Mercurial > libavutil.hg
annotate fifo.h @ 265:e9dcd3be3f67 libavutil
get_packetheader() forgot to read the header_checksum in big packets
patch from Clemens Ladisch cladisch AT fastmail dot net
(stray base64 patch reverted in the next commits)
author | lu_zero |
---|---|
date | Wed, 28 Feb 2007 03:28:31 +0000 |
parents | 73376a65f2e1 |
children | d64157d7a30f |
rev | line source |
---|---|
263 | 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 | |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
19 /** |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
20 * @file fifo.h |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
21 * A very simple circular buffer FIFO implementation. |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
22 */ |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
23 |
110 | 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 | |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
32 /** |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
33 * Initializes a FIFO *. |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
34 * @param *f FIFO buffer |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
35 * @param size of FIFO |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
36 * @return <0 for failure >=0 otherwise |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
37 */ |
110 | 38 int av_fifo_init(AVFifoBuffer *f, int size); |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
39 |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
40 /** |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
41 * Frees a FIFO *. |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
42 * @param *f FIFO buffer |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
43 */ |
110 | 44 void av_fifo_free(AVFifoBuffer *f); |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
45 |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
46 /** |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
47 * Returns the size of a FIFO *. |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
48 * @param *f FIFO buffer |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
49 * @return size |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
50 */ |
110 | 51 int av_fifo_size(AVFifoBuffer *f); |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
52 |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
53 /** |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
54 * Reads the data from the FIFO *. |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
55 * @param *f FIFO buffer |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
56 * @param *buf data destination |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
57 * @param buf_size data size |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
58 * @return -1 if not enough data |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
59 */ |
110 | 60 int av_fifo_read(AVFifoBuffer *f, uint8_t *buf, int buf_size); |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
61 |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
62 /** |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
63 * Reads the data from the FIFO *. |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
64 * @param *f FIFO buffer |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
65 * @param buf_size data size |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
66 * @param *func generic read function |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
67 * @param *dest data destination |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
68 * @return -1 if not enough data |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
69 */ |
110 | 70 int av_fifo_generic_read(AVFifoBuffer *f, int buf_size, void (*func)(void*, void*, int), void* dest); |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
71 |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
72 /** |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
73 * Writes the data in the FIFO *. |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
74 * @param *f FIFO buffer |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
75 * @param *buf data source |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
76 * @param size data size |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
77 */ |
110 | 78 void av_fifo_write(AVFifoBuffer *f, const uint8_t *buf, int size); |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
79 |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
80 /** |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
81 * Resizes the FIFO *. |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
82 * @param *f FIFO buffer |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
83 * @param size data size |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
84 */ |
110 | 85 void av_fifo_realloc(AVFifoBuffer *f, unsigned int size); |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
86 |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
87 /** |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
88 * Discards the data from the FIFO *. |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
89 * @param *f FIFO buffer |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
90 * @param size data size |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
91 */ |
110 | 92 void av_fifo_drain(AVFifoBuffer *f, int size); |
93 | |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
94 /** |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
95 * Returns a pointer with circular offset from FIFO's read pointer. |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
96 * @param *f FIFO buffer |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
97 * @param offs offset |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
98 * @return ptr=rptr+offs if rptr+offs<end else rptr+offs -(end-begin) |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
99 */ |
110 | 100 static inline uint8_t av_fifo_peek(AVFifoBuffer *f, int offs) |
101 { | |
102 uint8_t *ptr = f->rptr + offs; | |
103 if (ptr >= f->end) | |
104 ptr -= f->end - f->buffer; | |
105 return *ptr; | |
106 } | |
107 #endif /* FIFO_H */ |