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 | |
---|
41 | #define _LIBROAR_VS_STDATTRS _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL(1) |
---|
42 | |
---|
43 | struct roar_vs; |
---|
44 | |
---|
45 | typedef struct roar_vs roar_vs_t; |
---|
46 | typedef signed long int roar_mus_t; |
---|
47 | |
---|
48 | /* return readable string describing the problem */ |
---|
49 | const char * roar_vs_strerr(int error) _LIBROAR_ATTR_PURE _LIBROAR_ATTR_USE_RESULT; |
---|
50 | |
---|
51 | /* create a new VS object from normal RoarAudio connection object |
---|
52 | * The connection must not be closed caller before roar_vs_close() is called. |
---|
53 | * The connection is not closed by roar_vs_close(). |
---|
54 | */ |
---|
55 | roar_vs_t * roar_vs_new_from_con(struct roar_connection * con, int * error) _LIBROAR_VS_STDATTRS; |
---|
56 | |
---|
57 | /* create a new VS object with a new connection */ |
---|
58 | roar_vs_t * roar_vs_new(const char * server, const char * name, int * error) _LIBROAR_ATTR_USE_RESULT; |
---|
59 | |
---|
60 | /* start a the stream in the VS object */ |
---|
61 | int roar_vs_stream(roar_vs_t * vss, const struct roar_audio_info * info, int dir, int * error) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL(1, 2); |
---|
62 | |
---|
63 | /* connect to server and start stream in once |
---|
64 | * this is basically roar_vs_new() and roar_vs_stream() in one function. |
---|
65 | */ |
---|
66 | roar_vs_t * roar_vs_new_simple(const char * server, const char * name, int rate, int channels, int codec, int bits, int dir, int * error) _LIBROAR_ATTR_USE_RESULT; |
---|
67 | |
---|
68 | /* create a VS object for playback. |
---|
69 | * This is roar_vs_new_simple() with direction set to 'playback' (wave form data) |
---|
70 | */ |
---|
71 | #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)) |
---|
72 | |
---|
73 | |
---|
74 | /* Attach a open file. |
---|
75 | */ |
---|
76 | |
---|
77 | int roar_vs_file(roar_vs_t * vss, struct roar_vio_calls * vio, int closefile, int * error) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL(1, 2); |
---|
78 | |
---|
79 | /* Open a file and attach it. |
---|
80 | */ |
---|
81 | int roar_vs_file_simple(roar_vs_t * vss, char * filename, int * error) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL(1, 2); |
---|
82 | |
---|
83 | /* Connects to a server to just play a file. |
---|
84 | */ |
---|
85 | roar_vs_t * roar_vs_new_from_file(const char * server, const char * name, char * filename, int * error) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL(3); |
---|
86 | |
---|
87 | /* Switch to buffered mode. |
---|
88 | * After swiching to buffered mode you can use the buffered |
---|
89 | * mode functions. You must use roar_vs_iterate() to send data |
---|
90 | * from local buffer to server. |
---|
91 | * This is currently not thread safe but you may implement it in |
---|
92 | * diffrent thread if you do the locking yourself. |
---|
93 | * Takes the size for the used buffers as argument. |
---|
94 | * Buffer size should be a value of 2^n. Typical values are 2048 and 4096. |
---|
95 | */ |
---|
96 | int roar_vs_buffer(roar_vs_t * vss, size_t buffer, int * error) _LIBROAR_VS_STDATTRS; |
---|
97 | |
---|
98 | |
---|
99 | /* Boolean TRUE for VS functions */ |
---|
100 | #define ROAR_VS_TRUE 1 |
---|
101 | /* Boolean FALSE for VS functions */ |
---|
102 | #define ROAR_VS_FALSE 0 |
---|
103 | /* Boolean TOGGLE for VS functions */ |
---|
104 | #define ROAR_VS_TOGGLE -1 |
---|
105 | /* Boolean value used to ask for a value, do not change the value only ask for current value */ |
---|
106 | #define ROAR_VS_ASK -2 |
---|
107 | |
---|
108 | /* close and free the VS object |
---|
109 | * This does all needed cleanup. |
---|
110 | * If server connection was made by VS it is closed, too. |
---|
111 | * If server connection was provided by caller it is untouched. |
---|
112 | */ |
---|
113 | int roar_vs_close(roar_vs_t * vss, int killit, int * error) _LIBROAR_ATTR_NONNULL(1); |
---|
114 | |
---|
115 | /* write data to a stream |
---|
116 | * This function writes some data to the stream. |
---|
117 | * return is number of bytes written or -1 on error. |
---|
118 | * return value can be zero to indicate no data can be written but no error. |
---|
119 | * this may be the case with non-blocking streams. |
---|
120 | * returned value can be less then requested value. indicates a short write. |
---|
121 | * you should wait some (short!) time (for example one main loop iteration) and try again. |
---|
122 | */ |
---|
123 | ssize_t roar_vs_write(roar_vs_t * vss, const void * buf, size_t len, int * error) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL(1, 2); |
---|
124 | |
---|
125 | /* read data from a stream |
---|
126 | * This function reads some data from the stream. |
---|
127 | * return is number of bytes read or -1 on error. |
---|
128 | * return value can be zero to indicate no data can be read but no error. |
---|
129 | * this may be the case with non-blocking streams. |
---|
130 | * returned value can be less then requested value. indicates a short read. |
---|
131 | * you should wait some (short!) time (for example one main loop iteration) and try again. |
---|
132 | */ |
---|
133 | ssize_t roar_vs_read (roar_vs_t * vss, void * buf, size_t len, int * error) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL(1, 2); |
---|
134 | |
---|
135 | /* wait value for waiting */ |
---|
136 | #define ROAR_VS_WAIT 1 |
---|
137 | /* wait value for no waiting */ |
---|
138 | #define ROAR_VS_NOWAIT 0 |
---|
139 | /* Trigger action but do not wait for it to complet */ |
---|
140 | #define ROAR_VS_ASYNC -1 |
---|
141 | |
---|
142 | /* sync a stream with the server (flush buffers) |
---|
143 | * Returns 0 on no error and -1 on error. |
---|
144 | */ |
---|
145 | int roar_vs_sync (roar_vs_t * vss, int wait, int * error) _LIBROAR_ATTR_NONNULL(1); |
---|
146 | |
---|
147 | /* set blocking mode of stream |
---|
148 | * returns old blocking state |
---|
149 | */ |
---|
150 | int roar_vs_blocking (roar_vs_t * vss, int val, int * error) _LIBROAR_VS_STDATTRS; |
---|
151 | |
---|
152 | /* do not supply backend offset */ |
---|
153 | #define ROAR_VS_BACKEND_NONE -1 |
---|
154 | /* use first found primary stream of same mixer as offset source */ |
---|
155 | #define ROAR_VS_BACKEND_FIRST -2 |
---|
156 | /* use mean of primary streams of same mixer as offset source */ |
---|
157 | #define ROAR_VS_BACKEND_MEAN -3 |
---|
158 | /* default backend, now handled at runtime, old value was hard coded to _FIRST */ |
---|
159 | #define ROAR_VS_BACKEND_DEFAULT -4 |
---|
160 | |
---|
161 | /* get server's position of stream |
---|
162 | * returns server's position of the stream or -1 on error. |
---|
163 | * The returned server position is the position in samples |
---|
164 | * plus a offset provided by the selected backend |
---|
165 | */ |
---|
166 | ssize_t roar_vs_position(roar_vs_t * vss, int backend, int * error) _LIBROAR_VS_STDATTRS; |
---|
167 | |
---|
168 | /* get latency between playback and local write counter |
---|
169 | * This function may fail because the used codec uses |
---|
170 | * non-fixed bitrate. |
---|
171 | * if this function fails it returns zero and sets error or |
---|
172 | * clear error to ROAR_ERROR_NONE. |
---|
173 | * If non-zero is returned error is untouched. |
---|
174 | * return value is in mu-sec (units of 10^-6s). |
---|
175 | * Note that the returned value may be negative (the server being |
---|
176 | * ahead of us). This is normal in case we read a stream. |
---|
177 | */ |
---|
178 | roar_mus_t roar_vs_latency(roar_vs_t * vss, int backend, int * error) _LIBROAR_VS_STDATTRS _LIBROAR_ATTR_DEPRECATED; |
---|
179 | roar_mus_t roar_vs_latency2(roar_vs_t * vss, int backend, int wait, int * error) _LIBROAR_VS_STDATTRS; |
---|
180 | |
---|
181 | /* set pause flag |
---|
182 | * The pause flag should be set whenever the user presses the pause button or similar. |
---|
183 | * The stream may be come blocking after the pause flag has been set. |
---|
184 | * returns old pause setting (useful with ROAR_VS_TOGGLE) |
---|
185 | */ |
---|
186 | int roar_vs_pause(roar_vs_t * vss, int val, int * error) _LIBROAR_ATTR_NONNULL(1); |
---|
187 | |
---|
188 | /* set the mute flag of the stream |
---|
189 | * The pause flag should be set whenever the user mutes the stream in some way. |
---|
190 | * This flag is used so the volume is not changed and can be restored by the server |
---|
191 | * while unmuting. |
---|
192 | * It is very recommended to use this flag and not just set the volume to zero |
---|
193 | * returns old mute setting (useful with ROAR_VS_TOGGLE) |
---|
194 | */ |
---|
195 | int roar_vs_mute (roar_vs_t * vss, int val, int * error) _LIBROAR_ATTR_NONNULL(1); |
---|
196 | |
---|
197 | /* set volume of stream (all channels to the same value) |
---|
198 | * volume c is float from 0 ('muted', see above) to 1 (full volume). |
---|
199 | * Returns 0 on no error and -1 on error. |
---|
200 | */ |
---|
201 | int roar_vs_volume_mono (roar_vs_t * vss, float c, int * error) _LIBROAR_ATTR_NONNULL(1); |
---|
202 | /* set volume of stream (like volume + balance, stereo mode) |
---|
203 | * volume l and r are floats from 0 ('muted', see above) to 1 (full volume). |
---|
204 | * Returns 0 on no error and -1 on error. |
---|
205 | */ |
---|
206 | int roar_vs_volume_stereo (roar_vs_t * vss, float l, float r, int * error) _LIBROAR_ATTR_NONNULL(1); |
---|
207 | |
---|
208 | /* get volume from stream (like volume + balance, stereo mode) |
---|
209 | * volume pointers l and r are floats from 0 ('muted', see above) to 1 (full volume). |
---|
210 | * Returns 0 on no error and -1 on error. |
---|
211 | * NOTE: if you want a 'mono' volume (like roar_vs_volume_mono() takes) |
---|
212 | * you can just use: c = (*l + *r)/2 |
---|
213 | */ |
---|
214 | int roar_vs_volume_get (roar_vs_t * vss, float * l, float * r, int * error) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL(1, 2, 3); |
---|
215 | |
---|
216 | /* set an array of meta data for the stream |
---|
217 | * This sets an array of meta data stored in kv of length len for |
---|
218 | * the stream. |
---|
219 | * This should be called before streaming is started using read or write functions |
---|
220 | * but may be called at any time (for example to updata meta data). |
---|
221 | * Returns 0 on no error and -1 on error. |
---|
222 | * Example: |
---|
223 | * struct roar_keyval kv = {.key = "TITLE", .value = "Some title"}; |
---|
224 | * ret = roar_vs_meta(vss, &kv, 1, &err); |
---|
225 | */ |
---|
226 | int roar_vs_meta (roar_vs_t * vss, struct roar_keyval * kv, size_t len, int * error) _LIBROAR_ATTR_NONNULL(1, 2); |
---|
227 | |
---|
228 | /* sets the stream role |
---|
229 | * see ../roaraudio/stream.h for possible roles |
---|
230 | * Returns 0 on no error and -1 on error. |
---|
231 | */ |
---|
232 | int roar_vs_role (roar_vs_t * vss, int role, int * error) _LIBROAR_ATTR_NONNULL(1); |
---|
233 | |
---|
234 | /* Run a single iteration. |
---|
235 | * This will try to read data from source, write it to the stream |
---|
236 | * and flush the buffer in buffered mode. |
---|
237 | * Returns -1 on error, 0 on EOF and positive true value on no error. |
---|
238 | */ |
---|
239 | int roar_vs_iterate (roar_vs_t * vss, int wait, int * error) _LIBROAR_ATTR_NONNULL(1); |
---|
240 | |
---|
241 | /* Iterate until EOF or error. |
---|
242 | * Very simple main loop. |
---|
243 | * Returns 0 on no error and -1 on error. |
---|
244 | */ |
---|
245 | int roar_vs_run (roar_vs_t * vss, int * error) _LIBROAR_ATTR_NONNULL(1); |
---|
246 | |
---|
247 | ssize_t roar_vs_get_avail_read(roar_vs_t * vss, int * error) _LIBROAR_VS_STDATTRS; |
---|
248 | ssize_t roar_vs_get_avail_write(roar_vs_t * vss, int * error) _LIBROAR_VS_STDATTRS; |
---|
249 | |
---|
250 | /* If in buffered mode drop all data from internal buffer. |
---|
251 | * This drops all data in current ringbuffers. You can |
---|
252 | * select if data is only droped in write or read buffer. |
---|
253 | * This may be usefull in case of seeking and such |
---|
254 | * but should be avoided as it may break the bitstream. |
---|
255 | */ |
---|
256 | int roar_vs_reset_buffer(roar_vs_t * vss, int writering, int readring, int * error) _LIBROAR_VS_STDATTRS _LIBROAR_ATTR_DEPRECATED; |
---|
257 | |
---|
258 | /* Misc controls. |
---|
259 | * Use of this should be avoided by application. |
---|
260 | */ |
---|
261 | |
---|
262 | enum roar_vs_ctlcmd { |
---|
263 | ROAR_VS_CMD_NOOP = 0, |
---|
264 | #define ROAR_VS_CMD_NOOP ROAR_VS_CMD_NOOP |
---|
265 | ROAR_VS_CMD_SET_MIXER, |
---|
266 | #define ROAR_VS_CMD_SET_MIXER ROAR_VS_CMD_SET_MIXER |
---|
267 | ROAR_VS_CMD_GET_MIXER, |
---|
268 | #define ROAR_VS_CMD_GET_MIXER ROAR_VS_CMD_GET_MIXER |
---|
269 | ROAR_VS_CMD_SET_FIRST_PRIM, |
---|
270 | #define ROAR_VS_CMD_SET_FIRST_PRIM ROAR_VS_CMD_SET_FIRST_PRIM |
---|
271 | ROAR_VS_CMD_GET_FIRST_PRIM, |
---|
272 | #define ROAR_VS_CMD_GET_FIRST_PRIM ROAR_VS_CMD_GET_FIRST_PRIM |
---|
273 | |
---|
274 | // Latency control: |
---|
275 | ROAR_VS_CMD_SET_LATC_P, |
---|
276 | #define ROAR_VS_CMD_SET_LATC_P ROAR_VS_CMD_SET_LATC_P |
---|
277 | ROAR_VS_CMD_GET_LATC_P, |
---|
278 | #define ROAR_VS_CMD_GET_LATC_P ROAR_VS_CMD_GET_LATC_P |
---|
279 | ROAR_VS_CMD_SET_LATC_TARGET, |
---|
280 | #define ROAR_VS_CMD_SET_LATC_TARGET ROAR_VS_CMD_SET_LATC_TARGET |
---|
281 | ROAR_VS_CMD_GET_LATC_TARGET, |
---|
282 | #define ROAR_VS_CMD_GET_LATC_TARGET ROAR_VS_CMD_GET_LATC_TARGET |
---|
283 | ROAR_VS_CMD_SET_LATC_WINDOW, |
---|
284 | #define ROAR_VS_CMD_SET_LATC_WINDOW ROAR_VS_CMD_SET_LATC_WINDOW |
---|
285 | ROAR_VS_CMD_GET_LATC_WINDOW, |
---|
286 | #define ROAR_VS_CMD_GET_LATC_WINDOW ROAR_VS_CMD_GET_LATC_WINDOW |
---|
287 | ROAR_VS_CMD_SET_LATC_MINLAG, |
---|
288 | #define ROAR_VS_CMD_SET_LATC_MINLAG ROAR_VS_CMD_SET_LATC_MINLAG |
---|
289 | ROAR_VS_CMD_GET_LATC_MINLAG, |
---|
290 | #define ROAR_VS_CMD_GET_LATC_MINLAG ROAR_VS_CMD_GET_LATC_MINLAG |
---|
291 | |
---|
292 | // Volume: |
---|
293 | ROAR_VS_CMD_SET_FREE_VOLUME, |
---|
294 | #define ROAR_VS_CMD_SET_FREE_VOLUME ROAR_VS_CMD_SET_FREE_VOLUME |
---|
295 | ROAR_VS_CMD_GET_FREE_VOLUME, |
---|
296 | #define ROAR_VS_CMD_GET_FREE_VOLUME ROAR_VS_CMD_GET_FREE_VOLUME |
---|
297 | |
---|
298 | // auto pause flag, needed for sync streams: |
---|
299 | ROAR_VS_CMD_SET_DEFAULT_PAUSED, |
---|
300 | #define ROAR_VS_CMD_SET_DEFAULT_PAUSED ROAR_VS_CMD_SET_DEFAULT_PAUSED |
---|
301 | ROAR_VS_CMD_GET_DEFAULT_PAUSED, |
---|
302 | #define ROAR_VS_CMD_GET_DEFAULT_PAUSED ROAR_VS_CMD_GET_DEFAULT_PAUSED |
---|
303 | |
---|
304 | // Async operation: |
---|
305 | ROAR_VS_CMD_SET_ASYNC, |
---|
306 | #define ROAR_VS_CMD_SET_ASYNC ROAR_VS_CMD_SET_ASYNC |
---|
307 | ROAR_VS_CMD_GET_ASYNC, |
---|
308 | #define ROAR_VS_CMD_GET_ASYNC ROAR_VS_CMD_GET_ASYNC |
---|
309 | ROAR_VS_CMD_LOCK_ASYNC, |
---|
310 | #define ROAR_VS_CMD_LOCK_ASYNC ROAR_VS_CMD_LOCK_ASYNC |
---|
311 | ROAR_VS_CMD_UNLOCK_ASYNC, |
---|
312 | #define ROAR_VS_CMD_UNLOCK_ASYNC ROAR_VS_CMD_UNLOCK_ASYNC |
---|
313 | }; |
---|
314 | |
---|
315 | typedef enum roar_vs_ctlcmd roar_vs_ctlcmd; |
---|
316 | |
---|
317 | #define ROAR_VS_ASYNCLEVEL_NONE 0 |
---|
318 | #define ROAR_VS_ASYNCLEVEL_ENABLE 1 |
---|
319 | #define ROAR_VS_ASYNCLEVEL_AUTO 2 |
---|
320 | |
---|
321 | int roar_vs_ctl (roar_vs_t * vss, roar_vs_ctlcmd cmd, void * argp, int * error) _LIBROAR_VS_STDATTRS; |
---|
322 | |
---|
323 | |
---|
324 | /* Get used connection object |
---|
325 | * This may be useful if you want to use functions from the main API. |
---|
326 | * Returns used connection object or NULL on error. |
---|
327 | */ |
---|
328 | struct roar_connection * roar_vs_connection_obj(roar_vs_t * vss, int * error) _LIBROAR_VS_STDATTRS; |
---|
329 | |
---|
330 | /* Get used stream object |
---|
331 | * This may be useful if you want to use functions from the main API. |
---|
332 | * Returns used stream object or NULL on error. |
---|
333 | */ |
---|
334 | struct roar_stream * roar_vs_stream_obj (roar_vs_t * vss, int * error) _LIBROAR_VS_STDATTRS; |
---|
335 | |
---|
336 | /* Get used VIO object |
---|
337 | * This may be useful if you want to use functions from the main API. |
---|
338 | * For example this can be used in non-blocking mode |
---|
339 | * to test if we can read or write. To test that use roar_vio_select(). |
---|
340 | * Returns used VIO object or NULL on error. |
---|
341 | */ |
---|
342 | struct roar_vio_calls * roar_vs_vio_obj (roar_vs_t * vss, int * error) _LIBROAR_VS_STDATTRS; |
---|
343 | |
---|
344 | /* send NOOP command to server |
---|
345 | * This can be used to ping the server. |
---|
346 | * This is of no use normally. |
---|
347 | * Returns 0 on no error and -1 on error. |
---|
348 | */ |
---|
349 | #define roar_vs_noop(v, error) roar_noop(roar_vs_connection_obj((v), (error))) |
---|
350 | |
---|
351 | #endif |
---|
352 | |
---|
353 | //ll |
---|