Structs§
- Midi
Event - Fixed-size MIDI event (16 bytes, 16-byte aligned).
- Parameter
Event - Fixed-size parameter change event (16 bytes, 16-byte aligned).
- ShmHeader
- Shared-memory header (256 bytes).
- Transport
State - Transport state block (256 bytes).
Constants§
- AUDIO_
BUFFER_ SIZE - AUDIO_
OFFSET - Audio buffers start after the control area.
- CONTROL_
OFFSET - Control area starts right after the header.
- CONTROL_
SIZE - ECHO_
READ_ IDX_ OFFSET - ECHO_
RING_ OFFSET - ECHO_
RING_ SIZE - ECHO_
WRITE_ IDX_ OFFSET - HEADER_
SIZE - LAYOUT_
SIZE - Total bytes actively used by the protocol layout.
- MAGIC
- Magic number: “MAOL” in big-endian ASCII.
- MAX_
BLOCK_ SIZE - Maximum audio block size in samples.
- MAX_
CHANNELS - Maximum number of audio channels (main + sidechain combined).
- MIDI_
READ_ IDX_ OFFSET - MIDI_
RING_ OFFSET - MIDI ring buffer.
- MIDI_
RING_ SIZE - MIDI_
WRITE_ IDX_ OFFSET - NUM_
BUSES - Number of audio buses (main + sidechain).
- PARAM_
EVENT_ GESTURE_ BEGIN - PARAM_
EVENT_ GESTURE_ END - PARAM_
EVENT_ MOD - PARAM_
EVENT_ VALUE - PARAM_
READ_ IDX_ OFFSET - PARAM_
RING_ OFFSET - Parameter ring buffer.
- PARAM_
RING_ SIZE - PARAM_
WRITE_ IDX_ OFFSET - RING_
CAPACITY - Capacity of each ring buffer in slots (power of two).
- SCRATCH_
OFFSET - State blob scratch area.
- SCRATCH_
SIZE - SHM_
SIZE - Total shared-memory allocation size (4 MiB, page-aligned).
- TRANSPORT_
OFFSET - Transport state block (256-byte aligned from here).
- TRANSPORT_
SIZE - VERSION
- Current protocol version.
Functions§
- audio_
channel_ ⚠ptr - Returns a pointer to a specific channel/bus plane.
- audio_
ptr ⚠ - Returns a pointer to the audio buffer region.
- echo_
indices ⚠ - Returns pointers to the echo ring write/read atomics.
- echo_
ring_ ⚠ptr - Returns a pointer to the echo ring buffer slot array.
- header_
mut ⚠ - Returns a mutable reference to the header.
- header_
ref ⚠ - Returns a reference to the header at the start of the mapping.
- init_
shm_ ⚠layout - Zero-initialize the entire shared-memory region and write the header.
- midi_
indices ⚠ - Returns pointers to the MIDI ring write/read atomics.
- midi_
ring_ ⚠ptr - Returns a pointer to the MIDI ring buffer slot array.
- param_
indices ⚠ - Returns pointers to the parameter ring write/read atomics.
- param_
ring_ ⚠ptr - Returns a pointer to the parameter ring buffer slot array.
- scratch_
ptr ⚠ - Returns a pointer to the scratch buffer region.
- transport_
mut ⚠ - Returns a mutable reference to the transport state.
- transport_
ref ⚠ - Returns a reference to the transport state.
- wait_
for_ ready - Wait (spin + yield) until
readybecomes non-zero or timeout elapses.