From da52bedbff983f8a7a7e3a39f8f852a5022282f2 Mon Sep 17 00:00:00 2001
From: Sanchayan Maity <sanchayan@asymptotic.io>
Date: Sat, 29 Oct 2022 16:17:53 +0530
Subject: [PATCH] fdkaacenc: Update documentation to clarify bitrate and
 peak-bitrate

bitrate property is only applicable for constant bitrate and
peak-bitrate is only applicable for variable bitrate. Clarify
the same.
---
 .../docs/plugins/gst_plugins_cache.json              | 12 ++++++------
 .../gst-plugins-bad/ext/fdkaac/gstfdkaacenc.c        |  6 +++---
 2 files changed, 9 insertions(+), 9 deletions(-)

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 bbfd0886d5..2e24fc258e 100644
--- a/subprojects/gst-plugins-bad/docs/plugins/gst_plugins_cache.json
+++ b/subprojects/gst-plugins-bad/docs/plugins/gst_plugins_cache.json
@@ -16727,7 +16727,7 @@
                         "writable": true
                     },
                     "bitrate": {
-                        "blurb": "Target Audio Bitrate (0 = fixed value based on  sample rate and channel count)",
+                        "blurb": "Target Audio Bitrate. Only applicable if rate-control=cbr. (0 = fixed value based on sample rate and channel count)",
                         "conditionally-available": false,
                         "construct": false,
                         "construct-only": false,
@@ -16741,7 +16741,7 @@
                         "writable": true
                     },
                     "peak-bitrate": {
-                        "blurb": "Peak Bitrate to adjust maximum bits per audio frame. Bitrate is in bits/second. (0 = Not set)",
+                        "blurb": "Peak Bitrate to adjust maximum bits per audio frame. Bitrate is in bits/second. Only applicable if rate-control=vbr. (0 = Not set)",
                         "conditionally-available": false,
                         "construct": false,
                         "construct-only": false,
@@ -16753,9 +16753,9 @@
                         "readable": true,
                         "type": "gint",
                         "writable": true
-                     },
+                    },
                     "rate-control": {
-                        "blurb": "Whether Constant or Variable Bitrate should be used",
+                        "blurb": "Whether Constant or Variable Bitrate should be used.",
                         "conditionally-available": false,
                         "construct": false,
                         "construct-only": false,
@@ -16767,7 +16767,7 @@
                         "writable": true
                     },
                     "vbr-preset": {
-                        "blurb": "AAC Variable Bitrate configurations",
+                        "blurb": "AAC Variable Bitrate configurations. Requires rate-control as vbr.",
                         "conditionally-available": false,
                         "construct": false,
                         "construct-only": false,
@@ -237509,4 +237509,4 @@
         "tracers": {},
         "url": "Unknown package origin"
     }
-}
+}
\ No newline at end of file
diff --git a/subprojects/gst-plugins-bad/ext/fdkaac/gstfdkaacenc.c b/subprojects/gst-plugins-bad/ext/fdkaac/gstfdkaacenc.c
index bb468c9d31..abbf5d15fc 100644
--- a/subprojects/gst-plugins-bad/ext/fdkaac/gstfdkaacenc.c
+++ b/subprojects/gst-plugins-bad/ext/fdkaac/gstfdkaacenc.c
@@ -749,8 +749,8 @@ gst_fdkaacenc_class_init (GstFdkAacEncClass * klass)
   g_object_class_install_property (object_class, PROP_BITRATE,
       g_param_spec_int ("bitrate",
           "Bitrate",
-          "Target Audio Bitrate (0 = fixed value based on "
-          " sample rate and channel count)",
+          "Target Audio Bitrate. Only applicable if rate-control=cbr. "
+          "(0 = fixed value based on sample rate and channel count)",
           0, G_MAXINT, DEFAULT_BITRATE,
           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 
@@ -765,7 +765,7 @@ gst_fdkaacenc_class_init (GstFdkAacEncClass * klass)
       g_param_spec_int ("peak-bitrate",
           "Peak Bitrate",
           "Peak Bitrate to adjust maximum bits per audio frame. "
-          "Bitrate is in bits/second. (0 = Not set)",
+          "Bitrate is in bits/second. Only applicable if rate-control=vbr. (0 = Not set)",
           0, G_MAXINT, DEFAULT_PEAK_BITRATE,
           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));