Skip to content

Commit

Permalink
document that the returned value represents dynamic gain reduction/ex…
Browse files Browse the repository at this point in the history
…pansion before make-up gain is applied
  • Loading branch information
schwaaa committed Jan 13, 2025
1 parent b7a3fba commit 7b4beb2
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions include/clap/ext/draft/gain-reduction.h
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down

0 comments on commit 7b4beb2

Please sign in to comment.