Extension:Phonos

The Phonos extension is a Community Tech project for implementing the IPA Audio Renderer wish from the 2022 Community Wishlist Survey.

Configuration parameters

 * $wgPhonosEngine: Which engine to use. One of  (default), , or.
 * $wgPhonosApiEndpointLarynx: The API endpoint to use for the Larynx engine.
 * $wgPhonosApiEndpointGoogle: The API endpoint to use for the Google engine.
 * $wgPhonosApiKeyGoogle: The API key for the Google engine.
 * $wgPhonosApiProxy: HTTP proxy to use for API requests. If not set, will be used.
 * $wgPhonosFileBackend: Which file backend to use for caching. Defaults to a custom Phonos backend using FSFileBackend.
 * $wgPhonosFileBackendDirectory: Which directory to use for file caching, if $wgPhonosFileBackend is . Defaults to.
 * $wgPhonosEspeak: Path to the eSpeak executable. Defaults to
 * $wgPhonosLame: Path to the Lame executable used for converting WAV to MP3. Defaults to
 * $wgPhonosPath: Relative URL path to where Phonos files are publicly available. Defaults to
 * $wgPhonosWikibaseUrl: The URL to a Wikibase installation, including the and trailing slash.
 * $wgPhonosWikibaseProperties: An object containing the following:
 * wikibasePronunciationAudioProp: Property for pronunciation audio.
 * wikibaseLangNameProp: Property for language of work or name.
 * wikibaseIETFLangTagProp: Property for IETF language tag.


 * $wgPhonosCommonsMediaUrl: URL to Special:FilePath on a shared media repository including the trailing slash.
 * $wgPhonosInlineAudioPlayerMode: Disables IPA rendering and only allows playing of existing audio from Commons

Usage
For all usage information, see the extension's help page.

Maintenance
Phonos does not automatically delete files that have become orphaned. Over time, these files can build up and needlessly occupy space on your file system. To assist with this problem, Phonos offers two maintenance scripts:

countOrphanedFiles.php
This script will count orphaned files. You can pass the  flag to also delete the files.

On wiki farms you can use the  flag to specify which wikis to process, passing in the global IDs (database names). If not provided, the script will loop through all wikis as specified in the sites table, and process any where Phonos is installed. If the sites table is not populated, the script will act only on the current wiki.

deleteOldPhonosFiles.php
This script will delete all Phonos files created before the date specified with the  option. This is useful if you for instance changed the engine, and want to force recreation of Phonos files.

Adding a new TTS engine to Phonos
Phonos was designed to be agnostic to the engine used. The only requirement for TTS engines is that they accept SSML.

Create a new subclass of  and implement the required methods. Note that  returns   by default. If there is a way to programmatically fetch (or even hard code) the list of languages, this method should be overridden in the new subclass.

If the engine doesn't produce output in MP3 format, then Lame should be used to convert the file to MP3, such that  returns only raw MP3 data. That method should also be responsible for persisting the file to disk using.

Metrics and instrumentation
Various metrics are collected and stored in statsv, while errors in Phonos processing are stored with statsd:


 * https://w.wiki/6Zno – production dashboard
 * https://w.wiki/6Znm – beta cluster

The click and replay events are logged by, which can be used to track more things as desired. See T315091 for more details.

On the backend, anything that throws a  during processing will be captured and recorded on the above dashboards. The responsible pages are also categorized in the category "", as specified by the MediaWiki:Phonos-error-category interface page.