[2058] | 1 | //vio_ctl.h: |
---|
| 2 | |
---|
| 3 | /* |
---|
[5381] | 4 | * Copyright (C) Philipp 'ph3-der-loewe' Schafft - 2008-2012 |
---|
[2058] | 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 |
---|
[3517] | 21 | * the Free Software Foundation, 51 Franklin Street, Fifth Floor, |
---|
| 22 | * Boston, MA 02110-1301, USA. |
---|
[2058] | 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 illigal to use |
---|
| 33 | * them with any software that uses libesd, libartsc or libpulse*. |
---|
| 34 | */ |
---|
| 35 | |
---|
| 36 | #ifndef _LIBROARVIO_CTL_H_ |
---|
| 37 | #define _LIBROARVIO_CTL_H_ |
---|
| 38 | |
---|
| 39 | #include "libroar.h" |
---|
| 40 | |
---|
| 41 | // CTLs: |
---|
| 42 | /* |
---|
| 43 | * 0xAAAABBBB |
---|
| 44 | * AAAA: |
---|
| 45 | * 0x0001 -> Basic stream calls |
---|
| 46 | * 0x0002 -> Driver calls |
---|
| 47 | * |
---|
| 48 | * BBBB: |
---|
| 49 | * 0x0XXX -> Client |
---|
| 50 | * 0x1XXX -> Server |
---|
| 51 | */ |
---|
| 52 | |
---|
[5283] | 53 | #define ROAR_VIO_CTL_GET 0x1UL |
---|
| 54 | #define ROAR_VIO_CTL_SET 0x2UL |
---|
[2858] | 55 | |
---|
[5283] | 56 | #define ROAR_VIO_CTL_CLIENT 0x0000UL |
---|
| 57 | #define ROAR_VIO_CTL_SERVER 0x1000UL |
---|
[2858] | 58 | |
---|
[5283] | 59 | #define ROAR_VIO_CTL_GENERIC (0x0000UL<<16) |
---|
| 60 | #define ROAR_VIO_CTL_STREAM (0x0001UL<<16) |
---|
| 61 | #define ROAR_VIO_CTL_DRIVER (0x0002UL<<16) |
---|
[2058] | 62 | |
---|
| 63 | // basic calls: |
---|
[3435] | 64 | #define ROAR_VIO_CTL_GET_NEXT (ROAR_VIO_CTL_GENERIC|ROAR_VIO_CTL_GET|0x0100) |
---|
| 65 | #define ROAR_VIO_CTL_SET_NEXT (ROAR_VIO_CTL_GENERIC|ROAR_VIO_CTL_SET|0x0100) |
---|
| 66 | #define ROAR_VIO_CTL_GET_FH (ROAR_VIO_CTL_GENERIC|0x0110) |
---|
| 67 | #define ROAR_VIO_CTL_GET_READ_FH (ROAR_VIO_CTL_GENERIC|0x0111) |
---|
| 68 | #define ROAR_VIO_CTL_GET_WRITE_FH (ROAR_VIO_CTL_GENERIC|0x0112) |
---|
| 69 | #define ROAR_VIO_CTL_GET_SELECT_FH (ROAR_VIO_CTL_GENERIC|0x0113) |
---|
| 70 | #define ROAR_VIO_CTL_GET_SELECT_READ_FH (ROAR_VIO_CTL_GENERIC|0x0114) |
---|
| 71 | #define ROAR_VIO_CTL_GET_SELECT_WRITE_FH (ROAR_VIO_CTL_GENERIC|0x0115) |
---|
| 72 | #define ROAR_VIO_CTL_SELECT (ROAR_VIO_CTL_GENERIC|0x0120) |
---|
| 73 | #define ROAR_VIO_CTL_GET_UMMAP (ROAR_VIO_CTL_GENERIC|ROAR_VIO_CTL_GET|0x0130) /* Use mmap(), int as bool */ |
---|
| 74 | #define ROAR_VIO_CTL_SET_UMMAP (ROAR_VIO_CTL_GENERIC|ROAR_VIO_CTL_SET|0x0130) /* ** */ |
---|
| 75 | #define ROAR_VIO_CTL_GET_SHUTDOWN (ROAR_VIO_CTL_GENERIC|0x0140) /* shutdown(), need specs */ |
---|
| 76 | #define ROAR_VIO_CTL_SET_NOSYNC (ROAR_VIO_CTL_GENERIC|0x0150) /* delete call of vio sync() from object */ |
---|
| 77 | #define ROAR_VIO_CTL_GET_NAME (ROAR_VIO_CTL_GENERIC|ROAR_VIO_CTL_GET|0x0160) /* get name of VIO */ |
---|
[3769] | 78 | #define ROAR_VIO_CTL_ACCEPT (ROAR_VIO_CTL_GENERIC|0x0170) /* accept(), vio* */ |
---|
[3796] | 79 | #define ROAR_VIO_CTL_SHUTDOWN (ROAR_VIO_CTL_GENERIC|ROAR_VIO_CTL_SET|0x0174) /* shutdown(), int */ |
---|
[3852] | 80 | #define ROAR_VIO_CTL_SYSIO_IOCTL (ROAR_VIO_CTL_GENERIC|ROAR_VIO_CTL_SET|0x0180) /* ioctl(), */ |
---|
| 81 | /* struct roar_vio_sysio_ioctl* */ |
---|
[3878] | 82 | #define ROAR_VIO_CTL_FSTAT (ROAR_VIO_CTL_GENERIC|ROAR_VIO_CTL_GET|0x0184) /* fstat() */ |
---|
[4705] | 83 | #define ROAR_VIO_CTL_GET_SOCKNAME (ROAR_VIO_CTL_GENERIC|ROAR_VIO_CTL_GET|0x0188) /* getsockname() */ |
---|
| 84 | #define ROAR_VIO_CTL_GET_PEERNAME (ROAR_VIO_CTL_GENERIC|ROAR_VIO_CTL_GET|0x018C) /* getpeername() */ |
---|
[4831] | 85 | |
---|
| 86 | // NOTE: The following two blocks have some discontinuity in the used IDs: |
---|
| 87 | // 0x0190 was used by both ROAR_VIO_CTL_[GS]ET_SYSIO_SOCKOPT and ROAR_VIO_CTL_[GS]ET_MIMETYPE. |
---|
| 88 | // we fixed this by changeing IDs for both and add new consts for the conflicting IDs. |
---|
| 89 | // roar_vio_ctl() will print a warning if they are used. |
---|
| 90 | #define ROAR_VIO_CTL_CONFLICTING_ID_0 (ROAR_VIO_CTL_GENERIC|ROAR_VIO_CTL_GET|0x0190) |
---|
| 91 | #define ROAR_VIO_CTL_CONFLICTING_ID_1 (ROAR_VIO_CTL_GENERIC|ROAR_VIO_CTL_SET|0x0190) |
---|
| 92 | |
---|
| 93 | #define ROAR_VIO_CTL_GET_SYSIO_SOCKOPT (ROAR_VIO_CTL_GENERIC|ROAR_VIO_CTL_GET|0x0198) /* getsockopt() */ |
---|
| 94 | #define ROAR_VIO_CTL_SET_SYSIO_SOCKOPT (ROAR_VIO_CTL_GENERIC|ROAR_VIO_CTL_SET|0x0198) /* setsockopt() */ |
---|
[2858] | 95 | |
---|
[4530] | 96 | // more about network based protocols: |
---|
[4831] | 97 | #define ROAR_VIO_CTL_GET_MIMETYPE (ROAR_VIO_CTL_GENERIC|ROAR_VIO_CTL_GET|0x019C) |
---|
| 98 | #define ROAR_VIO_CTL_SET_MIMETYPE (ROAR_VIO_CTL_GENERIC|ROAR_VIO_CTL_SET|0x019C) |
---|
[4530] | 99 | #define ROAR_VIO_CTL_GET_USERPASS (ROAR_VIO_CTL_GENERIC|ROAR_VIO_CTL_SET|0x0194) |
---|
| 100 | #define ROAR_VIO_CTL_SET_USERPASS (ROAR_VIO_CTL_GENERIC|ROAR_VIO_CTL_SET|0x0194) |
---|
[5276] | 101 | |
---|
| 102 | // Implement roar_vio_nonblock()... |
---|
| 103 | #define ROAR_VIO_CTL_NONBLOCK (ROAR_VIO_CTL_GENERIC|0x01A0) /* roar_vio_nonblock(), int */ |
---|
[4530] | 104 | |
---|
[2858] | 105 | // get or set data format used for read and write calls, see below |
---|
| 106 | #define ROAR_VIO_CTL_GET_DATA_FORMAT (ROAR_VIO_CTL_GENERIC|ROAR_VIO_CTL_GET|0x0170) |
---|
| 107 | #define ROAR_VIO_CTL_SET_DATA_FORMAT (ROAR_VIO_CTL_GENERIC|ROAR_VIO_CTL_SET|0x0170) |
---|
[2058] | 108 | |
---|
| 109 | // stream: |
---|
| 110 | #define ROAR_VIO_CTL_SET_STREAM (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_CLIENT|ROAR_VIO_CTL_SET) /* normal streams */ |
---|
| 111 | #define ROAR_VIO_CTL_GET_STREAM (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_CLIENT|ROAR_VIO_CTL_GET) |
---|
| 112 | #define ROAR_VIO_CTL_SET_DMXSCHAN (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_CLIENT|ROAR_VIO_CTL_SET|0x10) /* simple DMX Channel */ |
---|
| 113 | #define ROAR_VIO_CTL_GET_DMXSCHAN (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_CLIENT|ROAR_VIO_CTL_GET|0x10) |
---|
| 114 | #define ROAR_VIO_CTL_SET_DMXUNIV (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_CLIENT|ROAR_VIO_CTL_SET|0x20) /* DMX Universe */ |
---|
| 115 | #define ROAR_VIO_CTL_GET_DMXUNIV (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_CLIENT|ROAR_VIO_CTL_GET|0x20) |
---|
| 116 | |
---|
| 117 | #define ROAR_VIO_CTL_SET_SSTREAM (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_SERVER|ROAR_VIO_CTL_SET) /* server streams */ |
---|
| 118 | #define ROAR_VIO_CTL_GET_SSTREAM (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_SERVER|ROAR_VIO_CTL_GET) |
---|
| 119 | #define ROAR_VIO_CTL_SET_SSTREAMID (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_SERVER|ROAR_VIO_CTL_SET|0x10) /* server streams */ |
---|
| 120 | #define ROAR_VIO_CTL_GET_SSTREAMID (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_SERVER|ROAR_VIO_CTL_GET|0x10) |
---|
| 121 | |
---|
| 122 | #define ROAR_VIO_CTL_SET_AUINFO (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_SET|0x2000) /* set a struct roar_audio_info */ |
---|
| 123 | #define ROAR_VIO_CTL_GET_AUINFO (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_GET|0x2000) /* get a struct roar_audio_info */ |
---|
| 124 | |
---|
| 125 | #define ROAR_VIO_CTL_GET_DELAY (ROAR_VIO_CTL_STREAM|ROAR_VIO_CTL_GET|0x010) /* return in bytes as the vio interface */ |
---|
| 126 | /* does not know anything about streams */ |
---|
| 127 | |
---|
| 128 | #define ROAR_VIO_CTL_GET_DBLOCKS (ROAR_VIO_CTL_DRIVER|0x0001) /* get Driver Blocks */ |
---|
| 129 | #define ROAR_VIO_CTL_SET_DBLOCKS (ROAR_VIO_CTL_DRIVER|0x0002) /* set Driver Blocks */ |
---|
| 130 | #define ROAR_VIO_CTL_GET_DBLKSIZE (ROAR_VIO_CTL_DRIVER|0x0003) /* get Driver Blocks size (in byte) */ |
---|
| 131 | #define ROAR_VIO_CTL_SET_DBLKSIZE (ROAR_VIO_CTL_DRIVER|0x0004) /* set Driver Blocks size (in byte) */ |
---|
| 132 | #define ROAR_VIO_CTL_GET_VOLUME (ROAR_VIO_CTL_DRIVER|ROAR_VIO_CTL_GET|0x10) |
---|
| 133 | #define ROAR_VIO_CTL_SET_VOLUME (ROAR_VIO_CTL_DRIVER|ROAR_VIO_CTL_SET|0x10) |
---|
[4815] | 134 | #define ROAR_VIO_CTL_GET_RECORD (ROAR_VIO_CTL_DRIVER|ROAR_VIO_CTL_GET|0x20) /* int */ |
---|
| 135 | #define ROAR_VIO_CTL_SET_RECORD (ROAR_VIO_CTL_DRIVER|ROAR_VIO_CTL_SET|0x20) /* int */ |
---|
[2058] | 136 | |
---|
[3796] | 137 | // consts for ROAR_VIO_CTL_SHUTDOWN: |
---|
| 138 | #define ROAR_VIO_SHUTDOWN_READ 0x1 |
---|
| 139 | #define ROAR_VIO_SHUTDOWN_WRITE 0x2 |
---|
| 140 | #define ROAR_VIO_SHUTDOWN_LISTEN 0x4 /* like close() on listen sock but allow padding requests */ |
---|
| 141 | /* to be accept()ed */ |
---|
| 142 | #define ROAR_VIO_SHUTDOWN_RW (ROAR_VIO_SHUTDOWN_READ|ROAR_VIO_SHUTDOWN_WRITE) |
---|
[2058] | 143 | |
---|
[2858] | 144 | // Data format used for read/write(): |
---|
| 145 | |
---|
| 146 | // _D_ata _F_ormat _T_ypes: |
---|
| 147 | // generic types: |
---|
| 148 | #define ROAR_VIO_DFT_UNKNOWN -1 |
---|
| 149 | #define ROAR_VIO_DFT_NULL 0x0000 |
---|
| 150 | #define ROAR_VIO_DFT_RAW 0x0001 /* raw bytes, default */ |
---|
[4902] | 151 | #define ROAR_VIO_DFT_PACKET 0x0002 /* a packet of some kind including headers */ |
---|
| 152 | #define ROAR_VIO_DFT_UNFRAMED 0x0003 /* a packet of some kind excluding headers */ |
---|
[2858] | 153 | |
---|
| 154 | // RoarAudio types: |
---|
| 155 | #define ROAR_VIO_DFT_RA_MESSAGE 0x0101 |
---|
| 156 | #define ROAR_VIO_DFT_RA_BUFFER 0x0102 |
---|
| 157 | |
---|
| 158 | // extern types: |
---|
| 159 | #define ROAR_VIO_DFT_OGG_PAGE 0x0201 |
---|
| 160 | #define ROAR_VIO_DFT_OGG_PACKET 0x0202 |
---|
| 161 | |
---|
| 162 | struct roar_vio_dataformat { |
---|
| 163 | unsigned int type; |
---|
| 164 | }; |
---|
| 165 | |
---|
[3852] | 166 | struct roar_vio_sysio_ioctl { |
---|
| 167 | long long int cmd; |
---|
| 168 | void * argp; |
---|
| 169 | }; |
---|
| 170 | |
---|
[4718] | 171 | struct roar_vio_sysio_sockopt { |
---|
| 172 | int level; |
---|
| 173 | int optname; |
---|
| 174 | void * optval; |
---|
| 175 | socklen_t optlen; |
---|
| 176 | }; |
---|
| 177 | |
---|
[3878] | 178 | #if 0 |
---|
| 179 | struct stat { |
---|
| 180 | dev_t st_dev; /* ID of device containing file */ |
---|
| 181 | ino_t st_ino; /* inode number */ |
---|
| 182 | X mode_t st_mode; /* protection */ |
---|
| 183 | X nlink_t st_nlink; /* number of hard links */ |
---|
| 184 | X uid_t st_uid; /* user ID of owner */ |
---|
| 185 | X gid_t st_gid; /* group ID of owner */ |
---|
| 186 | dev_t st_rdev; /* device ID (if special file) */ |
---|
| 187 | X off_t st_size; /* total size, in bytes */ |
---|
| 188 | X blksize_t st_blksize; /* blocksize for filesystem I/O */ |
---|
| 189 | X blkcnt_t st_blocks; /* number of blocks allocated */ |
---|
| 190 | time_t st_atime; /* time of last access */ |
---|
| 191 | time_t st_mtime; /* time of last modification */ |
---|
| 192 | time_t st_ctime; /* time of last status change */ |
---|
| 193 | }; |
---|
| 194 | #endif |
---|
| 195 | |
---|
| 196 | struct roar_vio_stat { |
---|
| 197 | mode_t mode; |
---|
| 198 | size_t linkc; |
---|
| 199 | uid_t uid; |
---|
| 200 | gid_t gid; |
---|
| 201 | size_t size; |
---|
| 202 | size_t blksize; |
---|
| 203 | size_t blocks; |
---|
| 204 | }; |
---|
| 205 | |
---|
[4530] | 206 | // struct for userpass: |
---|
| 207 | struct roar_userpass { |
---|
| 208 | int subtype; |
---|
| 209 | char * user; |
---|
| 210 | char * pass; |
---|
| 211 | }; |
---|
| 212 | |
---|
[4705] | 213 | // for ROAR_VIO_CTL_GET_SOCKNAME and ROAR_VIO_CTL_GET_PEERNAME |
---|
| 214 | struct roar_sockname { |
---|
| 215 | int flags; |
---|
| 216 | int type; |
---|
| 217 | char * addr; |
---|
| 218 | int port; |
---|
| 219 | }; |
---|
| 220 | |
---|
[2058] | 221 | #endif |
---|
| 222 | |
---|
| 223 | //ll |
---|