pettarin/icarus

icarus is a Sigil plugin to create EPUB 3 Audio-eBooks

icarus

icarus is a Sigil plugin to create EPUB 3 Audio-eBooks

• Version: 0.0.3
• Date: 2016-02-12
• Developer: Alberto Pettarin
• License: the MIT License (MIT)
• Contact: click here

Important: until reaching v1.0.0, this Sigil plugin should be considered experimental. Please report any issues or suggestions, thank you!

Goal

icarus helps creating EPUB 3 Audio-eBooks using Sigil and aeneas.

An EPUB 3 Audio-eBook is an EPUB 3 file with reflowable rendition and audio/text synchronization expressed by EPUB 3 Media Overlays (MO) via SMIL files. For an introduction to EPUB 3 Audio-eBooks, see this tutorial.

Specifically, icarus provides the following three functions (which can be used independently one from another):

1. automatically inserting MO attributes (id and class) into the XHTML files selected by the user;
2. creating a ZIP file which can be read by aeneas or uploaded to aeneasweb.org to compute the SMIL files describing EPUB 3 Media Overlays;
3. importing the SMIL files into the current Sigil eBook.

The final EPUB 3 Audio-eBook file can be then exported using the ePub3-itizer Sigil plugin, v0.3.6 or later.

The main goal of icarus consists in providing regular users with the opportunity of creating EPUB 3 Audio-eBooks with Sigil, leveraging aeneas for the actual computation of timing values in the SMIL files.

Currently Sigil does not have full native support for EPUB 3, but it is actively transitioning from EPUB 2 to EPUB 3, and its plugin mechanism allows the user to export EPUB 3 files, including support for EPUB 3 Media Overlays. When Sigil will have native support for EPUB 3 this plugin might be retired or re-purposed.

Installation

1. Download the icarus Sigil plugin from MobileRead or from the plugin directory
2. Open Sigil
3. Add the icarus plugin (Plugins > Manage Plugins > Add Plugin > select the downloaded ZIP file)

To export to EPUB 3, you will also need to:

1. Download the ePub3-itizer Sigil plugin, v0.3.6 or later, from MobileRead or from source
2. Add it to Sigil as above (Plugins > Manage Plugins > Add Plugin > select the downloaded ZIP file)

Compatibility Chart

As mentioned above, the icarus plugin should be considered a temporary workaround until Sigil implements full Media Overlays native support.

Moreover, the current Sigil 0.9.x series is undergoing a number of deep code/feature changes, and any new version might break this plugin. The same applies to the ePub3-itizer plugin.

Please be sure you are running one of the following supported combinations:

Sigil	icarus	ePub3-itizer
>= 0.9.0 and <= 0.9.2	<= 0.0.2	>= 0.3.4 and <= 0.3.5
>= 0.9.3 and	>= 0.0.3	== 0.3.6

As of 2016-12-08, icarus 0.0.3 has been tested working correctly with Sigil 0.9.7 and ePub3-itizer 0.3.6.

Usage

Please read the tutorial for detailed information about using icarus, including conventions and limitations.

Although the changes done by this plugin to the code of your eBook can be reverted, always save a backup copy of your EPUB file before using this plugin!

1. Open your eBook in Sigil
2. Select the XHTML files with associated audio on the Book Browser panel
3. Plugins > Edit > icarus

Features

• Add MO id and class attributes to user-selected XHTML files.
• Both id and class values are user-selectable (with default values f[0-9]{6} and mo respectively).
• Automatically added MO attributes can be removed.
• Handle pre-existing id attributes.
• Handle pre-existing class attributes.
• The user can specify the list of tags to be processed.
• The user can specify a "no MO" class attribute (with user-selectable value, default nomo) to avoid processing a specific element.
• The user can specify that the MO class should be added only to tags having a pre-existing MO id attribute.
• The (text, audio) file pairs can be detected automatically by matching their file names.
• The user can modify the list of (text, audio) files before exporting the aeneas job ZIP file.
• The exported aeneas job ZIP file can be immediately processed by aeneas or aeneasweb.org.
• The SMIL files computed by aeneas can be imported directly from the ZIP file generated by aeneas.

Limitations and Missing Features

• Identifiers are added to existing tags only. A future release will add <span> tags to support segmenting the text at finer granularity.
• XHTML files and audio files must have a 1:1 correspondence.
• This plugin reads the eBook metadatum dc:language to set the language in the configuration file (config.xml) of the aeneas job ZIP file. The language value is assumed to be the same for all the tasks in the job. If your eBook has multiple languages you will need to manually edit the config.xml file before running aeneas on it.
• No way of specifying the head/tail values of each audio file, which is processed from start to end.
• No way of specifying special aeneas parameters.
• No way of specifying the media narrator metadatum.
• The media active and media playback active classes must be manually added to the book CSS file by the user.

Change log

• 0.0.3 2016-02-12 Update to make the plugin work in Sigil v0.9.3 and later
• 0.0.2 2015-12-29 Added option for adding MO class only to elements with pre-existing MO id attribute
• 0.0.1 2015-12-16 Initial release

(You can download previous versions of the plugin from the plugin/ directory.

License

icarus is released under the MIT License.

The included files compatibility_utils.py, epub_utils.py, and unipath.py are copied from the ePub3-itizer Sigil plugin. See their source code for licensing details.

The audio files in the tutorial/ directory are excerpts from LibriVox public domain recordings.

No copy rights were harmed in the making of this project.

icarus's Issues

Receiving error "Plugin not a valid Sigil plugin"

Check for Windows crazy path stuff (encoding, reserved chars, etc.)

I cannot run it for batch

for example.
It can not add MO when more than 1 text and 1 mp3

Create tests

Add a visible link to the tutorial in the plugin GUI

Suggest somewhere to run with latest Sigil, or at least 0.9.1

Add span elements to fragment inside existing elements

E.g. for sentence- or word- level granularity

Allow the user to specify additional aeneas job parameters

For example, instead of the current text widget, show a proper table with editable text fields and select checkbox, one row for each audio/text pair. Each pair can have head/tail/language values.