2008-09-12 14:59:53 +02:00
|
|
|
/* the Music Player Daemon (MPD)
|
|
|
|
* Copyright (C) 2003-2007 by Warren Dukes (warren.dukes@gmail.com)
|
|
|
|
* This project's homepage is: http://www.musicpd.org
|
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program; if not, write to the Free Software
|
|
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef AUDIO_OUTPUT_SHOUT_H
|
|
|
|
#define AUDIO_OUTPUT_SHOUT_H
|
|
|
|
|
|
|
|
#include "../output_api.h"
|
|
|
|
|
|
|
|
#ifdef HAVE_SHOUT
|
|
|
|
|
|
|
|
#include "../conf.h"
|
|
|
|
#include "../timer.h"
|
|
|
|
|
|
|
|
#include <shout/shout.h>
|
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]
2008-09-12 16:04:40 +02:00
|
|
|
|
2008-09-12 16:38:54 +02:00
|
|
|
#define DISABLED_SHOUT_ENCODER_PLUGIN(plugin) \
|
|
|
|
struct shout_encoder_plugin plugin;
|
|
|
|
|
|
|
|
struct shout_data;
|
|
|
|
|
|
|
|
struct shout_encoder_plugin {
|
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]
2008-09-12 16:04:40 +02:00
|
|
|
const char *name;
|
|
|
|
unsigned int shout_format;
|
|
|
|
|
2008-09-12 16:38:54 +02:00
|
|
|
int (*clear_encoder_func)(struct shout_data *sd);
|
|
|
|
int (*encode_func)(struct shout_data *sd,
|
|
|
|
const char *chunk, size_t len);
|
|
|
|
void (*finish_func)(struct shout_data *sd);
|
|
|
|
int (*init_func)(struct shout_data *sd);
|
|
|
|
int (*init_encoder_func) (struct shout_data *sd);
|
|
|
|
/* Called when there is a new MpdTag to encode into the
|
|
|
|
stream. If this function returns non-zero, then the
|
|
|
|
resulting song will be passed to the shout server as
|
|
|
|
metadata. This allows the Ogg encoder to send metadata via
|
|
|
|
Vorbis comments in the stream, while an MP3 encoder can use
|
|
|
|
the Shout Server's metadata API. */
|
|
|
|
int (*send_metadata_func)(struct shout_data *sd,
|
|
|
|
char *song, size_t size);
|
|
|
|
};
|
2008-09-12 14:59:53 +02:00
|
|
|
|
2008-09-12 16:38:54 +02:00
|
|
|
struct shout_buffer {
|
2008-09-12 16:41:20 +02:00
|
|
|
unsigned char data[8192];
|
2008-09-12 15:57:43 +02:00
|
|
|
size_t len;
|
2008-09-12 16:38:54 +02:00
|
|
|
};
|
2008-09-12 15:57:43 +02:00
|
|
|
|
2008-09-12 15:59:55 +02:00
|
|
|
struct shout_data {
|
|
|
|
shout_t *shout_conn;
|
2008-09-12 16:00:01 +02:00
|
|
|
shout_metadata_t *shout_meta;
|
2008-09-12 15:59:55 +02:00
|
|
|
int shout_error;
|
|
|
|
|
2008-09-12 16:39:53 +02:00
|
|
|
const struct shout_encoder_plugin *encoder;
|
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]
2008-09-12 16:04:40 +02:00
|
|
|
void *encoder_data;
|
2008-09-12 14:59:53 +02:00
|
|
|
|
|
|
|
float quality;
|
|
|
|
int bitrate;
|
|
|
|
|
|
|
|
int opened;
|
|
|
|
|
|
|
|
struct tag *tag;
|
|
|
|
int tag_to_send;
|
|
|
|
|
|
|
|
int timeout;
|
|
|
|
int conn_attempts;
|
|
|
|
time_t last_attempt;
|
|
|
|
|
|
|
|
Timer *timer;
|
|
|
|
|
|
|
|
/* the configured audio format */
|
|
|
|
struct audio_format audio_format;
|
|
|
|
|
2008-09-12 16:38:54 +02:00
|
|
|
struct shout_buffer buf;
|
2008-09-12 15:57:43 +02:00
|
|
|
};
|
2008-09-12 15:02:57 +02:00
|
|
|
|
2008-09-12 16:39:53 +02:00
|
|
|
extern const struct shout_encoder_plugin shout_mp3_encoder;
|
|
|
|
extern const struct shout_encoder_plugin shout_ogg_encoder;
|
2008-09-12 15:02:57 +02:00
|
|
|
|
2008-09-12 14:59:53 +02:00
|
|
|
#endif
|
|
|
|
|
|
|
|
#endif
|