Extension:Score

パラメーター
$wgScoreLilyPond $wgScoreAbc2Ly $wgScoreFluidsynth $wgScoreSoundfont $wgScoreTimidity $wgScoreLame $wgScoreTrim $wgScorePath $wgScoreDirectory $wgScoreFileBackend

タグ
score

使用するフック
ParserFirstCallInit BeforePageDisplay SoftwareInfo WikibaseClientDataTypes WikibaseRepoDataTypes

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

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

問題点

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

Score 拡張機能は、LilyPond を使用して楽譜を PNG 画像としてレンダリングできるようにします。またそれらを音声ファイルや MIDI ファイルに変換することもできます。

このページの説明文書は、Score拡張機能の現在のマスターを参照しています。バージョン0.1をダウンロードする場合は、READMEファイルを参照してください。

謝辞

オリジナルの Extension:LilyPond はJohannes E. Schindelinによって書かれました。
この拡張機能は、Tim Starling の Extension:LilyPond のコードレビューに基づいています。
オリジナルの Extension:ABC は River Tarnell によって書かれました。

使用法

設定の後、scoreタグを使って簡単なLilyPond記法をウィキテキストに埋め込むことができます。例えば:

<score>\relative c' { f d f a d f e d cis a cis e a g f e }</score>

変換結果：

一般的な形式でscoreタグに属性を指定することもできます

<score attribute1="value1" attribute2="value2">…</score>.

例えば:

<score sound="1">\relative c' { f d f a d f e d cis a cis e a g f e }</score>

変換結果：

使用できる属性は次の通りです。

Attribute	Allowed values	Effect
lang	ABC, lilypond (default)	Sets the score language. For example, to provide a score in ABC notation, you might use <score lang="ABC"> X:1 M:C L:1/4 K:C C, D, E, F,\|G, A, B, C\|D E F G\|A B c d\| e f g a\|b c' d' e'\|f' g' a' b'\|] </score>.
midi	0 (default), 1	If set to 1, the rendered image(s) will be embedded into a hyperlink to an appropriate MIDI file.
override_midi	Known file name, that is, if override_midi="name" is given, `[[File:name]]` does not yield a red link	Uses the specified MIDI file instead of generating one with LilyPond. Use this attribute together with the midi attribute (see before) or the sound attribute (see later). This attribute is useful if you already have a MIDI file whose quality is superior to what would be generated by LilyPond.
override_audio	Known file name, that is, if override_audio="name" is given, `[[File:Name]]` does not yield a red link	Embeds the media specified by the file name in the HTML after the score image(s). This is an alternative to the sound attribute (see further). It can, for example, be useful if you have a suitable audio file of superior quality compared with the auto-generated audio file. Of course, you can still omit both attributes in this case and add the file manually to the page, if you prefer.
raw	0 (default), 1	If set to 1, the score code is interpreted as a complete LilyPond file. Use this option if you want to create more complex scores. If the score language (lang attribute) is not set to lilypond, this attribute is ignored. By default (when raw=0), provided code is wrapped in a `\score{...}` block, along with default `\layout{...}` and `\midi{...}` blocks, if not already provided.
sound	0 (default), 1	If set to 1, an audio file will be generated for the score, provided you installed and configured Extension:TimedMediaHandler. An audio player will be embedded in the HTML after the score image(s).
vorbis	0 (default), 1	Deprecated alias for sound.

歌詞は次のように追加することができます:

<score>\relative c'' { \time 4/4 \key c \major 
c4 g8 g a4 g r b^> c^> r \bar "|." } 
\addlyrics { Shave and a hair -- cut: two bits. }</score>

要件

この拡張機能はLilyPondを使用してスコア画像を描画するので、LilyPondをインストールする必要があります。スコアファイルをトリミングする拡張機能が必要な場合は、ImageMagickも必要です。

拡張機能は、LilyPond によって生成された MIDI ファイルから音声ファイルを作成することもできます。この機能を利用するには、Extension:TimedMediaHandlerをインストールする必要があります。

拡張機能のVersion 0.1のテストにはMediaWiki 1.18.0 および LilyPond 2.12.3 を使用しました。current git snapshot には MediaWiki と/または LilyPond の更新版が必要な場合があります。

ダウンロード手順

拡張機能のダウンロードを使用してください。GitHubからダウンロードする場合は、tarball [1] もしくはzipファイル [2] 形式が選べます。GitHubのScoreマスターブランチは安定バージョンのMediaWikiで動作しますが、まだ最新の機能の導入前である可能性があります。

