Mercurial > libavutil.hg

comparison fifo.h @ 957:e34e8d654ded libavutil

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix grammar errors in documentation
author mru
date Wed, 30 Jun 2010 15:38:06 +0000
parents 0795a743bda1
children
comparison
equal deleted inserted replaced
956:2894d4c208dc 957:e34e8d654ded
31 uint8_t *rptr, *wptr, *end; 31 uint8_t *rptr, *wptr, *end;
32 uint32_t rndx, wndx; 32 uint32_t rndx, wndx;
33 } AVFifoBuffer; 33 } AVFifoBuffer;
34 34
35 /** 35 /**
36 * Initializes an AVFifoBuffer. 36 * Initialize an AVFifoBuffer.
37 * @param size of FIFO 37 * @param size of FIFO
38 * @return AVFifoBuffer or NULL in case of memory allocation failure 38 * @return AVFifoBuffer or NULL in case of memory allocation failure
39 */ 39 */
40 AVFifoBuffer *av_fifo_alloc(unsigned int size); 40 AVFifoBuffer *av_fifo_alloc(unsigned int size);
41 41
42 /** 42 /**
43 * Frees an AVFifoBuffer. 43 * Free an AVFifoBuffer.
44 * @param *f AVFifoBuffer to free 44 * @param *f AVFifoBuffer to free
45 */ 45 */
46 void av_fifo_free(AVFifoBuffer *f); 46 void av_fifo_free(AVFifoBuffer *f);
47 47
48 /** 48 /**
49 * Resets the AVFifoBuffer to the state right after av_fifo_alloc, in particular it is emptied. 49 * Reset the AVFifoBuffer to the state right after av_fifo_alloc, in particular it is emptied.
50 * @param *f AVFifoBuffer to reset 50 * @param *f AVFifoBuffer to reset
51 */ 51 */
52 void av_fifo_reset(AVFifoBuffer *f); 52 void av_fifo_reset(AVFifoBuffer *f);
53 53
54 /** 54 /**
55 * Returns the amount of data in bytes in the AVFifoBuffer, that is the 55 * Return the amount of data in bytes in the AVFifoBuffer, that is the
56 * amount of data you can read from it. 56 * amount of data you can read from it.
57 * @param *f AVFifoBuffer to read from 57 * @param *f AVFifoBuffer to read from
58 * @return size 58 * @return size
59 */ 59 */
60 int av_fifo_size(AVFifoBuffer *f); 60 int av_fifo_size(AVFifoBuffer *f);
61 61
62 /** 62 /**
63 * Returns the amount of space in bytes in the AVFifoBuffer, that is the 63 * Return the amount of space in bytes in the AVFifoBuffer, that is the
64 * amount of data you can write into it. 64 * amount of data you can write into it.
65 * @param *f AVFifoBuffer to write into 65 * @param *f AVFifoBuffer to write into
66 * @return size 66 * @return size
67 */ 67 */
68 int av_fifo_space(AVFifoBuffer *f); 68 int av_fifo_space(AVFifoBuffer *f);
69 69
70 /** 70 /**
71 * Feeds data from an AVFifoBuffer to a user-supplied callback. 71 * Feed data from an AVFifoBuffer to a user-supplied callback.
72 * @param *f AVFifoBuffer to read from 72 * @param *f AVFifoBuffer to read from
73 * @param buf_size number of bytes to read 73 * @param buf_size number of bytes to read
74 * @param *func generic read function 74 * @param *func generic read function
75 * @param *dest data destination 75 * @param *dest data destination
76 */ 76 */
77 int av_fifo_generic_read(AVFifoBuffer *f, void *dest, int buf_size, void (*func)(void*, void*, int)); 77 int av_fifo_generic_read(AVFifoBuffer *f, void *dest, int buf_size, void (*func)(void*, void*, int));
78 78
79 /** 79 /**
80 * Feeds data from a user-supplied callback to an AVFifoBuffer. 80 * Feed data from a user-supplied callback to an AVFifoBuffer.
81 * @param *f AVFifoBuffer to write to 81 * @param *f AVFifoBuffer to write to
82 * @param *src data source; non-const since it may be used as a 82 * @param *src data source; non-const since it may be used as a
83 * modifiable context by the function defined in func 83 * modifiable context by the function defined in func
84 * @param size number of bytes to write 84 * @param size number of bytes to write
85 * @param *func generic write function; the first parameter is src, 85 * @param *func generic write function; the first parameter is src,
90 * @return the number of bytes written to the FIFO 90 * @return the number of bytes written to the FIFO
91 */ 91 */
92 int av_fifo_generic_write(AVFifoBuffer *f, void *src, int size, int (*func)(void*, void*, int)); 92 int av_fifo_generic_write(AVFifoBuffer *f, void *src, int size, int (*func)(void*, void*, int));
93 93
94 /** 94 /**
95 * Resizes an AVFifoBuffer. 95 * Resize an AVFifoBuffer.
96 * @param *f AVFifoBuffer to resize 96 * @param *f AVFifoBuffer to resize
97 * @param size new AVFifoBuffer size in bytes 97 * @param size new AVFifoBuffer size in bytes
98 * @return <0 for failure, >=0 otherwise 98 * @return <0 for failure, >=0 otherwise
99 */ 99 */
100 int av_fifo_realloc2(AVFifoBuffer *f, unsigned int size); 100 int av_fifo_realloc2(AVFifoBuffer *f, unsigned int size);
101 101
102 /** 102 /**
103 * Reads and discards the specified amount of data from an AVFifoBuffer. 103 * Read and discard the specified amount of data from an AVFifoBuffer.
104 * @param *f AVFifoBuffer to read from 104 * @param *f AVFifoBuffer to read from
105 * @param size amount of data to read in bytes 105 * @param size amount of data to read in bytes
106 */ 106 */
107 void av_fifo_drain(AVFifoBuffer *f, int size); 107 void av_fifo_drain(AVFifoBuffer *f, int size);
108 108