stream.h
Go to the documentation of this file.
/* PipeWire
*
* Copyright © 2018 Wim Taymans
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice (including the next
* paragraph) shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
#ifndef PIPEWIRE_STREAM_H
#define PIPEWIRE_STREAM_H
#ifdef __cplusplus
extern "C" {
#endif
struct pw_stream;
#include <spa/buffer/buffer.h>
#include <spa/param/param.h>
#include <spa/pod/command.h>
enum pw_stream_state {
PW_STREAM_STATE_ERROR = -1,
PW_STREAM_STATE_UNCONNECTED = 0,
PW_STREAM_STATE_CONNECTING = 1,
PW_STREAM_STATE_PAUSED = 2,
PW_STREAM_STATE_STREAMING = 3
};
struct pw_buffer {
struct spa_buffer *buffer;
void *user_data;
uint64_t size;
};
struct pw_stream_control {
const char *name;
uint32_t flags;
float def;
float min;
float max;
float *values;
uint32_t n_values;
uint32_t max_values;
};
struct pw_time {
int64_t now;
struct spa_fraction rate;
uint64_t ticks;
int64_t delay;
uint64_t queued;
};
#include <pipewire/port.h>
struct pw_stream_events {
#define PW_VERSION_STREAM_EVENTS 2
uint32_t version;
void (*destroy) (void *data);
void (*state_changed) (void *data, enum pw_stream_state old,
enum pw_stream_state state, const char *error);
void (*control_info) (void *data, uint32_t id, const struct pw_stream_control *control);
void (*io_changed) (void *data, uint32_t id, void *area, uint32_t size);
void (*param_changed) (void *data, uint32_t id, const struct spa_pod *param);
void (*add_buffer) (void *data, struct pw_buffer *buffer);
void (*remove_buffer) (void *data, struct pw_buffer *buffer);
void (*process) (void *data);
void (*drained) (void *data);
void (*command) (void *data, const struct spa_command *command);
void (*trigger_done) (void *data);
};
const char * pw_stream_state_as_string(enum pw_stream_state state);
enum pw_stream_flags {
PW_STREAM_FLAG_NONE = 0,
PW_STREAM_FLAG_AUTOCONNECT = (1 << 0),
PW_STREAM_FLAG_INACTIVE = (1 << 1),
PW_STREAM_FLAG_MAP_BUFFERS = (1 << 2),
PW_STREAM_FLAG_DRIVER = (1 << 3),
PW_STREAM_FLAG_RT_PROCESS = (1 << 4),
PW_STREAM_FLAG_NO_CONVERT = (1 << 5),
PW_STREAM_FLAG_EXCLUSIVE = (1 << 6),
PW_STREAM_FLAG_DONT_RECONNECT = (1 << 7),
PW_STREAM_FLAG_ALLOC_BUFFERS = (1 << 8),
PW_STREAM_FLAG_TRIGGER = (1 << 9),
};
struct pw_stream *
pw_stream_new(struct pw_core *core,
const char *name,
struct pw_properties *props );
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 );
void pw_stream_destroy(struct pw_stream *stream);
void pw_stream_add_listener(struct pw_stream *stream,
struct spa_hook *listener,
const struct pw_stream_events *events,
void *data);
enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error);
const char *pw_stream_get_name(struct pw_stream *stream);
struct pw_core *pw_stream_get_core(struct pw_stream *stream);
const struct pw_properties *pw_stream_get_properties(struct pw_stream *stream);
int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict);
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 );
uint32_t
pw_stream_get_node_id(struct pw_stream *stream);
int pw_stream_disconnect(struct pw_stream *stream);
int pw_stream_set_error(struct pw_stream *stream,
int res,
const char *error,
...) SPA_PRINTF_FUNC(3, 4);
int
pw_stream_update_params(struct pw_stream *stream,
const struct spa_pod **params,
uint32_t n_params );
const struct pw_stream_control *pw_stream_get_control(struct pw_stream *stream, uint32_t id);
int pw_stream_set_control(struct pw_stream *stream, uint32_t id, uint32_t n_values, float *values, ...);
int pw_stream_get_time(struct pw_stream *stream, struct pw_time *time);
struct pw_buffer *pw_stream_dequeue_buffer(struct pw_stream *stream);
int pw_stream_queue_buffer(struct pw_stream *stream, struct pw_buffer *buffer);
int pw_stream_set_active(struct pw_stream *stream, bool active);
int pw_stream_flush(struct pw_stream *stream, bool drain);
bool pw_stream_is_driving(struct pw_stream *stream);
int pw_stream_trigger_process(struct pw_stream *stream);
#ifdef __cplusplus
}
#endif
#endif /* PIPEWIRE_STREAM_H */
buffer.h
spa/buffer/buffer.h
pw_direction
#define pw_direction
The direction of a port.
Definition: port.h:63
pw_stream_flags
pw_stream_flags
Extra flags that can be used in pw_stream_connect()
Definition: stream.h:260
pw_stream_update_properties
int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict)
Definition: stream.c:1583
pw_stream_get_state
enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error)
Definition: stream.c:1563
pw_stream_update_params
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:1963
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:1678
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:1899
pw_stream_set_error
int pw_stream_set_error(struct pw_stream *stream, int res, const char *error,...) 1(3
Set the stream in error state.
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:1981
pw_stream_new
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:1410
pw_stream_is_driving
bool pw_stream_is_driving(struct pw_stream *stream)
Check if the stream is driving.
Definition: stream.c:2193
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:2033
pw_stream_flush
int pw_stream_flush(struct pw_stream *stream, bool drain)
Flush a stream.
Definition: stream.c:2181
pw_stream_get_time
int pw_stream_get_time(struct pw_stream *stream, struct pw_time *time)
Query the time on the stream
Definition: stream.c:2060
pw_stream_get_name
const char * pw_stream_get_name(struct pw_stream *stream)
Definition: stream.c:1571
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:1432
pw_stream_state
pw_stream_state
The state of a stream.
Definition: stream.h:173
pw_stream_disconnect
int pw_stream_disconnect(struct pw_stream *stream)
Disconnect stream
Definition: stream.c:1905
pw_stream_set_active
int pw_stream_set_active(struct pw_stream *stream, bool active)
Activate or deactivate the stream.
Definition: stream.c:2047
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:2100
pw_stream_trigger_process
int pw_stream_trigger_process(struct pw_stream *stream)
Trigger a push/pull on the stream.
Definition: stream.c:2228
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:2127
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:1547
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:1476
pw_stream_get_core
struct pw_core * pw_stream_get_core(struct pw_stream *stream)
Definition: stream.c:1600
pw_stream_destroy
void pw_stream_destroy(struct pw_stream *stream)
Destroy a stream.
Definition: stream.c:1494
pw_stream_get_properties
const struct pw_properties * pw_stream_get_properties(struct pw_stream *stream)
Definition: stream.c:1577
PW_STREAM_FLAG_INACTIVE
@ PW_STREAM_FLAG_INACTIVE
start the stream inactive, pw_stream_set_active() needs to be called explicitly
Definition: stream.h:264
PW_STREAM_FLAG_MAP_BUFFERS
@ PW_STREAM_FLAG_MAP_BUFFERS
mmap the buffers except DmaBuf
Definition: stream.h:267
PW_STREAM_FLAG_DRIVER
@ PW_STREAM_FLAG_DRIVER
be a driver
Definition: stream.h:268
PW_STREAM_FLAG_EXCLUSIVE
@ PW_STREAM_FLAG_EXCLUSIVE
require exclusive access to the device
Definition: stream.h:273
PW_STREAM_FLAG_NO_CONVERT
@ PW_STREAM_FLAG_NO_CONVERT
don't convert format
Definition: stream.h:272
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:280
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:275
PW_STREAM_FLAG_AUTOCONNECT
@ PW_STREAM_FLAG_AUTOCONNECT
try to automatically connect this stream
Definition: stream.h:262
PW_STREAM_FLAG_ALLOC_BUFFERS
@ PW_STREAM_FLAG_ALLOC_BUFFERS
the application will allocate buffer memory.
Definition: stream.h:277
PW_STREAM_FLAG_RT_PROCESS
@ PW_STREAM_FLAG_RT_PROCESS
call process from the realtime thread.
Definition: stream.h:269
PW_STREAM_FLAG_NONE
@ PW_STREAM_FLAG_NONE
no flags
Definition: stream.h:261
PW_STREAM_STATE_PAUSED
@ PW_STREAM_STATE_PAUSED
paused
Definition: stream.h:177
PW_STREAM_STATE_CONNECTING
@ PW_STREAM_STATE_CONNECTING
connection is in progress
Definition: stream.h:176
PW_STREAM_STATE_UNCONNECTED
@ PW_STREAM_STATE_UNCONNECTED
unconnected
Definition: stream.h:175
PW_STREAM_STATE_ERROR
@ PW_STREAM_STATE_ERROR
the stream is in error
Definition: stream.h:174
PW_STREAM_STATE_STREAMING
@ PW_STREAM_STATE_STREAMING
streaming
Definition: stream.h:178
SPA_PRINTF_FUNC
#define SPA_PRINTF_FUNC(fmt, arg1)
Definition: defs.h:260
param.h
spa/param/param.h
command.h
spa/pod/command.h
port.h
pipewire/port.h
pw_buffer
Definition: stream.h:181
pw_buffer::size
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:184
pw_buffer::buffer
struct spa_buffer * buffer
the spa buffer
Definition: stream.h:182
pw_buffer::user_data
void * user_data
user data attached to the buffer
Definition: stream.h:183
pw_core
pw_loop
Definition: loop.h:51
pw_properties
Definition: properties.h:53
pw_properties::dict
struct spa_dict dict
dictionary of key/values
Definition: properties.h:54
pw_properties::flags
uint32_t flags
extra flags
Definition: properties.h:55
pw_stream_control
Definition: stream.h:188
pw_stream_control::max
float max
max value
Definition: stream.h:193
pw_stream_control::flags
uint32_t flags
extra flags (unused)
Definition: stream.h:190
pw_stream_control::def
float def
default value
Definition: stream.h:191
pw_stream_control::max_values
uint32_t max_values
max values that can be set on this control
Definition: stream.h:196
pw_stream_control::min
float min
min value
Definition: stream.h:192
pw_stream_control::n_values
uint32_t n_values
number of values in array
Definition: stream.h:195
pw_stream_control::values
float * values
array of values
Definition: stream.h:194
pw_stream_events
Events for a stream.
Definition: stream.h:217
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:238
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:228
pw_stream_events::trigger_done
void(* trigger_done)(void *data)
a trigger_process completed.
Definition: stream.h:253
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:233
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:244
pw_stream_events::command
void(* command)(void *data, const struct spa_command *command)
A command notify, Since 0.3.39:1.
Definition: stream.h:250
pw_stream_events::version
uint32_t version
Definition: stream.h:220
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:224
pw_stream_events::drained
void(* drained)(void *data)
The stream is drained.
Definition: stream.h:247
pw_stream_events::destroy
void(* destroy)(void *data)
Definition: stream.h:222
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:236
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:231
pw_stream
pw_time
A time structure.
Definition: stream.h:200
pw_time::delay
int64_t delay
delay to device, add to ticks to get the time of the device.
Definition: stream.h:205
pw_time::rate
struct spa_fraction rate
the rate of ticks and delay
Definition: stream.h:202
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:208
pw_time::ticks
uint64_t ticks
the ticks at now.
Definition: stream.h:203
pw_time::now
int64_t now
the monotonic time in nanoseconds
Definition: stream.h:201
spa_buffer
A Buffer.
Definition: buffer.h:105
spa_command
Definition: command.h:49
spa_dict
Definition: dict.h:59
spa_fraction
Definition: defs.h:121
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:342
spa_pod
Definition: pod.h:63