Cosmetics: remove a redundant and misplaced doxy.
[libav.git] / libavutil / fifo.c
CommitLineData
f5a478f6
RS
1/*
2 * A very simple circular buffer FIFO implementation
3 * Copyright (c) 2000, 2001, 2002 Fabrice Bellard
4 * Copyright (c) 2006 Roman Shaposhnik
5 *
b78e7197
DB
6 * This file is part of FFmpeg.
7 *
8 * FFmpeg is free software; you can redistribute it and/or
f5a478f6
RS
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
b78e7197 11 * version 2.1 of the License, or (at your option) any later version.
f5a478f6 12 *
b78e7197 13 * FFmpeg is distributed in the hope that it will be useful,
f5a478f6
RS
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
b78e7197 19 * License along with FFmpeg; if not, write to the Free Software
f5a478f6
RS
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 */
22#include "common.h"
23#include "fifo.h"
24
fa3b9818 25int av_fifo_init(AVFifoBuffer *f, unsigned int size)
f5a478f6 26{
fa3b9818 27 size= FFMAX(size, size+1);
0726982c 28 f->wptr = f->rptr =
f5a478f6 29 f->buffer = av_malloc(size);
4497712f 30 f->end = f->buffer + size;
f5a478f6
RS
31 if (!f->buffer)
32 return -1;
f5a478f6
RS
33 return 0;
34}
35
36void av_fifo_free(AVFifoBuffer *f)
37{
38 av_free(f->buffer);
39}
40
41int av_fifo_size(AVFifoBuffer *f)
42{
43 int size = f->wptr - f->rptr;
44 if (size < 0)
45 size += f->end - f->buffer;
46 return size;
47}
48
f5a478f6
RS
49int av_fifo_read(AVFifoBuffer *f, uint8_t *buf, int buf_size)
50{
765d4f3b 51 return av_fifo_generic_read(f, buf_size, NULL, buf);
f5a478f6
RS
52}
53
e8e2b2ef 54#if LIBAVUTIL_VERSION_MAJOR < 50
f5a478f6 55void av_fifo_realloc(AVFifoBuffer *f, unsigned int new_size) {
8257b835
SS
56 av_fifo_realloc2(f, new_size);
57}
e8e2b2ef 58#endif
8257b835
SS
59
60int av_fifo_realloc2(AVFifoBuffer *f, unsigned int new_size) {
f5a478f6
RS
61 unsigned int old_size= f->end - f->buffer;
62
fa3b9818 63 if(old_size <= new_size){
96e39edc
MN
64 int len= av_fifo_size(f);
65 AVFifoBuffer f2;
f5a478f6 66
8257b835
SS
67 if (av_fifo_init(&f2, new_size) < 0)
68 return -1;
96e39edc
MN
69 av_fifo_read(f, f2.buffer, len);
70 f2.wptr += len;
71 av_free(f->buffer);
72 *f= f2;
f5a478f6 73 }
8257b835 74 return 0;
f5a478f6
RS
75}
76
77void av_fifo_write(AVFifoBuffer *f, const uint8_t *buf, int size)
78{
49cec199
BA
79 av_fifo_generic_write(f, (void *)buf, size, NULL);
80}
81
95c76e11 82int av_fifo_generic_write(AVFifoBuffer *f, void *src, int size, int (*func)(void*, void*, int))
49cec199
BA
83{
84 int total = size;
50b44685 85 do {
870a12d1 86 int len = FFMIN(f->end - f->wptr, size);
49cec199 87 if(func) {
95c76e11 88 if(func(src, f->wptr, len) <= 0)
49cec199
BA
89 break;
90 } else {
95c76e11
BF
91 memcpy(f->wptr, src, len);
92 src = (uint8_t*)src + len;
49cec199 93 }
f5a478f6
RS
94 f->wptr += len;
95 if (f->wptr >= f->end)
96 f->wptr = f->buffer;
f5a478f6 97 size -= len;
50b44685 98 } while (size > 0);
49cec199 99 return total - size;
f5a478f6
RS
100}
101
102
f5a478f6
RS
103int av_fifo_generic_read(AVFifoBuffer *f, int buf_size, void (*func)(void*, void*, int), void* dest)
104{
50b44685 105 do {
870a12d1 106 int len = FFMIN(f->end - f->rptr, buf_size);
765d4f3b
MN
107 if(func) func(dest, f->rptr, len);
108 else{
109 memcpy(dest, f->rptr, len);
110 dest = (uint8_t*)dest + len;
111 }
3da97cfd 112 av_fifo_drain(f, len);
f5a478f6 113 buf_size -= len;
50b44685 114 } while (buf_size > 0);
f5a478f6
RS
115 return 0;
116}
117
be65b41f 118/** discard data from the fifo */
f5a478f6
RS
119void av_fifo_drain(AVFifoBuffer *f, int size)
120{
121 f->rptr += size;
122 if (f->rptr >= f->end)
123 f->rptr -= f->end - f->buffer;
124}