PipeWire: pipewire/stream.h Source File

PipeWire 1.2.5

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
190struct pw_stream;
191
192#include <spa/buffer/buffer.h>
193#include <spa/param/param.h>
194#include <spa/pod/command.h>
195
197enum pw_stream_state {
198 PW_STREAM_STATE_ERROR = -1,
199 PW_STREAM_STATE_UNCONNECTED = 0,
200 PW_STREAM_STATE_CONNECTING = 1,
201 PW_STREAM_STATE_PAUSED = 2,
202 PW_STREAM_STATE_STREAMING = 3
203};
204
207struct pw_buffer {
208 struct spa_buffer *buffer;
209 void *user_data;
215 uint64_t size;
219 uint64_t requested;
224 uint64_t time;
229};
230
231struct pw_stream_control {
232 const char *name;
233 uint32_t flags;
234 float def;
235 float min;
236 float max;
237 float *values;
238 uint32_t n_values;
239 uint32_t max_values;
240};
241
315struct pw_time {
316 int64_t now;
322 struct spa_fraction rate;
324 uint64_t ticks;
327 int64_t delay;
336 uint64_t queued;
339 uint64_t buffered;
342 uint32_t queued_buffers;
343 uint32_t avail_buffers;
344 uint64_t size;
348};
349
350#include <pipewire/port.h>
351
354struct pw_stream_events {
355#define PW_VERSION_STREAM_EVENTS 2
356 uint32_t version;
357
358 void (*destroy) (void *data);
360 void (*state_changed) (void *data, enum pw_stream_state old,
361 enum pw_stream_state state, const char *error);
362
364 void (*control_info) (void *data, uint32_t id, const struct pw_stream_control *control);
365
367 void (*io_changed) (void *data, uint32_t id, void *area, uint32_t size);
369 void (*param_changed) (void *data, uint32_t id, const struct spa_pod *param);
370
372 void (*add_buffer) (void *data, struct pw_buffer *buffer);
374 void (*remove_buffer) (void *data, struct pw_buffer *buffer);
375
380 void (*process) (void *data);
381
383 void (*drained) (void *data);
384
386 void (*command) (void *data, const struct spa_command *command);
387
392 void (*trigger_done) (void *data);
393};
394
396const char * pw_stream_state_as_string(enum pw_stream_state state);
397
399enum pw_stream_flags {
400 PW_STREAM_FLAG_NONE = 0,
401 PW_STREAM_FLAG_AUTOCONNECT = (1 << 0),
403 PW_STREAM_FLAG_INACTIVE = (1 << 1),
406 PW_STREAM_FLAG_MAP_BUFFERS = (1 << 2),
408 PW_STREAM_FLAG_DRIVER = (1 << 3),
409 PW_STREAM_FLAG_RT_PROCESS = (1 << 4),
412 PW_STREAM_FLAG_NO_CONVERT = (1 << 5),
413 PW_STREAM_FLAG_EXCLUSIVE = (1 << 6),
415 PW_STREAM_FLAG_DONT_RECONNECT = (1 << 7),
417 PW_STREAM_FLAG_ALLOC_BUFFERS = (1 << 8),
420 PW_STREAM_FLAG_TRIGGER = (1 << 9),
425 PW_STREAM_FLAG_ASYNC = (1 << 10),
432 PW_STREAM_FLAG_EARLY_PROCESS = (1 << 11),
437 PW_STREAM_FLAG_RT_TRIGGER_DONE = (1 << 12),
440};
441
444struct pw_stream *
445 pw_stream_new(struct pw_core *core,
446 const char *name,
447 struct pw_properties *props );
448
449struct pw_stream *
450 pw_stream_new_simple(struct pw_loop *loop,
451 const char *name,
452 struct pw_properties *props,
453 const struct pw_stream_events *events,
454 void *data );
455
457void pw_stream_destroy(struct pw_stream *stream);
458
459void pw_stream_add_listener(struct pw_stream *stream,
460 struct spa_hook *listener,
461 const struct pw_stream_events *events,
462 void *data);
463
464enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error);
465
466const char *pw_stream_get_name(struct pw_stream *stream);
467
468struct pw_core *pw_stream_get_core(struct pw_stream *stream);
469
470const struct pw_properties *pw_stream_get_properties(struct pw_stream *stream);
471
472int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict);
473
479int
480 pw_stream_connect(struct pw_stream *stream,
481 enum pw_direction direction,
482 uint32_t target_id,
492 enum pw_stream_flags flags,
493 const struct spa_pod **params,
496 uint32_t n_params );
497
500uint32_t
501 pw_stream_get_node_id(struct pw_stream *stream);
502
504int pw_stream_disconnect(struct pw_stream *stream);
505
507int pw_stream_set_error(struct pw_stream *stream,
508 int res,
509 const char *error,
510 ...) SPA_PRINTF_FUNC(3, 4);
511
513int
514 pw_stream_update_params(struct pw_stream *stream,
515 const struct spa_pod **params,
516 uint32_t n_params );
517
522int pw_stream_set_param(struct pw_stream *stream,
523 uint32_t id,
524 const struct spa_pod *param );
525
527const struct pw_stream_control *pw_stream_get_control(struct pw_stream *stream, uint32_t id);
528
530int pw_stream_set_control(struct pw_stream *stream, uint32_t id, uint32_t n_values, float *values, ...);
531
533int pw_stream_get_time_n(struct pw_stream *stream, struct pw_time *time, size_t size);
534
537uint64_t pw_stream_get_nsec(struct pw_stream *stream);
538
541struct pw_loop *pw_stream_get_data_loop(struct pw_stream *stream);
542
545 SPA_DEPRECATED
546int pw_stream_get_time(struct pw_stream *stream, struct pw_time *time);
547
550struct pw_buffer *pw_stream_dequeue_buffer(struct pw_stream *stream);
551
553int pw_stream_queue_buffer(struct pw_stream *stream, struct pw_buffer *buffer);
554
556int pw_stream_set_active(struct pw_stream *stream, bool active);
557
560int pw_stream_flush(struct pw_stream *stream, bool drain);
561
566bool pw_stream_is_driving(struct pw_stream *stream);
567
586int pw_stream_trigger_process(struct pw_stream *stream);
587
592#ifdef __cplusplus
593}
594#endif
595
596#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:405
pw_stream_update_properties
int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict)
Definition stream.c:1739
pw_stream_get_state
enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error)
Definition stream.c:1719
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:1842
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:2132
pw_stream_get_nsec
uint64_t pw_stream_get_nsec(struct pw_stream *stream)
Get the current time in nanoseconds.
Definition stream.c:2370
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:2214
pw_stream_get_data_loop
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:2378
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 unconnected Stream.
Definition stream.c:1519
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:2316
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:2275
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:1585
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:2202
pw_stream_state
pw_stream_state
The state of a stream.
Definition stream.h:202
pw_stream_set_error
int pw_stream_set_error(struct pw_stream *stream, int res, const char *error,...)
Set the stream in error state.
Definition stream.c:2146
pw_stream_disconnect
int pw_stream_disconnect(struct pw_stream *stream)
Disconnect stream
Definition stream.c:2138
pw_stream_update_params
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:2172
pw_stream_set_active
int pw_stream_set_active(struct pw_stream *stream, bool active)
Activate or deactivate the stream.
Definition stream.c:2289
pw_stream_trigger_process
int pw_stream_trigger_process(struct pw_stream *stream)
Trigger a push/pull on the stream.
Definition stream.c:2538
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:1727
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:1541
pw_stream_get_properties
const struct pw_properties * pw_stream_get_properties(struct pw_stream *stream)
Definition stream.c:1733
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:2322
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:1700
pw_stream_destroy
void pw_stream_destroy(struct pw_stream *stream)
Destroy a stream.
Definition stream.c:1635
pw_stream_get_core
struct pw_core * pw_stream_get_core(struct pw_stream *stream)
Definition stream.c:1765
PW_STREAM_FLAG_EARLY_PROCESS
@ PW_STREAM_FLAG_EARLY_PROCESS
Call process as soon as there is a buffer to dequeue.
Definition stream.h:438
PW_STREAM_FLAG_INACTIVE
@ PW_STREAM_FLAG_INACTIVE
start the stream inactive, pw_stream_set_active() needs to be called explicitly
Definition stream.h:409
PW_STREAM_FLAG_RT_TRIGGER_DONE
@ PW_STREAM_FLAG_RT_TRIGGER_DONE
Call trigger_done from the realtime thread.
Definition stream.h:443
PW_STREAM_FLAG_MAP_BUFFERS
@ PW_STREAM_FLAG_MAP_BUFFERS
mmap the buffers except DmaBuf that is not explicitly marked as mappable.
Definition stream.h:412
PW_STREAM_FLAG_DRIVER
@ PW_STREAM_FLAG_DRIVER
be a driver
Definition stream.h:414
PW_STREAM_FLAG_EXCLUSIVE
@ PW_STREAM_FLAG_EXCLUSIVE
require exclusive access to the device
Definition stream.h:419
PW_STREAM_FLAG_ASYNC
@ PW_STREAM_FLAG_ASYNC
Buffers will not be dequeued/queued from the realtime process() function.
Definition stream.h:431
PW_STREAM_FLAG_NO_CONVERT
@ PW_STREAM_FLAG_NO_CONVERT
don't convert format
Definition stream.h:418
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:426
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:421
PW_STREAM_FLAG_AUTOCONNECT
@ PW_STREAM_FLAG_AUTOCONNECT
try to automatically connect this stream
Definition stream.h:407
PW_STREAM_FLAG_ALLOC_BUFFERS
@ PW_STREAM_FLAG_ALLOC_BUFFERS
the application will allocate buffer memory.
Definition stream.h:423
PW_STREAM_FLAG_RT_PROCESS
@ PW_STREAM_FLAG_RT_PROCESS
call process from the realtime thread.
Definition stream.h:415
PW_STREAM_FLAG_NONE
@ PW_STREAM_FLAG_NONE
no flags
Definition stream.h:406
PW_STREAM_STATE_PAUSED
@ PW_STREAM_STATE_PAUSED
paused
Definition stream.h:206
PW_STREAM_STATE_CONNECTING
@ PW_STREAM_STATE_CONNECTING
connection is in progress
Definition stream.h:205
PW_STREAM_STATE_UNCONNECTED
@ PW_STREAM_STATE_UNCONNECTED
unconnected
Definition stream.h:204
PW_STREAM_STATE_ERROR
@ PW_STREAM_STATE_ERROR
the stream is in error
Definition stream.h:203
PW_STREAM_STATE_STREAMING
@ PW_STREAM_STATE_STREAMING
streaming
Definition stream.h:207
SPA_DEPRECATED
#define SPA_DEPRECATED
Definition defs.h:301
SPA_PRINTF_FUNC
#define SPA_PRINTF_FUNC(fmt, arg1)
Definition defs.h:295
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:212
pw_buffer::size
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:220
pw_buffer::time
uint64_t time
For capture streams, this field contains the cycle time in nanoseconds when this buffer was queued in...
Definition stream.h:229
pw_buffer::requested
uint64_t requested
For playback streams, this field contains the suggested amount of data to provide.
Definition stream.h:224
pw_buffer::buffer
struct spa_buffer * buffer
the spa buffer
Definition stream.h:213
pw_buffer::user_data
void * user_data
user data attached to the buffer.
Definition stream.h:214
pw_core
pw_loop
Definition loop.h:33
pw_properties
Definition properties.h:34
pw_properties::dict
struct spa_dict dict
dictionary of key/values
Definition properties.h:35
pw_properties::flags
uint32_t flags
extra flags
Definition properties.h:36
pw_stream_control
Definition stream.h:236
pw_stream_control::max
float max
max value
Definition stream.h:241
pw_stream_control::flags
uint32_t flags
extra flags (unused)
Definition stream.h:238
pw_stream_control::def
float def
default value
Definition stream.h:239
pw_stream_control::max_values
uint32_t max_values
max values that can be set on this control
Definition stream.h:244
pw_stream_control::min
float min
min value
Definition stream.h:240
pw_stream_control::n_values
uint32_t n_values
number of values in array
Definition stream.h:243
pw_stream_control::values
float * values
array of values
Definition stream.h:242
pw_stream_events
Events for a stream.
Definition stream.h:359
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:380
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:370
pw_stream_events::trigger_done
void(* trigger_done)(void *data)
a trigger_process completed.
Definition stream.h:398
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:375
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:386
pw_stream_events::command
void(* command)(void *data, const struct spa_command *command)
A command notify, Since 0.3.39:1.
Definition stream.h:392
pw_stream_events::version
uint32_t version
Definition stream.h:362
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:366
pw_stream_events::drained
void(* drained)(void *data)
The stream is drained.
Definition stream.h:389
pw_stream_events::destroy
void(* destroy)(void *data)
Definition stream.h:364
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:378
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:373
pw_stream
pw_time
A time structure.
Definition stream.h:320
pw_time::delay
int64_t delay
delay to device.
Definition stream.h:332
pw_time::rate
struct spa_fraction rate
the rate of ticks and delay.
Definition stream.h:327
pw_time::buffered
uint64_t buffered
for audio/raw streams, this contains the extra number of frames buffered in the resampler.
Definition stream.h:344
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:341
pw_time::queued_buffers
uint32_t queued_buffers
the number of buffers that are queued.
Definition stream.h:347
pw_time::ticks
uint64_t ticks
the ticks at now.
Definition stream.h:329
pw_time::size
uint64_t size
for audio/raw playback streams, this contains the number of samples requested by the resampler for th...
Definition stream.h:349
pw_time::now
int64_t now
the time in nanoseconds.
Definition stream.h:321
pw_time::avail_buffers
uint32_t avail_buffers
the number of buffers that can be dequeued.
Definition stream.h:348
spa_buffer
A Buffer.
Definition buffer.h:100
spa_command
Definition command.h:29
spa_dict
Definition dict.h:39
spa_fraction
Definition defs.h:137
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