From ca7b4df812b8109911deb1e694fbea039f9818f5 Mon Sep 17 00:00:00 2001
From: Max Kellermann <max@musicpd.org>
Date: Thu, 7 Sep 2017 14:21:40 +0200
Subject: doc/user: document the Opus encoder

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

(limited to 'doc')

diff --git a/doc/user.xml b/doc/user.xml
index c5c7d341b..e010d5e3e 100644
--- a/doc/user.xml
+++ b/doc/user.xml
@@ -2991,6 +2991,60 @@ run</programlisting>
         </informaltable>
       </section>
 
+      <section id="opus_encoder">
+        <title><varname>opus</varname></title>
+
+        <para>
+          Encodes into <ulink
+          url="http://www.opus-codec.org/">Ogg Opus</ulink>.
+        </para>
+
+        <informaltable>
+          <tgroup cols="2">
+            <thead>
+              <row>
+                <entry>Setting</entry>
+                <entry>Description</entry>
+              </row>
+            </thead>
+            <tbody>
+              <row>
+                <entry>
+                  <varname>bitrate</varname>
+                </entry>
+                <entry>
+                  Sets the data rate in bit per second.  The special
+                  value "auto" lets <application>libopus</application>
+                  choose a rate (which is the default), and "max" uses
+                  the maximum possible data rate.
+                </entry>
+              </row>
+
+              <row>
+                <entry>
+                  <varname>complexity</varname>
+                </entry>
+                <entry>
+                  Sets the <ulink
+                  url="https://wiki.xiph.org/OpusFAQ#What_is_the_complexity_of_Opus.3F">Opus
+                  complexity</ulink>.
+                </entry>
+              </row>
+
+              <row>
+                <entry>
+                  <varname>signal</varname>
+                </entry>
+                <entry>
+                  Sets the Opus signal type.  Valid values are "auto"
+                  (the default), "voice" and "music".
+                </entry>
+              </row>
+            </tbody>
+          </tgroup>
+        </informaltable>
+      </section>
+
       <section id="vorbis_encoder">
         <title><varname>vorbis</varname></title>
 
-- 
cgit v1.2.3