audiblelight.augmentation.Chorus

audiblelight.augmentation.Chorus#

class audiblelight.augmentation.Chorus(sample_rate=44100, rate_hz=None, depth=None, centre_delay_ms=None, feedback=None, mix=None)#

Bases: EventAugmentation

Applies chorus to the audio.

This audio effect can be controlled via the speed and depth of the LFO controlling the frequency response, a mix control, a feedback control, and the centre delay of the modulation.

Parameters:

  • sample_rate (custom_types.Numeric) – the sample rate for the effect to use.

  • rate_hz (int | float | complex | integer | floating | DistributionLike | None) – the speed of the LFO controlling the frequency response. By default, sampled between 0 and 10 Hz

  • depth (int | float | complex | integer | floating | DistributionLike | None) – the depth of the LFO controlling the frequency response. By default, sampled between 0 and 1.0.

  • centre_delay_ms (int | float | complex | integer | floating | DistributionLike | None) – the centre delay of the modulation. By default, sampled between 1 and 20 ms.

  • feedback (int | float | complex | integer | floating | DistributionLike | None) – the feedback of the effect. By default, sampled between 0.0 and 0.9.

  • mix (int | float | complex | integer | floating | DistributionLike | None) – the dry/wet mix of the effect. By default, sampled between 0.1 and 0.5.

__init__(sample_rate=44100, rate_hz=None, depth=None, centre_delay_ms=None, feedback=None, mix=None)#
Parameters:

  • sample_rate (int | float | complex | integer | floating | None)

  • rate_hz (int | float | complex | integer | floating | DistributionLike | None)

  • depth (int | float | complex | integer | floating | DistributionLike | None)

  • centre_delay_ms (int | float | complex | integer | floating | DistributionLike | None)

  • feedback (int | float | complex | integer | floating | DistributionLike | None)

  • mix (int | float | complex | integer | floating | DistributionLike | None)

Methods

__init__([sample_rate, rate_hz, depth, ...])

from_dict(input_dict)

Initialise an augmentation from a dictionary.

process(input_array)

Calls the underlying FX (or a list of FX)

sample_value(override, default_dist)

Samples a value according to the following method:

to_dict()

Returns the parameters used by this augmentation

Attributes

AUGMENTATION_TYPE

MAX_DELAY

MAX_DEPTH

MAX_FEEDBACK

MAX_MIX

MAX_RATE

MIN_DELAY

MIN_DEPTH

MIN_FEEDBACK

MIN_MIX

MIN_RATE

name

Returns the name of this augmentation
MAX_DELAY = 20.0#
MAX_DEPTH = 1.0#
MAX_FEEDBACK = 0.9#
MAX_MIX = 0.5#
MAX_RATE = 10#
MIN_DELAY = 1.0#
MIN_DEPTH = 0.0#
MIN_FEEDBACK = 0.0#
MIN_MIX = 0.1#
MIN_RATE = 0#
Contents