[1140] | 1 | //vio.h: |
---|
[588] | 2 | |
---|
[690] | 3 | /* |
---|
[5381] | 4 | * Copyright (C) Philipp 'ph3-der-loewe' Schafft - 2008-2012 |
---|
[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 | |
---|
[5366] | 41 | // some defines: |
---|
| 42 | #define ROAR_VIOF_EXEC O_EXEC |
---|
| 43 | #define ROAR_VIOF_READ O_RDONLY |
---|
| 44 | #define ROAR_VIOF_WRITE O_WRONLY |
---|
| 45 | #define ROAR_VIOF_READWRITE O_RDWR |
---|
| 46 | #define ROAR_VIOF_SEARCH O_SEARCH |
---|
| 47 | #define ROAR_VIOF_LISTEN (-"") /* compiler error as long as there is no O_LISTEN */ |
---|
| 48 | |
---|
| 49 | #define ROAR_VIOF_CREAT O_CREAT |
---|
| 50 | #define ROAR_VIOF_TRUNC O_TRUNC |
---|
[5406] | 51 | |
---|
| 52 | #ifndef ROAR_TARGET_WIN32 |
---|
[5366] | 53 | #define ROAR_VIOF_NONBLOCK O_NONBLOCK |
---|
[5406] | 54 | #else |
---|
| 55 | #define ROAR_VIOF_NONBLOCK 0 |
---|
| 56 | #endif |
---|
[5366] | 57 | |
---|
[5378] | 58 | #define ROAR_VIO_FLAGS_NONE 0x00000000UL |
---|
[5388] | 59 | #define ROAR_VIO_FLAGS_FREESELF 0x00000001UL /* Free the VIO object */ |
---|
[5378] | 60 | |
---|
[2841] | 61 | struct roar_connection; |
---|
| 62 | |
---|
[1140] | 63 | // sys io: |
---|
| 64 | |
---|
[5278] | 65 | typedef int32_t roar_vio_ctl_t; |
---|
| 66 | typedef int_least64_t roar_off_t; |
---|
| 67 | |
---|
[589] | 68 | struct roar_vio_calls { |
---|
[5278] | 69 | size_t refc; |
---|
| 70 | uint32_t flags; |
---|
| 71 | void *inst; |
---|
| 72 | ssize_t (*read )(struct roar_vio_calls * vio, void *buf, size_t count); |
---|
| 73 | ssize_t (*write )(struct roar_vio_calls * vio, void *buf, size_t count); |
---|
| 74 | roar_off_t (*lseek )(struct roar_vio_calls * vio, roar_off_t offset, int whence); |
---|
| 75 | int (*sync )(struct roar_vio_calls * vio); |
---|
| 76 | int (*ctl )(struct roar_vio_calls * vio, roar_vio_ctl_t cmd, void * data); |
---|
| 77 | int (*close )(struct roar_vio_calls * vio); |
---|
[589] | 78 | }; |
---|
| 79 | |
---|
[4963] | 80 | int roar_vio_clear_calls (struct roar_vio_calls * calls); |
---|
| 81 | |
---|
[5109] | 82 | ssize_t roar_vio_read (struct roar_vio_calls * vio, void *buf, size_t count) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL_ALL; |
---|
| 83 | ssize_t roar_vio_write (struct roar_vio_calls * vio, void *buf, size_t count) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL_ALL; |
---|
[5278] | 84 | roar_off_t roar_vio_lseek (struct roar_vio_calls * vio, roar_off_t offset, int whence) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL_ALL; |
---|
[5109] | 85 | int roar_vio_nonblock(struct roar_vio_calls * vio, int state) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL_ALL; |
---|
| 86 | int roar_vio_sync (struct roar_vio_calls * vio) _LIBROAR_ATTR_NONNULL_ALL; |
---|
[5278] | 87 | int roar_vio_ctl (struct roar_vio_calls * vio, roar_vio_ctl_t cmd, void * data) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL(1); |
---|
[5388] | 88 | |
---|
| 89 | #define roar_vio_close(x) roar_vio_unref((x)) |
---|
| 90 | int roar_vio_ref (struct roar_vio_calls * vio) _LIBROAR_ATTR_NONNULL_ALL; |
---|
| 91 | int roar_vio_unref (struct roar_vio_calls * vio) _LIBROAR_ATTR_NONNULL_ALL; |
---|
[881] | 92 | |
---|
[3769] | 93 | // specal commands: |
---|
[5109] | 94 | int roar_vio_accept (struct roar_vio_calls * calls, struct roar_vio_calls * dst) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL_ALL; |
---|
| 95 | int roar_vio_shutdown(struct roar_vio_calls * vio, int how) _LIBROAR_ATTR_NONNULL_ALL; |
---|
[3769] | 96 | |
---|
[1252] | 97 | // converters: |
---|
[5109] | 98 | int roar_vio_open_fh (struct roar_vio_calls * calls, int fh) _LIBROAR_ATTR_NONNULL_ALL; |
---|
| 99 | int roar_vio_open_fh_socket(struct roar_vio_calls * calls, int fh) _LIBROAR_ATTR_NONNULL_ALL; |
---|
[1275] | 100 | |
---|
[5260] | 101 | int roar_vio_open_socket (struct roar_vio_calls * calls, const char * host, int port) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL_ALL; |
---|
| 102 | int roar_vio_open_socket_listen(struct roar_vio_calls * calls, int type, const char * host, int port) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL_ALL; |
---|
[1291] | 103 | |
---|
[5289] | 104 | int roar_vio_simple_stream (struct roar_vio_calls * calls, |
---|
| 105 | uint32_t rate, uint32_t channels, uint32_t bits, uint32_t codec, |
---|
| 106 | const char * server, int dir, const char * name, int mixer); |
---|
[1275] | 107 | |
---|
[2841] | 108 | int roar_vio_simple_new_stream_obj (struct roar_vio_calls * calls, |
---|
| 109 | struct roar_connection * con, |
---|
| 110 | struct roar_stream * s, |
---|
[5289] | 111 | uint32_t rate, uint32_t channels, uint32_t bits, uint32_t codec, |
---|
| 112 | int dir, int mixer); |
---|
[2841] | 113 | |
---|
[881] | 114 | // possible VIOs: |
---|
| 115 | |
---|
| 116 | // basic |
---|
[1118] | 117 | ssize_t roar_vio_basic_read (struct roar_vio_calls * vio, void *buf, size_t count); |
---|
| 118 | ssize_t roar_vio_basic_write (struct roar_vio_calls * vio, void *buf, size_t count); |
---|
[5278] | 119 | roar_off_t roar_vio_basic_lseek (struct roar_vio_calls * vio, roar_off_t offset, int whence); |
---|
[1118] | 120 | int roar_vio_basic_sync (struct roar_vio_calls * vio); |
---|
[5278] | 121 | int roar_vio_basic_ctl (struct roar_vio_calls * vio, roar_vio_ctl_t cmd, void * data); |
---|
[1241] | 122 | int roar_vio_basic_close (struct roar_vio_calls * vio); |
---|
[881] | 123 | |
---|
[943] | 124 | // null |
---|
[1241] | 125 | // this is a read and write in one! |
---|
[943] | 126 | ssize_t roar_vio_null_rw (struct roar_vio_calls * vio, void *buf, size_t count); |
---|
[1665] | 127 | int roar_vio_null_sync (struct roar_vio_calls * vio); |
---|
[943] | 128 | |
---|
[886] | 129 | // pass |
---|
| 130 | |
---|
[1247] | 131 | int roar_vio_open_pass (struct roar_vio_calls * calls, struct roar_vio_calls * dst); |
---|
[1241] | 132 | ssize_t roar_vio_pass_read (struct roar_vio_calls * vio, void *buf, size_t count); |
---|
| 133 | ssize_t roar_vio_pass_write (struct roar_vio_calls * vio, void *buf, size_t count); |
---|
[5278] | 134 | roar_off_t roar_vio_pass_lseek (struct roar_vio_calls * vio, roar_off_t offset, int whence); |
---|
[1241] | 135 | int roar_vio_pass_sync (struct roar_vio_calls * vio); |
---|
[5278] | 136 | int roar_vio_pass_ctl (struct roar_vio_calls * vio, roar_vio_ctl_t cmd, void * data); |
---|
[1241] | 137 | int roar_vio_pass_close (struct roar_vio_calls * vio); |
---|
[886] | 138 | |
---|
| 139 | // re-read/write |
---|
| 140 | |
---|
[1247] | 141 | int roar_vio_open_re (struct roar_vio_calls * calls, struct roar_vio_calls * dst); |
---|
[886] | 142 | ssize_t roar_vio_re_read (struct roar_vio_calls * vio, void *buf, size_t count); |
---|
| 143 | ssize_t roar_vio_re_write(struct roar_vio_calls * vio, void *buf, size_t count); |
---|
[5278] | 144 | roar_off_t roar_vio_re_lseek(struct roar_vio_calls * vio, roar_off_t offset, int whence); |
---|
[886] | 145 | |
---|
[588] | 146 | #endif |
---|
| 147 | |
---|
| 148 | //ll |
---|