PipeWire: pipewire/stream.h Source File

PipeWire 1.0.3

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
174struct pw_stream;
175
176#include <spa/buffer/buffer.h>
177#include <spa/param/param.h>
178#include <spa/pod/command.h>
179
181enum pw_stream_state {
182 PW_STREAM_STATE_ERROR = -1,
183 PW_STREAM_STATE_UNCONNECTED = 0,
184 PW_STREAM_STATE_CONNECTING = 1,
185 PW_STREAM_STATE_PAUSED = 2,
186 PW_STREAM_STATE_STREAMING = 3
187};
188
191struct pw_buffer {
192 struct spa_buffer *buffer;
193 void *user_data;
194 uint64_t size;
198 uint64_t requested;
203};
204
205struct pw_stream_control {
206 const char *name;
207 uint32_t flags;
208 float def;
209 float min;
210 float max;
211 float *values;
212 uint32_t n_values;
213 uint32_t max_values;
214};
215
290struct pw_time {
291 int64_t now;
297 struct spa_fraction rate;
299 uint64_t ticks;
302 int64_t delay;
311 uint64_t queued;
314 uint64_t buffered;
317 uint32_t queued_buffers;
318 uint32_t avail_buffers;
319};
320
321#include <pipewire/port.h>
322
325struct pw_stream_events {
326#define PW_VERSION_STREAM_EVENTS 2
327 uint32_t version;
328
329 void (*destroy) (void *data);
331 void (*state_changed) (void *data, enum pw_stream_state old,
332 enum pw_stream_state state, const char *error);
333
335 void (*control_info) (void *data, uint32_t id, const struct pw_stream_control *control);
336
338 void (*io_changed) (void *data, uint32_t id, void *area, uint32_t size);
340 void (*param_changed) (void *data, uint32_t id, const struct spa_pod *param);
341
343 void (*add_buffer) (void *data, struct pw_buffer *buffer);
345 void (*remove_buffer) (void *data, struct pw_buffer *buffer);
346
351 void (*process) (void *data);
352
354 void (*drained) (void *data);
355
357 void (*command) (void *data, const struct spa_command *command);
358
360 void (*trigger_done) (void *data);
361};
362
364const char * pw_stream_state_as_string(enum pw_stream_state state);
365
367enum pw_stream_flags {
368 PW_STREAM_FLAG_NONE = 0,
369 PW_STREAM_FLAG_AUTOCONNECT = (1 << 0),
371 PW_STREAM_FLAG_INACTIVE = (1 << 1),
374 PW_STREAM_FLAG_MAP_BUFFERS = (1 << 2),
375 PW_STREAM_FLAG_DRIVER = (1 << 3),
376 PW_STREAM_FLAG_RT_PROCESS = (1 << 4),
379 PW_STREAM_FLAG_NO_CONVERT = (1 << 5),
380 PW_STREAM_FLAG_EXCLUSIVE = (1 << 6),
382 PW_STREAM_FLAG_DONT_RECONNECT = (1 << 7),
384 PW_STREAM_FLAG_ALLOC_BUFFERS = (1 << 8),
387 PW_STREAM_FLAG_TRIGGER = (1 << 9),
392 PW_STREAM_FLAG_ASYNC = (1 << 10),
399 PW_STREAM_FLAG_EARLY_PROCESS = (1 << 11),
404};
405
408struct pw_stream *
409 pw_stream_new(struct pw_core *core,
410 const char *name,
411 struct pw_properties *props );
412
413struct pw_stream *
414 pw_stream_new_simple(struct pw_loop *loop,
415 const char *name,
416 struct pw_properties *props,
417 const struct pw_stream_events *events,
418 void *data );
419
421void pw_stream_destroy(struct pw_stream *stream);
422
423void pw_stream_add_listener(struct pw_stream *stream,
424 struct spa_hook *listener,
425 const struct pw_stream_events *events,
426 void *data);
427
428enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error);
429
430const char *pw_stream_get_name(struct pw_stream *stream);
431
432struct pw_core *pw_stream_get_core(struct pw_stream *stream);
433
434const struct pw_properties *pw_stream_get_properties(struct pw_stream *stream);
435
436int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict);
437
443int
444 pw_stream_connect(struct pw_stream *stream,
445 enum pw_direction direction,
446 uint32_t target_id,
456 enum pw_stream_flags flags,
457 const struct spa_pod **params,
460 uint32_t n_params );
461
464uint32_t
465 pw_stream_get_node_id(struct pw_stream *stream);
466
468int pw_stream_disconnect(struct pw_stream *stream);
469
471int pw_stream_set_error(struct pw_stream *stream,
472 int res,
473 const char *error,
474 ...) SPA_PRINTF_FUNC(3, 4);
475
477 int
478 pw_stream_update_params(struct pw_stream *stream,
479 const struct spa_pod **params,
480 uint32_t n_params );
481
486int pw_stream_set_param(struct pw_stream *stream,
487 uint32_t id,
488 const struct spa_pod *param );
489
491const struct pw_stream_control *pw_stream_get_control(struct pw_stream *stream, uint32_t id);
492
494int pw_stream_set_control(struct pw_stream *stream, uint32_t id, uint32_t n_values, float *values, ...);
495
497int pw_stream_get_time_n(struct pw_stream *stream, struct pw_time *time, size_t size);
498
501 SPA_DEPRECATED
502int pw_stream_get_time(struct pw_stream *stream, struct pw_time *time);
503
506struct pw_buffer *pw_stream_dequeue_buffer(struct pw_stream *stream);
507
509int pw_stream_queue_buffer(struct pw_stream *stream, struct pw_buffer *buffer);
510
512int pw_stream_set_active(struct pw_stream *stream, bool active);
513
516int pw_stream_flush(struct pw_stream *stream, bool drain);
517
522bool pw_stream_is_driving(struct pw_stream *stream);
523
526int pw_stream_trigger_process(struct pw_stream *stream);
527
532#ifdef __cplusplus
533}
534#endif
535
536#endif /* PIPEWIRE_STREAM_H */
buffer.h
spa/buffer/buffer.h
pw_direction
#define pw_direction
The direction of a port.
Definition port.h:46
pw_stream_flags
pw_stream_flags
Extra flags that can be used in pw_stream_connect()
Definition stream.h:373
pw_stream_update_properties
int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict)
Definition stream.c:1781
pw_stream_get_state
enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error)
Definition stream.c:1761
pw_stream_update_params
int 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:2190
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:1884
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:2394
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:2150
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:2232
pw_stream_is_driving
bool pw_stream_is_driving(struct pw_stream *stream)
Check if the stream is driving.
Definition stream.c:2503
pw_stream_flush
int pw_stream_flush(struct pw_stream *stream, bool drain)
Flush a stream.
Definition stream.c:2486
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:1561
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:2334
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:2293
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:1627
pw_stream_set_param
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:2220
pw_stream_state
pw_stream_state
The state of a stream.
Definition stream.h:186
pw_stream_disconnect
int pw_stream_disconnect(struct pw_stream *stream)
Disconnect stream
Definition stream.c:2156
pw_stream_set_active
int pw_stream_set_active(struct pw_stream *stream, bool active)
Activate or deactivate the stream.
Definition stream.c:2307
pw_stream_trigger_process
int pw_stream_trigger_process(struct pw_stream *stream)
Trigger a push/pull on the stream.
Definition stream.c:2540
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:2422
pw_stream_get_name
const char * pw_stream_get_name(struct pw_stream *stream)
Definition stream.c:1769
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:1583
pw_stream_get_properties
const struct pw_properties * pw_stream_get_properties(struct pw_stream *stream)
Definition stream.c:1775
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:2340
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:1742
pw_stream_destroy
void pw_stream_destroy(struct pw_stream *stream)
Destroy a stream.
Definition stream.c:1677
pw_stream_get_core
struct pw_core * pw_stream_get_core(struct pw_stream *stream)
Definition stream.c:1807
PW_STREAM_FLAG_EARLY_PROCESS
@ PW_STREAM_FLAG_EARLY_PROCESS
Call process as soon as there is a buffer to dequeue.
Definition stream.h:405
PW_STREAM_FLAG_INACTIVE
@ PW_STREAM_FLAG_INACTIVE
start the stream inactive, pw_stream_set_active() needs to be called explicitly
Definition stream.h:377
PW_STREAM_FLAG_MAP_BUFFERS
@ PW_STREAM_FLAG_MAP_BUFFERS
mmap the buffers except DmaBuf
Definition stream.h:380
PW_STREAM_FLAG_DRIVER
@ PW_STREAM_FLAG_DRIVER
be a driver
Definition stream.h:381
PW_STREAM_FLAG_EXCLUSIVE
@ PW_STREAM_FLAG_EXCLUSIVE
require exclusive access to the device
Definition stream.h:386
PW_STREAM_FLAG_ASYNC
@ PW_STREAM_FLAG_ASYNC
Buffers will not be dequeued/queued from the realtime process() function.
Definition stream.h:398
PW_STREAM_FLAG_NO_CONVERT
@ PW_STREAM_FLAG_NO_CONVERT
don't convert format
Definition stream.h:385
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:393
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:388
PW_STREAM_FLAG_AUTOCONNECT
@ PW_STREAM_FLAG_AUTOCONNECT
try to automatically connect this stream
Definition stream.h:375
PW_STREAM_FLAG_ALLOC_BUFFERS
@ PW_STREAM_FLAG_ALLOC_BUFFERS
the application will allocate buffer memory.
Definition stream.h:390
PW_STREAM_FLAG_RT_PROCESS
@ PW_STREAM_FLAG_RT_PROCESS
call process from the realtime thread.
Definition stream.h:382
PW_STREAM_FLAG_NONE
@ PW_STREAM_FLAG_NONE
no flags
Definition stream.h:374
PW_STREAM_STATE_PAUSED
@ PW_STREAM_STATE_PAUSED
paused
Definition stream.h:190
PW_STREAM_STATE_CONNECTING
@ PW_STREAM_STATE_CONNECTING
connection is in progress
Definition stream.h:189
PW_STREAM_STATE_UNCONNECTED
@ PW_STREAM_STATE_UNCONNECTED
unconnected
Definition stream.h:188
PW_STREAM_STATE_ERROR
@ PW_STREAM_STATE_ERROR
the stream is in error
Definition stream.h:187
PW_STREAM_STATE_STREAMING
@ PW_STREAM_STATE_STREAMING
streaming
Definition stream.h:191
SPA_DEPRECATED
#define SPA_DEPRECATED
Definition defs.h:283
SPA_PRINTF_FUNC
#define SPA_PRINTF_FUNC(fmt, arg1)
Definition defs.h:277
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:196
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:199
pw_buffer::requested
uint64_t requested
For playback streams, this field contains the suggested amount of data to provide.
Definition stream.h:203
pw_buffer::buffer
struct spa_buffer * buffer
the spa buffer
Definition stream.h:197
pw_buffer::user_data
void * user_data
user data attached to the buffer
Definition stream.h:198
pw_core
pw_loop
Definition 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:210
pw_stream_control::max
float max
max value
Definition stream.h:215
pw_stream_control::flags
uint32_t flags
extra flags (unused)
Definition stream.h:212
pw_stream_control::def
float def
default value
Definition stream.h:213
pw_stream_control::max_values
uint32_t max_values
max values that can be set on this control
Definition stream.h:218
pw_stream_control::min
float min
min value
Definition stream.h:214
pw_stream_control::n_values
uint32_t n_values
number of values in array
Definition stream.h:217
pw_stream_control::values
float * values
array of values
Definition stream.h:216
pw_stream_events
Events for a stream.
Definition stream.h:330
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:351
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:341
pw_stream_events::trigger_done
void(* trigger_done)(void *data)
a trigger_process completed.
Definition stream.h:366
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:346
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:357
pw_stream_events::command
void(* command)(void *data, const struct spa_command *command)
A command notify, Since 0.3.39:1.
Definition stream.h:363
pw_stream_events::version
uint32_t version
Definition stream.h:333
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:337
pw_stream_events::drained
void(* drained)(void *data)
The stream is drained.
Definition stream.h:360
pw_stream_events::destroy
void(* destroy)(void *data)
Definition stream.h:335
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:349
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:344
pw_stream
pw_time
A time structure.
Definition stream.h:295
pw_time::delay
int64_t delay
delay to device.
Definition stream.h:307
pw_time::rate
struct spa_fraction rate
the rate of ticks and delay.
Definition stream.h:302
pw_time::buffered
uint64_t buffered
for audio/raw streams, this contains the extra number of samples buffered in the resampler.
Definition stream.h:319
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:316
pw_time::queued_buffers
uint32_t queued_buffers
The number of buffers that are queued.
Definition stream.h:322
pw_time::ticks
uint64_t ticks
the ticks at now.
Definition stream.h:304
pw_time::now
int64_t now
the monotonic time in nanoseconds.
Definition stream.h:296
pw_time::avail_buffers
uint32_t avail_buffers
The number of buffers that can be dequeued.
Definition stream.h:323
spa_buffer
A Buffer.
Definition buffer.h:90
spa_command
Definition command.h:29
spa_dict
Definition 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:350
spa_pod
Definition pod.h:43