aria-kit 0.7.0

Audio capture, transcription, synthesis, and voice-analysis contracts for local speech apps
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

//! What every engine backend shares, whichever capability it serves: the
//! boxed shape of its own failures, the files its model downloads as, and
//! validation of the model files it loads. Each capability wraps these in
//! its own error vocabulary.

#[cfg(not(target_family = "wasm"))]
mod model_path;

use std::path::PathBuf;

#[cfg(not(target_family = "wasm"))]
pub use model_path::{validate_model_directory, validate_model_file};

/// One file of an engine's model and where to download it.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct ModelDownload {
    /// The file's name on disk, inside whatever folder holds the model.
    pub file_name: &'static str,
    pub url: &'static str,
    /// Size of what `url` serves. For an archive member, the whole archive.
    pub bytes: u64,
    /// SHA-256 of what `url` serves, in lowercase hex.
    pub sha256: &'static str,
    pub unpack: Unpack,
}

/// How the file comes out of what `url` serves.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Unpack {
    /// `url` serves the file itself.
    Plain,
    /// `url` serves a `.tar.bz2` archive holding the file at this path.
    TarBz2Member(&'static str),
}

// The engine's own error stays boxed rather than named. Which engine failed is
// already on the capability error, and naming the types here would put every
// engine crate's version in Aria's public API.
#[derive(Debug, thiserror::Error)]
pub enum BackendError {
    #[error(transparent)]
    Engine(Box<dyn std::error::Error + Send + Sync>),

    #[error("the backend answered, but the answer is unusable: {0}")]
    Unusable(String),
}

impl BackendError {
    pub fn engine(error: impl std::error::Error + Send + Sync + 'static) -> Self {
        Self::Engine(Box::new(error))
    }
}

#[derive(Debug, thiserror::Error)]
pub enum ModelError {
    #[cfg(not(target_family = "wasm"))]
    #[error(transparent)]
    Path(#[from] crate::primitives::file_inspection::InspectionError),

    #[error("failed to read the model directory {}", path.display())]
    ReadDirectory {
        path: PathBuf,
        #[source]
        source: std::io::Error,
    },

    #[error("model directory {} is missing {file}", directory.display())]
    Missing {
        directory: PathBuf,
        file: &'static str,
    },

    #[error("failed to read the model file {}", path.display())]
    Unreadable {
        path: PathBuf,
        #[source]
        source: std::io::Error,
    },

    #[error("the model file {} is malformed", path.display())]
    Malformed {
        path: PathBuf,
        #[source]
        source: Box<dyn std::error::Error + Send + Sync>,
    },
}