[0] | 1 | //buffer.h: |
---|
| 2 | |
---|
[690] | 3 | /* |
---|
[5381] | 4 | * Copyright (C) Philipp 'ph3-der-loewe' Schafft - 2008-2012 |
---|
[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 | |
---|
[0] | 36 | #ifndef _LIBROAR_BUFFER_H_ |
---|
| 37 | #define _LIBROAR_BUFFER_H_ |
---|
| 38 | |
---|
| 39 | #include <roaraudio.h> |
---|
| 40 | |
---|
[3022] | 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 |
---|
[1215] | 45 | |
---|
[5011] | 46 | // for memory corruption detection: |
---|
| 47 | #define ROAR_BUFFER_FLAG_USEABLE 0x40 |
---|
| 48 | #define ROAR_BUFFER_FLAG_FREED 0x80 |
---|
| 49 | |
---|
[3022] | 50 | #define ROAR_BUFFER_SET 0 |
---|
| 51 | #define ROAR_BUFFER_RESET 1 |
---|
| 52 | |
---|
[5109] | 53 | #define _LIBROAR_BUFFER_STDATTRS _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL_ALL |
---|
| 54 | |
---|
[4516] | 55 | struct roar_buffer; |
---|
| 56 | |
---|
| 57 | struct roar_buffer_stats { |
---|
| 58 | size_t parts; |
---|
| 59 | size_t bytes; |
---|
| 60 | size_t memory_usage; |
---|
[3022] | 61 | }; |
---|
[1215] | 62 | |
---|
[4516] | 63 | #define roar_buffer_new(a,len) roar_buffer_new_data((a), (len), NULL) |
---|
[7] | 64 | |
---|
[4522] | 65 | #define roar_buffer_free(x) roar_buffer_unref(x) |
---|
| 66 | |
---|
[5348] | 67 | #define roar_buffer_foreach(cur) for (; (cur) != NULL; (cur) = (roar_buffer_next(&(cur)) == -1) ? NULL : (cur)) |
---|
[5302] | 68 | |
---|
[5109] | 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; |
---|
[5298] | 71 | int roar_buffer_next (struct roar_buffer ** buf) _LIBROAR_BUFFER_STDATTRS; |
---|
[5109] | 72 | int roar_buffer_add (struct roar_buffer * buf, struct roar_buffer * next) _LIBROAR_BUFFER_STDATTRS; |
---|
[5299] | 73 | int roar_buffer_moveinto (struct roar_buffer * buf, struct roar_buffer ** next) _LIBROAR_BUFFER_STDATTRS; |
---|
[0] | 74 | |
---|
[5109] | 75 | int roar_buffer_ref (struct roar_buffer * buf) _LIBROAR_ATTR_NONNULL_ALL; |
---|
| 76 | int roar_buffer_unref (struct roar_buffer * buf) _LIBROAR_ATTR_NONNULL_ALL; |
---|
[4522] | 77 | |
---|
[5109] | 78 | int roar_buffer_new_data (struct roar_buffer ** buf, size_t len, void ** data) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL(1); |
---|
[3764] | 79 | |
---|
[5109] | 80 | int roar_buffer_ring_new (struct roar_buffer ** buf, size_t len, int free_running) _LIBROAR_BUFFER_STDATTRS; |
---|
[3022] | 81 | |
---|
[5109] | 82 | int roar_buffer_get_next (struct roar_buffer * buf, struct roar_buffer ** next) _LIBROAR_BUFFER_STDATTRS; |
---|
[0] | 83 | |
---|
[5352] | 84 | int roar_buffer_get_data (struct roar_buffer * buf, void ** data) _LIBROAR_BUFFER_STDATTRS; |
---|
| 85 | int roar_buffer_get_datalen(struct roar_buffer * buf, void ** data, size_t * len) _LIBROAR_BUFFER_STDATTRS; |
---|
[0] | 86 | |
---|
[5109] | 87 | int roar_buffer_set_offset (struct roar_buffer * buf, size_t off) _LIBROAR_BUFFER_STDATTRS; |
---|
[0] | 88 | |
---|
[5109] | 89 | int roar_buffer_shift_out (struct roar_buffer ** buf, void * data, size_t * len) _LIBROAR_BUFFER_STDATTRS; |
---|
[904] | 90 | |
---|
[5109] | 91 | int roar_buffer_set_meta (struct roar_buffer * buf, void * meta) _LIBROAR_BUFFER_STDATTRS; |
---|
| 92 | int roar_buffer_get_meta (struct roar_buffer * buf, void ** meta) _LIBROAR_BUFFER_STDATTRS; |
---|
| 93 | int roar_buffer_set_meta_i32(struct roar_buffer * buf, int32_t meta) _LIBROAR_BUFFER_STDATTRS; |
---|
| 94 | int roar_buffer_get_meta_i32(struct roar_buffer * buf, int32_t * meta) _LIBROAR_BUFFER_STDATTRS; |
---|
[0] | 95 | |
---|
[5109] | 96 | int roar_buffer_set_type (struct roar_buffer * buf, int type) _LIBROAR_BUFFER_STDATTRS; |
---|
| 97 | int roar_buffer_get_type (struct roar_buffer * buf, int * type) _LIBROAR_BUFFER_STDATTRS; |
---|
[4901] | 98 | |
---|
[5109] | 99 | int roar_buffer_set_len (struct roar_buffer * buf, size_t len) _LIBROAR_BUFFER_STDATTRS; |
---|
| 100 | int roar_buffer_get_len (struct roar_buffer * buf, size_t * len) _LIBROAR_BUFFER_STDATTRS; |
---|
[0] | 101 | |
---|
[5109] | 102 | int roar_buffer_set_flag (struct roar_buffer * buf, int flag, int reset) _LIBROAR_BUFFER_STDATTRS; |
---|
| 103 | int roar_buffer_get_flag (struct roar_buffer * buf, int flag) _LIBROAR_BUFFER_STDATTRS; |
---|
[1215] | 104 | |
---|
[5109] | 105 | int roar_buffer_duplicate (struct roar_buffer * buf, struct roar_buffer ** copy) _LIBROAR_BUFFER_STDATTRS; |
---|
[46] | 106 | |
---|
[5109] | 107 | int roar_buffer_ring_stats (struct roar_buffer * buf, struct roar_buffer_stats * stats) _LIBROAR_BUFFER_STDATTRS; |
---|
[7] | 108 | |
---|
[5109] | 109 | int roar_buffer_ring_read (struct roar_buffer * buf, void * data, size_t * len) _LIBROAR_BUFFER_STDATTRS; |
---|
| 110 | int roar_buffer_ring_write (struct roar_buffer * buf, void * data, size_t * len) _LIBROAR_BUFFER_STDATTRS; |
---|
[3022] | 111 | |
---|
[5109] | 112 | int roar_buffer_ring_avail(struct roar_buffer * buf, size_t * readlen, size_t * writelen) _LIBROAR_ATTR_USE_RESULT _LIBROAR_ATTR_NONNULL(1); |
---|
[4625] | 113 | |
---|
[5109] | 114 | int roar_buffer_ring_reset(struct roar_buffer * buf) _LIBROAR_BUFFER_STDATTRS; |
---|
[4629] | 115 | |
---|
[0] | 116 | #endif |
---|
| 117 | |
---|
| 118 | //ll |
---|