From 7b4beb2949d00e563d690348c1d24acf7ff1dd97 Mon Sep 17 00:00:00 2001 From: John Schwartz Date: Mon, 13 Jan 2025 08:37:05 -0500 Subject: [PATCH] document that the returned value represents dynamic gain reduction/expansion before make-up gain is applied --- include/clap/ext/draft/gain-reduction.h | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/include/clap/ext/draft/gain-reduction.h b/include/clap/ext/draft/gain-reduction.h index d03822a5..462ef04b 100644 --- a/include/clap/ext/draft/gain-reduction.h +++ b/include/clap/ext/draft/gain-reduction.h @@ -11,17 +11,20 @@ extern "C" { #endif typedef struct clap_plugin_gain_reduction { - // Returns the current gain reduction in dB. the value is intended + // Returns the current gain reduction in dB. The value is intended // for informational display, for example in a host meter or tooltip. // // The function should be called on the audio thread to ensure consistency // with processing time, although the host will likely use the value on // the main thread. // - // The returned value is in DB. Zero means the plugin is applying no gain + // The returned value is in dB. Zero means the plugin is applying no gain // reduction, or is not processing. A negative value means the plugin is - // applying gain reduction. A positive value means the plugin is adding - // gain. A single value is returned for all audio channels. + // applying gain reduction, as with a compressor or limiter. A positive + // value means the plugin is adding gain, as with an expander. The value + // represents the dynamic gain reduction or expansion applied by the + // plugin, before any make-up gain or other adjustment. A single value is + // returned for all audio channels. // // [audio-thread] double(CLAP_ABI *get)(const clap_plugin_t *plugin);