A fast local neural text to speech engine for Mycroft
Find a file
2022-09-22 18:06:27 -06:00
debian Fix debian scripts 2022-05-03 11:51:22 -04:00
docker Merge mimic3-client into main CLI 2022-04-11 14:50:48 -04:00
examples Extend speech dispatcher configuration file 2022-07-19 10:37:43 +02:00
img Update hero image in README 2022-05-06 18:15:39 -04:00
mimic3_http Skip voices that aren't installed yet in MaryTTS /voices endpoint 2022-07-05 10:03:30 -05:00
mimic3_tts Fix utterance boundary logic 2022-07-26 15:53:35 -05:00
opentts_abc Restore previous speaking rate in SSML 2022-05-10 13:33:27 -04:00
pyinstaller Merge mimic3-client into main CLI 2022-04-11 14:50:48 -04:00
scripts Missing assets are an error 2022-05-05 16:28:21 -04:00
tests Build plugin dist 2022-04-29 11:46:12 -04:00
voices Keep specific directories 2022-04-27 12:02:17 -04:00
wheels Keep specific directories 2022-04-27 12:02:17 -04:00
.gitignore Bump version 2022-05-04 19:03:33 -04:00
.isort.cfg Add script to generate deterministic samples and hashes 2022-04-20 11:43:15 -04:00
.projectile Initial commit 2022-03-16 17:22:15 -04:00
build-dist.sh Refactor into a single package 2022-05-02 15:24:43 -04:00
check.sh Refactor into a single package 2022-05-02 15:24:43 -04:00
Dockerfile Show debug for voice download in Docker builds 2022-05-04 14:30:38 -04:00
Dockerfile.debian Include libespeak so in PyInstaller build 2022-06-28 21:30:38 -04:00
Dockerfile.debian.dockerignore Refactor into a single package 2022-05-02 15:24:43 -04:00
Dockerfile.dist Show debug for voice download in Docker builds 2022-05-04 14:30:38 -04:00
Dockerfile.dist.dockerignore Refactor into a single package 2022-05-02 15:24:43 -04:00
Dockerfile.dockerignore Refactor into a single package 2022-05-02 15:24:43 -04:00
Dockerfile.gpu fix typo in Dockerfile.gpu 2022-07-17 05:16:39 +01:00
Dockerfile.gpu.dockerignore Refactor into a single package 2022-05-02 15:24:43 -04:00
Dockerfile.plugin Temporarily disable plugin test 2022-05-05 19:03:40 -04:00
Dockerfile.plugin.dockerignore Fix ignore for plugin build 2022-05-02 15:34:01 -04:00
Dockerfile.sample Show debug for voice download in Docker builds 2022-05-04 14:30:38 -04:00
Dockerfile.sample.dockerignore Refactor into a single package 2022-05-02 15:24:43 -04:00
install.sh Refactor into a single package 2022-05-02 15:24:43 -04:00
Jenkinsfile Need to build Debian packages first 2022-06-28 23:19:01 -04:00
LICENSE Fix license 2022-03-25 16:57:31 -04:00
Makefile Fix Makefile 2022-06-29 17:02:46 -04:00
MANIFEST.in Refactor into a single package 2022-05-02 15:24:43 -04:00
mypy.ini Refactor into a single package 2022-05-02 15:24:43 -04:00
pylintrc Add script to generate deterministic samples and hashes 2022-04-20 11:43:15 -04:00
README.md Update README.md 2022-07-02 08:58:34 -05:00
requirements.txt Update requirements.txt 2022-09-22 18:06:27 -06:00
requirements_dev.txt Working single-file binary build 2022-03-30 17:08:56 -04:00
setup.cfg Refactor into a single package 2022-05-02 15:24:43 -04:00
setup.py Explicitly include HTTP server files 2022-05-06 17:29:34 -04:00
test.sh Set no download option for test 2022-04-25 19:04:00 -04:00

Mimic 3

mimic 3 mark 2

A fast and local neural text to speech system developed by Mycroft for the Mark II.

Quickstart

Mycroft TTS Plugin

# Install system packages
sudo apt-get install libespeak-ng1

# Ensure that you're using the latest pip
mycroft-pip install --upgrade pip

# Install plugin
mycroft-pip install mycroft-plugin-tts-mimic3[all]

# Activate plugin
mycroft-config set tts.module mimic3_tts_plug

# Start mycroft
mycroft-start all

See documentation for more details.

Web Server

mkdir -p "${HOME}/.local/share/mycroft/mimic3"
chmod a+rwx "${HOME}/.local/share/mycroft/mimic3"
docker run \
       -it \
       -p 59125:59125 \
       -v "${HOME}/.local/share/mycroft/mimic3:/home/mimic3/.local/share/mycroft/mimic3" \
       'mycroftai/mimic3'

Visit http://localhost:59125 or from another terminal:

curl -X POST --data 'Hello world.' --output - localhost:59125/api/tts | aplay

See documentation for more details.

Command-Line Tool

# Install system packages
sudo apt-get install libespeak-ng1

# Create virtual environment
python3 -m venv .venv
source .venv/bin/activate
pip3 install --upgrade pip

pip3 install mycroft-mimic3-tts[all]

Now you can run:

mimic3 'Hello world.' | aplay

Use mimic3-server and mimic3 --remote ... for repeated usage (much faster).

See documentation for more details.


License

Mimic 3 is available under the AGPL v3 license