NeuralAmpModeler-rs 3.0.2

An opinionated, high-performance Neural Amp Modeler (NAM) client and core implementation in Rust for Linux/PipeWire and CLAP plugins.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

// SPDX-License-Identifier: Apache-2.0
// Copyright (c) 2026 Fábio Henrique de Lima Silva (fhl.bsb@gmail.com) All rights reserved.

//! Structured diagnostics system for NAM-rs.
//!
//! Provides error messages in two layers:
//! 1. **User-friendly message** — readable text for the end user.
//! 2. **Support block** — typed error code, contextual parameters,
//!    version, architecture, and timestamp for precise triage by devs/AI.
//!
//! ## Usage outside the RT thread
//!
//! All formatting and printing of diagnostics occurs **exclusively** in
//! non-RT threads (CLI, PipeWire main loop). The `process()` callback
//! continues using atomic flags (`RtStatusFlags`) for silent signaling.

pub mod bundle;
pub mod diagnostic;
pub mod error_codes;
pub mod format;
pub mod logger;
pub mod snapshot;
pub mod system_info;

pub use bundle::{DiagnosticBundle, ErrorContext};
pub use diagnostic::NamDiagnostic;
pub use error_codes::NamErrorCode;
pub use logger::{HostLogFn, LogBuffer, LogRecord, NamLogger};
pub use snapshot::{
    ACTIVE_MODEL_INFO, ACTIVE_MODEL_NAME, ACTIVE_SAMPLE_RATE, AudioInfo, HasRuntimeSnapshot,
    ModelInfo, RtInfo, RuntimeSnapshot, TelemetrySnapshot,
};
pub use system_info::SystemSnapshot;