:speaking_head: aspeak

A simple text-to-speech client for Azure TTS API. :laughing:

You can try the Azure TTS API online: https://azure.microsoft.com/en-us/services/cognitive-services/text-to-speech

Note

Starting from version 4.0.0, aspeak is rewritten in rust. The old python version is available at the python branch.

Please note that the rust rewritten version is experimental and might have bugs!

Installation

Download from GitHub Releases

Download the latest release from here.

After downloading, extract the archive and you will get a binary executable file.

You can put it in a directory that is in your PATH environment variable so that you can run it from anywhere.

Install from PyPI

Installing from PyPI will also install the python binding of aspeak for you. Check Library Usage#Python for more information on using the python binding.

bash pip install -U aspeak

Now the prebuilt wheels are only available for x86_64 architecture. Due to some technical issues, I haven't uploaded the source distribution to PyPI yet. So to build wheel from source, you need to follow the instructions in Install from Source.

Because of manylinux compatibility issues, the wheels for linux are not available on PyPI. (But you can still build them from source.)

Install from Source

CLI Only

The easiest way to install aspeak is to use cargo:

bash cargo install aspeak

Python Wheel

To build the python wheel, you need to install maturin first:

bash pip install maturin

After cloning the repository and cd into the directory , you can build the wheel by running:

bash maturin build --release --strip -F python --bindings pyo3 --interpreter python --manifest-path Cargo.toml --out dist-pyo3 maturin build --release --strip --bindings bin --interpreter python --manifest-path Cargo.toml --out dist-bin bash merge-wheel.bash

If everything goes well, you will get a wheel file in the dist directory.

Usage

Run aspeak help to see the help message.

Run aspeak help <subcommand> to see the help message of a subcommand.

Configuration

You can configure aspeak by creating a profile. Run the following command to create a profile:

sh $ aspeak config init

To edit the profile, run:

sh $ aspeak config edit

If you have trouble running the above command, you can edit the profile manually:

Fist get the path of the profile by running:

sh $ aspeak config where

Then edit the file with your favorite text editor.

The profile is a TOML file. The default profile looks like this:

Check the comments in the config file for more information about available options.

```toml

Profile for aspeak

GitHub: https://github.com/kxxt/aspeak

Output verbosity

0 - Default

1 - Verbose

The following output verbosity levels are only supported on debug build

2 - Debug

>=3 - Trace

verbosity = 0

#

Authentication configuration

#

[auth]

Endpoint for TTS

endpoint = "wss://eastus.api.speech.microsoft.com/cognitiveservices/websocket/v1"

Alternatively, you can specify the region if you are using official endpoints

region = "eastus"

Azure Subscription Key

key = "YOUR_KEY"

Authentication Token

token = "Your Authentication Token"

Extra http headers (for experts)

headers = [["X-My-Header", "My-Value"], ["X-My-Header2: My-Value2"]]

#

Configuration for text subcommand

#

[text]

Voice to use. Note that it takes precedence over the locale

voice = "en-US-JennyNeural"

Locale to use

locale = "en-US"

Rate

rate = 0

Pitch

pitch = 0

Role

role = "Boy"

Style, "general" by default

style = "general"

Style degree, a floating-point number between 0.1 and 2.0

style_degree = 1.0

#

Output Configuration

#

[output]

Container Format, Only wav/mp3/ogg/webm is supported.

container = "wav"

Audio Quality. Run aspeak list-qualities to see available qualities.

#

If you choose a container format that does not support the quality level you specified here,

we will automatically select the closest level for you.

quality = 0

Audio Format(for experts). Run aspeak list-formats to see available formats.

Note that it takes precedence over container and quality!

format = "audio-16khz-128kbitrate-mono-mp4"

```

Examples

Speak "Hello, world!" to default speaker.

sh $ aspeak text "Hello, world"

SSML to Speech

sh $ aspeak ssml << EOF <speak version='1.0' xmlns='http://www.w3.org/2001/10/synthesis' xml:lang='en-US'><voice name='en-US-JennyNeural'>Hello, world!</voice></speak> EOF

List all available voices.

sh $ aspeak list-voices

List all available voices for Chinese.

sh $ aspeak list-voices -l zh-CN

Get information about a voice.

sh $ aspeak list-voices -v en-US-SaraNeural

Save synthesized speech to a file.

sh $ aspeak text "Hello, world" -o output.wav

If you prefer mp3/ogg/webm, you can use -c mp3/-c ogg/-c webm option.

sh $ aspeak text "Hello, world" -o output.mp3 -c mp3 $ aspeak text "Hello, world" -o output.ogg -c ogg $ aspeak text "Hello, world" -o output.webm -c webm

List available quality levels

sh $ aspeak list-qualities

List available audio formats (For expert users)

sh $ aspeak list-formats

Increase/Decrease audio qualities

```sh

Less than default quality.

$ aspeak text "Hello, world" -o output.mp3 -c mp3 -q=-1

Best quality for mp3

$ aspeak text "Hello, world" -o output.mp3 -c mp3 -q=3 ```

Read text from file and speak it.

sh $ cat input.txt | aspeak text

or

sh $ aspeak text -f input.txt

with custom encoding:

sh $ aspeak text -f input.txt -e gbk

Read from stdin and speak it.

sh $ aspeak text

maybe you prefer:

sh $ aspeak text -l zh-CN << EOF 我能吞下玻璃而不伤身体。 EOF

Speak Chinese.

sh $ aspeak text "你好，世界！" -l zh-CN

Use a custom voice.

sh $ aspeak text "你好，世界！" -v zh-CN-YunjianNeural

Custom pitch, rate and style

sh $ aspeak text "你好，世界！" -v zh-CN-XiaoxiaoNeural -p 1.5 -r 0.5 -S sad $ aspeak text "你好，世界！" -v zh-CN-XiaoxiaoNeural -p=-10% -r=+5% -S cheerful $ aspeak text "你好，世界！" -v zh-CN-XiaoxiaoNeural -p=+40Hz -r=1.2f -S fearful $ aspeak text "你好，世界！" -v zh-CN-XiaoxiaoNeural -p=high -r=x-slow -S calm $ aspeak text "你好，世界！" -v zh-CN-XiaoxiaoNeural -p=+1st -r=-7% -S lyrical

Advanced Usage

Use a custom audio format for output

Note: Some audio formats are not supported when you are outputting to speaker.

sh $ aspeak text "Hello World" -F riff-48khz-16bit-mono-pcm -o high-quality.wav

Library Usage

Python

The new version of aspeak is written in Rust, and the Python binding is provided by PyO3.

Here is a simple example:

```python from aspeak import SpeechService, AudioFormat

service = SpeechService() service.connect() service.speak_text("Hello, world") ```

Rust

Add aspeak to your Cargo.toml:

bash $ cargo add aspeak

Then follow the documentation of aspeak crate.