Skip to main content

Crate aura

Crate aura 

Source
Expand description

AURA — Audio Unified Rust Architecture.

Umbrella crate for plugin authors. Prefer this over depending on every aura-* piece individually:

lx-aura = { path = ".../AURA/crates/aura", features = ["clap"] }
# optional UI:
lx-aura-baseview = { path = "...", features = ["backend-femtovg"] }
lx-aura-editor = { path = "...", features = ["backend-femtovg"] }
ⓘ
use aura::prelude::*;

Package name is lx-aura; the Rust crate stays aura ([lib] name). Features: clap / vst3 / lv2 for formats; dsp (default) for lx-aura-dsp. Params-only plugins: default-features = false.

#[derive(Params)] requires this umbrella (or an equivalent aura_params + path setup) — generated code uses ::aura::params::….

Re-exports§

pub use aura_core as core;
pub use aura_midi as midi;
pub use aura_params as params;
pub use aura_dsp as dsp;
pub use aura_clap as clap;
pub use aura_vst3 as vst3;
pub use aura_lv2 as lv2;

Modules§

prelude
Common imports for plugin authors.

Macros§

export
Export $logic (PluginLogic) as this cdylib’s CLAP entry point.
export_clap
Alias of export! for symmetry with export_vst3! / export_lv2!.
export_lv2
Export $logic as this cdylib’s LV2 entry (lv2_descriptor + lv2ui_descriptor).
export_vst3
Export $logic (PluginLogic) as this cdylib’s VST3 entry point.

Structs§

AudioBuffer
Borrowed host channel buffers for one process block.
AudioConfig
Config handed to reset when the host (re)prepares the plugin.
AudioTap
Lock-free single-producer/single-consumer sample tap for the audio → UI analyzer path (audio→UI sample ring).
BoolParam
A boolean parameter.
BusLayout
One complete I/O layout (main in/out + optional sidechain in + optional aux out).
EnumParam
An enum parameter.
FactoryPreset
One bundled factory preset for the host browser.
FloatParam
A continuous floating-point parameter.
IntParam
An integer parameter.
MeterSlot
A meter slot with an auto-assigned ID.
MidiBuffer
Ordered MIDI events for one audio block. Sorted by MidiEvent::sample_offset.
MidiEvent
One MIDI message at a sample offset within the current block.
MidiMessage
One MIDI message. Channel is 0..=15 for channel voice messages.
NoteBuffer
Ordered note events for one audio block (same insert rules as MIDI).
NoteEvent
One timed note-scoped event inside a process block.
NoteNameEntry
One entry in a plugin’s custom note-name table (CLAP_EXT_NOTE_NAME).
NoteTarget
Note-scope fields shared by CLAP note / expression / per-note-mod events.
NoteVoice
One occupied slot in NoteVoiceTable.
NoteVoiceTable
Fixed-size voice pool. No heap in apply / flush_ends after Self::new.
ParamEventQueue
GUI → audio-thread param event queue.
ParamFlags
ParamInfo
Metadata for a single parameter, used by format wrappers.
PluginContext
Context passed to Editor::open.
PluginInfo
Static metadata about a plugin.
ProcessContext
Per-block context handed to process().
Smoother
Per-parameter smoother. All methods take &self for interior mutability, enabling use through Arc<Params>.
Transport
Host timeline state (CLAP transport; VST3 maps onto the same shape; LV2 has no transport fill yet).
Tuning
Handle passed to crate::ProcessContext for per-voice tuning queries.
TuningEvent
A tuning selection event delivered by the host.
TuningInfo
Metadata for one host tuning entry (CLAP clap.tuning/2).
Ump
One UMP packet: 1, 2, or 4 native-endian 32-bit words.
UmpBuffer
Ordered UMP events for one audio block. Same insert / rebase rules as MidiBuffer.
UmpEvent
One Universal MIDI Packet at a sample offset within the current block.

Enums§

ChannelConfig
Channel width of a main audio bus.
FactoryPresetState
How a factory preset stores its parameter values.
MidiDialect
Wire dialect a MIDI port speaks.
MidiSource
MIDI message kind for ParamInfo::midi_map hints.
MidiStatus
High nibble of status byte (channel messages use low nibble as channel).
NoteEventKind
What happened to a (possibly scoped) note.
NoteExpression
CLAP note-expression id (clap_note_expression). Unknown values stay raw.
ParamEvent
Param event from the editor toward the host (gestures mark automation).
ParamRange
Defines how a parameter maps between plain and normalized values.
ParamUnit
ParamValueKind
Which strongly-typed *Param constructor produced this ParamInfo. The #[derive(Params)] macro sets it from the field type so format-side code can branch on the original typing without re-deriving it from range / unit.
PluginCategory
Broad plugin category for host browsers.
ProcessMode
How the host is driving audio through the plugin this activation.
ProcessStatus
What the plugin wants after process.
RawWindowHandle
Raw platform window handle for GUI parenting.
SmoothingStyle
Smoothing style for a parameter.

Constants§

NOTE_UNSPECIFIED
Wildcard used by CLAP when a field is unspecified (-1).

Traits§

Editor
Plugin GUI editor — host open/close/idle/resize.
EditorBridge
Bridge editor ↔ host / param store (minimal).
Float
Math on f32 or f64 (gains, freqs, coefficients — not necessarily samples).
FloatParamReadF32
Precision-routed read accessors for FloatParam at f32.
FloatParamReadF64
Precision-routed read accessors for FloatParam at f64. See FloatParamReadF32 for the contract.
IntoEditor
Box a concrete editor into Box<dyn Editor>.
ParamEnum
Trait for enums used as parameters.
Params
Trait implemented by #[derive(Params)] on a struct. Format wrappers use this to enumerate, read, and write parameters.
PluginLogic
What plugin authors implement for realtime DSP + optional GUI factory.
Sample
Float plus Default + Send + Sync + 'static for buffers and scratch.

Functions§

append_midi_as_notes
Append Note-On/Off and All-Sound/Notes-Off (CC 120/123) from midi as CLAP notes.
append_midi_as_ump
Lift 7-bit MIDI into type-0x2 UMP (VST3/LV2 → process ump).
append_notes_as_midi
Append On/Off/Choke from notes as 7-bit MIDI (VST3/LV2 out).
append_ump_as_midi
Down-convert UMP that has a MIDI 1 image (VST3/LV2 out). Per-note PB / SysEx8 / Flex stay behind.
apply_factory_preset
Apply a factory preset onto params. Returns false if a blob is malformed.
decode_state
Restore param values (and persist fields when present) from a v1 or v2 blob.
encode_state
Serialize param values + #[persist] fields into the host state blob.
format_param_value
Format a plain parameter value as a display string based on the parameter’s unit.
layout_at
Resolve a layout by index, defaulting to the first entry or stereo.
load_preset_file
Load a v1 state file from disk. Default [PluginLogic] file path.
note_split_points
Allocating wrapper around note_split_points_into.
note_split_points_into
Sorted unique split points in 0..=frames (always includes 0 and frames).
notes_or_midi
Prefer CLAP notes when the host sent any; otherwise fill scratch from MIDI.
parse_param_value
Inverse of format_param_value for host text_to_value round-trips.

Derive Macros§

ParamEnum
Derive ParamEnum for a C-like enum.
Params
Derive the Params implementation for a parameter struct.