PipeWire  0.3.52
stream.h
Go to the documentation of this file.
1 /* PipeWire
2  *
3  * Copyright © 2018 Wim Taymans
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a
6  * copy of this software and associated documentation files (the "Software"),
7  * to deal in the Software without restriction, including without limitation
8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9  * and/or sell copies of the Software, and to permit persons to whom the
10  * Software is furnished to do so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice (including the next
13  * paragraph) shall be included in all copies or substantial portions of the
14  * Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22  * DEALINGS IN THE SOFTWARE.
23  */
24 
25 #ifndef PIPEWIRE_STREAM_H
26 #define PIPEWIRE_STREAM_H
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
188 struct pw_stream;
189 
190 #include <spa/buffer/buffer.h>
191 #include <spa/param/param.h>
193 
195 enum pw_stream_state {
196  PW_STREAM_STATE_ERROR = -1,
201 };
202 
205 struct pw_buffer {
206  struct spa_buffer *buffer;
207  void *user_data;
208  uint64_t size;
212  uint64_t requested;
217 };
218 
219 struct pw_stream_control {
220  const char *name;
221  uint32_t flags;
222  float def;
223  float min;
224  float max;
225  float *values;
226  uint32_t n_values;
227  uint32_t max_values;
228 };
229 
295 struct pw_time {
296  int64_t now;
302  struct spa_fraction rate;
304  uint64_t ticks;
307  int64_t delay;
316  uint64_t queued;
319  uint64_t buffered;
322  uint32_t queued_buffers;
323  uint32_t avail_buffers;
324 };
325 
326 #include <pipewire/port.h>
327 
330 struct pw_stream_events {
331 #define PW_VERSION_STREAM_EVENTS 2
332  uint32_t version;
333 
334  void (*destroy) (void *data);
336  void (*state_changed) (void *data, enum pw_stream_state old,
337  enum pw_stream_state state, const char *error);
338 
340  void (*control_info) (void *data, uint32_t id, const struct pw_stream_control *control);
341 
343  void (*io_changed) (void *data, uint32_t id, void *area, uint32_t size);
345  void (*param_changed) (void *data, uint32_t id, const struct spa_pod *param);
346 
348  void (*add_buffer) (void *data, struct pw_buffer *buffer);
350  void (*remove_buffer) (void *data, struct pw_buffer *buffer);
351 
356  void (*process) (void *data);
357 
359  void (*drained) (void *data);
360 
362  void (*command) (void *data, const struct spa_command *command);
363 
365  void (*trigger_done) (void *data);
366 };
367 
369 const char * pw_stream_state_as_string(enum pw_stream_state state);
370 
372 enum pw_stream_flags {
373  PW_STREAM_FLAG_NONE = 0,
374  PW_STREAM_FLAG_AUTOCONNECT = (1 << 0),
376  PW_STREAM_FLAG_INACTIVE = (1 << 1),
380  PW_STREAM_FLAG_DRIVER = (1 << 3),
387  PW_STREAM_FLAG_DONT_RECONNECT = (1 << 7),
397 };
398 
401 struct pw_stream *
402 pw_stream_new(struct pw_core *core,
403  const char *name,
404  struct pw_properties *props );
405 
406 struct pw_stream *
407 pw_stream_new_simple(struct pw_loop *loop,
408  const char *name,
409  struct pw_properties *props,
410  const struct pw_stream_events *events,
411  void *data );
412 
414 void pw_stream_destroy(struct pw_stream *stream);
415 
416 void pw_stream_add_listener(struct pw_stream *stream,
417  struct spa_hook *listener,
418  const struct pw_stream_events *events,
419  void *data);
420 
421 enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error);
422 
423 const char *pw_stream_get_name(struct pw_stream *stream);
424 
425 struct pw_core *pw_stream_get_core(struct pw_stream *stream);
426 
427 const struct pw_properties *pw_stream_get_properties(struct pw_stream *stream);
428 
429 int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict);
430 
436 int
437 pw_stream_connect(struct pw_stream *stream,
438  enum pw_direction direction,
439  uint32_t target_id,
442  enum pw_stream_flags flags,
443  const struct spa_pod **params,
446  uint32_t n_params );
447 
450 uint32_t
451 pw_stream_get_node_id(struct pw_stream *stream);
452 
454 int pw_stream_disconnect(struct pw_stream *stream);
455 
457 int pw_stream_set_error(struct pw_stream *stream,
458  int res,
459  const char *error,
460  ...) SPA_PRINTF_FUNC(3, 4);
461 
468 int
469 pw_stream_update_params(struct pw_stream *stream,
470  const struct spa_pod **params,
473  uint32_t n_params );
474 
476 const struct pw_stream_control *pw_stream_get_control(struct pw_stream *stream, uint32_t id);
477 
479 int pw_stream_set_control(struct pw_stream *stream, uint32_t id, uint32_t n_values, float *values, ...);
480 
482 int pw_stream_get_time_n(struct pw_stream *stream, struct pw_time *time, size_t size);
483 
487 int pw_stream_get_time(struct pw_stream *stream, struct pw_time *time);
488 
491 struct pw_buffer *pw_stream_dequeue_buffer(struct pw_stream *stream);
492 
494 int pw_stream_queue_buffer(struct pw_stream *stream, struct pw_buffer *buffer);
495 
497 int pw_stream_set_active(struct pw_stream *stream, bool active);
498 
501 int pw_stream_flush(struct pw_stream *stream, bool drain);
502 
507 bool pw_stream_is_driving(struct pw_stream *stream);
508 
511 int pw_stream_trigger_process(struct pw_stream *stream);
512 
517 #ifdef __cplusplus
518 }
519 #endif
520 
521 #endif /* PIPEWIRE_STREAM_H */
spa/buffer/buffer.h
#define pw_direction
The direction of a port.
Definition: port.h:63
pw_stream_flags
Extra flags that can be used in pw_stream_connect()
Definition: stream.h:378
int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict)
Definition: stream.c:1671
enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error)
Definition: stream.c:1651
int int pw_stream_update_params(struct pw_stream *stream, const struct spa_pod **params, uint32_t n_params)
Complete the negotiation process with result code res.
Definition: stream.c:2058
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:1773
uint32_t pw_stream_get_node_id(struct pw_stream *stream)
Get the node ID of the stream.
Definition: stream.c:1994
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:2076
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:1498
bool pw_stream_is_driving(struct pw_stream *stream)
Check if the stream is driving.
Definition: stream.c:2319
const struct pw_stream_control * pw_stream_get_control(struct pw_stream *stream, uint32_t id)
Get control values.
Definition: stream.c:2136
int pw_stream_flush(struct pw_stream *stream, bool drain)
Flush a stream.
Definition: stream.c:2307
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:2171
const char * pw_stream_get_name(struct pw_stream *stream)
Definition: stream.c:1659
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:1520
pw_stream_state
The state of a stream.
Definition: stream.h:200
int pw_stream_disconnect(struct pw_stream *stream)
Disconnect stream
Definition: stream.c:2000
int pw_stream_set_active(struct pw_stream *stream, bool active)
Activate or deactivate the stream.
Definition: stream.c:2150
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:2226
int pw_stream_trigger_process(struct pw_stream *stream)
Trigger a push/pull on the stream.
Definition: stream.c:2354
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:2253
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:2177
void pw_stream_add_listener(struct pw_stream *stream, struct spa_hook *listener, const struct pw_stream_events *events, void *data)
Definition: stream.c:1635
const char * pw_stream_state_as_string(enum pw_stream_state state)
Convert a stream state to a readable string.
Definition: stream.c:1564
struct pw_core * pw_stream_get_core(struct pw_stream *stream)
Definition: stream.c:1695
void pw_stream_destroy(struct pw_stream *stream)
Destroy a stream.
Definition: stream.c:1582
const struct pw_properties * pw_stream_get_properties(struct pw_stream *stream)
Definition: stream.c:1665
@ PW_STREAM_FLAG_INACTIVE
start the stream inactive, pw_stream_set_active() needs to be called explicitly
Definition: stream.h:382
@ PW_STREAM_FLAG_MAP_BUFFERS
mmap the buffers except DmaBuf
Definition: stream.h:385
@ PW_STREAM_FLAG_DRIVER
be a driver
Definition: stream.h:386
@ PW_STREAM_FLAG_EXCLUSIVE
require exclusive access to the device
Definition: stream.h:391
@ PW_STREAM_FLAG_NO_CONVERT
don't convert format
Definition: stream.h:390
@ PW_STREAM_FLAG_TRIGGER
the output stream will not be scheduled automatically but _trigger_process() needs to be called.
Definition: stream.h:398
@ PW_STREAM_FLAG_DONT_RECONNECT
don't try to reconnect this stream when the sink/source is removed
Definition: stream.h:393
@ PW_STREAM_FLAG_AUTOCONNECT
try to automatically connect this stream
Definition: stream.h:380
@ PW_STREAM_FLAG_ALLOC_BUFFERS
the application will allocate buffer memory.
Definition: stream.h:395
@ PW_STREAM_FLAG_RT_PROCESS
call process from the realtime thread.
Definition: stream.h:387
@ PW_STREAM_FLAG_NONE
no flags
Definition: stream.h:379
@ PW_STREAM_STATE_PAUSED
paused
Definition: stream.h:204
@ PW_STREAM_STATE_CONNECTING
connection is in progress
Definition: stream.h:203
@ PW_STREAM_STATE_UNCONNECTED
unconnected
Definition: stream.h:202
@ PW_STREAM_STATE_ERROR
the stream is in error
Definition: stream.h:201
@ PW_STREAM_STATE_STREAMING
streaming
Definition: stream.h:205
#define SPA_DEPRECATED
Definition: defs.h:266
#define SPA_PRINTF_FUNC(fmt, arg1)
Definition: defs.h:260
spa/param/param.h
spa/pod/command.h
pipewire/port.h
a buffer structure obtained from pw_stream_dequeue_buffer().
Definition: stream.h:210
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:213
uint64_t requested
For playback streams, this field contains the suggested amount of data to provide.
Definition: stream.h:217
struct spa_buffer * buffer
the spa buffer
Definition: stream.h:211
void * user_data
user data attached to the buffer
Definition: stream.h:212
Definition: loop.h:51
Definition: properties.h:53
struct spa_dict dict
dictionary of key/values
Definition: properties.h:54
uint32_t flags
extra flags
Definition: properties.h:55
Definition: stream.h:224
float max
max value
Definition: stream.h:229
uint32_t flags
extra flags (unused)
Definition: stream.h:226
float def
default value
Definition: stream.h:227
uint32_t max_values
max values that can be set on this control
Definition: stream.h:232
float min
min value
Definition: stream.h:228
uint32_t n_values
number of values in array
Definition: stream.h:231
float * values
array of values
Definition: stream.h:230
Events for a stream.
Definition: stream.h:335
void(* remove_buffer)(void *data, struct pw_buffer *buffer)
when a buffer was destroyed for this stream
Definition: stream.h:356
void(* control_info)(void *data, uint32_t id, const struct pw_stream_control *control)
Notify information about a control.
Definition: stream.h:346
void(* trigger_done)(void *data)
a trigger_process completed.
Definition: stream.h:371
void(* param_changed)(void *data, uint32_t id, const struct spa_pod *param)
when a parameter changed
Definition: stream.h:351
void(* process)(void *data)
when a buffer can be queued (for playback streams) or dequeued (for capture streams).
Definition: stream.h:362
void(* command)(void *data, const struct spa_command *command)
A command notify, Since 0.3.39:1.
Definition: stream.h:368
uint32_t version
Definition: stream.h:338
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:342
void(* drained)(void *data)
The stream is drained.
Definition: stream.h:365
void(* destroy)(void *data)
Definition: stream.h:340
void(* add_buffer)(void *data, struct pw_buffer *buffer)
when a new buffer was created for this stream
Definition: stream.h:354
void(* io_changed)(void *data, uint32_t id, void *area, uint32_t size)
when io changed on the stream.
Definition: stream.h:349
A time structure.
Definition: stream.h:300
int64_t delay
delay to device.
Definition: stream.h:312
struct spa_fraction rate
the rate of ticks and delay.
Definition: stream.h:307
uint64_t buffered
for audio/raw streams, this contains the extra number of samples buffered in the resampler.
Definition: stream.h:324
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:321
uint32_t queued_buffers
The number of buffers that are queued.
Definition: stream.h:327
uint64_t ticks
the ticks at now.
Definition: stream.h:309
int64_t now
the monotonic time in nanoseconds.
Definition: stream.h:301
uint32_t avail_buffers
The number of buffers that can be dequeued.
Definition: stream.h:328
A Buffer.
Definition: buffer.h:109
Definition: command.h:49
Definition: dict.h:59
Definition: defs.h:121
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:351
Definition: pod.h:63