source: roaraudio/include/libroar/vio.h @ 1291:ba7f52e15690

Last change on this file since 1291:ba7f52e15690 was 1291:ba7f52e15690, checked in by phi, 15 years ago

added roar_vio_open_socket() and useless roar_vio_open_socket_listen()
File size: 6.4 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// CTLs:
41/*
42 * 0xAAAABBBB
43 * AAAA:
44 *   0x0001 -> Basic stream calls
45 *   0x0002 -> Driver calls
46 *
47 * BBBB:
48 *   0x0XXX -> Client
49 *   0x1XXX -> Server
50 */
51// stream:
52#define ROAR_VIO_CTL_SET_STREAM    0x00010001 /* normal streams */
53#define ROAR_VIO_CTL_GET_STREAM    0x00010002
54
55#define ROAR_VIO_CTL_SET_SSTREAM   0x00011001 /* server streams */
56#define ROAR_VIO_CTL_GET_SSTREAM   0x00011002
57
58#define ROAR_VIO_CTL_GET_DELAY     0x00010011 /* return in bytes as the vio interface */
59                                              /* does not know anything about streams */
60
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
65// sys io:
66
67struct roar_vio_calls {
68 void * inst;
69/*
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);
73*/
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);
79 int     (*ctl     )(struct roar_vio_calls * vio, int cmd, void * data);
80 int     (*close   )(struct roar_vio_calls * vio);
81};
82
83int roar_vio_init_calls (struct roar_vio_calls * calls);
84
85int roar_vio_set_inst (struct roar_vio_calls * vio, void * inst);
86int roar_vio_set_fh   (struct roar_vio_calls * vio, int fh);
87
88int roar_vio_get_fh   (struct roar_vio_calls * vio);
89
90ssize_t roar_vio_read    (struct roar_vio_calls * vio, void *buf, size_t count);
91ssize_t roar_vio_write   (struct roar_vio_calls * vio, void *buf, size_t count);
92off_t   roar_vio_lseek   (struct roar_vio_calls * vio, off_t offset, int whence);
93int     roar_vio_nonblock(struct roar_vio_calls * vio, int state);
94int     roar_vio_sync    (struct roar_vio_calls * vio);
95int     roar_vio_ctl     (struct roar_vio_calls * vio, int cmd, void * data);
96int     roar_vio_close   (struct roar_vio_calls * vio);
97
98// converters:
99int     roar_vio_open_file     (struct roar_vio_calls * calls, char * filename, int flags, mode_t mode);
100int     roar_vio_open_fh       (struct roar_vio_calls * calls, int fh);
101int     roar_vio_open_fh_socket(struct roar_vio_calls * calls, int fh);
102
103int     roar_vio_open_socket   (struct roar_vio_calls * calls, char * host, int port);
104int     roar_vio_open_socket_listen(struct roar_vio_calls * calls, int type, char * host, int port);
105
106int     roar_vio_simple_stream (struct roar_vio_calls * calls, int rate, int channels, int bits, int codec,
107                                                               char * server, int dir, char * name);
108
109int     roar_vio_open_stdio    (struct roar_vio_calls * calls, FILE * dst);
110
111FILE *  roar_vio_to_stdio      (struct roar_vio_calls * calls, int flags);
112
113
114// possible VIOs:
115
116// basic
117ssize_t roar_vio_basic_read    (struct roar_vio_calls * vio, void *buf, size_t count);
118ssize_t roar_vio_basic_write   (struct roar_vio_calls * vio, void *buf, size_t count);
119off_t   roar_vio_basic_lseek   (struct roar_vio_calls * vio, off_t offset, int whence);
120int     roar_vio_basic_nonblock(struct roar_vio_calls * vio, int state);
121int     roar_vio_basic_sync    (struct roar_vio_calls * vio);
122int     roar_vio_basic_close   (struct roar_vio_calls * vio);
123
124// null
125// this is a read and write in one!
126ssize_t roar_vio_null_rw    (struct roar_vio_calls * vio, void *buf, size_t count);
127
128// pass
129
130int     roar_vio_open_pass    (struct roar_vio_calls * calls, struct roar_vio_calls * dst);
131ssize_t roar_vio_pass_read    (struct roar_vio_calls * vio, void *buf, size_t count);
132ssize_t roar_vio_pass_write   (struct roar_vio_calls * vio, void *buf, size_t count);
133off_t   roar_vio_pass_lseek   (struct roar_vio_calls * vio, off_t offset, int whence);
134int     roar_vio_pass_nonblock(struct roar_vio_calls * vio, int state);
135int     roar_vio_pass_sync    (struct roar_vio_calls * vio);
136int     roar_vio_pass_ctl     (struct roar_vio_calls * vio, int cmd, void * data);
137int     roar_vio_pass_close   (struct roar_vio_calls * vio);
138
139// re-read/write
140
141int     roar_vio_open_re (struct roar_vio_calls * calls, struct roar_vio_calls * dst);
142ssize_t roar_vio_re_read (struct roar_vio_calls * vio, void *buf, size_t count);
143ssize_t roar_vio_re_write(struct roar_vio_calls * vio, void *buf, size_t count);
144off_t   roar_vio_re_lseek(struct roar_vio_calls * vio, off_t offset, int whence);
145
146// stdio
147ssize_t roar_vio_stdio_read    (struct roar_vio_calls * vio, void *buf, size_t count);
148ssize_t roar_vio_stdio_write   (struct roar_vio_calls * vio, void *buf, size_t count);
149off_t   roar_vio_stdio_lseek   (struct roar_vio_calls * vio, off_t offset, int whence);
150int     roar_vio_stdio_sync    (struct roar_vio_calls * vio);
151int     roar_vio_stdio_close   (struct roar_vio_calls * vio);
152
153#endif
154
155//ll
Note: See TracBrowser for help on using the repository browser.