[1140] | 1 | //vio.h: |
---|
[588] | 2 | |
---|
[690] | 3 | /* |
---|
[4708] | 4 | * Copyright (C) Philipp 'ph3-der-loewe' Schafft - 2008-2011 |
---|
[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 |
---|
[3517] | 21 | * the Free Software Foundation, 51 Franklin Street, Fifth Floor, |
---|
| 22 | * Boston, MA 02110-1301, USA. |
---|
[690] | 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 | |
---|
[588] | 36 | #ifndef _LIBROARVIO_H_ |
---|
| 37 | #define _LIBROARVIO_H_ |
---|
| 38 | |
---|
| 39 | #include "libroar.h" |
---|
| 40 | |
---|
[2841] | 41 | struct roar_connection; |
---|
| 42 | |
---|
[1140] | 43 | // sys io: |
---|
| 44 | |
---|
[589] | 45 | struct roar_vio_calls { |
---|
[593] | 46 | void * inst; |
---|
[881] | 47 | /* |
---|
[595] | 48 | ssize_t (*read) (int fd, void *buf, size_t count, void * inst); |
---|
| 49 | ssize_t (*write)(int fd, void *buf, size_t count, void * inst); |
---|
| 50 | off_t (*lseek)(int fildes, off_t offset, int whence, void * inst); |
---|
[881] | 51 | */ |
---|
[1118] | 52 | ssize_t (*read )(struct roar_vio_calls * vio, void *buf, size_t count); |
---|
| 53 | ssize_t (*write )(struct roar_vio_calls * vio, void *buf, size_t count); |
---|
| 54 | off_t (*lseek )(struct roar_vio_calls * vio, off_t offset, int whence); |
---|
| 55 | int (*nonblock)(struct roar_vio_calls * vio, int state); |
---|
| 56 | int (*sync )(struct roar_vio_calls * vio); |
---|
[1140] | 57 | int (*ctl )(struct roar_vio_calls * vio, int cmd, void * data); |
---|
[1241] | 58 | int (*close )(struct roar_vio_calls * vio); |
---|
[4531] | 59 | uint32_t flags; |
---|
[4532] | 60 | size_t refc; |
---|
[589] | 61 | }; |
---|
| 62 | |
---|
[5109] | 63 | int roar_vio_init_calls (struct roar_vio_calls * calls) _LIBROAR_ATTR_TO_STATIC; |
---|
[591] | 64 | |
---|
[4963] | 65 | int roar_vio_clear_calls (struct roar_vio_calls * calls); |
---|
| 66 | |
---|
[881] | 67 | int roar_vio_set_inst (struct roar_vio_calls * vio, void * inst); |
---|
[5109] | 68 | int roar_vio_set_fh (struct roar_vio_calls * vio, int fh) _LIBROAR_ATTR_TO_STATIC; |
---|
[881] | 69 | |
---|
[5109] | 70 | int roar_vio_get_fh (struct roar_vio_calls * vio) _LIBROAR_ATTR_TO_STATIC; |
---|
[881] | 71 | |
---|
[5109] | 72 | ssize_t roar_vio_read (struct roar_vio_calls * vio, void *buf, size_t count) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL_ALL; |
---|
| 73 | ssize_t roar_vio_write (struct roar_vio_calls * vio, void *buf, size_t count) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL_ALL; |
---|
| 74 | off_t roar_vio_lseek (struct roar_vio_calls * vio, off_t offset, int whence) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL_ALL; |
---|
| 75 | int roar_vio_nonblock(struct roar_vio_calls * vio, int state) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL_ALL; |
---|
| 76 | int roar_vio_sync (struct roar_vio_calls * vio) _LIBROAR_ATTR_NONNULL_ALL; |
---|
| 77 | int roar_vio_ctl (struct roar_vio_calls * vio, int cmd, void * data) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL(1); |
---|
| 78 | int roar_vio_close (struct roar_vio_calls * vio) _LIBROAR_ATTR_NONNULL_ALL; |
---|
[881] | 79 | |
---|
[3769] | 80 | // specal commands: |
---|
[5109] | 81 | int roar_vio_accept (struct roar_vio_calls * calls, struct roar_vio_calls * dst) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL_ALL; |
---|
| 82 | int roar_vio_shutdown(struct roar_vio_calls * vio, int how) _LIBROAR_ATTR_NONNULL_ALL; |
---|
[3769] | 83 | |
---|
[1252] | 84 | // converters: |
---|
[5242] | 85 | int roar_vio_open_file (struct roar_vio_calls * calls, const char * filename, int flags, mode_t mode) _LIBROAR_ATTR_DEPRECATED _LIBROAR_ATTR_NONNULL_ALL; |
---|
[5109] | 86 | int roar_vio_open_fh (struct roar_vio_calls * calls, int fh) _LIBROAR_ATTR_NONNULL_ALL; |
---|
| 87 | int roar_vio_open_fh_socket(struct roar_vio_calls * calls, int fh) _LIBROAR_ATTR_NONNULL_ALL; |
---|
[1275] | 88 | |
---|
[5109] | 89 | int roar_vio_open_socket (struct roar_vio_calls * calls, char * host, int port) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL_ALL; |
---|
| 90 | int roar_vio_open_socket_listen(struct roar_vio_calls * calls, int type, char * host, int port) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL_ALL; |
---|
[1291] | 91 | |
---|
[1275] | 92 | int roar_vio_simple_stream (struct roar_vio_calls * calls, int rate, int channels, int bits, int codec, |
---|
[5114] | 93 | const char * server, int dir, const char * name); |
---|
[1275] | 94 | |
---|
[2841] | 95 | int roar_vio_simple_new_stream_obj (struct roar_vio_calls * calls, |
---|
| 96 | struct roar_connection * con, |
---|
| 97 | struct roar_stream * s, |
---|
| 98 | int rate, int channels, int bits, int codec, int dir); |
---|
| 99 | |
---|
[881] | 100 | // possible VIOs: |
---|
| 101 | |
---|
| 102 | // basic |
---|
[1118] | 103 | ssize_t roar_vio_basic_read (struct roar_vio_calls * vio, void *buf, size_t count); |
---|
| 104 | ssize_t roar_vio_basic_write (struct roar_vio_calls * vio, void *buf, size_t count); |
---|
| 105 | off_t roar_vio_basic_lseek (struct roar_vio_calls * vio, off_t offset, int whence); |
---|
| 106 | int roar_vio_basic_nonblock(struct roar_vio_calls * vio, int state); |
---|
| 107 | int roar_vio_basic_sync (struct roar_vio_calls * vio); |
---|
[1505] | 108 | int roar_vio_basic_ctl (struct roar_vio_calls * vio, int cmd, void * data); |
---|
[1241] | 109 | int roar_vio_basic_close (struct roar_vio_calls * vio); |
---|
[881] | 110 | |
---|
[943] | 111 | // null |
---|
[1241] | 112 | // this is a read and write in one! |
---|
[943] | 113 | ssize_t roar_vio_null_rw (struct roar_vio_calls * vio, void *buf, size_t count); |
---|
[1665] | 114 | int roar_vio_null_sync (struct roar_vio_calls * vio); |
---|
[943] | 115 | |
---|
[886] | 116 | // pass |
---|
| 117 | |
---|
[1247] | 118 | int roar_vio_open_pass (struct roar_vio_calls * calls, struct roar_vio_calls * dst); |
---|
[1241] | 119 | ssize_t roar_vio_pass_read (struct roar_vio_calls * vio, void *buf, size_t count); |
---|
| 120 | ssize_t roar_vio_pass_write (struct roar_vio_calls * vio, void *buf, size_t count); |
---|
| 121 | off_t roar_vio_pass_lseek (struct roar_vio_calls * vio, off_t offset, int whence); |
---|
| 122 | int roar_vio_pass_nonblock(struct roar_vio_calls * vio, int state); |
---|
| 123 | int roar_vio_pass_sync (struct roar_vio_calls * vio); |
---|
| 124 | int roar_vio_pass_ctl (struct roar_vio_calls * vio, int cmd, void * data); |
---|
| 125 | int roar_vio_pass_close (struct roar_vio_calls * vio); |
---|
[886] | 126 | |
---|
| 127 | // re-read/write |
---|
| 128 | |
---|
[1247] | 129 | int roar_vio_open_re (struct roar_vio_calls * calls, struct roar_vio_calls * dst); |
---|
[886] | 130 | ssize_t roar_vio_re_read (struct roar_vio_calls * vio, void *buf, size_t count); |
---|
| 131 | ssize_t roar_vio_re_write(struct roar_vio_calls * vio, void *buf, size_t count); |
---|
| 132 | off_t roar_vio_re_lseek(struct roar_vio_calls * vio, off_t offset, int whence); |
---|
| 133 | |
---|
[588] | 134 | #endif |
---|
| 135 | |
---|
| 136 | //ll |
---|