From 4a0d4a02a64774c61840496c8141b89ed31d1d94 Mon Sep 17 00:00:00 2001
From: Max Kellermann <max@duempel.org>
Date: Mon, 24 Aug 2009 18:57:06 +0200
Subject: output/recorder: new output plugin for recording radio streams

The recorder plugin writes audio played by MPD to a file.  This may be
useful for recording radio streams.

This implementation is incomplete, because support for tags is
missing, and MPD should be able to record each track to a different
file.
---
 doc/mpdconf.example | 12 ++++++++++
 doc/user.xml        | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 79 insertions(+)

(limited to 'doc')

diff --git a/doc/mpdconf.example b/doc/mpdconf.example
index 1dce635b2..4e3b19a5a 100644
--- a/doc/mpdconf.example
+++ b/doc/mpdconf.example
@@ -226,6 +226,18 @@ input {
 #	mixer_type      "software"		# optional
 #}
 #
+# An example of a recorder output:
+#
+#audio_output {
+#	type		"recorder"
+#	name		"My recorder"
+#	encoder		"vorbis"		# optional, vorbis or lame
+#	path		"/var/lib/mpd/recorder/mpd.ogg"
+#	quality		"5.0"			# do not define if bitrate is defined
+#	bitrate		"128"			# do not define if quality is defined
+#	format		"44100:16:1"
+#}
+#
 # An example of a httpd output (built-in HTTP streaming server):
 #
 #audio_output {
diff --git a/doc/user.xml b/doc/user.xml
index 6e039ebde..853417040 100644
--- a/doc/user.xml
+++ b/doc/user.xml
@@ -834,6 +834,73 @@ cd mpd-version</programlisting>
         </informaltable>
       </section>
 
+      <section>
+        <title><varname>recorder</varname></title>
+
+        <para>
+          The <varname>recorder</varname> plugin writes the audio
+          played by MPD to a file.  This may be useful for recording
+          radio streams.
+        </para>
+
+        <para>
+          You must configure either <varname>quality</varname> or
+          <varname>bitrate</varname>.
+        </para>
+
+        <informaltable>
+          <tgroup cols="2">
+            <thead>
+              <row>
+                <entry>Setting</entry>
+                <entry>Description</entry>
+              </row>
+            </thead>
+            <tbody>
+              <row>
+                <entry>
+                  <varname>path</varname>
+                  <parameter>P</parameter>
+                </entry>
+                <entry>
+                  Write to this file.
+                </entry>
+              </row>
+              <row>
+                <entry>
+                  <varname>encoder</varname>
+                  <parameter>NAME</parameter>
+                </entry>
+                <entry>
+                  Chooses an encoder plugin,
+                  e.g. <parameter>vorbis</parameter>.
+                </entry>
+              </row>
+              <row>
+                <entry>
+                  <varname>quality</varname>
+                  <parameter>Q</parameter>
+                </entry>
+                <entry>
+                  Configures the encoder quality (for VBR) in the
+                  range -1 .. 10.
+                </entry>
+              </row>
+              <row>
+                <entry>
+                  <varname>bitrate</varname>
+                  <parameter>BR</parameter>
+                </entry>
+                <entry>
+                  Sets a constant encoder bit rate, in kilobit per
+                  second.
+                </entry>
+              </row>
+            </tbody>
+          </tgroup>
+        </informaltable>
+      </section>
+
       <section>
         <title><varname>shout</varname></title>
 
-- 
cgit v1.2.3