25 #ifndef PIPEWIRE_STREAM_H
26 #define PIPEWIRE_STREAM_H
152 #include <spa/buffer/buffer.h>
153 #include <spa/param/param.h>
185 struct spa_fraction
rate;
201 #define PW_VERSION_STREAM_EVENTS 0
277 struct spa_hook *listener,
303 const struct spa_pod **params,
319 const char *error, ... ) SPA_PRINTF_FUNC(3, 4);
329 const struct spa_pod **params,
PipeWire stream object class.
int int pw_stream_update_params(struct pw_stream *stream, const struct spa_pod **params, uint32_t n_params)
Complete the negotiation process with result code res.
Definition: stream.c:1733
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:1484
uint32_t pw_stream_get_node_id(struct pw_stream *stream)
Get the node ID of the stream.
Definition: stream.c:1669
struct pw_stream * pw_stream_new(struct pw_core *core, const char *name, struct pw_properties *props)
Create a new unconneced pw_stream.
Definition: stream.c:1230
int pw_stream_get_time(struct pw_stream *stream, struct pw_time *time)
Query the time on the stream.
Definition: stream.c:1826
const char * pw_stream_state_as_string(enum pw_stream_state state)
Convert a stream state to a readable string.
Definition: stream.c:1297
int pw_stream_disconnect(struct pw_stream *stream)
Disconnect stream.
Definition: stream.c:1675
int pw_stream_set_active(struct pw_stream *stream, bool active)
Activate or deactivate the stream.
Definition: stream.c:1816
void pw_stream_destroy(struct pw_stream *stream)
Destroy a stream.
Definition: stream.c:1315
buffer[1023]
Definition: core.h:330
static uint32_t int int res
Definition: core.h:326
static uint32_t id
Definition: core.h:325
#define pw_direction
Definition: port.h:47
pw_stream_flags
Extra flags that can be used in pw_stream_connect()
Definition: stream.h:237
@ PW_STREAM_FLAG_INACTIVE
start the stream inactive, pw_stream_set_active() needs to be called explicitly
Definition: stream.h:241
@ PW_STREAM_FLAG_MAP_BUFFERS
mmap the buffers except DmaBuf
Definition: stream.h:244
@ PW_STREAM_FLAG_DRIVER
be a driver
Definition: stream.h:245
@ PW_STREAM_FLAG_EXCLUSIVE
require exclusive access to the device
Definition: stream.h:250
@ PW_STREAM_FLAG_NO_CONVERT
don't convert format
Definition: stream.h:249
@ PW_STREAM_FLAG_DONT_RECONNECT
don't try to reconnect this stream when the sink/source is removed
Definition: stream.h:252
@ PW_STREAM_FLAG_AUTOCONNECT
try to automatically connect this stream
Definition: stream.h:239
@ PW_STREAM_FLAG_ALLOC_BUFFERS
the application will allocate buffer memory.
Definition: stream.h:254
@ PW_STREAM_FLAG_RT_PROCESS
call process from the realtime thread.
Definition: stream.h:246
@ PW_STREAM_FLAG_NONE
no flags
Definition: stream.h:238
int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict)
Definition: stream.c:1389
enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error)
Definition: stream.c:1369
int pw_stream_set_control(struct pw_stream *stream, uint32_t id, uint32_t n_values, float *values,...)
Set control values.
Definition: stream.c:1750
int pw_stream_set_error(struct pw_stream *stream, int res, const char *error,...) SPA_PRINTF_FUNC(3
Set the stream in error state.
int pw_stream_flush(struct pw_stream *stream, bool drain)
Flush a stream.
Definition: stream.c:1947
const char * pw_stream_get_name(struct pw_stream *stream)
Definition: stream.c:1377
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:1252
pw_stream_state
The state of a stream.
Definition: stream.h:156
@ PW_STREAM_STATE_PAUSED
paused
Definition: stream.h:160
@ PW_STREAM_STATE_CONNECTING
connection is in progress
Definition: stream.h:159
@ PW_STREAM_STATE_UNCONNECTED
unconnected
Definition: stream.h:158
@ PW_STREAM_STATE_ERROR
the stream is in error
Definition: stream.h:157
@ PW_STREAM_STATE_STREAMING
streaming
Definition: stream.h:161
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:1872
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:1899
void pw_stream_add_listener(struct pw_stream *stream, struct spa_hook *listener, const struct pw_stream_events *events, void *data)
Definition: stream.c:1360
struct pw_core * pw_stream_get_core(struct pw_stream *stream)
Definition: stream.c:1406
const struct pw_properties * pw_stream_get_properties(struct pw_stream *stream)
Definition: stream.c:1383
uint64_t size
This field is set by the user and the sum of all queued buffer is returned in the time info.
Definition: stream.h:167
struct spa_buffer * buffer
the spa buffer
Definition: stream.h:165
void * user_data
user data attached to the buffer
Definition: stream.h:166
PipeWire loop object provides an implementation of the spa loop interfaces.
Definition: loop.h:41
A collection of key/value pairs.
Definition: properties.h:45
struct spa_dict dict
dictionary of key/values
Definition: properties.h:46
uint32_t flags
extra flags
Definition: properties.h:47
float max
max value
Definition: stream.h:176
uint32_t flags
extra flags (unused)
Definition: stream.h:173
float def
default value
Definition: stream.h:174
uint32_t max_values
max values that can be set on this control
Definition: stream.h:179
float min
min value
Definition: stream.h:175
uint32_t n_values
number of values in array
Definition: stream.h:178
float * values
array of values
Definition: stream.h:177
const char * name
name of the control
Definition: stream.h:172
Events for a stream.
Definition: stream.h:200
void(* remove_buffer)(void *data, struct pw_buffer *buffer)
when a buffer was destroyed for this stream
Definition: stream.h:220
void(* control_info)(void *data, uint32_t id, const struct pw_stream_control *control)
Notify information about a control.
Definition: stream.h:210
void(* param_changed)(void *data, uint32_t id, const struct spa_pod *param)
when a parameter changed
Definition: stream.h:215
void(* process)(void *data)
when a buffer can be queued (for playback streams) or dequeued (for capture streams).
Definition: stream.h:226
uint32_t version
Definition: stream.h:202
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:206
void(* drained)(void *data)
The stream is drained.
Definition: stream.h:229
void(* destroy)(void *data)
Definition: stream.h:204
void(* add_buffer)(void *data, struct pw_buffer *buffer)
when a new buffer was created for this stream
Definition: stream.h:218
void(* io_changed)(void *data, uint32_t id, void *area, uint32_t size)
when io changed on the stream.
Definition: stream.h:213
A time structure.
Definition: stream.h:183
int64_t delay
delay to device, add to ticks to get the time of the device.
Definition: stream.h:188
struct spa_fraction rate
the rate of ticks and delay
Definition: stream.h:185
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:191
uint64_t ticks
the ticks at now.
Definition: stream.h:186
int64_t now
the monotonic time in nanoseconds
Definition: stream.h:184