Struct ConstantBufferStates

pub struct ConstantBufferStates<S> { /* private fields */ }

Simple implementation of BufferStates trait where every parameter is constant throughout the whole buffer.

This is in general useful for testing or other scenarios where you need to create a BufferStates object outside of a Conformal wrapper.

Implementations

impl<S: States> ConstantBufferStates<S>

pub fn new(s: S) -> Self

Create a new ConstantBufferStates object from a States object.

impl ConstantBufferStates<StatesMap>

pub fn new_override_defaults<'a, S: AsRef<str> + 'a>( infos: impl IntoIterator<Item = InfoRef<'a, S>> + 'a, overrides: &HashMap<&str, InternalValue>, ) -> Self

Create a new ConstantBufferStates object from a list of Infos and overrides.

This creates a ConstantBufferStates with all parameters set to default values for the whole buffer.

Note that if you want to pass this into a synth, you should use Self::new_override_synth_defaults instead.

overrides work exactly as in override_defaults.

Examples

let infos = vec![
  StaticInfoRef {
    title: "Numeric",
    short_title: "Numeric",
    unique_id: "numeric",
    flags: Default::default(),
    type_specific: TypeSpecificInfoRef::Numeric {
      default: 0.0,
      valid_range: 0.0..=1.0,
      units: None,
    },
  },
];
let overrides = vec![("numeric", InternalValue::Numeric(0.5))].into_iter().collect();
let buffer_states = ConstantBufferStates::new_override_defaults(infos, &overrides);
match buffer_states.get_numeric("numeric") {
  Some(NumericBufferState::Constant(0.5)) => (),
  _ => panic!("Expected constant value of 0.5"),
};

pub fn new_defaults<'a, S: AsRef<str> + 'a>( infos: impl IntoIterator<Item = InfoRef<'a, S>> + 'a, ) -> Self

Create a new ConstantBufferStates object from a list of Infos.

Each parameter in Infos will be set to its default value for the whole buffer.

Note that if you want to pass this into a synth, you should use Self::new_synth_defaults instead.

Examples

let infos = vec![
  StaticInfoRef {
    title: "Numeric",
    short_title: "Numeric",
    unique_id: "numeric",
    flags: Default::default(),
    type_specific: TypeSpecificInfoRef::Numeric {
      default: 0.0,
      valid_range: 0.0..=1.0,
      units: None,
    },
  },
];

let buffer_states = ConstantBufferStates::new_defaults(infos);
match buffer_states.get_numeric("numeric") {
  Some(NumericBufferState::Constant(0.0)) => (),
  _ => panic!("Expected constant value of 0.0"),
};

pub fn new_override_synth_defaults<'a, 'b: 'a>( infos: impl IntoIterator<Item = InfoRef<'a, &'b str>> + 'a, overrides: &HashMap<&str, InternalValue>, ) -> Self

Create a new ConstantBufferStates object to pass to a synth from a list of Infos and overrides.

This is similar to Self::new_override_defaults, but it also includes the controller parameters that are common to all synths. (crate::synth::CONTROLLER_PARAMETERS).

Thus, this is more appropriate to use if you plan to pass the parameters to a synth.

Examples

let infos = vec![
  StaticInfoRef {
    title: "Numeric",
    short_title: "Numeric",
    unique_id: "numeric",
    flags: Default::default(),
    type_specific: TypeSpecificInfoRef::Numeric {
      default: 0.0,
      valid_range: 0.0..=1.0,
      units: None,
    },
  },
];
let overrides = vec![
  // You can override declared parameters
  ("numeric", InternalValue::Numeric(0.5)),
  // Or you can override control parameters
  (MOD_WHEEL_PARAMETER, InternalValue::Numeric(0.2)),
].into_iter().collect();

let buffer_states = ConstantBufferStates::new_override_synth_defaults(infos, &overrides);

// Overridden parameters get the values you passed in
match buffer_states.get_numeric("numeric") {
  Some(NumericBufferState::Constant(0.5)) => (),
  _ => panic!("Expected constant value of 0.5"),
};
match buffer_states.get_numeric(MOD_WHEEL_PARAMETER) {
  Some(NumericBufferState::Constant(0.2)) => (),
  _ => panic!("Expected constant value of 0.2"),
};

