PipeWire  1.4.1
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 
238 struct pw_stream;
239 
240 #include <spa/buffer/buffer.h>
241 #include <spa/param/param.h>
243 #include <spa/pod/event.h>
244 
246 enum pw_stream_state {
247  PW_STREAM_STATE_ERROR = -1,
252 };
253 
256 struct pw_buffer {
257  struct spa_buffer *buffer;
258  void *user_data;
264  uint64_t size;
268  uint64_t requested;
273  uint64_t time;
278 };
279 
280 struct 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 
371 struct pw_time {
372  int64_t now;
378  struct spa_fraction rate;
380  uint64_t ticks;
383  int64_t delay;
392  uint64_t queued;
395  uint64_t buffered;
398  uint32_t queued_buffers;
399  uint32_t avail_buffers;
400  uint64_t size;
404 };
405 
406 #include <pipewire/port.h>
407 
410 struct pw_stream_events {
411 #define PW_VERSION_STREAM_EVENTS 2
412  uint32_t version;
413 
414  void (*destroy) (void *data);
417  void (*state_changed) (void *data, enum pw_stream_state old,
418  enum pw_stream_state state, const char *error);
419 
421  void (*control_info) (void *data, uint32_t id, const struct pw_stream_control *control);
422 
424  void (*io_changed) (void *data, uint32_t id, void *area, uint32_t size);
426  void (*param_changed) (void *data, uint32_t id, const struct spa_pod *param);
427 
429  void (*add_buffer) (void *data, struct pw_buffer *buffer);
431  void (*remove_buffer) (void *data, struct pw_buffer *buffer);
432 
437  void (*process) (void *data);
438 
440  void (*drained) (void *data);
441 
443  void (*command) (void *data, const struct spa_command *command);
444 
449  void (*trigger_done) (void *data);
450 };
451 
453 const char * pw_stream_state_as_string(enum pw_stream_state state);
454 
456 enum pw_stream_flags {
457  PW_STREAM_FLAG_NONE = 0,
458  PW_STREAM_FLAG_AUTOCONNECT = (1 << 0),
460  PW_STREAM_FLAG_INACTIVE = (1 << 1),
466  PW_STREAM_FLAG_RT_PROCESS = (1 << 4),
469  PW_STREAM_FLAG_NO_CONVERT = (1 << 5),
472  PW_STREAM_FLAG_DONT_RECONNECT = (1 << 7),
482  PW_STREAM_FLAG_ASYNC = (1 << 10),
489  PW_STREAM_FLAG_EARLY_PROCESS = (1 << 11),
497 };
498 
501 struct pw_stream *
502 pw_stream_new(struct pw_core *core,
503  const char *name,
504  struct pw_properties *props );
505 
506 struct pw_stream *
507 pw_stream_new_simple(struct pw_loop *loop,
508  const char *name,
509  struct pw_properties *props,
510  const struct pw_stream_events *events,
511  void *data );
512 
514 void pw_stream_destroy(struct pw_stream *stream);
515 
516 void pw_stream_add_listener(struct pw_stream *stream,
517  struct spa_hook *listener,
518  const struct pw_stream_events *events,
519  void *data);
520 
523 enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error);
524 
525 const char *pw_stream_get_name(struct pw_stream *stream);
526 
527 struct pw_core *pw_stream_get_core(struct pw_stream *stream);
528 
529 const struct pw_properties *pw_stream_get_properties(struct pw_stream *stream);
530 
531 int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict);
532 
538 int
539 pw_stream_connect(struct pw_stream *stream,
540  enum pw_direction direction,
541  uint32_t target_id,
551  enum pw_stream_flags flags,
552  const struct spa_pod **params,
555  uint32_t n_params );
556 
559 uint32_t
560 pw_stream_get_node_id(struct pw_stream *stream);
561 
563 int pw_stream_disconnect(struct pw_stream *stream);
564 
566 int pw_stream_set_error(struct pw_stream *stream,
567  int res,
568  const char *error,
569  ...) SPA_PRINTF_FUNC(3, 4);
570 
572 int
573 pw_stream_update_params(struct pw_stream *stream,
574  const struct spa_pod **params,
575  uint32_t n_params );
576 
581 int pw_stream_set_param(struct pw_stream *stream,
582  uint32_t id,
583  const struct spa_pod *param );
584 
586 const struct pw_stream_control *pw_stream_get_control(struct pw_stream *stream, uint32_t id);
587 
589 int pw_stream_set_control(struct pw_stream *stream, uint32_t id, uint32_t n_values, float *values, ...);
590 
592 int pw_stream_get_time_n(struct pw_stream *stream, struct pw_time *time, size_t size);
593 
596 uint64_t pw_stream_get_nsec(struct pw_stream *stream);
597 
600 struct pw_loop *pw_stream_get_data_loop(struct pw_stream *stream);
601 
605 int pw_stream_get_time(struct pw_stream *stream, struct pw_time *time);
606 
609 struct pw_buffer *pw_stream_dequeue_buffer(struct pw_stream *stream);
610 
612 int pw_stream_queue_buffer(struct pw_stream *stream, struct pw_buffer *buffer);
613 
616 int pw_stream_return_buffer(struct pw_stream *stream, struct pw_buffer *buffer);
617 
619 int pw_stream_set_active(struct pw_stream *stream, bool active);
620 
627 int pw_stream_flush(struct pw_stream *stream, bool drain);
628 
633 bool pw_stream_is_driving(struct pw_stream *stream);
634 
648 bool pw_stream_is_lazy(struct pw_stream *stream);
649 
679 int pw_stream_trigger_process(struct pw_stream *stream);
680 
683 int pw_stream_emit_event(struct pw_stream *stream, const struct spa_event *event);
684 
691 int pw_stream_set_rate(struct pw_stream *stream, double rate);
692 
697 #ifdef __cplusplus
698 }
699 #endif
700 
701 #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:462
int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict)
Definition: stream.c:1799
enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error)
Get the current stream state.
Definition: stream.c:1777
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:1902
uint32_t pw_stream_get_node_id(struct pw_stream *stream)
Get the node ID of the stream.
Definition: stream.c:2192
uint64_t pw_stream_get_nsec(struct pw_stream *stream)
Get the current time in nanoseconds.
Definition: stream.c:2434
int pw_stream_emit_event(struct pw_stream *stream, const struct spa_event *event)
Emit an event from this stream.
Definition: stream.c:2638
int pw_stream_set_control(struct pw_stream *stream, uint32_t id, uint32_t n_values, float *values,...)
Set control values.
Definition: stream.c:2274
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:2528
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:1577
bool pw_stream_is_driving(struct pw_stream *stream)
Check if the stream is driving.
Definition: stream.c:2602
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:2442
const struct pw_stream_control * pw_stream_get_control(struct pw_stream *stream, uint32_t id)
Get control values.
Definition: stream.c:2335
int pw_stream_flush(struct pw_stream *stream, bool drain)
Flush a stream.
Definition: stream.c:2585
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:2379
const char * pw_stream_get_name(struct pw_stream *stream)
Definition: stream.c:1787
int pw_stream_set_rate(struct pw_stream *stream, double rate)
Adjust the rate of the stream.
Definition: stream.c:2669
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:1599
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:2262
pw_stream_state
The state of a stream.
Definition: stream.h:251
int pw_stream_set_error(struct pw_stream *stream, int res, const char *error,...)
Set the stream in error state.
Definition: stream.c:2206
int pw_stream_disconnect(struct pw_stream *stream)
Disconnect stream
Definition: stream.c:2198
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:2232
int pw_stream_set_active(struct pw_stream *stream, bool active)
Activate or deactivate the stream.
Definition: stream.c:2349
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:2458
int pw_stream_trigger_process(struct pw_stream *stream)
Trigger a push/pull on the stream.
Definition: stream.c:2646
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:2486
bool pw_stream_is_lazy(struct pw_stream *stream)
Check if the graph is using lazy scheduling.
Definition: stream.c:2608
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:2385
void pw_stream_add_listener(struct pw_stream *stream, struct spa_hook *listener, const struct pw_stream_events *events, void *data)
Definition: stream.c:1758
const char * pw_stream_state_as_string(enum pw_stream_state state)
Convert a stream state to a readable string.
Definition: stream.c:1643
struct pw_core * pw_stream_get_core(struct pw_stream *stream)
Definition: stream.c:1825
void pw_stream_destroy(struct pw_stream *stream)
Destroy a stream.
Definition: stream.c:1693
const struct pw_properties * pw_stream_get_properties(struct pw_stream *stream)
Definition: stream.c:1793
@ PW_STREAM_FLAG_EARLY_PROCESS
Call process as soon as there is a buffer to dequeue.
Definition: stream.h:495
@ PW_STREAM_FLAG_INACTIVE
start the stream inactive, pw_stream_set_active() needs to be called explicitly
Definition: stream.h:466
@ PW_STREAM_FLAG_RT_TRIGGER_DONE
Call trigger_done from the realtime thread.
Definition: stream.h:500
@ PW_STREAM_FLAG_MAP_BUFFERS
mmap the buffers except DmaBuf that is not explicitly marked as mappable.
Definition: stream.h:469
@ PW_STREAM_FLAG_DRIVER
be a driver
Definition: stream.h:471
@ PW_STREAM_FLAG_EXCLUSIVE
require exclusive access to the device
Definition: stream.h:476
@ PW_STREAM_FLAG_ASYNC
Buffers will not be dequeued/queued from the realtime process() function.
Definition: stream.h:488
@ PW_STREAM_FLAG_NO_CONVERT
don't convert format
Definition: stream.h:475
@ PW_STREAM_FLAG_TRIGGER
the output stream will not be scheduled automatically but _trigger_process() needs to be called.
Definition: stream.h:483
@ PW_STREAM_FLAG_DONT_RECONNECT
don't try to reconnect this stream when the sink/source is removed
Definition: stream.h:478
@ PW_STREAM_FLAG_AUTOCONNECT
try to automatically connect this stream
Definition: stream.h:464
@ PW_STREAM_FLAG_ALLOC_BUFFERS
the application will allocate buffer memory.
Definition: stream.h:480
@ PW_STREAM_FLAG_RT_PROCESS
call process from the realtime thread.
Definition: stream.h:472
@ PW_STREAM_FLAG_NONE
no flags
Definition: stream.h:463
@ PW_STREAM_STATE_PAUSED
paused
Definition: stream.h:255
@ PW_STREAM_STATE_CONNECTING
connection is in progress
Definition: stream.h:254
@ PW_STREAM_STATE_UNCONNECTED
unconnected
Definition: stream.h:253
@ PW_STREAM_STATE_ERROR
the stream is in error
Definition: stream.h:252
@ PW_STREAM_STATE_STREAMING
streaming
Definition: stream.h:256
#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:261
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
uint64_t time
For capture streams, this field contains the cycle time in nanoseconds when this buffer was queued in...
Definition: stream.h:278
uint64_t requested
For playback streams, this field contains the suggested amount of data to provide.
Definition: stream.h:273
struct spa_buffer * buffer
the spa buffer
Definition: stream.h:262
void * user_data
user data attached to the buffer.
Definition: stream.h:263
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:285
float max
max value
Definition: stream.h:290
uint32_t flags
extra flags (unused)
Definition: stream.h:287
float def
default value
Definition: stream.h:288
uint32_t max_values
max values that can be set on this control
Definition: stream.h:293
float min
min value
Definition: stream.h:289
uint32_t n_values
number of values in array
Definition: stream.h:292
float * values
array of values
Definition: stream.h:291
Events for a stream.
Definition: stream.h:415
void(* remove_buffer)(void *data, struct pw_buffer *buffer)
when a buffer was destroyed for this stream
Definition: stream.h:437
void(* control_info)(void *data, uint32_t id, const struct pw_stream_control *control)
Notify information about a control.
Definition: stream.h:427
void(* trigger_done)(void *data)
a trigger_process completed.
Definition: stream.h:455
void(* param_changed)(void *data, uint32_t id, const struct spa_pod *param)
when a parameter changed
Definition: stream.h:432
void(* process)(void *data)
when a buffer can be queued (for playback streams) or dequeued (for capture streams).
Definition: stream.h:443
void(* command)(void *data, const struct spa_command *command)
A command notify, Since 0.3.39:1.
Definition: stream.h:449
uint32_t version
Definition: stream.h:418
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:423
void(* drained)(void *data)
The stream is drained.
Definition: stream.h:446
void(* destroy)(void *data)
Definition: stream.h:420
void(* add_buffer)(void *data, struct pw_buffer *buffer)
when a new buffer was created for this stream
Definition: stream.h:435
void(* io_changed)(void *data, uint32_t id, void *area, uint32_t size)
when io changed on the stream.
Definition: stream.h:430
A time structure.
Definition: stream.h:376
int64_t delay
delay to device.
Definition: stream.h:388
struct spa_fraction rate
the rate of ticks and delay.
Definition: stream.h:383
uint64_t buffered
for audio/raw streams, this contains the extra number of frames buffered in the resampler.
Definition: stream.h:400
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:397
uint32_t queued_buffers
the number of buffers that are queued.
Definition: stream.h:403
uint64_t ticks
the ticks at now.
Definition: stream.h:385
uint64_t size
for audio/raw playback streams, this contains the number of samples requested by the resampler for th...
Definition: stream.h:405
int64_t now
the time in nanoseconds.
Definition: stream.h:377
uint32_t avail_buffers
the number of buffers that can be dequeued.
Definition: stream.h:404
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