summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVíctor Manuel Jáquez Leal <vjaquez@igalia.com>2020-09-20 08:31:23 +0200
committerVíctor Manuel Jáquez Leal <vjaquez@igalia.com>2020-09-20 09:21:08 +0200
commit9e9e5c72d54b69cb3def2753066195e01ca5cad1 (patch)
treec3770bf6b67588694410545135bb9294f6ec40fd
parent9443bf7a225a2cd3462b3b8a597bda46ee7092e3 (diff)
va: h264dec: add documentationHEADmaster
Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-plugins-bad/-/merge_requests/1585>
-rw-r--r--sys/va/gstvah264dec.c25
1 files changed, 25 insertions, 0 deletions
diff --git a/sys/va/gstvah264dec.c b/sys/va/gstvah264dec.c
index 841429f7b..6dc872d3d 100644
--- a/sys/va/gstvah264dec.c
+++ b/sys/va/gstvah264dec.c
@@ -18,6 +18,31 @@
* Boston, MA 02110-1301, USA.
*/
+/**
+ * SECTION:element-vah264dec
+ * @title: vah264dec
+ * @short_description: A VA-API based H264 video decoder
+ *
+ * vah264dec decodes H264 bitstreams to VA surfaces using the
+ * installed and chosen [VA-API](https://01.org/linuxmedia/vaapi)
+ * driver.
+ *
+ * The decoding surfaces can be mapped onto main memory as video
+ * frames.
+ *
+ * ## Example launch line
+ * |[
+ * gst-launch-1.0 filesrc location=big_buck_bunny.mov ! parsebin ! vah264dec ! autovideosink
+ * ]|
+ *
+ */
+
+/* ToDo:
+ *
+ * + interlaced streams
+ * + mutiview and stereo profiles
+ */
+
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif