source: roaraudio/include/libroar/vs.h @ 5025:35982a4396fb

Last change on this file since 5025:35982a4396fb was 5025:35982a4396fb, checked in by phi, 11 years ago

prepare VS API for SYNC streams (FILTER), adding a flag for defaulting to PAUSE.

File size: 12.7 KB
Line 
1//vs.h:
2
3/*
4 *      Copyright (C) Philipp 'ph3-der-loewe' Schafft - 2010-2011
5 *
6 *  This file is part of libroar a part of RoarAudio,
7 *  a cross-platform sound system for both, home and professional use.
8 *  See README for details.
9 *
10 *  This file is free software; you can redistribute it and/or modify
11 *  it under the terms of the GNU General Public License version 3
12 *  as published by the Free Software Foundation.
13 *
14 *  libroar is distributed in the hope that it will be useful,
15 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
16 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 *  GNU General Public License for more details.
18 *
19 *  You should have received a copy of the GNU General Public License
20 *  along with this software; see the file COPYING.  If not, write to
21 *  the Free Software Foundation, 51 Franklin Street, Fifth Floor,
22 *  Boston, MA 02110-1301, USA.
23 *
24 *  NOTE for everyone want's to change something and send patches:
25 *  read README and HACKING! There a addition information on
26 *  the license of this document you need to read before you send
27 *  any patches.
28 *
29 *  NOTE for uses of non-GPL (LGPL,...) software using libesd, libartsc
30 *  or libpulse*:
31 *  The libs libroaresd, libroararts and libroarpulse link this lib
32 *  and are therefore GPL. Because of this it may be illegal to use
33 *  them with any software that uses libesd, libartsc or libpulse*.
34 */
35
36#ifndef _LIBROARVS_H_
37#define _LIBROARVS_H_
38
39#include "libroar.h"
40
41struct roar_vs;
42
43typedef struct roar_vs roar_vs_t;
44typedef signed long int roar_mus_t;
45
46/* return readable string describing the problem */
47const char * roar_vs_strerr(int error);
48
49/* create a new VS object from normal RoarAudio connection object
50 * The connection must not be closed caller before roar_vs_close() is called.
51 * The connection is not closed by roar_vs_close().
52 */
53roar_vs_t * roar_vs_new_from_con(struct roar_connection * con, int * error);
54
55/* create a new VS object with a new connection */
56roar_vs_t * roar_vs_new(const char * server, const char * name, int * error);
57
58/* start a the stream in the VS object */
59int roar_vs_stream(roar_vs_t * vss, const struct roar_audio_info * info, int dir, int * error);
60
61/* connect to server and start stream in once
62 * this is basically roar_vs_new() and roar_vs_stream() in one function.
63 */
64roar_vs_t * roar_vs_new_simple(const char * server, const char * name, int rate, int channels, int codec, int bits, int dir, int * error);
65
66/* create a VS object for playback.
67 * This is roar_vs_new_simple() with direction set to 'playback' (wave form data)
68 */
69#define roar_vs_new_playback(s,n,r,c,e,b,error) roar_vs_new_simple((s), (n), (r), (c), (e), (b), ROAR_DIR_PLAY, (error))
70
71
72/* Attach a open file.
73 */
74
75int roar_vs_file(roar_vs_t * vss, struct roar_vio_calls * vio, int closefile, int * error);
76
77/* Open a file and attach it.
78 */
79int roar_vs_file_simple(roar_vs_t * vss, char * filename, int * error);
80
81/* Connects to a server to just play a file.
82 */
83roar_vs_t * roar_vs_new_from_file(const char * server, const char * name, char * filename, int * error);
84
85/* Switch to buffered mode.
86 * After swiching to buffered mode you can use the buffered
87 * mode functions. You must use roar_vs_iterate() to send data
88 * from local buffer to server.
89 * This is currently not thread safe but you may implement it in
90 * diffrent thread if you do the locking yourself.
91 * Takes the size for the used buffers as argument.
92 * Buffer size should be a value of 2^n. Typical values are 2048 and 4096.
93 */
94int roar_vs_buffer(roar_vs_t * vss, size_t buffer, int * error);
95
96
97/* Boolean TRUE for VS functions */
98#define ROAR_VS_TRUE     1
99/* Boolean FALSE for VS functions */
100#define ROAR_VS_FALSE    0
101/* Boolean TOGGLE for VS functions */
102#define ROAR_VS_TOGGLE  -1
103/* Boolean value used to ask for a value, do not change the value only ask for current value */
104#define ROAR_VS_ASK     -2
105
106/* close and free the VS object
107 * This does all needed cleanup.
108 * If server connection was made by VS it is closed, too.
109 * If server connection was provided by caller it is untouched.
110 */
111int roar_vs_close(roar_vs_t * vss, int killit, int * error);
112
113/* write data to a stream
114 * This function writes some data to the stream.
115 * return is number of bytes written or -1 on error.
116 * return value can be zero to indicate no data can be written but no error.
117 * this may be the case with non-blocking streams.
118 * returned value can be less then requested value. indicates a short write.
119 * you should wait some (short!) time (for example one main loop iteration) and try again.
120 */
121ssize_t roar_vs_write(roar_vs_t * vss, const void * buf, size_t len, int * error);
122
123/* read data from a stream
124 * This function reads some data from the stream.
125 * return is number of bytes read or -1 on error.
126 * return value can be zero to indicate no data can be read but no error.
127 * this may be the case with non-blocking streams.
128 * returned value can be less then requested value. indicates a short read.
129 * you should wait some (short!) time (for example one main loop iteration) and try again.
130 */
131ssize_t roar_vs_read (roar_vs_t * vss,       void * buf, size_t len, int * error);
132
133/* wait value for waiting */
134#define ROAR_VS_WAIT   1
135/* wait value for no waiting */
136#define ROAR_VS_NOWAIT 0
137
138/* sync a stream with the server (flush buffers)
139 * Returns 0 on no error and -1 on error.
140 */
141int     roar_vs_sync (roar_vs_t * vss, int wait, int * error);
142
143/* set blocking mode of stream
144 * returns old blocking state
145 */
146int     roar_vs_blocking (roar_vs_t * vss, int val, int * error);
147
148/* do not supply backend offset */
149#define ROAR_VS_BACKEND_NONE    -1
150/* use first found primary stream of same mixer as offset source */
151#define ROAR_VS_BACKEND_FIRST   -2
152/* use mean of primary streams of same mixer as offset source */
153#define ROAR_VS_BACKEND_MEAN    -3
154/* default backend, now handled at runtime, old value was hard coded to _FIRST */
155#define ROAR_VS_BACKEND_DEFAULT -4
156
157/* get server's position of stream
158 * returns server's position of the stream or -1 on error.
159 * The returned server position is the position in samples
160 * plus a offset provided by the selected backend
161 */
162ssize_t roar_vs_position(roar_vs_t * vss, int backend, int * error);
163
164/* get latency between playback and local write counter
165 * This function may fail because the used codec uses
166 * non-fixed bitrate.
167 * if this function fails it returns zero and sets error or
168 * clear error to ROAR_ERROR_NONE.
169 * If non-zero is returned error is untouched.
170 * return value is in mu-sec (units of 10^-6s).
171 * Note that the returned value may be negative (the server being
172 * ahead of us). This is normal in case we read a stream.
173 */
174roar_mus_t roar_vs_latency(roar_vs_t * vss, int backend, int * error);
175
176/* set pause flag
177 * The pause flag should be set whenever the user presses the pause button or similar.
178 * The stream may be come blocking after the pause flag has been set.
179 * returns old pause setting (useful with ROAR_VS_TOGGLE)
180 */
181int     roar_vs_pause(roar_vs_t * vss, int val, int * error);
182
183/* set the mute flag of the stream
184 * The pause flag should be set whenever the user mutes the stream in some way.
185 * This flag is used so the volume is not changed and can be restored by the server
186 * while unmuting.
187 * It is very recommended to use this flag and not just set the volume to zero
188 * returns old mute setting (useful with ROAR_VS_TOGGLE)
189 */
190int     roar_vs_mute (roar_vs_t * vss, int val, int * error);
191
192/* set volume of stream (all channels to the same value)
193 * volume c is float from 0 ('muted', see above) to 1 (full volume).
194 * Returns 0 on no error and -1 on error.
195 */
196int     roar_vs_volume_mono   (roar_vs_t * vss, float c, int * error);
197/* set volume of stream (like volume + balance, stereo mode)
198 * volume l and r are floats from 0 ('muted', see above) to 1 (full volume).
199 * Returns 0 on no error and -1 on error.
200 */
201int     roar_vs_volume_stereo (roar_vs_t * vss, float l, float r, int * error);
202
203/* get volume from stream (like volume + balance, stereo mode)
204 * volume pointers l and r are floats from 0 ('muted', see above) to 1 (full volume).
205 * Returns 0 on no error and -1 on error.
206 * NOTE: if you want a 'mono' volume (like roar_vs_volume_mono() takes)
207 * you can just use: c = (*l + *r)/2
208 */
209int     roar_vs_volume_get    (roar_vs_t * vss, float * l, float * r, int * error);
210
211/* set an array of meta data for the stream
212 * This sets an array of meta data stored in kv of length len for
213 * the stream.
214 * This should be called before streaming is started using read or write functions
215 * but may be called at any time (for example to updata meta data).
216 * Returns 0 on no error and -1 on error.
217 * Example:
218 * struct roar_keyval kv = {.key = "TITLE", .value = "Some artist"};
219 * ret = roar_vs_meta(vss, &kv, 1, &err);
220 */
221int     roar_vs_meta          (roar_vs_t * vss, struct roar_keyval * kv, size_t len, int * error);
222
223/* sets the stream role
224 * see ../roaraudio/stream.h for possible roles
225 * Returns 0 on no error and -1 on error.
226 */
227int     roar_vs_role          (roar_vs_t * vss, int role, int * error);
228
229/* Run a single iteration.
230 * This will try to read data from source, write it to the stream
231 * and flush the buffer in buffered mode.
232 * Returns -1 on error, 0 on EOF and positive true value on no error.
233 */
234int     roar_vs_iterate       (roar_vs_t * vss, int wait, int * error);
235
236/* Iterate until EOF or error.
237 * Very simple main loop.
238 * Returns 0 on no error and -1 on error.
239 */
240int     roar_vs_run           (roar_vs_t * vss, int * error);
241
242ssize_t roar_vs_get_avail_read(roar_vs_t * vss, int * error);
243ssize_t roar_vs_get_avail_write(roar_vs_t * vss, int * error);
244
245/* If in buffered mode drop all data from internal buffer.
246 * This drops all data in current ringbuffers. You can
247 * select if data is only droped in write or read buffer.
248 * This may be usefull in case of seeking and such
249 * but should be avoided as it may break the bitstream.
250 */
251int     roar_vs_reset_buffer(roar_vs_t * vss, int writering, int readring, int * error);
252
253/* Misc controls.
254 * Use of this should be avoided by application.
255 */
256
257enum roar_vs_ctlcmd {
258 ROAR_VS_CMD_NOOP      = 0,
259#define ROAR_VS_CMD_NOOP ROAR_VS_CMD_NOOP
260 ROAR_VS_CMD_SET_MIXER,
261#define ROAR_VS_CMD_SET_MIXER ROAR_VS_CMD_SET_MIXER
262 ROAR_VS_CMD_GET_MIXER,
263#define ROAR_VS_CMD_GET_MIXER ROAR_VS_CMD_GET_MIXER
264 ROAR_VS_CMD_SET_FIRST_PRIM,
265#define ROAR_VS_CMD_SET_FIRST_PRIM ROAR_VS_CMD_SET_FIRST_PRIM
266 ROAR_VS_CMD_GET_FIRST_PRIM,
267#define ROAR_VS_CMD_GET_FIRST_PRIM ROAR_VS_CMD_GET_FIRST_PRIM
268
269 // Latency control:
270 ROAR_VS_CMD_SET_LATC_P,
271#define ROAR_VS_CMD_SET_LATC_P ROAR_VS_CMD_SET_LATC_P
272 ROAR_VS_CMD_GET_LATC_P,
273#define ROAR_VS_CMD_GET_LATC_P ROAR_VS_CMD_GET_LATC_P
274 ROAR_VS_CMD_SET_LATC_TARGET,
275#define ROAR_VS_CMD_SET_LATC_TARGET ROAR_VS_CMD_SET_LATC_TARGET
276 ROAR_VS_CMD_GET_LATC_TARGET,
277#define ROAR_VS_CMD_GET_LATC_TARGET ROAR_VS_CMD_GET_LATC_TARGET
278 ROAR_VS_CMD_SET_LATC_WINDOW,
279#define ROAR_VS_CMD_SET_LATC_WINDOW ROAR_VS_CMD_SET_LATC_WINDOW
280 ROAR_VS_CMD_GET_LATC_WINDOW,
281#define ROAR_VS_CMD_GET_LATC_WINDOW ROAR_VS_CMD_GET_LATC_WINDOW
282 ROAR_VS_CMD_SET_LATC_MINLAG,
283#define ROAR_VS_CMD_SET_LATC_MINLAG ROAR_VS_CMD_SET_LATC_MINLAG
284 ROAR_VS_CMD_GET_LATC_MINLAG,
285#define ROAR_VS_CMD_GET_LATC_MINLAG ROAR_VS_CMD_GET_LATC_MINLAG
286
287 // Volume:
288 ROAR_VS_CMD_SET_FREE_VOLUME,
289#define ROAR_VS_CMD_SET_FREE_VOLUME ROAR_VS_CMD_SET_FREE_VOLUME
290 ROAR_VS_CMD_GET_FREE_VOLUME,
291#define ROAR_VS_CMD_GET_FREE_VOLUME ROAR_VS_CMD_GET_FREE_VOLUME
292
293 // auto pause flag, needed for sync streams:
294 ROAR_VS_CMD_SET_DEFAULT_PAUSED,
295#define ROAR_VS_CMD_SET_DEFAULT_PAUSED ROAR_VS_CMD_SET_DEFAULT_PAUSED
296 ROAR_VS_CMD_GET_DEFAULT_PAUSED,
297#define ROAR_VS_CMD_GET_DEFAULT_PAUSED ROAR_VS_CMD_GET_DEFAULT_PAUSED
298};
299
300typedef enum roar_vs_ctlcmd roar_vs_ctlcmd;
301
302int     roar_vs_ctl           (roar_vs_t * vss, roar_vs_ctlcmd cmd, void * argp, int * error);
303
304
305/* Get used connection object
306 * This may be useful if you want to use functions from the main API.
307 * Returns used connection object or NULL on error.
308 */
309struct roar_connection * roar_vs_connection_obj(roar_vs_t * vss, int * error);
310
311/* Get used stream object
312 * This may be useful if you want to use functions from the main API.
313 * Returns used stream object or NULL on error.
314 */
315struct roar_stream     * roar_vs_stream_obj    (roar_vs_t * vss, int * error);
316
317/* Get used VIO object
318 * This may be useful if you want to use functions from the main API.
319 * For example this can be used in non-blocking mode
320 * to test if we can read or write. To test that use roar_vio_select().
321 * Returns used VIO object or NULL on error.
322 */
323struct roar_vio_calls  * roar_vs_vio_obj       (roar_vs_t * vss, int * error);
324
325/* send NOOP command to server
326 * This can be used to ping the server.
327 * This is of no use normally.
328 * Returns 0 on no error and -1 on error.
329 */
330#define roar_vs_noop(v, error) roar_noop(roar_vs_connection_obj((v), (error)))
331
332#endif
333
334//ll
Note: See TracBrowser for help on using the repository browser.