Mercurial > libavutil.hg

comparison fifo.h @ 633:8c48a1b999a3 libavutil

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
spelling/grammar/consistency review part I
author diego
date Wed, 28 Jan 2009 00:16:05 +0000
parents 5a8d0e6cdcfb
children 70bdd5501662
comparison
equal deleted inserted replaced
632:f9884e1112d0 633:8c48a1b999a3
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17 */ 17 */
18 18
19 /** 19 /**
20 * @file fifo.h 20 * @file fifo.h
21 * A very simple circular buffer FIFO implementation. 21 * a very simple circular buffer FIFO implementation
22 */ 22 */
23 23
24 #ifndef AVUTIL_FIFO_H 24 #ifndef AVUTIL_FIFO_H
25 #define AVUTIL_FIFO_H 25 #define AVUTIL_FIFO_H
26 26
62 * @param buf_size number of bytes to read 62 * @param buf_size number of bytes to read
63 */ 63 */
64 int av_fifo_read(AVFifoBuffer *f, uint8_t *buf, int buf_size); 64 int av_fifo_read(AVFifoBuffer *f, uint8_t *buf, int buf_size);
65 65
66 /** 66 /**
67 * Feeds data from an AVFifoBuffer to a user supplied callback. 67 * Feeds data from an AVFifoBuffer to a user-supplied callback.
68 * @param *f AVFifoBuffer to read from 68 * @param *f AVFifoBuffer to read from
69 * @param buf_size number of bytes to read 69 * @param buf_size number of bytes to read
70 * @param *func generic read function 70 * @param *func generic read function
71 * @param *dest data destination 71 * @param *dest data destination
72 */ 72 */
81 */ 81 */
82 attribute_deprecated void av_fifo_write(AVFifoBuffer *f, const uint8_t *buf, int size); 82 attribute_deprecated void av_fifo_write(AVFifoBuffer *f, const uint8_t *buf, int size);
83 #endif 83 #endif
84 84
85 /** 85 /**
86 * Feeds data from a user supplied callback to an AVFifoBuffer. 86 * Feeds data from a user-supplied callback to an AVFifoBuffer.
87 * @param *f AVFifoBuffer to write to 87 * @param *f AVFifoBuffer to write to
88 * @param *src data source 88 * @param *src data source
89 * @param size number of bytes to write 89 * @param size number of bytes to write
90 * @param *func generic write function. First parameter is src, 90 * @param *func generic write function; the first parameter is src,
91 * second is dest_buf, third is dest_buf_size. 91 * the second is dest_buf, the third is dest_buf_size.
92 * func must return the number of bytes written to dest_buf, or <= 0 to 92 * func must return the number of bytes written to dest_buf, or <= 0 to
93 * indicate no more data available to write. 93 * indicate no more data available to write.
94 * If func is NULL, src is interpreted as a simple byte array for source data. 94 * If func is NULL, src is interpreted as a simple byte array for source data.
95 * @return the number of bytes written to the fifo. 95 * @return the number of bytes written to the FIFO
96 */ 96 */
97 int av_fifo_generic_write(AVFifoBuffer *f, void *src, int size, int (*func)(void*, void*, int)); 97 int av_fifo_generic_write(AVFifoBuffer *f, void *src, int size, int (*func)(void*, void*, int));
98 98
99 #if LIBAVUTIL_VERSION_MAJOR < 50 99 #if LIBAVUTIL_VERSION_MAJOR < 50
100 /** 100 /**
108 108
109 /** 109 /**
110 * Resizes an AVFifoBuffer. 110 * Resizes an AVFifoBuffer.
111 * @param *f AVFifoBuffer to resize 111 * @param *f AVFifoBuffer to resize
112 * @param size new AVFifoBuffer size in bytes 112 * @param size new AVFifoBuffer size in bytes
113 * @return <0 for failure >=0 otherwise 113 * @return <0 for failure, >=0 otherwise
114 */ 114 */
115 int av_fifo_realloc2(AVFifoBuffer *f, unsigned int size); 115 int av_fifo_realloc2(AVFifoBuffer *f, unsigned int size);
116 116
117 /** 117 /**
118 * Reads and discards the specified amount of data from an AVFifoBuffer. 118 * Reads and discards the specified amount of data from an AVFifoBuffer.