git.sesse.net Git - casparcg/blob - ffmpeg 0.8/include/libavutil/fifo.h

   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
  19 /**
  20  * @file
  21  * a very simple circular buffer FIFO implementation
  22  */
  23
  24 #ifndef AVUTIL_FIFO_H
  25 #define AVUTIL_FIFO_H
  26
  27 #include <stdint.h>
  28 #include "avutil.h"
  29
  30 typedef struct AVFifoBuffer {
  31     uint8_t *buffer;
  32     uint8_t *rptr, *wptr, *end;
  33     uint32_t rndx, wndx;
  34 } AVFifoBuffer;
  35
  36 /**
  37  * Initialize an AVFifoBuffer.
  38  * @param size of FIFO
  39  * @return AVFifoBuffer or NULL in case of memory allocation failure
  40  */
  41 AVFifoBuffer *av_fifo_alloc(unsigned int size);
  42
  43 /**
  44  * Free an AVFifoBuffer.
  45  * @param f AVFifoBuffer to free
  46  */
  47 void av_fifo_free(AVFifoBuffer *f);
  48
  49 /**
  50  * Reset the AVFifoBuffer to the state right after av_fifo_alloc, in particular it is emptied.
  51  * @param f AVFifoBuffer to reset
  52  */
  53 void av_fifo_reset(AVFifoBuffer *f);
  54
  55 /**
  56  * Return the amount of data in bytes in the AVFifoBuffer, that is the
  57  * amount of data you can read from it.
  58  * @param f AVFifoBuffer to read from
  59  * @return size
  60  */
  61 int av_fifo_size(AVFifoBuffer *f);
  62
  63 /**
  64  * Return the amount of space in bytes in the AVFifoBuffer, that is the
  65  * amount of data you can write into it.
  66  * @param f AVFifoBuffer to write into
  67  * @return size
  68  */
  69 int av_fifo_space(AVFifoBuffer *f);
  70
  71 /**
  72  * Feed data from an AVFifoBuffer to a user-supplied callback.
  73  * @param f AVFifoBuffer to read from
  74  * @param buf_size number of bytes to read
  75  * @param func generic read function
  76  * @param dest data destination
  77  */
  78 int av_fifo_generic_read(AVFifoBuffer *f, void *dest, int buf_size, void (*func)(void*, void*, int));
  79
  80 /**
  81  * Feed data from a user-supplied callback to an AVFifoBuffer.
  82  * @param f AVFifoBuffer to write to
  83  * @param src data source; non-const since it may be used as a
  84  * modifiable context by the function defined in func
  85  * @param size number of bytes to write
  86  * @param func generic write function; the first parameter is src,
  87  * the second is dest_buf, the third is dest_buf_size.
  88  * func must return the number of bytes written to dest_buf, or <= 0 to
  89  * indicate no more data available to write.
  90  * If func is NULL, src is interpreted as a simple byte array for source data.
  91  * @return the number of bytes written to the FIFO
  92  */
  93 int av_fifo_generic_write(AVFifoBuffer *f, void *src, int size, int (*func)(void*, void*, int));
  94
  95 /**
  96  * Resize an AVFifoBuffer.
  97  * In case of reallocation failure, the old FIFO is kept unchanged.
  98  *
  99  * @param f AVFifoBuffer to resize
 100  * @param size new AVFifoBuffer size in bytes
 101  * @return <0 for failure, >=0 otherwise
 102  */
 103 int av_fifo_realloc2(AVFifoBuffer *f, unsigned int size);
 104
 105 /**
 106  * Read and discard the specified amount of data from an AVFifoBuffer.
 107  * @param f AVFifoBuffer to read from
 108  * @param size amount of data to read in bytes
 109  */
 110 void av_fifo_drain(AVFifoBuffer *f, int size);
 111
 112 /**
 113  * Return a pointer to the data stored in a FIFO buffer at a certain offset.
 114  * The FIFO buffer is not modified.
 115  *
 116  * @param f    AVFifoBuffer to peek at, f must be non-NULL
 117  * @param offs an offset in bytes, its absolute value must be less
 118  *             than the used buffer size or the returned pointer will
 119  *             point outside to the buffer data.
 120  *             The used buffer size can be checked with av_fifo_size().
 121  */
 122 static inline uint8_t *av_fifo_peek2(const AVFifoBuffer *f, int offs)
 123 {
 124     uint8_t *ptr = f->rptr + offs;
 125     if (ptr >= f->end)
 126         ptr = f->buffer + (ptr - f->end);
 127     else if (ptr < f->buffer)
 128         ptr = f->end - (f->buffer - ptr);
 129     return ptr;
 130 }
 131
 132 #if FF_API_AV_FIFO_PEEK
 133 /**
 134  * @deprecated Use av_fifo_peek2() instead.
 135  */
 136 attribute_deprecated
 137 static inline uint8_t av_fifo_peek(AVFifoBuffer *f, int offs)
 138 {
 139     return *av_fifo_peek2(f, offs);
 140 }
 141 #endif
 142
 143 #endif /* AVUTIL_FIFO_H */