audioeffects.shimmerhall
ShimmerHall - a hall that rings an octave above what you play.
You play into a hall, and a pitch shifter beside it makes the tail ring at the Interval you choose. Character picks how it is built. In Bloom the shifted copy goes into the hall once, Bloom after you play, and the whole hall waits for it. In Rise the shifter sits in a feedback loop: the hall starts at once, and each pass comes back shifted again, so the tail climbs while Damping darkens every pass until it fades.
Shimmer is how loud the shifted copy goes into the hall. Bloom is the wait
in Bloom and the time between passes in Rise. Rise is how strongly each
pass returns, in Rise only. Interval picks one of five shifts: -12, -5, +7,
+12 or +24 semitones. Decay, Size and Damping set the hall, and Damping
also darkens each pass of the loop. Mix is audiodelays.Echo’s: your dry
signal at unity up to 1, the hall alone at 2. The Effect controls page
lists what the knobs span and the patches.
In Bloom, move Bloom and the shifted copy moves by the same time, within 512 frames. Its energy centres within 2.5 semitones of the Interval. In Rise the loop’s short window spreads the first pass wider: within 2.5 semitones at -5 and +7, 3.5 at +12 and 6 at -12 and +24.
In Rise at +12 each octave arrives one Bloom after the one below, within 20 %. Moving Rise from 0.3 to 0.9 brings the third pass back 16 to 22 dB stronger against the first, and in Bloom Rise changes nothing. With Damping at 800 Hz the fourth pass is at least 12 dB weaker against the first than at 16 kHz.
Up to Mix 1 your dry signal passes untouched, sample for sample: the shimmer is only ever in the hall. At Mix 0 the output is your input, byte for byte. Latency is zero. Keep your input at or under -24 dBFS: with Decay, Size, Shimmer and Rise at the top, a steady loud input fills the hall to the rail.
tail_samples bounds how long the output takes to reach exact zero once
your input stops: 82 s at Rise 0.9 and Bloom 800 ms. reset() empties the
hall, the line and the shifter, and restores patch 0. Octave Rise is Octave
Bloom in Rise at Rise 0: one octave, once, and the hall starts at once. On
an ESP32-S3 the Bloom patches (Octave Bloom, Short Stagger and Fifth Halo)
take longer than a block and cannot keep up; the defaults and every Rise
patch keep up.
Limits
A control that jumps makes the output step: move it in small steps from the host if you need it smooth. Moving Character or Size empties the hall: the tail drops and the dry carries on. If your host takes the output before it loads a patch or moves Mix, the first 256 frames, 5 ms at 48 kHz, play at the old level.
Interval is a fixed shift in semitones, with no key awareness. Both shifters splice, so the shifted copy has a slight flutter. In Rise, a held note’s shimmer lands on the octave, a held G3 at +12 included. With Damping high and Rise near the top, or at the widest intervals, the climb fades out at the top of the band at 48 kHz; at 22.05 kHz a tone outside the series can still fold back, 25 to 40 dB under the first pass. Keep Damping lower for a clean climb. A mono source gets a mono rack. It needs a board with PSRAM.
When your source ends, the tail rings out as it would on silence. On a CircuitPython board, stop the rack from the host if your source can run dry in Bloom: CircuitPython’s own pitch shifter waits on a source that comes back empty. Firmware built with omnipython-builds’ build_mp.py carries the fix and returns.
A value outside a macro’s span clamps to the nearer stop, and NaN takes the
default; an interval other than the five raises ValueError.
- audioeffects.shimmerhall.BLOCK = 256
the palette’s block.
- Type:
Frames per pull
- audioeffects.shimmerhall.INTERVALS = (-12, -5, 7, 12, 24)
Interval’s five zones, in semitones, low to high on the 0-127 grid.
- audioeffects.shimmerhall.INTERVAL_MIDI = (0, 32, 64, 96, 127)
Where each zone sits on the grid when the constructor or a patch names it.
- audioeffects.shimmerhall.WINDOW_MS = 40.0
its window and crossfade, in ms.
- Type:
Bloom’s shifter
- audioeffects.shimmerhall.LOOP_WINDOW_MS = 25.0
the loop’s window. A shifted loop reads half of it late (
docs/upstream-diff.md,loop_semitones), so Rise’s line is set that much short of Bloom.- Type:
Rise’s shifter
- audioeffects.shimmerhall.LINE_MS = 825.0
Bloom’s top plus the loop window, the furthest a shifted tap reads.
- Type:
The line
- audioeffects.shimmerhall.STEPS = 256
audiodelays.PitchShiftreads in whole 256ths of unity (PitchShift.c:121), rounding down.
- audioeffects.shimmerhall.DEFAULT_STEPS = (127, 89, 0, 90, 96, 94, 64, 91, 32)
Each macro’s patch-0 step; the constructor defaults are these steps’ values, so a fresh instance is patch 0.
- audioeffects.shimmerhall.SHIMMER = 0.7007874015748031
each patch-0 step’s value. NaN falls back to these.
- Type:
The constructor defaults
- audioeffects.shimmerhall.step_centre_semitones(step)[source]
Semitones that put
audiodelays.PitchShiftonstep: the centre of the step, so the node’s truncation lands on it at any float width.
- audioeffects.shimmerhall.interval_step(semitones)[source]
The shifter’s read rate nearest
semitones, in 256ths.
- class audioeffects.shimmerhall.ShimmerHall(source, *options, **keywords)[source]
Bases:
ComponentA pitch shifter around a hall. The module docstring is the player’s page.
- NAME = 'ShimmerHall'
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().
- MACRO_LABELS = ('Character', 'Shimmer', 'Rise', 'Bloom', 'Interval', 'Decay', 'Size', 'Damping', '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: ('Octave Rise', (127, 89, 0, 90, 96, 94, 64, 91, 32)), 1: ('Short Stagger', (0, 76, 85, 38, 96, 77, 38, 102, 25)), 2: ('Fifth Halo', (0, 102, 85, 103, 64, 108, 89, 84, 38)), 3: ('Slow Rise', (127, 89, 85, 103, 96, 108, 89, 86, 38)), 4: ('Rise Damped', (127, 102, 113, 87, 96, 94, 64, 51, 32)), 5: ('Falling Octaves', (127, 89, 85, 93, 0, 102, 64, 76, 32)), 6: ('Octave Bloom', (0, 89, 85, 90, 96, 94, 64, 91, 32))}
_component.macro_ofof the card’s settings.
- macro(index)[source]
What macro
indexcurrently stands for, in its own units; for Interval, the semitones it plays.
- property output
The node the host plays. Asking for it is the host’s first step to pulling, so from here a level that moves is an ordinary move.
- reset()[source]
Empty the hall, the line and the shifter, return to patch 0, and play from there as a new instance does.
- property tail_samples
Frames until the output is exactly zero once the input stops, as an upper bound.