PipeWire 1.0.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
174struct pw_stream;
175
176#include <spa/buffer/buffer.h>
177#include <spa/param/param.h>
179
181enum pw_stream_state {
193 void *user_data;
199 uint64_t size;
203 uint64_t requested;
208 uint64_t time;
214
215struct pw_stream_control {
216 const char *name;
217 uint32_t flags;
218 float def;
219 float min;
220 float max;
221 float *values;
222 uint32_t n_values;
223 uint32_t max_values;
299struct pw_time {
300 int64_t now;
306 struct spa_fraction rate;
308 uint64_t ticks;
311 int64_t delay;
320 uint64_t queued;
323 uint64_t buffered;
326 uint32_t queued_buffers;
327 uint32_t avail_buffers;
328 uint64_t size;
334#include <pipewire/port.h>
335
338struct pw_stream_events {
339#define PW_VERSION_STREAM_EVENTS 2
340 uint32_t version;
341
342 void (*destroy) (void *data);
344 void (*state_changed) (void *data, enum pw_stream_state old,
345 enum pw_stream_state state, const char *error);
348 void (*control_info) (void *data, uint32_t id, const struct pw_stream_control *control);
349
351 void (*io_changed) (void *data, uint32_t id, void *area, uint32_t size);
353 void (*param_changed) (void *data, uint32_t id, const struct spa_pod *param);
356 void (*add_buffer) (void *data, struct pw_buffer *buffer);
358 void (*remove_buffer) (void *data, struct pw_buffer *buffer);
364 void (*process) (void *data);
365
367 void (*drained) (void *data);
368
370 void (*command) (void *data, const struct spa_command *command);
371
373 void (*trigger_done) (void *data);
374};
375
377const char * pw_stream_state_as_string(enum pw_stream_state state);
378
380enum pw_stream_flags {
382 PW_STREAM_FLAG_AUTOCONNECT = (1 << 0),
384 PW_STREAM_FLAG_INACTIVE = (1 << 1),
390 PW_STREAM_FLAG_RT_PROCESS = (1 << 4),
393 PW_STREAM_FLAG_NO_CONVERT = (1 << 5),
413 PW_STREAM_FLAG_EARLY_PROCESS = (1 << 11),
419
422struct pw_stream *
423pw_stream_new(struct pw_core *core,
424 const char *name,
425 struct pw_properties *props );
426
427struct pw_stream *
428pw_stream_new_simple(struct pw_loop *loop,
429 const char *name,
430 struct pw_properties *props,
431 const struct pw_stream_events *events,
432 void *data );
433
435void pw_stream_destroy(struct pw_stream *stream);
436
437void pw_stream_add_listener(struct pw_stream *stream,
438 struct spa_hook *listener,
439 const struct pw_stream_events *events,
440 void *data);
441
442enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error);
443
444const char *pw_stream_get_name(struct pw_stream *stream);
445
446struct pw_core *pw_stream_get_core(struct pw_stream *stream);
447
448const struct pw_properties *pw_stream_get_properties(struct pw_stream *stream);
449
450int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict);
451
457int
458pw_stream_connect(struct pw_stream *stream,
459 enum pw_direction direction,
460 uint32_t target_id,
471 const struct spa_pod **params,
474 uint32_t n_params );
475
478uint32_t
479pw_stream_get_node_id(struct pw_stream *stream);
480
482int pw_stream_disconnect(struct pw_stream *stream);
483
485int pw_stream_set_error(struct pw_stream *stream,
486 int res,
487 const char *error,
488 ...) SPA_PRINTF_FUNC(3, 4);
489
491int
492pw_stream_update_params(struct pw_stream *stream,
493 const struct spa_pod **params,
494 uint32_t n_params );
495
500int pw_stream_set_param(struct pw_stream *stream,
501 uint32_t id,
502 const struct spa_pod *param );
503
505const struct pw_stream_control *pw_stream_get_control(struct pw_stream *stream, uint32_t id);
506
508int pw_stream_set_control(struct pw_stream *stream, uint32_t id, uint32_t n_values, float *values, ...);
509
511int pw_stream_get_time_n(struct pw_stream *stream, struct pw_time *time, size_t size);
512
515uint64_t pw_stream_get_nsec(struct pw_stream *stream);
516
520int pw_stream_get_time(struct pw_stream *stream, struct pw_time *time);
521
524struct pw_buffer *pw_stream_dequeue_buffer(struct pw_stream *stream);
525
527int pw_stream_queue_buffer(struct pw_stream *stream, struct pw_buffer *buffer);
528
530int pw_stream_set_active(struct pw_stream *stream, bool active);
531
534int pw_stream_flush(struct pw_stream *stream, bool drain);
535
540bool pw_stream_is_driving(struct pw_stream *stream);
541
544int pw_stream_trigger_process(struct pw_stream *stream);
545
550#ifdef __cplusplus
551}
552#endif
553
554#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:386
int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict)
Definition stream.c:1801
enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error)
Definition stream.c:1781
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:1904
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:2439
uint32_t pw_stream_get_node_id(struct pw_stream *stream)
Get the node ID of the stream.
Definition stream.c:2184
uint64_t pw_stream_get_nsec(struct pw_stream *stream)
Get the current time in nanoseconds.
Definition stream.c:2422
int pw_stream_set_control(struct pw_stream *stream, uint32_t id, uint32_t n_values, float *values,...)
Set control values.
Definition stream.c:2266
bool pw_stream_is_driving(struct pw_stream *stream)
Check if the stream is driving.
Definition stream.c:2548
int pw_stream_flush(struct pw_stream *stream, bool drain)
Flush a stream.
Definition stream.c:2531
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:1581
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:2368
const struct pw_stream_control * pw_stream_get_control(struct pw_stream *stream, uint32_t id)
Get control values.
Definition stream.c:2327
const char * pw_stream_state_as_string(enum pw_stream_state state)
Convert a stream state to a readable string.
Definition stream.c:1647
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:2254
pw_stream_state
The state of a stream.
Definition stream.h:186
int pw_stream_set_error(struct pw_stream *stream, int res, const char *error,...)
Set the stream in error state.
Definition stream.c:2198
int pw_stream_disconnect(struct pw_stream *stream)
Disconnect stream
Definition stream.c:2190
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:2224
int pw_stream_set_active(struct pw_stream *stream, bool active)
Activate or deactivate the stream.
Definition stream.c:2341
int pw_stream_trigger_process(struct pw_stream *stream)
Trigger a push/pull on the stream.
Definition stream.c:2585
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:2467
const char * pw_stream_get_name(struct pw_stream *stream)
Definition stream.c:1789
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:1603
const struct pw_properties * pw_stream_get_properties(struct pw_stream *stream)
Definition stream.c:1795
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:2374
void pw_stream_add_listener(struct pw_stream *stream, struct spa_hook *listener, const struct pw_stream_events *events, void *data)
Definition stream.c:1762
void pw_stream_destroy(struct pw_stream *stream)
Destroy a stream.
Definition stream.c:1697
struct pw_core * pw_stream_get_core(struct pw_stream *stream)
Definition stream.c:1827
@ PW_STREAM_FLAG_EARLY_PROCESS
Call process as soon as there is a buffer to dequeue.
Definition stream.h:419
@ PW_STREAM_FLAG_INACTIVE
start the stream inactive, pw_stream_set_active() needs to be called explicitly
Definition stream.h:390
@ PW_STREAM_FLAG_MAP_BUFFERS
mmap the buffers except DmaBuf that is not explicitly marked as mappable.
Definition stream.h:393
@ PW_STREAM_FLAG_DRIVER
be a driver
Definition stream.h:395
@ PW_STREAM_FLAG_EXCLUSIVE
require exclusive access to the device
Definition stream.h:400
@ PW_STREAM_FLAG_ASYNC
Buffers will not be dequeued/queued from the realtime process() function.
Definition stream.h:412
@ PW_STREAM_FLAG_NO_CONVERT
don't convert format
Definition stream.h:399
@ PW_STREAM_FLAG_TRIGGER
the output stream will not be scheduled automatically but _trigger_process() needs to be called.
Definition stream.h:407
@ PW_STREAM_FLAG_DONT_RECONNECT
don't try to reconnect this stream when the sink/source is removed
Definition stream.h:402
@ PW_STREAM_FLAG_AUTOCONNECT
try to automatically connect this stream
Definition stream.h:388
@ PW_STREAM_FLAG_ALLOC_BUFFERS
the application will allocate buffer memory.
Definition stream.h:404
@ PW_STREAM_FLAG_RT_PROCESS
call process from the realtime thread.
Definition stream.h:396
@ PW_STREAM_FLAG_NONE
no flags
Definition stream.h:387
@ PW_STREAM_STATE_PAUSED
paused
Definition stream.h:190
@ PW_STREAM_STATE_CONNECTING
connection is in progress
Definition stream.h:189
@ PW_STREAM_STATE_UNCONNECTED
unconnected
Definition stream.h:188
@ PW_STREAM_STATE_ERROR
the stream is in error
Definition stream.h:187
@ PW_STREAM_STATE_STREAMING
streaming
Definition stream.h:191
#define SPA_DEPRECATED
Definition defs.h:283
#define SPA_PRINTF_FUNC(fmt, arg1)
Definition defs.h:277
spa/param/param.h
spa/pod/command.h
pipewire/port.h
a buffer structure obtained from pw_stream_dequeue_buffer().
Definition stream.h:196
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:204
uint64_t time
For capture streams, this field contains the cycle time in nanoseconds when this buffer was queued in...
Definition stream.h:213
uint64_t requested
For playback streams, this field contains the suggested amount of data to provide.
Definition stream.h:208
struct spa_buffer * buffer
the spa buffer
Definition stream.h:197
void * user_data
user data attached to the buffer.
Definition stream.h:198
Definition loop.h:31
Definition properties.h:33
struct spa_dict dict
dictionary of key/values
Definition properties.h:34
uint32_t flags
extra flags
Definition properties.h:35
Definition stream.h:220
float max
max value
Definition stream.h:225
uint32_t flags
extra flags (unused)
Definition stream.h:222
float def
default value
Definition stream.h:223
uint32_t max_values
max values that can be set on this control
Definition stream.h:228
float min
min value
Definition stream.h:224
uint32_t n_values
number of values in array
Definition stream.h:227
float * values
array of values
Definition stream.h:226
Events for a stream.
Definition stream.h:343
void(* remove_buffer)(void *data, struct pw_buffer *buffer)
when a buffer was destroyed for this stream
Definition stream.h:364
void(* control_info)(void *data, uint32_t id, const struct pw_stream_control *control)
Notify information about a control.
Definition stream.h:354
void(* trigger_done)(void *data)
a trigger_process completed.
Definition stream.h:379
void(* param_changed)(void *data, uint32_t id, const struct spa_pod *param)
when a parameter changed
Definition stream.h:359
void(* process)(void *data)
when a buffer can be queued (for playback streams) or dequeued (for capture streams).
Definition stream.h:370
void(* command)(void *data, const struct spa_command *command)
A command notify, Since 0.3.39:1.
Definition stream.h:376
uint32_t version
Definition stream.h:346
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:350
void(* drained)(void *data)
The stream is drained.
Definition stream.h:373
void(* destroy)(void *data)
Definition stream.h:348
void(* add_buffer)(void *data, struct pw_buffer *buffer)
when a new buffer was created for this stream
Definition stream.h:362
void(* io_changed)(void *data, uint32_t id, void *area, uint32_t size)
when io changed on the stream.
Definition stream.h:357
A time structure.
Definition stream.h:304
int64_t delay
delay to device.
Definition stream.h:316
struct spa_fraction rate
the rate of ticks and delay.
Definition stream.h:311
uint64_t buffered
for audio/raw streams, this contains the extra number of samples buffered in the resampler.
Definition stream.h:328
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:325
uint32_t queued_buffers
the number of buffers that are queued.
Definition stream.h:331
uint64_t ticks
the ticks at now.
Definition stream.h:313
uint64_t size
for audio/raw playback streams, this contains the number of samples requested by the resampler for th...
Definition stream.h:333
int64_t now
the time in nanoseconds.
Definition stream.h:305
uint32_t avail_buffers
the number of buffers that can be dequeued.
Definition stream.h:332
A Buffer.
Definition buffer.h:94
Definition command.h:29
Definition dict.h:39
Definition defs.h:123
A hook, contains the structure with functions and the data passed to the functions.
Definition hook.h:350
Definition pod.h:43