JACK-AUDIO-CONNECTION-KIT  0.125.0rc1
ringbuffer.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2000 Paul Davis
3  Copyright (C) 2003 Rohan Drape
4 
5  This program is free software; you can redistribute it and/or modify
6  it under the terms of the GNU Lesser General Public License as published by
7  the Free Software Foundation; either version 2.1 of the License, or
8  (at your option) any later version.
9 
10  This program is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  GNU Lesser General Public License for more details.
14 
15  You should have received a copy of the GNU Lesser General Public License
16  along with this program; if not, write to the Free Software
17  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18 
19  */
20 
21 #ifndef _RINGBUFFER_H
22 #define _RINGBUFFER_H
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 #include <sys/types.h>
29 
44 typedef struct {
45  char *buf;
46  size_t len;
47 }
49 
50 typedef struct {
51  char *buf;
52  volatile size_t write_ptr;
53  volatile size_t read_ptr;
54  size_t size;
55  size_t size_mask;
56  int mlocked;
57 }
59 
71 
79 
102 
124 
135 size_t jack_ringbuffer_read(jack_ringbuffer_t *rb, char *dest, size_t cnt);
136 
152 size_t jack_ringbuffer_peek(jack_ringbuffer_t *rb, char *dest, size_t cnt);
153 
165 void jack_ringbuffer_read_advance(jack_ringbuffer_t *rb, size_t cnt);
166 
175 
184 
193 
203 size_t jack_ringbuffer_write(jack_ringbuffer_t *rb, const char *src,
204  size_t cnt);
205 
218 
227 
228 
229 #ifdef __cplusplus
230 }
231 #endif
232 
233 #endif
size_t jack_ringbuffer_read_space(const jack_ringbuffer_t *rb)
void jack_ringbuffer_write_advance(jack_ringbuffer_t *rb, size_t cnt)
jack_ringbuffer_t * jack_ringbuffer_create(size_t sz)
size_t size_mask
Definition: ringbuffer.h:55
size_t jack_ringbuffer_write_space(const jack_ringbuffer_t *rb)
void jack_ringbuffer_free(jack_ringbuffer_t *rb)
void jack_ringbuffer_reset(jack_ringbuffer_t *rb)
volatile size_t write_ptr
Definition: ringbuffer.h:52
int mlocked
Definition: ringbuffer.h:56
char * buf
Definition: ringbuffer.h:51
void jack_ringbuffer_get_read_vector(const jack_ringbuffer_t *rb, jack_ringbuffer_data_t *vec)
void jack_ringbuffer_get_write_vector(const jack_ringbuffer_t *rb, jack_ringbuffer_data_t *vec)
size_t jack_ringbuffer_write(jack_ringbuffer_t *rb, const char *src, size_t cnt)
int jack_ringbuffer_mlock(jack_ringbuffer_t *rb)
void jack_ringbuffer_read_advance(jack_ringbuffer_t *rb, size_t cnt)
size_t jack_ringbuffer_read(jack_ringbuffer_t *rb, char *dest, size_t cnt)
volatile size_t read_ptr
Definition: ringbuffer.h:53
size_t size
Definition: ringbuffer.h:54
Definition: ringbuffer.h:44
size_t len
Definition: ringbuffer.h:46
char * buf
Definition: ringbuffer.h:45
size_t jack_ringbuffer_peek(jack_ringbuffer_t *rb, char *dest, size_t cnt)
Definition: ringbuffer.h:50