]> git.sesse.net Git - ffmpeg/blobdiff - libavutil/fifo.h
Add support for full header extradata to raw FLAC muxer.
[ffmpeg] / libavutil / fifo.h
index e1e85293dd32793d3d2dc3b8aefd42101164d774..1a549f254c1087e148b168c441d956c4558bd1be 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;
@@ -35,7 +39,7 @@ typedef struct AVFifoBuffer {
  * @param size of FIFO
  * @return <0 for failure >=0 otherwise
  */
-int av_fifo_init(AVFifoBuffer *f, int size);
+int av_fifo_init(AVFifoBuffer *f, unsigned int size);
 
 /**
  * Frees an AVFifoBuffer.
@@ -60,7 +64,7 @@ int av_fifo_size(AVFifoBuffer *f);
 int av_fifo_read(AVFifoBuffer *f, uint8_t *buf, int buf_size);
 
 /**
- * Feeds data from an AVFifoBuffer to a user supplied callback.
+ * 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
@@ -68,20 +72,47 @@ int av_fifo_read(AVFifoBuffer *f, uint8_t *buf, int buf_size);
  */
 int av_fifo_generic_read(AVFifoBuffer *f, int buf_size, void (*func)(void*, void*, int), void* dest);
 
+#if LIBAVUTIL_VERSION_MAJOR < 50
 /**
  * Writes data into an AVFifoBuffer.
  * @param *f AVFifoBuffer to write to
  * @param *buf data source
  * @param size data size
  */
-void av_fifo_write(AVFifoBuffer *f, const uint8_t *buf, int size);
+attribute_deprecated void av_fifo_write(AVFifoBuffer *f, const uint8_t *buf, int size);
+#endif
+
+/**
+ * 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
+ */
+int av_fifo_generic_write(AVFifoBuffer *f, void *src, int size, int (*func)(void*, void*, int));
+
+#if LIBAVUTIL_VERSION_MAJOR < 50
+/**
+ * Resizes an AVFifoBuffer.
+ * @param *f AVFifoBuffer to resize
+ * @param size new AVFifoBuffer size in bytes
+ * @see av_fifo_realloc2()
+ */
+attribute_deprecated void av_fifo_realloc(AVFifoBuffer *f, unsigned int size);
+#endif
 
 /**
  * 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);
 
 /**
  * Reads and discards the specified amount of data from an AVFifoBuffer.
@@ -97,4 +128,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 */