source: roaraudio/include/libroar/buffer.h @ 3764:2a2b1eb426c4

Last change on this file since 3764:2a2b1eb426c4 was 3764:2a2b1eb426c4, checked in by phi, 14 years ago

added new buffer function roar_buffer_new_data() to make common alloc case more easy

File size: 4.0 KB
Line 
1//buffer.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 _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#define ROAR_BUFFER_SET                     0
47#define ROAR_BUFFER_RESET                   1
48
49struct roar_buffer_ring {
50 size_t read_pos;
51 size_t write_pos;
52};
53
54struct roar_buffer {
55 size_t               len;
56 size_t               user_len;
57 int                  flags;
58 void               * data;
59 void               * user_data;
60 union {
61  void                    * vp;
62  int32_t                   i32;
63  struct roar_buffer_ring   ring;
64 }                    meta;
65 struct roar_buffer * next;
66};
67
68struct roar_buffer_stats {
69 int parts;
70 int bytes;
71 int memory_usage;
72};
73
74#define roar_buffer_next(a) roar_buffer_delete(*(a), (a))
75
76int roar_buffer_new      (struct roar_buffer ** buf, size_t len);
77int roar_buffer_new_no_ma(struct roar_buffer ** buf, size_t len, void * data); // no internal malloc
78int roar_buffer_free     (struct roar_buffer *  buf);
79int roar_buffer_delete   (struct roar_buffer *  buf, struct roar_buffer ** next);
80int roar_buffer_add      (struct roar_buffer *  buf, struct roar_buffer *  next);
81
82int roar_buffer_new_data (struct roar_buffer ** buf, size_t len, void ** data);
83
84int roar_buffer_ring_new (struct roar_buffer ** buf, size_t len, int free_running);
85
86int roar_buffer_get_next (struct roar_buffer *  buf, struct roar_buffer ** next);
87
88int roar_buffer_get_data (struct roar_buffer *  buf, void   ** data);
89
90int roar_buffer_set_offset (struct roar_buffer *  buf, size_t off);
91
92int roar_buffer_shift_out (struct roar_buffer ** buf, void * data, size_t * len);
93
94int roar_buffer_set_meta    (struct roar_buffer *  buf, void    *  meta);
95int roar_buffer_get_meta    (struct roar_buffer *  buf, void    ** meta);
96int roar_buffer_set_meta_i32(struct roar_buffer *  buf, int32_t    meta);
97int roar_buffer_get_meta_i32(struct roar_buffer *  buf, int32_t *  meta);
98
99int roar_buffer_set_len  (struct roar_buffer *  buf, size_t    len);
100int roar_buffer_get_len  (struct roar_buffer *  buf, size_t *  len);
101
102int roar_buffer_set_flag (struct roar_buffer *  buf, int flag, int reset);
103int roar_buffer_get_flag (struct roar_buffer *  buf, int flag);
104
105int roar_buffer_duplicate (struct roar_buffer *  buf, struct roar_buffer ** copy);
106
107int roar_buffer_ring_stats (struct roar_buffer *  buf, struct roar_buffer_stats * stats);
108
109int roar_buffer_ring_read  (struct roar_buffer *  buf, void * data, size_t * len);
110int roar_buffer_ring_write (struct roar_buffer *  buf, void * data, size_t * len);
111
112#endif
113
114//ll
Note: See TracBrowser for help on using the repository browser.