bad: Add msdkav1enc docs

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/2971>

diff --git a/subprojects/gst-plugins-bad/docs/plugins/gst_plugins_cache.json b/subprojects/gst-plugins-bad/docs/plugins/gst_plugins_cache.json
index 7fa588b..d21c72f 100644 (file)
--- a/subprojects/gst-plugins-bad/docs/plugins/gst_plugins_cache.json
+++ b/subprojects/gst-plugins-bad/docs/plugins/gst_plugins_cache.json
@@ -214259,6 +214259,88 @@
                 "properties": {},
                 "rank": "none"
             },
+            "msdkav1enc": {
+                "author": "Haihao Xiang <haihao.xiang@intel.com>, Mengkejiergeli Ba <mengkejiergeli.ba@intel.com>",
+                "description": "AV1 video encoder based on Intel oneVPL",
+                "hierarchy": [
+                    "GstMsdkAV1Enc",
+                    "GstMsdkEnc",
+                    "GstVideoEncoder",
+                    "GstElement",
+                    "GstObject",
+                    "GInitiallyUnowned",
+                    "GObject"
+                ],
+                "klass": "Codec/Encoder/Video/Hardware",
+                "long-name": "Intel MSDK AV1 encoder",
+                "pad-templates": {
+                    "sink": {
+                        "caps": "video/x-raw\n        format: { NV12, P010_10LE }\n         width: [ 1, 2147483647 ]\n        height: [ 1, 2147483647 ]\n     framerate: [ 0/1, 2147483647/1 ]\ninterlace-mode: progressive\nvideo/x-raw(memory:DMABuf)\n        format: { NV12, P010_10LE }\n         width: [ 1, 2147483647 ]\n        height: [ 1, 2147483647 ]\n     framerate: [ 0/1, 2147483647/1 ]\ninterlace-mode: progressive\n",
+                        "direction": "sink",
+                        "presence": "always"
+                    },
+                    "src": {
+                        "caps": "video/x-av1\n     framerate: [ 0/1, 2147483647/1 ]\n         width: [ 1, 2147483647 ]\n        height: [ 1, 2147483647 ]\n         profile: { (string)main }\n",
+                        "direction": "src",
+                        "presence": "always"
+                    }
+                },
+                "properties": {
+                    "b-pyramid": {
+                        "blurb": "Enable B-Pyramid Reference structure",
+                        "conditionally-available": false,
+                        "construct": false,
+                        "construct-only": false,
+                        "controllable": false,
+                        "default": "false",
+                        "mutable": "null",
+                        "readable": true,
+                        "type": "gboolean",
+                        "writable": true
+                    },
+                    "num-tile-cols": {
+                        "blurb": "number of columns for tiled encoding",
+                        "conditionally-available": false,
+                        "construct": false,
+                        "construct-only": false,
+                        "controllable": false,
+                        "default": "1",
+                        "max": "64",
+                        "min": "1",
+                        "mutable": "null",
+                        "readable": true,
+                        "type": "guint",
+                        "writable": true
+                    },
+                    "num-tile-rows": {
+                        "blurb": "number of rows for tiled encoding",
+                        "conditionally-available": false,
+                        "construct": false,
+                        "construct-only": false,
+                        "controllable": false,
+                        "default": "1",
+                        "max": "64",
+                        "min": "1",
+                        "mutable": "null",
+                        "readable": true,
+                        "type": "guint",
+                        "writable": true
+                    },
+                    "p-pyramid": {
+                        "blurb": "Enable P-Pyramid Reference structure",
+                        "conditionally-available": false,
+                        "construct": false,
+                        "construct-only": false,
+                        "controllable": false,
+                        "default": "false",
+                        "mutable": "null",
+                        "readable": true,
+                        "type": "gboolean",
+                        "writable": true
+                    }
+                },
+                "rank": "none"
+            },
             "msdkh264dec": {
                 "author": "Scott D Phillips <scott.d.phillips@intel.com>",
                 "description": "H264 video decoder based on Intel Media SDK",

diff --git a/subprojects/gst-plugins-bad/sys/msdk/gstmsdkav1enc.c b/subprojects/gst-plugins-bad/sys/msdk/gstmsdkav1enc.c
index 80c6b36..96a409c 100644 (file)
--- a/subprojects/gst-plugins-bad/sys/msdk/gstmsdkav1enc.c
+++ b/subprojects/gst-plugins-bad/sys/msdk/gstmsdkav1enc.c
@@ -29,6 +29,22 @@
  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+/**
+ * SECTION: element-msdkav1enc
+ * @title: msdkav1enc
+ * @short_description: Intel MSDK AV1 encoder
+ *
+ * AV1 video encoder based on Intel MFX
+ *
+ * ## Example launch line
+ * ```
+ * gst-launch-1.0 videotestsrc num-buffers=90 ! msdkav1enc ! av1parse ! matroskamux ! filesink location=output.webm
+ * ```
+ *
+ * Since: 1.21
+ *
+ */
+
 #ifdef HAVE_CONFIG_H
 #  include <config.h>
 #endif