Mercurial > libavutil.hg
annotate fifo.h @ 679:58a5033060c3 libavutil
Allocate AVFifoBuffer through the fifo API to reduce future API/ABI issues.
Yes this breaks ABI/API but ive already broken it and will bump avutil major
soon.
author | michael |
---|---|
date | Sun, 08 Mar 2009 14:16:55 +0000 |
parents | 5e391d180d81 |
children | cb5d78a798ac |
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 /** |
642
70bdd5501662
Use full internal pathname in doxygen @file directives.
diego
parents:
633
diff
changeset
|
20 * @file libavutil/fifo.h |
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> |
602 | 28 #include "avutil.h" |
502 | 29 #include "common.h" |
343 | 30 |
110 | 31 typedef struct AVFifoBuffer { |
32 uint8_t *buffer; | |
33 uint8_t *rptr, *wptr, *end; | |
676 | 34 uint32_t rndx, wndx; |
110 | 35 } AVFifoBuffer; |
36 | |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
37 /** |
268
d64157d7a30f
Improve Doxygen documentation, inspired by Michael's description.
diego
parents:
264
diff
changeset
|
38 * Initializes an AVFifoBuffer. |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
39 * @param size of FIFO |
679
58a5033060c3
Allocate AVFifoBuffer through the fifo API to reduce future API/ABI issues.
michael
parents:
676
diff
changeset
|
40 * @return AVFifoBuffer or NULL if mem allocation failure |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
41 */ |
679
58a5033060c3
Allocate AVFifoBuffer through the fifo API to reduce future API/ABI issues.
michael
parents:
676
diff
changeset
|
42 AVFifoBuffer *av_fifo_alloc(unsigned int size); |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
43 |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
44 /** |
268
d64157d7a30f
Improve Doxygen documentation, inspired by Michael's description.
diego
parents:
264
diff
changeset
|
45 * Frees an AVFifoBuffer. |
d64157d7a30f
Improve Doxygen documentation, inspired by Michael's description.
diego
parents:
264
diff
changeset
|
46 * @param *f AVFifoBuffer to free |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
47 */ |
110 | 48 void av_fifo_free(AVFifoBuffer *f); |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
49 |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
50 /** |
268
d64157d7a30f
Improve Doxygen documentation, inspired by Michael's description.
diego
parents:
264
diff
changeset
|
51 * Returns the amount of data in bytes in the AVFifoBuffer, that is the |
d64157d7a30f
Improve Doxygen documentation, inspired by Michael's description.
diego
parents:
264
diff
changeset
|
52 * amount of data you can read from it. |
d64157d7a30f
Improve Doxygen documentation, inspired by Michael's description.
diego
parents:
264
diff
changeset
|
53 * @param *f AVFifoBuffer to read from |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
54 * @return size |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
55 */ |
110 | 56 int av_fifo_size(AVFifoBuffer *f); |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
57 |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
58 /** |
268
d64157d7a30f
Improve Doxygen documentation, inspired by Michael's description.
diego
parents:
264
diff
changeset
|
59 * Reads data from an AVFifoBuffer. |
d64157d7a30f
Improve Doxygen documentation, inspired by Michael's description.
diego
parents:
264
diff
changeset
|
60 * @param *f AVFifoBuffer to read from |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
61 * @param *buf data destination |
268
d64157d7a30f
Improve Doxygen documentation, inspired by Michael's description.
diego
parents:
264
diff
changeset
|
62 * @param buf_size number of bytes to read |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
63 */ |
110 | 64 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
|
65 |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
66 /** |
633 | 67 * Feeds data from an AVFifoBuffer to a user-supplied callback. |
268
d64157d7a30f
Improve Doxygen documentation, inspired by Michael's description.
diego
parents:
264
diff
changeset
|
68 * @param *f AVFifoBuffer to read from |
d64157d7a30f
Improve Doxygen documentation, inspired by Michael's description.
diego
parents:
264
diff
changeset
|
69 * @param buf_size number of bytes to read |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
70 * @param *func generic read function |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
71 * @param *dest data destination |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
72 */ |
110 | 73 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
|
74 |
623
5a8d0e6cdcfb
Drop deprecated av_fifo_write function with the next libavutil version bump.
diego
parents:
602
diff
changeset
|
75 #if LIBAVUTIL_VERSION_MAJOR < 50 |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
76 /** |
268
d64157d7a30f
Improve Doxygen documentation, inspired by Michael's description.
diego
parents:
264
diff
changeset
|
77 * Writes data into an AVFifoBuffer. |
d64157d7a30f
Improve Doxygen documentation, inspired by Michael's description.
diego
parents:
264
diff
changeset
|
78 * @param *f AVFifoBuffer to write to |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
79 * @param *buf data source |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
80 * @param size data size |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
81 */ |
492 | 82 attribute_deprecated void av_fifo_write(AVFifoBuffer *f, const uint8_t *buf, int size); |
623
5a8d0e6cdcfb
Drop deprecated av_fifo_write function with the next libavutil version bump.
diego
parents:
602
diff
changeset
|
83 #endif |
492 | 84 |
85 /** | |
633 | 86 * Feeds data from a user-supplied callback to an AVFifoBuffer. |
492 | 87 * @param *f AVFifoBuffer to write to |
493 | 88 * @param *src data source |
492 | 89 * @param size number of bytes to write |
633 | 90 * @param *func generic write function; the first parameter is src, |
91 * the second is dest_buf, the third is dest_buf_size. | |
492 | 92 * func must return the number of bytes written to dest_buf, or <= 0 to |
93 * indicate no more data available to write. | |
493 | 94 * If func is NULL, src is interpreted as a simple byte array for source data. |
633 | 95 * @return the number of bytes written to the FIFO |
492 | 96 */ |
493 | 97 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
|
98 |
565
a0dab9157d6a
Deprecate av_fifo_realloc(). av_fifo_realloc2() should be used instead.
stefano
parents:
564
diff
changeset
|
99 #if LIBAVUTIL_VERSION_MAJOR < 50 |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
100 /** |
268
d64157d7a30f
Improve Doxygen documentation, inspired by Michael's description.
diego
parents:
264
diff
changeset
|
101 * Resizes an AVFifoBuffer. |
d64157d7a30f
Improve Doxygen documentation, inspired by Michael's description.
diego
parents:
264
diff
changeset
|
102 * @param *f AVFifoBuffer to resize |
d64157d7a30f
Improve Doxygen documentation, inspired by Michael's description.
diego
parents:
264
diff
changeset
|
103 * @param size new AVFifoBuffer size in bytes |
564 | 104 * @see av_fifo_realloc2() |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
105 */ |
565
a0dab9157d6a
Deprecate av_fifo_realloc(). av_fifo_realloc2() should be used instead.
stefano
parents:
564
diff
changeset
|
106 attribute_deprecated void av_fifo_realloc(AVFifoBuffer *f, unsigned int size); |
a0dab9157d6a
Deprecate av_fifo_realloc(). av_fifo_realloc2() should be used instead.
stefano
parents:
564
diff
changeset
|
107 #endif |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
108 |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
109 /** |
564 | 110 * Resizes an AVFifoBuffer. |
111 * @param *f AVFifoBuffer to resize | |
112 * @param size new AVFifoBuffer size in bytes | |
633 | 113 * @return <0 for failure, >=0 otherwise |
564 | 114 */ |
115 int av_fifo_realloc2(AVFifoBuffer *f, unsigned int size); | |
116 | |
117 /** | |
268
d64157d7a30f
Improve Doxygen documentation, inspired by Michael's description.
diego
parents:
264
diff
changeset
|
118 * Reads and discards the specified amount of data from an AVFifoBuffer. |
d64157d7a30f
Improve Doxygen documentation, inspired by Michael's description.
diego
parents:
264
diff
changeset
|
119 * @param *f AVFifoBuffer to read from |
d64157d7a30f
Improve Doxygen documentation, inspired by Michael's description.
diego
parents:
264
diff
changeset
|
120 * @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
|
121 */ |
110 | 122 void av_fifo_drain(AVFifoBuffer *f, int size); |
123 | |
124 static inline uint8_t av_fifo_peek(AVFifoBuffer *f, int offs) | |
125 { | |
126 uint8_t *ptr = f->rptr + offs; | |
127 if (ptr >= f->end) | |
128 ptr -= f->end - f->buffer; | |
129 return *ptr; | |
130 } | |
567 | 131 #endif /* AVUTIL_FIFO_H */ |