PipeWire  0.3.45
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
29 extern "C" {
30 #endif
31 
161 struct pw_stream;
162 
163 #include <spa/buffer/buffer.h>
164 #include <spa/param/param.h>
166 
168 enum pw_stream_state {
169  PW_STREAM_STATE_ERROR = -1,
174 };
175 
176 struct pw_buffer {
177  struct spa_buffer *buffer;
178  void *user_data;
179  uint64_t size;
181 };
182 
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;
192 };
193 
195 struct pw_time {
196  int64_t now;
197  struct spa_fraction rate;
198  uint64_t ticks;
200  int64_t delay;
203  uint64_t queued;
206 };
207 
208 #include <pipewire/port.h>
209 
212 struct pw_stream_events {
213 #define PW_VERSION_STREAM_EVENTS 2
214  uint32_t version;
215 
216  void (*destroy) (void *data);
218  void (*state_changed) (void *data, enum pw_stream_state old,
219  enum pw_stream_state state, const char *error);
220 
222  void (*control_info) (void *data, uint32_t id, const struct pw_stream_control *control);
223 
225  void (*io_changed) (void *data, uint32_t id, void *area, uint32_t size);
227  void (*param_changed) (void *data, uint32_t id, const struct spa_pod *param);
228 
230  void (*add_buffer) (void *data, struct pw_buffer *buffer);
232  void (*remove_buffer) (void *data, struct pw_buffer *buffer);
233 
238  void (*process) (void *data);
239 
241  void (*drained) (void *data);
242 
244  void (*command) (void *data, const struct spa_command *command);
245 
247  void (*trigger_done) (void *data);
248 };
249 
251 const char * pw_stream_state_as_string(enum pw_stream_state state);
252 
254 enum pw_stream_flags {
255  PW_STREAM_FLAG_NONE = 0,
256  PW_STREAM_FLAG_AUTOCONNECT = (1 << 0),
258  PW_STREAM_FLAG_INACTIVE = (1 << 1),
262  PW_STREAM_FLAG_DRIVER = (1 << 3),
269  PW_STREAM_FLAG_DONT_RECONNECT = (1 << 7),
279 };
280 
283 struct pw_stream *
284 pw_stream_new(struct pw_core *core,
285  const char *name,
286  struct pw_properties *props );
287 
288 struct pw_stream *
289 pw_stream_new_simple(struct pw_loop *loop,
290  const char *name,
291  struct pw_properties *props,
292  const struct pw_stream_events *events,
293  void *data );
294 
296 void pw_stream_destroy(struct pw_stream *stream);
297 
298 void pw_stream_add_listener(struct pw_stream *stream,
299  struct spa_hook *listener,
300  const struct pw_stream_events *events,
301  void *data);
302 
303 enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error);
304 
305 const char *pw_stream_get_name(struct pw_stream *stream);
306 
307 struct pw_core *pw_stream_get_core(struct pw_stream *stream);
308 
309 const struct pw_properties *pw_stream_get_properties(struct pw_stream *stream);
310 
311 int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict);
312 
318 int
319 pw_stream_connect(struct pw_stream *stream,
320  enum pw_direction direction,
321  uint32_t target_id,
324  enum pw_stream_flags flags,
325  const struct spa_pod **params,
328  uint32_t n_params );
329 
332 uint32_t
333 pw_stream_get_node_id(struct pw_stream *stream);
334 
336 int pw_stream_disconnect(struct pw_stream *stream);
337 
339 int pw_stream_set_error(struct pw_stream *stream,
340  int res,
341  const char *error,
342  ...) SPA_PRINTF_FUNC(3, 4);
343 
350 int
351 pw_stream_update_params(struct pw_stream *stream,
352  const struct spa_pod **params,
355  uint32_t n_params );
356 
358 const struct pw_stream_control *pw_stream_get_control(struct pw_stream *stream, uint32_t id);
359 
361 int pw_stream_set_control(struct pw_stream *stream, uint32_t id, uint32_t n_values, float *values, ...);
362 
364 int pw_stream_get_time(struct pw_stream *stream, struct pw_time *time);
365 
368 struct pw_buffer *pw_stream_dequeue_buffer(struct pw_stream *stream);
369 
371 int pw_stream_queue_buffer(struct pw_stream *stream, struct pw_buffer *buffer);
372 
374 int pw_stream_set_active(struct pw_stream *stream, bool active);
375 
378 int pw_stream_flush(struct pw_stream *stream, bool drain);
379 
384 bool pw_stream_is_driving(struct pw_stream *stream);
385 
388 int pw_stream_trigger_process(struct pw_stream *stream);
389 
394 #ifdef __cplusplus
395 }
396 #endif
397 
398 #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:260
int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict)
Definition: stream.c:1578
enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error)
Definition: stream.c:1558
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:1957
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:1673
uint32_t pw_stream_get_node_id(struct pw_stream *stream)
Get the node ID of the stream.
Definition: stream.c:1893
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:1975
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:1405
bool pw_stream_is_driving(struct pw_stream *stream)
Check if the stream is driving.
Definition: stream.c:2187
const struct pw_stream_control * pw_stream_get_control(struct pw_stream *stream, uint32_t id)
Get control values.
Definition: stream.c:2027
int pw_stream_flush(struct pw_stream *stream, bool drain)
Flush a stream.
Definition: stream.c:2175
int pw_stream_get_time(struct pw_stream *stream, struct pw_time *time)
Query the time on the stream
Definition: stream.c:2054
const char * pw_stream_get_name(struct pw_stream *stream)
Definition: stream.c:1566
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:1427
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:1899
int pw_stream_set_active(struct pw_stream *stream, bool active)
Activate or deactivate the stream.
Definition: stream.c:2041
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:2094
int pw_stream_trigger_process(struct pw_stream *stream)
Trigger a push/pull on the stream.
Definition: stream.c:2222
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:2121
void pw_stream_add_listener(struct pw_stream *stream, struct spa_hook *listener, const struct pw_stream_events *events, void *data)
Definition: stream.c:1542
const char * pw_stream_state_as_string(enum pw_stream_state state)
Convert a stream state to a readable string.
Definition: stream.c:1471
struct pw_core * pw_stream_get_core(struct pw_stream *stream)
Definition: stream.c:1595
void pw_stream_destroy(struct pw_stream *stream)
Destroy a stream.
Definition: stream.c:1489
const struct pw_properties * pw_stream_get_properties(struct pw_stream *stream)
Definition: stream.c:1572
@ 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
mmap the buffers except DmaBuf
Definition: stream.h:267
@ PW_STREAM_FLAG_DRIVER
be a driver
Definition: stream.h:268
@ PW_STREAM_FLAG_EXCLUSIVE
require exclusive access to the device
Definition: stream.h:273
@ PW_STREAM_FLAG_NO_CONVERT
don't convert format
Definition: stream.h:272
@ 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
don't try to reconnect this stream when the sink/source is removed
Definition: stream.h:275
@ PW_STREAM_FLAG_AUTOCONNECT
try to automatically connect this stream
Definition: stream.h:262
@ PW_STREAM_FLAG_ALLOC_BUFFERS
the application will allocate buffer memory.
Definition: stream.h:277
@ PW_STREAM_FLAG_RT_PROCESS
call process from the realtime thread.
Definition: stream.h:269
@ PW_STREAM_FLAG_NONE
no flags
Definition: stream.h:261
@ 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:217
void(* remove_buffer)(void *data, struct pw_buffer *buffer)
when a buffer was destroyed for this stream
Definition: stream.h:238
void(* control_info)(void *data, uint32_t id, const struct pw_stream_control *control)
Notify information about a control.
Definition: stream.h:228
void(* trigger_done)(void *data)
a trigger_process completed.
Definition: stream.h:253
void(* param_changed)(void *data, uint32_t id, const struct spa_pod *param)
when a parameter changed
Definition: stream.h:233
void(* process)(void *data)
when a buffer can be queued (for playback streams) or dequeued (for capture streams).
Definition: stream.h:244
void(* command)(void *data, const struct spa_command *command)
A command notify, Since 0.3.39:1.
Definition: stream.h:250
uint32_t version
Definition: stream.h:220
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
void(* drained)(void *data)
The stream is drained.
Definition: stream.h:247
void(* destroy)(void *data)
Definition: stream.h:222
void(* add_buffer)(void *data, struct pw_buffer *buffer)
when a new buffer was created for this stream
Definition: stream.h:236
void(* io_changed)(void *data, uint32_t id, void *area, uint32_t size)
when io changed on the stream.
Definition: stream.h:231
A time structure.
Definition: stream.h:200
int64_t delay
delay to device, add to ticks to get the time of the device.
Definition: stream.h:205
struct spa_fraction rate
the rate of ticks and delay
Definition: stream.h:202
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
uint64_t ticks
the ticks at now.
Definition: stream.h:203
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:342
Definition: pod.h:63