「WirePlumber」の版間の差分

提供: ArchWiki
ナビゲーションに移動 検索に移動
(→‎設定: 情報を更新)
(→‎設定: 設定ファイルのレイアウトを翻訳して追加)
16行目: 16行目:
   
 
== 設定 ==
 
== 設定 ==
WirePlumber のモジュール設計は、特定の機能の実装を入れ替える際に、残りの機能を再実装する必要がなく、非常に柔軟性があります。詳細な情報は、[https://pipewire.pages.freedesktop.org/wireplumber/configuration.html official documentation] で見ることができます。
 
   
  +
=== 設定ファイルのレイアウト ===
以下に、簡単な設定例を示します。
 
   
  +
[https://pipewire.pages.freedesktop.org/wireplumber/configuration.html WirePlumber の設定] は、変更された {{ic|context}} や {{ic|alsa_monitor}} などのグローバル PipeWire 風味の JSON オブジェクトで設定されていますその行動を変えるために。設定ファイルは、{{ic|~/.config/wireplumber/}} (ユーザー構成)、{{ic|/etc/wireplumber/}} (グローバル構成)、そして {{ic|/usr/share/wireplumber/}} (ストック構成) から読み取られます。
=== ルール マッチングのためのインターフェース名の取得 ===
 
  +
  +
WirePlumber は、[https://pipewire.pages.freedesktop.org/wireplumber/configuration/main.html メイン設定ファイル] を読み取ることから開始します。これは、PipeWire コンテキスト、[https://docs.pipewire.org/page_spa_plugins.html SPA プラグイン]、モジュール、およびコンポーネントを設定する JSON のようなファイルです。これらのコンポーネントの中には、グローバルオブジェクトを動的に変更するために使用される [[Wikipedia:ja:Lua|Lua]] スクリプトエンジンがあります。
  +
  +
パッケージに同梱されているさまざまな設定ファイルがあります。
  +
  +
* シングルインスタンス設定ファイル{{ic|/usr/share/wireplumber/wireplumber.conf}} これはデフォルトの設定であり、他のすべての設定の機能を1つのプロセス内に含んでいます。
  +
** すべてのメイン設定ファイルで使用されている "context" オブジェクトについては、[https://pipewire.pages.freedesktop.org/wireplumber/configuration/main.html ドキュメント] を参照。
  +
* メイン設定ファイル {{ic|/usr/share/wireplumber/main.conf}} WirePlumber コアに必要なモジュールとコンポーネントをロードし、{{ic|''config-dir''/main.lua.d/}} から [https://pipewire.pages.freedesktop.org/wireplumber/configuration/config_lua.html Lua 設定ファイル] をロードします。[https://pipewire.pages.freedesktop.org/wireplumber/configuration/config_lua.html] を参照してください。
  +
** [https://pipewire.pages.freedesktop.org/wireplumber/configuration/alsa.html ALSAオブジェクト] と [https://pipewire.pages.freedesktop.org/wireplumber/configuration/access.html "アクセス" オブジェクト] のドキュメントを参照してください。
  +
* [[Bluetooth]] 設定ファイル {{ic|/usr/share/wireplumber/bluetooth.conf}} コアプロセスの Bluetooth 接続を処理する WirePlumber プロセスに適しています。これは{{ic|''config-dir''/bluetooth.lua.d/}} から Lua ファイルをロードします。
  +
** [https://pipewire.pages.freedesktop.org/wireplumber/configuration/bluetooth.html Bluetooth オブジェクトのドキュメント] を参照してください。
  +
* ''policy'' 設定ファイルは {{ic|/usr/share/wireplumber/policy.conf}} にあります。これは、WirePlumber がノードの移動や変更を判断するためのポリシー機能をカプセル化したものです。{{ic|''config-dir''/policy.lua.d/}} から Lua ファイルを読み込みます。
  +
** ポリシー関連オブジェクトについては、[https://pipewire.pages.freedesktop.org/wireplumber/configuration/policy.html ドキュメント] を参照してください。
  +
  +
{{ic|lua.d/}} ディレクトリ内の Lua 設定ファイルは、{{ic|''config-dir''/scripts/}} から Lua スクリプトも読み込みます。これらのスクリプトは Pipewire のロジック/機能の一部を実装しており、特定の状況下では変更する価値がある場合もあります。
  +
  +
=== ルールマッチングのためのインターフェース名の取得 ===
   
 
WirePlumber の Lua スクリプトでは、設定したい対象インターフェースの [https://docs.pipewire.org/page_objects_design.html PipeWire objects] で {{ic|matches}} ルールを指定する必要があります。
 
WirePlumber の Lua スクリプトでは、設定したい対象インターフェースの [https://docs.pipewire.org/page_objects_design.html PipeWire objects] で {{ic|matches}} ルールを指定する必要があります。

2023年7月29日 (土) 02:50時点における版

関連記事

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

インストール

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

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

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

設定

設定ファイルのレイアウト

WirePlumber の設定 は、変更された contextalsa_monitor などのグローバル PipeWire 風味の JSON オブジェクトで設定されていますその行動を変えるために。設定ファイルは、~/.config/wireplumber/ (ユーザー構成)、/etc/wireplumber/ (グローバル構成)、そして /usr/share/wireplumber/ (ストック構成) から読み取られます。

WirePlumber は、メイン設定ファイル を読み取ることから開始します。これは、PipeWire コンテキスト、SPA プラグイン、モジュール、およびコンポーネントを設定する JSON のようなファイルです。これらのコンポーネントの中には、グローバルオブジェクトを動的に変更するために使用される Lua スクリプトエンジンがあります。

パッケージに同梱されているさまざまな設定ファイルがあります。

  • シングルインスタンス設定ファイル/usr/share/wireplumber/wireplumber.conf これはデフォルトの設定であり、他のすべての設定の機能を1つのプロセス内に含んでいます。
    • すべてのメイン設定ファイルで使用されている "context" オブジェクトについては、ドキュメント を参照。
  • メイン設定ファイル /usr/share/wireplumber/main.conf WirePlumber コアに必要なモジュールとコンポーネントをロードし、config-dir/main.lua.d/ から Lua 設定ファイル をロードします。[1] を参照してください。
  • Bluetooth 設定ファイル /usr/share/wireplumber/bluetooth.conf コアプロセスの Bluetooth 接続を処理する WirePlumber プロセスに適しています。これはconfig-dir/bluetooth.lua.d/ から Lua ファイルをロードします。
  • policy 設定ファイルは /usr/share/wireplumber/policy.conf にあります。これは、WirePlumber がノードの移動や変更を判断するためのポリシー機能をカプセル化したものです。config-dir/policy.lua.d/ から Lua ファイルを読み込みます。
    • ポリシー関連オブジェクトについては、ドキュメント を参照してください。

lua.d/ ディレクトリ内の Lua 設定ファイルは、config-dir/scripts/ から Lua スクリプトも読み込みます。これらのスクリプトは Pipewire のロジック/機能の一部を実装しており、特定の状況下では変更する価値がある場合もあります。

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

WirePlumber の Lua スクリプトでは、設定したい対象インターフェースの PipeWire objectsmatches ルールを指定する必要があります。

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

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

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

$ pw-cli list-objects Device
...
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"
...

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

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

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

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

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

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

例えば ALSA ノードの説明を変更するには、 ~/.config/wireplumber/main.lua.d/51-alsa-rename.lua のようなファイルを作成して、以下のような内容を記述してください。

51-alsa-rename.lua
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 ノードやデバイスの何かを変更したい場合は、以下のような内容で ~/.config/wireplumber/bluetooth.lua.d/51-rename.lua を作成するとよいでしょう。

51-rename.lua
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 スクリプトのファイル名と場所は、WirePlumber's マルチパスマージ で、デフォルトの設定ファイル

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

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

デバイスやノードを選択するためのマッチングルールや、変更できるプロパティは ALSA 設定Bluetooth 設定 に記載されています。

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

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

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

table.insert(alsa_monitor.rules,rule)

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

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

同じサウンドカード上の複数のシンクへの同時出力

/usr/share/alsa-card-profile/mixer/profile-sets/default.conf のコピーを作成して、更新後も変更が維持されるようにします。ここでは、アナログと HDMI の 2 つのデフォルトマッピングを結合するプロファイルを定義します。

/usr/share/alsa-card-profile/mixer/profile-sets/multiple.conf
[General]
auto-profiles = no

[Mapping analog-stereo]
device-strings = front:%f
channel-map = left,right
paths-output = analog-output analog-output-lineout analog-output-speaker analog-output-headphones analog-output-headphones-2
paths-input = analog-input-front-mic analog-input-rear-mic analog-input-internal-mic analog-input-dock-mic analog-input analog-input-mic analog-input-linein analog-input-aux analog-input-video analog-input-tvtuner analog-input-fm analog-input-mic-line analog-input-headphone-mic analog-input-headset-mic
priority = 15

[Mapping hdmi-stereo]
description = Digital Stereo (HDMI)
device-strings = hdmi:%f
paths-output = hdmi-output-0
channel-map = left,right
priority = 9
direction = output

[Profile multiple]
description = Analog Stereo Duplex + Digital Stereo (HDMI) Output
output-mappings = analog-stereo hdmi-stereo
input-mappings = analog-stereo

ここで、一致するデバイスに新しいカードプロファイルを使用するように Wireplumber を設定します。識別情報については、ルール マッチングのためのインターフェース名の取得 を参照してください。次のような Lua スクリプトを作成して構成を適用します。

/etc/wireplumber/main.lua.d/51-alsa-custom.lua (or ~/.config/wireplumber/main.lua.d/51-alsa-custom.lua)
rule = {
  matches = {
    {
      { "device.nick", "matches", "HDA Intel PCH" },
    },
  },
  apply_properties = {
    ["api.alsa.use-acp"] = true,
    ["api.acp.auto-profile"] = false,
    ["api.acp.auto-port"] = false,
    ["device.profile-set"] = "multiple.conf",
    ["device.profile"] = "multiple",
  },
}
table.insert(alsa_monitor.rules,rule)

ヒントとテクニック

キーボードで音量コントロール

次のコマンドをボリュームキーにバインドするには、キーボードショートカット#Xorg を参照してください: XF86AudioRaiseVolumeXF86AudioLowerVolumeXF86AudioMute、および XF86AudioMicMute

音量を 150% の制限で上げるには:

$ wpctl set-volume -l 1.5 @DEFAULT_AUDIO_SINK@ 5%+

音量を下げるには:

$ wpctl set-volume @DEFAULT_AUDIO_SINK@ 5%-

ボリュームをミュート/ミュート解除するには:

$ wpctl set-mute @DEFAULT_AUDIO_SINK@ toggle

マイクをミュート/ミュート解除するには:

$ wpctl set-mute @DEFAULT_AUDIO_SOURCE@ toggle
ヒント: デフォルト以外のシンクまたはソースを使用するには、wpctl status を実行して利用可能なすべてのシンクをリストし、@DEFAULT_AUDIO_SINK@ または _SOURCE@

音量レベルを表示

デフォルトのシンクの音量レベルとミュート状態を取得するには、次の手順を実行します。

$ wpctl get-volume @DEFAULT_AUDIO_SINK@
Volume: 0.45
ノート: ミュートステータスは、シンクがミュートされている場合にのみ表示されます。

ログアウト後も Bluetooth を実行し続ける/ヘッドレス Bluetooth

デフォルトでは、/usr/share/wireplumber/bluetooth.lua.d/50-bluez-config.lua により [2] が有効になります/diffs?commit_id=a253aa4c4948cdd87ba222670ee17db849af85ddlogind module] これにより、セッションが終了するたびに Bluetooth が無効になります。これは次のようにオーバーライドできます。

/etc/wireplumber/bluetooth.lua.d/50-bluez-config.lua (or ~/.config/wireplumber/bluetooth.lua.d/50-bluez-config.lua)
bluez_monitor.properties = {
  ["with-logind"] = false,
}
ノート: PipeWire/Wireplumber を実行しているユーザーに対して 残留 を有効にする必要があります。

参照