Libav
fifo.h
Go to the documentation of this file.
1 /*
2  * This file is part of Libav.
3  *
4  * Libav 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  * Libav 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 Libav; 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 {
34  uint32_t rndx, wndx;
35 } AVFifoBuffer;
36 
42 AVFifoBuffer *av_fifo_alloc(unsigned int size);
43 
48 void av_fifo_free(AVFifoBuffer *f);
49 
55 
63 
71 
79 int av_fifo_generic_read(AVFifoBuffer *f, void *dest, int buf_size, void (*func)(void*, void*, int));
80 
94 int av_fifo_generic_write(AVFifoBuffer *f, void *src, int size, int (*func)(void*, void*, int));
95 
102 int av_fifo_realloc2(AVFifoBuffer *f, unsigned int size);
103 
109 void av_fifo_drain(AVFifoBuffer *f, int size);
110 
121 static inline uint8_t *av_fifo_peek2(const AVFifoBuffer *f, int offs)
122 {
123  uint8_t *ptr = f->rptr + offs;
124  if (ptr >= f->end)
125  ptr = f->buffer + (ptr - f->end);
126  else if (ptr < f->buffer)
127  ptr = f->end - (f->buffer - ptr);
128  return ptr;
129 }
130 
131 #endif /* AVUTIL_FIFO_H */
int size
uint8_t * wptr
Definition: fifo.h:33
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:107
int av_fifo_realloc2(AVFifoBuffer *f, unsigned int size)
Resize an AVFifoBuffer.
Definition: fifo.c:62
external API header
uint32_t rndx
Definition: fifo.h:34
Macro definitions for various function/variable attributes.
uint8_t
int av_fifo_size(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:52
AVFifoBuffer * av_fifo_alloc(unsigned int size)
Initialize an AVFifoBuffer.
Definition: fifo.c:25
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:84
static uint8_t * av_fifo_peek2(const AVFifoBuffer *f, int offs)
Return a pointer to the data stored in a FIFO buffer at a certain offset.
Definition: fifo.h:121
int av_fifo_space(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:57
uint8_t * end
Definition: fifo.h:33
uint8_t * rptr
Definition: fifo.h:33
uint8_t * buffer
Definition: fifo.h:32
void av_fifo_free(AVFifoBuffer *f)
Free an AVFifoBuffer.
Definition: fifo.c:38
uint32_t wndx
Definition: fifo.h:34
void av_fifo_drain(AVFifoBuffer *f, int size)
Read and discard the specified amount of data from an AVFifoBuffer.
Definition: fifo.c:127
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:46