[1140] | 1 | //vio.h: |
---|
[588] | 2 | |
---|
[690] | 3 | /* |
---|
[1284] | 4 | * Copyright (C) Philipp 'ph3-der-loewe' Schafft - 2008, 2009 |
---|
[690] | 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 | |
---|
[588] | 35 | #ifndef _LIBROARVIO_H_ |
---|
| 36 | #define _LIBROARVIO_H_ |
---|
| 37 | |
---|
| 38 | #include "libroar.h" |
---|
| 39 | |
---|
[1140] | 40 | // CTLs: |
---|
[1220] | 41 | /* |
---|
| 42 | * 0xAAAABBBB |
---|
| 43 | * AAAA: |
---|
| 44 | * 0x0001 -> Basic stream calls |
---|
| 45 | * 0x0002 -> Driver calls |
---|
| 46 | * |
---|
| 47 | * BBBB: |
---|
| 48 | * 0x0XXX -> Client |
---|
| 49 | * 0x1XXX -> Server |
---|
| 50 | */ |
---|
[1505] | 51 | |
---|
[1517] | 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 | |
---|
[1505] | 60 | // basic calls: |
---|
[1517] | 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) |
---|
[1505] | 67 | |
---|
[1140] | 68 | // stream: |
---|
[1517] | 69 | #define ROAR_VIO_CTL_SET_STREAM (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_CLIENT|ROAR_VIO_CTL_SET) /* normal streams */ |
---|
| 70 | #define ROAR_VIO_CTL_GET_STREAM (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_CLIENT|ROAR_VIO_CTL_GET) |
---|
[1150] | 71 | |
---|
[1517] | 72 | #define ROAR_VIO_CTL_SET_SSTREAM (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_SERVER|ROAR_VIO_CTL_SET) /* server streams */ |
---|
| 73 | #define ROAR_VIO_CTL_GET_SSTREAM (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_SERVER|ROAR_VIO_CTL_GET) |
---|
[1529] | 74 | #define ROAR_VIO_CTL_SET_SSTREAMID (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_SERVER|ROAR_VIO_CTL_SET|0x10) /* server streams */ |
---|
| 75 | #define ROAR_VIO_CTL_GET_SSTREAMID (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_SERVER|ROAR_VIO_CTL_GET|0x10) |
---|
[1150] | 76 | |
---|
[1517] | 77 | #define ROAR_VIO_CTL_SET_AUINFO (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_SET|0x2000) /* set a struct roar_audio_info */ |
---|
| 78 | #define ROAR_VIO_CTL_GET_AUINFO (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_GET|0x2000) /* get a struct roar_audio_info */ |
---|
| 79 | |
---|
| 80 | #define ROAR_VIO_CTL_GET_DELAY (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_GET|0x010) /* return in bytes as the vio interface */ |
---|
[1151] | 81 | /* does not know anything about streams */ |
---|
[1140] | 82 | |
---|
[1517] | 83 | #define ROAR_VIO_CTL_GET_DBLOCKS (ROAR_VIO_CTL_DRIVER|0x0001) /* get Driver Blocks */ |
---|
| 84 | #define ROAR_VIO_CTL_SET_DBLOCKS (ROAR_VIO_CTL_DRIVER|0x0002) /* set Driver Blocks */ |
---|
| 85 | #define ROAR_VIO_CTL_GET_DBLKSIZE (ROAR_VIO_CTL_DRIVER|0x0003) /* get Driver Blocks size (in byte) */ |
---|
[1522] | 86 | #define ROAR_VIO_CTL_SET_DBLKSIZE (ROAR_VIO_CTL_DRIVER|0x0004) /* set Driver Blocks size (in byte) */ |
---|
[1590] | 87 | #define ROAR_VIO_CTL_GET_VOLUME (ROAR_VIO_CTL_DRIVER|ROAR_VIO_CTL_GET|0x10) |
---|
| 88 | #define ROAR_VIO_CTL_SET_VOLUME (ROAR_VIO_CTL_DRIVER|ROAR_VIO_CTL_SET|0x10) |
---|
[1220] | 89 | |
---|
[1140] | 90 | // sys io: |
---|
| 91 | |
---|
[589] | 92 | struct roar_vio_calls { |
---|
[593] | 93 | void * inst; |
---|
[881] | 94 | /* |
---|
[595] | 95 | ssize_t (*read) (int fd, void *buf, size_t count, void * inst); |
---|
| 96 | ssize_t (*write)(int fd, void *buf, size_t count, void * inst); |
---|
| 97 | off_t (*lseek)(int fildes, off_t offset, int whence, void * inst); |
---|
[881] | 98 | */ |
---|
[1118] | 99 | ssize_t (*read )(struct roar_vio_calls * vio, void *buf, size_t count); |
---|
| 100 | ssize_t (*write )(struct roar_vio_calls * vio, void *buf, size_t count); |
---|
| 101 | off_t (*lseek )(struct roar_vio_calls * vio, off_t offset, int whence); |
---|
| 102 | int (*nonblock)(struct roar_vio_calls * vio, int state); |
---|
| 103 | int (*sync )(struct roar_vio_calls * vio); |
---|
[1140] | 104 | int (*ctl )(struct roar_vio_calls * vio, int cmd, void * data); |
---|
[1241] | 105 | int (*close )(struct roar_vio_calls * vio); |
---|
[589] | 106 | }; |
---|
| 107 | |
---|
[591] | 108 | int roar_vio_init_calls (struct roar_vio_calls * calls); |
---|
| 109 | |
---|
[881] | 110 | int roar_vio_set_inst (struct roar_vio_calls * vio, void * inst); |
---|
| 111 | int roar_vio_set_fh (struct roar_vio_calls * vio, int fh); |
---|
| 112 | |
---|
| 113 | int roar_vio_get_fh (struct roar_vio_calls * vio); |
---|
| 114 | |
---|
[1118] | 115 | ssize_t roar_vio_read (struct roar_vio_calls * vio, void *buf, size_t count); |
---|
| 116 | ssize_t roar_vio_write (struct roar_vio_calls * vio, void *buf, size_t count); |
---|
| 117 | off_t roar_vio_lseek (struct roar_vio_calls * vio, off_t offset, int whence); |
---|
| 118 | int roar_vio_nonblock(struct roar_vio_calls * vio, int state); |
---|
| 119 | int roar_vio_sync (struct roar_vio_calls * vio); |
---|
[1140] | 120 | int roar_vio_ctl (struct roar_vio_calls * vio, int cmd, void * data); |
---|
[1241] | 121 | int roar_vio_close (struct roar_vio_calls * vio); |
---|
[881] | 122 | |
---|
[1314] | 123 | // some alias functions: |
---|
| 124 | #define roar_vio_puts(vio,s) roar_vio_write((vio), (s), strlen((s))) |
---|
| 125 | //#define roar_vio_putc(vio,c) roar_vio_write((vio), &(c), 1) |
---|
| 126 | int roar_vio_putc (struct roar_vio_calls * vio, char c); |
---|
| 127 | int roar_vio_getc (struct roar_vio_calls * vio); |
---|
| 128 | |
---|
[1351] | 129 | int roar_vio_printf (struct roar_vio_calls * vio, const char *format, ...); |
---|
| 130 | |
---|
[1252] | 131 | // converters: |
---|
| 132 | int roar_vio_open_file (struct roar_vio_calls * calls, char * filename, int flags, mode_t mode); |
---|
| 133 | int roar_vio_open_fh (struct roar_vio_calls * calls, int fh); |
---|
[1290] | 134 | int roar_vio_open_fh_socket(struct roar_vio_calls * calls, int fh); |
---|
[1275] | 135 | |
---|
[1291] | 136 | int roar_vio_open_socket (struct roar_vio_calls * calls, char * host, int port); |
---|
| 137 | int roar_vio_open_socket_listen(struct roar_vio_calls * calls, int type, char * host, int port); |
---|
| 138 | |
---|
[1275] | 139 | int roar_vio_simple_stream (struct roar_vio_calls * calls, int rate, int channels, int bits, int codec, |
---|
| 140 | char * server, int dir, char * name); |
---|
| 141 | |
---|
[1252] | 142 | int roar_vio_open_stdio (struct roar_vio_calls * calls, FILE * dst); |
---|
[1275] | 143 | |
---|
[1252] | 144 | FILE * roar_vio_to_stdio (struct roar_vio_calls * calls, int flags); |
---|
[1293] | 145 | #if defined(ROAR_HAVE_FOPENCOOKIE) || defined(ROAR_HAVE_FUNOPEN) |
---|
| 146 | int roar_vio_to_stdio_close (void *__cookie); |
---|
| 147 | #endif |
---|
| 148 | #if defined(ROAR_HAVE_FOPENCOOKIE) |
---|
| 149 | __ssize_t roar_vio_to_stdio_read (void *__cookie, char *__buf, size_t __nbytes); |
---|
| 150 | __ssize_t roar_vio_to_stdio_write (void *__cookie, __const char *__buf, size_t __n); |
---|
| 151 | int roar_vio_to_stdio_lseek (void *__cookie, _IO_off64_t *__pos, int __w); |
---|
| 152 | #elif defined(ROAR_HAVE_FUNOPEN) |
---|
| 153 | int roar_vio_to_stdio_read(void *__cookie, char *__buf, int __nbytes); |
---|
| 154 | int roar_vio_to_stdio_write(void *__cookie, const char *__buf, int __n); |
---|
| 155 | fpos_t roar_vio_to_stdio_lseek(void *__cookie, fpos_t __pos, int __w); |
---|
| 156 | #endif |
---|
[1252] | 157 | |
---|
[881] | 158 | |
---|
| 159 | // possible VIOs: |
---|
| 160 | |
---|
| 161 | // basic |
---|
[1118] | 162 | ssize_t roar_vio_basic_read (struct roar_vio_calls * vio, void *buf, size_t count); |
---|
| 163 | ssize_t roar_vio_basic_write (struct roar_vio_calls * vio, void *buf, size_t count); |
---|
| 164 | off_t roar_vio_basic_lseek (struct roar_vio_calls * vio, off_t offset, int whence); |
---|
| 165 | int roar_vio_basic_nonblock(struct roar_vio_calls * vio, int state); |
---|
| 166 | int roar_vio_basic_sync (struct roar_vio_calls * vio); |
---|
[1505] | 167 | int roar_vio_basic_ctl (struct roar_vio_calls * vio, int cmd, void * data); |
---|
[1241] | 168 | int roar_vio_basic_close (struct roar_vio_calls * vio); |
---|
[881] | 169 | |
---|
[1760] | 170 | #ifdef ROAR_TARGET_WIN32 |
---|
| 171 | ssize_t roar_vio_winsock_read (struct roar_vio_calls * vio, void *buf, size_t count); |
---|
| 172 | ssize_t roar_vio_winsock_write (struct roar_vio_calls * vio, void *buf, size_t count); |
---|
| 173 | int roar_vio_winsock_nonblock(struct roar_vio_calls * vio, int state); |
---|
| 174 | int roar_vio_winsock_sync (struct roar_vio_calls * vio); |
---|
| 175 | int roar_vio_winsock_ctl (struct roar_vio_calls * vio, int cmd, void * data); |
---|
| 176 | int roar_vio_winsock_close (struct roar_vio_calls * vio); |
---|
| 177 | #endif |
---|
| 178 | |
---|
[943] | 179 | // null |
---|
[1241] | 180 | // this is a read and write in one! |
---|
[943] | 181 | ssize_t roar_vio_null_rw (struct roar_vio_calls * vio, void *buf, size_t count); |
---|
[1665] | 182 | int roar_vio_null_sync (struct roar_vio_calls * vio); |
---|
[943] | 183 | |
---|
[886] | 184 | // pass |
---|
| 185 | |
---|
[1247] | 186 | int roar_vio_open_pass (struct roar_vio_calls * calls, struct roar_vio_calls * dst); |
---|
[1241] | 187 | ssize_t roar_vio_pass_read (struct roar_vio_calls * vio, void *buf, size_t count); |
---|
| 188 | ssize_t roar_vio_pass_write (struct roar_vio_calls * vio, void *buf, size_t count); |
---|
| 189 | off_t roar_vio_pass_lseek (struct roar_vio_calls * vio, off_t offset, int whence); |
---|
| 190 | int roar_vio_pass_nonblock(struct roar_vio_calls * vio, int state); |
---|
| 191 | int roar_vio_pass_sync (struct roar_vio_calls * vio); |
---|
| 192 | int roar_vio_pass_ctl (struct roar_vio_calls * vio, int cmd, void * data); |
---|
| 193 | int roar_vio_pass_close (struct roar_vio_calls * vio); |
---|
[886] | 194 | |
---|
| 195 | // re-read/write |
---|
| 196 | |
---|
[1247] | 197 | int roar_vio_open_re (struct roar_vio_calls * calls, struct roar_vio_calls * dst); |
---|
[886] | 198 | ssize_t roar_vio_re_read (struct roar_vio_calls * vio, void *buf, size_t count); |
---|
| 199 | ssize_t roar_vio_re_write(struct roar_vio_calls * vio, void *buf, size_t count); |
---|
| 200 | off_t roar_vio_re_lseek(struct roar_vio_calls * vio, off_t offset, int whence); |
---|
| 201 | |
---|
[1253] | 202 | // stdio |
---|
| 203 | ssize_t roar_vio_stdio_read (struct roar_vio_calls * vio, void *buf, size_t count); |
---|
| 204 | ssize_t roar_vio_stdio_write (struct roar_vio_calls * vio, void *buf, size_t count); |
---|
| 205 | off_t roar_vio_stdio_lseek (struct roar_vio_calls * vio, off_t offset, int whence); |
---|
| 206 | int roar_vio_stdio_sync (struct roar_vio_calls * vio); |
---|
[1505] | 207 | int roar_vio_stdio_ctl (struct roar_vio_calls * vio, int cmd, void * data); |
---|
[1253] | 208 | int roar_vio_stdio_close (struct roar_vio_calls * vio); |
---|
[886] | 209 | |
---|
[588] | 210 | #endif |
---|
| 211 | |
---|
| 212 | //ll |
---|