Reorder arguments for av_fifo_generic_read to be more logical and
[libav.git] / libavutil / fifo.h
index 1776034..d353844 100644 (file)
  */
 
 /**
- * @file fifo.h
- * A very simple circular buffer FIFO implementation.
+ * @file libavutil/fifo.h
+ * a very simple circular buffer FIFO implementation
  */
 
-#ifndef FIFO_H
-#define FIFO_H
+#ifndef AVUTIL_FIFO_H
+#define AVUTIL_FIFO_H
+
+#include <stdint.h>
+#include "avutil.h"
+#include "common.h"
 
 typedef struct AVFifoBuffer {
     uint8_t *buffer;
     uint8_t *rptr, *wptr, *end;
+    uint32_t rndx, wndx;
 } AVFifoBuffer;
 
 /**
- * Initializes a FIFO *.
- * @param *f FIFO buffer
+ * Initializes an AVFifoBuffer.
  * @param size of FIFO
- * @return <0 for failure >=0 otherwise
+ * @return AVFifoBuffer or NULL if mem allocation failure
  */
-int av_fifo_init(AVFifoBuffer *f, int size);
+AVFifoBuffer *av_fifo_alloc(unsigned int size);
 
 /**
- * Frees a FIFO *.
- * @param *f FIFO buffer
+ * Frees an AVFifoBuffer.
+ * @param *f AVFifoBuffer to free
  */
 void av_fifo_free(AVFifoBuffer *f);
 
 /**
- * Returns the size of a FIFO *.
- * @param *f FIFO buffer
- * @return size
+ * Resets the AVFifoBuffer to the state right after av_fifo_alloc, in particular it is emptied.
+ * @param *f AVFifoBuffer to reset
  */
-int av_fifo_size(AVFifoBuffer *f);
+void av_fifo_reset(AVFifoBuffer *f);
 
 /**
- * Reads the data from the FIFO *.
- * @param *f FIFO buffer
- * @param *buf data destination
- * @param buf_size data size
- * @return -1 if not enough data
+ * Returns the amount of data in bytes in the AVFifoBuffer, that is the
+ * amount of data you can read from it.
+ * @param *f AVFifoBuffer to read from
+ * @return size
  */
-int av_fifo_read(AVFifoBuffer *f, uint8_t *buf, int buf_size);
+int av_fifo_size(AVFifoBuffer *f);
 
 /**
- * Reads the data from the FIFO *.
- * @param *f FIFO buffer
- * @param buf_size data size
+ * Feeds data from an AVFifoBuffer to a user-supplied callback.
+ * @param *f AVFifoBuffer to read from
+ * @param buf_size number of bytes to read
  * @param *func generic read function
  * @param *dest data destination
- * @return -1 if not enough data
  */
-int av_fifo_generic_read(AVFifoBuffer *f, int buf_size, void (*func)(void*, void*, int), void* dest);
+int av_fifo_generic_read(AVFifoBuffer *f, void *dest, int buf_size, void (*func)(void*, void*, int));
 
 /**
- * Writes the data in the FIFO *.
- * @param *f FIFO buffer
- * @param *buf data source
- * @param size data size
+ * Feeds data from a user-supplied callback to an AVFifoBuffer.
+ * @param *f AVFifoBuffer to write to
+ * @param *src data source
+ * @param size number of bytes to write
+ * @param *func generic write function; the first parameter is src,
+ * the second is dest_buf, the third is dest_buf_size.
+ * func must return the number of bytes written to dest_buf, or <= 0 to
+ * indicate no more data available to write.
+ * If func is NULL, src is interpreted as a simple byte array for source data.
+ * @return the number of bytes written to the FIFO
  */
-void av_fifo_write(AVFifoBuffer *f, const uint8_t *buf, int size);
+int av_fifo_generic_write(AVFifoBuffer *f, void *src, int size, int (*func)(void*, void*, int));
 
 /**
- * Resizes the FIFO *.
- * @param *f FIFO buffer
- * @param size data size
+ * Resizes an AVFifoBuffer.
+ * @param *f AVFifoBuffer to resize
+ * @param size new AVFifoBuffer size in bytes
+ * @return <0 for failure, >=0 otherwise
  */
-void av_fifo_realloc(AVFifoBuffer *f, unsigned int size);
+int av_fifo_realloc2(AVFifoBuffer *f, unsigned int size);
 
 /**
- * Discards the data from the FIFO *.
- * @param *f FIFO buffer
- * @param size data size
+ * Reads and discards the specified amount of data from an AVFifoBuffer.
+ * @param *f AVFifoBuffer to read from
+ * @param size amount of data to read in bytes
  */
 void av_fifo_drain(AVFifoBuffer *f, int size);
 
-/**
- * Returns a pointer with circular offset from FIFO's read pointer.
- * @param *f FIFO buffer
- * @param offs offset
- * @return ptr=rptr+offs if rptr+offs<end else rptr+offs -(end-begin)
- */
 static inline uint8_t av_fifo_peek(AVFifoBuffer *f, int offs)
 {
     uint8_t *ptr = f->rptr + offs;
@@ -104,4 +106,4 @@ static inline uint8_t av_fifo_peek(AVFifoBuffer *f, int offs)
         ptr -= f->end - f->buffer;
     return *ptr;
 }
-#endif /* FIFO_H */
+#endif /* AVUTIL_FIFO_H */