msedge-tts 0.3.0

This library is a wrapper of MSEdge Read aloud function API. You can use it to synthesize text to speech with many voices MS provided.
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

//! Voice Type and Get function
//!
//! Use [get_voices_list] function to get all available voices.  
//! Use [get_voices_list_async] function to get all available voices asynchronously.  
//! Use [get_voices_list_proxy] function to get all available voices with proxy.  
//! Use [get_voices_list_proxy_async] function to get all available voices with proxy asynchronously.

use crate::{constants, error::Result};
use isahc::{config::Configurable, AsyncReadResponseExt, ReadResponseExt, RequestExt};

/// Voice category tags and personalities tags
#[derive(Debug, Clone, serde::Deserialize, serde::Serialize)]
pub struct VoiceTag {
    #[serde(rename = "ContentCategories")]
    pub content_categories: Option<Vec<String>>,
    #[serde(rename = "VoicePersonalities")]
    pub voice_personalities: Option<Vec<String>>,
}

/// Voice get from MS Edge Read aloud API.
#[derive(Debug, Clone, serde::Deserialize, serde::Serialize)]
pub struct Voice {
    #[serde(rename = "Name")]
    pub name: String,
    #[serde(rename = "ShortName")]
    pub short_name: Option<String>,
    #[serde(rename = "Gender")]
    pub gender: Option<String>,
    #[serde(rename = "Locale")]
    pub locale: Option<String>,
    #[serde(rename = "SuggestedCodec")]
    pub suggested_codec: Option<String>,
    #[serde(rename = "FriendlyName")]
    pub friendly_name: Option<String>,
    #[serde(rename = "Status")]
    pub status: Option<String>,
    #[serde(rename = "VoiceTag")]
    pub voice_tag: Option<VoiceTag>,
}

impl From<String> for Voice {
    fn from(voice_name: String) -> Self {
        Self {
            name: voice_name,
            short_name: None,
            gender: None,
            locale: None,
            suggested_codec: None,
            friendly_name: None,
            status: None,
            voice_tag: None,
        }
    }
}

impl From<&str> for Voice {
    fn from(voice_name: &str) -> Self {
        voice_name.to_string().into()
    }
}

/// Get all available voices
pub fn get_voices_list() -> Result<Vec<Voice>> {
    Ok(build_request(None, None, None)
        .map_err(isahc::Error::from)?
        .send()?
        .json()?)
}

/// Get all available voices with proxy.
///
/// **docs copy from isahc**  
/// Set a proxy to use for requests.
/// The proxy protocol is specified by the URI scheme.
///
/// `http`: Proxy. Default when no scheme is specified.  
/// `https`: HTTPS Proxy. (Added in 7.52.0 for OpenSSL, GnuTLS and NSS)  
/// `socks4`: SOCKS4 Proxy.  
/// `socks4a`: SOCKS4a Proxy. Proxy resolves URL hostname.  
/// `socks5`: SOCKS5 Proxy.  
/// `socks5h`: SOCKS5 Proxy. Proxy resolves URL hostname.  
pub fn get_voices_list_proxy(
    proxy: isahc::http::Uri,
    username: Option<&str>,
    password: Option<&str>,
) -> Result<Vec<Voice>> {
    Ok(build_request(Some(proxy), username, password)
        .map_err(isahc::Error::from)?
        .send()?
        .json()?)
}

/// Get all available voices asynchronously
pub async fn get_voices_list_async() -> Result<Vec<Voice>> {
    Ok(build_request(None, None, None)
        .map_err(isahc::Error::from)?
        .send_async()
        .await?
        .json()
        .await?)
}

/// Get all available voices asynchronously with proxy.
///
/// **docs copy from isahc**  
/// Set a proxy to use for requests.
/// The proxy protocol is specified by the URI scheme.
///
/// `http`: Proxy. Default when no scheme is specified.  
/// `https`: HTTPS Proxy. (Added in 7.52.0 for OpenSSL, GnuTLS and NSS)  
/// `socks4`: SOCKS4 Proxy.  
/// `socks4a`: SOCKS4a Proxy. Proxy resolves URL hostname.  
/// `socks5`: SOCKS5 Proxy.  
/// `socks5h`: SOCKS5 Proxy. Proxy resolves URL hostname.  
pub async fn get_voices_list_proxy_async(
    proxy: isahc::http::Uri,
    username: Option<&str>,
    password: Option<&str>,
) -> Result<Vec<Voice>> {
    Ok(build_request(Some(proxy), username, password)
        .map_err(isahc::Error::from)?
        .send_async()
        .await?
        .json()
        .await?)
}

fn build_request(
    proxy: Option<isahc::http::Uri>,
    username: Option<&str>,
    password: Option<&str>,
) -> std::result::Result<isahc::Request<()>, isahc::http::Error> {
    let mut builder = isahc::Request::get(constants::VOICE_LIST_URL)
        .header("Sec-CH-UA", constants::SEC_CH_UA)
        .header("Sec-CH-UA-Mobile", constants::SEC_CH_UA_MOBILE)
        .header("User-Agent", constants::USER_AGENT)
        .header("Sec-CH-UA-Platform", constants::SEC_CH_UA_PLATFORM)
        .header("Sec-Fetch-Site", constants::SEC_FETCH_SITE)
        .header("Sec-Fetch-Mode", constants::SEC_FETCH_MODE)
        .header("Sec-Fetch-Dest", constants::SEC_FETCH_DEST);

    if proxy.is_some() {
        builder = builder.proxy(proxy);
        if username.is_some() && password.is_some() {
            builder = builder.proxy_authentication(isahc::auth::Authentication::basic());
            builder = builder.proxy_credentials(isahc::auth::Credentials::new(
                username.unwrap(),
                password.unwrap(),
            ));
        }
    }

    builder.body(())
}