scribble 0.5.4

High-level Rust API for audio transcription using Whisper
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

//! `scribble` — a small, focused transcription library with a pluggable ASR backend.
//!
//! # Overview
//!
//! Scribble provides a clean, idiomatic Rust API for audio transcription,
//! designed to work equally well in CLI tools and long-running services.
//!
//! At a high level, Scribble wires together:
//! - Media demuxing and audio decoding (via Symphonia)
//! - Audio normalization and resampling (mono, 16 kHz)
//! - Backend inference (built-in Whisper backend available)
//! - Pluggable output encoders (JSON, VTT, etc.)
//!
//! The library emphasizes:
//! - Explicit control flow
//! - Streaming-friendly design
//! - Clear separation of concerns
//! - Minimal surprises for callers
//!
//! Most consumers should start with [`crate::Scribble`].

// ─────────────────────────────────────────────────────────────────────────────
// High-level API
// ─────────────────────────────────────────────────────────────────────────────

mod backend;
mod backends;
mod error;
mod opts;
mod scribble;
mod vad;

// ─────────────────────────────────────────────────────────────────────────────
// Transcription core
// ─────────────────────────────────────────────────────────────────────────────

mod segments;
mod token;

// ─────────────────────────────────────────────────────────────────────────────
// Audio preprocessing pipeline
// ─────────────────────────────────────────────────────────────────────────────

mod audio_pipeline;
mod decode;
mod decoder;
mod demux;
#[cfg(test)]
mod wav;

// ─────────────────────────────────────────────────────────────────────────────
// Output encoding
// ─────────────────────────────────────────────────────────────────────────────

mod json_array_encoder;
mod output_type;
mod segment_encoder;
mod vtt_encoder;

// ─────────────────────────────────────────────────────────────────────────────
// Infrastructure
// ─────────────────────────────────────────────────────────────────────────────

mod logging;

/// Internal adapters used to keep the high-level transcription loop linear and explicit.
pub(crate) mod samples_rx;

pub use crate::backend::{Backend, BackendStream};
pub use crate::backends::whisper::WhisperBackend;
pub use crate::error::{Error, Result};
pub use crate::logging::init as init_logging;
pub use crate::opts::Opts;
pub use crate::output_type::OutputType;
pub use crate::scribble::Scribble;
pub use crate::segment_encoder::SegmentEncoder;
pub use crate::segments::Segment;