Phabricator のプロジェクト名 #timedmediahandler

Extension:TimedMediaHandler

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Extension:TimedMediaHandler and the translation is 49% complete.

Other languages:
català • ‎Deutsch • ‎English • ‎español • ‎suomi • ‎français • ‎Frysk • ‎italiano • ‎日本語 • ‎Nederlands • ‎polski • ‎português • ‎português do Brasil • ‎русский • ‎sicilianu • ‎中文
MediaWiki 拡張機能マニュアルManual:Extensions
Crystal Clear action run.svg
TimedMediaHandler

リリースの状態:Extension status 安定

Screenshot of TimedMediaHandler extension with Big Buck Bunny as background video.png
実装Template:Extension#type Media, API
説明Template:Extension#description サーバー側のトランスコード、WebM、Ogg Theora、Vorbis、MP3、Speex、Timed Textの統合サポートを提供
作者Template:Extension#username Michael Dale, Jan Gerber, Tim Starling, James Heinrich, Brion Vibber, Derk-Jan Hartman
最新バージョンTemplate:Extension#version 0.5.0 (2015-12-08)
互換性ポリシーCompatibility#mediawiki_extensions リリースブランチ
MediaWikiTemplate:Extension#mediawiki 1.23+
PHPTemplate:Extension#php 5.4+
データベースの変更Template:Extension#needs-updatephp はい
ライセンスTemplate:Extension#license GNU General Public License 2.0 or later
ダウンロード
使用するフックTemplate:Extension#hook
ArticleFromTitleManual:Hooks/ArticleFromTitle
UploadCompleteManual:Hooks/UploadComplete
TitleMoveManual:Hooks/TitleMove
FileDeleteCompleteManual:Hooks/FileDeleteComplete
BeforePageDisplayManual:Hooks/BeforePageDisplay
ImageOpenShowImageInlineBeforeManual:Hooks/ImageOpenShowImageInlineBefore
ImagePageFileHistoryLineManual:Hooks/ImagePageFileHistoryLine
LoadExtensionSchemaUpdatesManual:Hooks/LoadExtensionSchemaUpdates
UnitTestsListManual:Hooks/UnitTestsList
ArticleContentOnDiffManual:Hooks/ArticleContentOnDiff
ImagePageAfterImageLinksManual:Hooks/ImagePageAfterImageLinks
NewRevisionFromEditCompleteManual:Hooks/NewRevisionFromEditComplete
ArticlePurgeManual:Hooks/ArticlePurge
wgQueryPagesManual:Hooks/wgQueryPages
RejectParserCacheValueManual:Hooks/RejectParserCacheValue

translatewiki.net で翻訳を利用できる場合は、TimedMediaHandler 拡張機能の翻訳にご協力ください

使用状況とバージョン マトリクスを確認してください。

問題点Phabricator

未解決のタスク · バグを報告

TimedMediaHandler拡張機能を使用すると、画像ファイルと同じ構文を使用して、ウィキページにオーディオおよびビデオファイルを表示できます。それにはHTML5プレーヤーと実験的なVideoJSプレーヤーが含まれています。字幕やキャプション(別名 Timed Text)や複数のWebMと他の派生物間のリアルタイムストリームの切り替えなどの機能があります。TMHサーバサイドのサポートには、HTML5のオーディオとビデオ、複数のトランスコードプロファイルをアップロードするオプション、OggとWebMビデオのためのMetadata解析、トランスコードジョブのスケジューリングのためのMediaWikiのjobQueueシステムが組み込まれています。

機能の概要

Commons:Commons:TimedTextページを参照してください。

構文の概要

In addition to the image embed syntax, Timed Media Handler supports:

