From 24d51b9d14b455652aa99d0e05117e5a1ec19d0f Mon Sep 17 00:00:00 2001
From: Max Kellermann <max@duempel.org>
Date: Mon, 10 Jan 2011 23:13:01 +0100
Subject: doc: add a list of encoder plugins

---
 doc/user.xml | 182 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 182 insertions(+)

(limited to 'doc')

diff --git a/doc/user.xml b/doc/user.xml
index 4dc04ff2e..1f74a02d4 100644
--- a/doc/user.xml
+++ b/doc/user.xml
@@ -235,6 +235,16 @@ cd mpd-version</programlisting>
       </informaltable>
     </section>
 
+    <section>
+      <title>Configuring encoder plugins</title>
+
+      <para>
+        Encoders are used by some of the output plugins (such as
+        <varname>shout</varname>).  The encoder settings are included
+        in the <varname>audio_output</varname> section.
+      </para>
+    </section>
+
     <section>
       <title>Configuring audio outputs</title>
 
@@ -668,6 +678,178 @@ cd mpd-version</programlisting>
       </section>
     </section>
 
+    <section>
+      <title>Encoder plugins</title>
+
+      <section>
+        <title><varname>flac</varname></title>
+
+        <para>
+          Encodes into FLAC (lossless).
+        </para>
+
+        <informaltable>
+          <tgroup cols="2">
+            <thead>
+              <row>
+                <entry>Setting</entry>
+                <entry>Description</entry>
+              </row>
+            </thead>
+            <tbody>
+              <row>
+                <entry>
+                  <varname>compression</varname>
+                </entry>
+                <entry>
+                  Sets the <filename>libFLAC</filename> compression
+                  level.  The levels range from 0 (fastest, least
+                  compression) to 8 (slowest, most compression).
+                </entry>
+              </row>
+            </tbody>
+          </tgroup>
+        </informaltable>
+      </section>
+
+      <section>
+        <title><varname>lame</varname></title>
+
+        <para>
+          Encodes into MP3 using the LAME library.
+        </para>
+
+        <informaltable>
+          <tgroup cols="2">
+            <thead>
+              <row>
+                <entry>Setting</entry>
+                <entry>Description</entry>
+              </row>
+            </thead>
+            <tbody>
+              <row>
+                <entry>
+                  <varname>quality</varname>
+                </entry>
+                <entry>
+                  Sets the quality for VBR.  0 is the highest quality,
+                  9 is the lowest quality.  Cannot be used with
+                  <varname>bitrate</varname>.
+                </entry>
+              </row>
+              <row>
+                <entry>
+                  <varname>bitrate</varname>
+                </entry>
+                <entry>
+                  Sets the bit rate in kilobit per second.  Cannot be
+                  used with <varname>quality</varname>.
+                </entry>
+              </row>
+            </tbody>
+          </tgroup>
+        </informaltable>
+      </section>
+
+      <section>
+        <title><varname>null</varname></title>
+
+        <para>
+          Does not encode anything, passes the input PCM data as-is.
+        </para>
+      </section>
+
+      <section>
+        <title><varname>twolame</varname></title>
+
+        <para>
+          Encodes into MP2 using the <filename>twolame</filename>
+          library.
+        </para>
+
+        <informaltable>
+          <tgroup cols="2">
+            <thead>
+              <row>
+                <entry>Setting</entry>
+                <entry>Description</entry>
+              </row>
+            </thead>
+            <tbody>
+              <row>
+                <entry>
+                  <varname>quality</varname>
+                </entry>
+                <entry>
+                  Sets the quality for VBR.  0 is the highest quality,
+                  9 is the lowest quality.  Cannot be used with
+                  <varname>bitrate</varname>.
+                </entry>
+              </row>
+              <row>
+                <entry>
+                  <varname>bitrate</varname>
+                </entry>
+                <entry>
+                  Sets the bit rate in kilobit per second.  Cannot be
+                  used with <varname>quality</varname>.
+                </entry>
+              </row>
+            </tbody>
+          </tgroup>
+        </informaltable>
+      </section>
+
+      <section>
+        <title><varname>vorbis</varname></title>
+
+        <para>
+          Encodes into Ogg Vorbis.
+        </para>
+
+        <informaltable>
+          <tgroup cols="2">
+            <thead>
+              <row>
+                <entry>Setting</entry>
+                <entry>Description</entry>
+              </row>
+            </thead>
+            <tbody>
+              <row>
+                <entry>
+                  <varname>quality</varname>
+                </entry>
+                <entry>
+                  Sets the quality for VBR.  -1 is the lowest quality,
+                  10 is the highest quality.  Cannot be used with
+                  <varname>bitrate</varname>.
+                </entry>
+              </row>
+              <row>
+                <entry>
+                  <varname>bitrate</varname>
+                </entry>
+                <entry>
+                  Sets the bit rate in kilobit per second.  Cannot be
+                  used with <varname>quality</varname>.
+                </entry>
+              </row>
+            </tbody>
+          </tgroup>
+        </informaltable>
+      </section>
+
+      <section>
+        <title><varname>wave</varname></title>
+
+        <para>
+          Encodes into WAV (lossless).
+        </para>
+      </section>
+    </section>
+
     <section>
       <title>Output plugins</title>
 
-- 
cgit v1.2.3