doc/mpd.conf.5.rst: move ReplayGain documentation to user.rst

This commit is contained in:
Max Kellermann 2021-11-22 22:14:10 +01:00
parent dcb5ca203c
commit e08c85ae2d
2 changed files with 40 additions and 17 deletions

View File

@ -128,23 +128,6 @@ audio_output
no audio_output section is specified, then MPD will scan for a usable audio no audio_output section is specified, then MPD will scan for a usable audio
output. output.
replaygain <off or album or track or auto>
If specified, mpd will adjust the volume of songs played using ReplayGain
tags (see https://wiki.hydrogenaud.io/index.php?title=Replaygain).
Setting this to "album" will
adjust volume using the album's ReplayGain tags, while setting it to "track"
will adjust it using the track ReplayGain tags. "auto" uses the track
ReplayGain tags if random play is activated otherwise the album ReplayGain
tags. Currently only FLAC, Ogg Vorbis, Musepack, and MP3 (through ID3v2
ReplayGain tags, not APEv2) are supported.
replaygain_preamp <-15 to 15>
This is the gain (in dB) applied to songs with ReplayGain tags.
volume_normalization <yes or no>
If yes, mpd will normalize the volume of songs as they play. The default is
no.
filesystem_charset <charset> filesystem_charset <charset>
This specifies the character set used for the filesystem. A list of supported This specifies the character set used for the filesystem. A list of supported
character sets can be obtained by running "iconv -l". The default is character sets can be obtained by running "iconv -l". The default is

View File

@ -465,6 +465,11 @@ The following table lists the audio_output options valid for all plugins:
implement an external mixer, see :ref:`external_mixer`) or no mixer implement an external mixer, see :ref:`external_mixer`) or no mixer
(:samp:`none`). By default, the hardware mixer is used for (:samp:`none`). By default, the hardware mixer is used for
devices which support it, and none for the others. devices which support it, and none for the others.
* - **replay_gain_handler software|mixer|none**
- Specifies how :ref:`replay_gain` is applied. The default is
``software``, which uses an internal software volume control.
``mixer`` uses the configured (hardware) mixer control.
``none`` disables replay gain on this audio output.
* - **filters "name,...**" * - **filters "name,...**"
- The specified configured filters are instantiated in the given - The specified configured filters are instantiated in the given
order. Each filter name refers to a ``filter`` block, see order. Each filter name refers to a ``filter`` block, see
@ -583,6 +588,40 @@ Sometimes, music needs to be resampled before it can be played; for example, CDs
Check the :ref:`resampler_plugins` reference for a list of resamplers Check the :ref:`resampler_plugins` reference for a list of resamplers
and how to configure them. and how to configure them.
Volume Normalization Settings
-----------------------------
.. _replay_gain:
Replay Gain
^^^^^^^^^^^
The setting ``replaygain`` specifies whether MPD shall adjust the
volume of songs played using `ReplayGain
<https://wiki.hydrogenaud.io/index.php?title=Replaygain>`__ tags.
Setting this to ``album`` will adjust volume using the album's
ReplayGain tags, while setting it to ``track`` will adjust it using
the "track" ReplayGain tags. ``auto`` uses the track ReplayGain tags
if random play is activated otherwise the album ReplayGain
tags.
If ReplayGain is enabled, then the setting ``replaygain_preamp`` is
set to a value (in dB) between ``-15`` and ``15``. This is the gain
applied to songs with ReplayGain tags.
ReplayGain is usually implemented with a software volume filter (which
prevents `Bit-perfect playback`_). To use a hardware mixer, set
``replay_gain_handler`` to ``mixer`` in the ``audio_output`` section
(see :ref:`config_audio_output` for details).
Simple Volume Normalization
^^^^^^^^^^^^^^^^^^^^^^^^^^^
MPD implements a very simple volume normalization method which can be
enabled by setting ``volume_normalization`` to ``yes``. It supports
16 bit PCM only.
Client Connections Client Connections
------------------ ------------------
@ -1076,6 +1115,7 @@ Check list for bit-perfect playback:
* Disable sound processing inside ALSA by configuring a "hardware" * Disable sound processing inside ALSA by configuring a "hardware"
device (:samp:`hw:0,0` or similar). device (:samp:`hw:0,0` or similar).
* Don't use software volume (setting :code:`mixer_type`). * Don't use software volume (setting :code:`mixer_type`).
* Don't use :ref:`replay_gain`.
* Don't force :program:`MPD` to use a specific audio format (settings * Don't force :program:`MPD` to use a specific audio format (settings
:code:`format`, :ref:`audio_output_format <audio_output_format>`). :code:`format`, :ref:`audio_output_format <audio_output_format>`).
* Verify that you are really doing bit-perfect playback using :program:`MPD`'s verbose log and :file:`/proc/asound/card*/pcm*p/sub*/hw_params`. Some DACs can also indicate the audio format. * Verify that you are really doing bit-perfect playback using :program:`MPD`'s verbose log and :file:`/proc/asound/card*/pcm*p/sub*/hw_params`. Some DACs can also indicate the audio format.