plughost-core 0.2.6

Shared types and offline render rules for plughost
Documentation
//! Shared types and offline render rules for plughost.
//!
//! See the [integration guide](https://github.com/emulette/plughost/blob/v0.2.6/llms.txt)
//! for end-to-end processing, routing, scanning, and recovery contracts.

#![warn(missing_docs)]

mod audio;
mod capabilities;
pub use audio::{
    AudioBusConfig, AudioBusInfo, AudioBusRole, AudioConfig, AudioConfiguration, AudioDirection,
    AudioInputRoute, AudioSource, BypassState, ChannelAdaptation, MAX_ALIGNMENT_BYTES,
    MAX_AUDIO_BUSES, MAX_AUDIO_CHANNELS, RoutedChainConfig, SlotAudioConfig,
};
mod config;
mod diagnostics;
mod errors;
mod event;
mod event_routing;
mod host;
#[doc(hidden)]
pub mod ipc;
mod parameter;
mod programs;
pub use programs::{FactoryPreset, FactoryPresetId, MAX_FACTORY_PRESETS};
mod parameter_events;
mod plugin;
pub mod remote;
pub mod render;
mod sample;
mod state;
mod transport;

pub use capabilities::{Capabilities, CapabilityReport, Support};
pub use config::{Layout, ProcessConfig, ProcessMode, SampleFormat};
pub use diagnostics::{
    DIAGNOSTIC_CAPACITY, DIAGNOSTIC_MESSAGE_BYTES, Diagnostic, DiagnosticBatch, DiagnosticSeverity,
};
pub use errors::{Failure, FailureKind, InputError, RenderError};

/// Diagnostic messages shared by the plughost crates. Internal to plughost, plughost-formats, and
/// plughost-helper; exempt from semver.
#[doc(hidden)]
pub mod messages {
    pub use crate::errors::{
        AUDIT, CHAIN_NOT_PREPARED, MAIN_BUS, OUTPUT_EVENT_CAPACITY, STATE_MISMATCH,
        UNCONVERTIBLE_OUTPUT_EVENTS, UNKNOWN_EVENT_PORT,
    };
}
/// The processing path's real-time audit. Internal to plughost-formats and plughost-helper;
/// exempt from semver.
#[doc(hidden)]
pub mod audit;
/// Buffers and checks the plughost crates share. Internal to plughost, plughost-formats, and
/// plughost-helper; exempt from semver.
#[doc(hidden)]
pub mod internal {
    pub use crate::changes::ChangeBuffer;
    pub use crate::diagnostics::DiagnosticBuffer;
    pub use crate::event::{events_fit, validate_event_budget};
    pub use crate::parameter::{
        changes_fit, validate_choice_page, validate_normalized, validate_parameter_text,
    };
    pub use crate::parameter_events::ParameterEventBuffer;
    pub use crate::sample::{Level, level};
}
pub use event::{
    Event, EventData, Events, ExpressionKind, Iter as EventsIter, MAX_BLOCK_EVENTS,
    MAX_BLOCK_SYSEX_BYTES, MAX_NOTE_ID, Message, Note, NoteExpression,
};
pub use event_routing::{
    EventConfig, EventInputRoute, EventPortInfo, EventSource, MAX_EVENT_PORTS, SlotEventConfig,
};
pub use host::HostIdentity;
pub use parameter::{
    AutomationEvent, PARAMETER_TEXT_BYTES, ParameterChange, ParameterFlags, ParameterInfo,
};
pub use parameter_events::{PARAMETER_EVENT_CAPACITY, ParameterEvent, ParameterEventBatch};
pub use plugin::{ClassId, PluginFormat, PluginId, PluginInfo, PluginKind, PluginRef};
pub use sample::Sample;
pub use state::{MAX_STATE_BYTES, PluginState};
pub use transport::{BarPosition, BlockContext, LoopRegion, TimeSignature, Transport};

mod changes;
pub use changes::{CHANGE_CAPACITY, ChangeBatch, PluginTiming, SlotChange};

pub use state::{MAX_PRESET_BYTES, PresetInfo, PresetMetadata, StatePurpose};

pub use parameter::{
    PARAMETER_CHOICE_PAGE_SIZE, ParameterChoice, ParameterChoicePage, ParameterDetails,
    ParameterGroup,
};

mod preset_discovery;
pub use preset_discovery::{
    DiscoveredPreset, PRESET_DISCOVERY_TEXT_BYTES, PresetDiscovery, PresetDiscoveryTarget,
    PresetFileFailure, PresetFileType, PresetFlags, PresetLocation, PresetLocationInfo,
    PresetPluginId, PresetProviderInfo, PresetSoundpack,
};