Statistics
| Branch: | Revision:

ffmpeg / libavutil / fifo.h @ 82ffe191

History | View | Annotate | Download (2.75 KB)

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 fifo.h
21
 * A very simple circular buffer FIFO implementation.
22
 */
23

    
24
#ifndef FIFO_H
25
#define FIFO_H
26

    
27
typedef struct AVFifoBuffer {
28
    uint8_t *buffer;
29
    uint8_t *rptr, *wptr, *end;
30
} AVFifoBuffer;
31

    
32
/**
33
 * Initializes an AVFifoBuffer.
34
 * @param *f AVFifoBuffer to initialize
35
 * @param size of FIFO
36
 * @return <0 for failure >=0 otherwise
37
 */
38
int av_fifo_init(AVFifoBuffer *f, int size);
39

    
40
/**
41
 * Frees an AVFifoBuffer.
42
 * @param *f AVFifoBuffer to free
43
 */
44
void av_fifo_free(AVFifoBuffer *f);
45

    
46
/**
47
 * Returns the amount of data in bytes in the AVFifoBuffer, that is the
48
 * amount of data you can read from it.
49
 * @param *f AVFifoBuffer to read from
50
 * @return size
51
 */
52
int av_fifo_size(AVFifoBuffer *f);
53

    
54
/**
55
 * Reads data from an AVFifoBuffer.
56
 * @param *f AVFifoBuffer to read from
57
 * @param *buf data destination
58
 * @param buf_size number of bytes to read
59
 */
60
int av_fifo_read(AVFifoBuffer *f, uint8_t *buf, int buf_size);
61

    
62
/**
63
 * Feeds data from an AVFifoBuffer to a user supplied callback.
64
 * @param *f AVFifoBuffer to read from
65
 * @param buf_size number of bytes to read
66
 * @param *func generic read function
67
 * @param *dest data destination
68
 */
69
int av_fifo_generic_read(AVFifoBuffer *f, int buf_size, void (*func)(void*, void*, int), void* dest);
70

    
71
/**
72
 * Writes data into an AVFifoBuffer.
73
 * @param *f AVFifoBuffer to write to
74
 * @param *buf data source
75
 * @param size data size
76
 */
77
void av_fifo_write(AVFifoBuffer *f, const uint8_t *buf, int size);
78

    
79
/**
80
 * Resizes an AVFifoBuffer.
81
 * @param *f AVFifoBuffer to resize
82
 * @param size new AVFifoBuffer size in bytes
83
 */
84
void av_fifo_realloc(AVFifoBuffer *f, unsigned int size);
85

    
86
/**
87
 * Reads and discards the specified amount of data from an AVFifoBuffer.
88
 * @param *f AVFifoBuffer to read from
89
 * @param size amount of data to read in bytes
90
 */
91
void av_fifo_drain(AVFifoBuffer *f, int size);
92

    
93
static inline uint8_t av_fifo_peek(AVFifoBuffer *f, int offs)
94
{
95
    uint8_t *ptr = f->rptr + offs;
96
    if (ptr >= f->end)
97
        ptr -= f->end - f->buffer;
98
    return *ptr;
99
}
100
#endif /* FIFO_H */