Cainteoir Text-to-Speech Engine
The Cainteoir Text-to-Speech engine is a library that provides text-to-speech functionality for reading and recording different document formats.
In order to build cainteoir-engine, you need:
- a functional autotools system (
- a functional c++ compiler;
- the Python YAML parser library;
- the zlib development libraries;
- the shared mime info package.
Optionally, you need:
- the pulseaudio development library to enable pulseaudio output;
- the alsa development libraries to enable alsa audio output;
- the vorbis encoder development libraries for ogg/vorbis support;
- the espeak development libraries for espeak support;
- the pico development libraries for svox pico support;
- the poppler development libraries for pdf support.
If you want ePub 3.0 Media Overlay support, you need FFmpeg or libav v9 or later, with the following libraries installed:
- libavresample — for converting differently sampled audio files to the one used by the TTS voice.
To build the documentation, you need:
- the kramdown program to build the general documentation;
- the doxygen program to build the api documentation;
- the documentation generator project (https://github.com/rhdunn/documentation-generator).
|shared mime info||
The Cainteoir Engine supports the standard GNU autotools build system. The
source code does not contain the generated
configure files, so to build
it you need to run:
./autogen.sh ./configure --prefix=/usr make
The tests can be run by using:
The program can be installed using:
sudo make install
Source tarballs can be generated by running:
To support building the documentation, you need to inform the build where the documentation-generator project is located. This can be done by:
cd .. git clone git://github.com/rhdunn/documentation-generator.git cd cainteoir-engine ./configure --with-docgen=../documentation-generator
The documentation can be built by running:
Alternatively, just the API documentation can be built by running:
NOTE: You need a recent version of doxygen (such as 1.8.5) that supports C++11 constructs, specifically scoped enumerations.
The following file formats are supported by Cainteoir Text-to-Speech:
Voice Database (
*.vdb) -- This is the compiled format used to define voices used by Cainteoir Text-to-Speech.
Language Database (
*.ldb) -- This is the compiled format used to define languages used by Cainteoir Text-to-Speech.
Report bugs to the cainteoir-engine issues page on GitHub.
The Cainteoir Text-to-Speech Engine is released under the GPL version 3 or later license.
Cainteoir is a registered trademark of Reece Dunn.
W3C is a trademark (registered in numerous countries) of the World Wide Web Consortium; marks of W3C are registered and held by its host institutions MIT, ERCIM, and Keio.
All trademarks are property of their respective owners.