1 /*****************************************************************************
2 * shout.c: This module forwards vorbis streams to an icecast server
3 *****************************************************************************
4 * Copyright (C) 2005 the VideoLAN team
7 * Authors: Daniel Fischer <dan at subsignal dot org>
8 * Derk-Jan Hartman <hartman at videolan dot org>
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.
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.
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 *****************************************************************************/
25 /*****************************************************************************
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.
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}'
38 *****************************************************************************/
40 /*****************************************************************************
42 *****************************************************************************/
48 #include <vlc_common.h>
49 #include <vlc_plugin.h>
51 #include <vlc_block.h>
53 #include <shout/shout.h>
55 /*****************************************************************************
57 *****************************************************************************/
58 static int Open ( vlc_object_t * );
59 static void Close( vlc_object_t * );
61 #define SOUT_CFG_PREFIX "sout-shout-"
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." )
67 #define DESCRIPTION_TEXT N_("Stream description")
68 #define DESCRIPTION_LONGTEXT N_("Description of the stream content or " \
69 "information about your channel." )
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." )
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. */
81 #define GENRE_TEXT N_("Genre description")
82 #define GENRE_LONGTEXT N_("Genre of the content. " )
84 #define URL_TEXT N_("URL description")
85 #define URL_LONGTEXT N_("URL with information about the stream or your channel. " )
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 */
91 #define BITRATE_TEXT N_("Bitrate")
92 #define BITRATE_LONGTEXT N_("Bitrate information of the transcoded stream. " )
94 #define SAMPLERATE_TEXT N_("Samplerate")
95 #define SAMPLERATE_LONGTEXT N_("Samplerate information of the transcoded stream. " )
97 #define CHANNELS_TEXT N_("Number of channels")
98 #define CHANNELS_LONGTEXT N_("Number of channels information of the transcoded stream. " )
100 #define QUALITY_TEXT N_("Ogg Vorbis Quality")
101 #define QUALITY_LONGTEXT N_("Ogg Vorbis Quality information of the transcoded stream. " )
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." )
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 )
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
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 );
156 struct sout_access_out_sys_t
161 /*****************************************************************************
162 * Open: open the shout connection
163 *****************************************************************************/
164 static int Open( vlc_object_t *p_this )
166 sout_access_out_t *p_access = (sout_access_out_t*)p_this;
167 sout_access_out_sys_t *p_sys;
173 char *psz_accessname;
175 const char *psz_user;
181 char *psz_description;
185 config_ChainParse( p_access, SOUT_CFG_PREFIX, ppsz_sout_options, p_access->p_cfg );
187 if( !p_access->psz_path )
190 "please specify url=user:password@host:port/mountpoint" );
194 psz_accessname = psz_parser = strdup( p_access->psz_path );
198 /* Parse connection data user:pwd@host:port/mountpoint */
199 psz_host = strchr( psz_parser, '@' );
202 psz_user = psz_parser;
203 *(psz_host++) = '\0';
208 psz_pass = strchr( psz_user, ':' );
210 *(psz_pass++) = '\0';
214 psz_mount = strchr( psz_host, '/' );
216 *(psz_mount++) = '\0';
220 if( psz_host[0] == '[' )
222 psz_port = strstr( psz_host, "]:" );
231 psz_port = strchr( psz_host, ':' );
233 *(psz_port++) = '\0';
235 i_port = psz_port ? atoi( psz_port ) : 8000;
237 p_sys = p_access->p_sys = malloc( sizeof( sout_access_out_sys_t ) );
240 free( psz_accessname );
244 psz_name = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "name" );
245 psz_description = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "description" );
246 psz_genre = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "genre" );
247 psz_url = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "url" );
249 p_shout = p_sys->p_shout = shout_new();
251 || shout_set_host( p_shout, psz_host ) != SHOUTERR_SUCCESS
252 || shout_set_protocol( p_shout, SHOUT_PROTOCOL_ICY ) != SHOUTERR_SUCCESS
253 || shout_set_port( p_shout, i_port ) != SHOUTERR_SUCCESS
254 || shout_set_password( p_shout, psz_pass ) != SHOUTERR_SUCCESS
255 || shout_set_mount( p_shout, psz_mount ) != SHOUTERR_SUCCESS
256 || shout_set_user( p_shout, psz_user ) != SHOUTERR_SUCCESS
257 || shout_set_agent( p_shout, "VLC media player " VERSION ) != SHOUTERR_SUCCESS
258 || shout_set_name( p_shout, psz_name ) != SHOUTERR_SUCCESS
259 || shout_set_description( p_shout, psz_description ) != SHOUTERR_SUCCESS
260 || shout_set_genre( p_shout, psz_genre ) != SHOUTERR_SUCCESS
261 || shout_set_url( p_shout, psz_url ) != SHOUTERR_SUCCESS
262 /* || shout_set_nonblocking( p_shout, 1 ) != SHOUTERR_SUCCESS */
265 msg_Err( p_access, "failed to initialize shout streaming to %s:%i/%s",
266 psz_host, i_port, psz_mount );
267 free( p_access->p_sys );
268 free( psz_accessname );
270 free( psz_description );
277 free( psz_description );
281 if( var_GetBool( p_access, SOUT_CFG_PREFIX "mp3" ) )
282 i_ret = shout_set_format( p_shout, SHOUT_FORMAT_MP3 );
284 i_ret = shout_set_format( p_shout, SHOUT_FORMAT_OGG );
286 if( i_ret != SHOUTERR_SUCCESS )
288 msg_Err( p_access, "failed to set the shoutcast streaming format" );
292 /* Don't force bitrate to 0 but only use when specified. This will otherwise
293 show an empty field on icecast directory listing instead of NA */
294 psz_val = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "bitrate" );
297 i_ret = shout_set_audio_info( p_shout, SHOUT_AI_BITRATE, psz_val );
299 if( i_ret != SHOUTERR_SUCCESS )
301 msg_Err( p_access, "failed to set the information about the bitrate" );
307 /* Bitrate information is used for icecast/shoutcast servers directory
308 listings (sorting, stream info etc.) */
309 msg_Warn( p_access, "no bitrate information specified (required for listing " \
310 "the server as public on the shoutcast website)" );
313 /* Information about samplerate, channels and quality will not be propagated
314 through the YP protocol for icecast to the public directory listing when
315 the icecast server is operating in shoutcast compatibility mode */
317 psz_val = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "samplerate" );
320 i_ret = shout_set_audio_info( p_shout, SHOUT_AI_SAMPLERATE, psz_val );
322 if( i_ret != SHOUTERR_SUCCESS )
324 msg_Err( p_access, "failed to set the information about the samplerate" );
329 psz_val = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "channels" );
332 i_ret = shout_set_audio_info( p_shout, SHOUT_AI_CHANNELS, psz_val );
334 if( i_ret != SHOUTERR_SUCCESS )
336 msg_Err( p_access, "failed to set the information about the number of channels" );
341 psz_val = var_GetNonEmptyString( p_access, SOUT_CFG_PREFIX "quality" );
344 i_ret = shout_set_audio_info( p_shout, SHOUT_AI_QUALITY, psz_val );
346 if( i_ret != SHOUTERR_SUCCESS )
348 msg_Err( p_access, "failed to set the information about Ogg Vorbis quality" );
353 if( var_GetBool( p_access, SOUT_CFG_PREFIX "public" ) )
355 i_ret = shout_set_public( p_shout, 1 );
356 if( i_ret != SHOUTERR_SUCCESS )
358 msg_Err( p_access, "failed to set the server status setting to public" );
363 /* Connect at startup. Cycle through the possible protocols. */
364 i_ret = shout_get_connected( p_shout );
365 while ( i_ret != SHOUTERR_CONNECTED )
367 /* Shout parameters cannot be changed on an open connection */
368 i_ret = shout_close( p_shout );
369 if( i_ret == SHOUTERR_SUCCESS )
371 i_ret = SHOUTERR_UNCONNECTED;
374 /* Re-initialize for Shoutcast using ICY protocol. Not needed for initial connection
375 but it is when we are reconnecting after other protocol was tried. */
376 i_ret = shout_set_protocol( p_shout, SHOUT_PROTOCOL_ICY );
377 if( i_ret != SHOUTERR_SUCCESS )
379 msg_Err( p_access, "failed to set the protocol to 'icy'" );
382 i_ret = shout_open( p_shout );
383 if( i_ret == SHOUTERR_SUCCESS )
385 i_ret = SHOUTERR_CONNECTED;
386 msg_Dbg( p_access, "connected using 'icy' (shoutcast) protocol" );
390 msg_Warn( p_access, "failed to connect using 'icy' (shoutcast) protocol" );
392 /* Shout parameters cannot be changed on an open connection */
393 i_ret = shout_close( p_shout );
394 if( i_ret == SHOUTERR_SUCCESS )
396 i_ret = SHOUTERR_UNCONNECTED;
399 /* IceCAST using HTTP protocol */
400 i_ret = shout_set_protocol( p_shout, SHOUT_PROTOCOL_HTTP );
401 if( i_ret != SHOUTERR_SUCCESS )
403 msg_Err( p_access, "failed to set the protocol to 'http'" );
406 i_ret = shout_open( p_shout );
407 if( i_ret == SHOUTERR_SUCCESS )
409 i_ret = SHOUTERR_CONNECTED;
410 msg_Dbg( p_access, "connected using 'http' (icecast 2.x) protocol" );
413 msg_Warn( p_access, "failed to connect using 'http' (icecast 2.x) protocol " );
416 for non-blocking, use:
417 while( i_ret == SHOUTERR_BUSY )
420 i_ret = shout_get_connected( p_shout );
423 if ( i_ret != SHOUTERR_CONNECTED )
425 msg_Warn( p_access, "unable to establish connection, retrying..." );
430 if( i_ret != SHOUTERR_CONNECTED )
432 msg_Err( p_access, "failed to open shout stream to %s:%i/%s: %s",
433 psz_host, i_port, psz_mount, shout_get_error(p_shout) );
434 free( p_access->p_sys );
435 free( psz_accessname );
439 p_access->pf_write = Write;
440 p_access->pf_seek = Seek;
441 p_access->pf_control = Control;
443 msg_Dbg( p_access, "shout access output opened (%s@%s:%i/%s)",
444 psz_user, psz_host, i_port, psz_mount );
445 free( psz_accessname );
450 free( psz_accessname );
455 /*****************************************************************************
456 * Close: close the target
457 *****************************************************************************/
458 static void Close( vlc_object_t * p_this )
460 sout_access_out_t *p_access = (sout_access_out_t*)p_this;
462 if( p_access->p_sys && p_access->p_sys->p_shout )
464 shout_close( p_access->p_sys->p_shout );
467 free( p_access->p_sys );
468 msg_Dbg( p_access, "shout access output closed" );
471 static int Control( sout_access_out_t *p_access, int i_query, va_list args )
475 case ACCESS_OUT_CONTROLS_PACE:
477 bool *pb = va_arg( args, bool * );
478 *pb = strcmp( p_access->psz_access, "stream" );
488 /*****************************************************************************
489 * Write: standard write
490 *****************************************************************************/
491 static ssize_t Write( sout_access_out_t *p_access, block_t *p_buffer )
495 shout_sync( p_access->p_sys->p_shout );
498 block_t *p_next = p_buffer->p_next;
500 if( shout_send( p_access->p_sys->p_shout,
501 p_buffer->p_buffer, p_buffer->i_buffer )
502 == SHOUTERR_SUCCESS )
504 i_write += p_buffer->i_buffer;
508 msg_Err( p_access, "cannot write to stream: %s",
509 shout_get_error(p_access->p_sys->p_shout) );
511 /* The most common cause seems to be a server disconnect, resulting in a
512 Socket Error which can only be fixed by closing and reconnecting.
513 Since we already began with a working connection, the most feasable
514 approach to get out of this error status is a (timed) reconnect approach. */
515 shout_close( p_access->p_sys->p_shout );
516 msg_Warn( p_access, "server unavailable? trying to reconnect..." );
517 /* Re-open the connection (protocol params have already been set) and re-sync */
518 if( shout_open( p_access->p_sys->p_shout ) == SHOUTERR_SUCCESS )
520 shout_sync( p_access->p_sys->p_shout );
521 msg_Warn( p_access, "reconnected to server" );
525 msg_Err( p_access, "failed to reconnect to server" );
526 block_ChainRelease (p_buffer);
531 block_Release( p_buffer );
533 /* XXX: Unsure if that's the cause for some audio trouble... */
541 /*****************************************************************************
542 * Seek: seek to a specific location -- not supported
543 *****************************************************************************/
544 static int Seek( sout_access_out_t *p_access, off_t i_pos )
547 msg_Err( p_access, "cannot seek on shout" );