PipeWire  0.3.77
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
9 extern "C" {
10 #endif
11 
172 struct pw_stream;
173 
174 #include <spa/buffer/buffer.h>
175 #include <spa/param/param.h>
177 
179 enum pw_stream_state {
180  PW_STREAM_STATE_ERROR = -1,
185 };
186 
189 struct pw_buffer {
190  struct spa_buffer *buffer;
191  void *user_data;
192  uint64_t size;
196  uint64_t requested;
201 };
202 
203 struct pw_stream_control {
204  const char *name;
205  uint32_t flags;
206  float def;
207  float min;
208  float max;
209  float *values;
210  uint32_t n_values;
211  uint32_t max_values;
212 };
213 
279 struct pw_time {
280  int64_t now;
286  struct spa_fraction rate;
288  uint64_t ticks;
291  int64_t delay;
300  uint64_t queued;
303  uint64_t buffered;
306  uint32_t queued_buffers;
307  uint32_t avail_buffers;
308 };
309 
310 #include <pipewire/port.h>
311 
314 struct pw_stream_events {
315 #define PW_VERSION_STREAM_EVENTS 2
316  uint32_t version;
317 
318  void (*destroy) (void *data);
320  void (*state_changed) (void *data, enum pw_stream_state old,
321  enum pw_stream_state state, const char *error);
322 
324  void (*control_info) (void *data, uint32_t id, const struct pw_stream_control *control);
325 
327  void (*io_changed) (void *data, uint32_t id, void *area, uint32_t size);
329  void (*param_changed) (void *data, uint32_t id, const struct spa_pod *param);
330 
332  void (*add_buffer) (void *data, struct pw_buffer *buffer);
334  void (*remove_buffer) (void *data, struct pw_buffer *buffer);
335 
340  void (*process) (void *data);
341 
343  void (*drained) (void *data);
344 
346  void (*command) (void *data, const struct spa_command *command);
347 
349  void (*trigger_done) (void *data);
350 };
351 
353 const char * pw_stream_state_as_string(enum pw_stream_state state);
354 
356 enum pw_stream_flags {
357  PW_STREAM_FLAG_NONE = 0,
358  PW_STREAM_FLAG_AUTOCONNECT = (1 << 0),
360  PW_STREAM_FLAG_INACTIVE = (1 << 1),
364  PW_STREAM_FLAG_DRIVER = (1 << 3),
371  PW_STREAM_FLAG_DONT_RECONNECT = (1 << 7),
381  PW_STREAM_FLAG_ASYNC = (1 << 10),
388 };
389 
392 struct pw_stream *
393 pw_stream_new(struct pw_core *core,
394  const char *name,
395  struct pw_properties *props );
396 
397 struct pw_stream *
398 pw_stream_new_simple(struct pw_loop *loop,
399  const char *name,
400  struct pw_properties *props,
401  const struct pw_stream_events *events,
402  void *data );
403 
405 void pw_stream_destroy(struct pw_stream *stream);
406 
407 void pw_stream_add_listener(struct pw_stream *stream,
408  struct spa_hook *listener,
409  const struct pw_stream_events *events,
410  void *data);
411 
412 enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error);
413 
414 const char *pw_stream_get_name(struct pw_stream *stream);
415 
416 struct pw_core *pw_stream_get_core(struct pw_stream *stream);
417 
418 const struct pw_properties *pw_stream_get_properties(struct pw_stream *stream);
419 
420 int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict);
421 
427 int
428 pw_stream_connect(struct pw_stream *stream,
429  enum pw_direction direction,
430  uint32_t target_id,
440  enum pw_stream_flags flags,
441  const struct spa_pod **params,
444  uint32_t n_params );
445 
448 uint32_t
449 pw_stream_get_node_id(struct pw_stream *stream);
450 
452 int pw_stream_disconnect(struct pw_stream *stream);
453 
455 int pw_stream_set_error(struct pw_stream *stream,
456  int res,
457  const char *error,
458  ...) SPA_PRINTF_FUNC(3, 4);
459 
461 int
462 pw_stream_update_params(struct pw_stream *stream,
463  const struct spa_pod **params,
466  uint32_t n_params );
467 
472 int pw_stream_set_param(struct pw_stream *stream,
473  uint32_t id,
474  const struct spa_pod *param );
475 
477 const struct pw_stream_control *pw_stream_get_control(struct pw_stream *stream, uint32_t id);
478 
480 int pw_stream_set_control(struct pw_stream *stream, uint32_t id, uint32_t n_values, float *values, ...);
481 
483 int pw_stream_get_time_n(struct pw_stream *stream, struct pw_time *time, size_t size);
484 
488 int pw_stream_get_time(struct pw_stream *stream, struct pw_time *time);
489 
492 struct pw_buffer *pw_stream_dequeue_buffer(struct pw_stream *stream);
493 
495 int pw_stream_queue_buffer(struct pw_stream *stream, struct pw_buffer *buffer);
496 
498 int pw_stream_set_active(struct pw_stream *stream, bool active);
499 
502 int pw_stream_flush(struct pw_stream *stream, bool drain);
503 
508 bool pw_stream_is_driving(struct pw_stream *stream);
509 
512 int pw_stream_trigger_process(struct pw_stream *stream);
513 
518 #ifdef __cplusplus
519 }
520 #endif
521 
522 #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:362
int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict)
Definition: stream.c:1776
enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error)
Definition: stream.c:1756
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:2183
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:1879
uint32_t pw_stream_get_node_id(struct pw_stream *stream)
Get the node ID of the stream.
Definition: stream.c:2143
int pw_stream_set_error(struct pw_stream *stream, int res, const char *error,...) 1(3
Set the stream in error state.
int pw_stream_set_control(struct pw_stream *stream, uint32_t id, uint32_t n_values, float *values,...)
Set control values.
Definition: stream.c:2224
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:1556
bool pw_stream_is_driving(struct pw_stream *stream)
Check if the stream is driving.
Definition: stream.c:2490
const struct pw_stream_control * pw_stream_get_control(struct pw_stream *stream, uint32_t id)
Get control values.
Definition: stream.c:2285
int pw_stream_flush(struct pw_stream *stream, bool drain)
Flush a stream.
Definition: stream.c:2473
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:2326
const char * pw_stream_get_name(struct pw_stream *stream)
Definition: stream.c:1764
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:1578
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:2212
pw_stream_state
The state of a stream.
Definition: stream.h:184
int pw_stream_disconnect(struct pw_stream *stream)
Disconnect stream
Definition: stream.c:2149
int pw_stream_set_active(struct pw_stream *stream, bool active)
Activate or deactivate the stream.
Definition: stream.c:2299
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:2381
int pw_stream_trigger_process(struct pw_stream *stream)
Trigger a push/pull on the stream.
Definition: stream.c:2527
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:2409
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:2332
void pw_stream_add_listener(struct pw_stream *stream, struct spa_hook *listener, const struct pw_stream_events *events, void *data)
Definition: stream.c:1737
const char * pw_stream_state_as_string(enum pw_stream_state state)
Convert a stream state to a readable string.
Definition: stream.c:1622
struct pw_core * pw_stream_get_core(struct pw_stream *stream)
Definition: stream.c:1802
void pw_stream_destroy(struct pw_stream *stream)
Destroy a stream.
Definition: stream.c:1672
const struct pw_properties * pw_stream_get_properties(struct pw_stream *stream)
Definition: stream.c:1770
@ PW_STREAM_FLAG_INACTIVE
start the stream inactive, pw_stream_set_active() needs to be called explicitly
Definition: stream.h:366
@ PW_STREAM_FLAG_MAP_BUFFERS
mmap the buffers except DmaBuf
Definition: stream.h:369
@ PW_STREAM_FLAG_DRIVER
be a driver
Definition: stream.h:370
@ PW_STREAM_FLAG_EXCLUSIVE
require exclusive access to the device
Definition: stream.h:375
@ PW_STREAM_FLAG_ASYNC
Buffers will not be dequeued/queued from the realtime process() function.
Definition: stream.h:387
@ PW_STREAM_FLAG_NO_CONVERT
don't convert format
Definition: stream.h:374
@ PW_STREAM_FLAG_TRIGGER
the output stream will not be scheduled automatically but _trigger_process() needs to be called.
Definition: stream.h:382
@ PW_STREAM_FLAG_DONT_RECONNECT
don't try to reconnect this stream when the sink/source is removed
Definition: stream.h:377
@ PW_STREAM_FLAG_AUTOCONNECT
try to automatically connect this stream
Definition: stream.h:364
@ PW_STREAM_FLAG_ALLOC_BUFFERS
the application will allocate buffer memory.
Definition: stream.h:379
@ PW_STREAM_FLAG_RT_PROCESS
call process from the realtime thread.
Definition: stream.h:371
@ PW_STREAM_FLAG_NONE
no flags
Definition: stream.h:363
@ PW_STREAM_STATE_PAUSED
paused
Definition: stream.h:188
@ PW_STREAM_STATE_CONNECTING
connection is in progress
Definition: stream.h:187
@ PW_STREAM_STATE_UNCONNECTED
unconnected
Definition: stream.h:186
@ PW_STREAM_STATE_ERROR
the stream is in error
Definition: stream.h:185
@ PW_STREAM_STATE_STREAMING
streaming
Definition: stream.h:189
#define SPA_DEPRECATED
Definition: defs.h:279
#define SPA_PRINTF_FUNC(fmt, arg1)
Definition: defs.h:273
spa/param/param.h
spa/pod/command.h
pipewire/port.h
a buffer structure obtained from pw_stream_dequeue_buffer().
Definition: stream.h:194
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:197
uint64_t requested
For playback streams, this field contains the suggested amount of data to provide.
Definition: stream.h:201
struct spa_buffer * buffer
the spa buffer
Definition: stream.h:195
void * user_data
user data attached to the buffer
Definition: stream.h:196
Definition: src/pipewire/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:208
float max
max value
Definition: stream.h:213
uint32_t flags
extra flags (unused)
Definition: stream.h:210
float def
default value
Definition: stream.h:211
uint32_t max_values
max values that can be set on this control
Definition: stream.h:216
float min
min value
Definition: stream.h:212
uint32_t n_values
number of values in array
Definition: stream.h:215
float * values
array of values
Definition: stream.h:214
Events for a stream.
Definition: stream.h:319
void(* remove_buffer)(void *data, struct pw_buffer *buffer)
when a buffer was destroyed for this stream
Definition: stream.h:340
void(* control_info)(void *data, uint32_t id, const struct pw_stream_control *control)
Notify information about a control.
Definition: stream.h:330
void(* trigger_done)(void *data)
a trigger_process completed.
Definition: stream.h:355
void(* param_changed)(void *data, uint32_t id, const struct spa_pod *param)
when a parameter changed
Definition: stream.h:335
void(* process)(void *data)
when a buffer can be queued (for playback streams) or dequeued (for capture streams).
Definition: stream.h:346
void(* command)(void *data, const struct spa_command *command)
A command notify, Since 0.3.39:1.
Definition: stream.h:352
uint32_t version
Definition: stream.h:322
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:326
void(* drained)(void *data)
The stream is drained.
Definition: stream.h:349
void(* destroy)(void *data)
Definition: stream.h:324
void(* add_buffer)(void *data, struct pw_buffer *buffer)
when a new buffer was created for this stream
Definition: stream.h:338
void(* io_changed)(void *data, uint32_t id, void *area, uint32_t size)
when io changed on the stream.
Definition: stream.h:333
A time structure.
Definition: stream.h:284
int64_t delay
delay to device.
Definition: stream.h:296
struct spa_fraction rate
the rate of ticks and delay.
Definition: stream.h:291
uint64_t buffered
for audio/raw streams, this contains the extra number of samples buffered in the resampler.
Definition: stream.h:308
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:305
uint32_t queued_buffers
The number of buffers that are queued.
Definition: stream.h:311
uint64_t ticks
the ticks at now.
Definition: stream.h:293
int64_t now
the monotonic time in nanoseconds.
Definition: stream.h:285
uint32_t avail_buffers
The number of buffers that can be dequeued.
Definition: stream.h:312
A Buffer.
Definition: buffer/buffer.h:90
Definition: pod/command.h:29
Definition: utils/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/pod.h:43