source: roaraudio/include/libroar/vio.h @ 4532:d8414455cc04

Last change on this file since 4532:d8414455cc04 was 4532:d8414455cc04, checked in by phi, 13 years ago

added refc

File size: 5.8 KB
Line 
1//vio.h:
2
3/*
4 *      Copyright (C) Philipp 'ph3-der-loewe' Schafft - 2008-2010
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, 51 Franklin Street, Fifth Floor,
22 *  Boston, MA 02110-1301, USA.
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_H_
37#define _LIBROARVIO_H_
38
39#include "libroar.h"
40
41struct roar_connection;
42
43// sys io:
44
45struct roar_vio_calls {
46 void * inst;
47/*
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);
51*/
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);
57 int     (*ctl     )(struct roar_vio_calls * vio, int cmd, void * data);
58 int     (*close   )(struct roar_vio_calls * vio);
59 uint32_t flags;
60 size_t   refc;
61};
62
63int roar_vio_init_calls (struct roar_vio_calls * calls);
64
65int roar_vio_set_inst (struct roar_vio_calls * vio, void * inst);
66int roar_vio_set_fh   (struct roar_vio_calls * vio, int fh);
67
68int roar_vio_get_fh   (struct roar_vio_calls * vio);
69
70ssize_t roar_vio_read    (struct roar_vio_calls * vio, void *buf, size_t count);
71ssize_t roar_vio_write   (struct roar_vio_calls * vio, void *buf, size_t count);
72off_t   roar_vio_lseek   (struct roar_vio_calls * vio, off_t offset, int whence);
73int     roar_vio_nonblock(struct roar_vio_calls * vio, int state);
74int     roar_vio_sync    (struct roar_vio_calls * vio);
75int     roar_vio_ctl     (struct roar_vio_calls * vio, int cmd, void * data);
76int     roar_vio_close   (struct roar_vio_calls * vio);
77
78// specal commands:
79int     roar_vio_accept  (struct roar_vio_calls * calls, struct roar_vio_calls * dst);
80int     roar_vio_shutdown(struct roar_vio_calls * vio,   int how);
81
82// converters:
83int     roar_vio_open_file     (struct roar_vio_calls * calls, char * filename, int flags, mode_t mode);
84int     roar_vio_open_fh       (struct roar_vio_calls * calls, int fh);
85int     roar_vio_open_fh_socket(struct roar_vio_calls * calls, int fh);
86
87int     roar_vio_open_socket   (struct roar_vio_calls * calls, char * host, int port);
88int     roar_vio_open_socket_listen(struct roar_vio_calls * calls, int type, char * host, int port);
89
90int     roar_vio_simple_stream (struct roar_vio_calls * calls, int rate, int channels, int bits, int codec,
91                                                               char * server, int dir, char * name);
92
93int     roar_vio_simple_new_stream_obj (struct roar_vio_calls * calls,
94                                        struct roar_connection * con,
95                                        struct roar_stream * s,
96                                        int rate, int channels, int bits, int codec, int dir);
97
98// possible VIOs:
99
100// basic
101ssize_t roar_vio_basic_read    (struct roar_vio_calls * vio, void *buf, size_t count);
102ssize_t roar_vio_basic_write   (struct roar_vio_calls * vio, void *buf, size_t count);
103off_t   roar_vio_basic_lseek   (struct roar_vio_calls * vio, off_t offset, int whence);
104int     roar_vio_basic_nonblock(struct roar_vio_calls * vio, int state);
105int     roar_vio_basic_sync    (struct roar_vio_calls * vio);
106int     roar_vio_basic_ctl     (struct roar_vio_calls * vio, int cmd, void * data);
107int     roar_vio_basic_close   (struct roar_vio_calls * vio);
108
109// null
110// this is a read and write in one!
111ssize_t roar_vio_null_rw    (struct roar_vio_calls * vio, void *buf, size_t count);
112int     roar_vio_null_sync  (struct roar_vio_calls * vio);
113
114// pass
115
116int     roar_vio_open_pass    (struct roar_vio_calls * calls, struct roar_vio_calls * dst);
117ssize_t roar_vio_pass_read    (struct roar_vio_calls * vio, void *buf, size_t count);
118ssize_t roar_vio_pass_write   (struct roar_vio_calls * vio, void *buf, size_t count);
119off_t   roar_vio_pass_lseek   (struct roar_vio_calls * vio, off_t offset, int whence);
120int     roar_vio_pass_nonblock(struct roar_vio_calls * vio, int state);
121int     roar_vio_pass_sync    (struct roar_vio_calls * vio);
122int     roar_vio_pass_ctl     (struct roar_vio_calls * vio, int cmd, void * data);
123int     roar_vio_pass_close   (struct roar_vio_calls * vio);
124
125// re-read/write
126
127int     roar_vio_open_re (struct roar_vio_calls * calls, struct roar_vio_calls * dst);
128ssize_t roar_vio_re_read (struct roar_vio_calls * vio, void *buf, size_t count);
129ssize_t roar_vio_re_write(struct roar_vio_calls * vio, void *buf, size_t count);
130off_t   roar_vio_re_lseek(struct roar_vio_calls * vio, off_t offset, int whence);
131
132#endif
133
134//ll
Note: See TracBrowser for help on using the repository browser.