Struct reaper_medium::ReaperNormalizedFxParamValue

pub struct ReaperNormalizedFxParamValue(_);

This represents a particular value of an FX parameter in “REAPER-normalized” form.

Please note that this value is not always normalized in the classical sense of being in the unit interval 0.0..=1.0! Mostly it is and this is definitely the frame of reference. But there are situations where it can be > 1.0. Turns out, it can even be a negative value! The meaning depends on the particular FX.

Examples of FX parameters which can take values that are not in the unit interval:

• ReaPitch has a Wet parameter which has a “reasonable” maximum at 6 dB which corresponds to the REAPER-normalized value 1.0. But this reasonable maximum can be exceeded, in which case it can almost reach 2.0.
• TAL Flanger has a Sync Speed parameter which reports the min/max range as 0.0..=1.0 but returns values between 0.0 and 8.0. It reports the range incorrectly.
• Xfer Records LFO Tool has an envelope point control that reports a value that is slightly below zero when dragged all down. That’s probably a bug.
• Because of a bug in REAPER <= 6.12 SetParamNormalized, it’s possible that certain JS FX parameter values end up as NaN, in Lua console displayed as “-1.#IND”. E.g. happened to JS FX “MIDI Note-On Delay” parameter “Poo”. Bug has been reported.

Justin said that 0.0..=1.0 is the normal VST parameter range but that some ReaPlugs extend that range when it’s convenient (e.g. increasing the range from the initial version of the plug-in or using values greater than 1.0 for volume when using gain etc.). He pointed out that developers should prepare for anything.

We don’t try to “fix” exotic values in medium-level API (e.g. setting negative values to zero automatically) because there might be plug-ins which assign meaning to these special values and then it would be a shame if we can’t set or get them.

Implementations

impl ReaperNormalizedFxParamValue

pub fn new(value: f64) -> ReaperNormalizedFxParamValue

Creates a REAPER-normalized FX parameter value.

pub const fn get(self) -> f64

Returns the wrapped value.

Trait Implementations

impl Clone for ReaperNormalizedFxParamValue

fn clone(&self) -> ReaperNormalizedFxParamValue

Returns a copy of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ReaperNormalizedFxParamValue

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ReaperNormalizedFxParamValue

fn default() -> ReaperNormalizedFxParamValue

Returns the “default value” for a type.

impl Display for ReaperNormalizedFxParamValue

fn fmt(&self, _derive_more_display_formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<f64> for ReaperNormalizedFxParamValue

fn from(value: f64) -> Self

Converts to this type from the input type.

impl PartialEq<ReaperNormalizedFxParamValue> for ReaperNormalizedFxParamValue

fn eq(&self, other: &ReaperNormalizedFxParamValue) -> bool

This method tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<ReaperNormalizedFxParamValue> for ReaperNormalizedFxParamValue

fn partial_cmp(&self, other: &ReaperNormalizedFxParamValue) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

const fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

const fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

const fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

const fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for ReaperNormalizedFxParamValue

impl StructuralPartialEq for ReaperNormalizedFxParamValue