PipeWire 1.0.4
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 {
191struct pw_buffer {
193 void *user_data;
194 uint64_t size;
198 uint64_t requested;
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;
289struct pw_time {
290 int64_t now;
296 struct spa_fraction rate;
298 uint64_t ticks;
301 int64_t delay;
310 uint64_t queued;
313 uint64_t buffered;
316 uint32_t queued_buffers;
317 uint32_t avail_buffers;
319
320#include <pipewire/port.h>
324struct pw_stream_events {
325#define PW_VERSION_STREAM_EVENTS 2
326 uint32_t version;
327
328 void (*destroy) (void *data);
330 void (*state_changed) (void *data, enum pw_stream_state old,
331 enum pw_stream_state state, const char *error);
334 void (*control_info) (void *data, uint32_t id, const struct pw_stream_control *control);
335
337 void (*io_changed) (void *data, uint32_t id, void *area, uint32_t size);
339 void (*param_changed) (void *data, uint32_t id, const struct spa_pod *param);
342 void (*add_buffer) (void *data, struct pw_buffer *buffer);
344 void (*remove_buffer) (void *data, struct pw_buffer *buffer);
350 void (*process) (void *data);
351
353 void (*drained) (void *data);
354
356 void (*command) (void *data, const struct spa_command *command);
357
359 void (*trigger_done) (void *data);
360};
361
363const char * pw_stream_state_as_string(enum pw_stream_state state);
364
366enum pw_stream_flags {
368 PW_STREAM_FLAG_AUTOCONNECT = (1 << 0),
370 PW_STREAM_FLAG_INACTIVE = (1 << 1),
376 PW_STREAM_FLAG_RT_PROCESS = (1 << 4),
379 PW_STREAM_FLAG_NO_CONVERT = (1 << 5),
399 PW_STREAM_FLAG_EARLY_PROCESS = (1 << 11),
405
408struct pw_stream *
409pw_stream_new(struct pw_core *core,
410 const char *name,
411 struct pw_properties *props );
412
413struct pw_stream *
414pw_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
444pw_stream_connect(struct pw_stream *stream,
445 enum pw_direction direction,
446 uint32_t target_id,
457 const struct spa_pod **params,
460 uint32_t n_params );
461
464uint32_t
465pw_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
477int
478pw_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
501uint64_t pw_stream_get_nsec(struct pw_stream *stream);
502
506int pw_stream_get_time(struct pw_stream *stream, struct pw_time *time);
507
510struct pw_buffer *pw_stream_dequeue_buffer(struct pw_stream *stream);
511
513int pw_stream_queue_buffer(struct pw_stream *stream, struct pw_buffer *buffer);
514
516int pw_stream_set_active(struct pw_stream *stream, bool active);
517
520int pw_stream_flush(struct pw_stream *stream, bool drain);
521
526bool pw_stream_is_driving(struct pw_stream *stream);
527
530int pw_stream_trigger_process(struct pw_stream *stream);
531
536#ifdef __cplusplus
537}
538#endif
539
540#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:372
int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict)
Definition stream.c:1788
enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error)
Definition stream.c:1768
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:1891
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:2409
uint32_t pw_stream_get_node_id(struct pw_stream *stream)
Get the node ID of the stream.
Definition stream.c:2157
uint64_t pw_stream_get_nsec(struct pw_stream *stream)
Get the current time in nanoseconds.
Definition stream.c:2392
int pw_stream_set_control(struct pw_stream *stream, uint32_t id, uint32_t n_values, float *values,...)
Set control values.
Definition stream.c:2239
bool pw_stream_is_driving(struct pw_stream *stream)
Check if the stream is driving.
Definition stream.c:2518
int pw_stream_flush(struct pw_stream *stream, bool drain)
Flush a stream.
Definition stream.c:2501
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:1568
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:2341
const struct pw_stream_control * pw_stream_get_control(struct pw_stream *stream, uint32_t id)
Get control values.
Definition stream.c:2300
const char * pw_stream_state_as_string(enum pw_stream_state state)
Convert a stream state to a readable string.
Definition stream.c:1634
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:2227
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:2171
int pw_stream_disconnect(struct pw_stream *stream)
Disconnect stream
Definition stream.c:2163
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:2197
int pw_stream_set_active(struct pw_stream *stream, bool active)
Activate or deactivate the stream.
Definition stream.c:2314
int pw_stream_trigger_process(struct pw_stream *stream)
Trigger a push/pull on the stream.
Definition stream.c:2555
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:2437
const char * pw_stream_get_name(struct pw_stream *stream)
Definition stream.c:1776
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:1590
const struct pw_properties * pw_stream_get_properties(struct pw_stream *stream)
Definition stream.c:1782
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:2347
void pw_stream_add_listener(struct pw_stream *stream, struct spa_hook *listener, const struct pw_stream_events *events, void *data)
Definition stream.c:1749
void pw_stream_destroy(struct pw_stream *stream)
Destroy a stream.
Definition stream.c:1684
struct pw_core * pw_stream_get_core(struct pw_stream *stream)
Definition stream.c:1814
@ PW_STREAM_FLAG_EARLY_PROCESS
Call process as soon as there is a buffer to dequeue.
Definition stream.h:405
@ PW_STREAM_FLAG_INACTIVE
start the stream inactive, pw_stream_set_active() needs to be called explicitly
Definition stream.h:376
@ PW_STREAM_FLAG_MAP_BUFFERS
mmap the buffers except DmaBuf that is not explicitly marked as mappable.
Definition stream.h:379
@ PW_STREAM_FLAG_DRIVER
be a driver
Definition stream.h:381
@ PW_STREAM_FLAG_EXCLUSIVE
require exclusive access to the device
Definition stream.h:386
@ PW_STREAM_FLAG_ASYNC
Buffers will not be dequeued/queued from the realtime process() function.
Definition stream.h:398
@ PW_STREAM_FLAG_NO_CONVERT
don't convert format
Definition stream.h:385
@ 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
don't try to reconnect this stream when the sink/source is removed
Definition stream.h:388
@ PW_STREAM_FLAG_AUTOCONNECT
try to automatically connect this stream
Definition stream.h:374
@ PW_STREAM_FLAG_ALLOC_BUFFERS
the application will allocate buffer memory.
Definition stream.h:390
@ PW_STREAM_FLAG_RT_PROCESS
call process from the realtime thread.
Definition stream.h:382
@ PW_STREAM_FLAG_NONE
no flags
Definition stream.h:373
@ 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 buffer is returned in the time info.
Definition stream.h:199
uint64_t requested
For playback streams, this field contains the suggested amount of data to provide.
Definition stream.h:203
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:210
float max
max value
Definition stream.h:215
uint32_t flags
extra flags (unused)
Definition stream.h:212
float def
default value
Definition stream.h:213
uint32_t max_values
max values that can be set on this control
Definition stream.h:218
float min
min value
Definition stream.h:214
uint32_t n_values
number of values in array
Definition stream.h:217
float * values
array of values
Definition stream.h:216
Events for a stream.
Definition stream.h:329
void(* remove_buffer)(void *data, struct pw_buffer *buffer)
when a buffer was destroyed for this stream
Definition stream.h:350
void(* control_info)(void *data, uint32_t id, const struct pw_stream_control *control)
Notify information about a control.
Definition stream.h:340
void(* trigger_done)(void *data)
a trigger_process completed.
Definition stream.h:365
void(* param_changed)(void *data, uint32_t id, const struct spa_pod *param)
when a parameter changed
Definition stream.h:345
void(* process)(void *data)
when a buffer can be queued (for playback streams) or dequeued (for capture streams).
Definition stream.h:356
void(* command)(void *data, const struct spa_command *command)
A command notify, Since 0.3.39:1.
Definition stream.h:362
uint32_t version
Definition stream.h:332
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:336
void(* drained)(void *data)
The stream is drained.
Definition stream.h:359
void(* destroy)(void *data)
Definition stream.h:334
void(* add_buffer)(void *data, struct pw_buffer *buffer)
when a new buffer was created for this stream
Definition stream.h:348
void(* io_changed)(void *data, uint32_t id, void *area, uint32_t size)
when io changed on the stream.
Definition stream.h:343
A time structure.
Definition stream.h:294
int64_t delay
delay to device.
Definition stream.h:306
struct spa_fraction rate
the rate of ticks and delay.
Definition stream.h:301
uint64_t buffered
for audio/raw streams, this contains the extra number of samples buffered in the resampler.
Definition stream.h:318
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:315
uint32_t queued_buffers
The number of buffers that are queued.
Definition stream.h:321
uint64_t ticks
the ticks at now.
Definition stream.h:303
int64_t now
the monotonic time in nanoseconds.
Definition stream.h:295
uint32_t avail_buffers
The number of buffers that can be dequeued.
Definition stream.h:322
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