PipeWire  0.3.27
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 
150 struct pw_stream;
151 
152 #include <spa/buffer/buffer.h>
153 #include <spa/param/param.h>
154 
162 };
163 
164 struct pw_buffer {
165  struct spa_buffer *buffer;
166  void *user_data;
167  uint64_t size;
169 };
170 
172  const char *name;
173  uint32_t flags;
174  float def;
175  float min;
176  float max;
177  float *values;
178  uint32_t n_values;
179  uint32_t max_values;
180 };
181 
183 struct pw_time {
184  int64_t now;
185  struct spa_fraction rate;
186  uint64_t ticks;
188  int64_t delay;
191  uint64_t queued;
194 };
195 
196 #include <pipewire/pipewire.h>
197 
201 #define PW_VERSION_STREAM_EVENTS 0
202  uint32_t version;
203 
204  void (*destroy) (void *data);
206  void (*state_changed) (void *data, enum pw_stream_state old,
207  enum pw_stream_state state, const char *error);
208 
210  void (*control_info) (void *data, uint32_t id, const struct pw_stream_control *control);
211 
213  void (*io_changed) (void *data, uint32_t id, void *area, uint32_t size);
215  void (*param_changed) (void *data, uint32_t id, const struct spa_pod *param);
216 
218  void (*add_buffer) (void *data, struct pw_buffer *buffer);
220  void (*remove_buffer) (void *data, struct pw_buffer *buffer);
221 
226  void (*process) (void *data);
227 
229  void (*drained) (void *data);
230 
231 };
232 
234 const char * pw_stream_state_as_string(enum pw_stream_state state);
235 
257 };
258 
261 struct pw_stream *
262 pw_stream_new(struct pw_core *core,
263  const char *name,
264  struct pw_properties *props );
265 
266 struct pw_stream *
267 pw_stream_new_simple(struct pw_loop *loop,
268  const char *name,
269  struct pw_properties *props,
270  const struct pw_stream_events *events,
271  void *data );
272 
274 void pw_stream_destroy(struct pw_stream *stream);
275 
277  struct spa_hook *listener,
278  const struct pw_stream_events *events,
279  void *data);
280 
281 enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error);
282 
283 const char *pw_stream_get_name(struct pw_stream *stream);
284 
285 struct pw_core *pw_stream_get_core(struct pw_stream *stream);
286 
288 
289 int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict);
290 
296 int
298  enum pw_direction direction,
299  uint32_t target_id,
302  enum pw_stream_flags flags,
303  const struct spa_pod **params,
306  uint32_t n_params );
307 
310 uint32_t
312 
315 
318  int res,
319  const char *error, ... ) SPA_PRINTF_FUNC(3, 4);
320 
327 int
328 pw_stream_update_params(struct pw_stream *stream,
329  const struct spa_pod **params,
332  uint32_t n_params );
333 
335 int pw_stream_set_control(struct pw_stream *stream, uint32_t id, uint32_t n_values, float *values, ...);
336 
338 int pw_stream_get_time(struct pw_stream *stream, struct pw_time *time);
339 
342 struct pw_buffer *pw_stream_dequeue_buffer(struct pw_stream *stream);
343 
345 int pw_stream_queue_buffer(struct pw_stream *stream, struct pw_buffer *buffer);
346 
348 int pw_stream_set_active(struct pw_stream *stream, bool active);
349 
352 int pw_stream_flush(struct pw_stream *stream, bool drain);
353 
354 #ifdef __cplusplus
355 }
356 #endif
357 
358 #endif /* PIPEWIRE_STREAM_H */
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:1977
uint64_t ticks
the ticks at now.
Definition: stream.h:186
A collection of key/value pairs.
Definition: properties.h:45
static uint32_t int int res
Definition: core.h:325
require exclusive access to the device
Definition: stream.h:250
uint32_t n_values
number of values in array
Definition: stream.h:178
buffer[1023]
Definition: core.h:330
paused
Definition: stream.h:160
float * values
array of values
Definition: stream.h:177
try to automatically connect this stream
Definition: stream.h:239
const char * pw_stream_state_as_string(enum pw_stream_state state)
Convert a stream state to a readable string.
Definition: stream.c:1343
const char * name
name of the control
Definition: stream.h:172
int64_t now
the monotonic time in nanoseconds
Definition: stream.h:184
Definition: stream.h:171
PipeWire loop object provides an implementation of the spa loop interfaces.
Definition: loop.h:41
A time structure.
Definition: stream.h:183
struct spa_dict dict
dictionary of key/values
Definition: properties.h:46
void(* add_buffer)(void *data, struct pw_buffer *buffer)
when a new buffer was created for this stream
Definition: stream.h:218
Events for a stream.
Definition: stream.h:200
pw_stream_state
The state of a stream.
Definition: stream.h:156
mmap the buffers except DmaBuf
Definition: stream.h:244
struct spa_fraction rate
the rate of ticks and delay
Definition: stream.h:185
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:191
int pw_stream_disconnect(struct pw_stream *stream)
Disconnect stream.
Definition: stream.c:1752
streaming
Definition: stream.h:161
struct pw_core * pw_stream_get_core(struct pw_stream *stream)
Definition: stream.c:1452
PipeWire stream object class.
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:1530
void pw_stream_destroy(struct pw_stream *stream)
Destroy a stream.
Definition: stream.c:1361
enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error)
Definition: stream.c:1415
don't convert format
Definition: stream.h:249
uint32_t pw_stream_get_node_id(struct pw_stream *stream)
Get the node ID of the stream.
Definition: stream.c:1746
don't try to reconnect this stream when the sink/source is removed
Definition: stream.h:252
be a driver
Definition: stream.h:245
the stream is in error
Definition: stream.h:157
float def
default value
Definition: stream.h:174
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:1298
void(* destroy)(void *data)
Definition: stream.h:204
int pw_stream_get_time(struct pw_stream *stream, struct pw_time *time)
Query the time on the stream.
Definition: stream.c:1904
int pw_stream_set_control(struct pw_stream *stream, uint32_t id, uint32_t n_values, float *values,...)
Set control values.
Definition: stream.c:1828
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:1950
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:167
start the stream inactive, pw_stream_set_active() needs to be called explicitly
Definition: stream.h:241
Definition: filter.c:79
const char * pw_stream_get_name(struct pw_stream *stream)
Definition: stream.c:1423
const struct pw_properties * pw_stream_get_properties(struct pw_stream *stream)
Definition: stream.c:1429
pw_stream_flags
Extra flags that can be used in pw_stream_connect()
Definition: stream.h:237
int pw_stream_flush(struct pw_stream *stream, bool drain)
Flush a stream.
Definition: stream.c:2025
void pw_stream_add_listener(struct pw_stream *stream, struct spa_hook *listener, const struct pw_stream_events *events, void *data)
Definition: stream.c:1406
#define pw_direction
Definition: port.h:47
struct pw_stream * pw_stream_new(struct pw_core *core, const char *name, struct pw_properties *props)
Create a new unconneced pw_stream.
Definition: stream.c:1276
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:206
Definition: stream.c:86
void(* remove_buffer)(void *data, struct pw_buffer *buffer)
when a buffer was destroyed for this stream
Definition: stream.h:220
void(* param_changed)(void *data, uint32_t id, const struct spa_pod *param)
when a parameter changed
Definition: stream.h:215
int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict *dict)
Definition: stream.c:1435
float max
max value
Definition: stream.h:176
void(* drained)(void *data)
The stream is drained.
Definition: stream.h:229
call process from the realtime thread.
Definition: stream.h:246
int64_t delay
delay to device, add to ticks to get the time of the device.
Definition: stream.h:188
struct spa_buffer * buffer
the spa buffer
Definition: stream.h:165
int pw_stream_set_active(struct pw_stream *stream, bool active)
Activate or deactivate the stream.
Definition: stream.c:1894
Definition: filter.c:58
static uint32_t id
Definition: core.h:325
connection is in progress
Definition: stream.h:159
void(* control_info)(void *data, uint32_t id, const struct pw_stream_control *control)
Notify information about a control.
Definition: stream.h:210
int pw_stream_set_error(struct pw_stream *stream, int res, const char *error,...) SPA_PRINTF_FUNC(3
Set the stream in error state.
Definition: stream.h:164
void(* process)(void *data)
when a buffer can be queued (for playback streams) or dequeued (for capture streams).
Definition: stream.h:226
the application will allocate buffer memory.
Definition: stream.h:254
uint32_t flags
extra flags (unused)
Definition: stream.h:173
uint32_t flags
extra flags
Definition: properties.h:47
uint32_t version
Definition: stream.h:202
unconnected
Definition: stream.h:158
uint32_t max_values
max values that can be set on this control
Definition: stream.h:179
float min
min value
Definition: stream.h:175
void(* io_changed)(void *data, uint32_t id, void *area, uint32_t size)
when io changed on the stream.
Definition: stream.h:213
void * user_data
user data attached to the buffer
Definition: stream.h:166
no flags
Definition: stream.h:238
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:1810
Definition: filter.c:74