2007-02-27 18:05:19 +02:00
|
|
|
/*
|
2011-03-18 19:35:10 +02:00
|
|
|
* This file is part of Libav.
|
2007-02-27 18:05:19 +02:00
|
|
|
*
|
2011-03-18 19:35:10 +02:00
|
|
|
* Libav is free software; you can redistribute it and/or
|
2007-02-27 18:05:19 +02:00
|
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
|
|
* License as published by the Free Software Foundation; either
|
|
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
|
|
*
|
2011-03-18 19:35:10 +02:00
|
|
|
* Libav is distributed in the hope that it will be useful,
|
2007-02-27 18:05:19 +02:00
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
* Lesser General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU Lesser General Public
|
2011-03-18 19:35:10 +02:00
|
|
|
* License along with Libav; if not, write to the Free Software
|
2007-02-27 18:05:19 +02:00
|
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
|
|
*/
|
|
|
|
|
2007-02-27 19:49:00 +02:00
|
|
|
/**
|
2010-04-20 17:45:34 +03:00
|
|
|
* @file
|
2009-01-28 02:16:05 +02:00
|
|
|
* a very simple circular buffer FIFO implementation
|
2007-02-27 19:49:00 +02:00
|
|
|
*/
|
|
|
|
|
2008-08-31 10:39:47 +03:00
|
|
|
#ifndef AVUTIL_FIFO_H
|
|
|
|
#define AVUTIL_FIFO_H
|
2006-09-21 10:31:53 +03:00
|
|
|
|
2007-06-17 01:59:13 +03:00
|
|
|
#include <stdint.h>
|
2011-06-29 18:30:23 +03:00
|
|
|
#include "avutil.h"
|
2007-06-17 01:59:13 +03:00
|
|
|
|
2006-09-21 10:31:53 +03:00
|
|
|
typedef struct AVFifoBuffer {
|
|
|
|
uint8_t *buffer;
|
|
|
|
uint8_t *rptr, *wptr, *end;
|
2009-03-07 23:02:08 +02:00
|
|
|
uint32_t rndx, wndx;
|
2006-09-21 10:31:53 +03:00
|
|
|
} AVFifoBuffer;
|
|
|
|
|
2007-02-27 19:49:00 +02:00
|
|
|
/**
|
2010-06-30 18:38:06 +03:00
|
|
|
* Initialize an AVFifoBuffer.
|
2007-02-27 19:49:00 +02:00
|
|
|
* @param size of FIFO
|
2010-04-07 01:31:59 +03:00
|
|
|
* @return AVFifoBuffer or NULL in case of memory allocation failure
|
2007-02-27 19:49:00 +02:00
|
|
|
*/
|
2009-03-08 16:16:55 +02:00
|
|
|
AVFifoBuffer *av_fifo_alloc(unsigned int size);
|
2007-02-27 19:49:00 +02:00
|
|
|
|
|
|
|
/**
|
2010-06-30 18:38:06 +03:00
|
|
|
* Free an AVFifoBuffer.
|
2011-08-08 13:06:26 +03:00
|
|
|
* @param f AVFifoBuffer to free
|
2007-02-27 19:49:00 +02:00
|
|
|
*/
|
2006-09-21 10:31:53 +03:00
|
|
|
void av_fifo_free(AVFifoBuffer *f);
|
2007-02-27 19:49:00 +02:00
|
|
|
|
2009-03-09 11:26:32 +02:00
|
|
|
/**
|
2010-06-30 18:38:06 +03:00
|
|
|
* Reset the AVFifoBuffer to the state right after av_fifo_alloc, in particular it is emptied.
|
2011-08-08 13:06:26 +03:00
|
|
|
* @param f AVFifoBuffer to reset
|
2009-03-09 11:26:32 +02:00
|
|
|
*/
|
|
|
|
void av_fifo_reset(AVFifoBuffer *f);
|
|
|
|
|
2007-02-27 19:49:00 +02:00
|
|
|
/**
|
2010-06-30 18:38:06 +03:00
|
|
|
* Return the amount of data in bytes in the AVFifoBuffer, that is the
|
2007-03-02 12:09:51 +02:00
|
|
|
* amount of data you can read from it.
|
2011-08-08 13:06:26 +03:00
|
|
|
* @param f AVFifoBuffer to read from
|
2007-02-27 19:49:00 +02:00
|
|
|
* @return size
|
|
|
|
*/
|
2006-09-21 10:31:53 +03:00
|
|
|
int av_fifo_size(AVFifoBuffer *f);
|
2007-02-27 19:49:00 +02:00
|
|
|
|
2009-04-03 02:22:19 +03:00
|
|
|
/**
|
2010-06-30 18:38:06 +03:00
|
|
|
* Return the amount of space in bytes in the AVFifoBuffer, that is the
|
2009-04-03 02:22:19 +03:00
|
|
|
* amount of data you can write into it.
|
2011-08-08 13:06:26 +03:00
|
|
|
* @param f AVFifoBuffer to write into
|
2009-04-03 02:22:19 +03:00
|
|
|
* @return size
|
|
|
|
*/
|
|
|
|
int av_fifo_space(AVFifoBuffer *f);
|
|
|
|
|
2007-02-27 19:49:00 +02:00
|
|
|
/**
|
2010-06-30 18:38:06 +03:00
|
|
|
* Feed data from an AVFifoBuffer to a user-supplied callback.
|
2011-08-08 13:06:26 +03:00
|
|
|
* @param f AVFifoBuffer to read from
|
2007-03-02 12:09:51 +02:00
|
|
|
* @param buf_size number of bytes to read
|
2011-08-08 13:06:26 +03:00
|
|
|
* @param func generic read function
|
|
|
|
* @param dest data destination
|
2007-02-27 19:49:00 +02:00
|
|
|
*/
|
2009-03-09 19:47:47 +02:00
|
|
|
int av_fifo_generic_read(AVFifoBuffer *f, void *dest, int buf_size, void (*func)(void*, void*, int));
|
2007-02-27 19:49:00 +02:00
|
|
|
|
2008-04-09 14:35:16 +03:00
|
|
|
/**
|
2010-06-30 18:38:06 +03:00
|
|
|
* Feed data from a user-supplied callback to an AVFifoBuffer.
|
2011-08-08 13:06:26 +03:00
|
|
|
* @param f AVFifoBuffer to write to
|
|
|
|
* @param src data source; non-const since it may be used as a
|
2010-02-25 01:52:52 +02:00
|
|
|
* modifiable context by the function defined in func
|
2008-04-09 14:35:16 +03:00
|
|
|
* @param size number of bytes to write
|
2011-08-08 13:06:26 +03:00
|
|
|
* @param func generic write function; the first parameter is src,
|
2009-01-28 02:16:05 +02:00
|
|
|
* the second is dest_buf, the third is dest_buf_size.
|
2008-04-09 14:35:16 +03:00
|
|
|
* func must return the number of bytes written to dest_buf, or <= 0 to
|
|
|
|
* indicate no more data available to write.
|
2008-04-09 14:36:50 +03:00
|
|
|
* If func is NULL, src is interpreted as a simple byte array for source data.
|
2009-01-28 02:16:05 +02:00
|
|
|
* @return the number of bytes written to the FIFO
|
2008-04-09 14:35:16 +03:00
|
|
|
*/
|
2008-04-09 14:36:50 +03:00
|
|
|
int av_fifo_generic_write(AVFifoBuffer *f, void *src, int size, int (*func)(void*, void*, int));
|
2007-02-27 19:49:00 +02:00
|
|
|
|
2008-08-19 21:43:34 +03:00
|
|
|
/**
|
2010-06-30 18:38:06 +03:00
|
|
|
* Resize an AVFifoBuffer.
|
2011-08-08 13:06:26 +03:00
|
|
|
* @param f AVFifoBuffer to resize
|
2008-08-19 21:43:34 +03:00
|
|
|
* @param size new AVFifoBuffer size in bytes
|
2009-01-28 02:16:05 +02:00
|
|
|
* @return <0 for failure, >=0 otherwise
|
2008-08-19 21:43:34 +03:00
|
|
|
*/
|
|
|
|
int av_fifo_realloc2(AVFifoBuffer *f, unsigned int size);
|
|
|
|
|
2007-02-27 19:49:00 +02:00
|
|
|
/**
|
2010-06-30 18:38:06 +03:00
|
|
|
* Read and discard the specified amount of data from an AVFifoBuffer.
|
2011-08-08 13:06:26 +03:00
|
|
|
* @param f AVFifoBuffer to read from
|
2007-03-02 12:09:51 +02:00
|
|
|
* @param size amount of data to read in bytes
|
2007-02-27 19:49:00 +02:00
|
|
|
*/
|
2006-09-21 10:31:53 +03:00
|
|
|
void av_fifo_drain(AVFifoBuffer *f, int size);
|
|
|
|
|
2011-06-29 18:30:23 +03:00
|
|
|
/**
|
|
|
|
* Return a pointer to the data stored in a FIFO buffer at a certain offset.
|
|
|
|
* The FIFO buffer is not modified.
|
|
|
|
*
|
2011-08-27 15:00:54 +03:00
|
|
|
* @param f AVFifoBuffer to peek at, f must be non-NULL
|
2011-06-29 18:30:23 +03:00
|
|
|
* @param offs an offset in bytes, its absolute value must be less
|
|
|
|
* than the used buffer size or the returned pointer will
|
|
|
|
* point outside to the buffer data.
|
|
|
|
* The used buffer size can be checked with av_fifo_size().
|
|
|
|
*/
|
|
|
|
static inline uint8_t *av_fifo_peek2(const AVFifoBuffer *f, int offs)
|
2006-09-21 10:31:53 +03:00
|
|
|
{
|
|
|
|
uint8_t *ptr = f->rptr + offs;
|
|
|
|
if (ptr >= f->end)
|
2011-06-29 18:30:23 +03:00
|
|
|
ptr = f->buffer + (ptr - f->end);
|
|
|
|
else if (ptr < f->buffer)
|
|
|
|
ptr = f->end - (f->buffer - ptr);
|
|
|
|
return ptr;
|
2006-09-21 10:31:53 +03:00
|
|
|
}
|
2011-06-29 18:30:23 +03:00
|
|
|
|
|
|
|
#if FF_API_AV_FIFO_PEEK
|
|
|
|
/**
|
|
|
|
* @deprecated Use av_fifo_peek2() instead.
|
|
|
|
*/
|
|
|
|
attribute_deprecated
|
|
|
|
static inline uint8_t av_fifo_peek(AVFifoBuffer *f, int offs)
|
|
|
|
{
|
|
|
|
return *av_fifo_peek2(f, offs);
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
2008-08-31 10:39:47 +03:00
|
|
|
#endif /* AVUTIL_FIFO_H */
|