PipeWire 1.3.0
Loading...
Searching...
No Matches
stream.h
Go to the documentation of this file.
1/* PipeWire */
2/* SPDX-FileCopyrightText: Copyright © 2018 Wim Taymans */
3/* SPDX-License-Identifier: MIT */
4
5#ifndef PIPEWIRE_STREAM_H
6#define PIPEWIRE_STREAM_H
7
8#ifdef __cplusplus
9extern "C" {
10#endif
11
227struct pw_stream;
228
229#include <spa/buffer/buffer.h>
230#include <spa/param/param.h>
232#include <spa/pod/event.h>
233
235enum pw_stream_state {
247 void *user_data;
253 uint64_t size;
257 uint64_t requested;
262 uint64_t time;
268
269struct pw_stream_control {
270 const char *name;
271 uint32_t flags;
272 float def;
273 float min;
274 float max;
275 float *values;
276 uint32_t n_values;
277 uint32_t max_values;
360struct pw_time {
361 int64_t now;
367 struct spa_fraction rate;
369 uint64_t ticks;
372 int64_t delay;
381 uint64_t queued;
384 uint64_t buffered;
387 uint32_t queued_buffers;
388 uint32_t avail_buffers;
389 uint64_t size;
395#include <pipewire/port.h>
396
399struct pw_stream_events {
400#define PW_VERSION_STREAM_EVENTS 2
401 uint32_t version;
402
403 void (*destroy) (void *data);
405 void (*state_changed) (void *data, enum pw_stream_state old,
406 enum pw_stream_state state, const char *error);
409 void (*control_info) (void *data, uint32_t id, const struct pw_stream_control *control);
410
412 void (*io_changed) (void *data, uint32_t id, void *area, uint32_t size);
414 void (*param_changed) (void *data, uint32_t id, const struct spa_pod *param);
417 void (*add_buffer) (void *data, struct pw_buffer *buffer);
419 void (*remove_buffer) (void *data, struct pw_buffer *buffer);
425 void (*process) (void *data);
426
428 void (*drained) (void *data);
429
431 void (*command) (void *data, const struct spa_command *command);
432
437 void (*trigger_done) (void *data);
438};
439
441const char * pw_stream_state_as_string(enum pw_stream_state state);
442
444enum pw_stream_flags {
446 PW_STREAM_FLAG_AUTOCONNECT = (1 << 0),
448 PW_STREAM_FLAG_INACTIVE = (1 << 1),
454 PW_STREAM_FLAG_RT_PROCESS = (1 << 4),
457 PW_STREAM_FLAG_NO_CONVERT = (1 << 5),
477 PW_STREAM_FLAG_EARLY_PROCESS = (1 << 11),
485};
486
489struct pw_stream *
490pw_stream_new(struct pw_core *core,
491 const char *name,
492 struct pw_properties *props );
493
494struct pw_stream *
495pw_stream_new_simple(struct pw_loop *loop,
496 const char *name,
497 struct pw_properties *props,
498 const struct pw_stream_events *events,
499 void *data );
500
502void pw_stream_destroy(struct pw_stream *stream);
503
504void pw_stream_add_listener(struct pw_stream *stream,
505 struct spa_hook *listener,
506 const struct pw_stream_events *events,
507 void *data);
508
509enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error);
510
511const char *pw_stream_get_name(struct pw_stream *stream);
512
513struct pw_core *pw_stream_get_core(struct pw_stream *stream);
514
515const struct pw_properties *pw_stream_get_properties(struct pw_stream *stream);
516
517int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict);
518
524int
525pw_stream_connect(struct pw_stream *stream,
526 enum pw_direction direction,
527 uint32_t target_id,
538 const struct spa_pod **params,
541 uint32_t n_params );
542
545uint32_t
546pw_stream_get_node_id(struct pw_stream *stream);
547
549int pw_stream_disconnect(struct pw_stream *stream);
550
552int pw_stream_set_error(struct pw_stream *stream,
553 int res,
554 const char *error,
555 ...) SPA_PRINTF_FUNC(3, 4);
556
558int
559pw_stream_update_params(struct pw_stream *stream,
560 const struct spa_pod **params,
561 uint32_t n_params );
562
567int pw_stream_set_param(struct pw_stream *stream,
568 uint32_t id,
569 const struct spa_pod *param );
570
572const struct pw_stream_control *pw_stream_get_control(struct pw_stream *stream, uint32_t id);
573
575int pw_stream_set_control(struct pw_stream *stream, uint32_t id, uint32_t n_values, float *values, ...);
576
578int pw_stream_get_time_n(struct pw_stream *stream, struct pw_time *time, size_t size);
579
582uint64_t pw_stream_get_nsec(struct pw_stream *stream);
583
586struct pw_loop *pw_stream_get_data_loop(struct pw_stream *stream);
587
591int pw_stream_get_time(struct pw_stream *stream, struct pw_time *time);
592
595struct pw_buffer *pw_stream_dequeue_buffer(struct pw_stream *stream);
596
598int pw_stream_queue_buffer(struct pw_stream *stream, struct pw_buffer *buffer);
599
601int pw_stream_set_active(struct pw_stream *stream, bool active);
602
609int pw_stream_flush(struct pw_stream *stream, bool drain);
610
615bool pw_stream_is_driving(struct pw_stream *stream);
616
635int pw_stream_trigger_process(struct pw_stream *stream);
636
639int pw_stream_emit_event(struct pw_stream *stream, const struct spa_event *event);
640
645#ifdef __cplusplus
646}
647#endif
648
649#endif /* PIPEWIRE_STREAM_H */
spa/buffer/buffer.h
#define pw_direction
The direction of a port.
Definition port.h:46
pw_stream_flags
Extra flags that can be used in pw_stream_connect()
Definition stream.h:450
int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict)
Definition stream.c:1766
enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error)
Definition stream.c:1746
int pw_stream_connect(struct pw_stream *stream, enum pw_direction direction, uint32_t target_id, enum pw_stream_flags flags, const struct spa_pod **params, uint32_t n_params)
Connect a stream for input or output on port_path.
Definition stream.c:1869
struct pw_buffer * pw_stream_dequeue_buffer(struct pw_stream *stream)
Get a buffer that can be filled for playback streams or consumed for capture streams.
Definition stream.c:2425
uint32_t pw_stream_get_node_id(struct pw_stream *stream)
Get the node ID of the stream.
Definition stream.c:2159
uint64_t pw_stream_get_nsec(struct pw_stream *stream)
Get the current time in nanoseconds.
Definition stream.c:2401
int pw_stream_emit_event(struct pw_stream *stream, const struct spa_event *event)
Emit an event from this stream.
Definition stream.c:2564
int pw_stream_set_control(struct pw_stream *stream, uint32_t id, uint32_t n_values, float *values,...)
Set control values.
Definition stream.c:2241
struct pw_loop * pw_stream_get_data_loop(struct pw_stream *stream)
Get the data loop that is doing the processing of this stream.
Definition stream.c:2409
bool pw_stream_is_driving(struct pw_stream *stream)
Check if the stream is driving.
Definition stream.c:2534
int pw_stream_flush(struct pw_stream *stream, bool drain)
Flush a stream.
Definition stream.c:2517
struct pw_stream * pw_stream_new(struct pw_core *core, const char *name, struct pw_properties *props)
Create a new unconnected Stream.
Definition stream.c:1546
int pw_stream_get_time(struct pw_stream *stream, struct pw_time *time)
Query the time on the stream, deprecated since 0.3.50, use pw_stream_get_time_n() to get the fields a...
Definition stream.c:2346
const struct pw_stream_control * pw_stream_get_control(struct pw_stream *stream, uint32_t id)
Get control values.
Definition stream.c:2302
const char * pw_stream_state_as_string(enum pw_stream_state state)
Convert a stream state to a readable string.
Definition stream.c:1612
int pw_stream_set_param(struct pw_stream *stream, uint32_t id, const struct spa_pod *param)
Set a parameter on the stream.
Definition stream.c:2229
pw_stream_state
The state of a stream.
Definition stream.h:240
int pw_stream_set_error(struct pw_stream *stream, int res, const char *error,...)
Set the stream in error state.
Definition stream.c:2173
int pw_stream_disconnect(struct pw_stream *stream)
Disconnect stream
Definition stream.c:2165
int pw_stream_update_params(struct pw_stream *stream, const struct spa_pod **params, uint32_t n_params)
Update the param exposed on the stream.
Definition stream.c:2199
int pw_stream_set_active(struct pw_stream *stream, bool active)
Activate or deactivate the stream.
Definition stream.c:2316
int pw_stream_trigger_process(struct pw_stream *stream)
Trigger a push/pull on the stream.
Definition stream.c:2572
int pw_stream_queue_buffer(struct pw_stream *stream, struct pw_buffer *buffer)
Submit a buffer for playback or recycle a buffer for capture.
Definition stream.c:2453
const char * pw_stream_get_name(struct pw_stream *stream)
Definition stream.c:1754
struct pw_stream * pw_stream_new_simple(struct pw_loop *loop, const char *name, struct pw_properties *props, const struct pw_stream_events *events, void *data)
Definition stream.c:1568
const struct pw_properties * pw_stream_get_properties(struct pw_stream *stream)
Definition stream.c:1760
int pw_stream_get_time_n(struct pw_stream *stream, struct pw_time *time, size_t size)
Query the time on the stream.
Definition stream.c:2352
void pw_stream_add_listener(struct pw_stream *stream, struct spa_hook *listener, const struct pw_stream_events *events, void *data)
Definition stream.c:1727
void pw_stream_destroy(struct pw_stream *stream)
Destroy a stream.
Definition stream.c:1662
struct pw_core * pw_stream_get_core(struct pw_stream *stream)
Definition stream.c:1792
@ PW_STREAM_FLAG_EARLY_PROCESS
Call process as soon as there is a buffer to dequeue.
Definition stream.h:483
@ PW_STREAM_FLAG_INACTIVE
start the stream inactive, pw_stream_set_active() needs to be called explicitly
Definition stream.h:454
@ PW_STREAM_FLAG_RT_TRIGGER_DONE
Call trigger_done from the realtime thread.
Definition stream.h:488
@ PW_STREAM_FLAG_MAP_BUFFERS
mmap the buffers except DmaBuf that is not explicitly marked as mappable.
Definition stream.h:457
@ PW_STREAM_FLAG_DRIVER
be a driver
Definition stream.h:459
@ PW_STREAM_FLAG_EXCLUSIVE
require exclusive access to the device
Definition stream.h:464
@ PW_STREAM_FLAG_ASYNC
Buffers will not be dequeued/queued from the realtime process() function.
Definition stream.h:476
@ PW_STREAM_FLAG_NO_CONVERT
don't convert format
Definition stream.h:463
@ PW_STREAM_FLAG_TRIGGER
the output stream will not be scheduled automatically but _trigger_process() needs to be called.
Definition stream.h:471
@ PW_STREAM_FLAG_DONT_RECONNECT
don't try to reconnect this stream when the sink/source is removed
Definition stream.h:466
@ PW_STREAM_FLAG_AUTOCONNECT
try to automatically connect this stream
Definition stream.h:452
@ PW_STREAM_FLAG_ALLOC_BUFFERS
the application will allocate buffer memory.
Definition stream.h:468
@ PW_STREAM_FLAG_RT_PROCESS
call process from the realtime thread.
Definition stream.h:460
@ PW_STREAM_FLAG_NONE
no flags
Definition stream.h:451
@ PW_STREAM_STATE_PAUSED
paused
Definition stream.h:244
@ PW_STREAM_STATE_CONNECTING
connection is in progress
Definition stream.h:243
@ PW_STREAM_STATE_UNCONNECTED
unconnected
Definition stream.h:242
@ PW_STREAM_STATE_ERROR
the stream is in error
Definition stream.h:241
@ PW_STREAM_STATE_STREAMING
streaming
Definition stream.h:245
#define SPA_DEPRECATED
Definition defs.h:301
#define SPA_PRINTF_FUNC(fmt, arg1)
Definition defs.h:295
spa/param/param.h
spa/pod/command.h
spa/pod/event.h
pipewire/port.h
a buffer structure obtained from pw_stream_dequeue_buffer().
Definition stream.h:250
uint64_t size
This field is set by the user and the sum of all queued buffers is returned in the time info.
Definition stream.h:258
uint64_t time
For capture streams, this field contains the cycle time in nanoseconds when this buffer was queued in...
Definition stream.h:267
uint64_t requested
For playback streams, this field contains the suggested amount of data to provide.
Definition stream.h:262
struct spa_buffer * buffer
the spa buffer
Definition stream.h:251
void * user_data
user data attached to the buffer.
Definition stream.h:252
Definition loop.h:33
Definition properties.h:34
struct spa_dict dict
dictionary of key/values
Definition properties.h:35
uint32_t flags
extra flags
Definition properties.h:36
Definition stream.h:274
float max
max value
Definition stream.h:279
uint32_t flags
extra flags (unused)
Definition stream.h:276
float def
default value
Definition stream.h:277
uint32_t max_values
max values that can be set on this control
Definition stream.h:282
float min
min value
Definition stream.h:278
uint32_t n_values
number of values in array
Definition stream.h:281
float * values
array of values
Definition stream.h:280
Events for a stream.
Definition stream.h:404
void(* remove_buffer)(void *data, struct pw_buffer *buffer)
when a buffer was destroyed for this stream
Definition stream.h:425
void(* control_info)(void *data, uint32_t id, const struct pw_stream_control *control)
Notify information about a control.
Definition stream.h:415
void(* trigger_done)(void *data)
a trigger_process completed.
Definition stream.h:443
void(* param_changed)(void *data, uint32_t id, const struct spa_pod *param)
when a parameter changed
Definition stream.h:420
void(* process)(void *data)
when a buffer can be queued (for playback streams) or dequeued (for capture streams).
Definition stream.h:431
void(* command)(void *data, const struct spa_command *command)
A command notify, Since 0.3.39:1.
Definition stream.h:437
uint32_t version
Definition stream.h:407
void(* state_changed)(void *data, enum pw_stream_state old, enum pw_stream_state state, const char *error)
when the stream state changes
Definition stream.h:411
void(* drained)(void *data)
The stream is drained.
Definition stream.h:434
void(* destroy)(void *data)
Definition stream.h:409
void(* add_buffer)(void *data, struct pw_buffer *buffer)
when a new buffer was created for this stream
Definition stream.h:423
void(* io_changed)(void *data, uint32_t id, void *area, uint32_t size)
when io changed on the stream.
Definition stream.h:418
A time structure.
Definition stream.h:365
int64_t delay
delay to device.
Definition stream.h:377
struct spa_fraction rate
the rate of ticks and delay.
Definition stream.h:372
uint64_t buffered
for audio/raw streams, this contains the extra number of frames buffered in the resampler.
Definition stream.h:389
uint64_t queued
data queued in the stream, this is the sum of the size fields in the pw_buffer that are currently que...
Definition stream.h:386
uint32_t queued_buffers
the number of buffers that are queued.
Definition stream.h:392
uint64_t ticks
the ticks at now.
Definition stream.h:374
uint64_t size
for audio/raw playback streams, this contains the number of samples requested by the resampler for th...
Definition stream.h:394
int64_t now
the time in nanoseconds.
Definition stream.h:366
uint32_t avail_buffers
the number of buffers that can be dequeued.
Definition stream.h:393
A Buffer.
Definition buffer.h:100
Definition command.h:29
Definition dict.h:41
Definition event.h:28
Definition defs.h:137
A hook, contains the structure with functions and the data passed to the functions.
Definition hook.h:350
Definition pod.h:43