beamer_core/
lib.rs

1//! # beamer-core
2//!
3//! Core abstractions for the Beamer audio plugin framework.
4//!
5//! This crate provides platform-agnostic and format-agnostic traits that define
6//! the interface for audio plugins. It has no external dependencies, making it
7//! suitable for use in any context.
8//!
9//! ## Main Traits
10//!
11//! - [`Plugin`] - Complete plugin trait combining DSP and parameters
12//! - [`AudioProcessor`] - Core DSP processing trait
13//! - [`Parameters`] - Parameter collection trait
14//! - [`EditorDelegate`] - GUI configuration and callbacks
15//!
16//! ## Types
17//!
18//! - [`Size`] - 2D size in pixels
19//! - [`Rect`] - Rectangle in pixels
20//! - [`Buffer`] - Main audio I/O buffer
21//! - [`AuxiliaryBuffers`] - Sidechain and aux bus access
22//! - [`BusInfo`] - Audio bus configuration
23//! - [`ParameterInfo`] - Parameter metadata
24//! - [`PluginError`] - Error types
25//! - [`MidiEvent`] - MIDI event types
26//! - [`Transport`] - DAW transport/timing state
27//! - [`ProcessContext`] - Processing context with sample rate and transport
28
29pub mod buffer;
30pub mod bypass;
31pub mod editor;
32pub mod error;
33pub mod midi;
34pub mod midi_cc_config;
35pub mod midi_cc_state;
36pub mod parameter_format;
37pub mod parameter_groups;
38pub mod parameter_info;
39pub mod parameter_range;
40pub mod parameter_store;
41pub mod parameter_types;
42pub mod plugin;
43pub mod process_context;
44pub mod sample;
45pub mod smoothing;
46pub mod types;
47
48// Re-exports for convenience
49pub use buffer::{AuxiliaryBuffers, AuxInput, AuxOutput, Buffer};
50pub use bypass::{BypassAction, BypassHandler, BypassState, CrossfadeCurve};
51pub use editor::{EditorConstraints, EditorDelegate, NoEditor};
52pub use error::{PluginError, PluginResult};
53pub use midi::{
54    // Basic types
55    cc, ChannelPressure, ControlChange, MidiBuffer, MidiChannel, MidiEvent, MidiEventKind,
56    MidiNote, NoteId, NoteOff, NoteOn, PitchBend, PolyPressure, ProgramChange,
57    // Advanced VST3 events
58    ChordInfo, NoteExpressionInt, NoteExpressionText, NoteExpressionValue, ScaleInfo, SysEx,
59    // MIDI 2.0 types
60    Midi2Controller,
61    // RPN/NRPN types
62    rpn, ParameterNumberKind, ParameterNumberMessage, RpnTracker,
63    // Note Expression Controller types (VST3 SDK 3.5.0)
64    NoteExpressionTypeFlags, NoteExpressionTypeInfo, NoteExpressionValueDesc,
65    // Keyswitch Controller types (VST3 SDK 3.5.0)
66    keyswitch_type, KeyswitchInfo,
67    // Physical UI Mapping types (VST3 SDK 3.6.11)
68    physical_ui, PhysicalUIMap,
69    // MPE Support types (VST3 SDK 3.6.12)
70    MpeInputDeviceSettings,
71    // Constants modules
72    note_expression,
73    // 14-bit CC utilities
74    combine_14bit_cc, combine_14bit_raw, split_14bit_cc, split_14bit_raw,
75    // Buffer size constants
76    MAX_CHORD_NAME_SIZE, MAX_EXPRESSION_TEXT_SIZE, MAX_KEYSWITCH_TITLE_SIZE,
77    MAX_NOTE_EXPRESSION_TITLE_SIZE, MAX_SCALE_NAME_SIZE, MAX_SYSEX_SIZE,
78};
79pub use parameter_format::Formatter;
80pub use parameter_range::{LinearMapper, LogMapper, LogOffsetMapper, PowerMapper, RangeMapper};
81pub use parameter_groups::{GroupId, GroupInfo, ParameterGroups, ROOT_GROUP_ID};
82pub use parameter_info::{ParameterFlags, ParameterInfo};
83pub use parameter_store::{NoParameters, ParameterStore};
84pub use parameter_types::{BoolParameter, EnumParameter, EnumParameterValue, FloatParameter, IntParameter, ParameterRef, Parameters};
85pub use smoothing::{Smoother, SmoothingStyle};
86pub use midi_cc_config::{controller, MidiCcConfig, MAX_CC_CONTROLLER};
87pub use midi_cc_state::{MidiCcState, MIDI_CC_PARAM_BASE};
88pub use plugin::{
89    AudioProcessor, AudioSetup, BusInfo, BusLayout, BusType, FullAudioSetup, HasParameters,
90    Midi1Assignment, Midi2Assignment, MidiControllerAssignment, NoConfig, Plugin, ProcessorConfig,
91};
92pub use process_context::{FrameRate, ProcessContext, Transport};
93pub use sample::Sample;
94pub use types::{ParameterId, ParameterValue, Rect, Size, MAX_AUX_BUSES, MAX_BUSES, MAX_CHANNELS};