扩展:TimedMediaHandler

**MediaWiki的扩展的手冊**
TimedMediaHandler; 發佈狀態：穩定版本
实现	媒體, API
描述	提供对于服务器端转码的集成支持，WebM、OGG Theora、Vorbis、Speex语音以及赋时文本
作者	Michael Dale, Jan Gerber, Tim Starling, James Heinrich, Brion Vibber, Derk-Jan Hartman
最新版本	0.6.0
兼容性政策	快照跟随MediaWiki发布。 master分支不向後兼容。
MediaWiki	>= 1.40.0
数据库更改	是
表	transcode
许可协议	GNU通用公眾授權條款2.0或更新版本
下載	下載扩展 ; Git [?]: 下载Git master; 浏览存储库 (Phabricator · GitHub); 提交历史; repository contributors (GitHub); 代码复核;
	參數 $wgMediaAudioTypes; $wgMediaVideoTypes; $wgWaitTimeForTranscodeReset; $wgEnableNiceBackgroundTranscodeJobs; $wgTmhEnableMp4Uploads; $wgUseFFmpeg2; $wgEnableTranscode; $wgTmhPriorityResolutionThreshold; $wgFFmpegVP9RowMT; $wgEnableIframeEmbed; $wgParserTestMediaHandlers; $wgTranscodeBackgroundSizeLimit; $wgTranscodeBackgroundTimeLimit; $wgEnabledAudioTranscodeSet; $wgTmhSoundfontLocation; $wgTmhFileExtensions; $wgTimedTextForeignNamespaces; $wgMinimumVideoPlayerSize; $wgFFmpegThreads; $wgTmhFluidsynthLocation; $wgTranscodeBackgroundMemoryLimit; $wgEnabledTranscodeSet; $wgFFmpegLocation; $wgTmhPriorityLengthThreshold; $wgTimedTextNS; $wgTranscodeBackgroundPriority;
	使用的钩子 ArticleContentOnDiff; ArticleFromTitle; ArticlePurge; BeforePageDisplay; CanonicalNamespaces; FileDeleteComplete; FileUpload; ImageOpenShowImageInlineBefore; ImagePageAfterImageLinks; ImagePageFileHistoryLine; LoadExtensionSchemaUpdates; MediaWikiPerformAction; ParserTestGlobals; RevisionFromEditComplete; SkinTemplateNavigation::Universal; TitleMove; wgQueryPages;
季度下載量	273 (Ranked 41st)
公開的wiki使用	1,290 (Ranked 218th)
	翻譯TimedMediaHandler的扩展，若在translatewiki.net可用
問題	尚未完成的工作 · 报告錯誤

This page is a translated version of the page Extension:TimedMediaHandler and the translation is 56% complete.

Outdated translations are marked like this.

Languages:

TimedMediaHandler擴展允許您使用與image文件相同的語法在Wiki頁面中顯示音頻和視頻文件。它包括VideoJS Player。支持字幕和字幕（又稱定時文本）以及在多個WebM和其他派生工具以及許多其他功能之間的實時流切換。 TMH服務器端支持包括用於上傳HTML5音頻和視頻的選項，用於傳遞內容的多個轉碼配置文件，MIDI文件的回放，用於Ogg和WebM視頻的元數據解析，以及與MediaWiki的jobQueue系統集成以安排轉碼作業。

For new and upcoming developments in 2022, see Extension:TimedMediaHandler/2022 work.

Please note that TimedMediaHandler does not currently work with PostgreSQL. See 任务T157424.

功能预览

For the player see: VideoJS Player.

查看Commons:Timed Text页面。

语法简介

在image embed syntax基础上，Timed Media Handler支持：

[[File:Video.ogv|File:Video.ogv]]: 用原尺寸显示一个视频。显示一个在视频中点提取的静止图像，和一个用来激活播放器的播放按钮。
[[File:Audio.oga|File:Audio.oga]]: 为声音文件显示一个占位符，包含一个用于激活播放器的播放按钮。
[[File:Midi.mid]]: 根據MIDI文件中的音樂指令生成數字音頻，並顯示嵌入式音頻播放器以播放此音頻。
[[File:Video.ogv|thumb]]: 在一个浮动的缩略图里显示视频。 <gallery>File:Video.ogv</gallery>; 在一个图片库（image gallery）里嵌入视频（每一个截图都会弹出一个用于完整视频的对话框）。
[[File:Video.ogg|thumbtime=1:25]]: 用1分25秒的一帧画面插入视频作为占位图形。一个单独的数字将默认被理解成秒数。也可以使用HH:MM:SS，例如1:02:22将是视频的1小时2分22秒。 Floating-point seconds are supported (but broken on Wikimedia wikis: phab:T228467).
[[File:Video.ogg|start=1:25]]: Temporal media fragments displays a video clip starting at 1 minute 25 seconds into the video. A single number is taken as an offset in seconds. You can also include an end time of the form 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. 也可以使用HH:MM:SS，例如1:02:22将是视频的1小时2分22秒。; start= and end= can also be used as query parameters in the URL for a video's file page.
[[File:Video.ogg|muted]]: Start the media with muted audio. （在版本1.39引入）
[[File:Video.ogg|loop]]: Loop the video continuously. （在版本1.39引入）
弃用: 語法字noicon和noplayer已棄用，不起作用。關鍵字disablecontrols可能會被棄用。（请参见task T135537）它採用以下任何值的逗號分隔列表： options, timedText, fullscreen

