Audiobook alignment for Indigenous languages!
This library is an end-to-end audio/text aligner. It is meant to be used together with the ReadAlong-Web-Component to interactively visualize the alignment.
Note: additional draft documentation is available here
The concept is a web application with a series of stages of processing, which ultimately leads to a time-aligned audiobook - i.e. a package of:
- SMIL file describing time alignments
- TEI file describing text
- Audio file (WAV or MP3)
Which can be loaded using the read-along web component. See also Studio Output Realizations.
Optionally a book can be generated as a standalone HTML page or as an ePub file.
- (optional) Pre-segment inputs, consisting of:
- Single audio file
- Text with page markings (assume paragraph breaks = pages)
- Input pages: each page consists of
- Image file
- Audio file
- Text
- Run alignment
- View output and download components
To install the latest version published to PyPI, you can run a standard pip
installation: pip install readalongs.
To install the current development version, clone the repo and pip install it locally:
$ git clone https://github.com/ReadAlongs/Studio.git
$ cd Studio
$ pip install -e .If you don't already have it, you will also need FFmpeg.
- Windows: FFmpeg builds for Windows (helpful instructions)
- Mac:
brew install ffmpeg - Linux:
<your package manager> install ffmpeg
On Windows, you might also need Visual Studio Build Tools (search for "Build Tools", select C++ when prompted) and swigwin.
(TODO: verify whether these are still needed now that soundswallower has replaced pocketsphinx.)
ReadAlong-Studio can be used either through the command line, a distributed web application or Docker.
Below shows some basic commands. For more information about how the command line interface works, please check this incomplete documentation and this draft documentation [TODO: complete and fix all this documentation!]. Additionally, you can add the --help flag to any command for more information.
Basic alignment is done with the following command.
readalongs align TEXTFILE WAVFILE OUTPUTNAME
In order to generate an ePub, there are two steps:
readalongs align --output-xhtml TEXTFILE WAVFILE OUTPUTNAMEreadalongs epub OUTPUTNAME.smil OUTPUTNAME.epub
ReadAlong-Studio has a web interface for creating interactive audiobooks. The web app can be served by first installing ReadAlong-Studio and then running readalongs run. A web app will then be available on port 5000.
If you are having trouble installing the package, you can also clone the repo and run the studio using Docker.
Working with in a Docker container has the advantage that no matter what your OS is, and what you have installed or configured, you will run on the standard ReadAlong-Studio configuration.
To build the Docker image, run:
docker build . --tag=readalong-studio
To run the Flask web app in a Docker container using that image:
docker run -p 5000:5000 -it readalong-studio
To run the Flask web app with real-time update:
docker run -p 5000:5000 -it -v $(pwd):/opt/readalong-studio readalong-studio
Then you should be able to visit http://localhost:5000/.
To run the interactive shell with real-time update:
docker run -p 5000:5000 -it -v $(pwd):/opt/readalong-studio readalong-studio sh
To run an interactive bash shell, using your local user inside Docker:
docker run -p 5000:5000 -it -v $(pwd):/opt/readalong-studio -u $(id -u):$(id -g) readalong-studio bash
@dhdaines. @littell. @roedoejet. @joanise.
Feel free to dive in! Open an issue or submit PRs.
This repo follows the Contributor Covenant Code of Conduct.
Have a look at Contributing.md for help getting started.
This project exists thanks to all the people who contribute.
@dhdaines. @eddieantonio. @finguist. @joanise. @littell. @roedoejet.
MIT © David Huggins-Daines, National Research Council Canada