インストール

ダウンロードして、ファイルを extensions/ フォルダー内の Score という名前のディレクトリ内に配置します。

以下のコードを LocalSettings.php の末尾に追加します:

wfLoadExtension( 'Score' );
$wgScoreLilyPond = '/path/to/your/lilypond/executable'; /* required */
$wgScoreAbc2Ly = '/path/to/your/abc2ly/executable'; /* if you want ABC to LilyPond conversion */
$wgScoreFluidsynth = '/path/to/your/fluidsynth/executable'; /* if you want MIDI to audio conversion */
$wgScoreSoundfont = '/path/to/your/soundfont/file'; /* required for Fluidsynth */
$wgScoreTimidity = '/path/to/your/timidity/executable'; /* fallback when Fluidsynth is not installed */
$wgScoreLame = '/path/to/your/lame/executable'; /* required to convert audio file for MP3 */
$wgScoreTrim = true; /* Set to false if you don't want score trimming */

Create a subdirectory named lilypond in your $wgUploadDirectory (usually the directory named images in in your MediaWiki directory). Make sure the directory is writable by your Web server.
完了 – ウィキの「Special:Version」に移動して、拡張機能が正しくインストールされたことを確認します。

MediaWiki 1.26 以前を稼働させている利用者へ:

上記の手順では、wfLoadExtension() を使用してこの拡張機能をインストールする新しい方法を記載しています。この拡張機能をこれらの過去のバージョン (MediaWiki 1.26 以前) にインストールする必要がある場合は、wfLoadExtension( 'Score' ); の代わりに以下を使用する必要があります:

require_once "$IP/extensions/Score/Score.php";

設定

現状ではこの拡張機能に次のようなグローバルな設定パラメータがあります。

$wgScoreLilyPond

$wgScoreLilyPond のパスを実行可能な LilyPond に設定（通常は /usr/bin/lilypondまたは/usr/local/bin/lilypond）。

$wgScoreTrim

$wgScoreTrimというブール値は既定で$wgUseImageMagickの値です。trueの場合、実行結果の score PNG 画像を ImageMagick でトリミング加工できます。それが不要の場合もしくは ImageMagick をインストールしたくない場合、$wgScoreTrimはfalseに設定します。

$wgScoreAbc2Ly

ABC 記法の$wgScoreAbc2Ly のパスを実行可能な LilyPond 変換機能に設定（通常は /usr/bin/abc2lyまたは/usr/local/bin/abc2ly）。

$wgScoreFluidsynth

$wgScoreFluidsynth のパスを実行可能な FluidSynth に設定（通常は/usr/bin/fluidsynthまたは/usr/local/bin/fluidsynth）。

$wgScoreSoundfont

$wgScoreSoundfont をSoundFontファイルのパスに設定（通常は/usr/share/sounds/sf2/FluidR3_GM.sf2 または /usr/share/sounds/sf2/FluidR3_GS.sf2）。

$wgScoreTimidity

$wgScoreTimidity のパスを実行可能なTiMidity++に設定（通常は/usr/bin/timidityまたは/usr/local/bin/timidity）。もし$wgScoreFluidsynth がない場合は、TiMidity++ にフォールバックして実行します。

$wgScoreLame

$wgScoreTimidity のパスを実行可能なLAMEに設定（通常は/usr/bin/lameまたは/usr/local/bin/lame）。生成する音声ファイルは必ず MP3 になるという制約があります。

注記

この拡張機能はシェル上で多種のバイナリを実行します。そのためメモリ不足のエラー発生時には、$wgMaxShellMemoryの拡張が必要な場合があります。

楽譜の検索

楽譜を含むページにはページ属性に「score」というセットが備わっています。楽譜のあるページの検索には特別:プロパティがあるページを使います。(日本語版ウィキペディアでは「プロパティ名:」欄で score を選択して実行。)

外部リンク

この拡張機能は 1 つ以上のウィキメディアのプロジェクトで使用されています。これはおそらく、この拡張機能が安定していて高いトラフィックのウェブサイトでも十分に動作することを意味します。この拡張機能がインストールされている場所を確認するには、ウィキメディアの設定ファイル CommonSettings.php および InitialiseSettings.php 内で、この拡張機能の名前を探してください。特定のウィキにインストールされている拡張機能の完全な一覧は、そのウィキの Special:Version ページにあります。