WirePlumberのソースを表示

[[Category:マルチメディア]]
[[en:WirePlumber]]
{{Related articles start}}
{{Related|PipeWire}}
{{Related articles end}}

[https://pipewire.pages.freedesktop.org/wireplumber WirePlumber] は、[[PipeWire]] 用の強力なセッションおよびポリシーマネージャです。モジュール設計に基づき、管理機能を実装し、 Lua プラグインによって、高度な設定と拡張が可能です。

== インストール ==

{{Pkg|wireplumber}} パッケージを [[インストール]]してください。他の PipeWire セッションマネージャーと競合しますので、必ずアンインストールするようにしてください。

WirePlumber は [[systemd/ユーザー]] を使ってサーバーを管理し、ソケットを自動で起動します。

オプションとして、ドキュメントを確認するために {{Pkg|wireplumber-docs}} をインストールしてください。

== 設定 ==
WirePlumber のモジュール設計は、特定の機能の実装を入れ替える際に、残りの機能を再実装する必要がなく、非常に柔軟性があります。詳細な情報は、[https://pipewire.pages.freedesktop.org/wireplumber/configuration.html official documentation] で見ることができます。

以下に、簡単な設定例を示します。

=== ルール マッチングのためのインターフェース名の取得 ===

WirePlumber の Lua スクリプトでは、設定したい対象インターフェースの [https://docs.pipewire.org/page_objects_design.html PipeWire objects] で {{ic|matches}} ルールを指定する必要があります。

システムで利用可能な全てのオブジェクトを表示するには、コマンド {{ic|pw-cli list-objects}} と {{ic|pw-cli dump}} を使用します。

オブジェクト {{ic|Node}} は PipeWire グラフ内のシンクまたはソースです。これらは ALSA の {{ic|Device}} に対応します。

表示するオブジェクトの種類を絞り込むには、 {{ic|<nowiki>[Device|Node]</nowiki>}} オプションを追加してください。例えば:

{{hc|$ pw-cli list-objects Device|output=
...
id 37, type PipeWire:Interface:Device/3
 	object.serial = "264"
 	factory.id = "14"
 	client.id = "49"
 	device.api = "alsa"
 	device.description = "Starship/Matisse HD Audio Controller"
 	device.name = "alsa_card.pci-0000_08_00.4"
 	device.nick = "HD-Audio Generic"
 	media.class = "Audio/Device"
...
}}

オブジェクトタイプのフィルタリングは、{{ic|pw-cli dump}} コマンドにも適用されます。

もしエンドポイントの特定のクラス (例:"Audio/Sink") を探しているのであれば、 {{ic|media.class}} プロパティを参照してください。

ほとんどの場合、ALSA を設定するときに必要なプロパティは {{ic|device.name}} か {{ic|node.name}} のどちらかです。

{{Tip|{{ic|pw-top}} コマンドは現在使用されている {{ic|Node}} のリストを表示します。}}

=== デバイス/ノードのプロパティを変更する ===

デバイスやノードのプロパティ（説明やニックネームなど）を変更するには、Lua スクリプトを作成し、{{ic|~/.config/wireplumber}} に適切なパスと名前で追加する必要があります。

例えば ALSA ノードの説明を変更するには、 {{ic|~/.config/wireplumber/main.lua.d/51-alsa-rename.lua}} のようなファイルを作成して、以下のような内容を記述してください。
{{hc|head=51-alsa-rename.lua|output=rule = {
  matches = {
    {
      { "node.name", "equals", "alsa_output.pci-0000_00_1f.3.output_analog-stereo" },
    },
  },
  apply_properties = {
    ["node.description"] = "Laptop",
  },
}

table.insert(alsa_monitor.rules,rule)}}

もし、Bluetooth ノードやデバイスの何かを変更したい場合は、以下のような内容で {{ic|~/.config/wireplumber/bluetooth.lua.d/51-rename.lua}} を作成するとよいでしょう。
{{hc|head=51-rename.lua|output=rule = {
  matches = {
    {
      { "node.name", "equals", "bluez_output.02_11_45_A0_B3_27.a2dp-sink" },
    },
  },
  apply_properties = {
    ["node.nick"] = "Headphones",
  },
}

table.insert(bluez_monitor.rules,rule)}}

Lua スクリプトのファイル名と場所は、[https://pipewire.pages.freedesktop.org/wireplumber/configuration/config_lua.html#multi-path-merging WirePlumber's マルチパスマージ] で、デフォルトの設定ファイル

（例:{{ic|/usr/share/wireplumber/main.lua.d/50-alsa-config.lua}}）デバイスをロードして有効にするファイル

（例:{{ic|/usr/share/wireplumber/main.lua.d/90-enable-all.lua}}）の前に実行できるよう設計されています。

デバイスやノードを選択するためのマッチングルールや、変更できるプロパティは [https://pipewire.pages.freedesktop.org/wireplumber/configuration/alsa.html ALSA 設定] と [https://pipewire.pages.freedesktop.org/wireplumber/configuration/bluetooth.html Bluetooth 設定] に記載されています。

=== デバイス/ノードの無効化 ===

WirePlumber v0.4.7 からは、プロパティ {{ic|device.disabled}} または {{ic|node.disabled}} で任意のデバイスやノードを無効にできるようになりました。

{{hc|head=~/.config/wireplumber/main.lua.d/51-alsa-disable.lua|output=rule = {
  matches = {
    {
      { "device.name", "equals", "alsa_card.pci-0000_08_00.4" },
    },
  },
  apply_properties = {
    ["device.disabled"] = true,
  },
}

table.insert(alsa_monitor.rules,rule)}}

システム内の {{ic|alsa_card.*}} の名前については、[[WirePlumber#Obtain interface name for rules matching]] を参照してください。

{{Note|一般的な使用例としては、NVIDIA の HDMI オーディオ出力を無効にする場合など。}}

== 参照 ==

* [https://pipewire.pages.freedesktop.org/wireplumber/ Documentation] — オフィシャル ドキュメント
* [https://www.collabora.com/news-and-blog/blog/2020/05/07/wireplumber-the-pipewire-session-manager/ WirePlumber, PipeWire session manager] - George Kiagiadakis (Collabora) による2020年5月のブログ記事で、WirePlumber の仕組みが詳しく説明されています。