PipeWire: stream.h Source File

PipeWire 0.3.37

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
29extern "C" {
30#endif
31
161struct pw_stream;
162
163#include <spa/buffer/buffer.h>
164#include <spa/param/param.h>
165
167 enum pw_stream_state {
168 PW_STREAM_STATE_ERROR = -1,
169 PW_STREAM_STATE_UNCONNECTED = 0,
170 PW_STREAM_STATE_CONNECTING = 1,
171 PW_STREAM_STATE_PAUSED = 2,
172 PW_STREAM_STATE_STREAMING = 3
173};
174
175 struct pw_buffer {
176 struct spa_buffer *buffer;
177 void *user_data;
178 uint64_t size;
180};
181
182 struct pw_stream_control {
183 const char *name;
184 uint32_t flags;
185 float def;
186 float min;
187 float max;
188 float *values;
189 uint32_t n_values;
190 uint32_t max_values;
191};
192
194 struct pw_time {
195 int64_t now;
196 struct spa_fraction rate;
197 uint64_t ticks;
199 int64_t delay;
202 uint64_t queued;
205};
206
207#include <pipewire/port.h>
208
211 struct pw_stream_events {
212#define PW_VERSION_STREAM_EVENTS 0
213 uint32_t version;
214
215 void (*destroy) (void *data);
217 void (*state_changed) (void *data, enum pw_stream_state old,
218 enum pw_stream_state state, const char *error);
219
221 void (*control_info) (void *data, uint32_t id, const struct pw_stream_control *control);
222
224 void (*io_changed) (void *data, uint32_t id, void *area, uint32_t size);
226 void (*param_changed) (void *data, uint32_t id, const struct spa_pod *param);
227
229 void (*add_buffer) (void *data, struct pw_buffer *buffer);
231 void (*remove_buffer) (void *data, struct pw_buffer *buffer);
232
237 void (*process) (void *data);
238
240 void (*drained) (void *data);
241};
242
244const char * pw_stream_state_as_string(enum pw_stream_state state);
245
247 enum pw_stream_flags {
248 PW_STREAM_FLAG_NONE = 0,
249 PW_STREAM_FLAG_AUTOCONNECT = (1 << 0),
251 PW_STREAM_FLAG_INACTIVE = (1 << 1),
254 PW_STREAM_FLAG_MAP_BUFFERS = (1 << 2),
255 PW_STREAM_FLAG_DRIVER = (1 << 3),
256 PW_STREAM_FLAG_RT_PROCESS = (1 << 4),
259 PW_STREAM_FLAG_NO_CONVERT = (1 << 5),
260 PW_STREAM_FLAG_EXCLUSIVE = (1 << 6),
262 PW_STREAM_FLAG_DONT_RECONNECT = (1 << 7),
264 PW_STREAM_FLAG_ALLOC_BUFFERS = (1 << 8),
267};
268
271struct pw_stream *
272 pw_stream_new(struct pw_core *core,
273 const char *name,
274 struct pw_properties *props );
275
276struct pw_stream *
277 pw_stream_new_simple(struct pw_loop *loop,
278 const char *name,
279 struct pw_properties *props,
280 const struct pw_stream_events *events,
281 void *data );
282
284void pw_stream_destroy(struct pw_stream *stream);
285
286void pw_stream_add_listener(struct pw_stream *stream,
287 struct spa_hook *listener,
288 const struct pw_stream_events *events,
289 void *data);
290
291enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error);
292
293const char *pw_stream_get_name(struct pw_stream *stream);
294
295struct pw_core *pw_stream_get_core(struct pw_stream *stream);
296
297const struct pw_properties *pw_stream_get_properties(struct pw_stream *stream);
298
299int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict);
300
306int
307 pw_stream_connect(struct pw_stream *stream,
308 enum pw_direction direction,
309 uint32_t target_id,
312 enum pw_stream_flags flags,
313 const struct spa_pod **params,
316 uint32_t n_params );
317
320uint32_t
321 pw_stream_get_node_id(struct pw_stream *stream);
322
324int pw_stream_disconnect(struct pw_stream *stream);
325
327 int pw_stream_set_error(struct pw_stream *stream,
328 int res,
329 const char *error,
330 ...) SPA_PRINTF_FUNC(3, 4);
331
338int
339 pw_stream_update_params(struct pw_stream *stream,
340 const struct spa_pod **params,
343 uint32_t n_params );
344
346const struct pw_stream_control *pw_stream_get_control(struct pw_stream *stream, uint32_t id);
347
349int pw_stream_set_control(struct pw_stream *stream, uint32_t id, uint32_t n_values, float *values, ...);
350
352int pw_stream_get_time(struct pw_stream *stream, struct pw_time *time);
353
356struct pw_buffer *pw_stream_dequeue_buffer(struct pw_stream *stream);
357
359int pw_stream_queue_buffer(struct pw_stream *stream, struct pw_buffer *buffer);
360
362int pw_stream_set_active(struct pw_stream *stream, bool active);
363
366int pw_stream_flush(struct pw_stream *stream, bool drain);
367
372bool pw_stream_is_driving(struct pw_stream *stream);
373
376int pw_stream_trigger_process(struct pw_stream *stream);
377
382#ifdef __cplusplus
383}
384#endif
385
386#endif /* PIPEWIRE_STREAM_H */
buffer.h
pw_direction
#define pw_direction
The direction of a port.
Definition: port.h:56
pw_stream_flags
pw_stream_flags
Extra flags that can be used in pw_stream_connect()
Definition: stream.h:247
pw_stream_update_properties
int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict)
Definition: stream.c:1508
pw_stream_get_state
enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error)
Definition: stream.c:1488
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:1883
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:1603
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:2020
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:1819
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:1901
pw_stream_is_driving
bool pw_stream_is_driving(struct pw_stream *stream)
Check if the stream is driving.
Definition: stream.c:2113
pw_stream_flush
int pw_stream_flush(struct pw_stream *stream, bool drain)
Flush a stream.
Definition: stream.c:2101
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 Object.
Definition: stream.c:1335
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:1980
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:1953
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:1401
pw_stream_state
pw_stream_state
The state of a stream.
Definition: stream.h:167
pw_stream_disconnect
int pw_stream_disconnect(struct pw_stream *stream)
Disconnect stream
Definition: stream.c:1825
pw_stream_set_active
int pw_stream_set_active(struct pw_stream *stream, bool active)
Activate or deactivate the stream.
Definition: stream.c:1967
pw_stream_trigger_process
int pw_stream_trigger_process(struct pw_stream *stream)
Trigger a push/pull on the stream.
Definition: stream.c:2136
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:2047
pw_stream_get_name
const char * pw_stream_get_name(struct pw_stream *stream)
Definition: stream.c:1496
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:1357
pw_stream_get_properties
const struct pw_properties * pw_stream_get_properties(struct pw_stream *stream)
Definition: stream.c:1502
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:1472
pw_stream_destroy
void pw_stream_destroy(struct pw_stream *stream)
Destroy a stream.
Definition: stream.c:1419
pw_stream_get_core
struct pw_core * pw_stream_get_core(struct pw_stream *stream)
Definition: stream.c:1525
PW_STREAM_FLAG_INACTIVE
@ PW_STREAM_FLAG_INACTIVE
start the stream inactive, pw_stream_set_active() needs to be called explicitly
Definition: stream.h:251
PW_STREAM_FLAG_MAP_BUFFERS
@ PW_STREAM_FLAG_MAP_BUFFERS
mmap the buffers except DmaBuf
Definition: stream.h:254
PW_STREAM_FLAG_DRIVER
@ PW_STREAM_FLAG_DRIVER
be a driver
Definition: stream.h:255
PW_STREAM_FLAG_EXCLUSIVE
@ PW_STREAM_FLAG_EXCLUSIVE
require exclusive access to the device
Definition: stream.h:260
PW_STREAM_FLAG_NO_CONVERT
@ PW_STREAM_FLAG_NO_CONVERT
don't convert format
Definition: stream.h:259
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:262
PW_STREAM_FLAG_AUTOCONNECT
@ PW_STREAM_FLAG_AUTOCONNECT
try to automatically connect this stream
Definition: stream.h:249
PW_STREAM_FLAG_ALLOC_BUFFERS
@ PW_STREAM_FLAG_ALLOC_BUFFERS
the application will allocate buffer memory.
Definition: stream.h:264
PW_STREAM_FLAG_RT_PROCESS
@ PW_STREAM_FLAG_RT_PROCESS
call process from the realtime thread.
Definition: stream.h:256
PW_STREAM_FLAG_NONE
@ PW_STREAM_FLAG_NONE
no flags
Definition: stream.h:248
PW_STREAM_STATE_PAUSED
@ PW_STREAM_STATE_PAUSED
paused
Definition: stream.h:171
PW_STREAM_STATE_CONNECTING
@ PW_STREAM_STATE_CONNECTING
connection is in progress
Definition: stream.h:170
PW_STREAM_STATE_UNCONNECTED
@ PW_STREAM_STATE_UNCONNECTED
unconnected
Definition: stream.h:169
PW_STREAM_STATE_ERROR
@ PW_STREAM_STATE_ERROR
the stream is in error
Definition: stream.h:168
PW_STREAM_STATE_STREAMING
@ PW_STREAM_STATE_STREAMING
streaming
Definition: stream.h:172
SPA_PRINTF_FUNC
#define SPA_PRINTF_FUNC(fmt, arg1)
Definition: defs.h:211
props
const char * props
Definition: media-session.c:2383
name
const char * name
Definition: media-session.c:2380
param.h
port.h
buffer
Definition: filter.c:59
control
Definition: stream.c:86
data
user data to add to an object
Definition: media-session.c:110
param
Definition: media-session.c:116
pw_buffer
Definition: stream.h:175
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:178
pw_buffer::buffer
struct spa_buffer * buffer
the spa buffer
Definition: stream.h:176
pw_buffer::user_data
void * user_data
user data attached to the buffer
Definition: stream.h:177
pw_loop
Definition: pipewire/src/pipewire/loop.h:47
pw_properties
Definition: properties.h:49
pw_properties::dict
struct spa_dict dict
dictionary of key/values
Definition: properties.h:50
pw_properties::flags
uint32_t flags
extra flags
Definition: properties.h:51
pw_stream_control
Definition: stream.h:182
pw_stream_control::max
float max
max value
Definition: stream.h:187
pw_stream_control::flags
uint32_t flags
extra flags (unused)
Definition: stream.h:184
pw_stream_control::def
float def
default value
Definition: stream.h:185
pw_stream_control::max_values
uint32_t max_values
max values that can be set on this control
Definition: stream.h:190
pw_stream_control::min
float min
min value
Definition: stream.h:186
pw_stream_control::n_values
uint32_t n_values
number of values in array
Definition: stream.h:189
pw_stream_control::values
float * values
array of values
Definition: stream.h:188
pw_stream_control::name
const char * name
name of the control
Definition: stream.h:183
pw_stream_events
Events for a stream.
Definition: stream.h:211
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:231
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:221
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:226
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:237
pw_stream_events::version
uint32_t version
Definition: stream.h:213
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:217
pw_stream_events::drained
void(* drained)(void *data)
The stream is drained.
Definition: stream.h:240
pw_stream_events::destroy
void(* destroy)(void *data)
Definition: stream.h:215
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:229
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:224
pw_time
A time structure.
Definition: stream.h:194
pw_time::delay
int64_t delay
delay to device, add to ticks to get the time of the device.
Definition: stream.h:199
pw_time::rate
struct spa_fraction rate
the rate of ticks and delay
Definition: stream.h:196
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:202
pw_time::ticks
uint64_t ticks
the ticks at now.
Definition: stream.h:197
pw_time::now
int64_t now
the monotonic time in nanoseconds
Definition: stream.h:195
spa_buffer
A Buffer.
Definition: buffer/buffer.h:93
spa_dict
Definition: utils/dict.h:48
spa_fraction
Definition: defs.h:104
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:295
spa_pod
Definition: pod/pod.h:50
stream
Definition: alsa-endpoint.c:91