lavu/fifo: add av_fifo_freep function
[ffmpeg.git] / libavutil / fifo.h
1 /*
2  * This file is part of FFmpeg.
3  *
4  * FFmpeg is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * FFmpeg is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with FFmpeg; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18
19 /**
20  * @file
21  * a very simple circular buffer FIFO implementation
22  */
23
24 #ifndef AVUTIL_FIFO_H
25 #define AVUTIL_FIFO_H
26
27 #include <stdint.h>
28 #include "avutil.h"
29 #include "attributes.h"
30
31 typedef struct AVFifoBuffer {
32     uint8_t *buffer;
33     uint8_t *rptr, *wptr, *end;
34     uint32_t rndx, wndx;
35 } AVFifoBuffer;
36
37 /**
38  * Initialize an AVFifoBuffer.
39  * @param size of FIFO
40  * @return AVFifoBuffer or NULL in case of memory allocation failure
41  */
42 AVFifoBuffer *av_fifo_alloc(unsigned int size);
43
44 /**
45  * Free an AVFifoBuffer.
46  * @param f AVFifoBuffer to free
47  */
48 void av_fifo_free(AVFifoBuffer *f);
49
50 /**
51  * Free an AVFifoBuffer and reset pointer to NULL.
52  * @param f AVFifoBuffer to free
53  */
54 void av_fifo_freep(AVFifoBuffer **f);
55
56 /**
57  * Reset the AVFifoBuffer to the state right after av_fifo_alloc, in particular it is emptied.
58  * @param f AVFifoBuffer to reset
59  */
60 void av_fifo_reset(AVFifoBuffer *f);
61
62 /**
63  * Return the amount of data in bytes in the AVFifoBuffer, that is the
64  * amount of data you can read from it.
65  * @param f AVFifoBuffer to read from
66  * @return size
67  */
68 int av_fifo_size(const AVFifoBuffer *f);
69
70 /**
71  * Return the amount of space in bytes in the AVFifoBuffer, that is the
72  * amount of data you can write into it.
73  * @param f AVFifoBuffer to write into
74  * @return size
75  */
76 int av_fifo_space(const AVFifoBuffer *f);
77
78 /**
79  * Feed data from an AVFifoBuffer to a user-supplied callback.
80  * @param f AVFifoBuffer to read from
81  * @param buf_size number of bytes to read
82  * @param func generic read function
83  * @param dest data destination
84  */
85 int av_fifo_generic_read(AVFifoBuffer *f, void *dest, int buf_size, void (*func)(void*, void*, int));
86
87 /**
88  * Feed data from a user-supplied callback to an AVFifoBuffer.
89  * @param f AVFifoBuffer to write to
90  * @param src data source; non-const since it may be used as a
91  * modifiable context by the function defined in func
92  * @param size number of bytes to write
93  * @param func generic write function; the first parameter is src,
94  * the second is dest_buf, the third is dest_buf_size.
95  * func must return the number of bytes written to dest_buf, or <= 0 to
96  * indicate no more data available to write.
97  * If func is NULL, src is interpreted as a simple byte array for source data.
98  * @return the number of bytes written to the FIFO
99  */
100 int av_fifo_generic_write(AVFifoBuffer *f, void *src, int size, int (*func)(void*, void*, int));
101
102 /**
103  * Resize an AVFifoBuffer.
104  * In case of reallocation failure, the old FIFO is kept unchanged.
105  *
106  * @param f AVFifoBuffer to resize
107  * @param size new AVFifoBuffer size in bytes
108  * @return <0 for failure, >=0 otherwise
109  */
110 int av_fifo_realloc2(AVFifoBuffer *f, unsigned int size);
111
112 /**
113  * Enlarge an AVFifoBuffer.
114  * In case of reallocation failure, the old FIFO is kept unchanged.
115  * The new fifo size may be larger than the requested size.
116  *
117  * @param f AVFifoBuffer to resize
118  * @param additional_space the amount of space in bytes to allocate in addition to av_fifo_size()
119  * @return <0 for failure, >=0 otherwise
120  */
121 int av_fifo_grow(AVFifoBuffer *f, unsigned int additional_space);
122
123 /**
124  * Read and discard the specified amount of data from an AVFifoBuffer.
125  * @param f AVFifoBuffer to read from
126  * @param size amount of data to read in bytes
127  */
128 void av_fifo_drain(AVFifoBuffer *f, int size);
129
130 /**
131  * Return a pointer to the data stored in a FIFO buffer at a certain offset.
132  * The FIFO buffer is not modified.
133  *
134  * @param f    AVFifoBuffer to peek at, f must be non-NULL
135  * @param offs an offset in bytes, its absolute value must be less
136  *             than the used buffer size or the returned pointer will
137  *             point outside to the buffer data.
138  *             The used buffer size can be checked with av_fifo_size().
139  */
140 static inline uint8_t *av_fifo_peek2(const AVFifoBuffer *f, int offs)
141 {
142     uint8_t *ptr = f->rptr + offs;
143     if (ptr >= f->end)
144         ptr = f->buffer + (ptr - f->end);
145     else if (ptr < f->buffer)
146         ptr = f->end - (f->buffer - ptr);
147     return ptr;
148 }
149
150 #endif /* AVUTIL_FIFO_H */