Git
[?]:
The TimedMediaHandler extension allows you to display audio and video files in wiki pages, using the same syntax as for image files. It includes the VideoJS Player. It has support for subtitles and captions (aka Timed Text), real-time stream switching between multiple WebM and other derivatives, and many other features. TMH server-side support includes options for uploading HTML5 audio and video, multiple transcode profiles to deliver content, playback of MIDI files, metadata parsing for Ogg and WebM videos, and integration with MediaWiki's job queue system for scheduling transcoding jobs.
For new and upcoming developments in 2022 and beyond, see Extension:TimedMediaHandler/2022 work.
For the player see: VideoJS Player.
For features of the subtitling system, see Commons:Timed Text page.
In addition to the image embed syntax, Timed Media Handler supports:
<gallery>File:Video.ogv</gallery>
end=1:30
which would result in a clip of 5 seconds playing from 1:25 to 1:30. If thumbtime is not provided, the start time will be used for the displayed thumbnail. One can also use HH:MM:SS, e.g. 1:02:22 will be 1 hour, 2 minutes, and 22 seconds into the video.
start=
and end=
can also be used as query parameters in the URL for a video's file page.
[[File:Big Buck Bunny 4K.webm|300px|thumb|...]] [[File:example.ogg|thumb|...]] [[File:example.ogg|30px]] [[File:example.ogg]]
The player works on most modern browsers (see MediaWiki's support matrix). Mobile support is spotty, especially on iOS.
TimedMediaHandler includes a JavaScript compatibility shim for Ogg audio/video that works in Safari, Internet Explorer 10/11, and Microsoft Edge browsers.
Third-party users of MediaWiki may also wish to manually enable MP4 H.264/AAC support for native video and audio playback in Safari/IE/Edge, but when using these formats, you may need a patent license from MPEG-LA for internet broadcasting.
You will want a recent version of ffmpeg in order to support encoding to WebM (with the latest version of VP9).
TimedMediaHandler
folder to your extensions/
directory.cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/TimedMediaHandler
composer install --no-dev
in the extension directory. (See T173141 for potential complications.)wfLoadExtension( 'TimedMediaHandler' ); $wgFFmpegLocation = '/usr/bin/ffmpeg'; // Most common ffmpeg path on Linux
The extension will automatically add supported file types (except for mp4) to $wgFileExtensions , so you do not need to add video file types manually.
After downloading this extension, please note that it requires
Composer.
So, after installation change to the directory containing the extension e.g., "../extensions/TimedMediaHandler/" and run composer install --no-dev
, or when updating: composer update --no-dev
.
Alternatively, as well as preferably, add the line "extensions/TimedMediaHandler/composer.json"
to the "composer.local.json" file in the root directory of your wiki e.g.
{ "extra": { "merge-plugin": { "include": [ "extensions/TimedMediaHandler/composer.json" ] } } }Comparison of Wikipedia media encoding options[edit]
As of 2018, Wikimedia sites use VP9.
Sorted by bandwidth tier:
Bitrate Mbit/s WebM VP8 WebM VP9 Super Low 0.08 160p Very Low 0.16 160p 240p Low 0.25 240p 360p Moderate 0.5 360p 480p Medium 1.0 480p 720p High 2.0 720p 1080p Very high 4.0 1080p 1440p Super high 8.0 2160pDetailed options:
Name 160P 240P 360P 480P 720P 1080P 160P 240P 360P 480P 720P 1080P 1440P 2160P Container WebM Video Encoding VP8 VP9 Max width (pixels) 288 426 640 854 1280 1920 288 426 640 854 1280 1920 2560 4096 Max height (pixels) 160 240 360 480 720 1080 160 240 360 480 720 1080 1440 2160 Bitrate (Mbit/s) 0.16 0.25 0.5 1.0 2.0 4.0 0.08 0.16 0.25 0.5 1.0 2.0 4.0 8.0 Audio Encoding Vorbis Opus Channels 2 (stereo) (pass-through) Sampling rate (Hz) 44100 48000 Quality - 1 2 3 - (default)This page is
outdated.
It was written for an older version of MediaWiki and may not apply to the most recent version. If you have checked or updated this page and found the content to be suitable, please remove this notice. See the
talk pagefor a possible discussion on this.
This section is out of date -- please update me
Here are some configuration variables that may be useful:
// The minimum size for an embedded video player (smaller than this size uses a pop-up player). $wgMinimumVideoPlayerSize = 200; // If transcoding is enabled for this wiki (if disabled, no transcode jobs are added, and no transcode status is displayed). // Note: if remote embedding an asset, we will still check if the remote repo has transcoding enabled and associated flavors // for that media embed. $wgEnableTranscode = true; // Exclude transcoding jobs from the default job runner because they take very long to complete $wgJobTypesExcludedFromDefaultQueue[] = 'webVideoTranscode'; $wgJobTypesExcludedFromDefaultQueue[] = 'webVideoTranscodePrioritized'; // The total amount of time a transcoding shell command can take: $wgTranscodeBackgroundTimeLimit = 3600 * 8; // Maximum amount of virtual memory available to transcoding processes in KB $wgTranscodeBackgroundMemoryLimit = 2 * 1024 * 1024; // 2GB avconv, ffmpeg2theora mmap resources so virtual memory needs to be high enough // Maximum file size transcoding processes can create, in KB $wgTranscodeBackgroundSizeLimit = 3 * 1024 * 1024; // 3GB // Number of threads to use in avconv for transcoding $wgFFmpegThreads = 1; // The NS for TimedText (registered on MediaWiki.org) // https://www.mediawiki.org/wiki/Extension_namespace_registration // Note commons pre-dates TimedMediaHandler and should set $wgTimedTextNS = 102 in LocalSettings.php $wgTimedTextNS = 710; // Set TimedText namespace for ForeignDBViaLBRepo on a per wikiID basis // $wgTimedTextForeignNamespaces = [ 'commonswiki' => 102 ]; $wgTimedTextForeignNamespaces = []; /** * Default enabled transcodes * * -If set to empty array, no derivatives will be created * -Derivative keys encode settings are defined in WebVideoTranscode.php * * -These transcodes are *in addition to* the source file. * -Only derivatives with a smaller width than the source asset size will be created * -Regardless of source size, at least one WebM and Ogg source will be created from the $wgEnabledTranscodeSet * -Derivative jobs are added to the MediaWiki JobQueue the first time the asset is uploaded * -Derivative should be listed min to max */ // Starting from 1.31 // All valid string values are listed in the extension's extension.json file $wgEnabledTranscodeSet = [ '160p.webm' => true, '240p.webm' => true, '360p.webm' => true, '480p.webm' => true, '720p.webm' => true, '1080p.webm' => true, ]; $wgEnabledAudioTranscodeSet = [ 'ogg' => true, // ogg+vorbis 'opus' => false, // ogg+opus 'mp3' => true, // raw mp3 'm4a' => false, // mp4+aac (mp4a.40.5) ]; // If mp3 source assets can be ingested: $wgTmhEnableMp3Uploads = true; // If mp4 source assets can be ingested: $wgTmhEnableMp4Uploads = false; // If you use ffmpeg 2, it can be set to true $wgUseFFmpeg2 = false;
For transcoding, make sure you have $wgMaxShellMemory
, $wgMaxShellTime
, $wgMaxShellFileSize
are large enough to allow encoding jobs to run and save output. Default values are most likely too low.
Because transcode jobs are resource intensive, they should not run as part of the normal job queue (see TT29336). Configure Localsettings.php
with:
$wgJobTypesExcludedFromDefaultQueue[] = 'webVideoTranscode'; $wgJobTypesExcludedFromDefaultQueue[] = 'webVideoTranscodePrioritized';
Setup dedicated jobrunners and request running the jobs by the --type
argument:
php ./maintenance/run.php runJobs --type webVideoTranscode php ./maintenance/run.php runJobs --type webVideoTranscodePrioritized
It is very important to run these tasks as the webserver user.
A single transcode job for a video can easily take an hour or longer, so ensure the commands have enough time and CPU to run.
To transcode many videos, you might want to run multiple encoding nodes that connect to the master database and access your file store directly. You will need to install ffmpeg.
Minimal install under Debian and Ubuntu[edit]Plus, add this to your LocalSettings.php (tested for Devuan ASCII (Archived 2018-09-23 at the Wayback Machine) only):
$wgFFmpegLocation = '/usr/bin/ffmpeg';Shellbox isolation[edit]
For security reasons, ffmpeg runs in an isolated container using Shellbox at Wikimedia. You will need their docker image if you want to emulate the Wikimedia setup, including their Debian version, dependencies, etc. Use $wgShellboxUrls
to configure MediaWiki to make use of your Shellbox nodes.
You can also create your custom docker image, of course.
$ docker pull docker-registry.wikimedia.org/wikimedia/mediawiki-libs-shellbox:video
This section needs expansion
Please note that versions of TimedMediaHandler before MediaWiki 1.38 did not work with PostgreSQL. See T157424.
ffmpeg
– failed to map segment from shared object
$wgUseFFmpeg2 = true;
to your LocalSettings.php
.
$wgUseFFmpeg2 = true;
to your LocalSettings.php
.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4