1 /*******************************************************************************
2 * xspf.c : XSPF playlist import functions
3 *******************************************************************************
4 * Copyright (C) 2006 the VideoLAN team
7 * Authors: Daniel Stränger <vlc at schmaller dot de>
8 * Yoann Peronneau <yoann@videolan.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 * \file modules/demux/playlist/xspf.c
26 * \brief XSPF playlist import functions
33 #include <vlc_common.h>
34 #include <vlc_demux.h>
37 #include <vlc_strings.h>
44 input_item_t **pp_tracklist;
45 int i_tracklist_entries;
50 static int Control( demux_t *, int, va_list );
51 static int Demux( demux_t * );
54 * \brief XSPF submodule initialization function
56 int Import_xspf( vlc_object_t *p_this )
58 DEMUX_BY_EXTENSION_OR_FORCED_MSG( ".xspf", "xspf-open",
59 "using XSPF playlist reader" );
63 void Close_xspf( vlc_object_t *p_this )
65 demux_t *p_demux = (demux_t *)p_this;
67 for(i = 0; i < p_demux->p_sys->i_tracklist_entries; i++)
69 if(p_demux->p_sys->pp_tracklist[i])
70 vlc_gc_decref( p_demux->p_sys->pp_tracklist[i] );
72 free( p_demux->p_sys->pp_tracklist );
73 free( p_demux->p_sys->psz_base );
74 free( p_demux->p_sys );
78 * \brief demuxer function for XSPF parsing
80 int Demux( demux_t *p_demux )
84 xml_reader_t *p_xml_reader = NULL;
85 char *psz_name = NULL;
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;
92 /* create new xml parser from stream */
93 p_xml = xml_Create( p_demux );
98 p_xml_reader = xml_ReaderCreate( p_xml, p_demux->s );
103 /* locating the root node */
108 if( xml_ReaderRead( p_xml_reader ) != 1 )
110 msg_Err( p_demux, "can't read xml stream" );
113 } while( i_ret == VLC_SUCCESS &&
114 xml_ReaderNodeType( p_xml_reader ) != XML_READER_STARTELEM );
116 /* checking root node name */
119 psz_name = xml_ReaderName( p_xml_reader );
120 if( !psz_name || strcmp( psz_name, "playlist" ) )
122 msg_Err( p_demux, "invalid root node name: %s", psz_name );
129 i_ret = parse_playlist_node( p_demux, p_current_input,
130 p_xml_reader, "playlist" ) ? 0 : -1;
133 for( i = 0 ; i < p_demux->p_sys->i_tracklist_entries ; i++ )
135 input_item_t *p_new_input = p_demux->p_sys->pp_tracklist[i];
138 input_item_AddSubItem( p_current_input, p_new_input );
142 HANDLE_PLAY_AND_RELEASE;
144 xml_ReaderDelete( p_xml, p_xml_reader );
147 return i_ret; /* Needed for correct operation of go back */
150 /** \brief dummy function for demux callback interface */
151 static int Control( demux_t *p_demux, int i_query, va_list args )
153 VLC_UNUSED(p_demux); VLC_UNUSED(i_query); VLC_UNUSED(args);
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
164 static bool parse_playlist_node COMPLEX_INTERFACE
166 char *psz_name = NULL;
167 char *psz_value = NULL;
168 bool b_version_found = false;
170 xml_elem_hnd_t *p_handler = NULL;
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} }
190 /* read all playlist attributes */
191 while( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
193 psz_name = xml_ReaderName( p_xml_reader );
194 psz_value = xml_ReaderValue( p_xml_reader );
195 if( !psz_name || !psz_value )
197 msg_Err( p_demux, "invalid xml stream @ <playlist>" );
201 /* attribute: version */
202 if( !strcmp( psz_name, "version" ) )
204 b_version_found = true;
205 if( strcmp( psz_value, "0" ) && strcmp( psz_value, "1" ) )
206 msg_Warn( p_demux, "unsupported XSPF version" );
208 /* attribute: xmlns */
209 else if( !strcmp( psz_name, "xmlns" ) || !strcmp( psz_name, "xmlns:vlc" ) )
211 else if( !strcmp( psz_name, "xml:base" ) )
213 p_demux->p_sys->psz_base = decode_URI_duplicate( psz_value );
215 /* unknown attribute */
217 msg_Warn( p_demux, "invalid <playlist> attribute:\"%s\"", psz_name);
221 /* attribute version is mandatory !!! */
222 if( !b_version_found )
223 msg_Warn( p_demux, "<playlist> requires \"version\" attribute" );
225 /* parse the child elements - we only take care of <trackList> */
226 while( xml_ReaderRead( p_xml_reader ) == 1 )
228 i_node = xml_ReaderNodeType( p_xml_reader );
231 case XML_READER_NONE:
233 case XML_READER_STARTELEM:
234 /* element start tag */
235 psz_name = xml_ReaderName( p_xml_reader );
236 if( !psz_name || !*psz_name )
238 msg_Err( p_demux, "invalid xml stream" );
243 for( p_handler = pl_elements;
244 p_handler->name && strcmp( psz_name, p_handler->name );
246 if( !p_handler->name )
248 msg_Err( p_demux, "unexpected element <%s>", psz_name );
253 /* complex content is parsed in a separate function */
254 if( p_handler->type == COMPLEX_CONTENT )
256 if( p_handler->pf_handler.cmplx( p_demux,
272 case XML_READER_TEXT:
273 /* simple element content */
275 psz_value = xml_ReaderValue( p_xml_reader );
278 msg_Err( p_demux, "invalid xml stream" );
284 case XML_READER_ENDELEM:
285 /* element end tag */
286 psz_name = xml_ReaderName( p_xml_reader );
289 msg_Err( p_demux, "invalid xml stream" );
293 /* leave if the current parent node <playlist> is terminated */
294 if( !strcmp( psz_name, psz_element ) )
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 ))
303 msg_Err( p_demux, "there's no open element left for <%s>",
309 if( p_handler->pf_handler.smpl )
311 p_handler->pf_handler.smpl( p_input_item, p_handler->name,
319 /* unknown/unexpected xml node */
320 msg_Err( p_demux, "unexpected xml node %i", i_node );
330 * \brief parses the tracklist node which only may contain <track>s
332 static bool parse_tracklist_node COMPLEX_INTERFACE
334 VLC_UNUSED(psz_element);
335 char *psz_name = NULL;
339 /* now parse the <track>s */
340 while( xml_ReaderRead( p_xml_reader ) == 1 )
342 i_node = xml_ReaderNodeType( p_xml_reader );
343 if( i_node == XML_READER_STARTELEM )
345 psz_name = xml_ReaderName( p_xml_reader );
348 msg_Err( p_demux, "unexpected end of xml data" );
352 if( strcmp( psz_name, "track") )
354 msg_Err( p_demux, "unexpected child of <trackList>: <%s>",
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 )
366 else if( i_node == XML_READER_ENDELEM )
370 /* the <trackList> has to be terminated */
371 if( xml_ReaderNodeType( p_xml_reader ) != XML_READER_ENDELEM )
373 msg_Err( p_demux, "there's a missing </trackList>" );
377 psz_name = xml_ReaderName( p_xml_reader );
378 if( !psz_name || strcmp( psz_name, "trackList" ) )
380 msg_Err( p_demux, "expected: </trackList>, found: </%s>", psz_name );
386 msg_Dbg( p_demux, "parsed %i tracks successfully", i_ntracks );
392 * \brief parse one track element
393 * \param COMPLEX_INTERFACE
395 static bool parse_track_node COMPLEX_INTERFACE
398 char *psz_name = NULL;
399 char *psz_value = NULL;
400 xml_elem_hnd_t *p_handler = NULL;
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} }
419 input_item_t *p_new_input = input_item_New( p_demux, NULL, NULL );
423 /* malloc has failed for input_item_New, so bailout early */
427 /* reset i_track_id */
428 p_demux->p_sys->i_track_id = -1;
430 while( xml_ReaderRead( p_xml_reader ) == 1 )
432 i_node = xml_ReaderNodeType( p_xml_reader );
435 case XML_READER_NONE:
438 case XML_READER_STARTELEM:
439 /* element start tag */
440 psz_name = xml_ReaderName( p_xml_reader );
441 if( !psz_name || !*psz_name )
443 msg_Err( p_demux, "invalid xml stream" );
448 for( p_handler = track_elements;
449 p_handler->name && strcmp( psz_name, p_handler->name );
451 if( !p_handler->name )
453 msg_Err( p_demux, "unexpected element <%s>", psz_name );
458 /* complex content is parsed in a separate function */
459 if( p_handler->type == COMPLEX_CONTENT )
464 "at <%s> level no new item has been allocated",
469 if( p_handler->pf_handler.cmplx( p_demux,
485 case XML_READER_TEXT:
486 /* simple element content */
488 psz_value = xml_ReaderValue( p_xml_reader );
491 msg_Err( p_demux, "invalid xml stream" );
497 case XML_READER_ENDELEM:
498 /* element end tag */
499 psz_name = xml_ReaderName( p_xml_reader );
502 msg_Err( p_demux, "invalid xml stream" );
506 /* leave if the current parent node <track> is terminated */
507 if( !strcmp( psz_name, psz_element ) )
511 if( p_demux->p_sys->i_track_id < 0 )
513 input_item_AddSubItem( p_input_item, p_new_input );
514 vlc_gc_decref( p_new_input );
518 if( p_demux->p_sys->i_track_id >=
519 p_demux->p_sys->i_tracklist_entries )
522 pp = realloc( p_demux->p_sys->pp_tracklist,
523 (p_demux->p_sys->i_track_id + 1) * sizeof(*pp) );
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;
532 p_demux->p_sys->pp_tracklist[
533 p_demux->p_sys->i_track_id ] = p_new_input;
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 ))
540 msg_Err( p_demux, "there's no open element left for <%s>",
546 /* special case: location */
547 if( !strcmp( p_handler->name, "location" ) )
549 char *psz_location = psz_value;
550 if( !strncmp( psz_value, "file://", 7 ) ) /* file path */
551 psz_location = decode_URI( psz_value + 7 );
552 else if( !strstr( psz_value, "://" ) ) /* relative path */
553 psz_location = decode_URI( psz_value );
561 if( p_demux->p_sys->psz_base && !strstr( psz_value, "://" ) )
564 if( asprintf( &psz_tmp, "%s%s", p_demux->p_sys->psz_base,
565 psz_location ) == -1 )
570 input_item_SetURI( p_new_input, psz_tmp );
574 input_item_SetURI( p_new_input, psz_location );
575 input_item_CopyOptions( p_input_item, p_new_input );
581 /* there MUST be an item */
584 msg_Err( p_demux, "item not yet created at <%s>",
589 if( p_handler->pf_handler.smpl )
591 p_handler->pf_handler.smpl( p_new_input,
602 /* unknown/unexpected xml node */
603 msg_Err( p_demux, "unexpected xml node %i", i_node );
609 msg_Err( p_demux, "unexpected end of xml data" );
615 * \brief handles the supported <track> sub-elements
617 static bool set_item_info SIMPLE_INTERFACE
619 /* exit if setting is impossible */
620 if( !psz_name || !psz_value || !p_input )
624 /* re-convert xml special characters inside psz_value */
625 resolve_xml_special_chars( psz_value );
627 /* handle each info element in a separate "if" clause */
628 if( !strcmp( psz_name, "title" ) )
630 input_item_SetTitle( p_input, psz_value );
632 else if( !strcmp( psz_name, "creator" ) )
634 input_item_SetArtist( p_input, psz_value );
636 else if( !strcmp( psz_name, "album" ) )
638 input_item_SetAlbum( p_input, psz_value );
641 else if( !strcmp( psz_name, "trackNum" ) )
643 input_item_SetTrackNum( p_input, psz_value );
645 else if( !strcmp( psz_name, "duration" ) )
647 long i_num = atol( psz_value );
648 input_item_SetDuration( p_input, (mtime_t) i_num*1000 );
650 else if( !strcmp( psz_name, "annotation" ) )
652 input_item_SetDescription( p_input, psz_value );
654 else if( !strcmp( psz_name, "image" ) )
656 input_item_SetArtURL( p_input, psz_value );
662 * \brief handles the <vlc:option> elements
664 static bool set_option SIMPLE_INTERFACE
666 /* exit if setting is impossible */
667 if( !psz_name || !psz_value || !p_input )
670 /* re-convert xml special characters inside psz_value */
671 resolve_xml_special_chars( psz_value );
673 input_item_AddOption( p_input, psz_value, 0 );
679 * \brief parse the extension node of a XSPF playlist
681 static bool parse_extension_node COMPLEX_INTERFACE
683 char *psz_name = NULL;
684 char *psz_value = NULL;
685 char *psz_title = NULL;
686 char *psz_application = NULL;
688 bool b_release_input_item = false;
689 xml_elem_hnd_t *p_handler = NULL;
690 input_item_t *p_new_input = NULL;
692 xml_elem_hnd_t pl_elements[] =
693 { {"vlc:node", COMPLEX_CONTENT, {.cmplx = parse_extension_node} },
694 {"vlc:item", COMPLEX_CONTENT, {.cmplx = parse_extitem_node} },
695 {"vlc:id", SIMPLE_CONTENT, {NULL} },
696 {"vlc:option", SIMPLE_CONTENT, {.smpl = set_option} },
697 {NULL, UNKNOWN_CONTENT, {NULL} }
700 /* read all extension node attributes */
701 while( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
703 psz_name = xml_ReaderName( p_xml_reader );
704 psz_value = xml_ReaderValue( p_xml_reader );
705 if( !psz_name || !psz_value )
707 msg_Err( p_demux, "invalid xml stream @ <vlc:node>" );
711 /* attribute: title */
712 if( !strcmp( psz_name, "title" ) )
714 resolve_xml_special_chars( psz_value );
715 psz_title = strdup( psz_value );
717 /* extension attribute: application */
718 else if( !strcmp( psz_name, "application" ) )
720 psz_application = strdup( psz_value );
722 /* unknown attribute */
724 msg_Warn( p_demux, "invalid <%s> attribute:\"%s\"", psz_element,
730 /* attribute title is mandatory except for <extension> */
731 if( !strcmp( psz_element, "vlc:node" ) )
735 msg_Warn( p_demux, "<vlc:node> requires \"title\" attribute" );
738 p_new_input = input_item_NewWithType( VLC_OBJECT( p_demux ),
739 "vlc://nop", psz_title, 0, NULL, 0, -1,
740 ITEM_TYPE_DIRECTORY );
743 input_item_AddSubItem( p_input_item, p_new_input );
744 p_input_item = p_new_input;
745 b_release_input_item = true;
749 else if( !strcmp( psz_element, "extension" ) )
751 if( !psz_application )
753 msg_Warn( p_demux, "<extension> requires \"application\" attribute" );
756 else if( strcmp( psz_application, "http://www.videolan.org/vlc/playlist/0" ) )
758 msg_Dbg( p_demux, "Skipping \"%s\" extension tag", psz_application );
759 free( psz_application );
763 free( psz_application );
765 /* parse the child elements */
766 while( xml_ReaderRead( p_xml_reader ) == 1 )
768 i_node = xml_ReaderNodeType( p_xml_reader );
771 case XML_READER_NONE:
773 case XML_READER_STARTELEM:
774 /* element start tag */
775 psz_name = xml_ReaderName( p_xml_reader );
776 if( !psz_name || !*psz_name )
778 msg_Err( p_demux, "invalid xml stream" );
780 if( b_release_input_item ) vlc_gc_decref( p_new_input );
784 for( p_handler = pl_elements;
785 p_handler->name && strcmp( psz_name, p_handler->name );
787 if( !p_handler->name )
789 msg_Err( p_demux, "unexpected element <%s>", psz_name );
791 if( b_release_input_item ) vlc_gc_decref( p_new_input );
795 /* complex content is parsed in a separate function */
796 if( p_handler->type == COMPLEX_CONTENT )
798 if( p_handler->pf_handler.cmplx( p_demux,
809 if( b_release_input_item ) vlc_gc_decref( p_new_input );
815 case XML_READER_TEXT:
816 /* simple element content */
818 psz_value = xml_ReaderValue( p_xml_reader );
821 msg_Err( p_demux, "invalid xml stream" );
823 if( b_release_input_item ) vlc_gc_decref( p_new_input );
828 case XML_READER_ENDELEM:
829 /* element end tag */
830 psz_name = xml_ReaderName( p_xml_reader );
833 msg_Err( p_demux, "invalid xml stream" );
835 if( b_release_input_item ) vlc_gc_decref( p_new_input );
838 /* leave if the current parent node is terminated */
839 if( !strcmp( psz_name, psz_element ) )
842 if( b_release_input_item ) vlc_gc_decref( p_new_input );
845 /* there MUST have been a start tag for that element name */
846 if( !p_handler || !p_handler->name
847 || strcmp( p_handler->name, psz_name ))
849 msg_Err( p_demux, "there's no open element left for <%s>",
852 if( b_release_input_item ) vlc_gc_decref( p_new_input );
856 /* special tag <vlc:id> */
857 if( !strcmp( p_handler->name, "vlc:id" ) )
859 p_demux->p_sys->i_track_id = atoi( psz_value );
861 else if( p_handler->pf_handler.smpl )
863 p_handler->pf_handler.smpl( p_input_item, p_handler->name,
871 /* unknown/unexpected xml node */
872 msg_Err( p_demux, "unexpected xml node %i", i_node );
874 if( b_release_input_item ) vlc_gc_decref( p_new_input );
879 if( b_release_input_item ) vlc_gc_decref( p_new_input );
884 * \brief parse the extension item node of a XSPF playlist
886 static bool parse_extitem_node COMPLEX_INTERFACE
888 VLC_UNUSED(psz_element);
889 input_item_t *p_new_input = NULL;
890 char *psz_name = NULL;
891 char *psz_value = NULL;
894 /* read all extension item attributes */
895 while( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
897 psz_name = xml_ReaderName( p_xml_reader );
898 psz_value = xml_ReaderValue( p_xml_reader );
899 if( !psz_name || !psz_value )
901 msg_Err( p_demux, "invalid xml stream @ <vlc:item>" );
905 /* attribute: href */
906 if( !strcmp( psz_name, "tid" ) )
908 i_tid = atoi( psz_value );
910 /* unknown attribute */
912 msg_Warn( p_demux, "invalid <vlc:item> attribute:\"%s\"", psz_name);
917 /* attribute href is mandatory */
920 msg_Warn( p_demux, "<vlc:item> requires \"tid\" attribute" );
924 if( i_tid >= p_demux->p_sys->i_tracklist_entries )
926 msg_Warn( p_demux, "invalid \"tid\" attribute" );
930 p_new_input = p_demux->p_sys->pp_tracklist[ i_tid ];
933 input_item_AddSubItem( p_input_item, p_new_input );
934 vlc_gc_decref( p_new_input );
935 p_demux->p_sys->pp_tracklist[i_tid] = NULL;
938 /* kludge for #1293 - XTAG sends ENDELEM for self closing tag */
939 /* (libxml sends NONE) */
940 xml_ReaderRead( p_xml_reader );
946 * \brief skips complex element content that we can't manage
948 static bool skip_element COMPLEX_INTERFACE
950 VLC_UNUSED(p_demux); VLC_UNUSED(p_input_item);
953 while( xml_ReaderRead( p_xml_reader ) == 1 )
955 if( xml_ReaderNodeType( p_xml_reader ) == XML_READER_ENDELEM )
957 psz_endname = xml_ReaderName( p_xml_reader );
960 if( !strcmp( psz_element, psz_endname ) )