Fix xspf reading/writing
[vlc.git] / modules / demux / playlist / xspf.c
1 /*******************************************************************************
2  * xspf.c : XSPF playlist import functions
3  *******************************************************************************
4  * Copyright (C) 2006 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Daniel Stränger <vlc at schmaller dot de>
8  *          Yoann Peronneau <yoann@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  * \file modules/demux/playlist/xspf.c
26  * \brief XSPF playlist import functions
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 <vlc_xml.h>
37 #include <vlc_strings.h>
38 #include <vlc_url.h>
39 #include "xspf.h"
40 #include "playlist.h"
41
42 struct demux_sys_t
43 {
44     input_item_t **pp_tracklist;
45     int i_tracklist_entries;
46     int i_track_id;
47     char * psz_base;
48 };
49
50 static int Control( demux_t *, int, va_list );
51 static int Demux( demux_t * );
52
53 /**
54  * \brief XSPF submodule initialization function
55  */
56 int Import_xspf( vlc_object_t *p_this )
57 {
58     DEMUX_BY_EXTENSION_OR_FORCED_MSG( ".xspf", "xspf-open",
59                                       "using XSPF playlist reader" );
60     return VLC_SUCCESS;
61 }
62
63 void Close_xspf( vlc_object_t *p_this )
64 {
65     demux_t *p_demux = (demux_t *)p_this;
66     int i;
67     for(i = 0; i < p_demux->p_sys->i_tracklist_entries; i++)
68     {
69         if(p_demux->p_sys->pp_tracklist[i])
70             vlc_gc_decref( p_demux->p_sys->pp_tracklist[i] );
71     }
72     free( p_demux->p_sys->pp_tracklist );
73     free( p_demux->p_sys->psz_base );
74     free( p_demux->p_sys );
75 }
76
77 /**
78  * \brief demuxer function for XSPF parsing
79  */
80 int Demux( demux_t *p_demux )
81 {
82     int i_ret = 1;
83     xml_t *p_xml = NULL;
84     xml_reader_t *p_xml_reader = NULL;
85     char *psz_name = NULL;
86     INIT_PLAYLIST_STUFF;
87     p_demux->p_sys->pp_tracklist = NULL;
88     p_demux->p_sys->i_tracklist_entries = 0;
89     p_demux->p_sys->i_track_id = -1;
90     p_demux->p_sys->psz_base = NULL;
91
92     /* create new xml parser from stream */
93     p_xml = xml_Create( p_demux );
94     if( !p_xml )
95         i_ret = -1;
96     else
97     {
98         p_xml_reader = xml_ReaderCreate( p_xml, p_demux->s );
99         if( !p_xml_reader )
100             i_ret = -1;
101     }
102
103     /* locating the root node */
104     if( i_ret == 1 )
105     {
106         do
107         {
108             if( xml_ReaderRead( p_xml_reader ) != 1 )
109             {
110                 msg_Err( p_demux, "can't read xml stream" );
111                 i_ret = -1;
112             }
113         } while( i_ret == VLC_SUCCESS &&
114                  xml_ReaderNodeType( p_xml_reader ) != XML_READER_STARTELEM );
115     }
116     /* checking root node name */
117     if( i_ret == 1 )
118     {
119         psz_name = xml_ReaderName( p_xml_reader );
120         if( !psz_name || strcmp( psz_name, "playlist" ) )
121         {
122             msg_Err( p_demux, "invalid root node name: %s", psz_name );
123             i_ret = -1;
124         }
125         FREE_NAME();
126     }
127
128     if( i_ret == 1 )
129         i_ret = parse_playlist_node( p_demux, p_current_input,
130                                      p_xml_reader, "playlist" ) ? 0 : -1;
131
132     int i;
133     for( i = 0 ; i < p_demux->p_sys->i_tracklist_entries ; i++ )
134     {
135         input_item_t *p_new_input = p_demux->p_sys->pp_tracklist[i];
136         if( p_new_input )
137         {
138             input_item_AddSubItem( p_current_input, p_new_input );
139         }
140     }
141
142     HANDLE_PLAY_AND_RELEASE;
143     if( p_xml_reader )
144         xml_ReaderDelete( p_xml, p_xml_reader );
145     if( p_xml )
146         xml_Delete( p_xml );
147     return i_ret; /* Needed for correct operation of go back */
148 }
149
150 /** \brief dummy function for demux callback interface */
151 static int Control( demux_t *p_demux, int i_query, va_list args )
152 {
153     VLC_UNUSED(p_demux); VLC_UNUSED(i_query); VLC_UNUSED(args);
154     return VLC_EGENERIC;
155 }
156
157 /**
158  * \brief parse the root node of a XSPF playlist
159  * \param p_demux demuxer instance
160  * \param p_input_item current input item
161  * \param p_xml_reader xml reader instance
162  * \param psz_element name of element to parse
163  */
164 static bool parse_playlist_node COMPLEX_INTERFACE
165 {
166     char *psz_name = NULL;
167     char *psz_value = NULL;
168     bool b_version_found = false;
169     int i_node;
170     xml_elem_hnd_t *p_handler = NULL;
171
172     xml_elem_hnd_t pl_elements[] =
173         { {"title",        SIMPLE_CONTENT,  {.smpl = set_item_info} },
174           {"creator",      SIMPLE_CONTENT,  {.smpl = set_item_info} },
175           {"annotation",   SIMPLE_CONTENT,  {.smpl = set_item_info} },
176           {"info",         SIMPLE_CONTENT,  {NULL} },
177           {"location",     SIMPLE_CONTENT,  {NULL} },
178           {"identifier",   SIMPLE_CONTENT,  {NULL} },
179           {"image",        SIMPLE_CONTENT,  {.smpl = set_item_info} },
180           {"date",         SIMPLE_CONTENT,  {NULL} },
181           {"license",      SIMPLE_CONTENT,  {NULL} },
182           {"attribution",  COMPLEX_CONTENT, {.cmplx = skip_element} },
183           {"link",         SIMPLE_CONTENT,  {NULL} },
184           {"meta",         SIMPLE_CONTENT,  {NULL} },
185           {"extension",    COMPLEX_CONTENT, {.cmplx = parse_extension_node} },
186           {"trackList",    COMPLEX_CONTENT, {.cmplx = parse_tracklist_node} },
187           {NULL,           UNKNOWN_CONTENT, {NULL} }
188         };
189
190     /* read all playlist attributes */
191     while( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
192     {
193         psz_name = xml_ReaderName( p_xml_reader );
194         psz_value = xml_ReaderValue( p_xml_reader );
195         if( !psz_name || !psz_value )
196         {
197             msg_Err( p_demux, "invalid xml stream @ <playlist>" );
198             FREE_ATT();
199             return false;
200         }
201         /* attribute: version */
202         if( !strcmp( psz_name, "version" ) )
203         {
204             b_version_found = true;
205             if( strcmp( psz_value, "0" ) && strcmp( psz_value, "1" ) )
206                 msg_Warn( p_demux, "unsupported XSPF version" );
207         }
208         /* attribute: xmlns */
209         else if( !strcmp( psz_name, "xmlns" ) || !strcmp( psz_name, "xmlns:vlc" ) )
210             ;
211         else if( !strcmp( psz_name, "xml:base" ) )
212         {
213             p_demux->p_sys->psz_base = decode_URI_duplicate( psz_value );
214         }
215         /* unknown attribute */
216         else
217             msg_Warn( p_demux, "invalid <playlist> attribute:\"%s\"", psz_name);
218
219         FREE_ATT();
220     }
221     /* attribute version is mandatory !!! */
222     if( !b_version_found )
223         msg_Warn( p_demux, "<playlist> requires \"version\" attribute" );
224
225     /* parse the child elements - we only take care of <trackList> */
226     while( xml_ReaderRead( p_xml_reader ) == 1 )
227     {
228         i_node = xml_ReaderNodeType( p_xml_reader );
229         switch( i_node )
230         {
231             case XML_READER_NONE:
232                 break;
233             case XML_READER_STARTELEM:
234                 /*  element start tag  */
235                 psz_name = xml_ReaderName( p_xml_reader );
236                 if( !psz_name || !*psz_name )
237                 {
238                     msg_Err( p_demux, "invalid xml stream" );
239                     FREE_ATT();
240                     return false;
241                 }
242                 /* choose handler */
243                 for( p_handler = pl_elements;
244                      p_handler->name && strcmp( psz_name, p_handler->name );
245                      p_handler++ );
246                 if( !p_handler->name )
247                 {
248                     msg_Err( p_demux, "unexpected element <%s>", psz_name );
249                     FREE_ATT();
250                     return false;
251                 }
252                 FREE_NAME();
253                 /* complex content is parsed in a separate function */
254                 if( p_handler->type == COMPLEX_CONTENT )
255                 {
256                     if( p_handler->pf_handler.cmplx( p_demux,
257                                                      p_input_item,
258                                                      p_xml_reader,
259                                                      p_handler->name ) )
260                     {
261                         p_handler = NULL;
262                         FREE_ATT();
263                     }
264                     else
265                     {
266                         FREE_ATT();
267                         return false;
268                     }
269                 }
270                 break;
271
272             case XML_READER_TEXT:
273                 /* simple element content */
274                 FREE_ATT();
275                 psz_value = xml_ReaderValue( p_xml_reader );
276                 if( !psz_value )
277                 {
278                     msg_Err( p_demux, "invalid xml stream" );
279                     FREE_ATT();
280                     return false;
281                 }
282                 break;
283
284             case XML_READER_ENDELEM:
285                 /* element end tag */
286                 psz_name = xml_ReaderName( p_xml_reader );
287                 if( !psz_name )
288                 {
289                     msg_Err( p_demux, "invalid xml stream" );
290                     FREE_ATT();
291                     return false;
292                 }
293                 /* leave if the current parent node <playlist> is terminated */
294                 if( !strcmp( psz_name, psz_element ) )
295                 {
296                     FREE_ATT();
297                     return true;
298                 }
299                 /* there MUST have been a start tag for that element name */
300                 if( !p_handler || !p_handler->name
301                     || strcmp( p_handler->name, psz_name ))
302                 {
303                     msg_Err( p_demux, "there's no open element left for <%s>",
304                              psz_name );
305                     FREE_ATT();
306                     return false;
307                 }
308
309                 if( p_handler->pf_handler.smpl )
310                 {
311                     p_handler->pf_handler.smpl( p_input_item, p_handler->name,
312                                                 psz_value );
313                 }
314                 FREE_ATT();
315                 p_handler = NULL;
316                 break;
317
318             default:
319                 /* unknown/unexpected xml node */
320                 msg_Err( p_demux, "unexpected xml node %i", i_node );
321                 FREE_ATT();
322                 return false;
323         }
324         FREE_NAME();
325     }
326     return false;
327 }
328
329 /**
330  * \brief parses the tracklist node which only may contain <track>s
331  */
332 static bool parse_tracklist_node COMPLEX_INTERFACE
333 {
334     VLC_UNUSED(psz_element);
335     char *psz_name = NULL;
336     int i_node;
337     int i_ntracks = 0;
338
339     /* now parse the <track>s */
340     while( xml_ReaderRead( p_xml_reader ) == 1 )
341     {
342         i_node = xml_ReaderNodeType( p_xml_reader );
343         if( i_node == XML_READER_STARTELEM )
344         {
345             psz_name = xml_ReaderName( p_xml_reader );
346             if( !psz_name )
347             {
348                 msg_Err( p_demux, "unexpected end of xml data" );
349                 FREE_NAME();
350                 return false;
351             }
352             if( strcmp( psz_name, "track") )
353             {
354                 msg_Err( p_demux, "unexpected child of <trackList>: <%s>",
355                          psz_name );
356                 FREE_NAME();
357                 return false;
358             }
359             FREE_NAME();
360
361             /* parse the track data in a separate function */
362             if( parse_track_node( p_demux, p_input_item,
363                                    p_xml_reader,"track" ) == true )
364                 i_ntracks++;
365         }
366         else if( i_node == XML_READER_ENDELEM )
367             break;
368     }
369
370     /* the <trackList> has to be terminated */
371     if( xml_ReaderNodeType( p_xml_reader ) != XML_READER_ENDELEM )
372     {
373         msg_Err( p_demux, "there's a missing </trackList>" );
374         FREE_NAME();
375         return false;
376     }
377     psz_name = xml_ReaderName( p_xml_reader );
378     if( !psz_name || strcmp( psz_name, "trackList" ) )
379     {
380         msg_Err( p_demux, "expected: </trackList>, found: </%s>", psz_name );
381         FREE_NAME();
382         return false;
383     }
384     FREE_NAME();
385
386     msg_Dbg( p_demux, "parsed %i tracks successfully", i_ntracks );
387
388     return true;
389 }
390
391 /**
392  * \brief parse one track element
393  * \param COMPLEX_INTERFACE
394  */
395 static bool parse_track_node COMPLEX_INTERFACE
396 {
397     int i_node;
398     char *psz_name = NULL;
399     char *psz_value = NULL;
400     xml_elem_hnd_t *p_handler = NULL;
401
402     xml_elem_hnd_t track_elements[] =
403         { {"location",     SIMPLE_CONTENT,  {NULL} },
404           {"identifier",   SIMPLE_CONTENT,  {NULL} },
405           {"title",        SIMPLE_CONTENT,  {.smpl = set_item_info} },
406           {"creator",      SIMPLE_CONTENT,  {.smpl = set_item_info} },
407           {"annotation",   SIMPLE_CONTENT,  {.smpl = set_item_info} },
408           {"info",         SIMPLE_CONTENT,  {NULL} },
409           {"image",        SIMPLE_CONTENT,  {.smpl = set_item_info} },
410           {"album",        SIMPLE_CONTENT,  {.smpl = set_item_info} },
411           {"trackNum",     SIMPLE_CONTENT,  {.smpl = set_item_info} },
412           {"duration",     SIMPLE_CONTENT,  {.smpl = set_item_info} },
413           {"link",         SIMPLE_CONTENT,  {NULL} },
414           {"meta",         SIMPLE_CONTENT,  {NULL} },
415           {"extension",    COMPLEX_CONTENT, {.cmplx = parse_extension_node} },
416           {NULL,           UNKNOWN_CONTENT, {NULL} }
417         };
418
419     input_item_t *p_new_input = input_item_New( p_demux, NULL, NULL );
420
421     if( !p_new_input )
422     {
423         /* malloc has failed for input_item_New, so bailout early */
424         return false;
425     }
426
427     /* reset i_track_id */
428     p_demux->p_sys->i_track_id = -1;
429
430     while( xml_ReaderRead( p_xml_reader ) == 1 )
431     {
432         i_node = xml_ReaderNodeType( p_xml_reader );
433         switch( i_node )
434         {
435             case XML_READER_NONE:
436                 break;
437
438             case XML_READER_STARTELEM:
439                 /*  element start tag  */
440                 psz_name = xml_ReaderName( p_xml_reader );
441                 if( !psz_name || !*psz_name )
442                 {
443                     msg_Err( p_demux, "invalid xml stream" );
444                     FREE_ATT();
445                     return false;
446                 }
447                 /* choose handler */
448                 for( p_handler = track_elements;
449                      p_handler->name && strcmp( psz_name, p_handler->name );
450                      p_handler++ );
451                 if( !p_handler->name )
452                 {
453                     msg_Err( p_demux, "unexpected element <%s>", psz_name );
454                     FREE_ATT();
455                     return false;
456                 }
457                 FREE_NAME();
458                 /* complex content is parsed in a separate function */
459                 if( p_handler->type == COMPLEX_CONTENT )
460                 {
461                     if( !p_new_input )
462                     {
463                         msg_Err( p_demux,
464                                  "at <%s> level no new item has been allocated",
465                                  p_handler->name );
466                         FREE_ATT();
467                         return false;
468                     }
469                     if( p_handler->pf_handler.cmplx( p_demux,
470                                                      p_new_input,
471                                                      p_xml_reader,
472                                                      p_handler->name ) )
473                     {
474                         p_handler = NULL;
475                         FREE_ATT();
476                     }
477                     else
478                     {
479                         FREE_ATT();
480                         return false;
481                     }
482                 }
483                 break;
484
485             case XML_READER_TEXT:
486                 /* simple element content */
487                 FREE_ATT();
488                 psz_value = xml_ReaderValue( p_xml_reader );
489                 if( !psz_value )
490                 {
491                     msg_Err( p_demux, "invalid xml stream" );
492                     FREE_ATT();
493                     return false;
494                 }
495                 break;
496
497             case XML_READER_ENDELEM:
498                 /* element end tag */
499                 psz_name = xml_ReaderName( p_xml_reader );
500                 if( !psz_name )
501                 {
502                     msg_Err( p_demux, "invalid xml stream" );
503                     FREE_ATT();
504                     return false;
505                 }
506                 /* leave if the current parent node <track> is terminated */
507                 if( !strcmp( psz_name, psz_element ) )
508                 {
509                     FREE_ATT();
510
511                     if( p_demux->p_sys->i_track_id < 0 )
512                     {
513                         input_item_AddSubItem( p_input_item, p_new_input );
514                         vlc_gc_decref( p_new_input );
515                         return true;
516                     }
517
518                     if( p_demux->p_sys->i_track_id >=
519                            p_demux->p_sys->i_tracklist_entries )
520                     {
521                         input_item_t **pp;
522                         pp = realloc( p_demux->p_sys->pp_tracklist,
523                             (p_demux->p_sys->i_track_id + 1) * sizeof(*pp) );
524                         if( !pp )
525                             return false;
526                         p_demux->p_sys->pp_tracklist = pp;
527                         while( p_demux->p_sys->i_track_id >=
528                                p_demux->p_sys->i_tracklist_entries )
529                             pp[p_demux->p_sys->i_tracklist_entries++] = NULL;
530                     }
531
532                     p_demux->p_sys->pp_tracklist[
533                             p_demux->p_sys->i_track_id ] = p_new_input;
534                     return true;
535                 }
536                 /* there MUST have been a start tag for that element name */
537                 if( !p_handler || !p_handler->name
538                     || strcmp( p_handler->name, psz_name ))
539                 {
540                     msg_Err( p_demux, "there's no open element left for <%s>",
541                              psz_name );
542                     FREE_ATT();
543                     return false;
544                 }
545
546                 /* special case: location */
547                 if( !strcmp( p_handler->name, "location" ) )
548                 {
549                     char *psz_location = psz_value;
550                     if( !strncmp( psz_value, "file://", 7 ) )
551                         psz_location = decode_URI( psz_value + 7 );
552
553                     if( !psz_location )
554                     {
555                         FREE_ATT();
556                         return false;
557                     }
558
559                     if( p_demux->p_sys->psz_base && !strstr( psz_value, "://" ) )
560                     {
561                         char* psz_tmp;
562                         if( asprintf( &psz_tmp, "%s%s", p_demux->p_sys->psz_base,
563                                       psz_location ) == -1 )
564                         {
565                             FREE_ATT();
566                             return NULL;
567                         }
568                         input_item_SetURI( p_new_input, psz_tmp );
569                         free( psz_tmp );
570                     }
571                     else
572                         input_item_SetURI( p_new_input, psz_location );
573                     input_item_CopyOptions( p_input_item, p_new_input );
574                     FREE_ATT();
575                     p_handler = NULL;
576                 }
577                 else
578                 {
579                     /* there MUST be an item */
580                     if( !p_new_input )
581                     {
582                         msg_Err( p_demux, "item not yet created at <%s>",
583                                  psz_name );
584                         FREE_ATT();
585                         return false;
586                     }
587                     if( p_handler->pf_handler.smpl )
588                     {
589                         p_handler->pf_handler.smpl( p_new_input,
590                                                     p_handler->name,
591                                                     psz_value );
592                         FREE_ATT();
593                     }
594                 }
595                 FREE_ATT();
596                 p_handler = NULL;
597                 break;
598
599             default:
600                 /* unknown/unexpected xml node */
601                 msg_Err( p_demux, "unexpected xml node %i", i_node );
602                 FREE_ATT();
603                 return false;
604         }
605         FREE_NAME();
606     }
607     msg_Err( p_demux, "unexpected end of xml data" );
608     FREE_ATT();
609     return false;
610 }
611
612 /**
613  * \brief handles the supported <track> sub-elements
614  */
615 static bool set_item_info SIMPLE_INTERFACE
616 {
617     /* exit if setting is impossible */
618     if( !psz_name || !psz_value || !p_input )
619         return false;
620
621
622     /* re-convert xml special characters inside psz_value */
623     resolve_xml_special_chars( psz_value );
624
625     /* handle each info element in a separate "if" clause */
626     if( !strcmp( psz_name, "title" ) )
627     {
628         input_item_SetTitle( p_input, psz_value );
629     }
630     else if( !strcmp( psz_name, "creator" ) )
631     {
632         input_item_SetArtist( p_input, psz_value );
633     }
634     else if( !strcmp( psz_name, "album" ) )
635     {
636         input_item_SetAlbum( p_input, psz_value );
637
638     }
639     else if( !strcmp( psz_name, "trackNum" ) )
640     {
641         input_item_SetTrackNum( p_input, psz_value );
642     }
643     else if( !strcmp( psz_name, "duration" ) )
644     {
645         long i_num = atol( psz_value );
646         input_item_SetDuration( p_input, (mtime_t) i_num*1000 );
647     }
648     else if( !strcmp( psz_name, "annotation" ) )
649     {
650         input_item_SetDescription( p_input, psz_value );
651     }
652     else if( !strcmp( psz_name, "image" ) )
653     {
654         input_item_SetArtURL( p_input, psz_value );
655     }
656     return true;
657 }
658
659 /**
660  * \brief handles the <vlc:option> elements
661  */
662 static bool set_option SIMPLE_INTERFACE
663 {
664     /* exit if setting is impossible */
665     if( !psz_name || !psz_value || !p_input )
666         return false;
667
668     /* re-convert xml special characters inside psz_value */
669     resolve_xml_special_chars( psz_value );
670
671     input_item_AddOption( p_input, psz_value, 0 );
672
673     return true;
674 }
675
676 /**
677  * \brief parse the extension node of a XSPF playlist
678  */
679 static bool parse_extension_node COMPLEX_INTERFACE
680 {
681     char *psz_name = NULL;
682     char *psz_value = NULL;
683     char *psz_title = NULL;
684     char *psz_application = NULL;
685     int i_node;
686     bool b_release_input_item = false;
687     xml_elem_hnd_t *p_handler = NULL;
688     input_item_t *p_new_input = NULL;
689
690     xml_elem_hnd_t pl_elements[] =
691         { {"vlc:node",   COMPLEX_CONTENT, {.cmplx = parse_extension_node} },
692           {"vlc:item",   COMPLEX_CONTENT, {.cmplx = parse_extitem_node} },
693           {"vlc:id",     SIMPLE_CONTENT, {NULL} },
694           {"vlc:option", SIMPLE_CONTENT, {.smpl = set_option} },
695           {NULL,    UNKNOWN_CONTENT, {NULL} }
696         };
697
698     /* read all extension node attributes */
699     while( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
700     {
701         psz_name = xml_ReaderName( p_xml_reader );
702         psz_value = xml_ReaderValue( p_xml_reader );
703         if( !psz_name || !psz_value )
704         {
705             msg_Err( p_demux, "invalid xml stream @ <vlc:node>" );
706             FREE_ATT();
707             return false;
708         }
709         /* attribute: title */
710         if( !strcmp( psz_name, "title" ) )
711         {
712             resolve_xml_special_chars( psz_value );
713             psz_title = strdup( psz_value );
714         }
715         /* extension attribute: application */
716         else if( !strcmp( psz_name, "application" ) )
717         {
718             psz_application = strdup( psz_value );
719         }
720         /* unknown attribute */
721         else
722             msg_Warn( p_demux, "invalid <%s> attribute:\"%s\"", psz_element,
723                       psz_name );
724
725         FREE_ATT();
726     }
727
728     /* attribute title is mandatory except for <extension> */
729     if( !strcmp( psz_element, "vlc:node" ) )
730     {
731         if( !psz_title )
732         {
733             msg_Warn( p_demux, "<vlc:node> requires \"title\" attribute" );
734             return false;
735         }
736         p_new_input = input_item_NewWithType( VLC_OBJECT( p_demux ),
737                           "vlc://nop", psz_title, 0, NULL, 0, -1,
738                           ITEM_TYPE_DIRECTORY );
739         if( p_new_input )
740         {
741             input_item_AddSubItem( p_input_item, p_new_input );
742             p_input_item = p_new_input;
743             b_release_input_item = true;
744         }
745         free( psz_title );
746     }
747     else if( !strcmp( psz_element, "extension" ) )
748     {
749         if( !psz_application )
750         {
751             msg_Warn( p_demux, "<extension> requires \"application\" attribute" );
752             return false;
753         }
754         else if( strcmp( psz_application, "http://www.videolan.org/vlc/playlist/0" ) )
755         {
756             msg_Dbg( p_demux, "Skipping \"%s\" extension tag", psz_application );
757             free( psz_application );
758             return false;
759         }
760     }
761     free( psz_application );
762
763     /* parse the child elements */
764     while( xml_ReaderRead( p_xml_reader ) == 1 )
765     {
766         i_node = xml_ReaderNodeType( p_xml_reader );
767         switch( i_node )
768         {
769             case XML_READER_NONE:
770                 break;
771             case XML_READER_STARTELEM:
772                 /*  element start tag  */
773                 psz_name = xml_ReaderName( p_xml_reader );
774                 if( !psz_name || !*psz_name )
775                 {
776                     msg_Err( p_demux, "invalid xml stream" );
777                     FREE_ATT();
778                     if( b_release_input_item ) vlc_gc_decref( p_new_input );
779                     return false;
780                 }
781                 /* choose handler */
782                 for( p_handler = pl_elements;
783                      p_handler->name && strcmp( psz_name, p_handler->name );
784                      p_handler++ );
785                 if( !p_handler->name )
786                 {
787                     msg_Err( p_demux, "unexpected element <%s>", psz_name );
788                     FREE_ATT();
789                     if( b_release_input_item ) vlc_gc_decref( p_new_input );
790                     return false;
791                 }
792                 FREE_NAME();
793                 /* complex content is parsed in a separate function */
794                 if( p_handler->type == COMPLEX_CONTENT )
795                 {
796                     if( p_handler->pf_handler.cmplx( p_demux,
797                                                      p_input_item,
798                                                      p_xml_reader,
799                                                      p_handler->name ) )
800                     {
801                         p_handler = NULL;
802                         FREE_ATT();
803                     }
804                     else
805                     {
806                         FREE_ATT();
807                         if( b_release_input_item ) vlc_gc_decref( p_new_input );
808                         return false;
809                     }
810                 }
811                 break;
812
813             case XML_READER_TEXT:
814                 /* simple element content */
815                 FREE_ATT();
816                 psz_value = xml_ReaderValue( p_xml_reader );
817                 if( !psz_value )
818                 {
819                     msg_Err( p_demux, "invalid xml stream" );
820                     FREE_ATT();
821                     if( b_release_input_item ) vlc_gc_decref( p_new_input );
822                     return false;
823                 }
824                 break;
825
826             case XML_READER_ENDELEM:
827                 /* element end tag */
828                 psz_name = xml_ReaderName( p_xml_reader );
829                 if( !psz_name )
830                 {
831                     msg_Err( p_demux, "invalid xml stream" );
832                     FREE_ATT();
833                     if( b_release_input_item ) vlc_gc_decref( p_new_input );
834                     return false;
835                 }
836                 /* leave if the current parent node is terminated */
837                 if( !strcmp( psz_name, psz_element ) )
838                 {
839                     FREE_ATT();
840                     if( b_release_input_item ) vlc_gc_decref( p_new_input );
841                     return true;
842                 }
843                 /* there MUST have been a start tag for that element name */
844                 if( !p_handler || !p_handler->name
845                     || strcmp( p_handler->name, psz_name ))
846                 {
847                     msg_Err( p_demux, "there's no open element left for <%s>",
848                              psz_name );
849                     FREE_ATT();
850                     if( b_release_input_item ) vlc_gc_decref( p_new_input );
851                     return false;
852                 }
853
854                 /* special tag <vlc:id> */
855                 if( !strcmp( p_handler->name, "vlc:id" ) )
856                 {
857                     p_demux->p_sys->i_track_id = atoi( psz_value );
858                 }
859                 else if( p_handler->pf_handler.smpl )
860                 {
861                     p_handler->pf_handler.smpl( p_input_item, p_handler->name,
862                                                 psz_value );
863                 }
864                 FREE_ATT();
865                 p_handler = NULL;
866                 break;
867
868             default:
869                 /* unknown/unexpected xml node */
870                 msg_Err( p_demux, "unexpected xml node %i", i_node );
871                 FREE_ATT();
872                 if( b_release_input_item ) vlc_gc_decref( p_new_input );
873                 return false;
874         }
875         FREE_NAME();
876     }
877     if( b_release_input_item ) vlc_gc_decref( p_new_input );
878     return false;
879 }
880
881 /**
882  * \brief parse the extension item node of a XSPF playlist
883  */
884 static bool parse_extitem_node COMPLEX_INTERFACE
885 {
886     VLC_UNUSED(psz_element);
887     input_item_t *p_new_input = NULL;
888     char *psz_name = NULL;
889     char *psz_value = NULL;
890     int i_tid = -1;
891
892     /* read all extension item attributes */
893     while( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
894     {
895         psz_name = xml_ReaderName( p_xml_reader );
896         psz_value = xml_ReaderValue( p_xml_reader );
897         if( !psz_name || !psz_value )
898         {
899             msg_Err( p_demux, "invalid xml stream @ <vlc:item>" );
900             FREE_ATT();
901             return false;
902         }
903         /* attribute: href */
904         if( !strcmp( psz_name, "tid" ) )
905         {
906             i_tid = atoi( psz_value );
907         }
908         /* unknown attribute */
909         else
910             msg_Warn( p_demux, "invalid <vlc:item> attribute:\"%s\"", psz_name);
911
912         FREE_ATT();
913     }
914
915     /* attribute href is mandatory */
916     if( i_tid < 0 )
917     {
918         msg_Warn( p_demux, "<vlc:item> requires \"tid\" attribute" );
919         return false;
920     }
921
922     if( i_tid >= p_demux->p_sys->i_tracklist_entries )
923     {
924         msg_Warn( p_demux, "invalid \"tid\" attribute" );
925         return false;
926     }
927
928     p_new_input = p_demux->p_sys->pp_tracklist[ i_tid ];
929     if( p_new_input )
930     {
931         input_item_AddSubItem( p_input_item, p_new_input );
932         vlc_gc_decref( p_new_input );
933         p_demux->p_sys->pp_tracklist[i_tid] = NULL;
934     }
935
936     /* kludge for #1293 - XTAG sends ENDELEM for self closing tag */
937     /* (libxml sends NONE) */
938     xml_ReaderRead( p_xml_reader );
939
940     return true;
941 }
942
943 /**
944  * \brief skips complex element content that we can't manage
945  */
946 static bool skip_element COMPLEX_INTERFACE
947 {
948     VLC_UNUSED(p_demux); VLC_UNUSED(p_input_item);
949     char *psz_endname;
950
951     while( xml_ReaderRead( p_xml_reader ) == 1 )
952     {
953         if( xml_ReaderNodeType( p_xml_reader ) == XML_READER_ENDELEM )
954         {
955             psz_endname = xml_ReaderName( p_xml_reader );
956             if( !psz_endname )
957                 return false;
958             if( !strcmp( psz_element, psz_endname ) )
959             {
960                 free( psz_endname );
961                 return true;
962             }
963             else
964                 free( psz_endname );
965         }
966     }
967     return false;
968 }