audioeffects.chorus

Chorus - one delayed voice on a clock-modulated bucket-brigade line.

The player’s text is the class docstring; the CLAIMS table in the class’s test file ties its claim sentences to tests.

audioeffects.chorus.MAX_DELAY_MS = 40.0

Line length. Delay 20 ms at Depth 0.35 reaches d_max = 20/(1-0.35) ≈ 30.8 ms; one frame of headroom sits under the line. 40 ms is the next round number that clears it.

audioeffects.chorus.SHAPE_LEN = 256

One period of the clock law, power of two, borrowed by the node.

audioeffects.chorus.DEPTH_OFF = 0.0001

wow_depth_ms = 0, delay = mean.

Type:

Depth below this is treated as off

audioeffects.chorus.clock_shape(m)[source]

Q15 table for d = d0/(1 + m·tri).

Fitted as mid + depth × wow with wow in [−1, 1]: wow(u) = −(m + u)/(1 + m·u). Depth 0 is a silent table; the node is driven with wow_depth_ms = 0 in that case.

audioeffects.chorus.delay_law(mean_ms, m)[source]

Node delay_ms and wow_depth_ms for mean mean_ms and swing m.

mid = d0/(1 − m²), depth = d0·m/(1 − m²), so d = mid + depth·wow recovers d0/(1 + m·u).

audioeffects.chorus.nominal_damping_hz(corner_hz, sample_rate)[source]

damping_hz whose one-pole −3 dB is corner_hz at sample_rate.

The node takes the analog-style coefficient 1 − exp(−2π f/fs) (audiodsp_feedback_delay.c:31-38), so the knob’s hertz is not the digital −3 dB. Inverse of |H|² = 1/2 for y += a(x − y).

class audioeffects.chorus.Chorus(source, *options, **keywords)[source]

Bases: Component

A one-voice analog chorus, the way a bucket-brigade pedal does it: one delayed copy of your signal, its pitch swirling because a triangle moves the line’s clock rather than its delay.

Controls. Rate is the sweep’s speed, and Depth is how far the clock swings either way. Mix sets the wet voice against your signal, which stays at full level: 0 is a wire, the default 0.815 is the vintage blend, and 1 puts the two level. Delay is the line’s average length. Tone is the wet voice’s low-pass: at its default 3 kHz the wet voice is at least 10 dB down at 10 kHz, the dark sound of the originals, and at 12 kHz it is less than 6 dB down there. The Effect controls page lists what the knobs span.

One voice. A hit comes back once, with no repeats: there is no feedback. The sweep runs free and does not follow a host’s tempo.

Levels. The wet voice adds to your signal, so at Mix 1 the output can reach twice the input. Keep the input under -6.03 dBFS and no setting reaches a rail; with the ceiling taken away, a phrase peaking at -3 dBFS rails. Mix 0 is a wire at any level.

Timing. Latency is zero at every setting: the wet voice’s delay is the effect, and your own signal comes through on time.

On a board. The class needs audiodsp’s audioecho, and on a board without it construction raises ImportError.

NAME = 'Chorus'

The stable provider name audioeffects.create() discovers.

TIER = 'audiodsp'

STOCK or AUDIODSP, with REQUIRES naming the audiodsp-own modules an AUDIODSP class needs.

Type:

roadmap §3

CAPABILITIES = ()

The contract’s static reads. CAPABILITIES names "tempo_sync" if and only if the class reads self._transport().

INPUT_CEILING_DBFS = -6.03

The wet voice is a delayed, low-passed copy of the input, so it never passes the input’s peak, and the dry is at unity: the sum is at most twice the input at Mix 1. -6.03 dBFS is 16 366 against the 32 767 rail.

MACRO_LABELS = ('Rate', 'Depth', 'Mix', 'Delay', 'Tone')

Knob names, one per macro index; one mode per label; the private engineering spans behind them; and the patches on the 0-127 grid.

reset()[source]

A reset is a fresh instance: patch 0’s delay lands at once.