FFmpeg
fifo.h
Go to the documentation of this file.
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 
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 
42 AVFifoBuffer *av_fifo_alloc(unsigned int size);
43 
50 AVFifoBuffer *av_fifo_alloc_array(size_t nmemb, size_t size);
51 
56 void av_fifo_free(AVFifoBuffer *f);
57 
62 void av_fifo_freep(AVFifoBuffer **f);
63 
68 void av_fifo_reset(AVFifoBuffer *f);
69 
76 int av_fifo_size(const AVFifoBuffer *f);
77 
84 int av_fifo_space(const AVFifoBuffer *f);
85 
95 int av_fifo_generic_peek_at(AVFifoBuffer *f, void *dest, int offset, int buf_size, void (*func)(void*, void*, int));
96 
105 int av_fifo_generic_peek(AVFifoBuffer *f, void *dest, int buf_size, void (*func)(void*, void*, int));
106 
114 int av_fifo_generic_read(AVFifoBuffer *f, void *dest, int buf_size, void (*func)(void*, void*, int));
115 
129 int av_fifo_generic_write(AVFifoBuffer *f, void *src, int size, int (*func)(void*, void*, int));
130 
139 int av_fifo_realloc2(AVFifoBuffer *f, unsigned int size);
140 
150 int av_fifo_grow(AVFifoBuffer *f, unsigned int additional_space);
151 
157 void av_fifo_drain(AVFifoBuffer *f, int size);
158 
169 static inline uint8_t *av_fifo_peek2(const AVFifoBuffer *f, int offs)
170 {
171  uint8_t *ptr = f->rptr + offs;
172  if (ptr >= f->end)
173  ptr = f->buffer + (ptr - f->end);
174  else if (ptr < f->buffer)
175  ptr = f->end - (f->buffer - ptr);
176  return ptr;
177 }
178 
179 #endif /* AVUTIL_FIFO_H */
av_fifo_generic_read
int av_fifo_generic_read(AVFifoBuffer *f, void *dest, int buf_size, void(*func)(void *, void *, int))
Feed data from an AVFifoBuffer to a user-supplied callback.
Definition: fifo.c:213
av_fifo_realloc2
int av_fifo_realloc2(AVFifoBuffer *f, unsigned int size)
Resize an AVFifoBuffer.
Definition: fifo.c:87
avutil.h
Convenience header that includes libavutil&#39;s core.
attributes.h
Macro definitions for various function/variable attributes.
av_fifo_generic_peek_at
int av_fifo_generic_peek_at(AVFifoBuffer *f, void *dest, int offset, int buf_size, void(*func)(void *, void *, int))
Feed data at specific position from an AVFifoBuffer to a user-supplied callback.
Definition: fifo.c:151
av_fifo_alloc
AVFifoBuffer * av_fifo_alloc(unsigned int size)
Initialize an AVFifoBuffer.
Definition: fifo.c:43
av_fifo_generic_write
int av_fifo_generic_write(AVFifoBuffer *f, void *src, int size, int(*func)(void *, void *, int))
Feed data from a user-supplied callback to an AVFifoBuffer.
Definition: fifo.c:122
av_fifo_size
int av_fifo_size(const AVFifoBuffer *f)
Return the amount of data in bytes in the AVFifoBuffer, that is the amount of data you can read from ...
Definition: fifo.c:77
av_fifo_freep
void av_fifo_freep(AVFifoBuffer **f)
Free an AVFifoBuffer and reset pointer to NULL.
Definition: fifo.c:63
av_fifo_alloc_array
AVFifoBuffer * av_fifo_alloc_array(size_t nmemb, size_t size)
Initialize an AVFifoBuffer.
Definition: fifo.c:49
AVFifoBuffer
Definition: fifo.h:31
av_fifo_generic_peek
int av_fifo_generic_peek(AVFifoBuffer *f, void *dest, int buf_size, void(*func)(void *, void *, int))
Feed data from an AVFifoBuffer to a user-supplied callback.
Definition: fifo.c:189
av_fifo_space
int av_fifo_space(const AVFifoBuffer *f)
Return the amount of space in bytes in the AVFifoBuffer, that is the amount of data you can write int...
Definition: fifo.c:82
av_fifo_free
void av_fifo_free(AVFifoBuffer *f)
Free an AVFifoBuffer.
Definition: fifo.c:55
av_fifo_grow
int av_fifo_grow(AVFifoBuffer *f, unsigned int additional_space)
Enlarge an AVFifoBuffer.
Definition: fifo.c:107
av_fifo_drain
void av_fifo_drain(AVFifoBuffer *f, int size)
Read and discard the specified amount of data from an AVFifoBuffer.
Definition: fifo.c:233
av_fifo_reset
void av_fifo_reset(AVFifoBuffer *f)
Reset the AVFifoBuffer to the state right after av_fifo_alloc, in particular it is emptied...
Definition: fifo.c:71
Generated by   doxygen 1.8.12