// Other parameters get their default values
match buffer_states.get_numeric(PITCH_BEND_PARAMETER) {
  Some(NumericBufferState::Constant(0.0)) => (),
  _ => panic!("Expected constant value of 0.0"),
};

pub fn new_synth_defaults<'a, 'b: 'a>( infos: impl IntoIterator<Item = InfoRef<'a, &'b str>> + 'a, ) -> Self

Create a new ConstantBufferStates object to pass to a synth from a list of Infos.

Each parameter in Infos will be set to its default value for the whole buffer.

This is similar to Self::new_defaults, but it also includes the controller parameters that are common to all synths. (crate::synth::CONTROLLER_PARAMETERS).

Thus, this is more appropriate to use if you plan to pass the parameters to a synth.

Examples

let infos = vec![
  StaticInfoRef {
    title: "Numeric",
    short_title: "Numeric",
    unique_id: "numeric",
    flags: Default::default(),
    type_specific: TypeSpecificInfoRef::Numeric {
      default: 0.0,
      valid_range: 0.0..=1.0,
      units: None,
    },
  },
];

let buffer_states = ConstantBufferStates::new_synth_defaults(infos);
match buffer_states.get_numeric("numeric") {
  Some(NumericBufferState::Constant(0.0)) => (),
  _ => panic!("Expected constant value of 0.0"),
};
match buffer_states.get_numeric(MOD_WHEEL_PARAMETER) {
  Some(NumericBufferState::Constant(0.0)) => (),
  _ => panic!("Expected constant value of 0.0"),
};

Trait Implementations

impl<S: States> BufferStates for ConstantBufferStates<S>

fn get_by_hash( &self, id_hash: IdHash, ) -> Option<BufferState<impl Iterator<Item = PiecewiseLinearCurvePoint> + Clone, impl Iterator<Item = TimedValue<u32>> + Clone, impl Iterator<Item = TimedValue<bool>> + Clone>>

Get the state of a parameter by it’s hashed unique ID.

fn get( &self, unique_id: &str, ) -> Option<BufferState<impl Iterator<Item = PiecewiseLinearCurvePoint> + Clone, impl Iterator<Item = TimedValue<u32>> + Clone, impl Iterator<Item = TimedValue<bool>> + Clone>>

Get the state of a parameter by it’s unique ID.

fn numeric_by_hash( &self, param_id: IdHash, ) -> Option<NumericBufferState<impl Iterator<Item = PiecewiseLinearCurvePoint> + Clone>>

Get the state of a numeric parameter by it’s hashed unique ID.

fn get_numeric( &self, unique_id: &str, ) -> Option<NumericBufferState<impl Iterator<Item = PiecewiseLinearCurvePoint> + Clone>>

Get the state of a numeric parameter by it’s unique ID.

fn enum_by_hash( &self, param_id: IdHash, ) -> Option<EnumBufferState<impl Iterator<Item = TimedValue<u32>> + Clone>>

Get the state of an enum parameter by it’s hashed unique ID.

fn get_enum( &self, unique_id: &str, ) -> Option<EnumBufferState<impl Iterator<Item = TimedValue<u32>> + Clone>>

Get the state of an enum parameter by it’s unique ID.

fn switch_by_hash( &self, param_id: IdHash, ) -> Option<SwitchBufferState<impl Iterator<Item = TimedValue<bool>> + Clone>>

Get the state of a switch parameter by it’s hashed unique ID.

fn get_switch( &self, unique_id: &str, ) -> Option<SwitchBufferState<impl Iterator<Item = TimedValue<bool>> + Clone>>

Get the state of a switch parameter by it’s unique ID.

impl<S: Clone> Clone for ConstantBufferStates<S>

fn clone(&self) -> ConstantBufferStates<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for ConstantBufferStates<S>

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

Formats the value using the given formatter.

impl<S: Default> Default for ConstantBufferStates<S>

fn default() -> ConstantBufferStates<S>

Returns the “default value” for a type.