aurum-core 0.0.5

On-device speech I/O core: whisper.cpp STT, ONNX TTS, cleanup, providers
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

//! # aurum-core
//!
//! Reusable **on-device speech I/O** library (experimental API).
//!
//! - **STT** — local whisper.cpp by default; optional OpenRouter
//! - **TTS** — local ONNX KittenTTS (cargo feature `tts`, default on)
//! - **Cleanup** — rules or optional LLM post-edit
//!
//! Tagline: *Speech both ways. On-device by default.*
//!
//! The API may change without notice until a deliberate major version.
//!
//! ## STT example
//!
//! ```rust,no_run
//! use aurum_core::audio::{AudioInput, WHISPER_SAMPLE_RATE};
//! use aurum_core::pcm::PcmBuffer;
//! use aurum_core::providers::{LocalWhisperProvider, TranscriptionOptions};
//! use std::path::PathBuf;
//!
//! # async fn demo() -> aurum_core::error::Result<()> {
//! let provider = LocalWhisperProvider::new(PathBuf::from("/tmp/aurum-cache"))
//!     .with_progress(false)
//!     .with_local_only(false);
//! provider.preload("tiny-q5_1").await?;
//!
//! let mut buf = PcmBuffer::dictation();
//! buf.push(&[0.0f32; 1600])?;
//! let result = provider
//!     .transcribe_pcm(
//!         buf.samples().as_slice(),
//!         &TranscriptionOptions {
//!             model: "tiny-q5_1".into(),
//!             language: "en".into(),
//!             timestamps: false,
//!             cancel: None,
//!         },
//!     )
//!     .await?;
//! let _ = AudioInput::from_pcm_slice(buf.samples().as_slice(), WHISPER_SAMPLE_RATE)?;
//! println!("{}", result.text);
//! aurum_core::providers::local::clear_context_cache();
//! # Ok(())
//! # }
//! ```

pub mod audio;
pub mod batch;
pub mod bench;
pub mod cache;
pub mod cancel;
pub mod capabilities;
pub mod cleanup;
pub mod config;
pub mod doctor;
pub mod download;
pub mod dto;
pub mod error;
pub mod eval;
pub mod model;
pub mod observability;
pub mod output;
pub mod partial;
pub mod pcm;
pub mod postprocess;
pub mod profile;
pub mod providers;
pub mod remote;
pub mod runtime;
pub mod support;
#[cfg(feature = "tts")]
pub mod tts;
pub mod window;

pub use audio::{load_audio, AudioInput, WHISPER_SAMPLE_RATE};
pub use batch::{
    build_items, discover_inputs, fingerprint_file, manifest_path, merge_for_resume, work_indices,
    BatchItem, BatchItemStatus, BatchManifest, BatchSummary, AUDIO_EXTENSIONS, BATCH_MANIFEST_NAME,
    BATCH_MANIFEST_VERSION,
};
pub use cancel::CancelFlag;
pub use capabilities::{
    preflight_cleanup, preflight_stt, preflight_tts, ProviderCapabilities,
    CAPABILITY_SCHEMA_VERSION,
};
pub use cleanup::{
    apply_cleanup, apply_cleanup_with_segments, cleanup_text, CleanupProviderKind, CleanupReport,
    CleanupResult, CleanupStyle, OpenRouterCleanup, RulesCleanup, SegmentCleanupPolicy,
    TextCleanup,
};
pub use config::{Config, EffectiveConfigDiagnostic};
pub use doctor::{run_doctor, DoctorCheck, DoctorReport, DoctorSeverity, DOCTOR_SCHEMA_VERSION};
pub use dto::{ErrorDto, SttResultDto, ERROR_SCHEMA_VERSION, STT_RESULT_SCHEMA_VERSION};
pub use error::{AurumError, ErrorCategory, Result, TranscriptionError};
pub use eval::{
    build_report, char_error_rate, repetition_ratio, score_stt, silence_false_positive,
    smoke_corpus, word_error_rate, EvalCorpus, EvalReport, SttFixture, SttScore,
};
pub use model::{list_models, DownloadProgress, EnsureModelOptions, ModelInfo, ModelStatus};
pub use observability::{
    process_metrics, DiagnosticBundle, Metrics, MetricsSnapshot, SpanTimer, METRICS_SCHEMA_VERSION,
};
pub use output::{
    commit_text, format_result, write_result, write_result_to_path, CommitMode, OutputFormat,
    OutputTransaction, SymlinkPolicy, DEFAULT_MAX_OUTPUT_BYTES,
};
pub use partial::{PartialSession, PartialSessionConfig, PartialUpdate};
pub use pcm::PcmBuffer;
pub use postprocess::{normalize_result_with_report, NormalizationReport};
pub use profile::{
    format_recommendation, resolve_profile, ProfileResolution, QualityProfile,
    PROFILE_EVIDENCE_VERSION,
};
pub use providers::{
    LocalWhisperProvider, OpenRouterProvider, OpenRouterSttMode, Segment, TranscriptionOptions,
    TranscriptionProvider, TranscriptionResult,
};
pub use remote::{HardenedHttpClient, RemotePolicy};
pub use runtime::{
    GovernorConfig, Lifecycle, LifecycleState, OpContext, PermitKind, ResourceGovernor,
};
pub use support::{
    build_support_bundle, default_bundle_path, SupportBundle, SUPPORT_BUNDLE_VERSION,
};
pub use window::{PartialClock, PartialWindowPolicy};

#[cfg(feature = "tts")]
pub use tts::{
    format_adapters as format_tts_adapters, format_custom_list as format_tts_custom_list,
    format_inspect as format_tts_inspect, format_model_list as format_tts_model_list,
    format_voice_list as format_tts_voice_list, inspect_pack as inspect_tts_pack,
    list_adapters as list_tts_adapters, list_models as list_tts_models,
    list_voices as list_tts_voices, propose_add_local as propose_tts_add_local,
    resolve_voice_for_model, run_kitten_catalogue_conformance, run_pack_conformance,
    verify_pack as verify_tts_pack, write_add_manifest as write_tts_add_manifest,
    write_wav_i16_mono_atomic, write_wav_i16_mono_transaction, BackendKind as TtsBackendKind,
    LocalTtsProvider, SynthesisOptions, SynthesisProvider, SynthesisResult, TrustMode,
    DEFAULT_TTS_MODEL, DEFAULT_TTS_VOICE, KOKORO_DEFAULT_VOICE, KOKORO_TTS_MODEL,
};