From a7a686f4ad662cf50ede65cee8712721c324cf9d Mon Sep 17 00:00:00 2001
From: Stein Magnus Jodal <stein.magnus@jodal.no>
Date: Thu, 9 Jun 2011 15:18:29 +0200
Subject: [PATCH] docs: How to use the SHOUTcast output

---
 docs/settings.rst  | 26 +++++++++++++++++++++
 mopidy/settings.py | 56 ++++++++++++++++++++++++++++------------------
 2 files changed, 60 insertions(+), 22 deletions(-)

diff --git a/docs/settings.rst b/docs/settings.rst
index 1d4a4972..917a71ba 100644
--- a/docs/settings.rst
+++ b/docs/settings.rst
@@ -92,6 +92,7 @@ To make a ``tag_cache`` of your local music available for Mopidy:
 
 .. _use_mpd_on_a_network:
 
+
 Connecting from other machines on the network
 =============================================
 
@@ -119,6 +120,31 @@ file::
     LASTFM_PASSWORD = u'mysecret'
 
 
+Streaming audio through a SHOUTcast/Icecast server
+==================================================
+
+If you want to play the audio on another computer than the one running Mopidy,
+you can stream the audio from Mopidy through an SHOUTcast or Icecast audio
+streaming server. Multiple media players can then be connected to the streaming
+server simultaneously. To use the SHOUTcast output, do the following:
+
+#. Install, configure and start the Icecast server. It can be found in the
+   ``icecast2`` package in Debian/Ubuntu.
+
+#. Add ``mopidy.outputs.shoutcast.ShoutcastOutput`` output to the
+   :attr:`mopidy.settings.OUTPUTS` setting.
+
+#. Check the default values for the following settings, and alter them to match
+   your Icecast setup if needed:
+
+   - :attr:`mopidy.settings.SHOUTCAST_OUTPUT_HOSTNAME`
+   - :attr:`mopidy.settings.SHOUTCAST_OUTPUT_PORT`
+   - :attr:`mopidy.settings.SHOUTCAST_OUTPUT_USERNAME`
+   - :attr:`mopidy.settings.SHOUTCAST_OUTPUT_PASSWORD`
+   - :attr:`mopidy.settings.SHOUTCAST_OUTPUT_MOUNT`
+   - :attr:`mopidy.settings.SHOUTCAST_OUTPUT_ENCODER`
+
+
 Available settings
 ==================
 
diff --git a/mopidy/settings.py b/mopidy/settings.py
index f92f51ca..6721e0a6 100644
--- a/mopidy/settings.py
+++ b/mopidy/settings.py
@@ -157,16 +157,16 @@ MIXER_MAX_VOLUME = 100
 #:     Listens on all interfaces, both IPv4 and IPv6.
 MPD_SERVER_HOSTNAME = u'127.0.0.1'
 
-#: The password required for connecting to the MPD server.
-#:
-#: Default: :class:`None`, which means no password required.
-MPD_SERVER_PASSWORD = None
-
 #: Which TCP port Mopidy's MPD server should listen to.
 #:
 #: Default: 6600
 MPD_SERVER_PORT = 6600
 
+#: The password required for connecting to the MPD server.
+#:
+#: Default: :class:`None`, which means no password required.
+MPD_SERVER_PASSWORD = None
+
 #: List of outputs to use. See :mod:`mopidy.outputs` for all available
 #: backends
 #:
@@ -179,42 +179,54 @@ OUTPUTS = (
     u'mopidy.outputs.local.LocalOutput',
 )
 
-#: Servar that runs Shoutcast server to send stream to.
+#: Hostname of the SHOUTcast server which Mopidy should stream audio to.
+#:
+#: Used by :mod:`mopidy.outputs.shoutcast`.
 #:
 #: Default::
 #:
 #:    SHOUTCAST_OUTPUT_HOSTNAME = u'127.0.0.1'
 SHOUTCAST_OUTPUT_HOSTNAME = u'127.0.0.1'
 
-#: User to authenticate as against Shoutcast server.
+#: Port of the SHOUTcast server.
 #:
-#: Default::
-#:
-#:    SHOUTCAST_OUTPUT_USERNAME = u'source'
-SHOUTCAST_OUTPUT_USERNAME = u'source'
-
-#: Password to authenticate with against Shoutcast server.
-#:
-#: Default::
-#:
-#:    SHOUTCAST_OUTPUT_PASSWORD = u'hackme'
-SHOUTCAST_OUTPUT_PASSWORD = u'hackme'
-
-#: Port to use for streaming to Shoutcast server.
+#: Used by :mod:`mopidy.outputs.shoutcast`.
 #:
 #: Default::
 #:
 #:    SHOUTCAST_OUTPUT_PORT = 8000
 SHOUTCAST_OUTPUT_PORT = 8000
 
-#: Mountpoint to use for the stream on the Shoutcast server.
+#: User to authenticate as against SHOUTcast server.
+#:
+#: Used by :mod:`mopidy.outputs.shoutcast`.
+#:
+#: Default::
+#:
+#:    SHOUTCAST_OUTPUT_USERNAME = u'source'
+SHOUTCAST_OUTPUT_USERNAME = u'source'
+
+#: Password to authenticate with against SHOUTcast server.
+#:
+#: Used by :mod:`mopidy.outputs.shoutcast`.
+#:
+#: Default::
+#:
+#:    SHOUTCAST_OUTPUT_PASSWORD = u'hackme'
+SHOUTCAST_OUTPUT_PASSWORD = u'hackme'
+
+#: Mountpoint to use for the stream on the SHOUTcast server.
+#:
+#: Used by :mod:`mopidy.outputs.shoutcast`.
 #:
 #: Default::
 #:
 #:    SHOUTCAST_OUTPUT_MOUNT = u'/stream'
 SHOUTCAST_OUTPUT_MOUNT = u'/stream'
 
-#: Encoder to use to process audio data before streaming.
+#: Encoder to use to process audio data before streaming to SHOUTcast server.
+#:
+#: Used by :mod:`mopidy.outputs.shoutcast`.
 #:
 #: Default::
 #: