fifo: Make writes atomic.
[ffmpeg.git] / libavutil / fifo.c
1 /*
2  * a very simple circular buffer FIFO implementation
3  * Copyright (c) 2000, 2001, 2002 Fabrice Bellard
4  * Copyright (c) 2006 Roman Shaposhnik
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22 #include "common.h"
23 #include "fifo.h"
24
25 AVFifoBuffer *av_fifo_alloc(unsigned int size)
26 {
27     AVFifoBuffer *f= av_mallocz(sizeof(AVFifoBuffer));
28     if (!f)
29         return NULL;
30     f->buffer = av_malloc(size);
31     f->end = f->buffer + size;
32     av_fifo_reset(f);
33     if (!f->buffer)
34         av_freep(&f);
35     return f;
36 }
37
38 void av_fifo_free(AVFifoBuffer *f)
39 {
40     if (f) {
41         av_freep(&f->buffer);
42         av_free(f);
43     }
44 }
45
46 void av_fifo_reset(AVFifoBuffer *f)
47 {
48     f->wptr = f->rptr = f->buffer;
49     f->wndx = f->rndx = 0;
50 }
51
52 int av_fifo_size(AVFifoBuffer *f)
53 {
54     return (uint32_t)(f->wndx - f->rndx);
55 }
56
57 int av_fifo_space(AVFifoBuffer *f)
58 {
59     return f->end - f->buffer - av_fifo_size(f);
60 }
61
62 int av_fifo_realloc2(AVFifoBuffer *f, unsigned int new_size)
63 {
64     unsigned int old_size = f->end - f->buffer;
65
66     if (old_size < new_size) {
67         int len = av_fifo_size(f);
68         AVFifoBuffer *f2 = av_fifo_alloc(new_size);
69
70         if (!f2)
71             return AVERROR(ENOMEM);
72         av_fifo_generic_read(f, f2->buffer, len, NULL);
73         f2->wptr += len;
74         f2->wndx += len;
75         av_free(f->buffer);
76         *f = *f2;
77         av_free(f2);
78     }
79     return 0;
80 }
81
82 // src must NOT be const as it can be a context for func that may need updating (like a pointer or byte counter)
83 int av_fifo_generic_write(AVFifoBuffer *f, void *src, int size, int (*func)(void*, void*, int))
84 {
85     int total = size;
86     uint32_t wndx= f->wndx;
87     uint8_t *wptr= f->wptr;
88
89     do {
90         int len = FFMIN(f->end - wptr, size);
91         if (func) {
92             if (func(src, wptr, len) <= 0)
93                 break;
94         } else {
95             memcpy(wptr, src, len);
96             src = (uint8_t*)src + len;
97         }
98 // Write memory barrier needed for SMP here in theory
99         wptr += len;
100         if (wptr >= f->end)
101             wptr = f->buffer;
102         wndx += len;
103         size -= len;
104     } while (size > 0);
105     f->wndx= wndx;
106     f->wptr= wptr;
107     return total - size;
108 }
109
110
111 int av_fifo_generic_read(AVFifoBuffer *f, void *dest, int buf_size, void (*func)(void*, void*, int))
112 {
113 // Read memory barrier needed for SMP here in theory
114     do {
115         int len = FFMIN(f->end - f->rptr, buf_size);
116         if(func) func(dest, f->rptr, len);
117         else{
118             memcpy(dest, f->rptr, len);
119             dest = (uint8_t*)dest + len;
120         }
121 // memory barrier needed for SMP here in theory
122         av_fifo_drain(f, len);
123         buf_size -= len;
124     } while (buf_size > 0);
125     return 0;
126 }
127
128 /** Discard data from the FIFO. */
129 void av_fifo_drain(AVFifoBuffer *f, int size)
130 {
131     f->rptr += size;
132     if (f->rptr >= f->end)
133         f->rptr -= f->end - f->buffer;
134     f->rndx += size;
135 }
136
137 #ifdef TEST
138
139 #undef printf
140
141 int main(void)
142 {
143     /* create a FIFO buffer */
144     AVFifoBuffer *fifo = av_fifo_alloc(13 * sizeof(int));
145     int i, j, n;
146
147     /* fill data */
148     for (i = 0; av_fifo_space(fifo) >= sizeof(int); i++)
149         av_fifo_generic_write(fifo, &i, sizeof(int), NULL);
150
151     /* peek at FIFO */
152     n = av_fifo_size(fifo)/sizeof(int);
153     for (i = -n+1; i < n; i++) {
154         int *v = (int *)av_fifo_peek2(fifo, i*sizeof(int));
155         printf("%d: %d\n", i, *v);
156     }
157     printf("\n");
158
159     /* read data */
160     for (i = 0; av_fifo_size(fifo) >= sizeof(int); i++) {
161         av_fifo_generic_read(fifo, &j, sizeof(int), NULL);
162         printf("%d ", j);
163     }
164     printf("\n");
165
166     av_fifo_free(fifo);
167
168     return 0;
169 }
170
171 #endif