From 34c8242133e70c8371956a601516ee38f0c92550 Mon Sep 17 00:00:00 2001 From: Max Kellermann Date: Mon, 18 Mar 2019 17:01:55 +0100 Subject: [PATCH 1/4] doc/user.rst: add more links --- doc/plugins.rst | 2 ++ doc/user.rst | 8 +++++++- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/doc/plugins.rst b/doc/plugins.rst index 060435537..08d4d1345 100644 --- a/doc/plugins.rst +++ b/doc/plugins.rst @@ -690,6 +690,8 @@ Valid quality values for libsoxr: * "low" * "quick" +.. _output_plugins: + Output plugins -------------- diff --git a/doc/user.rst b/doc/user.rst index 5ab9539db..674b19148 100644 --- a/doc/user.rst +++ b/doc/user.rst @@ -365,10 +365,14 @@ More information can be found in the :ref:`decoder_plugins` reference. Configuring encoder plugins --------------------------- -Encoders are used by some of the output plugins (such as shout). The encoder settings are included in the audio_output section. +Encoders are used by some of the output plugins (such as shout). The +encoder settings are included in the ``audio_output`` section, see :ref:`config_audio_output`. More information can be found in the :ref:`encoder_plugins` reference. + +.. _config_audio_output: + Configuring audio outputs ------------------------- @@ -422,6 +426,8 @@ The following table lists the audio_output options valid for all plugins: (:samp:`none`). By default, the hardware mixer is used for devices which support it, and none for the others. +More information can be found in the :ref:`output_plugins` reference. + Configuring filters ------------------- From aa1d867b72f8ea749625f53a5c6d7ed779f1288c Mon Sep 17 00:00:00 2001 From: Max Kellermann Date: Mon, 18 Mar 2019 16:59:47 +0100 Subject: [PATCH 2/4] doc/user.rst: document the "filters" setting --- doc/user.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/doc/user.rst b/doc/user.rst index 674b19148..cdcb94bd5 100644 --- a/doc/user.rst +++ b/doc/user.rst @@ -425,9 +425,16 @@ The following table lists the audio_output options valid for all plugins: implement an external mixer :ref:`external_mixer`) or no mixer (:samp:`none`). By default, the hardware mixer is used for devices which support it, and none for the others. + * - **filters "name,...**" + - The specified configured filters are instantiated in the given + order. Each filter name refers to a ``filter`` block, see + :ref:`config_filter`. More information can be found in the :ref:`output_plugins` reference. + +.. _config_filter: + Configuring filters ------------------- @@ -442,6 +449,9 @@ To configure a filter, add a :code:`filter` block to :file:`mpd.conf`: name "software volume" } +Configured filters may then be added to the ``filters`` setting of an +``audio_output`` section, see :ref:`config_audio_output`. + The following table lists the filter options valid for all plugins: .. list-table:: From 8158bd218c49f724245540c4b47f107c1bbe61ca Mon Sep 17 00:00:00 2001 From: Max Kellermann Date: Mon, 18 Mar 2019 18:05:18 +0100 Subject: [PATCH 3/4] doc/plugins.rst: add filter plugin reference --- doc/plugins.rst | 35 ++++++++++++++++++++++++++++++++++- doc/user.rst | 3 +++ 2 files changed, 37 insertions(+), 1 deletion(-) diff --git a/doc/plugins.rst b/doc/plugins.rst index 08d4d1345..21f8f1f2d 100644 --- a/doc/plugins.rst +++ b/doc/plugins.rst @@ -1039,8 +1039,41 @@ The "Solaris" plugin runs only on SUN Solaris, and plays via /dev/audio. * - **device PATH** - Sets the path of the audio device, defaults to /dev/audio. + +.. _filter_plugins: + +Filter plugins +-------------- + +normalize +~~~~~~~~~ + +Normalize the volume during playback (at the expensve of quality). + + +null +~~~~ + +A no-op filter. Audio data is returned as-is. + + +route +~~~~~ + +Reroute channels. + +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Setting + - Description + * - **routes "0>0, 1>1, ..."** + - Specifies the channel mapping. + + .. _playlist_plugins: - + Playlist plugins ---------------- diff --git a/doc/user.rst b/doc/user.rst index cdcb94bd5..ea65442b2 100644 --- a/doc/user.rst +++ b/doc/user.rst @@ -465,6 +465,9 @@ The following table lists the filter options valid for all plugins: * - **name** - The name of the filter +More information can be found in the :ref:`filter_plugins` reference. + + Configuring playlist plugins ---------------------------- From 7de8fd04a4dfbd0dbc1d021f3d096724069cde2b Mon Sep 17 00:00:00 2001 From: Max Kellermann Date: Mon, 18 Mar 2019 18:24:51 +0100 Subject: [PATCH 4/4] doc/plugins.rst: add the Haiku plugin and mark it as unmaintained --- doc/plugins.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/doc/plugins.rst b/doc/plugins.rst index 21f8f1f2d..69549e5a7 100644 --- a/doc/plugins.rst +++ b/doc/plugins.rst @@ -802,6 +802,15 @@ The fifo plugin writes raw PCM data to a FIFO (First In, First Out) file. The da * - **path P** - This specifies the path of the FIFO to write to. Must be an absolute path. If the path does not exist, it will be created when MPD is started, and removed when MPD is stopped. The FIFO will be created with the same user and group as MPD is running as. Default permissions can be modified by using the builtin shell command umask. If a FIFO already exists at the specified path it will be reused, and will not be removed when MPD is stopped. You can use the "mkfifo" command to create this, and then you may modify the permissions to your liking. +haiku +~~~~~ + +Use the SoundPlayer API on the Haiku operating system. + +This plugin is unmaintained and contains known bugs. It will be +removed soon, unless there is a new maintainer. + + jack ~~~~ The jack plugin connects to a `JACK server `_.