PipeWire 0.3.49
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>
166
168enum pw_stream_state {
176struct pw_buffer {
178 void *user_data;
179 uint64_t size;
184 const char *name;
185 uint32_t flags;
186 float def;
187 float min;
188 float max;
189 float *values;
190 uint32_t n_values;
191 uint32_t max_values;
195struct pw_time {
196 int64_t now;
202 struct spa_fraction rate;
204 uint64_t ticks;
206 int64_t delay;
214 uint64_t queued;
220};
221
222#include <pipewire/port.h>
223
226struct pw_stream_events {
227#define PW_VERSION_STREAM_EVENTS 2
228 uint32_t version;
229
230 void (*destroy) (void *data);
232 void (*state_changed) (void *data, enum pw_stream_state old,
233 enum pw_stream_state state, const char *error);
236 void (*control_info) (void *data, uint32_t id, const struct pw_stream_control *control);
237
239 void (*io_changed) (void *data, uint32_t id, void *area, uint32_t size);
241 void (*param_changed) (void *data, uint32_t id, const struct spa_pod *param);
244 void (*add_buffer) (void *data, struct pw_buffer *buffer);
246 void (*remove_buffer) (void *data, struct pw_buffer *buffer);
252 void (*process) (void *data);
253
255 void (*drained) (void *data);
256
258 void (*command) (void *data, const struct spa_command *command);
259
261 void (*trigger_done) (void *data);
262};
263
265const char * pw_stream_state_as_string(enum pw_stream_state state);
266
268enum pw_stream_flags {
270 PW_STREAM_FLAG_AUTOCONNECT = (1 << 0),
272 PW_STREAM_FLAG_INACTIVE = (1 << 1),
276 PW_STREAM_FLAG_DRIVER = (1 << 3),
294
297struct pw_stream *
298pw_stream_new(struct pw_core *core,
299 const char *name,
300 struct pw_properties *props );
301
302struct pw_stream *
303pw_stream_new_simple(struct pw_loop *loop,
304 const char *name,
305 struct pw_properties *props,
306 const struct pw_stream_events *events,
307 void *data );
308
310void pw_stream_destroy(struct pw_stream *stream);
311
312void pw_stream_add_listener(struct pw_stream *stream,
313 struct spa_hook *listener,
314 const struct pw_stream_events *events,
315 void *data);
316
317enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error);
318
319const char *pw_stream_get_name(struct pw_stream *stream);
320
321struct pw_core *pw_stream_get_core(struct pw_stream *stream);
322
323const struct pw_properties *pw_stream_get_properties(struct pw_stream *stream);
324
325int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict);
326
332int
333pw_stream_connect(struct pw_stream *stream,
334 enum pw_direction direction,
335 uint32_t target_id,
339 const struct spa_pod **params,
342 uint32_t n_params );
343
346uint32_t
347pw_stream_get_node_id(struct pw_stream *stream);
348
350int pw_stream_disconnect(struct pw_stream *stream);
351
353int pw_stream_set_error(struct pw_stream *stream,
354 int res,
355 const char *error,
356 ...) SPA_PRINTF_FUNC(3, 4);
357
364int
365pw_stream_update_params(struct pw_stream *stream,
366 const struct spa_pod **params,
369 uint32_t n_params );
370
372const struct pw_stream_control *pw_stream_get_control(struct pw_stream *stream, uint32_t id);
373
375int pw_stream_set_control(struct pw_stream *stream, uint32_t id, uint32_t n_values, float *values, ...);
376
378int pw_stream_get_time(struct pw_stream *stream, struct pw_time *time);
379
382struct pw_buffer *pw_stream_dequeue_buffer(struct pw_stream *stream);
383
385int pw_stream_queue_buffer(struct pw_stream *stream, struct pw_buffer *buffer);
386
388int pw_stream_set_active(struct pw_stream *stream, bool active);
389
392int pw_stream_flush(struct pw_stream *stream, bool drain);
393
398bool pw_stream_is_driving(struct pw_stream *stream);
399
402int pw_stream_trigger_process(struct pw_stream *stream);
403
408#ifdef __cplusplus
409}
410#endif
411
412#endif /* PIPEWIRE_STREAM_H */
spa/buffer/buffer.h
#define pw_direction
The direction of a port.
Definition: port.h:63
pw_stream_flags
Extra flags that can be used in pw_stream_connect()
Definition: stream.h:274
int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict)
Definition: stream.c:1597
enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error)
Definition: stream.c:1577
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:1977
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:1692
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:2118
uint32_t pw_stream_get_node_id(struct pw_stream *stream)
Get the node ID of the stream.
Definition: stream.c:1913
int pw_stream_set_error(struct pw_stream *stream, int res, const char *error,...) 1(3
Set the stream in error state.
int pw_stream_set_control(struct pw_stream *stream, uint32_t id, uint32_t n_values, float *values,...)
Set control values.
Definition: stream.c:1995
bool pw_stream_is_driving(struct pw_stream *stream)
Check if the stream is driving.
Definition: stream.c:2211
int pw_stream_flush(struct pw_stream *stream, bool drain)
Flush a stream.
Definition: stream.c:2199
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:1424
int pw_stream_get_time(struct pw_stream *stream, struct pw_time *time)
Query the time on the stream
Definition: stream.c:2074
const struct pw_stream_control * pw_stream_get_control(struct pw_stream *stream, uint32_t id)
Get control values.
Definition: stream.c:2047
const char * pw_stream_state_as_string(enum pw_stream_state state)
Convert a stream state to a readable string.
Definition: stream.c:1490
pw_stream_state
The state of a stream.
Definition: stream.h:173
int pw_stream_disconnect(struct pw_stream *stream)
Disconnect stream
Definition: stream.c:1919
int pw_stream_set_active(struct pw_stream *stream, bool active)
Activate or deactivate the stream.
Definition: stream.c:2061
int pw_stream_trigger_process(struct pw_stream *stream)
Trigger a push/pull on the stream.
Definition: stream.c:2246
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:2145
const char * pw_stream_get_name(struct pw_stream *stream)
Definition: stream.c:1585
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:1446
const struct pw_properties * pw_stream_get_properties(struct pw_stream *stream)
Definition: stream.c:1591
void pw_stream_add_listener(struct pw_stream *stream, struct spa_hook *listener, const struct pw_stream_events *events, void *data)
Definition: stream.c:1561
void pw_stream_destroy(struct pw_stream *stream)
Destroy a stream.
Definition: stream.c:1508
struct pw_core * pw_stream_get_core(struct pw_stream *stream)
Definition: stream.c:1614
@ PW_STREAM_FLAG_INACTIVE
start the stream inactive, pw_stream_set_active() needs to be called explicitly
Definition: stream.h:278
@ PW_STREAM_FLAG_MAP_BUFFERS
mmap the buffers except DmaBuf
Definition: stream.h:281
@ PW_STREAM_FLAG_DRIVER
be a driver
Definition: stream.h:282
@ PW_STREAM_FLAG_EXCLUSIVE
require exclusive access to the device
Definition: stream.h:287
@ PW_STREAM_FLAG_NO_CONVERT
don't convert format
Definition: stream.h:286
@ PW_STREAM_FLAG_TRIGGER
the output stream will not be scheduled automatically but _trigger_process() needs to be called.
Definition: stream.h:294
@ PW_STREAM_FLAG_DONT_RECONNECT
don't try to reconnect this stream when the sink/source is removed
Definition: stream.h:289
@ PW_STREAM_FLAG_AUTOCONNECT
try to automatically connect this stream
Definition: stream.h:276
@ PW_STREAM_FLAG_ALLOC_BUFFERS
the application will allocate buffer memory.
Definition: stream.h:291
@ PW_STREAM_FLAG_RT_PROCESS
call process from the realtime thread.
Definition: stream.h:283
@ PW_STREAM_FLAG_NONE
no flags
Definition: stream.h:275
@ PW_STREAM_STATE_PAUSED
paused
Definition: stream.h:177
@ PW_STREAM_STATE_CONNECTING
connection is in progress
Definition: stream.h:176
@ PW_STREAM_STATE_UNCONNECTED
unconnected
Definition: stream.h:175
@ PW_STREAM_STATE_ERROR
the stream is in error
Definition: stream.h:174
@ PW_STREAM_STATE_STREAMING
streaming
Definition: stream.h:178
#define SPA_PRINTF_FUNC(fmt, arg1)
Definition: defs.h:260
spa/param/param.h
spa/pod/command.h
pipewire/port.h
Definition: stream.h:181
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
struct spa_buffer * buffer
the spa buffer
Definition: stream.h:182
void * user_data
user data attached to the buffer
Definition: stream.h:183
Definition: loop.h:51
Definition: properties.h:53
struct spa_dict dict
dictionary of key/values
Definition: properties.h:54
uint32_t flags
extra flags
Definition: properties.h:55
Definition: stream.h:188
float max
max value
Definition: stream.h:193
uint32_t flags
extra flags (unused)
Definition: stream.h:190
float def
default value
Definition: stream.h:191
uint32_t max_values
max values that can be set on this control
Definition: stream.h:196
float min
min value
Definition: stream.h:192
uint32_t n_values
number of values in array
Definition: stream.h:195
float * values
array of values
Definition: stream.h:194
Events for a stream.
Definition: stream.h:231
void(* remove_buffer)(void *data, struct pw_buffer *buffer)
when a buffer was destroyed for this stream
Definition: stream.h:252
void(* control_info)(void *data, uint32_t id, const struct pw_stream_control *control)
Notify information about a control.
Definition: stream.h:242
void(* trigger_done)(void *data)
a trigger_process completed.
Definition: stream.h:267
void(* param_changed)(void *data, uint32_t id, const struct spa_pod *param)
when a parameter changed
Definition: stream.h:247
void(* process)(void *data)
when a buffer can be queued (for playback streams) or dequeued (for capture streams).
Definition: stream.h:258
void(* command)(void *data, const struct spa_command *command)
A command notify, Since 0.3.39:1.
Definition: stream.h:264
uint32_t version
Definition: stream.h:234
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:238
void(* drained)(void *data)
The stream is drained.
Definition: stream.h:261
void(* destroy)(void *data)
Definition: stream.h:236
void(* add_buffer)(void *data, struct pw_buffer *buffer)
when a new buffer was created for this stream
Definition: stream.h:250
void(* io_changed)(void *data, uint32_t id, void *area, uint32_t size)
when io changed on the stream.
Definition: stream.h:245
A time structure.
Definition: stream.h:200
int64_t delay
delay to device.
Definition: stream.h:211
struct spa_fraction rate
the rate of ticks and delay.
Definition: stream.h:207
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:219
uint64_t ticks
the ticks at now.
Definition: stream.h:209
int64_t now
the monotonic time in nanoseconds.
Definition: stream.h:201
A Buffer.
Definition: buffer.h:105
Definition: command.h:49
Definition: dict.h:59
Definition: defs.h:121
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:351
Definition: pod.h:63