source: roaraudio/include/libroar/vio.h @ 2054:f711d0d0a02d

Last change on this file since 2054:f711d0d0a02d was 2054:f711d0d0a02d, checked in by phi, 15 years ago

start of support to kill sync calls
File size: 10.7 KB
Line 
1//vio.h:
2
3/*
4 *      Copyright (C) Philipp 'ph3-der-loewe' Schafft - 2008, 2009
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, 675 Mass Ave, Cambridge, MA 02139, USA.
22 *
23 *  NOTE for everyone want's to change something and send patches:
24 *  read README and HACKING! There a addition information on
25 *  the license of this document you need to read before you send
26 *  any patches.
27 *
28 *  NOTE for uses of non-GPL (LGPL,...) software using libesd, libartsc
29 *  or libpulse*:
30 *  The libs libroaresd, libroararts and libroarpulse link this lib
31 *  and are therefore GPL. Because of this it may be illigal to use
32 *  them with any software that uses libesd, libartsc or libpulse*.
33 */
34
35#ifndef _LIBROARVIO_H_
36#define _LIBROARVIO_H_
37
38#include "libroar.h"
39
40// CTLs:
41/*
42 * 0xAAAABBBB
43 * AAAA:
44 *   0x0001 -> Basic stream calls
45 *   0x0002 -> Driver calls
46 *
47 * BBBB:
48 *   0x0XXX -> Client
49 *   0x1XXX -> Server
50 */
51
52#define ROAR_VIO_CTL_GET                  0x1
53#define ROAR_VIO_CTL_SET                  0x2
54#define ROAR_VIO_CTL_CLIENT            0x0000
55#define ROAR_VIO_CTL_SERVER            0x1000
56#define ROAR_VIO_CTL_GENERIC     (0x0000<<16)
57#define ROAR_VIO_CTL_STREAM      (0x0001<<16)
58#define ROAR_VIO_CTL_DRIVER      (0x0002<<16)
59
60// basic calls:
61#define ROAR_VIO_CTL_GET_NEXT          (ROAR_VIO_CTL_GENERIC|ROAR_VIO_CTL_GET|0x0100)
62#define ROAR_VIO_CTL_SET_NEXT          (ROAR_VIO_CTL_GENERIC|ROAR_VIO_CTL_SET|0x0100)
63#define ROAR_VIO_CTL_GET_FH            (ROAR_VIO_CTL_GENERIC|0x0110)
64#define ROAR_VIO_CTL_GET_READ_FH       (ROAR_VIO_CTL_GENERIC|0x0111)
65#define ROAR_VIO_CTL_GET_WRITE_FH      (ROAR_VIO_CTL_GENERIC|0x0112)
66#define ROAR_VIO_CTL_SELECT            (ROAR_VIO_CTL_GENERIC|0x0120)
67#define ROAR_VIO_CTL_GET_UMMAP         (ROAR_VIO_CTL_GENERIC|ROAR_VIO_CTL_GET|0x0130) /* Use mmap(), int as bool */
68#define ROAR_VIO_CTL_SET_UMMAP         (ROAR_VIO_CTL_GENERIC|ROAR_VIO_CTL_SET|0x0130) /* ** */
69#define ROAR_VIO_CTL_GET_SHUTDOWN      (ROAR_VIO_CTL_GENERIC|0x0140) /* shutdown(), need specs */
70#define ROAR_VIO_CTL_SET_NOSYNC        (ROAR_VIO_CTL_GENERIC|0x0150) /* delete call of vio sync() from object */
71
72// stream:
73#define ROAR_VIO_CTL_SET_STREAM    (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_CLIENT|ROAR_VIO_CTL_SET) /* normal streams */
74#define ROAR_VIO_CTL_GET_STREAM    (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_CLIENT|ROAR_VIO_CTL_GET)
75#define ROAR_VIO_CTL_SET_DMXSCHAN  (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_CLIENT|ROAR_VIO_CTL_SET|0x10) /* simple DMX Channel */
76#define ROAR_VIO_CTL_GET_DMXSCHAN  (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_CLIENT|ROAR_VIO_CTL_GET|0x10)
77#define ROAR_VIO_CTL_SET_DMXUNIV   (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_CLIENT|ROAR_VIO_CTL_SET|0x20) /* DMX Universe */
78#define ROAR_VIO_CTL_GET_DMXUNIV   (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_CLIENT|ROAR_VIO_CTL_GET|0x20)
79
80#define ROAR_VIO_CTL_SET_SSTREAM   (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_SERVER|ROAR_VIO_CTL_SET) /* server streams */
81#define ROAR_VIO_CTL_GET_SSTREAM   (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_SERVER|ROAR_VIO_CTL_GET)
82#define ROAR_VIO_CTL_SET_SSTREAMID (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_SERVER|ROAR_VIO_CTL_SET|0x10) /* server streams */
83#define ROAR_VIO_CTL_GET_SSTREAMID (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_SERVER|ROAR_VIO_CTL_GET|0x10)
84
85#define ROAR_VIO_CTL_SET_AUINFO    (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_SET|0x2000) /* set a struct roar_audio_info */
86#define ROAR_VIO_CTL_GET_AUINFO    (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_GET|0x2000) /* get a struct roar_audio_info */
87
88#define ROAR_VIO_CTL_GET_DELAY     (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_GET|0x010) /* return in bytes as the vio interface */
89                                              /* does not know anything about streams */
90
91#define ROAR_VIO_CTL_GET_DBLOCKS   (ROAR_VIO_CTL_DRIVER|0x0001) /* get Driver Blocks */
92#define ROAR_VIO_CTL_SET_DBLOCKS   (ROAR_VIO_CTL_DRIVER|0x0002) /* set Driver Blocks */
93#define ROAR_VIO_CTL_GET_DBLKSIZE  (ROAR_VIO_CTL_DRIVER|0x0003) /* get Driver Blocks size (in byte) */
94#define ROAR_VIO_CTL_SET_DBLKSIZE  (ROAR_VIO_CTL_DRIVER|0x0004) /* set Driver Blocks size (in byte) */
95#define ROAR_VIO_CTL_GET_VOLUME    (ROAR_VIO_CTL_DRIVER|ROAR_VIO_CTL_GET|0x10)
96#define ROAR_VIO_CTL_SET_VOLUME    (ROAR_VIO_CTL_DRIVER|ROAR_VIO_CTL_SET|0x10)
97
98// sys io:
99
100struct roar_vio_calls {
101 void * inst;
102/*
103 ssize_t (*read) (int fd, void *buf, size_t count, void * inst);
104 ssize_t (*write)(int fd, void *buf, size_t count, void * inst);
105 off_t   (*lseek)(int fildes, off_t offset, int whence, void * inst);
106*/
107 ssize_t (*read    )(struct roar_vio_calls * vio, void *buf, size_t count);
108 ssize_t (*write   )(struct roar_vio_calls * vio, void *buf, size_t count);
109 off_t   (*lseek   )(struct roar_vio_calls * vio, off_t offset, int whence);
110 int     (*nonblock)(struct roar_vio_calls * vio, int state);
111 int     (*sync    )(struct roar_vio_calls * vio);
112 int     (*ctl     )(struct roar_vio_calls * vio, int cmd, void * data);
113 int     (*close   )(struct roar_vio_calls * vio);
114};
115
116int roar_vio_init_calls (struct roar_vio_calls * calls);
117
118int roar_vio_set_inst (struct roar_vio_calls * vio, void * inst);
119int roar_vio_set_fh   (struct roar_vio_calls * vio, int fh);
120
121int roar_vio_get_fh   (struct roar_vio_calls * vio);
122
123ssize_t roar_vio_read    (struct roar_vio_calls * vio, void *buf, size_t count);
124ssize_t roar_vio_write   (struct roar_vio_calls * vio, void *buf, size_t count);
125off_t   roar_vio_lseek   (struct roar_vio_calls * vio, off_t offset, int whence);
126int     roar_vio_nonblock(struct roar_vio_calls * vio, int state);
127int     roar_vio_sync    (struct roar_vio_calls * vio);
128int     roar_vio_ctl     (struct roar_vio_calls * vio, int cmd, void * data);
129int     roar_vio_close   (struct roar_vio_calls * vio);
130
131// some alias functions:
132#define roar_vio_puts(vio,s) roar_vio_write((vio), (s), strlen((s)))
133//#define roar_vio_putc(vio,c) roar_vio_write((vio), &(c), 1)
134int     roar_vio_putc    (struct roar_vio_calls * vio, char c);
135int     roar_vio_getc    (struct roar_vio_calls * vio);
136
137int     roar_vio_printf  (struct roar_vio_calls * vio, const char *format, ...);
138
139// converters:
140int     roar_vio_open_file     (struct roar_vio_calls * calls, char * filename, int flags, mode_t mode);
141int     roar_vio_open_fh       (struct roar_vio_calls * calls, int fh);
142int     roar_vio_open_fh_socket(struct roar_vio_calls * calls, int fh);
143
144int     roar_vio_open_socket   (struct roar_vio_calls * calls, char * host, int port);
145int     roar_vio_open_socket_listen(struct roar_vio_calls * calls, int type, char * host, int port);
146
147int     roar_vio_simple_stream (struct roar_vio_calls * calls, int rate, int channels, int bits, int codec,
148                                                               char * server, int dir, char * name);
149
150int     roar_vio_open_stdio    (struct roar_vio_calls * calls, FILE * dst);
151
152FILE *  roar_vio_to_stdio      (struct roar_vio_calls * calls, int flags);
153#if defined(ROAR_HAVE_FOPENCOOKIE) || defined(ROAR_HAVE_FUNOPEN)
154int roar_vio_to_stdio_close (void *__cookie);
155#endif
156#if defined(ROAR_HAVE_FOPENCOOKIE)
157__ssize_t roar_vio_to_stdio_read (void *__cookie, char *__buf, size_t __nbytes);
158__ssize_t roar_vio_to_stdio_write (void *__cookie, __const char *__buf, size_t __n);
159int roar_vio_to_stdio_lseek (void *__cookie, _IO_off64_t *__pos, int __w);
160#elif defined(ROAR_HAVE_FUNOPEN)
161int roar_vio_to_stdio_read(void *__cookie, char *__buf, int __nbytes);
162int roar_vio_to_stdio_write(void *__cookie, const char *__buf, int __n);
163fpos_t roar_vio_to_stdio_lseek(void *__cookie, fpos_t __pos, int __w);
164#endif
165
166
167// possible VIOs:
168
169// basic
170ssize_t roar_vio_basic_read    (struct roar_vio_calls * vio, void *buf, size_t count);
171ssize_t roar_vio_basic_write   (struct roar_vio_calls * vio, void *buf, size_t count);
172off_t   roar_vio_basic_lseek   (struct roar_vio_calls * vio, off_t offset, int whence);
173int     roar_vio_basic_nonblock(struct roar_vio_calls * vio, int state);
174int     roar_vio_basic_sync    (struct roar_vio_calls * vio);
175int     roar_vio_basic_ctl     (struct roar_vio_calls * vio, int cmd, void * data);
176int     roar_vio_basic_close   (struct roar_vio_calls * vio);
177
178#ifdef ROAR_TARGET_WIN32
179ssize_t roar_vio_winsock_read    (struct roar_vio_calls * vio, void *buf, size_t count);
180ssize_t roar_vio_winsock_write   (struct roar_vio_calls * vio, void *buf, size_t count);
181int     roar_vio_winsock_nonblock(struct roar_vio_calls * vio, int state);
182int     roar_vio_winsock_sync    (struct roar_vio_calls * vio);
183int     roar_vio_winsock_ctl     (struct roar_vio_calls * vio, int cmd, void * data);
184int     roar_vio_winsock_close   (struct roar_vio_calls * vio);
185#endif
186
187// null
188// this is a read and write in one!
189ssize_t roar_vio_null_rw    (struct roar_vio_calls * vio, void *buf, size_t count);
190int     roar_vio_null_sync  (struct roar_vio_calls * vio);
191
192// pass
193
194int     roar_vio_open_pass    (struct roar_vio_calls * calls, struct roar_vio_calls * dst);
195ssize_t roar_vio_pass_read    (struct roar_vio_calls * vio, void *buf, size_t count);
196ssize_t roar_vio_pass_write   (struct roar_vio_calls * vio, void *buf, size_t count);
197off_t   roar_vio_pass_lseek   (struct roar_vio_calls * vio, off_t offset, int whence);
198int     roar_vio_pass_nonblock(struct roar_vio_calls * vio, int state);
199int     roar_vio_pass_sync    (struct roar_vio_calls * vio);
200int     roar_vio_pass_ctl     (struct roar_vio_calls * vio, int cmd, void * data);
201int     roar_vio_pass_close   (struct roar_vio_calls * vio);
202
203// re-read/write
204
205int     roar_vio_open_re (struct roar_vio_calls * calls, struct roar_vio_calls * dst);
206ssize_t roar_vio_re_read (struct roar_vio_calls * vio, void *buf, size_t count);
207ssize_t roar_vio_re_write(struct roar_vio_calls * vio, void *buf, size_t count);
208off_t   roar_vio_re_lseek(struct roar_vio_calls * vio, off_t offset, int whence);
209
210// stdio
211ssize_t roar_vio_stdio_read    (struct roar_vio_calls * vio, void *buf, size_t count);
212ssize_t roar_vio_stdio_write   (struct roar_vio_calls * vio, void *buf, size_t count);
213off_t   roar_vio_stdio_lseek   (struct roar_vio_calls * vio, off_t offset, int whence);
214int     roar_vio_stdio_sync    (struct roar_vio_calls * vio);
215int     roar_vio_stdio_ctl     (struct roar_vio_calls * vio, int cmd, void * data);
216int     roar_vio_stdio_close   (struct roar_vio_calls * vio);
217
218#endif
219
220//ll
Note: See TracBrowser for help on using the repository browser.