summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMax Kellermann <max@musicpd.org>2019-05-13 22:36:41 +0200
committerMax Kellermann <max@musicpd.org>2019-05-13 22:39:49 +0200
commitfb07a7cecc1932beb711550b2fecce841af354cd (patch)
tree8fc01d5211b31179939a58fd2b0199e2102d9744 /doc
parentc6b08a4d48ad3d20d0604dabac0d3074d9441e84 (diff)
doc/user.rst: move audio format spec to section "Global Audio Format"
Diffstat (limited to 'doc')
-rw-r--r--doc/user.rst31
1 files changed, 21 insertions, 10 deletions
diff --git a/doc/user.rst b/doc/user.rst
index b678b9535..c92a3de55 100644
--- a/doc/user.rst
+++ b/doc/user.rst
@@ -402,14 +402,9 @@ The following table lists the audio_output options valid for all plugins:
- The name of the plugin
* - **name**
- The name of the audio output. It is visible to the client. Some plugins also use it internally, e.g. as a name registered in the PULSE server.
- * - **format**
- - Always open the audio output with the specified audio format samplerate:bits:channels), regardless of the format of the input file. This is optional for most plugins.
-
- Any of the three attributes may be an asterisk to specify that this attribute should not be enforced, example: 48000:16:*. *:*:* is equal to not having a format specification.
-
- The following values are valid for bits: 8 (signed 8 bit integer samples), 16, 24 (signed 24 bit integer samples padded to 32 bit), 32 (signed 32 bit integer samples), f (32 bit floating point, -1.0 to 1.0), "dsd" means DSD (Direct Stream Digital). For DSD, there are special cases such as "dsd64", which allows you to omit the sample rate (e.g. dsd512:2 for stereo DSD512, i.e. 22.5792 MHz).
-
- The sample rate is special for DSD: :program:`MPD` counts the number of bytes, not bits. Thus, a DSD "bit" rate of 22.5792 MHz (DSD512) is 2822400 from :program:`MPD`'s point of view (44100*512/8).
+ * - **format samplerate:bits:channels**
+ - Always open the audio output with the specified audio format, regardless of the format of the input file. This is optional for most plugins.
+ See :ref:`audio_output_format` for a detailed description of the value.
* - **enabed yes|no**
- Specifies whether this audio output is enabled when :program:`MPD` is started. By default, all audio outputs are enabled. This is just the default setting when there is no state file; with a state file, the previous state is restored.
* - **tags yes|no**
@@ -511,8 +506,24 @@ Global Audio Format
The setting ``audio_output_format`` forces :program:`MPD` to use one
audio format for all outputs. Doing that is usually not a good idea.
-The values are the same as in ``format`` in the :ref:`audio_output
-section <config_audio_output>`.
+
+The value is specified as ``samplerate:bits:channels``.
+
+Any of the three attributes may be an asterisk to specify that this
+attribute should not be enforced, example: ``48000:16:*``.
+``*:*:*`` is equal to not having a format specification.
+
+The following values are valid for bits: ``8`` (signed 8 bit integer
+samples), ``16``, ``24`` (signed 24 bit integer samples padded to 32
+bit), ``32`` (signed 32 bit integer samples), ``f`` (32 bit floating
+point, -1.0 to 1.0), ``dsd`` means DSD (Direct Stream Digital). For
+DSD, there are special cases such as ``dsd64``, which allows you to
+omit the sample rate (e.g. ``dsd512:2`` for stereo DSD512,
+i.e. 22.5792 MHz).
+
+The sample rate is special for DSD: :program:`MPD` counts the number
+of bytes, not bits. Thus, a DSD "bit" rate of 22.5792 MHz (DSD512) is
+2822400 from :program:`MPD`'s point of view (44100*512/8).
Resampler
~~~~~~~~~