Skip to content

Commit 86ba014

Browse files
JarbasAlclaude
andcommitted
docs: rewrite README in Simplified Technical English
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
1 parent 2cf0a62 commit 86ba014

1 file changed

Lines changed: 63 additions & 55 deletions

File tree

README.md

Lines changed: 63 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,70 @@
11
## Description
22

3-
OVOS TTS plugin for [Cotovia TTS](http://gtm.uvigo.es/cotovia)
3+
This is the OVOS TTS plugin for [Cotovia TTS](http://gtm.uvigo.es/cotovia).
44

5-
### About Cotovia
5+
Cotovia is a unit-selection text-to-speech system. It builds the speech signal
6+
by joining prerecorded segments. Cotovia determines the sequence of sounds,
7+
their intonation, and their duration from the input text. It considers several
8+
intonation contours in parallel, and for each one it selects a sequence of
9+
speech units. It picks the final intonation contour based on how well the
10+
selected speech units fit together.
611

7-
Cotovia is a unit-selection text-to-speech system, i.e., generates the synthetic speech signal as a
8-
concatenation of prerecorded segments. Cotovia determines the sequence of sounds, its intonation and
9-
duration from the input text. Actually several intonation contours are considered in parallel and for
10-
each one a sequence of speech units is selected. The final intonation contours is selected according to
11-
the suitability of the sequence of speech units found.
12-
1312
### Voices
1413

15-
At this time two Galician voices are available at sourceforge. These two voices are also suitable for Spanish,
16-
with little distortion, since the phonemes of Spanish may be considered a subset of Galician phonemes. The
17-
nicknames of the two speakers are Iago and Sabela. Nevertheless you will find three voices available for
18-
Cotovia:
14+
Two Galician voices are available on SourceForge. These voices also work for
15+
Spanish, with little distortion, because Spanish phonemes are a subset of
16+
Galician phonemes. The nicknames of the two speakers are Iago and Sabela.
17+
Cotovia offers three voice options:
1918

20-
* iago : Galician male speaker, duration of the recording: 80 minutes. It was Cotovia's first voice and the
21-
quality is limited by the reduced recording time.
22-
23-
* sabela-large : Galician female speaker, duration of the recording: 14.5 hours. Use this voice if you want to
24-
obtain maximum quality speech and you are not too worried about execution time.
25-
26-
* sabela: default speaker. A subset of Sabela's recordings (about 4 hours). A good compromise between quality
27-
and execution time.
28-
19+
* `iago`: a Galician male speaker, with 80 minutes of recording. It was
20+
Cotovia's first voice, so its quality is limited by the short recording
21+
time.
22+
* `sabela-large`: a Galician female speaker, with 14.5 hours of recording. Use
23+
this voice for the highest quality speech when execution time does not
24+
matter.
25+
* `sabela`: the default speaker. It uses a subset of Sabela's recordings
26+
(about 4 hours), which balances quality against execution time.
2927

3028
## Install
3129

32-
Install the plugin
30+
Install the plugin.
3331

34-
`pip install ovos-tts-plugin-cotovia`
32+
```bash
33+
pip install ovos-tts-plugin-cotovia
34+
```
3535

36-
Download and install [Cotovia](https://sourceforge.net/projects/cotovia/files/Debian%20packages/)
36+
Then download and install [Cotovia](https://sourceforge.net/projects/cotovia/files/Debian%20packages/).
3737

38-
#### Debian
38+
### Debian
3939

40-
In order to run Cotovia, you will need to install the following packages:
40+
To run Cotovia, install these packages:
4141

42-
cotovia_0.5_amd64.deb --- Cotovia executable
43-
cotovia-lang-gl_0.5_all.deb --- Galician linguistic data
44-
cotovia-lang-es_0.5_all.deb --- Spanish linguistic data
42+
cotovia_0.5_amd64.deb --- Cotovia executable
43+
cotovia-lang-gl_0.5_all.deb --- Galician linguistic data
44+
cotovia-lang-es_0.5_all.deb --- Spanish linguistic data
4545

46-
Additionally you need to install at least one voice
46+
Also install at least one voice:
4747

4848
cotovia-voice-iago_0.5_all.deb
4949
cotovia-voice-sabela-large_0.5_all.deb
5050
cotovia-voice-sabela_0.5_all.deb
5151

52-
#### Arch
52+
### Arch
5353

54-
arch linux users can find packages converted with 'debtap' in the [releases page](https://github.com/OpenVoiceOS/ovos-tts-plugin-cotovia/releases/tag/0.4.1)
54+
Arch Linux users can find packages converted with `debtap` on the
55+
[releases page](https://github.com/OpenVoiceOS/ovos-tts-plugin-cotovia/releases/tag/0.4.1).
5556

5657
```bash
5758
sudo pacman -U /home/miro/Transferências/cotovia-0.5-1-x86_64.pkg.tar.zst
58-
sudo pacman -U /home/miro/Transferências/cotovia-lang-es-0.5-1-any.pkg.tar.zst
59-
sudo pacman -U /home/miro/Transferências/cotovia-lang-gl-0.5-1-any.pkg.tar.zst
60-
sudo pacman -U /home/miro/Transferências/cotovia-voice-iago-0.5-1-any.pkg.tar.zst
61-
sudo pacman -U /home/miro/Transferências/cotovia-voice-sabela-0.5-1-any.pkg.tar.zst
62-
sudo pacman -U /home/miro/Transferências/cotovia-voice-sabela-large-0.5-1-any.pkg.tar.zst
59+
sudo pacman -U /home/miro/Transferências/cotovia-lang-es-0.5-1-any.pkg.tar.zst
60+
sudo pacman -U /home/miro/Transferências/cotovia-lang-gl-0.5-1-any.pkg.tar.zst
61+
sudo pacman -U /home/miro/Transferências/cotovia-voice-iago-0.5-1-any.pkg.tar.zst
62+
sudo pacman -U /home/miro/Transferências/cotovia-voice-sabela-0.5-1-any.pkg.tar.zst
63+
sudo pacman -U /home/miro/Transferências/cotovia-voice-sabela-large-0.5-1-any.pkg.tar.zst
6364
```
6465

65-
otherwise here is a guide [how to install a .deb package in arch linux](https://www.baeldung.com/linux/arch-install-deb-package)
66+
If you do not use `debtap` packages, see this guide on
67+
[how to install a .deb package in Arch Linux](https://www.baeldung.com/linux/arch-install-deb-package).
6668

6769
## Configuration
6870

@@ -73,18 +75,17 @@ otherwise here is a guide [how to install a .deb package in arch linux](https://
7375
"voice": "iago"
7476
}
7577
}
76-
7778
```
7879

7980
### Advanced config
8081

81-
Additional configuration params are available
82+
You can set these additional parameters:
8283

83-
- `lang` can be `gl` for galician or `es`
84-
- `voice` cab be `iago` or `sabela`
85-
- `pitch_scale_factor` can be used to change pitch (default `100`)
86-
- `time_scale_factor` can be used to change speed (default `100`)
87-
- `bin` can be used to set a path to the executable (default `/usr/bin/cotovia`)
84+
- `lang`: `gl` for Galician or `es` for Spanish.
85+
- `voice`: `iago` or `sabela`.
86+
- `pitch_scale_factor`: changes pitch (default `100`).
87+
- `time_scale_factor`: changes speed (default `100`).
88+
- `bin`: path to the executable (default `/usr/bin/cotovia`).
8889

8990
```json
9091
"tts": {
@@ -96,25 +97,32 @@ Additional configuration params are available
9697
"time_scale_factor": 80,
9798
"bin": "/usr/bin/cotovia"
9899
}
99-
}
100-
100+
}
101101
```
102102

103-
104103
## Docker (ovos-tts-server)
105104

106105
A container image runs the plugin as an
107106
[`ovos-tts-server`](https://github.com/OpenVoiceOS/ovos-tts-server) (ElevenLabs-compatible
108-
API), built and pushed to GHCR by CI on every push to `dev`/`master`:
107+
API). CI builds and pushes this image to GHCR on every push to `dev` or `master`.
109108

110109
```bash
111110
docker run -p 9666:9666 ghcr.io/openvoiceos/ovos-tts-plugin-cotovia:latest
112111
curl "http://localhost:9666/synthesize/ola%20mundo?lang=gl" --output ola.wav
113112
```
114113

115-
The image bundles the cotovia binary (from the wheel) and downloads the Galician
116-
linguistic data plus the `iago` voice from SourceForge at build time (into
117-
`/usr/share/cotovia/data`), so the running container is fully offline. The served
118-
voice/lang are baked in via the `COTOVIA_VOICE` (default `iago`) and `COTOVIA_LANG`
119-
(default `gl-es`) build args; add other voice `.deb` packages to the Dockerfile and
120-
rebuild to serve `sabela`. See the bundled `docker-compose.yml`.
114+
The image bundles the Cotovia binary from the wheel. At build time, it also
115+
downloads the Galician linguistic data and the `iago` voice from SourceForge,
116+
into `/usr/share/cotovia/data`. This makes the running container fully offline.
117+
The build args `COTOVIA_VOICE` (default `iago`) and `COTOVIA_LANG` (default
118+
`gl-es`) bake the served voice and language into the image. To serve `sabela`,
119+
add its `.deb` package to the Dockerfile and rebuild. See the bundled
120+
`docker-compose.yml` for an example.
121+
122+
## Related projects
123+
124+
- [OpenVoiceOS/ovos-tts-server](https://github.com/OpenVoiceOS/ovos-tts-server) — serves this plugin over an ElevenLabs-compatible HTTP API.
125+
126+
## License
127+
128+
Apache-2.0. See [LICENSE](LICENSE).

0 commit comments

Comments
 (0)