aboutsummaryrefslogtreecommitdiffstats
path: root/libavfilter/vidstabutils.h
diff options
context:
space:
mode:
authorTimothy Gu <timothygu99@gmail.com>2014-08-21 19:12:10 -0700
committerMichael Niedermayer <michaelni@gmx.at>2014-08-22 22:19:20 +0200
commit8495c6086d04ffc6c2cf85a0497c428f60c76395 (patch)
tree3b6c1a51b9ea3c466abd1561bb2b3b5ae75aea0c /libavfilter/vidstabutils.h
parent6e51e746c42607e35e8595bd66a8f50e1d9c40a4 (diff)
downloadffmpeg-8495c6086d04ffc6c2cf85a0497c428f60c76395.tar.gz
vidstabutils: improve documentation
Signed-off-by: Timothy Gu <timothygu99@gmail.com> Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
Diffstat (limited to 'libavfilter/vidstabutils.h')
-rw-r--r--libavfilter/vidstabutils.h17
1 files changed, 14 insertions, 3 deletions
diff --git a/libavfilter/vidstabutils.h b/libavfilter/vidstabutils.h
index 93278f680d..c6d6cedb72 100644
--- a/libavfilter/vidstabutils.h
+++ b/libavfilter/vidstabutils.h
@@ -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