doc/user.rst: add MixRamp documentation

This commit is contained in:
Max Kellermann 2021-12-06 21:14:04 +01:00
parent 4e276256c0
commit bea821f194
2 changed files with 50 additions and 3 deletions

View File

@ -479,7 +479,7 @@ Querying :program:`MPD`'s status
current song in seconds, but with higher resolution. current song in seconds, but with higher resolution.
- ``duration`` [#since_0_20]_: Duration of the current song in seconds. - ``duration`` [#since_0_20]_: Duration of the current song in seconds.
- ``bitrate``: instantaneous bitrate in kbps - ``bitrate``: instantaneous bitrate in kbps
- ``xfade``: ``crossfade`` in seconds - ``xfade``: ``crossfade`` in seconds (see :ref:`crossfading`)
- ``mixrampdb``: ``mixramp`` threshold in dB - ``mixrampdb``: ``mixramp`` threshold in dB
- ``mixrampdelay``: ``mixrampdelay`` in seconds - ``mixrampdelay``: ``mixrampdelay`` in seconds
- ``audio``: The format emitted by the decoder plugin during - ``audio``: The format emitted by the decoder plugin during
@ -519,17 +519,19 @@ Playback options
.. _command_crossfade: .. _command_crossfade:
:command:`crossfade {SECONDS}` :command:`crossfade {SECONDS}`
Sets crossfading between songs. Sets crossfading between songs. See :ref:`crossfading`.
.. _command_mixrampdb: .. _command_mixrampdb:
:command:`mixrampdb {deciBels}` :command:`mixrampdb {deciBels}`
Sets the threshold at which songs will be overlapped. Like crossfading but doesn't fade the track volume, just overlaps. The songs need to have MixRamp tags added by an external tool. 0dB is the normalized maximum volume so use negative values, I prefer -17dB. In the absence of mixramp tags crossfading will be used. See http://sourceforge.net/projects/mixramp Sets the threshold at which songs will be overlapped.
See :ref:`mixramp`.
.. _command_mixrampdelay: .. _command_mixrampdelay:
:command:`mixrampdelay {SECONDS}` :command:`mixrampdelay {SECONDS}`
Additional time subtracted from the overlap calculated by mixrampdb. A value of "nan" disables MixRamp overlapping and falls back to crossfading. Additional time subtracted from the overlap calculated by mixrampdb. A value of "nan" disables MixRamp overlapping and falls back to crossfading.
See :ref:`mixramp`.
.. _command_random: .. _command_random:

View File

@ -622,6 +622,51 @@ enabled by setting ``volume_normalization`` to ``yes``. It supports
16 bit PCM only. 16 bit PCM only.
.. _crossfading:
Cross-Fading
------------
If ``crossfade`` is set to a positive number, then adjacent songs are
cross-faded by this number of seconds. This is a run-time setting
:ref:`which can be controlled by clients <command_crossfade>`,
e.g. with :program:`mpc`::
mpc crossfade 10
mpc crossfade 0
Zero means cross-fading is disabled.
Cross-fading is only possible if both songs have the same audio
format. At the cost of quality loss and higher CPU usage, you can
make sure this is always given by configuring
:ref:`audio_output_format`.
.. _mixramp:
MixRamp
^^^^^^^
MixRamp tags describe the loudness levels at start and end of a song
and can be used by MPD to find the best time to begin cross-fading.
MPD enables MixRamp if:
- Cross-fade is enabled
- :ref:`mixrampdelay <command_mixrampdelay>` is set to a positive
value, e.g.::
mpc mixrampdelay 1
- :ref:`mixrampdb <command_mixrampdb>` is set to a reasonable value,
e.g.::
mpc mixrampdb -17
- both songs have MixRamp tags
- both songs have the same audio format (or :ref:`audio_output_format`
is configured)
The `MixRamp <http://sourceforge.net/projects/mixramp>`__ tool can be
used to add MixRamp tags to your song files.
Client Connections Client Connections
------------------ ------------------