source: roaraudio/include/libroar/vio.h @ 2058:6678cfcaacc6

Last change on this file since 2058:6678cfcaacc6 was 2058:6678cfcaacc6, checked in by phi, 15 years ago

moved the vio ctl #defines out of the vio header
File size: 7.3 KB
Line 
1//vio.h:
2
3/*
4 *      Copyright (C) Philipp 'ph3-der-loewe' Schafft - 2008, 2009
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
35#ifndef _LIBROARVIO_H_
36#define _LIBROARVIO_H_
37
38#include "libroar.h"
39
40// sys io:
41
42struct roar_vio_calls {
43 void * inst;
44/*
45 ssize_t (*read) (int fd, void *buf, size_t count, void * inst);
46 ssize_t (*write)(int fd, void *buf, size_t count, void * inst);
47 off_t   (*lseek)(int fildes, off_t offset, int whence, void * inst);
48*/
49 ssize_t (*read    )(struct roar_vio_calls * vio, void *buf, size_t count);
50 ssize_t (*write   )(struct roar_vio_calls * vio, void *buf, size_t count);
51 off_t   (*lseek   )(struct roar_vio_calls * vio, off_t offset, int whence);
52 int     (*nonblock)(struct roar_vio_calls * vio, int state);
53 int     (*sync    )(struct roar_vio_calls * vio);
54 int     (*ctl     )(struct roar_vio_calls * vio, int cmd, void * data);
55 int     (*close   )(struct roar_vio_calls * vio);
56};
57
58int roar_vio_init_calls (struct roar_vio_calls * calls);
59
60int roar_vio_set_inst (struct roar_vio_calls * vio, void * inst);
61int roar_vio_set_fh   (struct roar_vio_calls * vio, int fh);
62
63int roar_vio_get_fh   (struct roar_vio_calls * vio);
64
65ssize_t roar_vio_read    (struct roar_vio_calls * vio, void *buf, size_t count);
66ssize_t roar_vio_write   (struct roar_vio_calls * vio, void *buf, size_t count);
67off_t   roar_vio_lseek   (struct roar_vio_calls * vio, off_t offset, int whence);
68int     roar_vio_nonblock(struct roar_vio_calls * vio, int state);
69int     roar_vio_sync    (struct roar_vio_calls * vio);
70int     roar_vio_ctl     (struct roar_vio_calls * vio, int cmd, void * data);
71int     roar_vio_close   (struct roar_vio_calls * vio);
72
73// some alias functions:
74#define roar_vio_puts(vio,s) roar_vio_write((vio), (s), strlen((s)))
75//#define roar_vio_putc(vio,c) roar_vio_write((vio), &(c), 1)
76int     roar_vio_putc    (struct roar_vio_calls * vio, char c);
77int     roar_vio_getc    (struct roar_vio_calls * vio);
78
79int     roar_vio_printf  (struct roar_vio_calls * vio, const char *format, ...);
80
81// converters:
82int     roar_vio_open_file     (struct roar_vio_calls * calls, char * filename, int flags, mode_t mode);
83int     roar_vio_open_fh       (struct roar_vio_calls * calls, int fh);
84int     roar_vio_open_fh_socket(struct roar_vio_calls * calls, int fh);
85
86int     roar_vio_open_socket   (struct roar_vio_calls * calls, char * host, int port);
87int     roar_vio_open_socket_listen(struct roar_vio_calls * calls, int type, char * host, int port);
88
89int     roar_vio_simple_stream (struct roar_vio_calls * calls, int rate, int channels, int bits, int codec,
90                                                               char * server, int dir, char * name);
91
92int     roar_vio_open_stdio    (struct roar_vio_calls * calls, FILE * dst);
93
94FILE *  roar_vio_to_stdio      (struct roar_vio_calls * calls, int flags);
95#if defined(ROAR_HAVE_FOPENCOOKIE) || defined(ROAR_HAVE_FUNOPEN)
96int roar_vio_to_stdio_close (void *__cookie);
97#endif
98#if defined(ROAR_HAVE_FOPENCOOKIE)
99__ssize_t roar_vio_to_stdio_read (void *__cookie, char *__buf, size_t __nbytes);
100__ssize_t roar_vio_to_stdio_write (void *__cookie, __const char *__buf, size_t __n);
101int roar_vio_to_stdio_lseek (void *__cookie, _IO_off64_t *__pos, int __w);
102#elif defined(ROAR_HAVE_FUNOPEN)
103int roar_vio_to_stdio_read(void *__cookie, char *__buf, int __nbytes);
104int roar_vio_to_stdio_write(void *__cookie, const char *__buf, int __n);
105fpos_t roar_vio_to_stdio_lseek(void *__cookie, fpos_t __pos, int __w);
106#endif
107
108
109// possible VIOs:
110
111// basic
112ssize_t roar_vio_basic_read    (struct roar_vio_calls * vio, void *buf, size_t count);
113ssize_t roar_vio_basic_write   (struct roar_vio_calls * vio, void *buf, size_t count);
114off_t   roar_vio_basic_lseek   (struct roar_vio_calls * vio, off_t offset, int whence);
115int     roar_vio_basic_nonblock(struct roar_vio_calls * vio, int state);
116int     roar_vio_basic_sync    (struct roar_vio_calls * vio);
117int     roar_vio_basic_ctl     (struct roar_vio_calls * vio, int cmd, void * data);
118int     roar_vio_basic_close   (struct roar_vio_calls * vio);
119
120#ifdef ROAR_TARGET_WIN32
121ssize_t roar_vio_winsock_read    (struct roar_vio_calls * vio, void *buf, size_t count);
122ssize_t roar_vio_winsock_write   (struct roar_vio_calls * vio, void *buf, size_t count);
123int     roar_vio_winsock_nonblock(struct roar_vio_calls * vio, int state);
124int     roar_vio_winsock_sync    (struct roar_vio_calls * vio);
125int     roar_vio_winsock_ctl     (struct roar_vio_calls * vio, int cmd, void * data);
126int     roar_vio_winsock_close   (struct roar_vio_calls * vio);
127#endif
128
129// null
130// this is a read and write in one!
131ssize_t roar_vio_null_rw    (struct roar_vio_calls * vio, void *buf, size_t count);
132int     roar_vio_null_sync  (struct roar_vio_calls * vio);
133
134// pass
135
136int     roar_vio_open_pass    (struct roar_vio_calls * calls, struct roar_vio_calls * dst);
137ssize_t roar_vio_pass_read    (struct roar_vio_calls * vio, void *buf, size_t count);
138ssize_t roar_vio_pass_write   (struct roar_vio_calls * vio, void *buf, size_t count);
139off_t   roar_vio_pass_lseek   (struct roar_vio_calls * vio, off_t offset, int whence);
140int     roar_vio_pass_nonblock(struct roar_vio_calls * vio, int state);
141int     roar_vio_pass_sync    (struct roar_vio_calls * vio);
142int     roar_vio_pass_ctl     (struct roar_vio_calls * vio, int cmd, void * data);
143int     roar_vio_pass_close   (struct roar_vio_calls * vio);
144
145// re-read/write
146
147int     roar_vio_open_re (struct roar_vio_calls * calls, struct roar_vio_calls * dst);
148ssize_t roar_vio_re_read (struct roar_vio_calls * vio, void *buf, size_t count);
149ssize_t roar_vio_re_write(struct roar_vio_calls * vio, void *buf, size_t count);
150off_t   roar_vio_re_lseek(struct roar_vio_calls * vio, off_t offset, int whence);
151
152// stdio
153ssize_t roar_vio_stdio_read    (struct roar_vio_calls * vio, void *buf, size_t count);
154ssize_t roar_vio_stdio_write   (struct roar_vio_calls * vio, void *buf, size_t count);
155off_t   roar_vio_stdio_lseek   (struct roar_vio_calls * vio, off_t offset, int whence);
156int     roar_vio_stdio_sync    (struct roar_vio_calls * vio);
157int     roar_vio_stdio_ctl     (struct roar_vio_calls * vio, int cmd, void * data);
158int     roar_vio_stdio_close   (struct roar_vio_calls * vio);
159
160#endif
161
162//ll
Note: See TracBrowser for help on using the repository browser.