audioeffects.vibrato

Vibrato - a clock-modulated bucket-brigade line, wet alone.

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

audioeffects.vibrato.MAX_DELAY_MS = 80.0

Delay 12 ms at m = 0.85 reaches d_max ≈ 80 ms.

audioeffects.vibrato.SHAPE_LEN = 256

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

audioeffects.vibrato.BLOCK_FRAMES = 256

FeedbackDelay’s native block, which the Mixer’s buffer matches.

audioeffects.vibrato.DEPTH_OFF = 0.0001

wow_depth_ms = 0, delay = mean.

Type:

Depth / m below this is off

audioeffects.vibrato.M_MAX = 0.85

Clock index clamp so 1 + m·u stays away from zero.

audioeffects.vibrato.RISE_10_90 = 0.8

10–90 % of a linear 0→1 ramp is 0.8 of its duration; Rise names that 10–90 % of the Engage envelope (wow_depth_ms). Instantaneous-frequency 10–90 at Rate 5 Hz cannot resolve a 150 ms rise — one LFO period is 200 ms — so T5’s ifreq clause is Station C’s 5 s extreme, not this law.

audioeffects.vibrato.DEPTH_GLIDE_MS = 20.0

the node’s default.

Type:

How long a depth move other than Engage glides

audioeffects.vibrato.one_pole_ring(hz, sample_rate)[source]

Frames a FeedbackDelay loop filter at hz takes to fall from full scale to under half an LSB: the node’s state falls by exp(-2 pi f / fs) a frame (one_pole_coefficient), plus one frame for the single precision it computes that in. 0 for a filter out of circuit.

audioeffects.vibrato.clock_shape(m)[source]

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

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

audioeffects.vibrato.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.vibrato.peak_cents(mean_ms, rate_hz, m, steps=256)[source]

Exact peak |Δf/f| of d0/(1 + m·sin ωt), in cents.

audioeffects.vibrato.m_for_cents(mean_ms, rate_hz, cents)[source]

Clock index m whose exact peak cents match cents, clamped to M_MAX.

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

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

class audioeffects.vibrato.Vibrato(source, *options, **keywords)[source]

Bases: Component

A vibrato after the Boss VB-2: your signal comes out only through a short bucket-brigade line whose clock a sine sweeps, so the pitch wobbles and none of the dry is left to comb against it.

Controls. Rate is the sweep’s speed. Depth is the peak pitch swing, and stays that size wherever Rate and Delay sit. Engage turns the vibrato on and off without switching the audio: Rise is how long the depth takes to go from 10 % to 90 % of the way, in a straight line. Any other knob that moves the depth glides there over 20 ms rather than stepping. Delay is the line’s average length. Tone is the wet voice’s low-pass, and Body its high-pass; at the defaults the band is 3 dB down at 40 Hz and at 17 kHz. Level cuts the output by up to 12 dB; at the top of its travel the output is at the input’s level. The Effect controls page lists what the knobs span.

The sound. With no dry path there is no comb: from 200 Hz to 2 kHz the level stays within 1 dB at any Depth up to 60 cents. At the default patch the sweep is a smooth sine, its third harmonic more than 25 dB down. The sweep runs free and does not follow a host’s tempo; reset() starts it afresh.

Timing. Latency is the Delay, snapped to a whole sample: 4 ms by default, which is 192 samples at 48 kHz and 176 at 44.1 kHz. Nothing looks ahead.

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

NAME = 'Vibrato'

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().

MACRO_LABELS = ('Rate', 'Depth', 'Rise', 'Engage', 'Delay', 'Tone', 'Body', 'Level')

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