PipeWire 0.2.5

stream.h
Go to the documentation of this file.
1 /* PipeWire
2 * Copyright (C) 2015 Wim Taymans <wim.taymans@gmail.com>
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
13 *
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
17 * Boston, MA 02110-1301, USA.
18 */
19
20 #ifndef __PIPEWIRE_STREAM_H__
21 #define __PIPEWIRE_STREAM_H__
22
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26
147 struct pw_stream;
148
149 #include <spa/buffer/buffer.h>
150 #include <spa/param/param.h>
151
152 #include <pipewire/remote.h>
153
155 enum pw_stream_state {
156 PW_STREAM_STATE_ERROR = -1,
157 PW_STREAM_STATE_UNCONNECTED = 0,
158 PW_STREAM_STATE_CONNECTING = 1,
159 PW_STREAM_STATE_CONFIGURE = 2,
160 PW_STREAM_STATE_READY = 3,
161 PW_STREAM_STATE_PAUSED = 4,
163 PW_STREAM_STATE_STREAMING = 5
164 };
165
166 struct pw_buffer {
167 struct spa_buffer *buffer; /* the spa buffer */
168 void *user_data; /* user data attached to the buffer */
169 uint64_t size; /* For input streams, this field is set by pw_stream
170 with the duration of the buffer in ticks.
171 For output streams, this field is set by the user.
172 This field is added for all queued buffers and
173 returned in the time info. */
174 };
175
177 struct pw_stream_events {
178 #define PW_VERSION_STREAM_EVENTS 0
179 uint32_t version;
180
181 void (*destroy) (void *data);
183 void (*state_changed) (void *data, enum pw_stream_state old,
184 enum pw_stream_state state, const char *error);
188 void (*format_changed) (void *data, const struct spa_pod *format);
189
191 void (*add_buffer) (void *data, struct pw_buffer *buffer);
193 void (*remove_buffer) (void *data, struct pw_buffer *buffer);
194
199 void (*process) (void *data);
200 };
201
203 const char * pw_stream_state_as_string(enum pw_stream_state state);
204
206 enum pw_stream_flags {
207 PW_STREAM_FLAG_NONE = 0,
208 PW_STREAM_FLAG_AUTOCONNECT = (1 << 0),
210 PW_STREAM_FLAG_INACTIVE = (1 << 1),
211 PW_STREAM_FLAG_MAP_BUFFERS = (1 << 2),
212 PW_STREAM_FLAG_DRIVER = (1 << 3),
213 PW_STREAM_FLAG_RT_PROCESS = (1 << 4),
215 PW_STREAM_FLAG_NO_CONVERT = (1 << 5),
216 PW_STREAM_FLAG_EXCLUSIVE = (1 << 6),
218 };
219
222 struct pw_stream *
223 pw_stream_new(struct pw_remote *remote,
224 const char *name,
225 struct pw_properties *props );
226
227 struct pw_stream *
228 pw_stream_new_simple(struct pw_loop *loop,
229 const char *name,
230 struct pw_properties *props,
231 const struct pw_stream_events *events,
232 void *data );
233
235 void pw_stream_destroy(struct pw_stream *stream);
236
237 void pw_stream_add_listener(struct pw_stream *stream,
238 struct spa_hook *listener,
239 const struct pw_stream_events *events,
240 void *data);
241
242 enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error);
243
244 const char *pw_stream_get_name(struct pw_stream *stream);
245
246 struct pw_remote *pw_stream_get_remote(struct pw_stream *stream);
247
249 #define PW_STREAM_PROP_IS_LIVE "pipewire.latency.is-live"
250
251 #define PW_STREAM_PROP_LATENCY_MIN "pipewire.latency.min"
252
253 #define PW_STREAM_PROP_LATENCY_MAX "pipewire.latency.max"
254
255 const struct pw_properties *pw_stream_get_properties(struct pw_stream *stream);
256
262 int
263 pw_stream_connect(struct pw_stream *stream,
264 enum pw_direction direction,
265 const char *port_path,
267 enum pw_stream_flags flags,
268 const struct spa_pod **params,
271 uint32_t n_params );
272
275 uint32_t
276 pw_stream_get_node_id(struct pw_stream *stream);
277
279 int pw_stream_disconnect(struct pw_stream *stream);
280
287 void
288 pw_stream_finish_format(struct pw_stream *stream,
289 int res,
290 const struct spa_pod **params,
293 uint32_t n_params );
294
295
297 #define PW_STREAM_CONTROL_VOLUME "volume"
298
300 #define PW_STREAM_CONTROL_CONTRAST "contrast"
301 #define PW_STREAM_CONTROL_BRIGHTNESS "brightness"
302 #define PW_STREAM_CONTROL_HUE "hue"
303 #define PW_STREAM_CONTROL_SATURATION "saturation"
304
306 int pw_stream_set_control(struct pw_stream *stream, const char *name, float value);
308 int pw_stream_get_control(struct pw_stream *stream, const char *name, float *value);
309
311 int pw_stream_set_active(struct pw_stream *stream, bool active);
312
314 struct pw_time {
315 int64_t now;
316 struct spa_fraction rate;
317 uint64_t ticks;
319 uint64_t delay;
322 uint64_t queued;
325 };
326
328 int pw_stream_get_time(struct pw_stream *stream, struct pw_time *time);
329
332 struct pw_buffer *pw_stream_dequeue_buffer(struct pw_stream *stream);
333
335 int pw_stream_queue_buffer(struct pw_stream *stream, struct pw_buffer *buffer);
336
337
338 #ifdef __cplusplus
339 }
340 #endif
341
342 #endif /* __PIPEWIRE_STREAM_H__ */
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:1398
pw_time::delay
uint64_t delay
delay to device, add to ticks for INPUT streams and subtract from ticks for OUTPUT streams to get the...
Definition: stream.h:319
pw_time::ticks
uint64_t ticks
the ticks at now.
Definition: stream.h:317
pw_properties
A collection of key/value pairs.
Definition: properties.h:38
pw_stream_set_control
int pw_stream_set_control(struct pw_stream *stream, const char *name, float value)
Set a control value.
Definition: stream.c:1374
pw_stream::pw_stream_connect
int pw_stream_connect(struct pw_stream *stream, enum pw_direction direction, const char *port_path, 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:1250
PW_STREAM_FLAG_EXCLUSIVE
require exclusive access to the device
Definition: stream.h:216
PW_STREAM_STATE_PAUSED
paused, fully configured but not processing data yet
Definition: stream.h:161
pw_stream_events::format_changed
void(* format_changed)(void *data, const struct spa_pod *format)
when the format changed.
Definition: stream.h:188
PW_STREAM_FLAG_AUTOCONNECT
try to automatically connect this stream
Definition: stream.h:208
pw_stream::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:351
pw_time::now
int64_t now
the monotonic time
Definition: stream.h:315
pw_loop
PipeWire loop object provides an implementation of the spa loop interfaces.
Definition: loop.h:37
pw_time
A time structure.
Definition: stream.h:314
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:191
pw_stream_events
Events for a stream.
Definition: stream.h:177
pw_stream_get_control
int pw_stream_get_control(struct pw_stream *stream, const char *name, float *value)
Get a control value.
Definition: stream.c:1379
pw_stream_state
pw_stream_state
The state of a stream.
Definition: stream.h:155
PW_STREAM_FLAG_MAP_BUFFERS
mmap the buffers
Definition: stream.h:211
pw_time::rate
struct spa_fraction rate
the rate of ticks
Definition: stream.h:316
PW_STREAM_STATE_READY
stream is ready
Definition: stream.h:160
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:322
pw_stream::pw_stream_new
struct pw_stream * pw_stream_new(struct pw_remote *remote, const char *name, struct pw_properties *props)
Create a new unconneced pw_stream.
Definition: stream.c:372
pw_stream::pw_stream_disconnect
int pw_stream_disconnect(struct pw_stream *stream)
Disconnect stream.
Definition: stream.c:1326
PW_STREAM_STATE_STREAMING
streaming
Definition: stream.h:163
pw_stream
PipeWire stream object class.
pw_stream::pw_stream_destroy
void pw_stream_destroy(struct pw_stream *stream)
Destroy a stream.
Definition: stream.c:528
pw_stream_get_state
enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error)
Definition: stream.c:432
PW_STREAM_FLAG_NO_CONVERT
don&#39;t convert format
Definition: stream.h:215
pw_stream::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:1296
PW_STREAM_FLAG_DRIVER
be a driver
Definition: stream.h:212
PW_STREAM_STATE_ERROR
the strean is in error
Definition: stream.h:156
pw_remote
Represents a connection with a remote PipeWire instance.
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:426
pw_stream_events::destroy
void(* destroy)(void *data)
Definition: stream.h:181
pw_stream::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:1355
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:1384
pw_buffer::size
uint64_t size
Definition: stream.h:169
PW_STREAM_FLAG_INACTIVE
start the stream inactive
Definition: stream.h:210
pw_stream_get_name
const char * pw_stream_get_name(struct pw_stream *stream)
Definition: stream.c:439
pw_stream_get_properties
const struct pw_properties * pw_stream_get_properties(struct pw_stream *stream)
Definition: stream.c:444
pw_stream_flags
pw_stream_flags
Extra flags that can be used in pw_stream_connect()
Definition: stream.h:206
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:449
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:183
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:193
PW_STREAM_FLAG_RT_PROCESS
call process from the realtime thread
Definition: stream.h:213
pw_buffer::buffer
struct spa_buffer * buffer
Definition: stream.h:167
pw_stream::pw_stream_finish_format
void pw_stream_finish_format(struct pw_stream *stream, int res, const struct spa_pod **params, uint32_t n_params)
Complete the negotiation process with result code res.
Definition: stream.c:1302
pw_stream::pw_stream_set_active
int pw_stream_set_active(struct pw_stream *stream, bool active)
Activate or deactivate the stream.
Definition: stream.c:1343
remote.h
PW_STREAM_STATE_CONNECTING
connection is in progress
Definition: stream.h:158
pw_buffer
Definition: stream.h:166
pw_stream_get_remote
struct pw_remote * pw_stream_get_remote(struct pw_stream *stream)
Definition: stream.c:1290
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:199
pw_stream_events::version
uint32_t version
Definition: stream.h:179
PW_STREAM_STATE_UNCONNECTED
unconnected
Definition: stream.h:157
PW_STREAM_STATE_CONFIGURE
stream is being configured
Definition: stream.h:159
pw_buffer::user_data
void * user_data
Definition: stream.h:168
PW_STREAM_FLAG_NONE
no flags
Definition: stream.h:207
pw_direction
pw_direction
The direction of a port.
Definition: introspect.h:47