virtualenv/FFmpeg
1
0
Fork 0
mirror of https://github.com/FFmpeg/FFmpeg.git synced 2024-12-23 12:43:46 +02:00
Code Issues Releases Activity

lavu/bprint: extend/clarify documentation for av_bprint_init() size_max value

Browse Source 
Also define AV_BPRINT_SIZE_* macros before av_bprint_init() declaration,
and mention them in the av_bprint_init() doxy.
This commit is contained in:
Stefano Sabatini 2012-07-26 21:37:11 +02:00
parent a2f91e7bcd
commit 7cf9aaddcd
1 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
libavutil/bprint.h
View File

@ -81,24 +81,27 @@ typedef struct AVBPrint {
) )
} AVBPrint; } AVBPrint;
/**
* Convenience macros for special values for av_bprint_init() size_max
* parameter.
*/
#define AV_BPRINT_SIZE_UNLIMITED ((unsigned)-1)
#define AV_BPRINT_SIZE_AUTOMATIC 1
#define AV_BPRINT_SIZE_COUNT_ONLY 0
/** /**
* Init a print buffer. * Init a print buffer.
* *
* @param buf buffer to init * @param buf buffer to init
* @param size_init initial size (including the final 0) * @param size_init initial size (including the final 0)
* @param size_max maximum size; * @param size_max maximum size;
* 0 means do not write anything, just count the length; * any large value means that the internal buffer will be
* 1 is replaced by the maximum value for automatic storage * reallocated as needed up to that limit; -1 is converted to
* UINT_MAX, the largest limit possible.
* Check also AV_BPRINT_SIZE_* macros.
*/ */
void av_bprint_init(AVBPrint *buf, unsigned size_init, unsigned size_max); void av_bprint_init(AVBPrint *buf, unsigned size_init, unsigned size_max);
/**
* Convenience macros for special values for size_max.
*/
#define AV_BPRINT_SIZE_UNLIMITED ((unsigned)-1)
#define AV_BPRINT_SIZE_AUTOMATIC 1
#define AV_BPRINT_SIZE_COUNT_ONLY 0
/** /**
* Init a print buffer using a pre-existing buffer. * Init a print buffer using a pre-existing buffer.
* *