source: roaraudio/include/libroar/vio.h @ 3517:1a3218a3fc5b

Last change on this file since 3517:1a3218a3fc5b was 3517:1a3218a3fc5b, checked in by phi, 14 years ago

updated license headers, FSF moved office

File size: 5.6 KB
RevLine 
[1140]1//vio.h:
[588]2
[690]3/*
[1284]4 *      Copyright (C) Philipp 'ph3-der-loewe' Schafft - 2008, 2009
[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]41struct roar_connection;
42
[1140]43// sys io:
44
[589]45struct 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);
[589]59};
60
[591]61int roar_vio_init_calls (struct roar_vio_calls * calls);
62
[881]63int roar_vio_set_inst (struct roar_vio_calls * vio, void * inst);
64int roar_vio_set_fh   (struct roar_vio_calls * vio, int fh);
65
66int roar_vio_get_fh   (struct roar_vio_calls * vio);
67
[1118]68ssize_t roar_vio_read    (struct roar_vio_calls * vio, void *buf, size_t count);
69ssize_t roar_vio_write   (struct roar_vio_calls * vio, void *buf, size_t count);
70off_t   roar_vio_lseek   (struct roar_vio_calls * vio, off_t offset, int whence);
71int     roar_vio_nonblock(struct roar_vio_calls * vio, int state);
72int     roar_vio_sync    (struct roar_vio_calls * vio);
[1140]73int     roar_vio_ctl     (struct roar_vio_calls * vio, int cmd, void * data);
[1241]74int     roar_vio_close   (struct roar_vio_calls * vio);
[881]75
[1252]76// converters:
77int     roar_vio_open_file     (struct roar_vio_calls * calls, char * filename, int flags, mode_t mode);
78int     roar_vio_open_fh       (struct roar_vio_calls * calls, int fh);
[1290]79int     roar_vio_open_fh_socket(struct roar_vio_calls * calls, int fh);
[1275]80
[1291]81int     roar_vio_open_socket   (struct roar_vio_calls * calls, char * host, int port);
82int     roar_vio_open_socket_listen(struct roar_vio_calls * calls, int type, char * host, int port);
83
[1275]84int     roar_vio_simple_stream (struct roar_vio_calls * calls, int rate, int channels, int bits, int codec,
85                                                               char * server, int dir, char * name);
86
[2841]87int     roar_vio_simple_new_stream_obj (struct roar_vio_calls * calls,
88                                        struct roar_connection * con,
89                                        struct roar_stream * s,
90                                        int rate, int channels, int bits, int codec, int dir);
91
[881]92// possible VIOs:
93
94// basic
[1118]95ssize_t roar_vio_basic_read    (struct roar_vio_calls * vio, void *buf, size_t count);
96ssize_t roar_vio_basic_write   (struct roar_vio_calls * vio, void *buf, size_t count);
97off_t   roar_vio_basic_lseek   (struct roar_vio_calls * vio, off_t offset, int whence);
98int     roar_vio_basic_nonblock(struct roar_vio_calls * vio, int state);
99int     roar_vio_basic_sync    (struct roar_vio_calls * vio);
[1505]100int     roar_vio_basic_ctl     (struct roar_vio_calls * vio, int cmd, void * data);
[1241]101int     roar_vio_basic_close   (struct roar_vio_calls * vio);
[881]102
[943]103// null
[1241]104// this is a read and write in one!
[943]105ssize_t roar_vio_null_rw    (struct roar_vio_calls * vio, void *buf, size_t count);
[1665]106int     roar_vio_null_sync  (struct roar_vio_calls * vio);
[943]107
[886]108// pass
109
[1247]110int     roar_vio_open_pass    (struct roar_vio_calls * calls, struct roar_vio_calls * dst);
[1241]111ssize_t roar_vio_pass_read    (struct roar_vio_calls * vio, void *buf, size_t count);
112ssize_t roar_vio_pass_write   (struct roar_vio_calls * vio, void *buf, size_t count);
113off_t   roar_vio_pass_lseek   (struct roar_vio_calls * vio, off_t offset, int whence);
114int     roar_vio_pass_nonblock(struct roar_vio_calls * vio, int state);
115int     roar_vio_pass_sync    (struct roar_vio_calls * vio);
116int     roar_vio_pass_ctl     (struct roar_vio_calls * vio, int cmd, void * data);
117int     roar_vio_pass_close   (struct roar_vio_calls * vio);
[886]118
119// re-read/write
120
[1247]121int     roar_vio_open_re (struct roar_vio_calls * calls, struct roar_vio_calls * dst);
[886]122ssize_t roar_vio_re_read (struct roar_vio_calls * vio, void *buf, size_t count);
123ssize_t roar_vio_re_write(struct roar_vio_calls * vio, void *buf, size_t count);
124off_t   roar_vio_re_lseek(struct roar_vio_calls * vio, off_t offset, int whence);
125
[588]126#endif
127
128//ll
Note: See TracBrowser for help on using the repository browser.