Mercurial > libavutil.hg
annotate fifo.h @ 961:64a8e85b50be libavutil
Improve GET_UTF{8,16} documentation
author | mru |
---|---|
date | Wed, 30 Jun 2010 20:09:48 +0000 |
parents | e34e8d654ded |
children |
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 /** |
899
0795a743bda1
Remove explicit filename from Doxygen @file commands.
diego
parents:
896
diff
changeset
|
20 * @file |
633 | 21 * a very simple circular buffer FIFO implementation |
264
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 |
567 | 24 #ifndef AVUTIL_FIFO_H |
25 #define AVUTIL_FIFO_H | |
110 | 26 |
343 | 27 #include <stdint.h> |
28 | |
110 | 29 typedef struct AVFifoBuffer { |
30 uint8_t *buffer; | |
31 uint8_t *rptr, *wptr, *end; | |
676 | 32 uint32_t rndx, wndx; |
110 | 33 } AVFifoBuffer; |
34 | |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
35 /** |
957 | 36 * Initialize an AVFifoBuffer. |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
37 * @param size of FIFO |
896 | 38 * @return AVFifoBuffer or NULL in case of memory allocation failure |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
39 */ |
679
58a5033060c3
Allocate AVFifoBuffer through the fifo API to reduce future API/ABI issues.
michael
parents:
676
diff
changeset
|
40 AVFifoBuffer *av_fifo_alloc(unsigned int size); |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
41 |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
42 /** |
957 | 43 * Free an AVFifoBuffer. |
268
d64157d7a30f
Improve Doxygen documentation, inspired by Michael's description.
diego
parents:
264
diff
changeset
|
44 * @param *f AVFifoBuffer to free |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
45 */ |
110 | 46 void av_fifo_free(AVFifoBuffer *f); |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
47 |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
48 /** |
957 | 49 * Reset the AVFifoBuffer to the state right after av_fifo_alloc, in particular it is emptied. |
688
91216685a7ae
Add av_fifo_reset function to completely reset fifo state, which makes
reimar
parents:
686
diff
changeset
|
50 * @param *f AVFifoBuffer to reset |
91216685a7ae
Add av_fifo_reset function to completely reset fifo state, which makes
reimar
parents:
686
diff
changeset
|
51 */ |
91216685a7ae
Add av_fifo_reset function to completely reset fifo state, which makes
reimar
parents:
686
diff
changeset
|
52 void av_fifo_reset(AVFifoBuffer *f); |
91216685a7ae
Add av_fifo_reset function to completely reset fifo state, which makes
reimar
parents:
686
diff
changeset
|
53 |
91216685a7ae
Add av_fifo_reset function to completely reset fifo state, which makes
reimar
parents:
686
diff
changeset
|
54 /** |
957 | 55 * Return the amount of data in bytes in the AVFifoBuffer, that is the |
268
d64157d7a30f
Improve Doxygen documentation, inspired by Michael's description.
diego
parents:
264
diff
changeset
|
56 * amount of data you can read from it. |
d64157d7a30f
Improve Doxygen documentation, inspired by Michael's description.
diego
parents:
264
diff
changeset
|
57 * @param *f AVFifoBuffer to read from |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
58 * @return size |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
59 */ |
110 | 60 int av_fifo_size(AVFifoBuffer *f); |
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 /** |
957 | 63 * Return the amount of space in bytes in the AVFifoBuffer, that is the |
722 | 64 * amount of data you can write into it. |
65 * @param *f AVFifoBuffer to write into | |
66 * @return size | |
67 */ | |
68 int av_fifo_space(AVFifoBuffer *f); | |
69 | |
70 /** | |
957 | 71 * Feed data from an AVFifoBuffer to a user-supplied callback. |
268
d64157d7a30f
Improve Doxygen documentation, inspired by Michael's description.
diego
parents:
264
diff
changeset
|
72 * @param *f AVFifoBuffer to read from |
d64157d7a30f
Improve Doxygen documentation, inspired by Michael's description.
diego
parents:
264
diff
changeset
|
73 * @param buf_size number of bytes to read |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
74 * @param *func generic read function |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
75 * @param *dest data destination |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
76 */ |
691
4e9e0c52ed08
Reorder arguments for av_fifo_generic_read to be more logical and
reimar
parents:
688
diff
changeset
|
77 int av_fifo_generic_read(AVFifoBuffer *f, void *dest, int buf_size, void (*func)(void*, void*, int)); |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
78 |
492 | 79 /** |
957 | 80 * Feed data from a user-supplied callback to an AVFifoBuffer. |
492 | 81 * @param *f AVFifoBuffer to write to |
850
3d6e83a917d2
Extend doxy for the src parameter of av_fifo_generic_write().
stefano
parents:
722
diff
changeset
|
82 * @param *src data source; non-const since it may be used as a |
3d6e83a917d2
Extend doxy for the src parameter of av_fifo_generic_write().
stefano
parents:
722
diff
changeset
|
83 * modifiable context by the function defined in func |
492 | 84 * @param size number of bytes to write |
633 | 85 * @param *func generic write function; the first parameter is src, |
86 * the second is dest_buf, the third is dest_buf_size. | |
492 | 87 * func must return the number of bytes written to dest_buf, or <= 0 to |
88 * indicate no more data available to write. | |
493 | 89 * If func is NULL, src is interpreted as a simple byte array for source data. |
633 | 90 * @return the number of bytes written to the FIFO |
492 | 91 */ |
493 | 92 int av_fifo_generic_write(AVFifoBuffer *f, void *src, int size, int (*func)(void*, void*, int)); |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
93 |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
94 /** |
957 | 95 * Resize an AVFifoBuffer. |
564 | 96 * @param *f AVFifoBuffer to resize |
97 * @param size new AVFifoBuffer size in bytes | |
633 | 98 * @return <0 for failure, >=0 otherwise |
564 | 99 */ |
100 int av_fifo_realloc2(AVFifoBuffer *f, unsigned int size); | |
101 | |
102 /** | |
957 | 103 * Read and discard the specified amount of data from an AVFifoBuffer. |
268
d64157d7a30f
Improve Doxygen documentation, inspired by Michael's description.
diego
parents:
264
diff
changeset
|
104 * @param *f AVFifoBuffer to read from |
d64157d7a30f
Improve Doxygen documentation, inspired by Michael's description.
diego
parents:
264
diff
changeset
|
105 * @param size amount of data to read in bytes |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
106 */ |
110 | 107 void av_fifo_drain(AVFifoBuffer *f, int size); |
108 | |
109 static inline uint8_t av_fifo_peek(AVFifoBuffer *f, int offs) | |
110 { | |
111 uint8_t *ptr = f->rptr + offs; | |
112 if (ptr >= f->end) | |
113 ptr -= f->end - f->buffer; | |
114 return *ptr; | |
115 } | |
567 | 116 #endif /* AVUTIL_FIFO_H */ |