Fix H.264 interframe decoding when compiling with icc. Patch by Loren
[libav.git] / libavutil / fifo.h
CommitLineData
f5a90186
DB
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
1faf7dc8
DB
19/**
20 * @file fifo.h
21 * A very simple circular buffer FIFO implementation.
22 */
23
5b21bdab
DB
24#ifndef FFMPEG_FIFO_H
25#define FFMPEG_FIFO_H
f5a478f6 26
99545457
MR
27#include <stdint.h>
28
f5a478f6
RS
29typedef struct AVFifoBuffer {
30 uint8_t *buffer;
31 uint8_t *rptr, *wptr, *end;
32} AVFifoBuffer;
33
1faf7dc8 34/**
82ffe191
DB
35 * Initializes an AVFifoBuffer.
36 * @param *f AVFifoBuffer to initialize
1faf7dc8
DB
37 * @param size of FIFO
38 * @return <0 for failure >=0 otherwise
39 */
f5a478f6 40int av_fifo_init(AVFifoBuffer *f, int size);
1faf7dc8
DB
41
42/**
82ffe191
DB
43 * Frees an AVFifoBuffer.
44 * @param *f AVFifoBuffer to free
1faf7dc8 45 */
f5a478f6 46void av_fifo_free(AVFifoBuffer *f);
1faf7dc8
DB
47
48/**
82ffe191
DB
49 * Returns the amount of data in bytes in the AVFifoBuffer, that is the
50 * amount of data you can read from it.
51 * @param *f AVFifoBuffer to read from
1faf7dc8
DB
52 * @return size
53 */
f5a478f6 54int av_fifo_size(AVFifoBuffer *f);
1faf7dc8
DB
55
56/**
82ffe191
DB
57 * Reads data from an AVFifoBuffer.
58 * @param *f AVFifoBuffer to read from
1faf7dc8 59 * @param *buf data destination
82ffe191 60 * @param buf_size number of bytes to read
1faf7dc8 61 */
f5a478f6 62int av_fifo_read(AVFifoBuffer *f, uint8_t *buf, int buf_size);
1faf7dc8
DB
63
64/**
82ffe191
DB
65 * Feeds data from an AVFifoBuffer to a user supplied callback.
66 * @param *f AVFifoBuffer to read from
67 * @param buf_size number of bytes to read
1faf7dc8
DB
68 * @param *func generic read function
69 * @param *dest data destination
1faf7dc8 70 */
f5a478f6 71int av_fifo_generic_read(AVFifoBuffer *f, int buf_size, void (*func)(void*, void*, int), void* dest);
1faf7dc8
DB
72
73/**
82ffe191
DB
74 * Writes data into an AVFifoBuffer.
75 * @param *f AVFifoBuffer to write to
1faf7dc8
DB
76 * @param *buf data source
77 * @param size data size
78 */
f5a478f6 79void av_fifo_write(AVFifoBuffer *f, const uint8_t *buf, int size);
1faf7dc8
DB
80
81/**
82ffe191
DB
82 * Resizes an AVFifoBuffer.
83 * @param *f AVFifoBuffer to resize
84 * @param size new AVFifoBuffer size in bytes
1faf7dc8 85 */
f5a478f6 86void av_fifo_realloc(AVFifoBuffer *f, unsigned int size);
1faf7dc8
DB
87
88/**
82ffe191
DB
89 * Reads and discards the specified amount of data from an AVFifoBuffer.
90 * @param *f AVFifoBuffer to read from
91 * @param size amount of data to read in bytes
1faf7dc8 92 */
f5a478f6
RS
93void av_fifo_drain(AVFifoBuffer *f, int size);
94
95static inline uint8_t av_fifo_peek(AVFifoBuffer *f, int offs)
96{
97 uint8_t *ptr = f->rptr + offs;
98 if (ptr >= f->end)
99 ptr -= f->end - f->buffer;
100 return *ptr;
101}
5b21bdab 102#endif /* FFMPEG_FIFO_H */