espeakng 0.2.0

A safe Rust wrapper around espeakNG via espeakNG-sys.
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

use std::os::unix::prelude::AsRawFd;

use bitflags::bitflags;

use crate::utils::StringFromCPtr;
use crate::{bindings, utils};

#[derive(Clone, Copy)]
pub enum PhonemeGenOptions<'a> {
    /// Generate phonemes using the standard espeak style
    Standard {
        text_mode: TextMode,
        phoneme_mode: PhonemeMode,
    },
    /// Generate phonemes using the mbrola style
    Mbrola,
    /// Generate phonemes using the mbrola style and write them in a file
    MbrolaFile(&'a dyn AsRawFd),
}

#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
#[repr(u32)]
/// Type of character codes
pub enum TextMode {
    /// UTF8 encoding
    #[default]
    Utf8 = 1,
}

bitflags! {
    #[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
    pub struct PhonemeMode: u32 {
        /// include ties (U+361) for phoneme names of more than one letter.
        const IncludeTies = 1;
        /// include zero-width-joiner for phoneme names of more than one letter.
        const IncludeZeroWidthJoiners = 2;
        /// separate phonemes with underscore characters.
        const SeparateWithUnderscores = 4;
    }
}

#[derive(Debug, PartialEq, Eq, Copy, Clone, strum_macros::FromRepr)]
#[repr(u8)]
pub enum Gender {
    Male = 1,
    Female = 2,
}

#[derive(Debug, PartialEq, Eq, Clone)]
pub struct Language {
    pub name: String,
    pub priority: i8,
}

#[derive(Debug, PartialEq, Eq, Clone)]
#[non_exhaustive] // Keep Voice private constructable to keep set_voice safe.
pub struct Voice {
    pub name: String,
    pub filename: String,
    pub languages: Vec<Language>,
    pub gender: Option<Gender>,
    pub age: u8,
}

impl From<bindings::espeak_VOICE> for Voice {
    fn from(voice: bindings::espeak_VOICE) -> Self {
        unsafe {
            Self {
                age: voice.age,
                name: String::from_cptr(voice.name),
                filename: String::from_cptr(voice.identifier),
                gender: Gender::from_repr(voice.gender),
                languages: utils::parse_lang_array(voice.languages),
            }
        }
    }
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[repr(u32)]
pub enum Parameter {
    /// Words per minute. Values must be between 80-450 inclusive.
    Rate = 1,
    /// Volume of speech. Values should be 0-100 as greater values may produce amplitude compression or distortion.
    Volume = 2,
    /// Base pitch, default 50. Values must be between 0-100 inclusive.
    Pitch = 3,
    /// The pitch range, where 0 is monotone and 50 is normal. Values must be between 0-100 inclusive.
    Range = 4,
    /// The punctuation characters to speak. Value must be [PunctationType].
    Punctuation = 5,
    /// How to pronounce capital letters.
    /// - 0 = none
    /// - 1 = sound icon
    /// - 2 = spelling
    /// - 3 or higher, by raising pitch. The value is the amount of Hz by which the pitch of each capitalised word is raised.
    Capitals = 6,
    /// The units of how long to pause between words. At default speed, this is units of of 10mS.
    Wordgap = 7,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[repr(u32)]
pub enum PunctationType {
    None = 0,
    All = 1,
    Some = 2,
}