/*****************************************************************************
- * shout.c
+ * shout.c: This module forwards vorbis streams to an icecast server
*****************************************************************************
- * Copyright (C) 2005 VideoLAN
+ * Copyright (C) 2005 the VideoLAN team
* $Id$
*
* Authors: Daniel Fischer <dan at subsignal dot org>
+ * Derk-Jan Hartman <hartman at videolan dot 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
*
* 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, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
/*****************************************************************************
* Some Comments:
*
- * o this only works for ogg streams, and there's no checking about that yet.
- * o i have lots of problems with audio, but i think they are not caused
- * by this patch
- * o there's a memleak somewhere, quite huge. i'm unsure if its somewhere
- * in libshout, in vlc or even in this patch...
+ * - this only works for ogg and/or mp3, and we don't check this yet.
+ * - MP3 metadata is not passed along, since metadata is only available after
+ * this module is opened.
*
* Typical usage:
*
* vlc v4l:/dev/video:input=2:norm=pal:size=192x144 \
* --sout '#transcode{vcodec=theora,vb=300,acodec=vorb,ab=96}\
- * :std{access=shout,mux=ogg,url=localhost:8005}'
+ * :std{access=shout,mux=ogg,dst=localhost:8005}'
*
*****************************************************************************/
/*****************************************************************************
* Preamble
*****************************************************************************/
-#include <string.h>
-#include <vlc/vlc.h>
-#include <vlc/sout.h>
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <vlc_common.h>
+#include <vlc_plugin.h>
+#include <vlc_sout.h>
+#include <vlc_block.h>
#include <shout/shout.h>
#define SOUT_CFG_PREFIX "sout-shout-"
-vlc_module_begin();
- set_description( _("libshout (icecast) output") );
- set_shortname( N_("Shout" ));
- set_capability( "sout access", 50 );
- set_category( CAT_SOUT );
- set_subcategory( SUBCAT_SOUT_ACO );
- add_shortcut( "shout" );
- set_callbacks( Open, Close );
-vlc_module_end();
+#define NAME_TEXT N_("Stream name")
+#define NAME_LONGTEXT N_("Name to give to this stream/channel on the " \
+ "shoutcast/icecast server." )
+
+#define DESCRIPTION_TEXT N_("Stream description")
+#define DESCRIPTION_LONGTEXT N_("Description of the stream content or " \
+ "information about your channel." )
+
+#define MP3_TEXT N_("Stream MP3")
+#define MP3_LONGTEXT N_("You normally have to feed the shoutcast module " \
+ "with Ogg streams. It is also possible to stream " \
+ "MP3 instead, so you can forward MP3 streams to " \
+ "the shoutcast/icecast server." )
+
+/* To be listed properly as a public stream on the Yellow Pages of shoutcast/icecast
+ the genres should match those used on the corresponding sites. Several examples
+ are Alternative, Classical, Comedy, Country etc. */
+
+#define GENRE_TEXT N_("Genre description")
+#define GENRE_LONGTEXT N_("Genre of the content. " )
+
+#define URL_TEXT N_("URL description")
+#define URL_LONGTEXT N_("URL with information about the stream or your channel. " )
+
+/* The shout module only "transmits" data. It does not have direct access to
+ "codec level" information. Stream information such as bitrate, samplerate,
+ channel numbers and quality (in case of Ogg streaming) need to be set manually */
+
+#define BITRATE_TEXT N_("Bitrate")
+#define BITRATE_LONGTEXT N_("Bitrate information of the transcoded stream. " )
+
+#define SAMPLERATE_TEXT N_("Samplerate")
+#define SAMPLERATE_LONGTEXT N_("Samplerate information of the transcoded stream. " )
+
+#define CHANNELS_TEXT N_("Number of channels")
+#define CHANNELS_LONGTEXT N_("Number of channels information of the transcoded stream. " )
+
+#define QUALITY_TEXT N_("Ogg Vorbis Quality")
+#define QUALITY_LONGTEXT N_("Ogg Vorbis Quality information of the transcoded stream. " )
+
+#define PUBLIC_TEXT N_("Stream public")
+#define PUBLIC_LONGTEXT N_("Make the server publicly available on the 'Yellow Pages' " \
+ "(directory listing of streams) on the icecast/shoutcast " \
+ "website. Requires the bitrate information specified for " \
+ "shoutcast. Requires Ogg streaming for icecast." )
+
+vlc_module_begin ()
+ set_description( N_("IceCAST output") )
+ set_shortname( "Shoutcast" )
+ set_capability( "sout access", 50 )
+ set_category( CAT_SOUT )
+ set_subcategory( SUBCAT_SOUT_ACO )
+ add_shortcut( "shout" )
+ add_string( SOUT_CFG_PREFIX "name", "VLC media player - Live stream", NULL,
+ NAME_TEXT, NAME_LONGTEXT, false )
+ add_string( SOUT_CFG_PREFIX "description",
+ "Live stream from VLC media player", NULL,
+ DESCRIPTION_TEXT, DESCRIPTION_LONGTEXT, false )
+ add_bool( SOUT_CFG_PREFIX "mp3", false, NULL,
+ MP3_TEXT, MP3_LONGTEXT, true )
+ add_string( SOUT_CFG_PREFIX "genre", "Alternative", NULL,
+ GENRE_TEXT, GENRE_LONGTEXT, false )
+ add_string( SOUT_CFG_PREFIX "url", "http://www.videolan.org/vlc", NULL,
+ URL_TEXT, URL_LONGTEXT, false )
+ add_string( SOUT_CFG_PREFIX "bitrate", "", NULL,
+ BITRATE_TEXT, BITRATE_LONGTEXT, false )
+ add_string( SOUT_CFG_PREFIX "samplerate", "", NULL,
+ SAMPLERATE_TEXT, SAMPLERATE_LONGTEXT, false )
+ add_string( SOUT_CFG_PREFIX "channels", "", NULL,
+ CHANNELS_TEXT, CHANNELS_LONGTEXT, false )
+ add_string( SOUT_CFG_PREFIX "quality", "", NULL,
+ QUALITY_TEXT, QUALITY_LONGTEXT, false )
+ add_bool( SOUT_CFG_PREFIX "public", false, NULL,
+ PUBLIC_TEXT, PUBLIC_LONGTEXT, true )
+ set_callbacks( Open, Close )
+vlc_module_end ()
+
+/*****************************************************************************
+ * Exported prototypes
+ *****************************************************************************/
+static const char *const ppsz_sout_options[] = {
+ "name", "description", "mp3", "genre", "url", "bitrate", "samplerate",
+ "channels", "quality", "public", NULL
+};
/*****************************************************************************
* Exported prototypes
*****************************************************************************/
-static int Write( sout_access_out_t *, block_t * );
+static ssize_t Write( sout_access_out_t *, block_t * );
static int Seek ( sout_access_out_t *, off_t );
-static int Read ( sout_access_out_t *, block_t * );
+static int Control( sout_access_out_t *, int, va_list );
struct sout_access_out_sys_t
{
sout_access_out_sys_t *p_sys;
shout_t *p_shout;
long i_ret;
-
- char *psz_user, *psz_pass, *psz_host, *psz_mount;
unsigned int i_port;
-
- char *parser = strdup( p_access->psz_name );
- char *tmp_port;
-
- if( !p_access->psz_name )
+ vlc_value_t val;
+
+ char *psz_accessname = NULL;
+ char *psz_parser = NULL;
+ char *psz_user = NULL;
+ char *psz_pass = NULL;
+ char *psz_host = NULL;
+ char *psz_mount = NULL;
+ char *psz_name = NULL;
+ char *psz_description = NULL;
+ char *tmp_port = NULL;
+ char *psz_genre = NULL;
+ char *psz_url = NULL;
+
+ config_ChainParse( p_access, SOUT_CFG_PREFIX, ppsz_sout_options, p_access->p_cfg );
+
+ if( !p_access->psz_path )
{
msg_Err( p_access,
"please specify url=user:password@host:port/mountpoint" );
return VLC_EGENERIC;
}
+ psz_accessname = psz_parser = strdup( p_access->psz_path );
+ if( !psz_parser )
+ return VLC_ENOMEM;
+
/* Parse connection data user:pwd@host:port/mountpoint */
- psz_user = parser;
- while( parser[0] && parser[0] != ':' ) parser++;
- if( parser[0] ) { parser[0] = 0; parser++; }
- psz_pass = parser;
- while( parser[0] && parser[0] != '@' ) parser++;
- if( parser[0] ) { parser[0] = 0; parser++; }
- psz_host = parser;
- while( parser[0] && parser[0] != ':' ) parser++;
- if( parser[0] ) { parser[0] = 0; parser++; }
- tmp_port = parser;
- while( parser[0] && parser[0] != '/' ) parser++;
- if( parser[0] ) { parser[0] = 0; parser++; }
- psz_mount = parser;
+ psz_user = psz_parser;
+ while( psz_parser[0] && psz_parser[0] != ':' ) psz_parser++;
+ if( psz_parser[0] ) { psz_parser[0] = 0; psz_parser++; }
+ psz_pass = psz_parser;
+ while( psz_parser[0] && psz_parser[0] != '@' ) psz_parser++;
+ if( psz_parser[0] ) { psz_parser[0] = 0; psz_parser++; }
+ psz_host = psz_parser;
+ while( psz_parser[0] && psz_parser[0] != ':' ) psz_parser++;
+ if( psz_parser[0] ) { psz_parser[0] = 0; psz_parser++; }
+ tmp_port = psz_parser;
+ while( psz_parser[0] && psz_parser[0] != '/' ) psz_parser++;
+ if( psz_parser[0] ) { psz_parser[0] = 0; psz_parser++; }
+ psz_mount = psz_parser;
i_port = atoi( tmp_port );
p_sys = p_access->p_sys = malloc( sizeof( sout_access_out_sys_t ) );
if( !p_sys )
{
- msg_Err( p_access, "out of memory" );
- free( parser );
+ free( psz_accessname );
return VLC_ENOMEM;
}
+ var_Get( p_access, SOUT_CFG_PREFIX "name", &val );
+ if( *val.psz_string )
+ psz_name = val.psz_string;
+ else
+ free( val.psz_string );
+
+ var_Get( p_access, SOUT_CFG_PREFIX "description", &val );
+ if( *val.psz_string )
+ psz_description = val.psz_string;
+ else
+ free( val.psz_string );
+
+ var_Get( p_access, SOUT_CFG_PREFIX "genre", &val );
+ if( *val.psz_string )
+ psz_genre = val.psz_string;
+ else
+ free( val.psz_string );
+
+ var_Get( p_access, SOUT_CFG_PREFIX "url", &val );
+ if( *val.psz_string )
+ psz_url = val.psz_string;
+ else
+ free( val.psz_string );
+
p_shout = p_sys->p_shout = shout_new();
if( !p_shout
|| shout_set_host( p_shout, psz_host ) != SHOUTERR_SUCCESS
- || shout_set_protocol( p_shout, SHOUT_PROTOCOL_HTTP )
- != SHOUTERR_SUCCESS
+ || shout_set_protocol( p_shout, SHOUT_PROTOCOL_ICY ) != SHOUTERR_SUCCESS
|| shout_set_port( p_shout, i_port ) != SHOUTERR_SUCCESS
|| shout_set_password( p_shout, psz_pass ) != SHOUTERR_SUCCESS
|| shout_set_mount( p_shout, psz_mount ) != SHOUTERR_SUCCESS
|| shout_set_user( p_shout, psz_user ) != SHOUTERR_SUCCESS
- || shout_set_format( p_shout, SHOUT_FORMAT_OGG ) != SHOUTERR_SUCCESS
- // || shout_set_nonblocking( p_shout, 1 ) != SHOUTERR_SUCCESS
+ || shout_set_agent( p_shout, "VLC media player " VERSION ) != SHOUTERR_SUCCESS
+ || shout_set_name( p_shout, psz_name ) != SHOUTERR_SUCCESS
+ || shout_set_description( p_shout, psz_description ) != SHOUTERR_SUCCESS
+ || shout_set_genre( p_shout, psz_genre ) != SHOUTERR_SUCCESS
+ || shout_set_url( p_shout, psz_url ) != SHOUTERR_SUCCESS
+ /* || shout_set_nonblocking( p_shout, 1 ) != SHOUTERR_SUCCESS */
)
{
- msg_Err( p_access, "failed to initialize shout streaming to %s:%i%s",
+ msg_Err( p_access, "failed to initialize shout streaming to %s:%i/%s",
psz_host, i_port, psz_mount );
free( p_access->p_sys );
- free( parser );
+ free( psz_accessname );
+ free( psz_name );
+ free( psz_description );
+ free( psz_genre );
+ free( psz_url );
return VLC_EGENERIC;
}
- i_ret = shout_open( p_shout );
- if( i_ret == SHOUTERR_SUCCESS )
+ free( psz_name );
+ free( psz_description );
+ free( psz_genre );
+ free( psz_url );
+
+ var_Get( p_access, SOUT_CFG_PREFIX "mp3", &val );
+ if( val.b_bool == true )
+ i_ret = shout_set_format( p_shout, SHOUT_FORMAT_MP3 );
+ else
+ i_ret = shout_set_format( p_shout, SHOUT_FORMAT_OGG );
+
+ if( i_ret != SHOUTERR_SUCCESS )
{
- i_ret = SHOUTERR_CONNECTED;
+ msg_Err( p_access, "failed to set the shoutcast streaming format" );
+ free( p_access->p_sys );
+ free( psz_accessname );
+ return VLC_EGENERIC;
}
-/*
- for non-blocking, use:
- while( i_ret == SHOUTERR_BUSY )
+ /* Don't force bitrate to 0 but only use when specified. This will otherwise
+ show an empty field on icecast directory listing instead of NA */
+ var_Get( p_access, SOUT_CFG_PREFIX "bitrate", &val );
+ if( *val.psz_string )
+ {
+ i_ret = shout_set_audio_info( p_shout, SHOUT_AI_BITRATE, val.psz_string );
+ if( i_ret != SHOUTERR_SUCCESS )
+ {
+ msg_Err( p_access, "failed to set the information about the bitrate" );
+ free( val.psz_string );
+ free( p_access->p_sys );
+ free( psz_accessname );
+ return VLC_EGENERIC;
+ }
+ }
+ else
+ {
+ /* Bitrate information is used for icecast/shoutcast servers directory
+ listings (sorting, stream info etc.) */
+ msg_Warn( p_access, "no bitrate information specified (required for listing " \
+ "the server as public on the shoutcast website)" );
+ free( val.psz_string );
+ }
+
+ /* Information about samplerate, channels and quality will not be propagated
+ through the YP protocol for icecast to the public directory listing when
+ the icecast server is operating in shoutcast compatibility mode */
+
+ var_Get( p_access, SOUT_CFG_PREFIX "samplerate", &val );
+ if( *val.psz_string )
+ {
+ i_ret = shout_set_audio_info( p_shout, SHOUT_AI_SAMPLERATE, val.psz_string );
+ if( i_ret != SHOUTERR_SUCCESS )
+ {
+ msg_Err( p_access, "failed to set the information about the samplerate" );
+ free( val.psz_string );
+ free( p_access->p_sys );
+ free( psz_accessname );
+ return VLC_EGENERIC;
+ }
+ }
+ else
+ free( val.psz_string );
+
+ var_Get( p_access, SOUT_CFG_PREFIX "channels", &val );
+ if( *val.psz_string )
{
- sleep( 1 );
- i_ret = shout_get_connected( p_shout );
+ i_ret = shout_set_audio_info( p_shout, SHOUT_AI_CHANNELS, val.psz_string );
+ if( i_ret != SHOUTERR_SUCCESS )
+ {
+ msg_Err( p_access, "failed to set the information about the number of channels" );
+ free( val.psz_string );
+ free( p_access->p_sys );
+ free( psz_accessname );
+ return VLC_EGENERIC;
+ }
+ }
+ else
+ free( val.psz_string );
+
+ var_Get( p_access, SOUT_CFG_PREFIX "quality", &val );
+ if( *val.psz_string )
+ {
+ i_ret = shout_set_audio_info( p_shout, SHOUT_AI_QUALITY, val.psz_string );
+ if( i_ret != SHOUTERR_SUCCESS )
+ {
+ msg_Err( p_access, "failed to set the information about Ogg Vorbis quality" );
+ free( val.psz_string );
+ free( p_access->p_sys );
+ free( psz_accessname );
+ return VLC_EGENERIC;
+ }
}
+ else
+ free( val.psz_string );
+
+ var_Get( p_access, SOUT_CFG_PREFIX "public", &val );
+ if( val.b_bool == true )
+ {
+ i_ret = shout_set_public( p_shout, 1 );
+ if( i_ret != SHOUTERR_SUCCESS )
+ {
+ msg_Err( p_access, "failed to set the server status setting to public" );
+ free( p_access->p_sys );
+ free( psz_accessname );
+ return VLC_EGENERIC;
+ }
+ }
+
+ /* Connect at startup. Cycle through the possible protocols. */
+ i_ret = shout_get_connected( p_shout );
+ while ( i_ret != SHOUTERR_CONNECTED )
+ {
+ /* Shout parameters cannot be changed on an open connection */
+ i_ret = shout_close( p_shout );
+ if( i_ret == SHOUTERR_SUCCESS )
+ {
+ i_ret = SHOUTERR_UNCONNECTED;
+ }
+
+ /* Re-initialize for Shoutcast using ICY protocol. Not needed for initial connection
+ but it is when we are reconnecting after other protocol was tried. */
+ i_ret = shout_set_protocol( p_shout, SHOUT_PROTOCOL_ICY );
+ if( i_ret != SHOUTERR_SUCCESS )
+ {
+ msg_Err( p_access, "failed to set the protocol to 'icy'" );
+ free( p_access->p_sys );
+ free( psz_accessname );
+ return VLC_EGENERIC;
+ }
+ i_ret = shout_open( p_shout );
+ if( i_ret == SHOUTERR_SUCCESS )
+ {
+ i_ret = SHOUTERR_CONNECTED;
+ msg_Dbg( p_access, "connected using 'icy' (shoutcast) protocol" );
+ }
+ else
+ {
+ msg_Warn( p_access, "failed to connect using 'icy' (shoutcast) protocol" );
+
+ /* Shout parameters cannot be changed on an open connection */
+ i_ret = shout_close( p_shout );
+ if( i_ret == SHOUTERR_SUCCESS )
+ {
+ i_ret = SHOUTERR_UNCONNECTED;
+ }
+
+ /* IceCAST using HTTP protocol */
+ i_ret = shout_set_protocol( p_shout, SHOUT_PROTOCOL_HTTP );
+ if( i_ret != SHOUTERR_SUCCESS )
+ {
+ msg_Err( p_access, "failed to set the protocol to 'http'" );
+ free( p_access->p_sys );
+ free( psz_accessname );
+ return VLC_EGENERIC;
+ }
+ i_ret = shout_open( p_shout );
+ if( i_ret == SHOUTERR_SUCCESS )
+ {
+ i_ret = SHOUTERR_CONNECTED;
+ msg_Dbg( p_access, "connected using 'http' (icecast 2.x) protocol" );
+ }
+ else
+ msg_Warn( p_access, "failed to connect using 'http' (icecast 2.x) protocol " );
+ }
+/*
+ for non-blocking, use:
+ while( i_ret == SHOUTERR_BUSY )
+ {
+ sleep( 1 );
+ i_ret = shout_get_connected( p_shout );
+ }
*/
+ if ( i_ret != SHOUTERR_CONNECTED )
+ {
+ msg_Warn( p_access, "unable to establish connection, retrying..." );
+ msleep( 30000000 );
+ }
+ }
+
if( i_ret != SHOUTERR_CONNECTED )
{
- msg_Err( p_access, "failed to open shout stream to %s:%i%s: %s",
+ msg_Err( p_access, "failed to open shout stream to %s:%i/%s: %s",
psz_host, i_port, psz_mount, shout_get_error(p_shout) );
free( p_access->p_sys );
- free( parser );
+ free( psz_accessname );
return VLC_EGENERIC;
}
p_access->pf_write = Write;
- p_access->pf_read = Read;
p_access->pf_seek = Seek;
+ p_access->pf_control = Control;
- msg_Dbg( p_access, "shout access output opened (%s@%s:%i%s)",
+ msg_Dbg( p_access, "shout access output opened (%s@%s:%i/%s)",
psz_user, psz_host, i_port, psz_mount );
-
- /* Update pace control flag */
- if( p_access->psz_access && !strcmp( p_access->psz_access, "stream" ) )
- {
- p_access->p_sout->i_out_pace_nocontrol++;
- }
-
- /* FIXME: it should be free()d somewhere, but not here.... ? */
- //free( parser );
+ free( psz_accessname );
return VLC_SUCCESS;
}
shout_shutdown();
}
free( p_access->p_sys );
-
- /* Update pace control flag */
- if( p_access->psz_access && !strcmp( p_access->psz_access, "stream" ) )
- {
- p_access->p_sout->i_out_pace_nocontrol--;
- }
-
msg_Dbg( p_access, "shout access output closed" );
}
-/*****************************************************************************
- * Read: standard read -- not supported
- *****************************************************************************/
-static int Read( sout_access_out_t *p_access, block_t *p_buffer )
+static int Control( sout_access_out_t *p_access, int i_query, va_list args )
{
- msg_Err( p_access, "cannot read from shout" );
- return VLC_EGENERIC;
+ switch( i_query )
+ {
+ case ACCESS_OUT_CONTROLS_PACE:
+ {
+ bool *pb = va_arg( args, bool * );
+ *pb = strcmp( p_access->psz_access, "stream" );
+ break;
+ }
+
+ default:
+ return VLC_EGENERIC;
+ }
+ return VLC_SUCCESS;
}
/*****************************************************************************
* Write: standard write
*****************************************************************************/
-static int Write( sout_access_out_t *p_access, block_t *p_buffer )
+static ssize_t Write( sout_access_out_t *p_access, block_t *p_buffer )
{
size_t i_write = 0;
{
msg_Err( p_access, "cannot write to stream: %s",
shout_get_error(p_access->p_sys->p_shout) );
+
+ /* The most common cause seems to be a server disconnect, resulting in a
+ Socket Error which can only be fixed by closing and reconnecting.
+ Since we already began with a working connection, the most feasable
+ approach to get out of this error status is a (timed) reconnect approach. */
+ shout_close( p_access->p_sys->p_shout );
+ msg_Warn( p_access, "server unavailable? trying to reconnect..." );
+ /* Re-open the connection (protocol params have already been set) and re-sync */
+ if( shout_open( p_access->p_sys->p_shout ) == SHOUTERR_SUCCESS )
+ {
+ shout_sync( p_access->p_sys->p_shout );
+ msg_Warn( p_access, "reconnected to server" );
+ }
+ else
+ {
+ msg_Err( p_access, "failed to reconnect to server" );
+ block_ChainRelease (p_buffer);
+ return VLC_EGENERIC;
+ }
+
}
block_Release( p_buffer );
projects / vlc / blobdiff