fifo.h 3.83 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 fifo.h
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
#include "common.h"
30

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

36
/**
37 38
 * Initializes an AVFifoBuffer.
 * @param *f AVFifoBuffer to initialize
39 40 41
 * @param size of FIFO
 * @return <0 for failure >=0 otherwise
 */
42
int av_fifo_init(AVFifoBuffer *f, unsigned int size);
43 44

/**
45 46
 * Frees an AVFifoBuffer.
 * @param *f AVFifoBuffer to free
47
 */
48
void av_fifo_free(AVFifoBuffer *f);
49 50

/**
51 52 53
 * Returns the amount of data in bytes in the AVFifoBuffer, that is the
 * amount of data you can read from it.
 * @param *f AVFifoBuffer to read from
54 55
 * @return size
 */
56
int av_fifo_size(AVFifoBuffer *f);
57 58

/**
59 60
 * Reads data from an AVFifoBuffer.
 * @param *f AVFifoBuffer to read from
61
 * @param *buf data destination
62
 * @param buf_size number of bytes to read
63
 */
64
int av_fifo_read(AVFifoBuffer *f, uint8_t *buf, int buf_size);
65 66

/**
67
 * Feeds data from an AVFifoBuffer to a user-supplied callback.
68 69
 * @param *f AVFifoBuffer to read from
 * @param buf_size number of bytes to read
70 71 72
 * @param *func generic read function
 * @param *dest data destination
 */
73
int av_fifo_generic_read(AVFifoBuffer *f, int buf_size, void (*func)(void*, void*, int), void* dest);
74

75
#if LIBAVUTIL_VERSION_MAJOR < 50
76
/**
77 78
 * Writes data into an AVFifoBuffer.
 * @param *f AVFifoBuffer to write to
79 80 81
 * @param *buf data source
 * @param size data size
 */
82
attribute_deprecated void av_fifo_write(AVFifoBuffer *f, const uint8_t *buf, int size);
83
#endif
84 85

/**
86
 * Feeds data from a user-supplied callback to an AVFifoBuffer.
87
 * @param *f AVFifoBuffer to write to
88
 * @param *src data source
89
 * @param size number of bytes to write
90 91
 * @param *func generic write function; the first parameter is src,
 * the second is dest_buf, the third is dest_buf_size.
92 93
 * func must return the number of bytes written to dest_buf, or <= 0 to
 * indicate no more data available to write.
94
 * If func is NULL, src is interpreted as a simple byte array for source data.
95
 * @return the number of bytes written to the FIFO
96
 */
97
int av_fifo_generic_write(AVFifoBuffer *f, void *src, int size, int (*func)(void*, void*, int));
98

99
#if LIBAVUTIL_VERSION_MAJOR < 50
100
/**
101 102 103
 * Resizes an AVFifoBuffer.
 * @param *f AVFifoBuffer to resize
 * @param size new AVFifoBuffer size in bytes
104
 * @see av_fifo_realloc2()
105
 */
106 107
attribute_deprecated void av_fifo_realloc(AVFifoBuffer *f, unsigned int size);
#endif
108

109 110 111 112
/**
 * Resizes an AVFifoBuffer.
 * @param *f AVFifoBuffer to resize
 * @param size new AVFifoBuffer size in bytes
113
 * @return <0 for failure, >=0 otherwise
114 115 116
 */
int av_fifo_realloc2(AVFifoBuffer *f, unsigned int size);

117
/**
118 119 120
 * Reads and discards the specified amount of data from an AVFifoBuffer.
 * @param *f AVFifoBuffer to read from
 * @param size amount of data to read in bytes
121
 */
122 123 124 125 126 127 128 129 130
void av_fifo_drain(AVFifoBuffer *f, int size);

static inline uint8_t av_fifo_peek(AVFifoBuffer *f, int offs)
{
    uint8_t *ptr = f->rptr + offs;
    if (ptr >= f->end)
        ptr -= f->end - f->buffer;
    return *ptr;
}
131
#endif /* AVUTIL_FIFO_H */