x264enc: Update long-name and description
authorRuben Gonzalez <rgonzalez@fluendo.com>
Mon, 21 Feb 2022 22:29:23 +0000 (23:29 +0100)
committerGStreamer Marge Bot <gitlab-merge-bot@gstreamer-foundation.org>
Tue, 22 Feb 2022 15:28:21 +0000 (15:28 +0000)
Update x264enc long-name to be more than just the name. Then the
description also was updated to be longer than the long-name, and
similar to the plugin description.

Finally, as I am here, H264 was replaced by H.264 and x264 is only a
plugin (not plugins).

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

subprojects/gst-plugins-ugly/docs/gst_plugins_cache.json
subprojects/gst-plugins-ugly/ext/x264/gstx264enc.c

index e3290a1..1de6d70 100644 (file)
         "url": "Unknown package origin"
     },
     "x264": {
-        "description": "libx264-based H264 plugins",
+        "description": "libx264-based H.264 encoder plugin",
         "elements": {
             "x264enc": {
                 "author": "Josef Zlomek <josef.zlomek@itonis.tv>, Mark Nauwelaerts <mnauw@users.sf.net>",
-                "description": "H264 Encoder",
+                "description": "libx264-based H.264 video encoder",
                 "hierarchy": [
                     "GstX264Enc",
                     "GstVideoEncoder",
                     "GstPreset"
                 ],
                 "klass": "Codec/Encoder/Video",
-                "long-name": "x264enc",
+                "long-name": "x264 H.264 Encoder",
                 "pad-templates": {
                     "sink": {
                         "caps": "video/x-raw:\n      framerate: [ 0/1, 2147483647/1 ]\n          width: [ 1, 2147483647 ]\n         height: [ 1, 2147483647 ]\n         format: { Y444, Y42B, I420, YV12, NV12, Y444_10LE, I422_10LE, I420_10LE }\n",
index 2604506..70f73c5 100644 (file)
@@ -86,7 +86,7 @@
  * |[
  * gst-launch-1.0 -v videotestsrc num-buffers=1000 ! tee name=t ! queue ! videoconvert ! autovideosink \
  *   t. ! queue ! x264enc rc-lookahead=5 ! fakesink
- * ]| This example pipeline will encode a test video source to H264 while
+ * ]| This example pipeline will encode a test video source to H.264 while
  * displaying the input material at the same time.  As mentioned above,
  * specific settings are needed in this case to avoid pipeline stalling.
  * Depending on goals and context, other approaches are possible, e.g.
@@ -1199,7 +1199,8 @@ gst_x264_enc_class_init (GstX264EncClass * klass)
   g_string_append_printf (x264enc_defaults, ":weightp=0");
 
   gst_element_class_set_static_metadata (element_class,
-      "x264enc", "Codec/Encoder/Video", "H264 Encoder",
+      "x264 H.264 Encoder", "Codec/Encoder/Video",
+      "libx264-based H.264 video encoder",
       "Josef Zlomek <josef.zlomek@itonis.tv>, "
       "Mark Nauwelaerts <mnauw@users.sf.net>");
 
@@ -3053,5 +3054,5 @@ plugin_init (GstPlugin * plugin)
 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
     GST_VERSION_MINOR,
     x264,
-    "libx264-based H264 plugins",
+    "libx264-based H.264 encoder plugin",
     plugin_init, VERSION, "GPL", GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)