audioeffects.reverb
Reverb - Dattorro’s plate network, cut four ways: a plate, a room, a
chamber and a hall.
Your dry signal passes untouched and a reverb tail rises behind it.
Character picks the machine: plate is dense from the first milliseconds,
the way the EMT 140’s steel sheet is, while room, chamber and hall
start sparse and build. Decay sets how long the tail rings, Size stretches
the network’s lines, and Predelay holds the tail back from the dry.
Diffusion smears the early echoes, Damping darkens the tail as it rings,
and Bandwidth darkens what goes in. Low Cut keeps the bass out of the tank
while the dry keeps it. Mod Depth and Mod Rate wobble two lines inside the
tank, Width sets the stereo spread, and Tone tilts the tail. Mix is
audiodelays.Echo’s: the dry at unity until 1, the tail alone at 2. Mix 0
is a byte-exact wire while the tank keeps ringing behind it. Latency is
zero: nothing looks ahead, and Predelay delays only the tail. The Effect
controls page lists what the knobs span and the patches.
On the plate, Decay also moves the tail’s loss corner, the way the EMT 140’s damping panel does: open at Decay 8 s and above, at the Damping setting at 1 s and below.
A Character or Size move re-cuts the tank: the tail drops to nothing at the
move, and the dry carries on without losing a frame. reset() empties the
tank the same way, keeps the dry, and restores patch 0.
Decay. At each character’s reference patch (Steel Plate, Live Room, Dark Chamber, Concert Hall) at Size 1.0, the tail falls 60 dB at 500 Hz within 12 % of Decay at 2, 3, 4, 6, 8 and 10 s, and on the hall from 4 s. Shorter Decays, other Sizes and the other patches are not claimed: Damped Plate, Small Room and Live Room ring longer than their Decay reads. With Damping at 1 kHz and Size 0.5, the room, chamber and hall at Decay 8 and 10 s ring more than 12 % short of it: the class holds the bass to 1.5 x Decay.
Modulation. With Mod Depth at 0, a 1 kHz tone on Steel Plate or Concert Hall comes out as one line, its sidebands more than 60 dB under it. On those two patches as shipped, at every grid position from 17 to 64 of Mod Depth (about 0.27 to 1 ms) and from 45 to 81 of Mod Rate (about 0.4 to 1.2 Hz), tones at 300 Hz, 1 kHz and 3 kHz spread into sidebands within 20 dB of the tone. Outside that it is not claimed: on Steel Plate a 3 kHz tone at Mod Depth position 81 (about 1.28 ms) and Mod Rate position 121 (about 4.16 Hz) reads more than 20 dB under.
Input ceiling. There is no input gain, and the tank’s lines clamp at the rail on every write whatever Mix is: a steady 362 Hz tone at 8 000 LSB RMS comes back more than 1 dB quieter in the tail than at 4 000. On 2 s of uniform noise at 4 000 LSB RMS at Mix 1, no shipped patch reaches the rail at 48, 44.1 or 22.05 kHz; Bright Chamber at 44.1 kHz is not claimed. Keep the input under -12 dBFS and the defaults and patches stay off the rails.
tail_samples bounds the frames until the output is exactly zero once
your input stops: 222 868 frames at the defaults at 48 kHz. One int16
allocation holds the lines and 200 ms of predelay: 89 714 B for Steel Plate
at 48 kHz, and 146 914 B for the hall at Size 1.5, the most it takes.
Limits shared by the family
A jump of Mix walks to its new setting over 20 ms rather than stepping the output. A jump of another control steps it: move that in small steps from the host if you need it smooth.
When your source ends, the tail rings out as it would on silence.
Asking for character="spring" says it is parked: the tank has no
dispersive chain yet. A value outside a macro’s span clamps to the nearer
stop, and NaN takes the option’s default. On a board without audioverb,
construction raises ImportError.
- audioeffects.reverb.REF_RATE = 29761.0
his Fig. 1 lengths are frames at 29 761 Hz.
- Type:
Dattorro’s reference rate
- audioeffects.reverb.DATTORRO_LINES = (142, 107, 379, 277, 672, 4453, 1800, 3720, 908, 4217, 2656, 3163)
four input diffusers, then half A (modulated all-pass, delay, all-pass, delay) and half B the same.
- Type:
Dattorro Fig. 1’s twelve lines, in the Tank’s order
- audioeffects.reverb.DATTORRO_TAPS = ((0, 9, 266, 0.6), (0, 9, 2974, 0.6), (0, 10, 1913, -0.6), (0, 11, 1996, 0.6), (0, 5, 1990, -0.6), (0, 6, 187, -0.6), (0, 7, 1066, -0.6), (1, 5, 353, 0.6), (1, 5, 3627, 0.6), (1, 6, 1228, -0.6), (1, 7, 2673, 0.6), (1, 9, 2111, -0.6), (1, 10, 335, -0.6), (1, 11, 121, -0.6))
Dattorro Table 2’s fourteen output taps, (channel, line, offset, gain).
- audioeffects.reverb.RATIOS = ((0.3, 0.3, 0.3, 0.3, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0), (4.5, 4.2, 3.4, 3.7, 0.5, 0.36, 0.44, 0.4, 0.52, 0.38, 0.42, 0.37), (4.0, 4.3, 3.0, 3.4, 0.8, 0.62, 0.7, 0.66, 0.78, 0.64, 0.72, 0.6), (2.0, 1.86, 1.6, 1.78, 1.3, 1.12, 1.24, 1.08, 1.26, 1.16, 1.2, 1.1))
Each character’s ratio over Dattorro’s twelve lines (dossier App. A8.8). The plate is his tank with its input diffusers at 0.3 of his, so the density is there by 20 ms (T1); the others stretch the diffusers so the density builds (T8) and re-proportion the tank. No two rows are proportional, so no Size makes two characters’ line sets equal (T9).
- audioeffects.reverb.KAPPA = (1.078125, 1.046875, 1.078125, 1.046875)
The Decay law’s per-character constant (dossier section 4), each a multiple of 1/64 so every float format holds it exactly.
- audioeffects.reverb.LF_CAP = 1.5
the loop’s bass never rings longer than LF_CAP x Decay (dossier section 4; the 1.5 is the design’s).
- Type:
The Decay law’s low-frequency ceiling
- audioeffects.reverb.MIN_LINE = 4
145-146`); the shortest the class cuts anywhere on its span is 12.
- Type:
The node refuses a line under 4 frames (`audiodsp_tank.c
- audioeffects.reverb.MAX_PREDELAY_MS = 200.0
The Tank’s predelay allocation, fixed at construction; the Predelay macro’s top.
- audioeffects.reverb.CHARACTER_MIDI = (0, 42, 85, 127)
Where each character’s zone sits on the 0-127 grid when the constructor or a patch names it: plate 0-31, room 32-63, chamber 64-95, hall 96-127.
- audioeffects.reverb.DAMPER_LONG_S = 8.0
open at DAMPER_LONG_S, the Damping setting at DAMPER_SHORT_S, geometric in log Decay between (dossier section 4, T3).
- Type:
The plate’s damper law
- audioeffects.reverb.DECAY_HZ = 500.0
The frequency Decay is stated at.
- audioeffects.reverb.DEFAULTS = (0.0, 2.4, 1.0, 0.0, 0.75, 1000.0, 12000.0, 40.0, 0.27, 1.0, 1.0, 0.0, 0.35)
The constructor defaults, in macro order, which NaN falls back to.
- audioeffects.reverb.line_set(index, size, sample_rate, ratios=None)[source]
The twelve line lengths, in frames, of character
indexatsizeandsample_rate: round(n x fs / 29 761 x size x r) per line.
- audioeffects.reverb.tap_table(index, size, sample_rate, ratios=None, lines=None)[source]
The fourteen taps, flattened as the Tank takes them: each offset scaled by its own line’s factor and held under that line’s length.
- audioeffects.reverb.half_periods(lines)[source]
Frames around each half of the figure-eight: lines 4-7 and 8-11.
- audioeffects.reverb.one_pole_mag(corner_hz, frequency, sample_rate)[source]
|H| at
frequencyof the node’s loop one-pole, whose coefficient is 1 - exp(-2 pi corner / fs).
- audioeffects.reverb.damper_hz(decay_s, damping_hz, sample_rate)[source]
The plate’s loop corner at a Decay: 0.98 x Nyquist at 8 s and above,
damping_hzat 1 s and below, geometric in log Decay between.
- audioeffects.reverb.decay_law(kappa, lines, sample_rate, decay_s, loop_hz)[source]
The Tank’s
decayfor a T60 ofdecay_sat 500 Hz.One pass through a half multiplies by
decaytwice, the cross-feed read and the in-loop multiply (audiodsp_tank.c:537-538,:552), and the loop one-pole once, so- decay = min(10^(-3 k P / (2 T fs)) / sqrt|H(500 Hz)|,
10^(-3 k P / (2 x 1.5 T fs)))
with P the mean half period in frames. The first term lifts
decayby the one-pole’s loss at 500 Hz; the second caps the bass (where the one-pole is 1) at 1.5 x T. Returns (decay, capped, t_lf):t_lfis the low-frequency T60 the handed decay gives, which bounds the tail.
- audioeffects.reverb.tail_frames(sample_rate, predelay_ms, t_lf, size)[source]
Tier 3’s bound: ceil(fs x (Predelay + 1.6 x max(1.2 x T_lf, 1.5 x Size))).
- class audioeffects.reverb.Reverb(source, *options, **keywords)[source]
Bases:
ComponentDattorro’s network as four machines: an EMT plate that is dense at once and darkens as Decay shortens, and a room, chamber and hall that build. The module docstring is the player’s page.
- NAME = 'Reverb'
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.
CAPABILITIESnames"tempo_sync"if and only if the class readsself._transport().
- INPUT_CEILING_DBFS = -12
The defaults and every patch play the ceiling kit’s materials clean at this level; at -9 dBFS, patch 9 rails on a 220 Hz square.
- MACRO_LABELS = ('Character', 'Decay', 'Size', 'Predelay', 'Diffusion', 'Damping', 'Bandwidth', 'Low Cut', 'Mod Depth', 'Mod Rate', 'Width', 'Tone', 'Mix')
Knob names, one per macro index; one mode per label; the private engineering spans behind them; and the patches on the 0-127 grid.
- PATCHES = {0: ('Steel Plate', (0, 75, 64, 0, 106, 25, 109, 27, 17, 75, 127, 64, 22)), 1: ('Short Plate', (0, 50, 64, 0, 106, 40, 115, 43, 13, 81, 114, 74, 19)), 2: ('Damped Plate', (0, 44, 95, 0, 106, 12, 95, 55, 13, 75, 102, 48, 19)), 3: ('Bass-Free Plate', (0, 65, 64, 0, 106, 25, 103, 114, 17, 75, 102, 74, 25)), 4: ('Small Room', (42, 15, 25, 1, 85, 91, 103, 43, 13, 68, 102, 64, 16)), 5: ('Live Room', (42, 44, 95, 3, 85, 102, 109, 36, 19, 63, 114, 74, 19)), 6: ('Concert Hall', (127, 86, 95, 16, 99, 84, 100, 32, 32, 58, 127, 64, 22)), 7: ('Dark Chamber', (85, 65, 64, 5, 99, 59, 86, 49, 19, 71, 102, 43, 20)), 8: ('Bright Chamber', (85, 61, 64, 5, 99, 116, 119, 59, 19, 71, 102, 85, 20)), 9: ('Slow Bloom', (127, 98, 127, 25, 113, 76, 95, 32, 64, 45, 127, 64, 29))}
_component.macro_ofof the dossier’s section 6 settings, Character at 0 / 42 / 85 / 127; patch 0 is the constructor’s defaults on the grid.
- property tail_samples
Frames until the output is exactly zero once the input stops, as an upper bound (the dossier’s Tier 3): the low-frequency T60 the handed
decaygives, x 1.2 for the law’s error, or 1.5 x Size for the character’s own ringing, whichever is longer, x 1.6, plus the predelay.