Merge commit '4e7f0b082d8c4b360312216b9241bec65ff63b35'
[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 int av_fifo_grow(AVFifoBuffer *f, unsigned int size)
83 {
84     unsigned int old_size = f->end - f->buffer;
85     if(size + (unsigned)av_fifo_size(f) < size)
86         return AVERROR(EINVAL);
87
88     size += av_fifo_size(f);
89
90     if (old_size < size)
91         return av_fifo_realloc2(f, FFMAX(size, 2*size));
92     return 0;
93 }
94
95 // src must NOT be const as it can be a context for func that may need updating (like a pointer or byte counter)
96 int av_fifo_generic_write(AVFifoBuffer *f, void *src, int size, int (*func)(void*, void*, int))
97 {
98     int total = size;
99     uint32_t wndx= f->wndx;
100     uint8_t *wptr= f->wptr;
101
102     do {
103         int len = FFMIN(f->end - wptr, size);
104         if (func) {
105             if (func(src, wptr, len) <= 0)
106                 break;
107         } else {
108             memcpy(wptr, src, len);
109             src = (uint8_t*)src + len;
110         }
111 // Write memory barrier needed for SMP here in theory
112         wptr += len;
113         if (wptr >= f->end)
114             wptr = f->buffer;
115         wndx += len;
116         size -= len;
117     } while (size > 0);
118     f->wndx= wndx;
119     f->wptr= wptr;
120     return total - size;
121 }
122
123
124 int av_fifo_generic_read(AVFifoBuffer *f, void *dest, int buf_size, void (*func)(void*, void*, int))
125 {
126 // Read memory barrier needed for SMP here in theory
127     do {
128         int len = FFMIN(f->end - f->rptr, buf_size);
129         if(func) func(dest, f->rptr, len);
130         else{
131             memcpy(dest, f->rptr, len);
132             dest = (uint8_t*)dest + len;
133         }
134 // memory barrier needed for SMP here in theory
135         av_fifo_drain(f, len);
136         buf_size -= len;
137     } while (buf_size > 0);
138     return 0;
139 }
140
141 /** Discard data from the FIFO. */
142 void av_fifo_drain(AVFifoBuffer *f, int size)
143 {
144     f->rptr += size;
145     if (f->rptr >= f->end)
146         f->rptr -= f->end - f->buffer;
147     f->rndx += size;
148 }
149
150 #ifdef TEST
151
152 int main(void)
153 {
154     /* create a FIFO buffer */
155     AVFifoBuffer *fifo = av_fifo_alloc(13 * sizeof(int));
156     int i, j, n;
157
158     /* fill data */
159     for (i = 0; av_fifo_space(fifo) >= sizeof(int); i++)
160         av_fifo_generic_write(fifo, &i, sizeof(int), NULL);
161
162     /* peek at FIFO */
163     n = av_fifo_size(fifo)/sizeof(int);
164     for (i = -n+1; i < n; i++) {
165         int *v = (int *)av_fifo_peek2(fifo, i*sizeof(int));
166         printf("%d: %d\n", i, *v);
167     }
168     printf("\n");
169
170     /* read data */
171     for (i = 0; av_fifo_size(fifo) >= sizeof(int); i++) {
172         av_fifo_generic_read(fifo, &j, sizeof(int), NULL);
173         printf("%d ", j);
174     }
175     printf("\n");
176
177     av_fifo_free(fifo);
178
179     return 0;
180 }
181
182 #endif