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