a light weight connector for espeak-ng and speakup
  • C 96.6%
  • Meson 3.4%
Find a file
donovanmalisch23-alt f266faaff7 espeak: escape XML-special characters in single-character mode
When speakup echoes a single character, espeakup wraps it in SSML:

    <say-as interpret-as="characters">%c</say-as>

If the character is one of XML's five special characters (< > & ' "),
the raw byte is injected straight into the markup, producing ill-formed
SSML.  espeak-ng then misparses the <say-as> element, which surfaces as
a spurious high-pitched "ringing" whenever one of these characters is
spoken.

Escape each special character to its corresponding XML entity
(&lt; &gt; &amp; &apos; &quot;) so the markup stays well-formed.
Non-printable characters (< 0x20 or > 0x7e) are no longer wrapped in
SSML either; they fall through to the existing raw-synthesis fallback
so they cannot corrupt the surrounding element either.

The space and ordinary-printable-character paths are unchanged.
2026-08-03 20:52:35 +02:00
doc format build files consistently 2021-07-03 03:53:58 +03:00
services services: add fallback systemd unitdir if systemd is not available 2026-06-29 18:55:16 +02:00
src espeak: escape XML-special characters in single-character mode 2026-08-03 20:52:35 +02:00
.clang-format use clang-format for code styling 2021-06-19 01:57:49 -05:00
.gitignore switch to meson (#30) 2021-06-18 21:53:04 -05:00
.indent.pro added .indent.pro to the repository 2009-05-30 00:20:31 -05:00
COPYING added gpl 2008-08-01 21:46:54 -05:00
meson.build meson: switch from deprecated functions (#49) 2022-03-11 14:51:28 +01:00
meson_options.txt format build files consistently 2021-07-03 03:53:58 +03:00
README.md Fix deprecated Meson setup command warning in README (#61) 2025-08-22 14:12:32 +03:00

espeakup connector

espeakup is a program which makes it possible for speakup to use the espeak-ng software synthesizer. It does this by reading speakup's softsynth device and passing the text to espeak-ng which actually speaks.

Requirements

This program works with the speakup screen reader, which can be obtained from http://linux-speakup.org, and the espeak-ng software speech synthesizer.

You must have both of these installed and operational. Setting them up is beyond the scope of this document.

Installation

The preferred way to install espeakup is using your distribution's packaging system, but if your distribution does not have a package for espeakup yet, espeakup just uses meson, so you should be able to change to the source directory, then type:

meson setup . ./build
cd ./build
ninja
sudo ninja install

Starting Up

This program should be run after speakup is set up to communicate with a software synthesizer and after /dev/softsynth exists. The way this is done is distribution specific, so it is beyond the scope of this documentation.

Acknowledgements

I would like to thank Marc Mulcahy, the author of the speakup to TTSynth connector, on which this work is based. Also, I would like to thank Kirk Reiser and Jonathan Duddington, the authors of Speakup and Espeak, respectively, for their work.

Filing Bugs

Bugs should be filed on our bug tracker at https://github.com/linux-speakup/issues.