• Eric Wollesen's avatar
    shout: introduce pluggable encoder API · 4970c42c
    Eric Wollesen authored
    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]
    4970c42c
mpdconf.example 9.22 KB