vidstabutils: improve documentation

Signed-off-by: Timothy Gu <timothygu99@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
This commit is contained in:
Timothy Gu 2014-08-21 19:12:10 -07:00 committed by Michael Niedermayer
parent 6e51e746c4
commit 8495c6086d
1 changed files with 14 additions and 3 deletions

View File

@ -25,12 +25,23 @@
#include "avfilter.h"
/* ** some conversions from avlib to vid.stab constants and functions *** */
/* Conversion routines between libav* and vid.stab */
/** converts the pixelformat of avlib into the one of the vid.stab library */
/**
* Converts an AVPixelFormat to a VSPixelFormat.
*
* @param[in] ctx AVFilterContext used for logging
* @param[in] pf AVPixelFormat
* @return a corresponding VSPixelFormat
*/
VSPixelFormat ff_av2vs_pixfmt(AVFilterContext *ctx, enum AVPixelFormat pf);
/** sets the memory allocation function and logging constants to av versions */
/**
* Initialize libvidstab
*
* Sets the memory allocation functions and logging constants to corresponding
* av* versions.
*/
void ff_vs_init(void);
#endif