PipeWire 1.3.81
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
232struct pw_stream;
233
234#include <spa/buffer/buffer.h>
235#include <spa/param/param.h>
237#include <spa/pod/event.h>
238
240enum pw_stream_state {
252 void *user_data;
258 uint64_t size;
262 uint64_t requested;
267 uint64_t time;
273
274struct pw_stream_control {
275 const char *name;
276 uint32_t flags;
277 float def;
278 float min;
279 float max;
280 float *values;
281 uint32_t n_values;
282 uint32_t max_values;
365struct pw_time {
366 int64_t now;
372 struct spa_fraction rate;
374 uint64_t ticks;
377 int64_t delay;
386 uint64_t queued;
389 uint64_t buffered;
392 uint32_t queued_buffers;
393 uint32_t avail_buffers;
394 uint64_t size;
400#include <pipewire/port.h>
401
404struct pw_stream_events {
405#define PW_VERSION_STREAM_EVENTS 2
406 uint32_t version;
407
408 void (*destroy) (void *data);
410 void (*state_changed) (void *data, enum pw_stream_state old,
411 enum pw_stream_state state, const char *error);
414 void (*control_info) (void *data, uint32_t id, const struct pw_stream_control *control);
415
417 void (*io_changed) (void *data, uint32_t id, void *area, uint32_t size);
419 void (*param_changed) (void *data, uint32_t id, const struct spa_pod *param);
422 void (*add_buffer) (void *data, struct pw_buffer *buffer);
424 void (*remove_buffer) (void *data, struct pw_buffer *buffer);
430 void (*process) (void *data);
431
433 void (*drained) (void *data);
434
436 void (*command) (void *data, const struct spa_command *command);
437
442 void (*trigger_done) (void *data);
443};
444
446const char * pw_stream_state_as_string(enum pw_stream_state state);
447
449enum pw_stream_flags {
451 PW_STREAM_FLAG_AUTOCONNECT = (1 << 0),
453 PW_STREAM_FLAG_INACTIVE = (1 << 1),
459 PW_STREAM_FLAG_RT_PROCESS = (1 << 4),
462 PW_STREAM_FLAG_NO_CONVERT = (1 << 5),
482 PW_STREAM_FLAG_EARLY_PROCESS = (1 << 11),
490};
491
494struct pw_stream *
495pw_stream_new(struct pw_core *core,
496 const char *name,
497 struct pw_properties *props );
498
499struct pw_stream *
500pw_stream_new_simple(struct pw_loop *loop,
501 const char *name,
502 struct pw_properties *props,
503 const struct pw_stream_events *events,
504 void *data );
505
507void pw_stream_destroy(struct pw_stream *stream);
508
509void pw_stream_add_listener(struct pw_stream *stream,
510 struct spa_hook *listener,
511 const struct pw_stream_events *events,
512 void *data);
513
514enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error);
515
516const char *pw_stream_get_name(struct pw_stream *stream);
517
518struct pw_core *pw_stream_get_core(struct pw_stream *stream);
519
520const struct pw_properties *pw_stream_get_properties(struct pw_stream *stream);
521
522int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict);
523
529int
530pw_stream_connect(struct pw_stream *stream,
531 enum pw_direction direction,
532 uint32_t target_id,
543 const struct spa_pod **params,
546 uint32_t n_params );
547
550uint32_t
551pw_stream_get_node_id(struct pw_stream *stream);
552
554int pw_stream_disconnect(struct pw_stream *stream);
555
557int pw_stream_set_error(struct pw_stream *stream,
558 int res,
559 const char *error,
560 ...) SPA_PRINTF_FUNC(3, 4);
561
563int
564pw_stream_update_params(struct pw_stream *stream,
565 const struct spa_pod **params,
566 uint32_t n_params );
567
572int pw_stream_set_param(struct pw_stream *stream,
573 uint32_t id,
574 const struct spa_pod *param );
575
577const struct pw_stream_control *pw_stream_get_control(struct pw_stream *stream, uint32_t id);
578
580int pw_stream_set_control(struct pw_stream *stream, uint32_t id, uint32_t n_values, float *values, ...);
581
583int pw_stream_get_time_n(struct pw_stream *stream, struct pw_time *time, size_t size);
584
587uint64_t pw_stream_get_nsec(struct pw_stream *stream);
588
591struct pw_loop *pw_stream_get_data_loop(struct pw_stream *stream);
592
596int pw_stream_get_time(struct pw_stream *stream, struct pw_time *time);
597
600struct pw_buffer *pw_stream_dequeue_buffer(struct pw_stream *stream);
601
603int pw_stream_queue_buffer(struct pw_stream *stream, struct pw_buffer *buffer);
604
607int pw_stream_return_buffer(struct pw_stream *stream, struct pw_buffer *buffer);
608
610int pw_stream_set_active(struct pw_stream *stream, bool active);
611
618int pw_stream_flush(struct pw_stream *stream, bool drain);
619
624bool pw_stream_is_driving(struct pw_stream *stream);
625
639bool pw_stream_is_lazy(struct pw_stream *stream);
640
670int pw_stream_trigger_process(struct pw_stream *stream);
671
674int pw_stream_emit_event(struct pw_stream *stream, const struct spa_event *event);
675
682int pw_stream_set_rate(struct pw_stream *stream, double rate);
683
688#ifdef __cplusplus
689}
690#endif
691
692#endif /* PIPEWIRE_STREAM_H */
spa/buffer/buffer.h
buffer[1023]
Definition core.h:437
uint32_t id
Definition core.h:432
uint32_t int int res
Definition core.h:433
#define pw_direction
The direction of a port.
Definition port.h:51
pw_stream_flags
Extra flags that can be used in pw_stream_connect()
Definition stream.h:455
int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict)
Definition stream.c:1773
enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error)
Definition stream.c:1753
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:1876
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:2432
uint32_t pw_stream_get_node_id(struct pw_stream *stream)
Get the node ID of the stream.
Definition stream.c:2166
uint64_t pw_stream_get_nsec(struct pw_stream *stream)
Get the current time in nanoseconds.
Definition stream.c:2408
int pw_stream_emit_event(struct pw_stream *stream, const struct spa_event *event)
Emit an event from this stream.
Definition stream.c:2612
int pw_stream_set_control(struct pw_stream *stream, uint32_t id, uint32_t n_values, float *values,...)
Set control values.
Definition stream.c:2248
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:2502
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:2416
bool pw_stream_is_driving(struct pw_stream *stream)
Check if the stream is driving.
Definition stream.c:2576
int pw_stream_flush(struct pw_stream *stream, bool drain)
Flush a stream.
Definition stream.c:2559
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:1553
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:2353
int pw_stream_set_rate(struct pw_stream *stream, double rate)
Adjust the rate of the stream.
Definition stream.c:2643
const struct pw_stream_control * pw_stream_get_control(struct pw_stream *stream, uint32_t id)
Get control values.
Definition stream.c:2309
const char * pw_stream_state_as_string(enum pw_stream_state state)
Convert a stream state to a readable string.
Definition stream.c:1619
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:2236
pw_stream_state
The state of a stream.
Definition stream.h:245
int pw_stream_set_error(struct pw_stream *stream, int res, const char *error,...)
Set the stream in error state.
Definition stream.c:2180
int pw_stream_disconnect(struct pw_stream *stream)
Disconnect stream
Definition stream.c:2172
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:2206
int pw_stream_set_active(struct pw_stream *stream, bool active)
Activate or deactivate the stream.
Definition stream.c:2323
int pw_stream_trigger_process(struct pw_stream *stream)
Trigger a push/pull on the stream.
Definition stream.c:2620
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:2460
bool pw_stream_is_lazy(struct pw_stream *stream)
Check if the graph is using lazy scheduling.
Definition stream.c:2582
const char * pw_stream_get_name(struct pw_stream *stream)
Definition stream.c:1761
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:1575
const struct pw_properties * pw_stream_get_properties(struct pw_stream *stream)
Definition stream.c:1767
int pw_stream_get_time_n(struct pw_stream *stream, struct pw_time *time, size_t size)
Query the time on the stream, RT safe.
Definition stream.c:2359
void pw_stream_add_listener(struct pw_stream *stream, struct spa_hook *listener, const struct pw_stream_events *events, void *data)
Definition stream.c:1734
void pw_stream_destroy(struct pw_stream *stream)
Destroy a stream.
Definition stream.c:1669
struct pw_core * pw_stream_get_core(struct pw_stream *stream)
Definition stream.c:1799
@ PW_STREAM_FLAG_EARLY_PROCESS
Call process as soon as there is a buffer to dequeue.
Definition stream.h:488
@ PW_STREAM_FLAG_INACTIVE
start the stream inactive, pw_stream_set_active() needs to be called explicitly
Definition stream.h:459
@ PW_STREAM_FLAG_RT_TRIGGER_DONE
Call trigger_done from the realtime thread.
Definition stream.h:493
@ PW_STREAM_FLAG_MAP_BUFFERS
mmap the buffers except DmaBuf that is not explicitly marked as mappable.
Definition stream.h:462
@ PW_STREAM_FLAG_DRIVER
be a driver
Definition stream.h:464
@ PW_STREAM_FLAG_EXCLUSIVE
require exclusive access to the device
Definition stream.h:469
@ PW_STREAM_FLAG_ASYNC
Buffers will not be dequeued/queued from the realtime process() function.
Definition stream.h:481
@ PW_STREAM_FLAG_NO_CONVERT
don't convert format
Definition stream.h:468
@ PW_STREAM_FLAG_TRIGGER
the output stream will not be scheduled automatically but _trigger_process() needs to be called.
Definition stream.h:476
@ PW_STREAM_FLAG_DONT_RECONNECT
don't try to reconnect this stream when the sink/source is removed
Definition stream.h:471
@ PW_STREAM_FLAG_AUTOCONNECT
try to automatically connect this stream
Definition stream.h:457
@ PW_STREAM_FLAG_ALLOC_BUFFERS
the application will allocate buffer memory.
Definition stream.h:473
@ PW_STREAM_FLAG_RT_PROCESS
call process from the realtime thread.
Definition stream.h:465
@ PW_STREAM_FLAG_NONE
no flags
Definition stream.h:456
@ PW_STREAM_STATE_PAUSED
paused
Definition stream.h:249
@ PW_STREAM_STATE_CONNECTING
connection is in progress
Definition stream.h:248
@ PW_STREAM_STATE_UNCONNECTED
unconnected
Definition stream.h:247
@ PW_STREAM_STATE_ERROR
the stream is in error
Definition stream.h:246
@ PW_STREAM_STATE_STREAMING
streaming
Definition stream.h:250
#define SPA_DEPRECATED
Definition defs.h:301
#define SPA_PRINTF_FUNC(fmt, arg1)
Definition defs.h:295
spa/param/param.h
spa/pod/command.h
spa/pod/event.h
pipewire/port.h
a buffer structure obtained from pw_stream_dequeue_buffer().
Definition stream.h:255
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:263
uint64_t time
For capture streams, this field contains the cycle time in nanoseconds when this buffer was queued in...
Definition stream.h:272
uint64_t requested
For playback streams, this field contains the suggested amount of data to provide.
Definition stream.h:267
struct spa_buffer * buffer
the spa buffer
Definition stream.h:256
void * user_data
user data attached to the buffer.
Definition stream.h:257
Definition loop.h:33
Definition properties.h:39
struct spa_dict dict
dictionary of key/values
Definition properties.h:40
uint32_t flags
extra flags
Definition properties.h:41
Definition stream.h:279
float max
max value
Definition stream.h:284
uint32_t flags
extra flags (unused)
Definition stream.h:281
float def
default value
Definition stream.h:282
uint32_t max_values
max values that can be set on this control
Definition stream.h:287
float min
min value
Definition stream.h:283
uint32_t n_values
number of values in array
Definition stream.h:286
float * values
array of values
Definition stream.h:285
Events for a stream.
Definition stream.h:409
void(* remove_buffer)(void *data, struct pw_buffer *buffer)
when a buffer was destroyed for this stream
Definition stream.h:430
void(* control_info)(void *data, uint32_t id, const struct pw_stream_control *control)
Notify information about a control.
Definition stream.h:420
void(* trigger_done)(void *data)
a trigger_process completed.
Definition stream.h:448
void(* param_changed)(void *data, uint32_t id, const struct spa_pod *param)
when a parameter changed
Definition stream.h:425
void(* process)(void *data)
when a buffer can be queued (for playback streams) or dequeued (for capture streams).
Definition stream.h:436
void(* command)(void *data, const struct spa_command *command)
A command notify, Since 0.3.39:1.
Definition stream.h:442
uint32_t version
Definition stream.h:412
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:416
void(* drained)(void *data)
The stream is drained.
Definition stream.h:439
void(* destroy)(void *data)
Definition stream.h:414
void(* add_buffer)(void *data, struct pw_buffer *buffer)
when a new buffer was created for this stream
Definition stream.h:428
void(* io_changed)(void *data, uint32_t id, void *area, uint32_t size)
when io changed on the stream.
Definition stream.h:423
A time structure.
Definition stream.h:370
int64_t delay
delay to device.
Definition stream.h:382
struct spa_fraction rate
the rate of ticks and delay.
Definition stream.h:377
uint64_t buffered
for audio/raw streams, this contains the extra number of frames buffered in the resampler.
Definition stream.h:394
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:391
uint32_t queued_buffers
the number of buffers that are queued.
Definition stream.h:397
uint64_t ticks
the ticks at now.
Definition stream.h:379
uint64_t size
for audio/raw playback streams, this contains the number of samples requested by the resampler for th...
Definition stream.h:399
int64_t now
the time in nanoseconds.
Definition stream.h:371
uint32_t avail_buffers
the number of buffers that can be dequeued.
Definition stream.h:398
A Buffer.
Definition buffer.h:110
Definition command.h:29
Definition dict.h:51
Definition event.h:28
Definition defs.h:137
A hook, contains the structure with functions and the data passed to the functions.
Definition hook.h:427
Definition pod.h:43