Almost done with the ring buffer implementation (but still untested, so assumed
[speexdsp.git] / libspeex / buffer.c
1 /* Copyright (C) 2007 Jean-Marc Valin
2       
3    File: buffer.c
4    This is a very simple ring buffer implementation. It is not thread-safe
5    so you need to do your own locking.
6
7    Redistribution and use in source and binary forms, with or without
8    modification, are permitted provided that the following conditions are
9    met:
10
11    1. Redistributions of source code must retain the above copyright notice,
12    this list of conditions and the following disclaimer.
13
14    2. Redistributions in binary form must reproduce the above copyright
15    notice, this list of conditions and the following disclaimer in the
16    documentation and/or other materials provided with the distribution.
17
18    3. The name of the author may not be used to endorse or promote products
19    derived from this software without specific prior written permission.
20
21    THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22    IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23    OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24    DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
25    INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
26    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27    SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28    HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
29    STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
30    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31    POSSIBILITY OF SUCH DAMAGE.
32 */
33
34 #include "os_support.h"
35 #include "misc.h"
36 #include <speex/speex_buffer.h>
37
38 struct SpeexBuffer_ {
39    void *data;
40    int   size;
41    int   read_ptr;
42    int   write_ptr;
43    int   available;
44 };
45
46 SpeexBuffer *speex_buffer_init(int size)
47 {
48    SpeexBuffer *st = speex_alloc(sizeof(SpeexBuffer));
49    st->data = speex_alloc(size);
50    st->size = size;
51    st->read_ptr = 0;
52    st->write_ptr = 0;
53    st->available = 0;
54    return st;
55 }
56
57 void speex_buffer_destroy(SpeexBuffer *st)
58 {
59    speex_free(st->data);
60    speex_free(st);
61 }
62
63 int speex_buffer_write(SpeexBuffer *st, void *data, int len)
64 {
65    int end;
66    int end1;
67    if (len > st->size)
68    {
69       data += len-st->size;
70       len = st->size;
71    }
72    end = st->write_ptr + len;
73    end1 = end;
74    if (end1 > st->size)
75       end1 = st->size;
76    speex_move(st->data + st->write_ptr, data, end1 - st->write_ptr);
77    if (end > st->size)
78    {
79       end -= st->size;
80       speex_move(st->data, data+end1 - st->write_ptr, end);
81    }
82    st->available += len;
83    if (st->available > st->size)
84    {
85       st->available = st->size;
86       st->read_ptr = st->write_ptr;
87    }
88    return len;
89 }
90
91 int speex_buffer_writezeros(SpeexBuffer *st, int len)
92 {
93    /* This is almost the same as for speex_buffer_write() but using 
94    speex_memset() instead of speex_move(). Update accordingly. */
95       int end;
96    int end1;
97    if (len > st->size)
98    {
99       len = st->size;
100    }
101    end = st->write_ptr + len;
102    end1 = end;
103    if (end1 > st->size)
104       end1 = st->size;
105    speex_memset(st->data + st->write_ptr, 0, end1 - st->write_ptr);
106    if (end > st->size)
107    {
108       end -= st->size;
109       speex_memset(st->data, 0, end);
110    }
111    st->available += len;
112    if (st->available > st->size)
113    {
114       st->available = st->size;
115       st->read_ptr = st->write_ptr;
116    }
117
118    return len;
119 }
120
121 int speex_buffer_read(SpeexBuffer *st, void *data, int len)
122 {
123    int end, end1;
124    if (len > st->available)
125    {
126       speex_memset(data+st->available, 0, st->size-st->available);
127       len = st->available;
128    }
129    end = st->read_ptr + len;
130    end1 = end;
131    if (end1 > st->size)
132       end1 = st->size;
133    speex_move(data, st->data + st->read_ptr, end1 - st->read_ptr);
134
135    if (end > st->size)
136    {
137       end -= st->size;
138       speex_move(data+end1 - st->read_ptr, st->data, end);
139    }
140    st->available -= len;
141    return len;
142 }
143
144 int speex_buffer_get_available(SpeexBuffer *st)
145 {
146    return st->available;
147 }
148
149 int speex_buffer_resize(SpeexBuffer *st, int len)
150 {
151    int old_len = st->size;
152    if (len > old_len)
153    {
154       st->data = speex_realloc(st->data, len);
155       /* FIXME: move data/pointers properly for growing the buffer */
156    } else {
157       /* FIXME: move data/pointers properly for shrinking the buffer */
158       st->data = speex_realloc(st->data, len);
159    }
160    return len;
161 }