fifo.h 4.26 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
/*
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * FFmpeg is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with FFmpeg; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

19
/**
20
 * @file
21
 * a very simple circular buffer FIFO implementation
22 23
 */

24 25
#ifndef AVUTIL_FIFO_H
#define AVUTIL_FIFO_H
26

27
#include <stdint.h>
28
#include "avutil.h"
29

30 31 32
typedef struct AVFifoBuffer {
    uint8_t *buffer;
    uint8_t *rptr, *wptr, *end;
33
    uint32_t rndx, wndx;
34 35
} AVFifoBuffer;

36
/**
37
 * Initialize an AVFifoBuffer.
38
 * @param size of FIFO
39
 * @return AVFifoBuffer or NULL in case of memory allocation failure
40
 */
41
AVFifoBuffer *av_fifo_alloc(unsigned int size);
42 43

/**
44
 * Free an AVFifoBuffer.
45
 * @param *f AVFifoBuffer to free
46
 */
47
void av_fifo_free(AVFifoBuffer *f);
48

49
/**
50
 * Reset the AVFifoBuffer to the state right after av_fifo_alloc, in particular it is emptied.
51 52 53 54
 * @param *f AVFifoBuffer to reset
 */
void av_fifo_reset(AVFifoBuffer *f);

55
/**
56
 * Return the amount of data in bytes in the AVFifoBuffer, that is the
57 58
 * amount of data you can read from it.
 * @param *f AVFifoBuffer to read from
59 60
 * @return size
 */
61
int av_fifo_size(AVFifoBuffer *f);
62

63
/**
64
 * Return the amount of space in bytes in the AVFifoBuffer, that is the
65 66 67 68 69 70
 * amount of data you can write into it.
 * @param *f AVFifoBuffer to write into
 * @return size
 */
int av_fifo_space(AVFifoBuffer *f);

71
/**
72
 * Feed data from an AVFifoBuffer to a user-supplied callback.
73 74
 * @param *f AVFifoBuffer to read from
 * @param buf_size number of bytes to read
75 76 77
 * @param *func generic read function
 * @param *dest data destination
 */
78
int av_fifo_generic_read(AVFifoBuffer *f, void *dest, int buf_size, void (*func)(void*, void*, int));
79

80
/**
81
 * Feed data from a user-supplied callback to an AVFifoBuffer.
82
 * @param *f AVFifoBuffer to write to
83 84
 * @param *src data source; non-const since it may be used as a
 * modifiable context by the function defined in func
85
 * @param size number of bytes to write
86 87
 * @param *func generic write function; the first parameter is src,
 * the second is dest_buf, the third is dest_buf_size.
88 89
 * func must return the number of bytes written to dest_buf, or <= 0 to
 * indicate no more data available to write.
90
 * If func is NULL, src is interpreted as a simple byte array for source data.
91
 * @return the number of bytes written to the FIFO
92
 */
93
int av_fifo_generic_write(AVFifoBuffer *f, void *src, int size, int (*func)(void*, void*, int));
94

95
/**
96
 * Resize an AVFifoBuffer.
97 98
 * @param *f AVFifoBuffer to resize
 * @param size new AVFifoBuffer size in bytes
99
 * @return <0 for failure, >=0 otherwise
100 101 102
 */
int av_fifo_realloc2(AVFifoBuffer *f, unsigned int size);

103
/**
104
 * Read and discard the specified amount of data from an AVFifoBuffer.
105 106
 * @param *f AVFifoBuffer to read from
 * @param size amount of data to read in bytes
107
 */
108 109
void av_fifo_drain(AVFifoBuffer *f, int size);

110 111 112 113 114 115 116 117 118 119 120
/**
 * Return a pointer to the data stored in a FIFO buffer at a certain offset.
 * The FIFO buffer is not modified.
 *
 * @param *f   AVFifoBuffer to peek at, f must be non-NULL
 * @param offs an offset in bytes, its absolute value must be less
 *             than the used buffer size or the returned pointer will
 *             point outside to the buffer data.
 *             The used buffer size can be checked with av_fifo_size().
 */
static inline uint8_t *av_fifo_peek2(const AVFifoBuffer *f, int offs)
121 122 123
{
    uint8_t *ptr = f->rptr + offs;
    if (ptr >= f->end)
124 125 126 127
        ptr = f->buffer + (ptr - f->end);
    else if (ptr < f->buffer)
        ptr = f->end - (f->buffer - ptr);
    return ptr;
128
}
129 130 131 132 133 134 135 136 137 138 139 140

#if FF_API_AV_FIFO_PEEK
/**
 * @deprecated Use av_fifo_peek2() instead.
 */
attribute_deprecated
static inline uint8_t av_fifo_peek(AVFifoBuffer *f, int offs)
{
    return *av_fifo_peek2(f, offs);
}
#endif

141
#endif /* AVUTIL_FIFO_H */