ad72311c0758d037dac2743e40de8f9ef2be9b56
[vlc.git] / 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", 50 );
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
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     unsigned int i_port;
170     vlc_value_t val;
171
172     char *psz_accessname = NULL;
173     char *psz_parser = NULL;
174     char *psz_user = NULL;
175     char *psz_pass = NULL;
176     char *psz_host = NULL;
177     char *psz_mount = NULL;
178     char *psz_name = NULL;
179     char *psz_description = NULL;
180     char *tmp_port = NULL;
181     char *psz_genre = NULL;
182     char *psz_url = NULL;
183
184     config_ChainParse( p_access, SOUT_CFG_PREFIX, ppsz_sout_options, p_access->p_cfg );
185
186     psz_accessname = psz_parser = strdup( p_access->psz_path );
187     if( !psz_parser )
188         return VLC_ENOMEM;
189
190     if( !p_access->psz_path )
191     {
192         msg_Err( p_access,
193                  "please specify url=user:password@host:port/mountpoint" );
194         return VLC_EGENERIC;
195     }
196
197     /* Parse connection data user:pwd@host:port/mountpoint */
198     psz_user = psz_parser;
199     while( psz_parser[0] && psz_parser[0] != ':' ) psz_parser++;
200     if( psz_parser[0] ) { psz_parser[0] = 0; psz_parser++; }
201     psz_pass = psz_parser;
202     while( psz_parser[0] && psz_parser[0] != '@' ) psz_parser++;
203     if( psz_parser[0] ) { psz_parser[0] = 0; psz_parser++; }
204     psz_host = psz_parser;
205     while( psz_parser[0] && psz_parser[0] != ':' ) psz_parser++;
206     if( psz_parser[0] ) { psz_parser[0] = 0; psz_parser++; }
207     tmp_port = psz_parser;
208     while( psz_parser[0] && psz_parser[0] != '/' ) psz_parser++;
209     if( psz_parser[0] ) { psz_parser[0] = 0; psz_parser++; }
210     psz_mount = psz_parser;
211
212     i_port = atoi( tmp_port );
213
214     p_sys = p_access->p_sys = malloc( sizeof( sout_access_out_sys_t ) );
215     if( !p_sys )
216     {
217         free( psz_accessname );
218         return VLC_ENOMEM;
219     }
220
221     var_Get( p_access, SOUT_CFG_PREFIX "name", &val );
222     if( *val.psz_string )
223         psz_name = val.psz_string;
224     else
225         free( val.psz_string );
226
227     var_Get( p_access, SOUT_CFG_PREFIX "description", &val );
228     if( *val.psz_string )
229         psz_description = val.psz_string;
230     else
231         free( val.psz_string );
232
233     var_Get( p_access, SOUT_CFG_PREFIX "genre", &val );
234     if( *val.psz_string )
235         psz_genre = val.psz_string;
236     else
237         free( val.psz_string );
238
239     var_Get( p_access, SOUT_CFG_PREFIX "url", &val );
240     if( *val.psz_string )
241         psz_url = val.psz_string;
242     else
243         free( val.psz_string );
244
245     p_shout = p_sys->p_shout = shout_new();
246     if( !p_shout
247          || shout_set_host( p_shout, psz_host ) != SHOUTERR_SUCCESS
248          || shout_set_protocol( p_shout, SHOUT_PROTOCOL_ICY ) != SHOUTERR_SUCCESS
249          || shout_set_port( p_shout, i_port ) != SHOUTERR_SUCCESS
250          || shout_set_password( p_shout, psz_pass ) != SHOUTERR_SUCCESS
251          || shout_set_mount( p_shout, psz_mount ) != SHOUTERR_SUCCESS
252          || shout_set_user( p_shout, psz_user ) != SHOUTERR_SUCCESS
253          || shout_set_agent( p_shout, "VLC media player " VERSION ) != SHOUTERR_SUCCESS
254          || shout_set_name( p_shout, psz_name ) != SHOUTERR_SUCCESS
255          || shout_set_description( p_shout, psz_description ) != SHOUTERR_SUCCESS
256          || shout_set_genre( p_shout, psz_genre ) != SHOUTERR_SUCCESS
257          || shout_set_url( p_shout, psz_url ) != SHOUTERR_SUCCESS
258          /* || shout_set_nonblocking( p_shout, 1 ) != SHOUTERR_SUCCESS */
259       )
260     {
261         msg_Err( p_access, "failed to initialize shout streaming to %s:%i/%s",
262                  psz_host, i_port, psz_mount );
263         free( p_access->p_sys );
264         free( psz_accessname );
265         return VLC_EGENERIC;
266     }
267
268     free( psz_name );
269     free( psz_description );
270     free( psz_genre );
271     free( psz_url );
272
273     var_Get( p_access, SOUT_CFG_PREFIX "mp3", &val );
274     if( val.b_bool == true )
275         i_ret = shout_set_format( p_shout, SHOUT_FORMAT_MP3 );
276     else
277         i_ret = shout_set_format( p_shout, SHOUT_FORMAT_OGG );
278
279     if( i_ret != SHOUTERR_SUCCESS )
280     {
281         msg_Err( p_access, "failed to set the shoutcast streaming format" );
282         free( p_access->p_sys );
283         free( psz_accessname );
284         return VLC_EGENERIC;
285     }
286
287     /* Don't force bitrate to 0 but only use when specified. This will otherwise
288        show an empty field on icecast directory listing instead of NA */
289     var_Get( p_access, SOUT_CFG_PREFIX "bitrate", &val );
290     if( *val.psz_string )
291     {
292         i_ret = shout_set_audio_info( p_shout, SHOUT_AI_BITRATE, val.psz_string );
293         if( i_ret != SHOUTERR_SUCCESS )
294         {
295             msg_Err( p_access, "failed to set the information about the bitrate" );
296             free( p_access->p_sys );
297             free( psz_accessname );
298             return VLC_EGENERIC;
299         }
300     }
301     else
302     {
303         /* Bitrate information is used for icecast/shoutcast servers directory
304            listings (sorting, stream info etc.) */
305         msg_Warn( p_access, "no bitrate information specified (required for listing " \
306                             "the server as public on the shoutcast website)" );
307         free( val.psz_string );
308     }
309
310     /* Information about samplerate, channels and quality will not be propagated
311        through the YP protocol for icecast to the public directory listing when
312        the icecast server is operating in shoutcast compatibility mode */
313
314     var_Get( p_access, SOUT_CFG_PREFIX "samplerate", &val );
315     if( *val.psz_string )
316     {
317         i_ret = shout_set_audio_info( p_shout, SHOUT_AI_SAMPLERATE, val.psz_string );
318         if( i_ret != SHOUTERR_SUCCESS )
319         {
320             msg_Err( p_access, "failed to set the information about the samplerate" );
321             free( p_access->p_sys );
322             free( psz_accessname );
323             return VLC_EGENERIC;
324         }
325     }
326     else
327         free( val.psz_string );
328
329     var_Get( p_access, SOUT_CFG_PREFIX "channels", &val );
330     if( *val.psz_string )
331     {
332         i_ret = shout_set_audio_info( p_shout, SHOUT_AI_CHANNELS, val.psz_string );
333         if( i_ret != SHOUTERR_SUCCESS )
334         {
335             msg_Err( p_access, "failed to set the information about the number of channels" );
336             free( p_access->p_sys );
337             free( psz_accessname );
338             return VLC_EGENERIC;
339         }
340     }
341     else
342         free( val.psz_string );
343
344     var_Get( p_access, SOUT_CFG_PREFIX "quality", &val );
345     if( *val.psz_string )
346     {
347         i_ret = shout_set_audio_info( p_shout, SHOUT_AI_QUALITY, val.psz_string );
348         if( i_ret != SHOUTERR_SUCCESS )
349         {
350             msg_Err( p_access, "failed to set the information about Ogg Vorbis quality" );
351             free( p_access->p_sys );
352             free( psz_accessname );
353             return VLC_EGENERIC;
354         }
355     }
356     else
357         free( val.psz_string );
358
359     var_Get( p_access, SOUT_CFG_PREFIX "public", &val );
360     if( val.b_bool == true )
361     {
362         i_ret = shout_set_public( p_shout, 1 );
363         if( i_ret != SHOUTERR_SUCCESS )
364         {
365             msg_Err( p_access, "failed to set the server status setting to public" );
366             free( p_access->p_sys );
367             free( psz_accessname );
368             return VLC_EGENERIC;
369         }
370     }
371
372     /* Connect at startup. Cycle through the possible protocols. */
373     i_ret = shout_get_connected( p_shout );
374     while ( i_ret != SHOUTERR_CONNECTED )
375     {
376         /* Shout parameters cannot be changed on an open connection */
377         i_ret = shout_close( p_shout );
378         if( i_ret == SHOUTERR_SUCCESS )
379         {
380             i_ret = SHOUTERR_UNCONNECTED;
381         }
382
383         /* Re-initialize for Shoutcast using ICY protocol. Not needed for initial connection
384            but it is when we are reconnecting after other protocol was tried. */
385         i_ret = shout_set_protocol( p_shout, SHOUT_PROTOCOL_ICY );
386         if( i_ret != SHOUTERR_SUCCESS )
387         {
388             msg_Err( p_access, "failed to set the protocol to 'icy'" );
389             free( p_access->p_sys );
390             free( psz_accessname );
391             return VLC_EGENERIC;
392         }
393         i_ret = shout_open( p_shout );
394         if( i_ret == SHOUTERR_SUCCESS )
395         {
396             i_ret = SHOUTERR_CONNECTED;
397             msg_Dbg( p_access, "connected using 'icy' (shoutcast) protocol" );
398         }
399         else
400         {
401             msg_Warn( p_access, "failed to connect using 'icy' (shoutcast) protocol" );
402
403             /* Shout parameters cannot be changed on an open connection */
404             i_ret = shout_close( p_shout );
405             if( i_ret == SHOUTERR_SUCCESS )
406             {
407                 i_ret = SHOUTERR_UNCONNECTED;
408             }
409
410             /* IceCAST using HTTP protocol */
411             i_ret = shout_set_protocol( p_shout, SHOUT_PROTOCOL_HTTP );
412             if( i_ret != SHOUTERR_SUCCESS )
413             {
414                 msg_Err( p_access, "failed to set the protocol to 'http'" );
415                 free( p_access->p_sys );
416                 free( psz_accessname );
417                 return VLC_EGENERIC;
418             }
419             i_ret = shout_open( p_shout );
420             if( i_ret == SHOUTERR_SUCCESS )
421             {
422                 i_ret = SHOUTERR_CONNECTED;
423                 msg_Dbg( p_access, "connected using 'http' (icecast 2.x) protocol" );
424             }
425             else
426                 msg_Warn( p_access, "failed to connect using 'http' (icecast 2.x) protocol " );
427         }
428 /*
429         for non-blocking, use:
430         while( i_ret == SHOUTERR_BUSY )
431         {
432             sleep( 1 );
433             i_ret = shout_get_connected( p_shout );
434         }
435 */
436         if ( i_ret != SHOUTERR_CONNECTED )
437         {
438             msg_Warn( p_access, "unable to establish connection, retrying..." );
439             msleep( 30000000 );
440         }
441     }
442
443     if( i_ret != SHOUTERR_CONNECTED )
444     {
445         msg_Err( p_access, "failed to open shout stream to %s:%i/%s: %s",
446                  psz_host, i_port, psz_mount, shout_get_error(p_shout) );
447         free( p_access->p_sys );
448         free( psz_accessname );
449         return VLC_EGENERIC;
450     }
451
452     p_access->pf_write = Write;
453     p_access->pf_seek  = Seek;
454
455     msg_Dbg( p_access, "shout access output opened (%s@%s:%i/%s)",
456              psz_user, psz_host, i_port, psz_mount );
457
458     /* Update pace control flag */
459     if( p_access->psz_access && !strcmp( p_access->psz_access, "stream" ) )
460     {
461         p_access->p_sout->i_out_pace_nocontrol++;
462     }
463
464     free( psz_accessname );
465
466     return VLC_SUCCESS;
467 }
468
469 /*****************************************************************************
470  * Close: close the target
471  *****************************************************************************/
472 static void Close( vlc_object_t * p_this )
473 {
474     sout_access_out_t *p_access = (sout_access_out_t*)p_this;
475
476     if( p_access->p_sys && p_access->p_sys->p_shout )
477     {
478         shout_close( p_access->p_sys->p_shout );
479         shout_shutdown();
480     }
481     free( p_access->p_sys );
482
483     /* Update pace control flag */
484     if( p_access->psz_access && !strcmp( p_access->psz_access, "stream" ) )
485     {
486         p_access->p_sout->i_out_pace_nocontrol--;
487     }
488
489     msg_Dbg( p_access, "shout access output closed" );
490 }
491
492 /*****************************************************************************
493  * Write: standard write
494  *****************************************************************************/
495 static ssize_t Write( sout_access_out_t *p_access, block_t *p_buffer )
496 {
497     size_t i_write = 0;
498
499     shout_sync( p_access->p_sys->p_shout );
500     while( p_buffer )
501     {
502         block_t *p_next = p_buffer->p_next;
503
504         if( shout_send( p_access->p_sys->p_shout,
505                         p_buffer->p_buffer, p_buffer->i_buffer )
506              == SHOUTERR_SUCCESS )
507         {
508             i_write += p_buffer->i_buffer;
509         }
510         else
511         {
512             msg_Err( p_access, "cannot write to stream: %s",
513                      shout_get_error(p_access->p_sys->p_shout) );
514
515             /* The most common cause seems to be a server disconnect, resulting in a
516                Socket Error which can only be fixed by closing and reconnecting.
517                Since we already began with a working connection, the most feasable
518                approach to get out of this error status is a (timed) reconnect approach. */
519             shout_close( p_access->p_sys->p_shout );
520             msg_Warn( p_access, "server unavailable? trying to reconnect..." );
521             /* Re-open the connection (protocol params have already been set) and re-sync */
522             if( shout_open( p_access->p_sys->p_shout ) == SHOUTERR_SUCCESS )
523             {
524                 shout_sync( p_access->p_sys->p_shout );
525                 msg_Warn( p_access, "reconnected to server" );
526             }
527             else
528             {
529                 msg_Err( p_access, "failed to reconnect to server" );
530                 block_ChainRelease (p_buffer);
531                 return VLC_EGENERIC;
532             }
533
534         }
535         block_Release( p_buffer );
536
537         /* XXX: Unsure if that's the cause for some audio trouble... */
538
539         p_buffer = p_next;
540     }
541
542     return i_write;
543 }
544
545 /*****************************************************************************
546  * Seek: seek to a specific location -- not supported
547  *****************************************************************************/
548 static int Seek( sout_access_out_t *p_access, off_t i_pos )
549 {
550     msg_Err( p_access, "cannot seek on shout" );
551     return VLC_EGENERIC;
552 }
553