PipeWire  0.1.5.1
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 
163 struct pw_stream;
164 
165 #include <spa/buffer.h>
166 #include <spa/format.h>
167 
168 #include <pipewire/remote.h>
169 
180 };
181 
184 #define PW_VERSION_STREAM_EVENTS 0
185  uint32_t version;
186 
187  void (*destroy) (void *data);
189  void (*state_changed) (void *data, enum pw_stream_state old,
190  enum pw_stream_state state, const char *error);
194  void (*format_changed) (void *data, struct spa_format *format);
195 
197  void (*add_buffer) (void *data, uint32_t id);
199  void (*remove_buffer) (void *data, uint32_t id);
202  void (*new_buffer) (void *data, uint32_t id);
204  void (*need_buffer) (void *data);
205 };
206 
208 const char * pw_stream_state_as_string(enum pw_stream_state state);
209 
217 };
218 
223 };
224 
226 struct pw_time {
227  int64_t now;
228  int64_t ticks;
229  int32_t rate;
230 };
231 
234 struct pw_stream *
235 pw_stream_new(struct pw_remote *remote,
236  const char *name,
237  struct pw_properties *props );
238 
240 void pw_stream_destroy(struct pw_stream *stream);
241 
242 void pw_stream_add_listener(struct pw_stream *stream,
243  struct spa_hook *listener,
244  const struct pw_stream_events *events,
245  void *data);
246 
247 enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error);
248 
249 const char *pw_stream_get_name(struct pw_stream *stream);
250 
252 #define PW_STREAM_PROP_IS_LIVE "pipewire.latency.is-live"
253 
254 #define PW_STREAM_PROP_LATENCY_MIN "pipewire.latency.min"
255 
256 #define PW_STREAM_PROP_LATENCY_MAX "pipewire.latency.max"
257 
258 const struct pw_properties *pw_stream_get_properties(struct pw_stream *stream);
259 
266 bool
267 pw_stream_connect(struct pw_stream *stream,
268  enum pw_direction direction,
269  enum pw_stream_mode mode,
270  const char *port_path,
272  enum pw_stream_flags flags,
273  uint32_t n_possible_formats,
274  const struct spa_format **possible_formats );
275 
278 uint32_t
279 pw_stream_get_node_id(struct pw_stream *stream);
280 
282 void pw_stream_disconnect(struct pw_stream *stream);
283 
290 void
291 pw_stream_finish_format(struct pw_stream *stream,
292  int res,
293  struct spa_param **params,
294  uint32_t n_params );
295 
297 bool pw_stream_get_time(struct pw_stream *stream, struct pw_time *time);
298 
302 uint32_t pw_stream_get_empty_buffer(struct pw_stream *stream);
303 
307 bool pw_stream_recycle_buffer(struct pw_stream *stream, uint32_t id);
308 
313 struct spa_buffer *
314 pw_stream_peek_buffer(struct pw_stream *stream, uint32_t id);
315 
321 bool pw_stream_send_buffer(struct pw_stream *stream, uint32_t id);
322 
323 #ifdef __cplusplus
324 }
325 #endif
326 
327 #endif /* __PIPEWIRE_STREAM_H__ */
A collection of key/value pairs.
Definition: properties.h:38
void(* format_changed)(void *data, struct spa_format *format)
when the format changed.
Definition: stream.h:194
bool pw_stream_connect(struct pw_stream *stream, enum pw_direction direction, enum pw_stream_mode mode, const char *port_path, enum pw_stream_flags flags, uint32_t n_possible_formats, const struct spa_format **possible_formats)
Definition: stream.c:934
paused, fully configured but not processing data yet
Definition: stream.h:177
try to automatically connect this stream
Definition: stream.h:213
int64_t now
the monotonic time
Definition: stream.h:227
A time structure.
Definition: stream.h:226
void(* new_buffer)(void *data, uint32_t id)
when a buffer can be reused (for playback streams) or is filled (for capture streams ...
Definition: stream.h:202
uint32_t pw_stream_get_node_id(struct pw_stream *stream)
Definition: stream.c:977
uint32_t pw_stream_get_empty_buffer(struct pw_stream *stream)
Definition: stream.c:1040
Events for a stream.
Definition: stream.h:183
pw_stream_state
The state of a stream.
Definition: stream.h:171
int64_t ticks
the ticks at now
Definition: stream.h:228
bool pw_stream_get_time(struct pw_stream *stream, struct pw_time *time)
Definition: stream.c:1024
stream is ready
Definition: stream.h:176
void pw_stream_destroy(struct pw_stream *stream)
Definition: stream.c:341
streaming
Definition: stream.h:179
PipeWire stream object class.
pw_stream_mode
The method for transfering data for a stream.
Definition: stream.h:220
enum pw_stream_state pw_stream_get_state(struct pw_stream *stream, const char **error)
Definition: stream.c:246
the strean is in error
Definition: stream.h:172
data is placed in buffers
Definition: stream.h:221
struct pw_stream * pw_stream_new(struct pw_remote *remote, const char *name, struct pw_properties *props)
Definition: stream.c:198
Represents a connection with a remote PipeWire instance.
void(* destroy)(void *data)
Definition: stream.h:187
a ringbuffer is used to exchange data
Definition: stream.h:222
bool pw_stream_send_buffer(struct pw_stream *stream, uint32_t id)
Definition: stream.c:1083
const char * pw_stream_get_name(struct pw_stream *stream)
Definition: stream.c:253
const struct pw_properties * pw_stream_get_properties(struct pw_stream *stream)
Definition: stream.c:258
pw_stream_flags
Extra flags that can be used in pw_stream_connect()
Definition: stream.h:211
void pw_stream_add_listener(struct pw_stream *stream, struct spa_hook *listener, const struct pw_stream_events *events, void *data)
Definition: stream.c:263
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:189
void(* need_buffer)(void *data)
when a buffer is needed (for playback streams)
Definition: stream.h:204
void pw_stream_finish_format(struct pw_stream *stream, int res, struct spa_param **params, uint32_t n_params)
Definition: stream.c:983
void(* remove_buffer)(void *data, uint32_t id)
when a buffer was destroyed for this stream
Definition: stream.h:199
void(* add_buffer)(void *data, uint32_t id)
when a new buffer was created for this stream
Definition: stream.h:197
connection is in progress
Definition: stream.h:174
request periodic clock updates for this stream
Definition: stream.h:215
struct spa_buffer * pw_stream_peek_buffer(struct pw_stream *stream, uint32_t id)
Definition: stream.c:1073
const char * pw_stream_state_as_string(enum pw_stream_state state)
Definition: stream.c:177
uint32_t version
Definition: stream.h:185
int32_t rate
the rate of ticks
Definition: stream.h:229
unconnected
Definition: stream.h:173
bool pw_stream_recycle_buffer(struct pw_stream *stream, uint32_t id)
Definition: stream.c:1053
stream is being configured
Definition: stream.h:175
no flags
Definition: stream.h:212
pw_direction
The direction of a port.
Definition: introspect.h:47
void pw_stream_disconnect(struct pw_stream *stream)
Definition: stream.c:1006