1
0
mirror of https://github.com/FFmpeg/FFmpeg.git synced 2024-12-23 12:43:46 +02:00

Clarify AVFilterBuffer documentation, make it clear that it is not

necessarily video-related.

Originally committed as revision 24293 to svn://svn.ffmpeg.org/ffmpeg/trunk
This commit is contained in:
Stefano Sabatini 2010-07-17 18:27:11 +00:00
parent 8e9d930873
commit 32d7bcd4b1

View File

@ -59,31 +59,28 @@ typedef struct AVFilterContext AVFilterContext;
typedef struct AVFilterLink AVFilterLink; typedef struct AVFilterLink AVFilterLink;
typedef struct AVFilterPad AVFilterPad; typedef struct AVFilterPad AVFilterPad;
/* TODO: look for other flags which may be useful in this structure (interlace
* flags, etc)
*/
/** /**
* A reference-counted picture data type used by the filter system. Filters * A reference-counted buffer data type used by the filter system. Filters
* should not store pointers to this structure directly, but instead use the * should not store pointers to this structure directly, but instead use the
* AVFilterPicRef structure below. * AVFilterPicRef structure below.
*/ */
typedef struct AVFilterBuffer typedef struct AVFilterBuffer
{ {
uint8_t *data[4]; ///< picture data for each plane uint8_t *data[4]; ///< buffer data for each plane
int linesize[4]; ///< number of bytes per line int linesize[4]; ///< number of bytes per line
enum PixelFormat format; ///< colorspace enum PixelFormat format; ///< colorspace
unsigned refcount; ///< number of references to this image unsigned refcount; ///< number of references to this buffer
/** private data to be used by a custom free function */ /** private data to be used by a custom free function */
void *priv; void *priv;
/** /**
* A pointer to the function to deallocate this image if the default * A pointer to the function to deallocate this buffer if the default
* function is not sufficient. This could, for example, add the memory * function is not sufficient. This could, for example, add the memory
* back into a memory pool to be reused later without the overhead of * back into a memory pool to be reused later without the overhead of
* reallocating it from scratch. * reallocating it from scratch.
*/ */
void (*free)(struct AVFilterBuffer *pic); void (*free)(struct AVFilterBuffer *buf);
} AVFilterBuffer; } AVFilterBuffer;
/** /**