doc: v4l2codecs: Document all decoders
Add the documentation blob and since marker for all decoders. Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/5555>
This commit is contained in:
parent
3645f050af
commit
bb37ea168d
@ -10,6 +10,9 @@ set -eux
|
||||
|
||||
source "ci/scripts/source_image_env.sh"
|
||||
|
||||
# Special doc mode for V4L2 stateless codecs
|
||||
export GST_V4L2_CODEC_GEN_DOC=1
|
||||
|
||||
meson_args="${MESON_ARGS:--Ddoc=enabled -Drs=enabled -Dgst-docs:fatal_warnings=true}"
|
||||
echo "$meson_args"
|
||||
meson setup "$builddir" $meson_args
|
||||
|
@ -18,6 +18,17 @@
|
||||
* Boston, MA 02110-1301, USA.
|
||||
*/
|
||||
|
||||
/**
|
||||
* SECTION:gstv4l2codecalphadecodebin
|
||||
* @title: GstV4l2CodecAlphaDecodeBin
|
||||
* @short_description: V4L2 base class to implement VP8/VP9 alpha decoding.
|
||||
*
|
||||
* V4L2 base class to implement VP8/VP9 alpha decoding.
|
||||
*
|
||||
* Since: 1.20
|
||||
*/
|
||||
|
||||
|
||||
#ifdef HAVE_CONFIG_H
|
||||
#include "config.h"
|
||||
#endif
|
||||
|
@ -28,6 +28,21 @@ G_BEGIN_DECLS
|
||||
G_DECLARE_DERIVABLE_TYPE (GstV4l2CodecAlphaDecodeBin,
|
||||
gst_v4l2_codec_alpha_decode_bin, GST, V4L2_CODEC_ALPHA_DECODE_BIN, GstBin);
|
||||
|
||||
/**
|
||||
* GstV4l2CodecAlphaDecodeBin:
|
||||
*
|
||||
* Base class for V4L2 Stateless alpha decoders.
|
||||
*
|
||||
* Since: 1.20
|
||||
*/
|
||||
|
||||
/**
|
||||
* GstV4l2CodecAlphaDecodeBinClass:
|
||||
*
|
||||
* Base class for V4L2 Stateless alpha decoders.
|
||||
*
|
||||
* Since: 1.20
|
||||
*/
|
||||
struct _GstV4l2CodecAlphaDecodeBinClass
|
||||
{
|
||||
GstBinClass parent_class;
|
||||
|
@ -18,6 +18,21 @@
|
||||
* Boston, MA 02110-1301, USA.
|
||||
*/
|
||||
|
||||
/**
|
||||
* SECTION:element-v4l2slav1dec
|
||||
* @title: v4l2slav1dec
|
||||
* @short_description: V4L2 Stateless AV1 video decoder
|
||||
*
|
||||
* decodes AV1 bitstreams as DMABuf using Linux V4L2 Stateless API.
|
||||
*
|
||||
* ## Example launch line
|
||||
* ```
|
||||
* gst-launch-1.0 filesrc location=some.mov ! parsebin ! v4l2slav1dec ! autovideosink
|
||||
* ```
|
||||
*
|
||||
* Since: 1.24
|
||||
*/
|
||||
|
||||
|
||||
#ifdef HAVE_CONFIG_H
|
||||
#include "config.h"
|
||||
|
@ -17,6 +17,22 @@
|
||||
* Boston, MA 02110-1301, USA.
|
||||
*/
|
||||
|
||||
/**
|
||||
* SECTION:element-v4l2slh264dec
|
||||
* @title: v4l2slh264dec
|
||||
* @short_description: V4L2 Stateless H.264 video decoder
|
||||
*
|
||||
* decodes H.264 bitstreams as DMABuf using Linux V4L2 Stateless API.
|
||||
*
|
||||
* ## Example launch line
|
||||
* ```
|
||||
* gst-launch-1.0 filesrc location=some.mov ! parsebin ! v4l2slh264dec ! autovideosink
|
||||
* ```
|
||||
*
|
||||
* Since: 1.20
|
||||
*/
|
||||
|
||||
|
||||
#ifdef HAVE_CONFIG_H
|
||||
#include <config.h>
|
||||
#endif
|
||||
|
@ -18,6 +18,21 @@
|
||||
* Boston, MA 02110-1301, USA.
|
||||
*/
|
||||
|
||||
/**
|
||||
* SECTION:element-v4l2slh265dec
|
||||
* @title: v4l2slh265dec
|
||||
* @short_description: V4L2 Stateless H.265 video decoder
|
||||
*
|
||||
* decodes H.265 bitstreams as DMABuf using Linux V4L2 Stateless API.
|
||||
*
|
||||
* ## Example launch line
|
||||
* ```
|
||||
* gst-launch-1.0 filesrc location=some.mov ! parsebin ! v4l2slh265dec ! autovideosink
|
||||
* ```
|
||||
*
|
||||
* Since: 1.22
|
||||
*/
|
||||
|
||||
#ifdef HAVE_CONFIG_H
|
||||
#include <config.h>
|
||||
#endif
|
||||
|
@ -17,6 +17,21 @@
|
||||
* Boston, MA 02110-1301, USA.
|
||||
*/
|
||||
|
||||
/**
|
||||
* SECTION:element-v4l2slmpeg2dec
|
||||
* @title: v4l2slmpeg2dec
|
||||
* @short_description: V4L2 Stateless MPEG2 Video video decoder
|
||||
*
|
||||
* decodes MPEG2 Video bitstreams as DMABuf using Linux V4L2 Stateless API.
|
||||
*
|
||||
* ## Example launch line
|
||||
* ```
|
||||
* gst-launch-1.0 filesrc location=some.mov ! parsebin ! v4l2slmpeg2dec ! autovideosink
|
||||
* ```
|
||||
*
|
||||
* Since: 1.20
|
||||
*/
|
||||
|
||||
|
||||
#ifdef HAVE_CONFIG_H
|
||||
#include <config.h>
|
||||
|
@ -17,6 +17,38 @@
|
||||
* Boston, MA 02110-1301, USA.
|
||||
*/
|
||||
|
||||
/**
|
||||
* SECTION:element-v4l2slvp8dec
|
||||
* @title: v4l2slvp8dec
|
||||
* @short_description: V4L2 Stateless VP8 video decoder
|
||||
*
|
||||
* decodes VP8 bitstreams as DMABuf using Linux V4L2 Stateless API.
|
||||
*
|
||||
* ## Example launch line
|
||||
* ```
|
||||
* gst-launch-1.0 filesrc location=some.mkv ! parsebin ! v4l2slvp8dec ! autovideosink
|
||||
* ```
|
||||
*
|
||||
* Since: 1.20
|
||||
*/
|
||||
|
||||
/**
|
||||
* SECTION:element-v4l2slvp8alphadecodebin
|
||||
* @title: v4l2slvp8alphadecodebin
|
||||
* @short_description: V4L2 Stateless VP8 with alpa video decoder
|
||||
*
|
||||
* decodes VP8 bitstreams with alpha auxiliary stream as DMABuf using Linux
|
||||
* V4L2 Stateless API.
|
||||
*
|
||||
* ## Example launch line
|
||||
* ```
|
||||
* gst-launch-1.0 filesrc location=some.mkv ! parsebin ! v4l2slvp8alphadecodebin ! autovideosink
|
||||
* ```
|
||||
*
|
||||
* Since: 1.20
|
||||
*/
|
||||
|
||||
|
||||
#ifdef HAVE_CONFIG_H
|
||||
#include <config.h>
|
||||
#endif
|
||||
|
@ -18,6 +18,37 @@
|
||||
* Boston, MA 02110-1301, USA.
|
||||
*/
|
||||
|
||||
/**
|
||||
* SECTION:element-v4l2slvp9dec
|
||||
* @title: v4l2slvp9dec
|
||||
* @short_description: V4L2 Stateless VP9 video decoder
|
||||
*
|
||||
* decodes VP9 bitstreams as DMABuf using Linux V4L2 Stateless API.
|
||||
*
|
||||
* ## Example launch line
|
||||
* ```
|
||||
* gst-launch-1.0 filesrc location=some.mkv ! parsebin ! v4l2slvp9dec ! autovideosink
|
||||
* ```
|
||||
*
|
||||
* Since: 1.20
|
||||
*/
|
||||
|
||||
/**
|
||||
* SECTION:element-v4l2slvp9alphadecodebin
|
||||
* @title: v4l2slvp9alphadecodebin
|
||||
* @short_description: V4L2 Stateless VP9 with alpa video decoder
|
||||
*
|
||||
* decodes VP9 bitstreams with alpha auxiliary stream as DMABuf using Linux
|
||||
* V4L2 Stateless API.
|
||||
*
|
||||
* ## Example launch line
|
||||
* ```
|
||||
* gst-launch-1.0 filesrc location=some.mkv ! parsebin ! v4l2slvp9alphadecodebin ! autovideosink
|
||||
* ```
|
||||
*
|
||||
* Since: 1.20
|
||||
*/
|
||||
|
||||
#ifdef HAVE_CONFIG_H
|
||||
#include <config.h>
|
||||
#endif
|
||||
|
Loading…
x
Reference in New Issue
Block a user