客户端支持

示例视频播放器

示例音频播放器

音頻播放器更寬，顯示進度條

这个播放器在大部分现代浏览器上能够工作，支持IE9及更高版本（在MediaWiki's support matrix里有关于现代浏览器的描述）。移动端支持情况不一，尤其是在iOS上。

TimedMediaHandler包括用於Ogg音頻/視頻的JavaScript兼容性代碼，可在Safari，Internet Explorer 10/11和Microsoft Edge瀏覽器中使用。

MediaWiki的第三方用戶可能還希望為Safari / IE / Edge中的本地視頻和音頻播放手動啟用MP4 H.264 / AAC支持，但是使用這些格式時，您可能需要MPEG-LA的專利許可才能進行互聯網廣播。

安裝

You will want a recent version of ffmpeg in order to support encoding to WebM (with the latest version of VP9).

下载文件，并将其放置在您extensions/文件夹中的TimedMediaHandler目录内。
只有從git安裝才运行Composer来安装PHP依赖，通过发行composer install --no-dev至扩展目录。（参见任务T173141了解潜在问题。）

将下列代码放置在您的LocalSettings.php 的底部：

wfLoadExtension( 'TimedMediaHandler' );
$wgFFmpegLocation = '/usr/bin/ffmpeg'; // Most common ffmpeg path on Linux

运行更新脚本，它将自动创建此扩展必须依赖的数据库表。
Configure as required.
You may need to increase the allowed memory in $wgMaxShellMemory .
完成 – 在您的wiki上导航至Special:Version，以验证已成功安装扩展。

The extension will automatically add supported file types (except for mp4) to $wgFileExtensions , so you do not need to manually add video file types.

下載此擴展後，請注意，它需要Composer。

所以，在从Git安装之后，切换到包含该扩展的目录。例如："../extensions/TimedMediaHandler/"并运行composer install --no-dev，或在更新时：composer update --no-dev。

或者最好将"extensions/TimedMediaHandler/composer.json"添加到在Wiki根目录下的"composer.local.json"文件中，例如：

{
	"extra": {
		"merge-plugin": {
			"include": [
				"extensions/TimedMediaHandler/composer.json"
			]
		}
	}
}

维基百科媒体编码选项的比较

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		2160p

详细选项:

名称		160P	240P	360P	480P	720P	1080P	160P	240P	360P	480P	720P	1080P	1440P	2160P
容器		WebM
视频	编码	VP8						VP9
	最大宽度（像素）	288	426	640	854	1280	1920	288	426	640	854	1280	1920	2560	4096
	最大高度（像素）	160	240	360	480	720	1080	160	240	360	480	720	1080	1440	2160
	比特率 (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
音频	编码	Vorbis						Opus
	频道	2 (stereo)						(pass-through)
	采样率 (Hz)	44100						48000
	品质	-		1	2	3	-	(default)

配置

本部分已过时-请更新我

这里展示了一些可能有用的配置变量：

// The minimum size for an embed 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;

// The total amout 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 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 can be set it to true
$wgUseFFmpeg2 = false;

如果需要转码，请确认你的$wgMaxShellMemory,$wgMaxShellTime,$wgMaxShellFileSize足够大而保证转码工作进行并保存输出。默认值很可能太小了。

进行转码工作

由于转码工作是资源集中型工作，它们不会再常规工作队列中运行 (查看 task T29336)。相反，它们必须由--type参数请求：

php maintenance/runJobs.php --type webVideoTranscode

如果運行此命令使其永久掛起，則可能需要在LocalSettings.php中設置$wgTranscodeBackgroundTimeLimit = 0;。参见任务T206957。

编码节点

为了能够转码许多视频，你可能想要运行多个连接到主数据库并且直接访问你的文件的编码节点。您将需要安装ffmpeg。

在Debian和Ubuntu下的最小安装

apt install ffmpeg

Plus, add this to your LocalSettings.php (tested for Devuan ASCII (Archived 2018-09-23 at the Wayback Machine) only):

$wgFFmpegLocation = '/usr/bin/ffmpeg';

Troubleshooting

本部分需要擴展

ffmpeg – failed to map segment from shared object: You need to increase the allowed memory in $wgMaxShellMemory .
Class 'getID3' not found: You need to install the extension's PHP dependencies using Composer, see the installation section.
Unrecognized option 'max_muxing_queue_size': You may be using ffmpeg 2. You need add $wgUseFFmpeg2 = true; to your LocalSettings.php.
Unrecognized option 'max_muxing_queue_size': You may be using ffmpeg 2. You need add $wgUseFFmpeg2 = true; to your LocalSettings.php.
[exception] […] /index.php?title=Special:Upload Error: Call to undefined method FSFile::getLocalRefPath(): This extension is incompatible with 扩展:嵌入式视频 . Uninstall it. You may also need to make sure you did the composer steps properly.

此扩展用于一个或多个维基媒体项目。这可能意味着扩展足够稳定、运作足够良好，可以用在这样的高流量的网站上。请在维基媒体的CommonSettings.php和InitialiseSettings.php配置文件中查找此扩展的名称以查看哪些网站安装了该扩展。特定wiki上的已安装的扩展的完整列表位于Special:Version页面。

此擴充功能包含在以下包或/和wiki農場：

這不是一份權威名單。即使一些wiki農場/託管者沒有被列在這裡，他們也可能包含這個extension。請以各wiki農場/託管者或包的狀態為準。