source: roaraudio/include/libroar/vio.h @ 5388:e5cc8e03a3e1

Last change on this file since 5388:e5cc8e03a3e1 was 5388:e5cc8e03a3e1, checked in by phi, 12 years ago

Added support for refcount based VIOs as well as dynamically allocated VIOs (non-stack or global VIOs) (Closes: #127)
File size: 6.6 KB
Line 
1//vio.h:
2
3/*
4 *      Copyright (C) Philipp 'ph3-der-loewe' Schafft - 2008-2012
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
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
51#define ROAR_VIOF_NONBLOCK  O_NONBLOCK
52
53#define ROAR_VIO_FLAGS_NONE        0x00000000UL
54#define ROAR_VIO_FLAGS_FREESELF    0x00000001UL /* Free the VIO object */
55
56struct roar_connection;
57
58// sys io:
59
60typedef int32_t       roar_vio_ctl_t;
61typedef int_least64_t roar_off_t;
62
63struct roar_vio_calls {
64 size_t           refc;
65 uint32_t         flags;
66 void            *inst;
67 ssize_t        (*read    )(struct roar_vio_calls * vio, void *buf, size_t count);
68 ssize_t        (*write   )(struct roar_vio_calls * vio, void *buf, size_t count);
69 roar_off_t     (*lseek   )(struct roar_vio_calls * vio, roar_off_t offset, int whence);
70 int            (*sync    )(struct roar_vio_calls * vio);
71 int            (*ctl     )(struct roar_vio_calls * vio, roar_vio_ctl_t cmd, void * data);
72 int            (*close   )(struct roar_vio_calls * vio);
73};
74
75int roar_vio_clear_calls (struct roar_vio_calls * calls);
76
77ssize_t roar_vio_read    (struct roar_vio_calls * vio, void *buf, size_t count) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL_ALL;
78ssize_t roar_vio_write   (struct roar_vio_calls * vio, void *buf, size_t count) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL_ALL;
79roar_off_t   roar_vio_lseek   (struct roar_vio_calls * vio, roar_off_t offset, int whence) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL_ALL;
80int     roar_vio_nonblock(struct roar_vio_calls * vio, int state) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL_ALL;
81int     roar_vio_sync    (struct roar_vio_calls * vio) _LIBROAR_ATTR_NONNULL_ALL;
82int     roar_vio_ctl     (struct roar_vio_calls * vio, roar_vio_ctl_t cmd, void * data) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL(1);
83
84#define roar_vio_close(x) roar_vio_unref((x))
85int     roar_vio_ref     (struct roar_vio_calls * vio) _LIBROAR_ATTR_NONNULL_ALL;
86int     roar_vio_unref   (struct roar_vio_calls * vio) _LIBROAR_ATTR_NONNULL_ALL;
87
88// specal commands:
89int     roar_vio_accept  (struct roar_vio_calls * calls, struct roar_vio_calls * dst) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL_ALL;
90int     roar_vio_shutdown(struct roar_vio_calls * vio,   int how) _LIBROAR_ATTR_NONNULL_ALL;
91
92// converters:
93int     roar_vio_open_fh       (struct roar_vio_calls * calls, int fh) _LIBROAR_ATTR_NONNULL_ALL;
94int     roar_vio_open_fh_socket(struct roar_vio_calls * calls, int fh) _LIBROAR_ATTR_NONNULL_ALL;
95
96int     roar_vio_open_socket   (struct roar_vio_calls * calls, const char * host, int port) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL_ALL;
97int     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;
98
99int     roar_vio_simple_stream (struct roar_vio_calls * calls,
100                                uint32_t rate, uint32_t channels, uint32_t bits, uint32_t codec,
101                                const char * server, int dir, const char * name, int mixer);
102
103int     roar_vio_simple_new_stream_obj (struct roar_vio_calls * calls,
104                                        struct roar_connection * con,
105                                        struct roar_stream * s,
106                                        uint32_t rate, uint32_t channels, uint32_t bits, uint32_t codec,
107                                        int dir, int mixer);
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);
114roar_off_t   roar_vio_basic_lseek   (struct roar_vio_calls * vio, roar_off_t offset, int whence);
115int     roar_vio_basic_sync    (struct roar_vio_calls * vio);
116int     roar_vio_basic_ctl     (struct roar_vio_calls * vio, roar_vio_ctl_t cmd, void * data);
117int     roar_vio_basic_close   (struct roar_vio_calls * vio);
118
119// null
120// this is a read and write in one!
121ssize_t roar_vio_null_rw    (struct roar_vio_calls * vio, void *buf, size_t count);
122int     roar_vio_null_sync  (struct roar_vio_calls * vio);
123
124// pass
125
126int     roar_vio_open_pass    (struct roar_vio_calls * calls, struct roar_vio_calls * dst);
127ssize_t roar_vio_pass_read    (struct roar_vio_calls * vio, void *buf, size_t count);
128ssize_t roar_vio_pass_write   (struct roar_vio_calls * vio, void *buf, size_t count);
129roar_off_t   roar_vio_pass_lseek   (struct roar_vio_calls * vio, roar_off_t offset, int whence);
130int     roar_vio_pass_sync    (struct roar_vio_calls * vio);
131int     roar_vio_pass_ctl     (struct roar_vio_calls * vio, roar_vio_ctl_t cmd, void * data);
132int     roar_vio_pass_close   (struct roar_vio_calls * vio);
133
134// re-read/write
135
136int     roar_vio_open_re (struct roar_vio_calls * calls, struct roar_vio_calls * dst);
137ssize_t roar_vio_re_read (struct roar_vio_calls * vio, void *buf, size_t count);
138ssize_t roar_vio_re_write(struct roar_vio_calls * vio, void *buf, size_t count);
139roar_off_t   roar_vio_re_lseek(struct roar_vio_calls * vio, roar_off_t offset, int whence);
140
141#endif
142
143//ll
Note: See TracBrowser for help on using the repository browser.