git.sesse.net Git - vlc/blob - modules/access_output/shout.c

   1 /*****************************************************************************
   2  * shout.c: This module forwards vorbis streams to an icecast server
   3  *****************************************************************************
   4  * Copyright (C) 2005 the VideoLAN team
   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
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 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 General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, 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
  53 #include <shout/shout.h>
  54
  55 /*****************************************************************************
  56  * Module descriptor
  57  *****************************************************************************/
  58 static int  Open ( vlc_object_t * );
  59 static void Close( vlc_object_t * );
  60
  61 #define SOUT_CFG_PREFIX "sout-shout-"
  62
  63 #define NAME_TEXT N_("Stream name")
  64 #define NAME_LONGTEXT N_("Name to give to this stream/channel on the " \
  65                          "shoutcast/icecast server." )
  66
  67 #define DESCRIPTION_TEXT N_("Stream description")
  68 #define DESCRIPTION_LONGTEXT N_("Description of the stream content or " \
  69                                 "information about your channel." )
  70
  71 #define MP3_TEXT N_("Stream MP3")
  72 #define MP3_LONGTEXT N_("You normally have to feed the shoutcast module " \
  73                         "with Ogg streams. It is also possible to stream " \
  74                         "MP3 instead, so you can forward MP3 streams to " \
  75                         "the shoutcast/icecast server." )
  76
  77 /* To be listed properly as a public stream on the Yellow Pages of shoutcast/icecast
  78    the genres should match those used on the corresponding sites. Several examples
  79    are Alternative, Classical, Comedy, Country etc. */
  80
  81 #define GENRE_TEXT N_("Genre description")
  82 #define GENRE_LONGTEXT N_("Genre of the content. " )
  83
  84 #define URL_TEXT N_("URL description")
  85 #define URL_LONGTEXT N_("URL with information about the stream or your channel. " )
  86
  87 /* The shout module only "transmits" data. It does not have direct access to
  88    "codec level" information. Stream information such as bitrate, samplerate,
  89    channel numbers and quality (in case of Ogg streaming) need to be set manually */
  90
  91 #define BITRATE_TEXT N_("Bitrate")
  92 #define BITRATE_LONGTEXT N_("Bitrate information of the transcoded stream. " )
  93
  94 #define SAMPLERATE_TEXT N_("Samplerate")
  95 #define SAMPLERATE_LONGTEXT N_("Samplerate information of the transcoded stream. " )
  96
  97 #define CHANNELS_TEXT N_("Number of channels")
  98 #define CHANNELS_LONGTEXT N_("Number of channels information of the transcoded stream. " )
  99
 100 #define QUALITY_TEXT N_("Ogg Vorbis Quality")
 101 #define QUALITY_LONGTEXT N_("Ogg Vorbis Quality information of the transcoded stream. " )
 102
 103 #define PUBLIC_TEXT N_("Stream public")
 104 #define PUBLIC_LONGTEXT N_("Make the server publicly available on the 'Yellow Pages' " \
 105                            "(directory listing of streams) on the icecast/shoutcast " \
 106                            "website. Requires the bitrate information specified for " \
 107                            "shoutcast. Requires Ogg streaming for icecast." )
 108
 109 vlc_module_begin ()
 110     set_description( N_("IceCAST output") )
 111     set_shortname( "Shoutcast" )
 112     set_capability( "sout access", 0 )
 113     set_category( CAT_SOUT )
 114     set_subcategory( SUBCAT_SOUT_ACO )
 115     add_shortcut( "shout" )
 116     add_string( SOUT_CFG_PREFIX "name", "VLC media player - Live stream", NULL,
 117                 NAME_TEXT, NAME_LONGTEXT, false )
 118     add_string( SOUT_CFG_PREFIX "description",
 119                  "Live stream from VLC media player", NULL,
 120                 DESCRIPTION_TEXT, DESCRIPTION_LONGTEXT, false )
 121     add_bool(   SOUT_CFG_PREFIX "mp3", false, NULL,
 122                 MP3_TEXT, MP3_LONGTEXT, true )
 123     add_string( SOUT_CFG_PREFIX "genre", "Alternative", NULL,
 124                 GENRE_TEXT, GENRE_LONGTEXT, false )
 125     add_string( SOUT_CFG_PREFIX "url", "http://www.videolan.org/vlc", NULL,
 126                 URL_TEXT, URL_LONGTEXT, false )
 127     add_string( SOUT_CFG_PREFIX "bitrate", "", NULL,
 128                 BITRATE_TEXT, BITRATE_LONGTEXT, false )
 129     add_string( SOUT_CFG_PREFIX "samplerate", "", NULL,
 130                 SAMPLERATE_TEXT, SAMPLERATE_LONGTEXT, false )
 131     add_string( SOUT_CFG_PREFIX "channels", "", NULL,
 132                 CHANNELS_TEXT, CHANNELS_LONGTEXT, false )
 133     add_string( SOUT_CFG_PREFIX "quality", "", NULL,
 134                 QUALITY_TEXT, QUALITY_LONGTEXT, false )
 135     add_bool(   SOUT_CFG_PREFIX "public", false, NULL,
 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 Seek ( sout_access_out_t *, off_t  );
 154 static int Control( sout_access_out_t *, int, va_list );
 155
 156 struct sout_access_out_sys_t
 157 {
 158     shout_t *p_shout;
 159 };
 160
 161 /*****************************************************************************
 162  * Open: open the shout connection
 163  *****************************************************************************/
 164 static int Open( vlc_object_t *p_this )
 165 {
 166     sout_access_out_t *p_access = (sout_access_out_t*)p_this;
 167     sout_access_out_sys_t *p_sys;
 168     shout_t *p_shout;
 169     long i_ret;
 170     unsigned int i_port;
 171     char *psz_val;
 172
 173     char *psz_accessname;
 174     char *psz_parser;
 175     const char *psz_user;
 176     const char *psz_pass;
 177     const char *psz_host;
 178     const char *psz_mount;
 179     const char *psz_port;
 180     char *psz_name;
 181     char *psz_description;
 182     char *psz_genre;
 183     char *psz_url;
 184
 185     config_ChainParse( p_access, SOUT_CFG_PREFIX, ppsz_sout_options, p_access->p_cfg );
 186
 187     if( !p_access->psz_path )
 188     {
 189         msg_Err( p_access,
 190                  "please specify url=user:password@host:port/mountpoint" );
 191         return VLC_EGENERIC;
 192     }
 193
 194     psz_accessname = psz_parser = strdup( p_access->psz_path );
 195     if( !psz_parser )
 196         return VLC_ENOMEM;
 197
 198     /* Parse connection data user:pwd@host:port/mountpoint */
 199     psz_user = psz_parser;
 200     while( psz_parser[0] && psz_parser[0] != ':' ) psz_parser++;
 201     if( psz_parser[0] ) { psz_parser[0] = 0; psz_parser++; }
 202     psz_pass = psz_parser;
 203     while( psz_parser[0] && psz_parser[0] != '@' ) psz_parser++;
 204     if( psz_parser[0] ) { psz_parser[0] = 0; psz_parser++; }
 205     psz_host = psz_parser;
 206     while( psz_parser[0] && psz_parser[0] != ':' ) psz_parser++;
 207     if( psz_parser[0] ) { psz_parser[0] = 0; psz_parser++; }
 208     psz_port = psz_parser;
 209     while( psz_parser[0] && psz_parser[0] != '/' ) psz_parser++;
 210     if( psz_parser[0] ) { psz_parser[0] = 0; psz_parser++; }
 211     psz_mount = psz_parser;
 212
 213     i_port = atoi( psz_port );
 214
 215     p_sys = p_access->p_sys = malloc( sizeof( sout_access_out_sys_t ) );
 216     if( !p_sys )
 217     {
 218         free( psz_accessname );
 219         return VLC_ENOMEM;
 220     }
 221
 222     psz_name = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "name" );
 223     psz_description = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "description" );
 224     psz_genre = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "genre" );
 225     psz_url = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "url" );
 226
 227     p_shout = p_sys->p_shout = shout_new();
 228     if( !p_shout
 229          || shout_set_host( p_shout, psz_host ) != SHOUTERR_SUCCESS
 230          || shout_set_protocol( p_shout, SHOUT_PROTOCOL_ICY ) != SHOUTERR_SUCCESS
 231          || shout_set_port( p_shout, i_port ) != SHOUTERR_SUCCESS
 232          || shout_set_password( p_shout, psz_pass ) != SHOUTERR_SUCCESS
 233          || shout_set_mount( p_shout, psz_mount ) != SHOUTERR_SUCCESS
 234          || shout_set_user( p_shout, psz_user ) != SHOUTERR_SUCCESS
 235          || shout_set_agent( p_shout, "VLC media player " VERSION ) != SHOUTERR_SUCCESS
 236          || shout_set_name( p_shout, psz_name ) != SHOUTERR_SUCCESS
 237          || shout_set_description( p_shout, psz_description ) != SHOUTERR_SUCCESS
 238          || shout_set_genre( p_shout, psz_genre ) != SHOUTERR_SUCCESS
 239          || shout_set_url( p_shout, psz_url ) != SHOUTERR_SUCCESS
 240          /* || shout_set_nonblocking( p_shout, 1 ) != SHOUTERR_SUCCESS */
 241       )
 242     {
 243         msg_Err( p_access, "failed to initialize shout streaming to %s:%i/%s",
 244                  psz_host, i_port, psz_mount );
 245         free( p_access->p_sys );
 246         free( psz_accessname );
 247         free( psz_name );
 248         free( psz_description );
 249         free( psz_genre );
 250         free( psz_url );
 251         return VLC_EGENERIC;
 252     }
 253
 254     free( psz_name );
 255     free( psz_description );
 256     free( psz_genre );
 257     free( psz_url );
 258
 259     if( var_GetBool( p_access, SOUT_CFG_PREFIX "mp3" ) )
 260         i_ret = shout_set_format( p_shout, SHOUT_FORMAT_MP3 );
 261     else
 262         i_ret = shout_set_format( p_shout, SHOUT_FORMAT_OGG );
 263
 264     if( i_ret != SHOUTERR_SUCCESS )
 265     {
 266         msg_Err( p_access, "failed to set the shoutcast streaming format" );
 267         goto error;
 268     }
 269
 270     /* Don't force bitrate to 0 but only use when specified. This will otherwise
 271        show an empty field on icecast directory listing instead of NA */
 272     psz_val = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "bitrate" );
 273     if( psz_val )
 274     {
 275         i_ret = shout_set_audio_info( p_shout, SHOUT_AI_BITRATE, psz_val );
 276         free( psz_val );
 277         if( i_ret != SHOUTERR_SUCCESS )
 278         {
 279             msg_Err( p_access, "failed to set the information about the bitrate" );
 280             goto error;
 281         }
 282     }
 283     else
 284     {
 285         /* Bitrate information is used for icecast/shoutcast servers directory
 286            listings (sorting, stream info etc.) */
 287         msg_Warn( p_access, "no bitrate information specified (required for listing " \
 288                             "the server as public on the shoutcast website)" );
 289     }
 290
 291     /* Information about samplerate, channels and quality will not be propagated
 292        through the YP protocol for icecast to the public directory listing when
 293        the icecast server is operating in shoutcast compatibility mode */
 294
 295     psz_val = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "samplerate" );
 296     if( psz_val )
 297     {
 298         i_ret = shout_set_audio_info( p_shout, SHOUT_AI_SAMPLERATE, psz_val );
 299         free( psz_val );
 300         if( i_ret != SHOUTERR_SUCCESS )
 301         {
 302             msg_Err( p_access, "failed to set the information about the samplerate" );
 303             goto error;
 304         }
 305     }
 306
 307     psz_val = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "channels" );
 308     if( psz_val )
 309     {
 310         i_ret = shout_set_audio_info( p_shout, SHOUT_AI_CHANNELS, psz_val );
 311         free( psz_val );
 312         if( i_ret != SHOUTERR_SUCCESS )
 313         {
 314             msg_Err( p_access, "failed to set the information about the number of channels" );
 315             goto error;
 316         }
 317     }
 318
 319     psz_val = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "quality" );
 320     if( psz_val )
 321     {
 322         i_ret = shout_set_audio_info( p_shout, SHOUT_AI_QUALITY, psz_val );
 323         free( psz_val );
 324         if( i_ret != SHOUTERR_SUCCESS )
 325         {
 326             msg_Err( p_access, "failed to set the information about Ogg Vorbis quality" );
 327             goto error;
 328         }
 329     }
 330
 331     if( var_GetBool( p_access, SOUT_CFG_PREFIX "public" ) )
 332     {
 333         i_ret = shout_set_public( p_shout, 1 );
 334         if( i_ret != SHOUTERR_SUCCESS )
 335         {
 336             msg_Err( p_access, "failed to set the server status setting to public" );
 337             goto error;
 338         }
 339     }
 340
 341     /* Connect at startup. Cycle through the possible protocols. */
 342     i_ret = shout_get_connected( p_shout );
 343     while ( i_ret != SHOUTERR_CONNECTED )
 344     {
 345         /* Shout parameters cannot be changed on an open connection */
 346         i_ret = shout_close( p_shout );
 347         if( i_ret == SHOUTERR_SUCCESS )
 348         {
 349             i_ret = SHOUTERR_UNCONNECTED;
 350         }
 351
 352         /* Re-initialize for Shoutcast using ICY protocol. Not needed for initial connection
 353            but it is when we are reconnecting after other protocol was tried. */
 354         i_ret = shout_set_protocol( p_shout, SHOUT_PROTOCOL_ICY );
 355         if( i_ret != SHOUTERR_SUCCESS )
 356         {
 357             msg_Err( p_access, "failed to set the protocol to 'icy'" );
 358             goto error;
 359         }
 360         i_ret = shout_open( p_shout );
 361         if( i_ret == SHOUTERR_SUCCESS )
 362         {
 363             i_ret = SHOUTERR_CONNECTED;
 364             msg_Dbg( p_access, "connected using 'icy' (shoutcast) protocol" );
 365         }
 366         else
 367         {
 368             msg_Warn( p_access, "failed to connect using 'icy' (shoutcast) protocol" );
 369
 370             /* Shout parameters cannot be changed on an open connection */
 371             i_ret = shout_close( p_shout );
 372             if( i_ret == SHOUTERR_SUCCESS )
 373             {
 374                 i_ret = SHOUTERR_UNCONNECTED;
 375             }
 376
 377             /* IceCAST using HTTP protocol */
 378             i_ret = shout_set_protocol( p_shout, SHOUT_PROTOCOL_HTTP );
 379             if( i_ret != SHOUTERR_SUCCESS )
 380             {
 381                 msg_Err( p_access, "failed to set the protocol to 'http'" );
 382                 goto error;
 383             }
 384             i_ret = shout_open( p_shout );
 385             if( i_ret == SHOUTERR_SUCCESS )
 386             {
 387                 i_ret = SHOUTERR_CONNECTED;
 388                 msg_Dbg( p_access, "connected using 'http' (icecast 2.x) protocol" );
 389             }
 390             else
 391                 msg_Warn( p_access, "failed to connect using 'http' (icecast 2.x) protocol " );
 392         }
 393 /*
 394         for non-blocking, use:
 395         while( i_ret == SHOUTERR_BUSY )
 396         {
 397             sleep( 1 );
 398             i_ret = shout_get_connected( p_shout );
 399         }
 400 */
 401         if ( i_ret != SHOUTERR_CONNECTED )
 402         {
 403             msg_Warn( p_access, "unable to establish connection, retrying..." );
 404             msleep( 30000000 );
 405         }
 406     }
 407
 408     if( i_ret != SHOUTERR_CONNECTED )
 409     {
 410         msg_Err( p_access, "failed to open shout stream to %s:%i/%s: %s",
 411                  psz_host, i_port, psz_mount, shout_get_error(p_shout) );
 412         free( p_access->p_sys );
 413         free( psz_accessname );
 414         return VLC_EGENERIC;
 415     }
 416
 417     p_access->pf_write = Write;
 418     p_access->pf_seek  = Seek;
 419     p_access->pf_control = Control;
 420
 421     msg_Dbg( p_access, "shout access output opened (%s@%s:%i/%s)",
 422              psz_user, psz_host, i_port, psz_mount );
 423     free( psz_accessname );
 424
 425     return VLC_SUCCESS;
 426
 427 error:
 428     free( psz_accessname );
 429     free( p_sys );
 430     return VLC_EGENERIC;
 431 }
 432
 433 /*****************************************************************************
 434  * Close: close the target
 435  *****************************************************************************/
 436 static void Close( vlc_object_t * p_this )
 437 {
 438     sout_access_out_t *p_access = (sout_access_out_t*)p_this;
 439
 440     if( p_access->p_sys && p_access->p_sys->p_shout )
 441     {
 442         shout_close( p_access->p_sys->p_shout );
 443         shout_shutdown();
 444     }
 445     free( p_access->p_sys );
 446     msg_Dbg( p_access, "shout access output closed" );
 447 }
 448
 449 static int Control( sout_access_out_t *p_access, int i_query, va_list args )
 450 {
 451     switch( i_query )
 452     {
 453         case ACCESS_OUT_CONTROLS_PACE:
 454         {
 455             bool *pb = va_arg( args, bool * );
 456             *pb = strcmp( p_access->psz_access, "stream" );
 457             break;
 458         }
 459
 460         default:
 461             return VLC_EGENERIC;
 462     }
 463     return VLC_SUCCESS;
 464 }
 465
 466 /*****************************************************************************
 467  * Write: standard write
 468  *****************************************************************************/
 469 static ssize_t Write( sout_access_out_t *p_access, block_t *p_buffer )
 470 {
 471     size_t i_write = 0;
 472
 473     shout_sync( p_access->p_sys->p_shout );
 474     while( p_buffer )
 475     {
 476         block_t *p_next = p_buffer->p_next;
 477
 478         if( shout_send( p_access->p_sys->p_shout,
 479                         p_buffer->p_buffer, p_buffer->i_buffer )
 480              == SHOUTERR_SUCCESS )
 481         {
 482             i_write += p_buffer->i_buffer;
 483         }
 484         else
 485         {
 486             msg_Err( p_access, "cannot write to stream: %s",
 487                      shout_get_error(p_access->p_sys->p_shout) );
 488
 489             /* The most common cause seems to be a server disconnect, resulting in a
 490                Socket Error which can only be fixed by closing and reconnecting.
 491                Since we already began with a working connection, the most feasable
 492                approach to get out of this error status is a (timed) reconnect approach. */
 493             shout_close( p_access->p_sys->p_shout );
 494             msg_Warn( p_access, "server unavailable? trying to reconnect..." );
 495             /* Re-open the connection (protocol params have already been set) and re-sync */
 496             if( shout_open( p_access->p_sys->p_shout ) == SHOUTERR_SUCCESS )
 497             {
 498                 shout_sync( p_access->p_sys->p_shout );
 499                 msg_Warn( p_access, "reconnected to server" );
 500             }
 501             else
 502             {
 503                 msg_Err( p_access, "failed to reconnect to server" );
 504                 block_ChainRelease (p_buffer);
 505                 return VLC_EGENERIC;
 506             }
 507
 508         }
 509         block_Release( p_buffer );
 510
 511         /* XXX: Unsure if that's the cause for some audio trouble... */
 512
 513         p_buffer = p_next;
 514     }
 515
 516     return i_write;
 517 }
 518
 519 /*****************************************************************************
 520  * Seek: seek to a specific location -- not supported
 521  *****************************************************************************/
 522 static int Seek( sout_access_out_t *p_access, off_t i_pos )
 523 {
 524     VLC_UNUSED(i_pos);
 525     msg_Err( p_access, "cannot seek on shout" );
 526     return VLC_EGENERIC;
 527 }
 528