source: roaraudio/include/libroar/vs.h @ 4629:27acd1cc7e9c

Last change on this file since 4629:27acd1cc7e9c was 4629:27acd1cc7e9c, checked in by phi, 13 years ago

support to reset buffer

File size: 10.5 KB
Line 
1//vs.h:
2
3/*
4 *      Copyright (C) Philipp 'ph3-der-loewe' Schafft - 2010
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
85int roar_vs_buffer(roar_vs_t * vss, size_t buffer, int * error);
86
87
88/* Boolean TRUE for VS functions */
89#define ROAR_VS_TRUE     1
90/* Boolean FALSE for VS functions */
91#define ROAR_VS_FALSE    0
92/* Boolean TOGGLE for VS functions */
93#define ROAR_VS_TOGGLE  -1
94/* Boolean value used to ask for a value, do not change the value only ask for current value */
95#define ROAR_VS_ASK     -2
96
97/* close and free the VS object
98 * This does all needed cleanup.
99 * If server connection was made by VS it is closed, too.
100 * If server connection was provided by caller it is untouched.
101 */
102int roar_vs_close(roar_vs_t * vss, int killit, int * error);
103
104/* write data to a stream
105 * This function writes some data to the stream.
106 * return is number of bytes written or -1 on error.
107 * return value can be zero to indicate no data can be written but no error.
108 * this may be the case with non-blocking streams.
109 * returned value can be less then requested value. indicates a short write.
110 * you should wait some (short!) time (for example one main loop iteration) and try again.
111 */
112ssize_t roar_vs_write(roar_vs_t * vss, const void * buf, size_t len, int * error);
113
114/* read data from a stream
115 * This function reads some data from the stream.
116 * return is number of bytes read or -1 on error.
117 * return value can be zero to indicate no data can be read but no error.
118 * this may be the case with non-blocking streams.
119 * returned value can be less then requested value. indicates a short read.
120 * you should wait some (short!) time (for example one main loop iteration) and try again.
121 */
122ssize_t roar_vs_read (roar_vs_t * vss,       void * buf, size_t len, int * error);
123
124/* wait value for waiting */
125#define ROAR_VS_WAIT   1
126/* wait value for no waiting */
127#define ROAR_VS_NOWAIT 0
128
129/* sync a stream with the server (flush buffers)
130 * Returns 0 on no error and -1 on error.
131 */
132int     roar_vs_sync (roar_vs_t * vss, int wait, int * error);
133
134/* set blocking mode of stream
135 * returns old blocking state
136 */
137int     roar_vs_blocking (roar_vs_t * vss, int val, int * error);
138
139/* default backend */
140#define ROAR_VS_BACKEND_DEFAULT ROAR_VS_BACKEND_FIRST
141/* do not supply backend offset */
142#define ROAR_VS_BACKEND_NONE    -1
143/* use first found primary stream of same mixer as offset source */
144#define ROAR_VS_BACKEND_FIRST   -2
145/* use mean of primary streams of same mixer as offset source */
146#define ROAR_VS_BACKEND_MEAN    -3
147
148/* get server's position of stream
149 * returns server's position of the stream or -1 on error.
150 * The returned server position is the position in samples
151 * plus a offset provided by the selected backend
152 */
153ssize_t roar_vs_position(roar_vs_t * vss, int backend, int * error);
154
155/* get latency between playback and local write counter
156 * This function may fail because the used codec uses
157 * non-fixed bitrate.
158 * if this function fails it returns zero and sets error or
159 * clear error to ROAR_ERROR_NONE.
160 * If non-zero is returned error is untouched.
161 * return value is in mu-sec (units of 10^-6s).
162 * Note that the returned value may be negative (the server being
163 * ahead of us). This is normal in case we read a stream.
164 */
165roar_mus_t roar_vs_latency(roar_vs_t * vss, int backend, int * error);
166
167/* set pause flag
168 * The pause flag should be set whenever the user presses the pause button or similar.
169 * The stream may be come blocking after the pause flag has been set.
170 * returns old pause setting (useful with ROAR_VS_TOGGLE)
171 */
172int     roar_vs_pause(roar_vs_t * vss, int val, int * error);
173
174/* set the mute flag of the stream
175 * The pause flag should be set whenever the user mutes the stream in some way.
176 * This flag is used so the volume is not changed and can be restored by the server
177 * while unmuting.
178 * It is very recommended to use this flag and not just set the volume to zero
179 * returns old mute setting (useful with ROAR_VS_TOGGLE)
180 */
181int     roar_vs_mute (roar_vs_t * vss, int val, int * error);
182
183/* set volume of stream (all channels to the same value)
184 * volume c is float from 0 ('muted', see above) to 1 (full volume).
185 * Returns 0 on no error and -1 on error.
186 */
187int     roar_vs_volume_mono   (roar_vs_t * vss, float c, int * error);
188/* set volume of stream (like volume + balance, stereo mode)
189 * volume l and r are floats from 0 ('muted', see above) to 1 (full volume).
190 * Returns 0 on no error and -1 on error.
191 */
192int     roar_vs_volume_stereo (roar_vs_t * vss, float l, float r, int * error);
193
194/* get volume from stream (like volume + balance, stereo mode)
195 * volume pointers l and r are floats from 0 ('muted', see above) to 1 (full volume).
196 * Returns 0 on no error and -1 on error.
197 * NOTE: if you want a 'mono' volume (like roar_vs_volume_mono() takes)
198 * you can just use: c = (*l + *r)/2
199 */
200int     roar_vs_volume_get    (roar_vs_t * vss, float * l, float * r, int * error);
201
202/* set an array of meta data for the stream
203 * This sets an array of meta data stored in kv of length len for
204 * the stream.
205 * This should be called before streaming is started using read or write functions
206 * but may be called at any time (for example to updata meta data).
207 * Returns 0 on no error and -1 on error.
208 * Example:
209 * struct roar_keyval kv = {.key = "TITLE", .value = "Some artist"};
210 * ret = roar_vs_meta(vss, &kv, 1, &err);
211 */
212int     roar_vs_meta          (roar_vs_t * vss, struct roar_keyval * kv, size_t len, int * error);
213
214/* sets the stream role
215 * see ../roaraudio/stream.h for possible roles
216 * Returns 0 on no error and -1 on error.
217 */
218int     roar_vs_role          (roar_vs_t * vss, int role, int * error);
219
220/* Run a single iteration.
221 * This will try to read data from source, write it to the stream
222 * and flush the buffer in buffered mode.
223 * Returns -1 on error, 0 on EOF and positive true value on no error.
224 */
225int     roar_vs_iterate       (roar_vs_t * vss, int wait, int * error);
226
227/* Iterate until EOF or error.
228 * Very simple main loop.
229 * Returns 0 on no error and -1 on error.
230 */
231int     roar_vs_run           (roar_vs_t * vss, int * error);
232
233ssize_t roar_vs_get_avail_read(roar_vs_t * vss, int * error);
234ssize_t roar_vs_get_avail_write(roar_vs_t * vss, int * error);
235
236int     roar_vs_reset_buffer(roar_vs_t * vss, int writering, int readring, int * error);
237
238/* Misc controls.
239 */
240
241enum roar_vs_ctlcmd {
242 ROAR_VS_CMD_NOOP      = 0,
243 ROAR_VS_CMD_SET_MIXER,
244 ROAR_VS_CMD_GET_MIXER,
245 ROAR_VS_CMD_SET_FIRST_PRIM,
246 ROAR_VS_CMD_GET_FIRST_PRIM,
247};
248
249typedef enum roar_vs_ctlcmd roar_vs_ctlcmd;
250
251int     roar_vs_ctl           (roar_vs_t * vss, roar_vs_ctlcmd cmd, void * argp, int * error);
252
253
254/* Get used connection object
255 * This may be useful if you want to use functions from the main API.
256 * Returns used connection object or NULL on error.
257 */
258struct roar_connection * roar_vs_connection_obj(roar_vs_t * vss, int * error);
259
260/* Get used stream object
261 * This may be useful if you want to use functions from the main API.
262 * Returns used stream object or NULL on error.
263 */
264struct roar_stream     * roar_vs_stream_obj    (roar_vs_t * vss, int * error);
265
266/* Get used VIO object
267 * This may be useful if you want to use functions from the main API.
268 * For example this can be used in non-blocking mode
269 * to test if we can read or write. To test that use roar_vio_select().
270 * Returns used VIO object or NULL on error.
271 */
272struct roar_vio_calls  * roar_vs_vio_obj       (roar_vs_t * vss, int * error);
273
274/* send NOOP command to server
275 * This can be used to ping the server.
276 * This is of no use normally.
277 * Returns 0 on no error and -1 on error.
278 */
279#define roar_vs_noop(v, error) roar_noop(roar_vs_connection_obj((v), (error)))
280
281#endif
282
283//ll
Note: See TracBrowser for help on using the repository browser.