modules/access_output/shout.c

   1 /*****************************************************************************
   2  * shout.c: This module forwards vorbis streams to an icecast server
   3  *****************************************************************************
   4  * Copyright (C) 2005 VLC authors and VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Daniel Fischer <dan at subsignal dot org>
   8  *          Derk-Jan Hartman <hartman at videolan dot org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify it
  11  * under the terms of the GNU Lesser General Public License as published by
  12  * the Free Software Foundation; either version 2.1 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public License
  21  * along with this program; if not, write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 /*****************************************************************************
  26  * Some Comments:
  27  *
  28  * - this only works for ogg and/or mp3, and we don't check this yet.
  29  * - MP3 metadata is not passed along, since metadata is only available after
  30  *   this module is opened.
  31  *
  32  * Typical usage:
  33  *
  34  * vlc v4l:/dev/video:input=2:norm=pal:size=192x144 \
  35  * --sout '#transcode{vcodec=theora,vb=300,acodec=vorb,ab=96}\
  36  * :std{access=shout,mux=ogg,dst=localhost:8005}'
  37  *
  38  *****************************************************************************/
  39
  40 /*****************************************************************************
  41  * Preamble
  42  *****************************************************************************/
  43
  44 #ifdef HAVE_CONFIG_H
  45 # include "config.h"
  46 #endif
  47
  48 #include <vlc_common.h>
  49 #include <vlc_plugin.h>
  50 #include <vlc_sout.h>
  51 #include <vlc_block.h>
  52 #include <vlc_url.h>
  53
  54 #include <shout/shout.h>
  55
  56 /*****************************************************************************
  57  * Module descriptor
  58  *****************************************************************************/
  59 static int  Open ( vlc_object_t * );
  60 static void Close( vlc_object_t * );
  61
  62 #define SOUT_CFG_PREFIX "sout-shout-"
  63
  64 #define NAME_TEXT N_("Stream name")
  65 #define NAME_LONGTEXT N_("Name to give to this stream/channel on the " \
  66                          "shoutcast/icecast server." )
  67
  68 #define DESCRIPTION_TEXT N_("Stream description")
  69 #define DESCRIPTION_LONGTEXT N_("Description of the stream content or " \
  70                                 "information about your channel." )
  71
  72 #define MP3_TEXT N_("Stream MP3")
  73 #define MP3_LONGTEXT N_("You normally have to feed the shoutcast module " \
  74                         "with Ogg streams. It is also possible to stream " \
  75                         "MP3 instead, so you can forward MP3 streams to " \
  76                         "the shoutcast/icecast server." )
  77
  78 /* To be listed properly as a public stream on the Yellow Pages of shoutcast/icecast
  79    the genres should match those used on the corresponding sites. Several examples
  80    are Alternative, Classical, Comedy, Country etc. */
  81
  82 #define GENRE_TEXT N_("Genre description")
  83 #define GENRE_LONGTEXT N_("Genre of the content." )
  84
  85 #define URL_TEXT N_("URL description")
  86 #define URL_LONGTEXT N_("URL with information about the stream or your channel." )
  87
  88 /* The shout module only "transmits" data. It does not have direct access to
  89    "codec level" information. Stream information such as bitrate, samplerate,
  90    channel numbers and quality (in case of Ogg streaming) need to be set manually */
  91
  92 #define BITRATE_TEXT N_("Bitrate")
  93 #define BITRATE_LONGTEXT N_("Bitrate information of the transcoded stream." )
  94
  95 #define SAMPLERATE_TEXT N_("Samplerate")
  96 #define SAMPLERATE_LONGTEXT N_("Samplerate information of the transcoded stream." )
  97
  98 #define CHANNELS_TEXT N_("Number of channels")
  99 #define CHANNELS_LONGTEXT N_("Number of channels information of the transcoded stream." )
 100
 101 #define QUALITY_TEXT N_("Ogg Vorbis Quality")
 102 #define QUALITY_LONGTEXT N_("Ogg Vorbis Quality information of the transcoded stream." )
 103
 104 #define PUBLIC_TEXT N_("Stream public")
 105 #define PUBLIC_LONGTEXT N_("Make the server publicly available on the 'Yellow Pages' " \
 106                            "(directory listing of streams) on the icecast/shoutcast " \
 107                            "website. Requires the bitrate information specified for " \
 108                            "shoutcast. Requires Ogg streaming for icecast." )
 109
 110 vlc_module_begin ()
 111     set_description( N_("IceCAST output") )
 112     set_shortname( "Shoutcast" )
 113     set_capability( "sout access", 0 )
 114     set_category( CAT_SOUT )
 115     set_subcategory( SUBCAT_SOUT_ACO )
 116     add_shortcut( "shout" )
 117     add_string( SOUT_CFG_PREFIX "name", "VLC media player - Live stream",
 118                 NAME_TEXT, NAME_LONGTEXT, false )
 119     add_string( SOUT_CFG_PREFIX "description", "Live stream from VLC media player",
 120                 DESCRIPTION_TEXT, DESCRIPTION_LONGTEXT, false )
 121     add_bool(   SOUT_CFG_PREFIX "mp3", false,
 122                 MP3_TEXT, MP3_LONGTEXT, true )
 123     add_string( SOUT_CFG_PREFIX "genre", "Alternative",
 124                 GENRE_TEXT, GENRE_LONGTEXT, false )
 125     add_string( SOUT_CFG_PREFIX "url", "http://www.videolan.org/vlc",
 126                 URL_TEXT, URL_LONGTEXT, false )
 127     add_string( SOUT_CFG_PREFIX "bitrate", "",
 128                 BITRATE_TEXT, BITRATE_LONGTEXT, false )
 129     add_string( SOUT_CFG_PREFIX "samplerate", "",
 130                 SAMPLERATE_TEXT, SAMPLERATE_LONGTEXT, false )
 131     add_string( SOUT_CFG_PREFIX "channels", "",
 132                 CHANNELS_TEXT, CHANNELS_LONGTEXT, false )
 133     add_string( SOUT_CFG_PREFIX "quality", "",
 134                 QUALITY_TEXT, QUALITY_LONGTEXT, false )
 135     add_bool(   SOUT_CFG_PREFIX "public", false,
 136                 PUBLIC_TEXT, PUBLIC_LONGTEXT, true )
 137     set_callbacks( Open, Close )
 138 vlc_module_end ()
 139
 140 /*****************************************************************************
 141  * Exported prototypes
 142  *****************************************************************************/
 143 static const char *const ppsz_sout_options[] = {
 144     "name", "description", "mp3", "genre", "url", "bitrate", "samplerate",
 145     "channels", "quality", "public", NULL
 146 };
 147
 148
 149 /*****************************************************************************
 150  * Exported prototypes
 151  *****************************************************************************/
 152 static ssize_t Write( sout_access_out_t *, block_t * );
 153 static int Control( sout_access_out_t *, int, va_list );
 154
 155 struct sout_access_out_sys_t
 156 {
 157     shout_t *p_shout;
 158 };
 159
 160 /*****************************************************************************
 161  * Open: open the shout connection
 162  *****************************************************************************/
 163 static int Open( vlc_object_t *p_this )
 164 {
 165     sout_access_out_t *p_access = (sout_access_out_t*)p_this;
 166     sout_access_out_sys_t *p_sys;
 167     shout_t *p_shout;
 168     long i_ret;
 169     char *psz_val;
 170
 171     char *psz_name;
 172     char *psz_description;
 173     char *psz_genre;
 174     char *psz_url;
 175     vlc_url_t url;
 176
 177     config_ChainParse( p_access, SOUT_CFG_PREFIX, ppsz_sout_options, p_access->p_cfg );
 178
 179     vlc_UrlParse( &url , p_access->psz_path );
 180     if( url.i_port <= 0 )
 181         url.i_port = 8000;
 182
 183     if( url.psz_host == NULL )
 184     {   /* Backward compatibility with bind@path syntax */
 185         vlc_UrlClean( &url );
 186         if( unlikely(asprintf( &psz_url, "//%s", p_access->psz_path ) == -1) )
 187             return VLC_ENOMEM;
 188         vlc_UrlParse( &url, psz_url );
 189         free( psz_url );
 190     }
 191
 192     p_sys = p_access->p_sys = malloc( sizeof( sout_access_out_sys_t ) );
 193     if( !p_sys )
 194     {
 195         vlc_UrlClean( &url );
 196         return VLC_ENOMEM;
 197     }
 198
 199     psz_name = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "name" );
 200     psz_description = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "description" );
 201     psz_genre = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "genre" );
 202     psz_url = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "url" );
 203
 204     p_shout = p_sys->p_shout = shout_new();
 205     if( !p_shout
 206          || shout_set_host( p_shout, url.psz_host ) != SHOUTERR_SUCCESS
 207          || shout_set_protocol( p_shout, SHOUT_PROTOCOL_ICY ) != SHOUTERR_SUCCESS
 208          || shout_set_port( p_shout, url.i_port ) != SHOUTERR_SUCCESS
 209          || shout_set_password( p_shout, url.psz_password ) != SHOUTERR_SUCCESS
 210          || shout_set_mount( p_shout, url.psz_path ) != SHOUTERR_SUCCESS
 211          || shout_set_user( p_shout, url.psz_username ) != SHOUTERR_SUCCESS
 212          || shout_set_agent( p_shout, "VLC media player " VERSION ) != SHOUTERR_SUCCESS
 213          || shout_set_name( p_shout, psz_name ) != SHOUTERR_SUCCESS
 214          || shout_set_description( p_shout, psz_description ) != SHOUTERR_SUCCESS
 215          || shout_set_genre( p_shout, psz_genre ) != SHOUTERR_SUCCESS
 216          || shout_set_url( p_shout, psz_url ) != SHOUTERR_SUCCESS
 217          /* || shout_set_nonblocking( p_shout, 1 ) != SHOUTERR_SUCCESS */
 218       )
 219     {
 220         msg_Err( p_access, "failed to initialize shout streaming to %s:%i/%s",
 221                  url.psz_host, url.i_port, url.psz_path );
 222
 223         free( psz_name );
 224         free( psz_description );
 225         free( psz_genre );
 226         free( psz_url );
 227         goto error;
 228     }
 229
 230     free( psz_name );
 231     free( psz_description );
 232     free( psz_genre );
 233     free( psz_url );
 234
 235     i_ret = shout_set_format( p_shout, var_GetBool( p_access, SOUT_CFG_PREFIX "mp3" ) ?
 236                                        SHOUT_FORMAT_MP3 : SHOUT_FORMAT_OGG );
 237
 238     if( i_ret != SHOUTERR_SUCCESS )
 239     {
 240         msg_Err( p_access, "failed to set the shoutcast streaming format" );
 241         goto error;
 242     }
 243
 244     /* Don't force bitrate to 0 but only use when specified. This will otherwise
 245        show an empty field on icecast directory listing instead of NA */
 246     psz_val = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "bitrate" );
 247     if( psz_val )
 248     {
 249         i_ret = shout_set_audio_info( p_shout, SHOUT_AI_BITRATE, psz_val );
 250         free( psz_val );
 251         if( i_ret != SHOUTERR_SUCCESS )
 252         {
 253             msg_Err( p_access, "failed to set the information about the bitrate" );
 254             goto error;
 255         }
 256     }
 257     else
 258     {
 259         /* Bitrate information is used for icecast/shoutcast servers directory
 260            listings (sorting, stream info etc.) */
 261         msg_Warn( p_access, "no bitrate information specified (required for listing " \
 262                             "the server as public on the shoutcast website)" );
 263     }
 264
 265     /* Information about samplerate, channels and quality will not be propagated
 266        through the YP protocol for icecast to the public directory listing when
 267        the icecast server is operating in shoutcast compatibility mode */
 268
 269     psz_val = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "samplerate" );
 270     if( psz_val )
 271     {
 272         i_ret = shout_set_audio_info( p_shout, SHOUT_AI_SAMPLERATE, psz_val );
 273         free( psz_val );
 274         if( i_ret != SHOUTERR_SUCCESS )
 275         {
 276             msg_Err( p_access, "failed to set the information about the samplerate" );
 277             goto error;
 278         }
 279     }
 280
 281     psz_val = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "channels" );
 282     if( psz_val )
 283     {
 284         i_ret = shout_set_audio_info( p_shout, SHOUT_AI_CHANNELS, psz_val );
 285         free( psz_val );
 286         if( i_ret != SHOUTERR_SUCCESS )
 287         {
 288             msg_Err( p_access, "failed to set the information about the number of channels" );
 289             goto error;
 290         }
 291     }
 292
 293     psz_val = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "quality" );
 294     if( psz_val )
 295     {
 296         i_ret = shout_set_audio_info( p_shout, SHOUT_AI_QUALITY, psz_val );
 297         free( psz_val );
 298         if( i_ret != SHOUTERR_SUCCESS )
 299         {
 300             msg_Err( p_access, "failed to set the information about Ogg Vorbis quality" );
 301             goto error;
 302         }
 303     }
 304
 305     if( var_GetBool( p_access, SOUT_CFG_PREFIX "public" ) )
 306     {
 307         i_ret = shout_set_public( p_shout, 1 );
 308         if( i_ret != SHOUTERR_SUCCESS )
 309         {
 310             msg_Err( p_access, "failed to set the server status setting to public" );
 311             goto error;
 312         }
 313     }
 314
 315     /* Connect at startup. Cycle through the possible protocols. */
 316     i_ret = shout_get_connected( p_shout );
 317     while ( i_ret != SHOUTERR_CONNECTED )
 318     {
 319         /* Shout parameters cannot be changed on an open connection */
 320         shout_close( p_shout );
 321
 322         /* Re-initialize for Shoutcast using ICY protocol. Not needed for initial connection
 323            but it is when we are reconnecting after other protocol was tried. */
 324         i_ret = shout_set_protocol( p_shout, SHOUT_PROTOCOL_ICY );
 325         if( i_ret != SHOUTERR_SUCCESS )
 326         {
 327             msg_Err( p_access, "failed to set the protocol to 'icy'" );
 328             goto error;
 329         }
 330         i_ret = shout_open( p_shout );
 331         if( i_ret == SHOUTERR_SUCCESS )
 332         {
 333             i_ret = SHOUTERR_CONNECTED;
 334             msg_Dbg( p_access, "connected using 'icy' (shoutcast) protocol" );
 335         }
 336         else
 337         {
 338             msg_Warn( p_access, "failed to connect using 'icy' (shoutcast) protocol" );
 339
 340             /* Shout parameters cannot be changed on an open connection */
 341             shout_close( p_shout );
 342
 343             /* IceCAST using HTTP protocol */
 344             i_ret = shout_set_protocol( p_shout, SHOUT_PROTOCOL_HTTP );
 345             if( i_ret != SHOUTERR_SUCCESS )
 346             {
 347                 msg_Err( p_access, "failed to set the protocol to 'http'" );
 348                 goto error;
 349             }
 350             i_ret = shout_open( p_shout );
 351             if( i_ret == SHOUTERR_SUCCESS )
 352             {
 353                 i_ret = SHOUTERR_CONNECTED;
 354                 msg_Dbg( p_access, "connected using 'http' (icecast 2.x) protocol" );
 355             }
 356             else
 357                 msg_Warn( p_access, "failed to connect using 'http' (icecast 2.x) protocol " );
 358         }
 359 /*
 360         for non-blocking, use:
 361         while( i_ret == SHOUTERR_BUSY )
 362         {
 363             sleep( 1 );
 364             i_ret = shout_get_connected( p_shout );
 365         }
 366 */
 367         if ( i_ret != SHOUTERR_CONNECTED )
 368         {
 369             msg_Warn( p_access, "unable to establish connection, retrying..." );
 370             msleep( 30000000 );
 371         }
 372     }
 373
 374     if( i_ret != SHOUTERR_CONNECTED )
 375     {
 376         msg_Err( p_access, "failed to open shout stream to %s:%i/%s: %s",
 377                  url.psz_host, url.i_port, url.psz_path, shout_get_error(p_shout) );
 378         goto error;
 379     }
 380
 381     p_access->pf_write = Write;
 382     p_access->pf_control = Control;
 383
 384     msg_Dbg( p_access, "shout access output opened (%s@%s:%i/%s)",
 385              url.psz_username, url.psz_host, url.i_port, url.psz_path );
 386
 387     vlc_UrlClean( &url );
 388     return VLC_SUCCESS;
 389
 390 error:
 391     if( p_sys->p_shout )
 392         shout_free( p_sys->p_shout );
 393     vlc_UrlClean( &url );
 394     free( p_sys );
 395     return VLC_EGENERIC;
 396 }
 397
 398 /*****************************************************************************
 399  * Close: close the target
 400  *****************************************************************************/
 401 static void Close( vlc_object_t * p_this )
 402 {
 403     sout_access_out_t *p_access = (sout_access_out_t*)p_this;
 404     sout_access_out_sys_t *p_sys = p_access->p_sys;
 405
 406     if( p_sys->p_shout )
 407     {
 408         shout_close( p_sys->p_shout );
 409         shout_free( p_sys->p_shout );
 410         shout_shutdown();
 411     }
 412     free( p_sys );
 413     msg_Dbg( p_access, "shout access output closed" );
 414 }
 415
 416 static int Control( sout_access_out_t *p_access, int i_query, va_list args )
 417 {
 418     switch( i_query )
 419     {
 420         case ACCESS_OUT_CONTROLS_PACE:
 421         {
 422             bool *pb = va_arg( args, bool * );
 423             *pb = strcmp( p_access->psz_access, "stream" );
 424             break;
 425         }
 426
 427         default:
 428             return VLC_EGENERIC;
 429     }
 430     return VLC_SUCCESS;
 431 }
 432
 433 /*****************************************************************************
 434  * Write: standard write
 435  *****************************************************************************/
 436 static ssize_t Write( sout_access_out_t *p_access, block_t *p_buffer )
 437 {
 438     sout_access_out_sys_t *p_sys = p_access->p_sys;
 439     size_t i_write = 0;
 440
 441     shout_sync( p_sys->p_shout );
 442     while( p_buffer )
 443     {
 444         block_t *p_next = p_buffer->p_next;
 445
 446         if( shout_send( p_sys->p_shout, p_buffer->p_buffer, p_buffer->i_buffer )
 447              == SHOUTERR_SUCCESS )
 448         {
 449             i_write += p_buffer->i_buffer;
 450         }
 451         else
 452         {
 453             msg_Err( p_access, "cannot write to stream: %s",
 454                      shout_get_error( p_sys->p_shout ) );
 455
 456             /* The most common cause seems to be a server disconnect, resulting in a
 457                Socket Error which can only be fixed by closing and reconnecting.
 458                Since we already began with a working connection, the most feasable
 459                approach to get out of this error status is a (timed) reconnect approach. */
 460             shout_close( p_sys->p_shout );
 461             msg_Warn( p_access, "server unavailable? trying to reconnect..." );
 462             /* Re-open the connection (protocol params have already been set) and re-sync */
 463             if( shout_open( p_sys->p_shout ) == SHOUTERR_SUCCESS )
 464             {
 465                 shout_sync( p_sys->p_shout );
 466                 msg_Warn( p_access, "reconnected to server" );
 467             }
 468             else
 469             {
 470                 msg_Err( p_access, "failed to reconnect to server" );
 471                 block_ChainRelease( p_buffer );
 472                 return VLC_EGENERIC;
 473             }
 474
 475         }
 476         block_Release( p_buffer );
 477
 478         /* XXX: Unsure if that's the cause for some audio trouble... */
 479
 480         p_buffer = p_next;
 481     }
 482
 483     return i_write;
 484 }