]> git.sesse.net Git - vlc/blob - modules/demux/playlist/shoutcast.c
input_item: Remove input_item_AddSubItem2 and send subitem_added event from input_ite...
[vlc] / modules / demux / playlist / shoutcast.c
1 /*****************************************************************************
2  * shoutcast.c: Winamp >=5.2 shoutcast demuxer
3  *****************************************************************************
4  * Copyright (C) 2006 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Antoine Cellerier <dionoea -@t- videolan -Dot- org>
8  *          based on b4s.c by Sigmund Augdal Helberg <dnumgis@videolan.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  * Preamble
27  *****************************************************************************/
28
29 #ifdef HAVE_CONFIG_H
30 # include "config.h"
31 #endif
32
33 #include <vlc_common.h>
34 #include <vlc_demux.h>
35
36 #include "playlist.h"
37 #include <vlc_xml.h>
38
39 /* duplicate from modules/services_discovery/shout.c */
40 #define SHOUTCAST_BASE_URL "http/shout-winamp://www.shoutcast.com/sbin/newxml.phtml"
41 #define SHOUTCAST_TUNEIN_BASE_URL "http://www.shoutcast.com"
42 #define SHOUTCAST_TV_TUNEIN_URL "http://www.shoutcast.com/sbin/tunein-tvstation.pls?id="
43
44 /*****************************************************************************
45  * Local prototypes
46  *****************************************************************************/
47 static int Demux( demux_t *p_demux);
48 static int Control( demux_t *p_demux, int i_query, va_list args );
49
50 static int DemuxGenre( demux_t *p_demux, xml_reader_t *p_xml_reader,
51                        input_item_node_t *p_input_node );
52 static int DemuxStation( demux_t *p_demux, xml_reader_t *p_xml_reader,
53                          input_item_node_t *p_input_node, bool b_adult );
54
55 /*****************************************************************************
56  * Import_Shoutcast: main import function
57  *****************************************************************************/
58 int Import_Shoutcast( vlc_object_t *p_this )
59 {
60     demux_t *p_demux = (demux_t *)p_this;
61
62     if( !demux_IsForced( p_demux, "shout-winamp" ) )
63         return VLC_EGENERIC;
64
65     p_demux->pf_demux = Demux;
66     p_demux->pf_control = Control;
67     msg_Dbg( p_demux, "using shoutcast playlist reader" );
68
69     return VLC_SUCCESS;
70 }
71
72 /*****************************************************************************
73  * Deactivate: frees unused data
74  *****************************************************************************/
75 void Close_Shoutcast( vlc_object_t *p_this )
76 {
77     (void)p_this;
78 }
79
80 static int Demux( demux_t *p_demux )
81 {
82     xml_t *p_xml;
83     xml_reader_t *p_xml_reader = NULL;
84     char *psz_eltname = NULL;
85     int i_ret = -1;
86     input_item_t *p_current_input = GetCurrentItem(p_demux);
87
88     p_xml = xml_Create( p_demux );
89     if( !p_xml )
90         goto error;
91
92     p_xml_reader = xml_ReaderCreate( p_xml, p_demux->s );
93     if( !p_xml_reader )
94         goto error;
95
96     /* check root node */
97     if( xml_ReaderRead( p_xml_reader ) != 1 )
98     {
99         msg_Err( p_demux, "invalid file (no root node)" );
100         goto error;
101     }
102
103     if( xml_ReaderNodeType( p_xml_reader ) != XML_READER_STARTELEM ||
104         ( psz_eltname = xml_ReaderName( p_xml_reader ) ) == NULL ||
105         ( strcmp( psz_eltname, "genrelist" )
106           && strcmp( psz_eltname, "stationlist" ) ) )
107     {
108         msg_Err( p_demux, "invalid root node %i, %s",
109                  xml_ReaderNodeType( p_xml_reader ), psz_eltname );
110         goto error;
111     }
112
113     input_item_node_t *p_input_node = input_item_node_Create( p_current_input );
114
115     if( !strcmp( psz_eltname, "genrelist" ) )
116     {
117         /* we're reading a genre list */
118         if( DemuxGenre( p_demux, p_xml_reader, p_input_node ) )
119             goto error;
120     }
121     else
122     {
123         /* we're reading a station list */
124         if( DemuxStation( p_demux, p_xml_reader, p_input_node,
125                 var_CreateGetBool( p_demux, "shoutcast-show-adult" ) ) )
126             goto error;
127     }
128
129     input_item_AddSubItemTree( p_input_node );
130
131     i_ret = 0; /* Needed for correct operation of go back */
132
133 error:
134     if( p_xml_reader )
135         xml_ReaderDelete( p_xml, p_xml_reader );
136     if( p_xml )
137         xml_Delete( p_xml );
138     free( psz_eltname );
139     input_item_node_Delete( p_input_node );
140     vlc_gc_decref(p_current_input);
141     return i_ret;
142 }
143
144 #define GET_VALUE( a ) \
145                         if( !strcmp( psz_attrname, #a ) ) \
146                         { \
147                             free(psz_ ## a); \
148                             psz_ ## a = psz_attrvalue; \
149                         }
150 /* <genrelist>
151  *   <genre name="the name"></genre>
152  *   ...
153  * </genrelist>
154  **/
155 static int DemuxGenre( demux_t *p_demux, xml_reader_t *p_xml_reader,
156                        input_item_node_t *p_input_node )
157 {
158     char *psz_name = NULL; /* genre name */
159     int i_ret = -1;
160
161     while( xml_ReaderRead( p_xml_reader ) == 1 )
162     {
163         // Get the node type
164         switch( xml_ReaderNodeType( p_xml_reader ) )
165         {
166             // Error
167             case -1:
168                 goto error;
169
170             case XML_READER_STARTELEM:
171             {
172                 // Read the element name
173                 char *psz_eltname = xml_ReaderName( p_xml_reader );
174                 if( !psz_eltname )
175                     goto error;
176
177                 if( !strcmp( psz_eltname, "genre" ) )
178                 {
179                     // Read the attributes
180                     while( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
181                     {
182                         char *psz_attrname = xml_ReaderName( p_xml_reader );
183                         char *psz_attrvalue =
184                             xml_ReaderValue( p_xml_reader );
185                         if( !psz_attrname || !psz_attrvalue )
186                         {
187                             free( psz_attrname );
188                             free( psz_attrvalue );
189                             free( psz_eltname );
190                             break;
191                         }
192
193                         GET_VALUE( name )
194                         else
195                         {
196                             msg_Warn( p_demux,
197                                       "unexpected attribure %s in element %s",
198                                       psz_attrname, psz_eltname );
199                             free( psz_attrvalue );
200                         }
201                         free( psz_attrname );
202                     }
203                 }
204                 free( psz_eltname );
205                 break;
206             }
207
208             case XML_READER_TEXT:
209                 break;
210
211             // End element
212             case XML_READER_ENDELEM:
213             {
214                 // Read the element name
215                 char *psz_eltname = xml_ReaderName( p_xml_reader );
216                 if( !psz_eltname )
217                     goto error;
218
219                 if( !strcmp( psz_eltname, "genre" ) )
220                 {
221                     char* psz_mrl;
222                     if( asprintf( &psz_mrl, SHOUTCAST_BASE_URL "?genre=%s",
223                              psz_name ) != -1 )
224                     {
225                         input_item_t *p_input;
226                         p_input = input_item_New( p_demux, psz_mrl, psz_name );
227                         input_item_CopyOptions( p_input_node->p_item, p_input );
228                         free( psz_mrl );
229                         input_item_node_AppendItem( p_input_node, p_input );
230                         vlc_gc_decref( p_input );
231                     }
232                     FREENULL( psz_name );
233                 }
234                 free( psz_eltname );
235                 break;
236             }
237         }
238     }
239     i_ret = 0;
240
241 error:
242     free( psz_name );
243     return i_ret;
244 }
245
246 /* radio stations:
247  * <stationlist>
248  *   <tunein base="/sbin/tunein-station.pls"></tunein>
249  *   <station name="the name"
250  *            mt="mime type"
251  *            id="the id"
252  *            br="bit rate"
253  *            genre="A big genre string"
254  *            ct="current track name/author/..."
255  *            lc="listener count"></station>
256  * </stationlist>
257  *
258  * TV stations:
259  * <stationlist>
260  *   <tunein base="/sbin/tunein-station.pls"></tunein>
261  *   <station name="the name"
262  *            id="the id"
263  *            br="bit rate"
264  *            rt="rating"
265  *            load="server load ?"
266  *            ct="current track name/author/..."
267  *            genre="A big genre string"
268  *            lc="listener count"></station>
269  * </stationlist>
270  **/
271 static int DemuxStation( demux_t *p_demux, xml_reader_t *p_xml_reader,
272                          input_item_node_t *p_input_node, bool b_adult )
273 {
274     char *psz_base = NULL; /* */
275
276     char *psz_name = NULL; /* genre name */
277     char *psz_mt = NULL; /* mime type */
278     char *psz_id = NULL; /* id */
279     char *psz_br = NULL; /* bit rate */
280     char *psz_genre = NULL; /* genre */
281     char *psz_ct = NULL; /* current track */
282     char *psz_lc = NULL; /* listener count */
283
284     /* If these are set then it's *not* a radio but a TV */
285     char *psz_rt = NULL; /* rating for shoutcast TV */
286     char *psz_load = NULL; /* load for shoutcast TV */
287
288     char *psz_eltname = NULL; /* tag name */
289
290     while( xml_ReaderRead( p_xml_reader ) == 1 )
291     {
292         int i_type;
293
294         // Get the node type
295         i_type = xml_ReaderNodeType( p_xml_reader );
296         switch( i_type )
297         {
298             // Error
299             case -1:
300                 return -1;
301                 break;
302
303             case XML_READER_STARTELEM:
304                 // Read the element name
305                 psz_eltname = xml_ReaderName( p_xml_reader );
306                 if( !psz_eltname ) return -1;
307
308                 // Read the attributes
309                 if( !strcmp( psz_eltname, "tunein" ) )
310                 {
311                     while( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
312                     {
313                         char *psz_attrname = xml_ReaderName( p_xml_reader );
314                         char *psz_attrvalue =
315                             xml_ReaderValue( p_xml_reader );
316                         if( !psz_attrname || !psz_attrvalue )
317                         {
318                             free( psz_eltname );
319                             free( psz_attrname );
320                             free( psz_attrvalue );
321                             return -1;
322                         }
323
324                         GET_VALUE( base )
325                         else
326                         {
327                             msg_Warn( p_demux,
328                                       "unexpected attribure %s in element %s",
329                                       psz_attrname, psz_eltname );
330                             free( psz_attrvalue );
331                         }
332                         free( psz_attrname );
333                     }
334                 }
335                 else if( !strcmp( psz_eltname, "station" ) )
336                 {
337                     while( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
338                     {
339                         char *psz_attrname = xml_ReaderName( p_xml_reader );
340                         char *psz_attrvalue =
341                             xml_ReaderValue( p_xml_reader );
342                         if( !psz_attrname || !psz_attrvalue )
343                         {
344                             free( psz_eltname );
345                             free( psz_attrname );
346                             free( psz_attrvalue );
347                             return -1;
348                         }
349
350                         GET_VALUE( name )
351                         else GET_VALUE( mt )
352                         else GET_VALUE( id )
353                         else GET_VALUE( br )
354                         else GET_VALUE( genre )
355                         else GET_VALUE( ct )
356                         else GET_VALUE( lc )
357                         else GET_VALUE( rt )
358                         else GET_VALUE( load )
359                         else
360                         {
361                             msg_Warn( p_demux,
362                                       "unexpected attribute %s in element %s",
363                                       psz_attrname, psz_eltname );
364                             free( psz_attrvalue );
365                         }
366                         free( psz_attrname );
367                     }
368                 }
369                 free( psz_eltname );
370                 break;
371
372             case XML_READER_TEXT:
373                 break;
374
375             // End element
376             case XML_READER_ENDELEM:
377                 // Read the element name
378                 psz_eltname = xml_ReaderName( p_xml_reader );
379                 if( !psz_eltname ) return -1;
380                 if( !strcmp( psz_eltname, "station" ) &&
381                     ( psz_base || ( psz_rt && psz_load &&
382                     ( b_adult || strcmp( psz_rt, "NC17" ) ) ) ) )
383                 {
384                     char *psz_mrl = NULL;
385                     if( psz_rt || psz_load )
386                     {
387                         /* tv */
388                         if( asprintf( &psz_mrl, SHOUTCAST_TV_TUNEIN_URL "%s",
389                                  psz_id ) == -1)
390                             psz_mrl = NULL;
391                     }
392                     else
393                     {
394                         /* radio */
395                         if( asprintf( &psz_mrl, SHOUTCAST_TUNEIN_BASE_URL "%s?id=%s",
396                              psz_base, psz_id ) == -1 )
397                             psz_mrl = NULL;
398                     }
399
400                     /* Create the item */
401                     input_item_t *p_input;
402                     p_input = input_item_New( p_demux, psz_mrl, psz_name );
403                     input_item_CopyOptions( p_input_node->p_item, p_input );
404                     free( psz_mrl );
405
406 #define SADD_INFO( type, field ) \
407                     if( field ) \
408                         input_item_AddInfo( p_input, _("Shoutcast"), \
409                                             vlc_gettext(type), "%s", field )
410                     SADD_INFO( N_("Mime"), psz_mt );
411                     SADD_INFO( N_("Bitrate"), psz_br );
412                     SADD_INFO( N_("Listeners"), psz_lc );
413                     SADD_INFO( N_("Load"), psz_load );
414                     if( psz_genre )
415                         input_item_SetGenre( p_input, psz_genre );
416                     if( psz_ct )
417                         input_item_SetNowPlaying( p_input, psz_ct );
418                     if( psz_rt )
419                         input_item_SetRating( p_input, psz_rt );
420                     input_item_node_AppendItem( p_input_node, p_input );
421                     vlc_gc_decref( p_input );
422                     FREENULL( psz_base );
423                     FREENULL( psz_name );
424                     FREENULL( psz_mt );
425                     FREENULL( psz_id );
426                     FREENULL( psz_br );
427                     FREENULL( psz_genre );
428                     FREENULL( psz_ct );
429                     FREENULL( psz_lc );
430                     FREENULL( psz_rt );
431                     FREENULL( psz_load );
432                 }
433                 free( psz_eltname );
434                 break;
435         }
436     }
437     return 0;
438 }
439
440 static int Control( demux_t *p_demux, int i_query, va_list args )
441 {
442     VLC_UNUSED(p_demux); VLC_UNUSED(i_query); VLC_UNUSED(args);
443     return VLC_EGENERIC;
444 }