source: roaraudio/include/libroar/vio.h @ 1516:8537a24adfa3

Last change on this file since 1516:8537a24adfa3 was 1505:06a3687a4ce8, checked in by phi, 15 years ago

added more support for vio_ctl, added ROAR_VIO_CTL_GET_*FH and ROAR_VIO_CTL_SELECT
File size: 7.9 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// basic calls:
53#define ROAR_VIO_CTL_GET_NEXT          0x0101
54#define ROAR_VIO_CTL_SET_NEXT          0x0102
55#define ROAR_VIO_CTL_GET_FH            0x0110
56#define ROAR_VIO_CTL_GET_READ_FH       0x0111
57#define ROAR_VIO_CTL_GET_WRITE_FH      0x0112
58#define ROAR_VIO_CTL_SELECT            0x0120
59
60// stream:
61#define ROAR_VIO_CTL_SET_STREAM    0x00010001 /* normal streams */
62#define ROAR_VIO_CTL_GET_STREAM    0x00010002
63
64#define ROAR_VIO_CTL_SET_SSTREAM   0x00011001 /* server streams */
65#define ROAR_VIO_CTL_GET_SSTREAM   0x00011002
66
67#define ROAR_VIO_CTL_GET_DELAY     0x00010011 /* return in bytes as the vio interface */
68                                              /* does not know anything about streams */
69
70#define ROAR_VIO_CTL_GET_DBLOCKS   0x00020001 /* get Driver Blocks */
71#define ROAR_VIO_CTL_SET_DBLOCKS   0x00020002 /* set Driver Blocks */
72#define ROAR_VIO_CTL_GET_DBLKSIZE  0x00020003 /* get Driver Blocks size (in byte) */
73
74// sys io:
75
76struct roar_vio_calls {
77 void * inst;
78/*
79 ssize_t (*read) (int fd, void *buf, size_t count, void * inst);
80 ssize_t (*write)(int fd, void *buf, size_t count, void * inst);
81 off_t   (*lseek)(int fildes, off_t offset, int whence, void * inst);
82*/
83 ssize_t (*read    )(struct roar_vio_calls * vio, void *buf, size_t count);
84 ssize_t (*write   )(struct roar_vio_calls * vio, void *buf, size_t count);
85 off_t   (*lseek   )(struct roar_vio_calls * vio, off_t offset, int whence);
86 int     (*nonblock)(struct roar_vio_calls * vio, int state);
87 int     (*sync    )(struct roar_vio_calls * vio);
88 int     (*ctl     )(struct roar_vio_calls * vio, int cmd, void * data);
89 int     (*close   )(struct roar_vio_calls * vio);
90};
91
92int roar_vio_init_calls (struct roar_vio_calls * calls);
93
94int roar_vio_set_inst (struct roar_vio_calls * vio, void * inst);
95int roar_vio_set_fh   (struct roar_vio_calls * vio, int fh);
96
97int roar_vio_get_fh   (struct roar_vio_calls * vio);
98
99ssize_t roar_vio_read    (struct roar_vio_calls * vio, void *buf, size_t count);
100ssize_t roar_vio_write   (struct roar_vio_calls * vio, void *buf, size_t count);
101off_t   roar_vio_lseek   (struct roar_vio_calls * vio, off_t offset, int whence);
102int     roar_vio_nonblock(struct roar_vio_calls * vio, int state);
103int     roar_vio_sync    (struct roar_vio_calls * vio);
104int     roar_vio_ctl     (struct roar_vio_calls * vio, int cmd, void * data);
105int     roar_vio_close   (struct roar_vio_calls * vio);
106
107// some alias functions:
108#define roar_vio_puts(vio,s) roar_vio_write((vio), (s), strlen((s)))
109//#define roar_vio_putc(vio,c) roar_vio_write((vio), &(c), 1)
110int     roar_vio_putc    (struct roar_vio_calls * vio, char c);
111int     roar_vio_getc    (struct roar_vio_calls * vio);
112
113int     roar_vio_printf  (struct roar_vio_calls * vio, const char *format, ...);
114
115// converters:
116int     roar_vio_open_file     (struct roar_vio_calls * calls, char * filename, int flags, mode_t mode);
117int     roar_vio_open_fh       (struct roar_vio_calls * calls, int fh);
118int     roar_vio_open_fh_socket(struct roar_vio_calls * calls, int fh);
119
120int     roar_vio_open_socket   (struct roar_vio_calls * calls, char * host, int port);
121int     roar_vio_open_socket_listen(struct roar_vio_calls * calls, int type, char * host, int port);
122
123int     roar_vio_simple_stream (struct roar_vio_calls * calls, int rate, int channels, int bits, int codec,
124                                                               char * server, int dir, char * name);
125
126int     roar_vio_open_stdio    (struct roar_vio_calls * calls, FILE * dst);
127
128FILE *  roar_vio_to_stdio      (struct roar_vio_calls * calls, int flags);
129#if defined(ROAR_HAVE_FOPENCOOKIE) || defined(ROAR_HAVE_FUNOPEN)
130int roar_vio_to_stdio_close (void *__cookie);
131#endif
132#if defined(ROAR_HAVE_FOPENCOOKIE)
133__ssize_t roar_vio_to_stdio_read (void *__cookie, char *__buf, size_t __nbytes);
134__ssize_t roar_vio_to_stdio_write (void *__cookie, __const char *__buf, size_t __n);
135int roar_vio_to_stdio_lseek (void *__cookie, _IO_off64_t *__pos, int __w);
136#elif defined(ROAR_HAVE_FUNOPEN)
137int roar_vio_to_stdio_read(void *__cookie, char *__buf, int __nbytes);
138int roar_vio_to_stdio_write(void *__cookie, const char *__buf, int __n);
139fpos_t roar_vio_to_stdio_lseek(void *__cookie, fpos_t __pos, int __w);
140#endif
141
142
143// possible VIOs:
144
145// basic
146ssize_t roar_vio_basic_read    (struct roar_vio_calls * vio, void *buf, size_t count);
147ssize_t roar_vio_basic_write   (struct roar_vio_calls * vio, void *buf, size_t count);
148off_t   roar_vio_basic_lseek   (struct roar_vio_calls * vio, off_t offset, int whence);
149int     roar_vio_basic_nonblock(struct roar_vio_calls * vio, int state);
150int     roar_vio_basic_sync    (struct roar_vio_calls * vio);
151int     roar_vio_basic_ctl     (struct roar_vio_calls * vio, int cmd, void * data);
152int     roar_vio_basic_close   (struct roar_vio_calls * vio);
153
154// null
155// this is a read and write in one!
156ssize_t roar_vio_null_rw    (struct roar_vio_calls * vio, void *buf, size_t count);
157
158// pass
159
160int     roar_vio_open_pass    (struct roar_vio_calls * calls, struct roar_vio_calls * dst);
161ssize_t roar_vio_pass_read    (struct roar_vio_calls * vio, void *buf, size_t count);
162ssize_t roar_vio_pass_write   (struct roar_vio_calls * vio, void *buf, size_t count);
163off_t   roar_vio_pass_lseek   (struct roar_vio_calls * vio, off_t offset, int whence);
164int     roar_vio_pass_nonblock(struct roar_vio_calls * vio, int state);
165int     roar_vio_pass_sync    (struct roar_vio_calls * vio);
166int     roar_vio_pass_ctl     (struct roar_vio_calls * vio, int cmd, void * data);
167int     roar_vio_pass_close   (struct roar_vio_calls * vio);
168
169// re-read/write
170
171int     roar_vio_open_re (struct roar_vio_calls * calls, struct roar_vio_calls * dst);
172ssize_t roar_vio_re_read (struct roar_vio_calls * vio, void *buf, size_t count);
173ssize_t roar_vio_re_write(struct roar_vio_calls * vio, void *buf, size_t count);
174off_t   roar_vio_re_lseek(struct roar_vio_calls * vio, off_t offset, int whence);
175
176// stdio
177ssize_t roar_vio_stdio_read    (struct roar_vio_calls * vio, void *buf, size_t count);
178ssize_t roar_vio_stdio_write   (struct roar_vio_calls * vio, void *buf, size_t count);
179off_t   roar_vio_stdio_lseek   (struct roar_vio_calls * vio, off_t offset, int whence);
180int     roar_vio_stdio_sync    (struct roar_vio_calls * vio);
181int     roar_vio_stdio_ctl     (struct roar_vio_calls * vio, int cmd, void * data);
182int     roar_vio_stdio_close   (struct roar_vio_calls * vio);
183
184#endif
185
186//ll
Note: See TracBrowser for help on using the repository browser.