1 | //buffer.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 _LIBROAR_BUFFER_H_ |
---|
37 | #define _LIBROAR_BUFFER_H_ |
---|
38 | |
---|
39 | #include <roaraudio.h> |
---|
40 | |
---|
41 | #define ROAR_BUFFER_FLAG_NONE 0x00 |
---|
42 | #define ROAR_BUFFER_FLAG_NOFREE 0x01 |
---|
43 | #define ROAR_BUFFER_FLAG_RING 0x02 |
---|
44 | #define ROAR_BUFFER_FLAG_FREE_RUNNING 0x04 |
---|
45 | |
---|
46 | // for memory corruption detection: |
---|
47 | #define ROAR_BUFFER_FLAG_USEABLE 0x40 |
---|
48 | #define ROAR_BUFFER_FLAG_FREED 0x80 |
---|
49 | |
---|
50 | #define ROAR_BUFFER_SET 0 |
---|
51 | #define ROAR_BUFFER_RESET 1 |
---|
52 | |
---|
53 | #define _LIBROAR_BUFFER_STDATTRS _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL_ALL |
---|
54 | |
---|
55 | struct roar_buffer; |
---|
56 | |
---|
57 | struct roar_buffer_stats { |
---|
58 | size_t parts; |
---|
59 | size_t bytes; |
---|
60 | size_t memory_usage; |
---|
61 | }; |
---|
62 | |
---|
63 | #define roar_buffer_new(a,len) roar_buffer_new_data((a), (len), NULL) |
---|
64 | |
---|
65 | #define roar_buffer_free(x) roar_buffer_unref(x) |
---|
66 | |
---|
67 | #define roar_buffer_foreach(cur) for (; (cur) != NULL; (cur) = (roar_buffer_next(&(cur)) == -1) ? NULL : (cur)) |
---|
68 | |
---|
69 | int roar_buffer_new_no_ma(struct roar_buffer ** buf, size_t len, void * data) _LIBROAR_BUFFER_STDATTRS; // no internal malloc |
---|
70 | int roar_buffer_delete (struct roar_buffer * buf, struct roar_buffer ** next) _LIBROAR_BUFFER_STDATTRS; |
---|
71 | int roar_buffer_next (struct roar_buffer ** buf) _LIBROAR_BUFFER_STDATTRS; |
---|
72 | int roar_buffer_add (struct roar_buffer * buf, struct roar_buffer * next) _LIBROAR_BUFFER_STDATTRS; |
---|
73 | int roar_buffer_moveinto (struct roar_buffer * buf, struct roar_buffer ** next) _LIBROAR_BUFFER_STDATTRS; |
---|
74 | int roar_buffer_moveintoqueue(struct roar_buffer ** buf, struct roar_buffer ** next) _LIBROAR_BUFFER_STDATTRS; |
---|
75 | |
---|
76 | int roar_buffer_ref (struct roar_buffer * buf) _LIBROAR_ATTR_NONNULL_ALL; |
---|
77 | int roar_buffer_unref (struct roar_buffer * buf) _LIBROAR_ATTR_NONNULL_ALL; |
---|
78 | |
---|
79 | int roar_buffer_new_data (struct roar_buffer ** buf, size_t len, void ** data) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL(1); |
---|
80 | |
---|
81 | int roar_buffer_ring_new (struct roar_buffer ** buf, size_t len, int free_running) _LIBROAR_BUFFER_STDATTRS; |
---|
82 | |
---|
83 | int roar_buffer_get_next (struct roar_buffer * buf, struct roar_buffer ** next) _LIBROAR_BUFFER_STDATTRS; |
---|
84 | |
---|
85 | int roar_buffer_get_data (struct roar_buffer * buf, void ** data) _LIBROAR_BUFFER_STDATTRS; |
---|
86 | int roar_buffer_get_datalen(struct roar_buffer * buf, void ** data, size_t * len) _LIBROAR_BUFFER_STDATTRS; |
---|
87 | |
---|
88 | int roar_buffer_set_offset (struct roar_buffer * buf, size_t off) _LIBROAR_BUFFER_STDATTRS; |
---|
89 | |
---|
90 | int roar_buffer_shift_out (struct roar_buffer ** buf, void * data, size_t * len) _LIBROAR_BUFFER_STDATTRS; |
---|
91 | |
---|
92 | int roar_buffer_set_meta (struct roar_buffer * buf, void * meta) _LIBROAR_BUFFER_STDATTRS; |
---|
93 | int roar_buffer_get_meta (struct roar_buffer * buf, void ** meta) _LIBROAR_BUFFER_STDATTRS; |
---|
94 | int roar_buffer_set_meta_i32(struct roar_buffer * buf, int32_t meta) _LIBROAR_BUFFER_STDATTRS; |
---|
95 | int roar_buffer_get_meta_i32(struct roar_buffer * buf, int32_t * meta) _LIBROAR_BUFFER_STDATTRS; |
---|
96 | |
---|
97 | int roar_buffer_set_type (struct roar_buffer * buf, int type) _LIBROAR_BUFFER_STDATTRS; |
---|
98 | int roar_buffer_get_type (struct roar_buffer * buf, int * type) _LIBROAR_BUFFER_STDATTRS; |
---|
99 | |
---|
100 | int roar_buffer_set_len (struct roar_buffer * buf, size_t len) _LIBROAR_BUFFER_STDATTRS; |
---|
101 | int roar_buffer_get_len (struct roar_buffer * buf, size_t * len) _LIBROAR_BUFFER_STDATTRS; |
---|
102 | |
---|
103 | int roar_buffer_set_flag (struct roar_buffer * buf, int flag, int reset) _LIBROAR_BUFFER_STDATTRS; |
---|
104 | int roar_buffer_get_flag (struct roar_buffer * buf, int flag) _LIBROAR_BUFFER_STDATTRS; |
---|
105 | |
---|
106 | int roar_buffer_duplicate (struct roar_buffer * buf, struct roar_buffer ** copy) _LIBROAR_BUFFER_STDATTRS; |
---|
107 | |
---|
108 | int roar_buffer_ring_stats (struct roar_buffer * buf, struct roar_buffer_stats * stats) _LIBROAR_BUFFER_STDATTRS; |
---|
109 | |
---|
110 | int roar_buffer_ring_read (struct roar_buffer * buf, void * data, size_t * len) _LIBROAR_BUFFER_STDATTRS; |
---|
111 | int roar_buffer_ring_write (struct roar_buffer * buf, void * data, size_t * len) _LIBROAR_BUFFER_STDATTRS; |
---|
112 | |
---|
113 | int roar_buffer_ring_avail(struct roar_buffer * buf, size_t * readlen, size_t * writelen) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL(1); |
---|
114 | |
---|
115 | int roar_buffer_ring_reset(struct roar_buffer * buf) _LIBROAR_BUFFER_STDATTRS; |
---|
116 | |
---|
117 | #endif |
---|
118 | |
---|
119 | //ll |
---|