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 withexport_vst3!/export_lv2!. - export_
lv2 - Export
$logicas this cdylib’s LV2 entry (lv2_descriptor+lv2ui_descriptor). - export_
vst3 - Export
$logic(PluginLogic) as this cdylib’s VST3 entry point.
Structs§
- Audio
Buffer - Borrowed host channel buffers for one process block.
- Audio
Config - Config handed to
resetwhen the host (re)prepares the plugin. - Audio
Tap - Lock-free single-producer/single-consumer sample tap for the audio → UI analyzer path (audio→UI sample ring).
- Bool
Param - A boolean parameter.
- BusLayout
- One complete I/O layout (main in/out + optional sidechain in + optional aux out).
- Enum
Param - An enum parameter.
- Factory
Preset - One bundled factory preset for the host browser.
- Float
Param - A continuous floating-point parameter.
- IntParam
- An integer parameter.
- Meter
Slot - A meter slot with an auto-assigned ID.
- Midi
Buffer - Ordered MIDI events for one audio block. Sorted by
MidiEvent::sample_offset. - Midi
Event - One MIDI message at a sample offset within the current block.
- Midi
Message - One MIDI message. Channel is
0..=15for channel voice messages. - Note
Buffer - Ordered note events for one audio block (same insert rules as MIDI).
- Note
Event - One timed note-scoped event inside a process block.
- Note
Name Entry - One entry in a plugin’s custom note-name table (
CLAP_EXT_NOTE_NAME). - Note
Target - Note-scope fields shared by CLAP note / expression / per-note-mod events.
- Note
Voice - One occupied slot in
NoteVoiceTable. - Note
Voice Table - Fixed-size voice pool. No heap in
apply/flush_endsafterSelf::new. - Param
Event Queue - GUI → audio-thread param event queue.
- Param
Flags - Param
Info - Metadata for a single parameter, used by format wrappers.
- Plugin
Context - Context passed to
Editor::open. - Plugin
Info - Static metadata about a plugin.
- Process
Context - Per-block context handed to
process(). - Smoother
- Per-parameter smoother. All methods take
&selffor interior mutability, enabling use throughArc<Params>. - Transport
- Host timeline state (CLAP transport; VST3 maps onto the same shape; LV2 has no transport fill yet).
- Tuning
- Handle passed to
crate::ProcessContextfor per-voice tuning queries. - Tuning
Event - A tuning selection event delivered by the host.
- Tuning
Info - 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§
- Channel
Config - Channel width of a main audio bus.
- Factory
Preset State - How a factory preset stores its parameter values.
- Midi
Dialect - Wire dialect a MIDI port speaks.
- Midi
Source - MIDI message kind for
ParamInfo::midi_maphints. - Midi
Status - High nibble of status byte (channel messages use low nibble as channel).
- Note
Event Kind - What happened to a (possibly scoped) note.
- Note
Expression - CLAP note-expression id (
clap_note_expression). Unknown values stay raw. - Param
Event - Param event from the editor toward the host (gestures mark automation).
- Param
Range - Defines how a parameter maps between plain and normalized values.
- Param
Unit - Param
Value Kind - Which strongly-typed
*Paramconstructor produced thisParamInfo. The#[derive(Params)]macro sets it from the field type so format-side code can branch on the original typing without re-deriving it fromrange/unit. - Plugin
Category - Broad plugin category for host browsers.
- Process
Mode - How the host is driving audio through the plugin this activation.
- Process
Status - What the plugin wants after
process. - RawWindow
Handle - Raw platform window handle for GUI parenting.
- Smoothing
Style - 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.
- Editor
Bridge - Bridge editor ↔ host / param store (minimal).
- Float
- Math on
f32orf64(gains, freqs, coefficients — not necessarily samples). - Float
Param Read F32 - Precision-routed read accessors for
FloatParamatf32. - Float
Param Read F64 - Precision-routed read accessors for
FloatParamatf64. SeeFloatParamReadF32for the contract. - Into
Editor - Box a concrete editor into
Box<dyn Editor>. - Param
Enum - 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.
- Plugin
Logic - What plugin authors implement for realtime DSP + optional GUI factory.
- Sample
FloatplusDefault + Send + Sync + 'staticfor buffers and scratch.
Functions§
- append_
midi_ as_ notes - Append Note-On/Off and All-Sound/Notes-Off (CC 120/123) from
midias 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
notesas 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. Returnsfalseif 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 includes0andframes). - notes_
or_ midi - Prefer CLAP notes when the host sent any; otherwise fill
scratchfrom MIDI. - parse_
param_ value - Inverse of
format_param_valuefor hosttext_to_valueround-trips.