[[File:Video.ogv|File:Video.ogv]]
Display a video at its nominal size. Displays a still image from the midpoint with a play button to start an embedded player.
[[File:Audio.oga|File:Audio.oga]]
サウンドファイルのプレースホルダを表示し、埋め込みプレーヤーを開始するための再生ボタンを表示します。
[[File:Video.ogv|thumb]]
Show a video in a floating thumbnail box
<gallery>File:Video.ogv</gallery>
Show a video embedded in an image gallery ( each clip will popup a dialog for the full player )
[[File:Video.ogg|thumbtime=1:25]]
Use a frame from 1 minute 25 seconds into the video as the placeholder image. A single number is taken as an offset in seconds.
[[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.
廃止予定
The syntax words noicon and noplayer are deprecated and do not function. The keyword disablecontrols will likely be deprecated soon. It takes the following values: options, timedText, fullscreen

サポートされるブラウザー

動画プレーヤーの例
音声プレーヤーの例
プログレスバーを表示する、より広いオーディオプレーヤー

プレーヤーは最新のブラウザで動作し、IE9以降をサポートしています(MediaWikiのサポートマトリックスで説明されているモダンブラウザ)。 特にiOSでは、モバイルサポートには問題があります。

2015年8月現在、TimedMediaHandlerには、Safari、Internet Explorer 10/11、およびMicrosoft Edgeブラウザで動作するOggオーディオ/ビデオ用のJavaScript互換シムが含まれています。

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.

インストール

インストールの詳しい手順について README を参照。

You will want a recent version of ffmpeg in order to support encoding to WebM ( with the latest version of VP8). j^ supplies up-to-date static builds of ffmpeg with WebM support for major OSs at firefogg.org/nightly/


  • ダウンロードして、ファイルを extensions/ フォルダー内の TimedMediaHandler という名前のディレクトリ内に配置します。
  • 以下のコードを LocalSettings.php の末尾に追加します:
    // TimedMediaHandler is dependent on mwEmbedSupport
    // MediaWiki 1.27 or earlier
    require_once "$IP/extensions/MwEmbedSupport/MwEmbedSupport.php";
    // After MediaWiki 1.27
    wfLoadExtension( 'MwEmbedSupport' );
    // TimedMediaHandler
    require_once "$IP/extensions/TimedMediaHandler/TimedMediaHandler.php";
    
  • 更新スクリプトを実行します。このスクリプトは、この拡張機能が必要とするデータベース テーブルを自動的に作成します。
  • Configure as required.
  • YesY 完了 - ウィキの「Special:Version」に移動して、拡張機能が正しくインストールされたことを確認します。


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

ウィキペディアのメディアエンコードオプションの比較

Sorted by bandwidth tier (grayed items are not currently enabled):

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
動画 Encoding 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
音声 Encoding Vorbis Opus
チャンネル 2 (stereo) (pass-through)
サンプリング レート (Hz) 44100 48000
品質 - 1 2 3 - (default)

設定

This section is out of date -- please update me

以下は有用な設定用の変数です:

// 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 = array( 'commonswiki' => 102 );
$wgTimedTextForeignNamespaces = array();

/**
 * 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
 */
$wgEnabledTranscodeSet = array(
    WebVideoTranscode::ENC_WEBM_160P,
    WebVideoTranscode::ENC_WEBM_240P,
    WebVideoTranscode::ENC_WEBM_360P,
    WebVideoTranscode::ENC_WEBM_480P,
    WebVideoTranscode::ENC_WEBM_720P,
    WebVideoTranscode::ENC_WEBM_1080P,
);

$wgEnabledAudioTranscodeSet = array(
    WebVideoTranscode::ENC_OGG_VORBIS,
    WebVideoTranscode::ENC_MP3,
);

// If mp3 source assets can be ingested:
$wgTmhEnableMp3Uploads = true;

// If mp4 source assets can be ingested:
$wgTmhEnableMp4Uploads = 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 will not run as part of normal job queue ( see bug 29336 ) Instead they must be requested by the --type argument:

php maintenance/runJobs.php --type webVideoTranscode


Encoding nodes

To be able to transcode many videos you might want to run multiple encoding nodes that connect to the master db and access your file store directly. You will need to install ffmpeg.

Ubuntu 16.04での最小限のインストール

apt-get install ffmpeg


ロードマップ

  • Add support for transcoding from arbitrary format uploads.
  • Improve mobile support for uploading and playback ( via native aps if the browser html5 support does not include WebM )
  • Add support for WebM flattening of edited sequences
  • Add support for 8k videos
  • 2.x 枝にアップグレード。 (保留中。 video.js. への移行を計画中)
  • メインの動画再生のレイヤーを Kaltura から Video.js に変更。
  • 一貫したモバイルサポート
  • MPEG-DASHアダプティブストリーミング
  • サイレント動画を自動再生するための「GIFモード」
  • MIDI入力のサポート
  • Score、その他の拡張機能に接続するための内部インターフェイスの改善

注記

These notes about the status of TimedMediaHandler were shared by Jan Gerber at the end of his consulting agreement for WMF on 27 September, 2013:

Since you asked in the last meeting to write up an overview of the current state of TimedMediaHandler, here we go:

  • videoscalers:
    • setup like jobrunners, but only processing video transcode jobs (configuration of jobs/memory/threads in puppet and wikimedia-config)
  • imagescalers:
    • extract frames from videos, using avconv for all videos reading videos via http from swift backend
  • proxy caches:
    • must support HTTP 206 Range Requests for video urls (currently requires custom code that is managed in puppet)
  • custom packages for video transcoding (apt.wikimedia.org):
    • ffmpeg2theora (new upstream version to reduce memory by only using one thread)
    • libav (ubuntu version with patch to fix memory leak in ogg decoder)
    • libvpx (new upstream version fixing various issues and quality improvements)
  • custom packages for image scaling (apt.wikimedia.org):
    • vips (new upstream version addressing various performance issues)


2015年8月の更新

Brion と TheDJ は TImedMediaHandler の次の項目について新しく保守を始めました:

Done:

  • fixed some regressions in transcode handling
  • added /ogv.js JavaScript compatibility shim for Safari 6.1+, IE 10/11, and Edge
  • increasing Ogg transcode quality (increased bandwidth)
  • support subtitles in ogv.js
  • finish killing broken Cortado Java compatibility shim
  • retooling TMH's ResourceLoader modules for better compatibility
  • fix ogv.js issues
    • missing volume control

Todo 'small':

  • fix more transcode issues

Todo 'medium':

  • get transcoding from VP9/Opus working on Wikimedia servers...
  • transcoding to VP9/Opus WebM with decreased bandwidth
  • add Ogg skeleton to ogg audio transcodes for better seeking
  • integrate lightweight video player into Extension:MobileFrontend
  • rework serving Timed Text

Todo 'large':

Todo 'long-term':

  • get VP9 working fast enough on ogv.js to replace Ogg Theora transcodes