aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorEric Wollesen <encoded@xmtp.net>2008-09-12 16:04:40 +0200
committerMax Kellermann <max@duempel.org>2008-09-12 16:04:40 +0200
commit4970c42c8675ff6a992f159dc97837d3c0e2d35e (patch)
tree811bec6ed60c049bd53090456d6cec8933280cd3 /doc
parent43ee3c3b366e6a8df088a5684431403f09138ffa (diff)
downloadmpd-4970c42c8675ff6a992f159dc97837d3c0e2d35e.tar.gz
mpd-4970c42c8675ff6a992f159dc97837d3c0e2d35e.tar.xz
mpd-4970c42c8675ff6a992f159dc97837d3c0e2d35e.zip
shout: introduce pluggable encoder API
I've perhaps gone a bit overboard, but here's the current rundown: Both Ogg and MP3 use the "shout" audio output plugin. The shout audio output plugin itself has two new plugins, one for the Ogg encoder, and another for the MP3 (LAME) encoder. Configuration for an Ogg stream doesn't change. For an MP3 stream, configuration is the same as Ogg, with two exceptions. First, you must specify the optional "encoding" parameter, which should be set to "mp3". See mpd.conf(5) for more details. Second, the "quality" parameter is reversed for LAME, such that 1 is high quality for LAME, whereas 10 is high quality for Ogg. I've decomposed the code so that all libshout related operations are done in audioOutput_shout.c, all Ogg specific functions are in audioOutput_shout_ogg.c, and of course then all LAME specific functions are handled in audioOutput_shout_mp3.c. To develop encoder plugins for the shout audio output plugin, I basically just mimicked the plugin system used for audio outputs. This might be overkill, but hopefully if anyone ever wants to support some other sort of stream, like maybe AAC, FLAC, or WMA (hey it could happen), they will hopefully be all set. The Ogg encoder is slightly less optimal under this configuration. It used to send shout data directly out of its ogg_page structures. Now, in the interest of encapsulation, it copies the data from its ogg_page structures into a buffer provided by the shout audio output plugin (see audioOutput_shout_ogg.c, line 77.) I suspect the performance impact is negligible. As for metadata, I'm pretty sure they'll both work. I wrote up a test scaffold that would create a fake tag, and tell the plugin to send it out to the stream every few seconds. It seemed to work fine. Of course, if something does break, I'll be glad to fix it. Lastly, I've renamed lots of things into snake_case, in keeping with normalperson's wishes in that regard. [mk: moved the MP3 patch after this one. Splitted this patch into several parts; the others were already applied before this one. Fixed a bunch GCC warnings and wrong whitespace modifications. Made it compile with mpd-mk by adapting to its prototypes]
Diffstat (limited to 'doc')
-rw-r--r--doc/mpd.conf.510
-rw-r--r--doc/mpdconf.example1
2 files changed, 9 insertions, 2 deletions
diff --git a/doc/mpd.conf.5 b/doc/mpd.conf.5
index 371c0d774..5a77d4944 100644
--- a/doc/mpd.conf.5
+++ b/doc/mpd.conf.5
@@ -365,9 +365,11 @@ This specifies the icecast mountpoint to use.
This specifies the password to use when logging in to the icecast server.
.TP
.B quality <quality>
-This specifies the ogg encoding quality to use. The value must be between 0
+This specifies the encoding quality to use. The value must be between 0
and 10. Fractional values, such as 2.5, are permitted. Either the quality or
-the bitrate parameter must be specified, but not both.
+the bitrate parameter must be specified, but not both. For Ogg, a
+higher quality number produces higher quality output. For MP3, it's
+just the opposite, with lower numbers producing higher quality output.
.TP
.B bitrate <kbps>
This specifies the bitrate to use for encoding. Either the quality or the
@@ -378,6 +380,10 @@ This specifies the sample rate, bits per sample, and number of channels to use
for encoding.
.SH OPTIONAL SHOUT OUTPUT PARAMETERS
.TP
+.B encoding <encoding>
+This specifies which output encoding to use. Should be either "ogg"
+or "mp3". The default is "ogg".
+.TP
.B user <username>
This specifies the username to use when logging in to the icecast server. The
default is "source".
diff --git a/doc/mpdconf.example b/doc/mpdconf.example
index be04adb91..995bba3aa 100644
--- a/doc/mpdconf.example
+++ b/doc/mpdconf.example
@@ -112,6 +112,7 @@ error_file "~/.mpd/mpd.error"
#
#audio_output {
# type "shout"
+# encoding "ogg"
# name "My Shout Stream"
# host "localhost"
# port "8000"