summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMax Kellermann <max@duempel.org>2009-03-15 03:32:34 +0100
committerMax Kellermann <max@duempel.org>2009-03-15 03:32:34 +0100
commite62580db0bab0650f088f9f45c66657d18dfb679 (patch)
tree19c0deec7b75ea7fe2513c674c7de3fe2647fa7c /doc
parent565afefc66b7753ed27f6b7febaf32667c38c44a (diff)
httpd: new output plugin to replace "shout"
Let's get rid of the "shout" plugin, and the awfully complicated icecast daemon setup! MPD can do better if it's doing the HTTP server stuff on its own. This new plugin has several advantages: - easier to set up - only one daemon, no password settings, no mount settings - MPD controls the encoder and thus already knows the packet boundaries - icecast has to parse them - MPD doesn't bother to encode data while nobody is listening This implementation is very experimental (no header parsing, ignores request URI, no icy-metadata, ...). It should be able to suport several encoders in parallel in the future (with different bit rates, different codec, ...), to make MPD the perfect streaming server. Once MPD gets multi-player support, we can even mount several different radio stations on one server.
Diffstat (limited to 'doc')
-rw-r--r--doc/mpdconf.example12
-rw-r--r--doc/user.xml71
2 files changed, 83 insertions, 0 deletions
diff --git a/doc/mpdconf.example b/doc/mpdconf.example
index f7816e4ae..3af0567d6 100644
--- a/doc/mpdconf.example
+++ b/doc/mpdconf.example
@@ -198,6 +198,18 @@ log_file "~/.mpd/log"
# timeout "2" # optional
#}
#
+# An example of a httpd output (built-in HTTP streaming server):
+#
+#audio_output {
+# type "httpd"
+# name "My HTTP Stream"
+# encoder "ogg" # optional
+# port "8000"
+# quality "5.0"
+# bitrate "128"
+# format "44100:16:1"
+#}
+#
# An example of a pulseaudio output (streaming to a remote pulseaudio server)
#
#audio_output {
diff --git a/doc/user.xml b/doc/user.xml
index 06dc087f0..6837181a9 100644
--- a/doc/user.xml
+++ b/doc/user.xml
@@ -252,6 +252,77 @@ cd mpd-0.14.2</programlisting>
</section>
<section>
+ <title><varname>httpd</varname></title>
+
+ <para>
+ The <varname>httpd</varname> plugin creates a HTTP server,
+ similar to ShoutCast / IceCast. HTTP streaming clients like
+ <filename>mplayer</filename> can connect to it.
+ </para>
+
+ <para>
+ You must configure either <varname>quality</varname> or
+ <varname>bitrate</varname>. It is highly recommended to
+ configure a fixed <varname>format</varname>, because a
+ stream cannot switch its audio format on-the-fly when the
+ song changes.
+ </para>
+
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Setting</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <varname>port</varname>
+ <parameter>P</parameter>
+ </entry>
+ <entry>
+ Binds the HTTP server to the specified port (on all
+ interfaces).
+ </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>null</varname></title>
<para>