PipeWire: stream.h Source File

PipeWire 0.3.67

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
169struct pw_stream;
170
171#include <spa/buffer/buffer.h>
172#include <spa/param/param.h>
173#include <spa/pod/command.h>
174
176enum pw_stream_state {
177 PW_STREAM_STATE_ERROR = -1,
178 PW_STREAM_STATE_UNCONNECTED = 0,
179 PW_STREAM_STATE_CONNECTING = 1,
180 PW_STREAM_STATE_PAUSED = 2,
181 PW_STREAM_STATE_STREAMING = 3
182};
183
186struct pw_buffer {
187 struct spa_buffer *buffer;
188 void *user_data;
189 uint64_t size;
193 uint64_t requested;
198};
199
200struct pw_stream_control {
201 const char *name;
202 uint32_t flags;
203 float def;
204 float min;
205 float max;
206 float *values;
207 uint32_t n_values;
208 uint32_t max_values;
209};
210
276struct pw_time {
277 int64_t now;
283 struct spa_fraction rate;
285 uint64_t ticks;
288 int64_t delay;
297 uint64_t queued;
300 uint64_t buffered;
303 uint32_t queued_buffers;
304 uint32_t avail_buffers;
305};
306
307#include <pipewire/port.h>
308
311struct pw_stream_events {
312#define PW_VERSION_STREAM_EVENTS 2
313 uint32_t version;
314
315 void (*destroy) (void *data);
317 void (*state_changed) (void *data, enum pw_stream_state old,
318 enum pw_stream_state state, const char *error);
319
321 void (*control_info) (void *data, uint32_t id, const struct pw_stream_control *control);
322
324 void (*io_changed) (void *data, uint32_t id, void *area, uint32_t size);
326 void (*param_changed) (void *data, uint32_t id, const struct spa_pod *param);
327
329 void (*add_buffer) (void *data, struct pw_buffer *buffer);
331 void (*remove_buffer) (void *data, struct pw_buffer *buffer);
332
337 void (*process) (void *data);
338
340 void (*drained) (void *data);
341
343 void (*command) (void *data, const struct spa_command *command);
344
346 void (*trigger_done) (void *data);
347};
348
350const char * pw_stream_state_as_string(enum pw_stream_state state);
351
353enum pw_stream_flags {
354 PW_STREAM_FLAG_NONE = 0,
355 PW_STREAM_FLAG_AUTOCONNECT = (1 << 0),
357 PW_STREAM_FLAG_INACTIVE = (1 << 1),
360 PW_STREAM_FLAG_MAP_BUFFERS = (1 << 2),
361 PW_STREAM_FLAG_DRIVER = (1 << 3),
362 PW_STREAM_FLAG_RT_PROCESS = (1 << 4),
365 PW_STREAM_FLAG_NO_CONVERT = (1 << 5),
366 PW_STREAM_FLAG_EXCLUSIVE = (1 << 6),
368 PW_STREAM_FLAG_DONT_RECONNECT = (1 << 7),
370 PW_STREAM_FLAG_ALLOC_BUFFERS = (1 << 8),
373 PW_STREAM_FLAG_TRIGGER = (1 << 9),
378};
379
382struct pw_stream *
383 pw_stream_new(struct pw_core *core,
384 const char *name,
385 struct pw_properties *props );
386
387struct pw_stream *
388 pw_stream_new_simple(struct pw_loop *loop,
389 const char *name,
390 struct pw_properties *props,
391 const struct pw_stream_events *events,
392 void *data );
393
395void pw_stream_destroy(struct pw_stream *stream);
396
397void pw_stream_add_listener(struct pw_stream *stream,
398 struct spa_hook *listener,
399 const struct pw_stream_events *events,
400 void *data);
401
402enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error);
403
404const char *pw_stream_get_name(struct pw_stream *stream);
405
406struct pw_core *pw_stream_get_core(struct pw_stream *stream);
407
408const struct pw_properties *pw_stream_get_properties(struct pw_stream *stream);
409
410int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict);
411
417int
418 pw_stream_connect(struct pw_stream *stream,
419 enum pw_direction direction,
420 uint32_t target_id,
430 enum pw_stream_flags flags,
431 const struct spa_pod **params,
434 uint32_t n_params );
435
438uint32_t
439 pw_stream_get_node_id(struct pw_stream *stream);
440
442int pw_stream_disconnect(struct pw_stream *stream);
443
445int pw_stream_set_error(struct pw_stream *stream,
446 int res,
447 const char *error,
448 ...) SPA_PRINTF_FUNC(3, 4);
449
456int
457 pw_stream_update_params(struct pw_stream *stream,
458 const struct spa_pod **params,
461 uint32_t n_params );
462
464const struct pw_stream_control *pw_stream_get_control(struct pw_stream *stream, uint32_t id);
465
467int pw_stream_set_control(struct pw_stream *stream, uint32_t id, uint32_t n_values, float *values, ...);
468
470int pw_stream_get_time_n(struct pw_stream *stream, struct pw_time *time, size_t size);
471
474 SPA_DEPRECATED
475int pw_stream_get_time(struct pw_stream *stream, struct pw_time *time);
476
479struct pw_buffer *pw_stream_dequeue_buffer(struct pw_stream *stream);
480
482int pw_stream_queue_buffer(struct pw_stream *stream, struct pw_buffer *buffer);
483
485int pw_stream_set_active(struct pw_stream *stream, bool active);
486
489int pw_stream_flush(struct pw_stream *stream, bool drain);
490
495bool pw_stream_is_driving(struct pw_stream *stream);
496
499int pw_stream_trigger_process(struct pw_stream *stream);
500
505#ifdef __cplusplus
506}
507#endif
508
509#endif /* PIPEWIRE_STREAM_H */
buffer.h
spa/buffer/buffer.h
pw_direction
#define pw_direction
The direction of a port.
Definition: port.h:43
pw_stream_flags
pw_stream_flags
Extra flags that can be used in pw_stream_connect()
Definition: stream.h:359
pw_stream_update_properties
int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict)
Definition: stream.c:1689
pw_stream_get_state
enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error)
Definition: stream.c:1669
pw_stream_update_params
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:2080
pw_stream_connect
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:1791
pw_stream_dequeue_buffer
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:2248
pw_stream_get_node_id
uint32_t pw_stream_get_node_id(struct pw_stream *stream)
Get the node ID of the stream.
Definition: stream.c:2016
pw_stream_set_error
int pw_stream_set_error(struct pw_stream *stream, int res, const char *error,...) 1(3
Set the stream in error state.
pw_stream_set_control
int pw_stream_set_control(struct pw_stream *stream, uint32_t id, uint32_t n_values, float *values,...)
Set control values.
Definition: stream.c:2098
pw_stream_is_driving
bool pw_stream_is_driving(struct pw_stream *stream)
Check if the stream is driving.
Definition: stream.c:2341
pw_stream_flush
int pw_stream_flush(struct pw_stream *stream, bool drain)
Flush a stream.
Definition: stream.c:2329
pw_stream_new
struct pw_stream * pw_stream_new(struct pw_core *core, const char *name, struct pw_properties *props)
Create a new unconneced Stream.
Definition: stream.c:1516
pw_stream_get_time
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:2193
pw_stream_get_control
const struct pw_stream_control * pw_stream_get_control(struct pw_stream *stream, uint32_t id)
Get control values.
Definition: stream.c:2158
pw_stream_state_as_string
const char * pw_stream_state_as_string(enum pw_stream_state state)
Convert a stream state to a readable string.
Definition: stream.c:1582
pw_stream_state
pw_stream_state
The state of a stream.
Definition: stream.h:181
pw_stream_disconnect
int pw_stream_disconnect(struct pw_stream *stream)
Disconnect stream
Definition: stream.c:2022
pw_stream_set_active
int pw_stream_set_active(struct pw_stream *stream, bool active)
Activate or deactivate the stream.
Definition: stream.c:2172
pw_stream_trigger_process
int pw_stream_trigger_process(struct pw_stream *stream)
Trigger a push/pull on the stream.
Definition: stream.c:2376
pw_stream_queue_buffer
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:2275
pw_stream_get_name
const char * pw_stream_get_name(struct pw_stream *stream)
Definition: stream.c:1677
pw_stream_new_simple
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:1538
pw_stream_get_properties
const struct pw_properties * pw_stream_get_properties(struct pw_stream *stream)
Definition: stream.c:1683
pw_stream_get_time_n
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:2199
pw_stream_add_listener
void pw_stream_add_listener(struct pw_stream *stream, struct spa_hook *listener, const struct pw_stream_events *events, void *data)
Definition: stream.c:1653
pw_stream_destroy
void pw_stream_destroy(struct pw_stream *stream)
Destroy a stream.
Definition: stream.c:1600
pw_stream_get_core
struct pw_core * pw_stream_get_core(struct pw_stream *stream)
Definition: stream.c:1713
PW_STREAM_FLAG_INACTIVE
@ PW_STREAM_FLAG_INACTIVE
start the stream inactive, pw_stream_set_active() needs to be called explicitly
Definition: stream.h:363
PW_STREAM_FLAG_MAP_BUFFERS
@ PW_STREAM_FLAG_MAP_BUFFERS
mmap the buffers except DmaBuf
Definition: stream.h:366
PW_STREAM_FLAG_DRIVER
@ PW_STREAM_FLAG_DRIVER
be a driver
Definition: stream.h:367
PW_STREAM_FLAG_EXCLUSIVE
@ PW_STREAM_FLAG_EXCLUSIVE
require exclusive access to the device
Definition: stream.h:372
PW_STREAM_FLAG_NO_CONVERT
@ PW_STREAM_FLAG_NO_CONVERT
don't convert format
Definition: stream.h:371
PW_STREAM_FLAG_TRIGGER
@ PW_STREAM_FLAG_TRIGGER
the output stream will not be scheduled automatically but _trigger_process() needs to be called.
Definition: stream.h:379
PW_STREAM_FLAG_DONT_RECONNECT
@ PW_STREAM_FLAG_DONT_RECONNECT
don't try to reconnect this stream when the sink/source is removed
Definition: stream.h:374
PW_STREAM_FLAG_AUTOCONNECT
@ PW_STREAM_FLAG_AUTOCONNECT
try to automatically connect this stream
Definition: stream.h:361
PW_STREAM_FLAG_ALLOC_BUFFERS
@ PW_STREAM_FLAG_ALLOC_BUFFERS
the application will allocate buffer memory.
Definition: stream.h:376
PW_STREAM_FLAG_RT_PROCESS
@ PW_STREAM_FLAG_RT_PROCESS
call process from the realtime thread.
Definition: stream.h:368
PW_STREAM_FLAG_NONE
@ PW_STREAM_FLAG_NONE
no flags
Definition: stream.h:360
PW_STREAM_STATE_PAUSED
@ PW_STREAM_STATE_PAUSED
paused
Definition: stream.h:185
PW_STREAM_STATE_CONNECTING
@ PW_STREAM_STATE_CONNECTING
connection is in progress
Definition: stream.h:184
PW_STREAM_STATE_UNCONNECTED
@ PW_STREAM_STATE_UNCONNECTED
unconnected
Definition: stream.h:183
PW_STREAM_STATE_ERROR
@ PW_STREAM_STATE_ERROR
the stream is in error
Definition: stream.h:182
PW_STREAM_STATE_STREAMING
@ PW_STREAM_STATE_STREAMING
streaming
Definition: stream.h:186
SPA_DEPRECATED
#define SPA_DEPRECATED
Definition: defs.h:279
SPA_PRINTF_FUNC
#define SPA_PRINTF_FUNC(fmt, arg1)
Definition: defs.h:273
param.h
spa/param/param.h
command.h
spa/pod/command.h
port.h
pipewire/port.h
pw_buffer
a buffer structure obtained from pw_stream_dequeue_buffer().
Definition: stream.h:191
pw_buffer::size
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:194
pw_buffer::requested
uint64_t requested
For playback streams, this field contains the suggested amount of data to provide.
Definition: stream.h:198
pw_buffer::buffer
struct spa_buffer * buffer
the spa buffer
Definition: stream.h:192
pw_buffer::user_data
void * user_data
user data attached to the buffer
Definition: stream.h:193
pw_core
pw_loop
Definition: src/pipewire/loop.h:31
pw_properties
Definition: properties.h:33
pw_properties::dict
struct spa_dict dict
dictionary of key/values
Definition: properties.h:34
pw_properties::flags
uint32_t flags
extra flags
Definition: properties.h:35
pw_stream_control
Definition: stream.h:205
pw_stream_control::max
float max
max value
Definition: stream.h:210
pw_stream_control::flags
uint32_t flags
extra flags (unused)
Definition: stream.h:207
pw_stream_control::def
float def
default value
Definition: stream.h:208
pw_stream_control::max_values
uint32_t max_values
max values that can be set on this control
Definition: stream.h:213
pw_stream_control::min
float min
min value
Definition: stream.h:209
pw_stream_control::n_values
uint32_t n_values
number of values in array
Definition: stream.h:212
pw_stream_control::values
float * values
array of values
Definition: stream.h:211
pw_stream_events
Events for a stream.
Definition: stream.h:316
pw_stream_events::remove_buffer
void(* remove_buffer)(void *data, struct pw_buffer *buffer)
when a buffer was destroyed for this stream
Definition: stream.h:337
pw_stream_events::control_info
void(* control_info)(void *data, uint32_t id, const struct pw_stream_control *control)
Notify information about a control.
Definition: stream.h:327
pw_stream_events::trigger_done
void(* trigger_done)(void *data)
a trigger_process completed.
Definition: stream.h:352
pw_stream_events::param_changed
void(* param_changed)(void *data, uint32_t id, const struct spa_pod *param)
when a parameter changed
Definition: stream.h:332
pw_stream_events::process
void(* process)(void *data)
when a buffer can be queued (for playback streams) or dequeued (for capture streams).
Definition: stream.h:343
pw_stream_events::command
void(* command)(void *data, const struct spa_command *command)
A command notify, Since 0.3.39:1.
Definition: stream.h:349
pw_stream_events::version
uint32_t version
Definition: stream.h:319
pw_stream_events::state_changed
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:323
pw_stream_events::drained
void(* drained)(void *data)
The stream is drained.
Definition: stream.h:346
pw_stream_events::destroy
void(* destroy)(void *data)
Definition: stream.h:321
pw_stream_events::add_buffer
void(* add_buffer)(void *data, struct pw_buffer *buffer)
when a new buffer was created for this stream
Definition: stream.h:335
pw_stream_events::io_changed
void(* io_changed)(void *data, uint32_t id, void *area, uint32_t size)
when io changed on the stream.
Definition: stream.h:330
pw_stream
pw_time
A time structure.
Definition: stream.h:281
pw_time::delay
int64_t delay
delay to device.
Definition: stream.h:293
pw_time::rate
struct spa_fraction rate
the rate of ticks and delay.
Definition: stream.h:288
pw_time::buffered
uint64_t buffered
for audio/raw streams, this contains the extra number of samples buffered in the resampler.
Definition: stream.h:305
pw_time::queued
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:302
pw_time::queued_buffers
uint32_t queued_buffers
The number of buffers that are queued.
Definition: stream.h:308
pw_time::ticks
uint64_t ticks
the ticks at now.
Definition: stream.h:290
pw_time::now
int64_t now
the monotonic time in nanoseconds.
Definition: stream.h:282
pw_time::avail_buffers
uint32_t avail_buffers
The number of buffers that can be dequeued.
Definition: stream.h:309
spa_buffer
A Buffer.
Definition: buffer/buffer.h:90
spa_command
Definition: pod/command.h:29
spa_dict
Definition: utils/dict.h:39
spa_fraction
Definition: defs.h:123
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:331
spa_pod
Definition: pod/pod.h:43