https://github.com/sztheory/espeak
[wip] Crystal wrapper for ‘espeak’ and ‘lame’ with sugar on top to create Text-To-Speech mp3 files
https://github.com/sztheory/espeak
crystal espeak lame mp3 shard text-to-speech tts wrapper
Last synced: 8 months ago
JSON representation
[wip] Crystal wrapper for ‘espeak’ and ‘lame’ with sugar on top to create Text-To-Speech mp3 files
- Host: GitHub
- URL: https://github.com/sztheory/espeak
- Owner: szTheory
- License: mit
- Created: 2019-09-17T21:25:52.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-09-18T04:29:33.000Z (about 6 years ago)
- Last Synced: 2025-02-16T00:56:18.321Z (8 months ago)
- Topics: crystal, espeak, lame, mp3, shard, text-to-speech, tts, wrapper
- Language: Crystal
- Homepage:
- Size: 9.77 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# espeak
espeak is a small Crystal API for utilizing [espeak](http://espeak.sourceforge.net) and [lame](http://lame.sourceforge.net/) to create Text-To-Speech mp3 files. It can also just speak (without saving). Port of the [espeak-ruby gem](https://github.com/dejan/espeak-ruby).
## Installation
1. Add the dependency to your `shard.yml`:
```yaml
dependencies:
espeak:
github: szTheory/espeak
```
2. Run `shards install`
## Usage
```crystal
require "espeak"
```
## Examples
```crystal
# Speaks "YO!"
speech = Espeak::Speech.new("YO!")
speech.speak # invokes espeak
# Creates hello-de.mp3 file
speech = Espeak::Speech.new("Hallo Welt", voice: "de")
speech.save("hello-de.mp3") # invokes espeak + lame
# Lists voices
Espeak::Voice.all.map { |v| v.language } # ["af", "bs", "ca", "cs", "cy", "da", "de", "el", "en", "en-sc", "en-uk", "en-uk-north", "en-uk-rp", "en-uk-wmids", "en-us", "en-wi", "eo", "es", "es-la", "fi", "fr", "fr-be", "grc", "hi", "hr", "hu", "hy", "hy", "id", "is", "it", "jbo", "ka", "kn", "ku", "la", "lv", "mk", "ml", "nci", "nl", "no", "pap", "pl", "pt", "pt-pt", "ro", "ru", "sk", "sq", "sr", "sv", "sw", "ta", "tr", "vi", "zh", "zh-yue"]
# Find particular voice
Espeak::Voice.find_by_language('en') #
```
## Features
Currently only subset of espeak features is supported.
```crystal
voice: 'en', # use voice file of this name from espeak-data/voices
pitch: 50, # pitch adjustment, 0 to 99
speed: 170, # speed in words per minute, 80 to 370
capital: 170, # increase emphasis (pitch) of capitalized words, 1 to 40 (for natural sound, can go higher)
```
These are default values, and they can be easily overridden:
```crystal
Speech.new("Zdravo svete", voice: "sr", pitch: 90, speed: 200).speak
```
## Installing dependencies
### OS X
brew install espeak lame
### Ubuntu
apt-get install espeak lame
## Related
* [espeak-ruby](http://github.com/dejan/espeak-ruby) - original Ruby gem that this Crystal version was ported from
* [espeak-http](http://github.com/dejan/espeak-http) - Micro web app for Text-To-Speech conversion via HTTP powered by Ruby, Sinatra, lame, espeak and espeak-ruby
## Licence
espeak is released under the [MIT License](/MIT-LICENSE).
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## Contributors
- [szTheory](https://github.com/szTheory) - creator and maintainer
- [dejan](https://github.com/dejan/) - creator of the original [espeak-ruby](https://github.com/dejan/espeak-ruby)