PipeWire: pipewire/stream.h Source File

PipeWire 1.6.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
233
238struct pw_stream;
239
240#include <spa/buffer/buffer.h>
241#include <spa/param/param.h>
242#include <spa/pod/command.h>
243#include <spa/pod/event.h>
244
246enum pw_stream_state {
247 PW_STREAM_STATE_ERROR = -1,
248 PW_STREAM_STATE_UNCONNECTED = 0,
249 PW_STREAM_STATE_CONNECTING = 1,
250 PW_STREAM_STATE_PAUSED = 2,
251 PW_STREAM_STATE_STREAMING = 3
252};
253
256 struct pw_buffer {
257 struct spa_buffer *buffer;
258 void *user_data;
261 * cleanup should be performed in the remove_buffer
262 * event. The user data is returned unmodified each
263 * time a buffer is dequeued. */
264 uint64_t size;
268 uint64_t requested;
273 uint64_t time;
278};
279
280struct pw_stream_control {
281 const char *name;
282 uint32_t flags;
283 float def;
284 float min;
285 float max;
286 float *values;
287 uint32_t n_values;
288 uint32_t max_values;
289};
290
295
377struct pw_time {
378 int64_t now;
382 * the current time and calculate updated ticks and delay
383 * values. */
384 struct spa_fraction rate;
386 uint64_t ticks;
389 int64_t delay;
399 uint64_t queued;
402 uint64_t buffered;
405 uint32_t queued_buffers;
406 uint32_t avail_buffers;
407 uint64_t size;
411};
412
413#include <pipewire/port.h>
414
417struct pw_stream_events {
418#define PW_VERSION_STREAM_EVENTS 2
419 uint32_t version;
420
421 void (*destroy) (void *data);
422 /** when the stream state changes. Since 1.4 this also sets errno when the
423 * new state is PW_STREAM_STATE_ERROR */
424 void (*state_changed) (void *data, enum pw_stream_state old,
425 enum pw_stream_state state, const char *error);
426
428 void (*control_info) (void *data, uint32_t id, const struct pw_stream_control *control);
429
431 void (*io_changed) (void *data, uint32_t id, void *area, uint32_t size);
433 void (*param_changed) (void *data, uint32_t id, const struct spa_pod *param);
434
436 void (*add_buffer) (void *data, struct pw_buffer *buffer);
438 void (*remove_buffer) (void *data, struct pw_buffer *buffer);
439
444 void (*process) (void *data);
445
447 void (*drained) (void *data);
448
450 void (*command) (void *data, const struct spa_command *command);
451
456 void (*trigger_done) (void *data);
457};
458
460const char * pw_stream_state_as_string(enum pw_stream_state state);
461
463enum pw_stream_flags {
464 PW_STREAM_FLAG_NONE = 0,
465 PW_STREAM_FLAG_AUTOCONNECT = (1 << 0),
467 PW_STREAM_FLAG_INACTIVE = (1 << 1),
469 * called explicitly */
470 PW_STREAM_FLAG_MAP_BUFFERS = (1 << 2),
472 PW_STREAM_FLAG_DRIVER = (1 << 3),
473 PW_STREAM_FLAG_RT_PROCESS = (1 << 4),
476 PW_STREAM_FLAG_NO_CONVERT = (1 << 5),
477 PW_STREAM_FLAG_EXCLUSIVE = (1 << 6),
479 PW_STREAM_FLAG_DONT_RECONNECT = (1 << 7),
481 PW_STREAM_FLAG_ALLOC_BUFFERS = (1 << 8),
484 PW_STREAM_FLAG_TRIGGER = (1 << 9),
489 PW_STREAM_FLAG_ASYNC = (1 << 10),
496 PW_STREAM_FLAG_EARLY_PROCESS = (1 << 11),
501 PW_STREAM_FLAG_RT_TRIGGER_DONE = (1 << 12),
504};
505
508struct pw_stream *
509 pw_stream_new(struct pw_core *core,
510 const char *name,
511 struct pw_properties *props );
512
513struct pw_stream *
514 pw_stream_new_simple(struct pw_loop *loop,
515 const char *name,
516 struct pw_properties *props,
517 const struct pw_stream_events *events,
518 void *data );
519
521void pw_stream_destroy(struct pw_stream *stream);
522
523void pw_stream_add_listener(struct pw_stream *stream,
524 struct spa_hook *listener,
525 const struct pw_stream_events *events,
526 void *data);
527
530enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error);
531
532const char *pw_stream_get_name(struct pw_stream *stream);
533
534struct pw_core *pw_stream_get_core(struct pw_stream *stream);
535
536const struct pw_properties *pw_stream_get_properties(struct pw_stream *stream);
537
538int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict);
539
545int
546 pw_stream_connect(struct pw_stream *stream,
547 enum pw_direction direction,
548 uint32_t target_id,
558 enum pw_stream_flags flags,
559 const struct spa_pod **params,
562 uint32_t n_params );
563
566uint32_t
567 pw_stream_get_node_id(struct pw_stream *stream);
568
570int pw_stream_disconnect(struct pw_stream *stream);
571
573int pw_stream_set_error(struct pw_stream *stream,
574 int res,
575 const char *error,
576 ...) SPA_PRINTF_FUNC(3, 4);
577
579int
580 pw_stream_update_params(struct pw_stream *stream,
581 const struct spa_pod **params,
582 uint32_t n_params );
583
588int pw_stream_set_param(struct pw_stream *stream,
589 uint32_t id,
590 const struct spa_pod *param );
591
593const struct pw_stream_control *pw_stream_get_control(struct pw_stream *stream, uint32_t id);
594
596int pw_stream_set_control(struct pw_stream *stream, uint32_t id, uint32_t n_values, float *values, ...);
597
599int pw_stream_get_time_n(struct pw_stream *stream, struct pw_time *time, size_t size);
600
603uint64_t pw_stream_get_nsec(struct pw_stream *stream);
604
607struct pw_loop *pw_stream_get_data_loop(struct pw_stream *stream);
608
611 SPA_DEPRECATED
612int pw_stream_get_time(struct pw_stream *stream, struct pw_time *time);
613
616struct pw_buffer *pw_stream_dequeue_buffer(struct pw_stream *stream);
617
619int pw_stream_queue_buffer(struct pw_stream *stream, struct pw_buffer *buffer);
620
623int pw_stream_return_buffer(struct pw_stream *stream, struct pw_buffer *buffer);
624
626int pw_stream_set_active(struct pw_stream *stream, bool active);
627
634int pw_stream_flush(struct pw_stream *stream, bool drain);
635
640bool pw_stream_is_driving(struct pw_stream *stream);
641
655bool pw_stream_is_lazy(struct pw_stream *stream);
656
686int pw_stream_trigger_process(struct pw_stream *stream);
687
690int pw_stream_emit_event(struct pw_stream *stream, const struct spa_event *event);
691
698int pw_stream_set_rate(struct pw_stream *stream, double rate);
699
703
704#ifdef __cplusplus
705}
706#endif
707
708#endif /* PIPEWIRE_STREAM_H */
buffer.h
spa/buffer/buffer.h
id
uint32_t id
Definition core.h:432
res
uint32_t int int res
Definition core.h:433
pw_direction
#define pw_direction
The direction of a port.
Definition port.h:51
pw_stream_flags
pw_stream_flags
Extra flags that can be used in pw_stream_connect().
Definition stream.h:469
pw_stream_update_properties
int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict)
Definition stream.c:1871
pw_stream_get_state
enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error)
Get the current stream state.
Definition stream.c:1849
pw_stream_connect
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:1974
pw_stream_dequeue_buffer
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:2545
pw_stream_get_node_id
uint32_t pw_stream_get_node_id(struct pw_stream *stream)
Get the node ID of the stream.
Definition stream.c:2266
pw_stream_get_nsec
uint64_t pw_stream_get_nsec(struct pw_stream *stream)
Get the current time in nanoseconds.
Definition stream.c:2519
pw_stream_emit_event
int pw_stream_emit_event(struct pw_stream *stream, const struct spa_event *event)
Emit an event from this stream.
Definition stream.c:2746
pw_stream_set_control
int pw_stream_set_control(struct pw_stream *stream, uint32_t id, uint32_t n_values, float *values,...)
Set control values.
Definition stream.c:2348
pw_stream_return_buffer
int pw_stream_return_buffer(struct pw_stream *stream, struct pw_buffer *buffer)
Return a buffer to the queue without using it.
Definition stream.c:2634
pw_stream_get_data_loop
struct pw_loop * pw_stream_get_data_loop(struct pw_stream *stream)
Get the data loop that is doing the processing of this stream.
Definition stream.c:2527
pw_stream_is_driving
bool pw_stream_is_driving(struct pw_stream *stream)
Check if the stream is driving.
Definition stream.c:2708
pw_stream_flush
int pw_stream_flush(struct pw_stream *stream, bool drain)
Flush a stream.
Definition stream.c:2691
pw_stream_new
struct pw_stream * pw_stream_new(struct pw_core *core, const char *name, struct pw_properties *props)
Create a new unconnected Stream.
Definition stream.c:1641
pw_stream_get_time
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:2461
pw_stream_set_rate
int pw_stream_set_rate(struct pw_stream *stream, double rate)
Adjust the rate of the stream.
Definition stream.c:2777
pw_stream_get_control
const struct pw_stream_control * pw_stream_get_control(struct pw_stream *stream, uint32_t id)
Get control values.
Definition stream.c:2409
pw_stream_state_as_string
const char * pw_stream_state_as_string(enum pw_stream_state state)
Convert a stream state to a readable string.
Definition stream.c:1707
pw_stream_set_param
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:2336
pw_stream_state
pw_stream_state
The state of a stream.
Definition stream.h:251
pw_stream_set_error
int pw_stream_set_error(struct pw_stream *stream, int res, const char *error,...)
Set the stream in error state.
Definition stream.c:2280
pw_stream_disconnect
int pw_stream_disconnect(struct pw_stream *stream)
Disconnect stream.
Definition stream.c:2272
pw_stream_update_params
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:2306
pw_stream_set_active
int pw_stream_set_active(struct pw_stream *stream, bool active)
Activate or deactivate the stream.
Definition stream.c:2435
pw_stream_trigger_process
int pw_stream_trigger_process(struct pw_stream *stream)
Trigger a push/pull on the stream.
Definition stream.c:2754
pw_stream_queue_buffer
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:2586
pw_stream_is_lazy
bool pw_stream_is_lazy(struct pw_stream *stream)
Check if the graph is using lazy scheduling.
Definition stream.c:2714
pw_stream_get_name
const char * pw_stream_get_name(struct pw_stream *stream)
Definition stream.c:1859
pw_stream_new_simple
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:1663
pw_stream_get_properties
const struct pw_properties * pw_stream_get_properties(struct pw_stream *stream)
Definition stream.c:1865
pw_stream_get_time_n
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:2467
pw_stream_add_listener
void pw_stream_add_listener(struct pw_stream *stream, struct spa_hook *listener, const struct pw_stream_events *events, void *data)
Definition stream.c:1830
pw_stream_destroy
void pw_stream_destroy(struct pw_stream *stream)
Destroy a stream.
Definition stream.c:1782
pw_stream_get_core
struct pw_core * pw_stream_get_core(struct pw_stream *stream)
Definition stream.c:1897
PW_STREAM_FLAG_EARLY_PROCESS
@ PW_STREAM_FLAG_EARLY_PROCESS
Call process as soon as there is a buffer to dequeue.
Definition stream.h:502
PW_STREAM_FLAG_INACTIVE
@ PW_STREAM_FLAG_INACTIVE
start the stream inactive, pw_stream_set_active() needs to be called explicitly
Definition stream.h:473
PW_STREAM_FLAG_RT_TRIGGER_DONE
@ PW_STREAM_FLAG_RT_TRIGGER_DONE
Call trigger_done from the realtime thread.
Definition stream.h:507
PW_STREAM_FLAG_MAP_BUFFERS
@ PW_STREAM_FLAG_MAP_BUFFERS
mmap the buffers except DmaBuf that is not explicitly marked as mappable.
Definition stream.h:476
PW_STREAM_FLAG_DRIVER
@ PW_STREAM_FLAG_DRIVER
be a driver
Definition stream.h:478
PW_STREAM_FLAG_EXCLUSIVE
@ PW_STREAM_FLAG_EXCLUSIVE
require exclusive access to the device
Definition stream.h:483
PW_STREAM_FLAG_ASYNC
@ PW_STREAM_FLAG_ASYNC
Buffers will not be dequeued/queued from the realtime process() function.
Definition stream.h:495
PW_STREAM_FLAG_NO_CONVERT
@ PW_STREAM_FLAG_NO_CONVERT
don't convert format
Definition stream.h:482
PW_STREAM_FLAG_TRIGGER
@ PW_STREAM_FLAG_TRIGGER
the output stream will not be scheduled automatically but _trigger_process() needs to be called.
Definition stream.h:490
PW_STREAM_FLAG_DONT_RECONNECT
@ PW_STREAM_FLAG_DONT_RECONNECT
don't try to reconnect this stream when the sink/source is removed
Definition stream.h:485
PW_STREAM_FLAG_AUTOCONNECT
@ PW_STREAM_FLAG_AUTOCONNECT
try to automatically connect this stream
Definition stream.h:471
PW_STREAM_FLAG_ALLOC_BUFFERS
@ PW_STREAM_FLAG_ALLOC_BUFFERS
the application will allocate buffer memory.
Definition stream.h:487
PW_STREAM_FLAG_RT_PROCESS
@ PW_STREAM_FLAG_RT_PROCESS
call process from the realtime thread.
Definition stream.h:479
PW_STREAM_FLAG_NONE
@ PW_STREAM_FLAG_NONE
no flags
Definition stream.h:470
PW_STREAM_STATE_PAUSED
@ PW_STREAM_STATE_PAUSED
paused
Definition stream.h:255
PW_STREAM_STATE_CONNECTING
@ PW_STREAM_STATE_CONNECTING
connection is in progress
Definition stream.h:254
PW_STREAM_STATE_UNCONNECTED
@ PW_STREAM_STATE_UNCONNECTED
unconnected
Definition stream.h:253
PW_STREAM_STATE_ERROR
@ PW_STREAM_STATE_ERROR
the stream is in error
Definition stream.h:252
PW_STREAM_STATE_STREAMING
@ PW_STREAM_STATE_STREAMING
streaming
Definition stream.h:256
SPA_DEPRECATED
#define SPA_DEPRECATED
Definition defs.h:303
SPA_PRINTF_FUNC
#define SPA_PRINTF_FUNC(fmt, arg1)
Definition defs.h:297
param.h
spa/param/param.h
command.h
spa/pod/command.h
event.h
spa/pod/event.h
port.h
pipewire/port.h
pw_buffer
a buffer structure obtained from pw_stream_dequeue_buffer().
Definition stream.h:261
pw_buffer::size
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:269
pw_buffer::time
uint64_t time
For capture streams, this field contains the cycle time in nanoseconds when this buffer was queued in...
Definition stream.h:278
pw_buffer::requested
uint64_t requested
For playback streams, this field contains the suggested amount of data to provide.
Definition stream.h:273
pw_buffer::user_data
void * user_data
user data attached to the buffer.
Definition stream.h:263
pw_core
pw_loop
Definition loop.h:33
pw_properties
Definition properties.h:39
pw_properties::dict
struct spa_dict dict
dictionary of key/values
Definition properties.h:40
pw_properties::flags
uint32_t flags
extra flags
Definition properties.h:41
pw_stream_control
Definition stream.h:285
pw_stream_control::max
float max
max value
Definition stream.h:290
pw_stream_control::flags
uint32_t flags
extra flags (unused)
Definition stream.h:287
pw_stream_control::def
float def
default value
Definition stream.h:288
pw_stream_control::max_values
uint32_t max_values
max values that can be set on this control
Definition stream.h:293
pw_stream_control::min
float min
min value
Definition stream.h:289
pw_stream_control::n_values
uint32_t n_values
number of values in array
Definition stream.h:292
pw_stream_control::values
float * values
array of values
Definition stream.h:291
pw_stream_events
Events for a stream.
Definition stream.h:422
pw_stream_events::remove_buffer
void(* remove_buffer)(void *data, struct pw_buffer *buffer)
when a buffer was destroyed for this stream
Definition stream.h:444
pw_stream_events::control_info
void(* control_info)(void *data, uint32_t id, const struct pw_stream_control *control)
Notify information about a control.
Definition stream.h:434
pw_stream_events::trigger_done
void(* trigger_done)(void *data)
a trigger_process completed.
Definition stream.h:462
pw_stream_events::param_changed
void(* param_changed)(void *data, uint32_t id, const struct spa_pod *param)
when a parameter changed
Definition stream.h:439
pw_stream_events::process
void(* process)(void *data)
when a buffer can be queued (for playback streams) or dequeued (for capture streams).
Definition stream.h:450
pw_stream_events::command
void(* command)(void *data, const struct spa_command *command)
A command notify, Since 0.3.39:1.
Definition stream.h:456
pw_stream_events::version
uint32_t version
Definition stream.h:425
pw_stream_events::state_changed
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:430
pw_stream_events::drained
void(* drained)(void *data)
The stream is drained.
Definition stream.h:453
pw_stream_events::destroy
void(* destroy)(void *data)
Definition stream.h:427
pw_stream_events::add_buffer
void(* add_buffer)(void *data, struct pw_buffer *buffer)
when a new buffer was created for this stream
Definition stream.h:442
pw_stream_events::io_changed
void(* io_changed)(void *data, uint32_t id, void *area, uint32_t size)
when io changed on the stream.
Definition stream.h:437
pw_stream
pw_time
A time structure.
Definition stream.h:382
pw_time::delay
int64_t delay
delay to device.
Definition stream.h:394
pw_time::rate
struct spa_fraction rate
the rate of ticks and delay.
Definition stream.h:389
pw_time::buffered
uint64_t buffered
for audio/raw streams, this contains the extra number of frames buffered in the resampler.
Definition stream.h:407
pw_time::queued
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:404
pw_time::queued_buffers
uint32_t queued_buffers
the number of buffers that are queued.
Definition stream.h:410
pw_time::ticks
uint64_t ticks
the ticks at now.
Definition stream.h:391
pw_time::size
uint64_t size
for audio/raw playback streams, this contains the number of samples requested by the resampler for th...
Definition stream.h:412
pw_time::now
int64_t now
the time in nanoseconds.
Definition stream.h:383
pw_time::avail_buffers
uint32_t avail_buffers
the number of buffers that can be dequeued.
Definition stream.h:411
spa_buffer
A Buffer.
Definition buffer.h:110
spa_command
Definition command.h:29
spa_dict
Definition dict.h:51
spa_event
Definition event.h:28
spa_fraction
Definition defs.h:137
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition hook.h:427
spa_pod
Definition pod.h:57