PipeWire  0.3.29
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>
165 
173 };
174 
175 struct pw_buffer {
176  struct spa_buffer *buffer;
177  void *user_data;
178  uint64_t size;
180 };
181 
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;
197  uint64_t ticks;
199  int64_t delay;
202  uint64_t queued;
205 };
206 
207 #include <pipewire/port.h>
208 
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 };
243 
245 const char * pw_stream_state_as_string(enum pw_stream_state state);
246 
268 };
269 
272 struct pw_stream *
273 pw_stream_new(struct pw_core *core,
274  const char *name,
275  struct pw_properties *props );
276 
277 struct pw_stream *
278 pw_stream_new_simple(struct pw_loop *loop,
279  const char *name,
280  struct pw_properties *props,
281  const struct pw_stream_events *events,
282  void *data );
283 
285 void pw_stream_destroy(struct pw_stream *stream);
286 
287 void pw_stream_add_listener(struct pw_stream *stream,
288  struct spa_hook *listener,
289  const struct pw_stream_events *events,
290  void *data);
291 
292 enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error);
293 
294 const char *pw_stream_get_name(struct pw_stream *stream);
295 
296 struct pw_core *pw_stream_get_core(struct pw_stream *stream);
297 
298 const struct pw_properties *pw_stream_get_properties(struct pw_stream *stream);
299 
300 int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict);
301 
307 int
308 pw_stream_connect(struct pw_stream *stream,
309  enum pw_direction direction,
310  uint32_t target_id,
313  enum pw_stream_flags flags,
314  const struct spa_pod **params,
317  uint32_t n_params );
318 
321 uint32_t
322 pw_stream_get_node_id(struct pw_stream *stream);
323 
325 int pw_stream_disconnect(struct pw_stream *stream);
326 
328 int pw_stream_set_error(struct pw_stream *stream,
329  int res,
330  const char *error,
331  ...) SPA_PRINTF_FUNC(3, 4);
332 
339 int
340 pw_stream_update_params(struct pw_stream *stream,
341  const struct spa_pod **params,
344  uint32_t n_params );
345 
347 int pw_stream_set_control(struct pw_stream *stream, uint32_t id, uint32_t n_values, float *values, ...);
348 
350 int pw_stream_get_time(struct pw_stream *stream, struct pw_time *time);
351 
354 struct pw_buffer *pw_stream_dequeue_buffer(struct pw_stream *stream);
355 
357 int pw_stream_queue_buffer(struct pw_stream *stream, struct pw_buffer *buffer);
358 
360 int pw_stream_set_active(struct pw_stream *stream, bool active);
361 
364 int pw_stream_flush(struct pw_stream *stream, bool drain);
365 
370 #ifdef __cplusplus
371 }
372 #endif
373 
374 #endif /* PIPEWIRE_STREAM_H */
void pw_stream_destroy(struct pw_stream *stream)
Destroy a stream.
Definition: stream.c:1400
#define pw_direction
The direction of a port.
Definition: port.h:56
uint64_t ticks
the ticks at now.
Definition: stream.h:197
Definition: properties.h:49
the stream is in error
Definition: stream.h:168
uint32_t n_values
number of values in array
Definition: stream.h:189
the application will allocate buffer memory.
Definition: stream.h:265
float * values
array of values
Definition: stream.h:188
const char * name
name of the control
Definition: stream.h:183
int64_t now
the monotonic time in nanoseconds
Definition: stream.h:195
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:76
Definition: stream.h:182
Definition: src/pipewire/loop.h:47
A time structure.
Definition: stream.h:194
struct spa_dict dict
dictionary of key/values
Definition: properties.h:50
void(* add_buffer)(void *data, struct pw_buffer *buffer)
when a new buffer was created for this stream
Definition: stream.h:229
int pw_stream_flush(struct pw_stream *stream, bool drain)
Flush a stream.
Definition: stream.c:2085
Events for a stream.
Definition: stream.h:211
call process from the realtime thread.
Definition: stream.h:257
struct spa_fraction rate
the rate of ticks and delay
Definition: stream.h:196
static uint32_t int int res
Definition: core.h:328
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
don&#39;t try to reconnect this stream when the sink/source is removed
Definition: stream.h:263
connection is in progress
Definition: stream.h:170
void pw_stream_add_listener(struct pw_stream *stream, struct spa_hook *listener, const struct pw_stream_events *events, void *data)
Definition: stream.c:1453
const char * pw_stream_get_name(struct pw_stream *stream)
Definition: stream.c:1476
Definition: utils/dict.h:48
#define SPA_PRINTF_FUNC(fmt, arg1)
Definition: defs.h:203
try to automatically connect this stream
Definition: stream.h:250
static uint32_t id
Definition: core.h:328
int pw_stream_get_time(struct pw_stream *stream, struct pw_time *time)
Query the time on the stream.
Definition: stream.c:1957
paused
Definition: stream.h:171
int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict)
Definition: stream.c:1488
Definition: defs.h:103
float def
default value
Definition: stream.h:185
start the stream inactive, pw_stream_set_active() needs to be called explicitly
Definition: stream.h:252
int pw_stream_set_active(struct pw_stream *stream, bool active)
Activate or deactivate the stream.
Definition: stream.c:1947
pw_stream_state
The state of a stream.
Definition: stream.h:167
don&#39;t convert format
Definition: stream.h:260
void(* destroy)(void *data)
Definition: stream.h:215
A Buffer.
Definition: buffer/buffer.h:93
Definition: pod/pod.h:50
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
unconnected
Definition: stream.h:169
enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error)
Definition: stream.c:1468
buffer[1023]
Definition: core.h:333
Definition: filter.c:80
Definition: stream.c:97
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
Definition: stream.c:86
be a driver
Definition: stream.h:256
const char * pw_stream_state_as_string(enum pw_stream_state state)
Convert a stream state to a readable string.
Definition: stream.c:1382
void(* remove_buffer)(void *data, struct pw_buffer *buffer)
when a buffer was destroyed for this stream
Definition: stream.h:231
void(* param_changed)(void *data, uint32_t id, const struct spa_pod *param)
when a parameter changed
Definition: stream.h:226
float max
max value
Definition: stream.h:187
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:1583
int pw_stream_disconnect(struct pw_stream *stream)
Disconnect stream.
Definition: stream.c:1805
void(* drained)(void *data)
The stream is drained.
Definition: stream.h:240
int64_t delay
delay to device, add to ticks to get the time of the device.
Definition: stream.h:199
struct spa_buffer * buffer
the spa buffer
Definition: stream.h:176
Definition: filter.c:59
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:1863
void(* control_info)(void *data, uint32_t id, const struct pw_stream_control *control)
Notify information about a control.
Definition: stream.h:221
no flags
Definition: stream.h:249
require exclusive access to the device
Definition: stream.h:261
Definition: stream.h:175
void(* process)(void *data)
when a buffer can be queued (for playback streams) or dequeued (for capture streams).
Definition: stream.h:237
mmap the buffers except DmaBuf
Definition: stream.h:255
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:1316
uint32_t flags
extra flags (unused)
Definition: stream.h:184
uint32_t flags
extra flags
Definition: properties.h:51
const struct pw_properties * pw_stream_get_properties(struct pw_stream *stream)
Definition: stream.c:1482
uint32_t version
Definition: stream.h:213
pw_stream_flags
Extra flags that can be used in pw_stream_connect()
Definition: stream.h:248
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:1338
uint32_t max_values
max values that can be set on this control
Definition: stream.h:190
float min
min value
Definition: stream.h:186
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:2007
void(* io_changed)(void *data, uint32_t id, void *area, uint32_t size)
when io changed on the stream.
Definition: stream.h:224
streaming
Definition: stream.h:172
void * user_data
user data attached to the buffer
Definition: stream.h:177
uint32_t pw_stream_get_node_id(struct pw_stream *stream)
Get the node ID of the stream.
Definition: stream.c:1799
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:2034
Definition: filter.c:75
struct pw_core * pw_stream_get_core(struct pw_stream *stream)
Definition: stream.c:1505
int pw_stream_set_error(struct pw_stream *stream, int res, const char *error,...) SPA_PRINTF_FUNC(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:1881