Mercurial > libavutil.hg
annotate fifo.h @ 708:2cd525e90b45 libavutil
Make the pixel formats which were defined as macros:
PIX_FMT_ARGB
PIX_FMT_RGBA
PIX_FMT_ABGR
PIX_FMT_BGRA
defined as enum PixelFormat values, and viceversa make:
PIX_FMT_RGB32
PIX_FMT_RGB32_1
PIX_FMT_BGR32
PIX_FMT_BGR32_1
defined as macros, also resort accordingly the enum PixelFormat
list.
Also make avcodec_get_pix_fmt() recognize the "rgb32" and "bgr32"
aliases, in order to make ffmpeg pass regressions test.
This change breaks ABI backward compatibility.
author | stefano |
---|---|
date | Sun, 22 Mar 2009 22:50:19 +0000 |
parents | 4e9e0c52ed08 |
children | 2f890bb12bbc |
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 /** |
688
91216685a7ae
Add av_fifo_reset function to completely reset fifo state, which makes
reimar
parents:
686
diff
changeset
|
51 * Resets the AVFifoBuffer to the state right after av_fifo_alloc, in particular it is emptied. |
91216685a7ae
Add av_fifo_reset function to completely reset fifo state, which makes
reimar
parents:
686
diff
changeset
|
52 * @param *f AVFifoBuffer to reset |
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 void av_fifo_reset(AVFifoBuffer *f); |
91216685a7ae
Add av_fifo_reset function to completely reset fifo state, which makes
reimar
parents:
686
diff
changeset
|
55 |
91216685a7ae
Add av_fifo_reset function to completely reset fifo state, which makes
reimar
parents:
686
diff
changeset
|
56 /** |
268
d64157d7a30f
Improve Doxygen documentation, inspired by Michael's description.
diego
parents:
264
diff
changeset
|
57 * 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
|
58 * amount of data you can read from it. |
d64157d7a30f
Improve Doxygen documentation, inspired by Michael's description.
diego
parents:
264
diff
changeset
|
59 * @param *f AVFifoBuffer to read from |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
60 * @return size |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
61 */ |
110 | 62 int av_fifo_size(AVFifoBuffer *f); |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
63 |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
64 /** |
633 | 65 * 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
|
66 * @param *f AVFifoBuffer to read from |
d64157d7a30f
Improve Doxygen documentation, inspired by Michael's description.
diego
parents:
264
diff
changeset
|
67 * @param buf_size number of bytes to read |
264
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
68 * @param *func generic read function |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
69 * @param *dest data destination |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
70 */ |
691
4e9e0c52ed08
Reorder arguments for av_fifo_generic_read to be more logical and
reimar
parents:
688
diff
changeset
|
71 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
|
72 |
492 | 73 /** |
633 | 74 * Feeds data from a user-supplied callback to an AVFifoBuffer. |
492 | 75 * @param *f AVFifoBuffer to write to |
493 | 76 * @param *src data source |
492 | 77 * @param size number of bytes to write |
633 | 78 * @param *func generic write function; the first parameter is src, |
79 * the second is dest_buf, the third is dest_buf_size. | |
492 | 80 * func must return the number of bytes written to dest_buf, or <= 0 to |
81 * indicate no more data available to write. | |
493 | 82 * If func is NULL, src is interpreted as a simple byte array for source data. |
633 | 83 * @return the number of bytes written to the FIFO |
492 | 84 */ |
493 | 85 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
|
86 |
73376a65f2e1
Doxygen documentation for all functions, patch by Dujardin Bernard,
diego
parents:
263
diff
changeset
|
87 /** |
564 | 88 * Resizes an AVFifoBuffer. |
89 * @param *f AVFifoBuffer to resize | |
90 * @param size new AVFifoBuffer size in bytes | |
633 | 91 * @return <0 for failure, >=0 otherwise |
564 | 92 */ |
93 int av_fifo_realloc2(AVFifoBuffer *f, unsigned int size); | |
94 | |
95 /** | |
268
d64157d7a30f
Improve Doxygen documentation, inspired by Michael's description.
diego
parents:
264
diff
changeset
|
96 * 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
|
97 * @param *f AVFifoBuffer to read from |
d64157d7a30f
Improve Doxygen documentation, inspired by Michael's description.
diego
parents:
264
diff
changeset
|
98 * @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
|
99 */ |
110 | 100 void av_fifo_drain(AVFifoBuffer *f, int size); |
101 | |
102 static inline uint8_t av_fifo_peek(AVFifoBuffer *f, int offs) | |
103 { | |
104 uint8_t *ptr = f->rptr + offs; | |
105 if (ptr >= f->end) | |
106 ptr -= f->end - f->buffer; | |
107 return *ptr; | |
108 } | |
567 | 109 #endif /* AVUTIL_FIFO_H */ |