PipeWire  0.3.82
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 
288 struct pw_time {
289  int64_t now;
295  struct spa_fraction rate;
297  uint64_t ticks;
300  int64_t delay;
309  uint64_t queued;
312  uint64_t buffered;
315  uint32_t queued_buffers;
316  uint32_t avail_buffers;
317 };
318 
319 #include <pipewire/port.h>
320 
323 struct pw_stream_events {
324 #define PW_VERSION_STREAM_EVENTS 2
325  uint32_t version;
326 
327  void (*destroy) (void *data);
329  void (*state_changed) (void *data, enum pw_stream_state old,
330  enum pw_stream_state state, const char *error);
331 
333  void (*control_info) (void *data, uint32_t id, const struct pw_stream_control *control);
334 
336  void (*io_changed) (void *data, uint32_t id, void *area, uint32_t size);
338  void (*param_changed) (void *data, uint32_t id, const struct spa_pod *param);
339 
341  void (*add_buffer) (void *data, struct pw_buffer *buffer);
343  void (*remove_buffer) (void *data, struct pw_buffer *buffer);
344 
349  void (*process) (void *data);
350 
352  void (*drained) (void *data);
353 
355  void (*command) (void *data, const struct spa_command *command);
356 
358  void (*trigger_done) (void *data);
359 };
360 
362 const char * pw_stream_state_as_string(enum pw_stream_state state);
363 
365 enum pw_stream_flags {
366  PW_STREAM_FLAG_NONE = 0,
367  PW_STREAM_FLAG_AUTOCONNECT = (1 << 0),
369  PW_STREAM_FLAG_INACTIVE = (1 << 1),
373  PW_STREAM_FLAG_DRIVER = (1 << 3),
380  PW_STREAM_FLAG_DONT_RECONNECT = (1 << 7),
390  PW_STREAM_FLAG_ASYNC = (1 << 10),
397  PW_STREAM_FLAG_EARLY_PROCESS = (1 << 11),
402 };
403 
406 struct pw_stream *
407 pw_stream_new(struct pw_core *core,
408  const char *name,
409  struct pw_properties *props );
410 
411 struct pw_stream *
412 pw_stream_new_simple(struct pw_loop *loop,
413  const char *name,
414  struct pw_properties *props,
415  const struct pw_stream_events *events,
416  void *data );
417 
419 void pw_stream_destroy(struct pw_stream *stream);
420 
421 void pw_stream_add_listener(struct pw_stream *stream,
422  struct spa_hook *listener,
423  const struct pw_stream_events *events,
424  void *data);
425 
426 enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error);
427 
428 const char *pw_stream_get_name(struct pw_stream *stream);
429 
430 struct pw_core *pw_stream_get_core(struct pw_stream *stream);
431 
432 const struct pw_properties *pw_stream_get_properties(struct pw_stream *stream);
433 
434 int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict);
435 
441 int
442 pw_stream_connect(struct pw_stream *stream,
443  enum pw_direction direction,
444  uint32_t target_id,
454  enum pw_stream_flags flags,
455  const struct spa_pod **params,
458  uint32_t n_params );
459 
462 uint32_t
463 pw_stream_get_node_id(struct pw_stream *stream);
464 
466 int pw_stream_disconnect(struct pw_stream *stream);
467 
469 int pw_stream_set_error(struct pw_stream *stream,
470  int res,
471  const char *error,
472  ...) SPA_PRINTF_FUNC(3, 4);
473 
475 int
476 pw_stream_update_params(struct pw_stream *stream,
477  const struct spa_pod **params,
478  uint32_t n_params );
479 
484 int pw_stream_set_param(struct pw_stream *stream,
485  uint32_t id,
486  const struct spa_pod *param );
487 
489 const struct pw_stream_control *pw_stream_get_control(struct pw_stream *stream, uint32_t id);
490 
492 int pw_stream_set_control(struct pw_stream *stream, uint32_t id, uint32_t n_values, float *values, ...);
493 
495 int pw_stream_get_time_n(struct pw_stream *stream, struct pw_time *time, size_t size);
496 
500 int pw_stream_get_time(struct pw_stream *stream, struct pw_time *time);
501 
504 struct pw_buffer *pw_stream_dequeue_buffer(struct pw_stream *stream);
505 
507 int pw_stream_queue_buffer(struct pw_stream *stream, struct pw_buffer *buffer);
508 
510 int pw_stream_set_active(struct pw_stream *stream, bool active);
511 
514 int pw_stream_flush(struct pw_stream *stream, bool drain);
515 
520 bool pw_stream_is_driving(struct pw_stream *stream);
521 
524 int pw_stream_trigger_process(struct pw_stream *stream);
525 
530 #ifdef __cplusplus
531 }
532 #endif
533 
534 #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:371
int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict)
Definition: stream.c:1780
enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error)
Definition: stream.c:1760
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:2189
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:1883
uint32_t pw_stream_get_node_id(struct pw_stream *stream)
Get the node ID of the stream.
Definition: stream.c:2149
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:2230
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:1560
bool pw_stream_is_driving(struct pw_stream *stream)
Check if the stream is driving.
Definition: stream.c:2496
const struct pw_stream_control * pw_stream_get_control(struct pw_stream *stream, uint32_t id)
Get control values.
Definition: stream.c:2291
int pw_stream_flush(struct pw_stream *stream, bool drain)
Flush a stream.
Definition: stream.c:2479
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:2332
const char * pw_stream_get_name(struct pw_stream *stream)
Definition: stream.c:1768
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:1582
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:2218
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:2155
int pw_stream_set_active(struct pw_stream *stream, bool active)
Activate or deactivate the stream.
Definition: stream.c:2305
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:2387
int pw_stream_trigger_process(struct pw_stream *stream)
Trigger a push/pull on the stream.
Definition: stream.c:2533
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:2415
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:2338
void pw_stream_add_listener(struct pw_stream *stream, struct spa_hook *listener, const struct pw_stream_events *events, void *data)
Definition: stream.c:1741
const char * pw_stream_state_as_string(enum pw_stream_state state)
Convert a stream state to a readable string.
Definition: stream.c:1626
struct pw_core * pw_stream_get_core(struct pw_stream *stream)
Definition: stream.c:1806
void pw_stream_destroy(struct pw_stream *stream)
Destroy a stream.
Definition: stream.c:1676
const struct pw_properties * pw_stream_get_properties(struct pw_stream *stream)
Definition: stream.c:1774
@ PW_STREAM_FLAG_EARLY_PROCESS
Call process as soon as there is a buffer to dequeue.
Definition: stream.h:403
@ PW_STREAM_FLAG_INACTIVE
start the stream inactive, pw_stream_set_active() needs to be called explicitly
Definition: stream.h:375
@ PW_STREAM_FLAG_MAP_BUFFERS
mmap the buffers except DmaBuf
Definition: stream.h:378
@ PW_STREAM_FLAG_DRIVER
be a driver
Definition: stream.h:379
@ PW_STREAM_FLAG_EXCLUSIVE
require exclusive access to the device
Definition: stream.h:384
@ PW_STREAM_FLAG_ASYNC
Buffers will not be dequeued/queued from the realtime process() function.
Definition: stream.h:396
@ PW_STREAM_FLAG_NO_CONVERT
don't convert format
Definition: stream.h:383
@ PW_STREAM_FLAG_TRIGGER
the output stream will not be scheduled automatically but _trigger_process() needs to be called.
Definition: stream.h:391
@ PW_STREAM_FLAG_DONT_RECONNECT
don't try to reconnect this stream when the sink/source is removed
Definition: stream.h:386
@ PW_STREAM_FLAG_AUTOCONNECT
try to automatically connect this stream
Definition: stream.h:373
@ PW_STREAM_FLAG_ALLOC_BUFFERS
the application will allocate buffer memory.
Definition: stream.h:388
@ PW_STREAM_FLAG_RT_PROCESS
call process from the realtime thread.
Definition: stream.h:380
@ PW_STREAM_FLAG_NONE
no flags
Definition: stream.h:372
@ 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:328
void(* remove_buffer)(void *data, struct pw_buffer *buffer)
when a buffer was destroyed for this stream
Definition: stream.h:349
void(* control_info)(void *data, uint32_t id, const struct pw_stream_control *control)
Notify information about a control.
Definition: stream.h:339
void(* trigger_done)(void *data)
a trigger_process completed.
Definition: stream.h:364
void(* param_changed)(void *data, uint32_t id, const struct spa_pod *param)
when a parameter changed
Definition: stream.h:344
void(* process)(void *data)
when a buffer can be queued (for playback streams) or dequeued (for capture streams).
Definition: stream.h:355
void(* command)(void *data, const struct spa_command *command)
A command notify, Since 0.3.39:1.
Definition: stream.h:361
uint32_t version
Definition: stream.h:331
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:335
void(* drained)(void *data)
The stream is drained.
Definition: stream.h:358
void(* destroy)(void *data)
Definition: stream.h:333
void(* add_buffer)(void *data, struct pw_buffer *buffer)
when a new buffer was created for this stream
Definition: stream.h:347
void(* io_changed)(void *data, uint32_t id, void *area, uint32_t size)
when io changed on the stream.
Definition: stream.h:342
A time structure.
Definition: stream.h:293
int64_t delay
delay to device.
Definition: stream.h:305
struct spa_fraction rate
the rate of ticks and delay.
Definition: stream.h:300
uint64_t buffered
for audio/raw streams, this contains the extra number of samples buffered in the resampler.
Definition: stream.h:317
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:314
uint32_t queued_buffers
The number of buffers that are queued.
Definition: stream.h:320
uint64_t ticks
the ticks at now.
Definition: stream.h:302
int64_t now
the monotonic time in nanoseconds.
Definition: stream.h:294
uint32_t avail_buffers
The number of buffers that can be dequeued.
Definition: stream.h:321
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