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
30 #include <vlc_demux.h>
34 #include "vlc_strings.h"
40 playlist_item_t *p_item_in_category;
41 input_item_t **pp_tracklist;
42 int i_tracklist_entries;
47 static int Control( demux_t *, int, va_list );
48 static int Demux( demux_t * );
51 * \brief XSPF submodule initialization function
53 int E_(Import_xspf)( vlc_object_t *p_this )
55 DEMUX_BY_EXTENSION_OR_FORCED_MSG( ".xspf", "xspf-open",
56 "using XSPF playlist reader" );
60 void E_(Close_xspf)( vlc_object_t *p_this )
62 demux_t *p_demux = (demux_t *)p_this;
63 FREENULL( p_demux->p_sys->pp_tracklist );
64 FREENULL( p_demux->p_sys->psz_base );
65 free( p_demux->p_sys );
69 * \brief demuxer function for XSPF parsing
71 int Demux( demux_t *p_demux )
73 int i_ret = VLC_SUCCESS;
75 xml_reader_t *p_xml_reader = NULL;
76 char *psz_name = NULL;
78 p_demux->p_sys->pp_tracklist = NULL;
79 p_demux->p_sys->i_tracklist_entries = 0;
80 p_demux->p_sys->i_identifier = 0;
81 p_demux->p_sys->psz_base = NULL;
83 /* create new xml parser from stream */
84 p_xml = xml_Create( p_demux );
89 p_xml_reader = xml_ReaderCreate( p_xml, p_demux->s );
94 /* locating the root node */
95 if( i_ret == VLC_SUCCESS )
99 if( xml_ReaderRead( p_xml_reader ) != 1 )
101 msg_Err( p_demux, "can't read xml stream" );
102 i_ret = VLC_EGENERIC;
104 } while( i_ret == VLC_SUCCESS &&
105 xml_ReaderNodeType( p_xml_reader ) != XML_READER_STARTELEM );
107 /* checking root node name */
108 if( i_ret == VLC_SUCCESS )
110 psz_name = xml_ReaderName( p_xml_reader );
111 if( !psz_name || strcmp( psz_name, "playlist" ) )
113 msg_Err( p_demux, "invalid root node name: %s", psz_name );
114 i_ret = VLC_EGENERIC;
119 i_ret = parse_playlist_node( p_demux, p_playlist, p_current_input,
120 p_xml_reader, "playlist" );
121 HANDLE_PLAY_AND_RELEASE;
123 xml_ReaderDelete( p_xml, p_xml_reader );
126 return -1; /* Needed for correct operation of go back */
129 /** \brief dummy function for demux callback interface */
130 static int Control( demux_t *p_demux, int i_query, va_list args )
136 * \brief parse the root node of a XSPF playlist
137 * \param p_demux demuxer instance
138 * \param p_playlist playlist instance
139 * \param p_input_item current input item
140 * \param p_xml_reader xml reader instance
141 * \param psz_element name of element to parse
143 static vlc_bool_t parse_playlist_node COMPLEX_INTERFACE
146 char *psz_value=NULL;
147 vlc_bool_t b_version_found = VLC_FALSE;
149 xml_elem_hnd_t *p_handler=NULL;
151 xml_elem_hnd_t pl_elements[] =
152 { {"title", SIMPLE_CONTENT, {.smpl = set_item_info} },
153 {"creator", SIMPLE_CONTENT, {.smpl = set_item_info} },
154 {"annotation", SIMPLE_CONTENT, {.smpl = set_item_info} },
155 {"info", SIMPLE_CONTENT, {NULL} },
156 {"location", SIMPLE_CONTENT, {NULL} },
157 {"identifier", SIMPLE_CONTENT, {NULL} },
158 {"image", SIMPLE_CONTENT, {.smpl = set_item_info} },
159 {"date", SIMPLE_CONTENT, {NULL} },
160 {"license", SIMPLE_CONTENT, {NULL} },
161 {"attribution", COMPLEX_CONTENT, {.cmplx = skip_element} },
162 {"link", SIMPLE_CONTENT, {NULL} },
163 {"meta", SIMPLE_CONTENT, {NULL} },
164 {"extension", COMPLEX_CONTENT, {.cmplx = parse_extension_node} },
165 {"trackList", COMPLEX_CONTENT, {.cmplx = parse_tracklist_node} },
166 {NULL, UNKNOWN_CONTENT, {NULL} }
169 /* read all playlist attributes */
170 while( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
172 psz_name = xml_ReaderName( p_xml_reader );
173 psz_value = xml_ReaderValue( p_xml_reader );
174 if( !psz_name || !psz_value )
176 msg_Err( p_demux, "invalid xml stream @ <playlist>" );
180 /* attribute: version */
181 if( !strcmp( psz_name, "version" ) )
183 b_version_found = VLC_TRUE;
184 if( strcmp( psz_value, "0" ) && strcmp( psz_value, "1" ) )
185 msg_Warn( p_demux, "unsupported XSPF version" );
187 /* attribute: xmlns */
188 else if( !strcmp( psz_name, "xmlns" ) )
190 else if( !strcmp( psz_name, "xml:base" ) )
192 p_demux->p_sys->psz_base = decode_URI_duplicate( psz_value );
194 /* unknown attribute */
196 msg_Warn( p_demux, "invalid <playlist> attribute:\"%s\"", psz_name);
200 /* attribute version is mandatory !!! */
201 if( !b_version_found )
202 msg_Warn( p_demux, "<playlist> requires \"version\" attribute" );
204 /* parse the child elements - we only take care of <trackList> */
205 while( xml_ReaderRead( p_xml_reader ) == 1 )
207 i_node = xml_ReaderNodeType( p_xml_reader );
210 case XML_READER_NONE:
212 case XML_READER_STARTELEM:
213 /* element start tag */
214 psz_name = xml_ReaderName( p_xml_reader );
215 if( !psz_name || !*psz_name )
217 msg_Err( p_demux, "invalid xml stream" );
222 for( p_handler = pl_elements;
223 p_handler->name && strcmp( psz_name, p_handler->name );
225 if( !p_handler->name )
227 msg_Err( p_demux, "unexpected element <%s>", psz_name );
232 /* complex content is parsed in a separate function */
233 if( p_handler->type == COMPLEX_CONTENT )
235 if( p_handler->pf_handler.cmplx( p_demux,
252 case XML_READER_TEXT:
253 /* simple element content */
255 psz_value = xml_ReaderValue( p_xml_reader );
258 msg_Err( p_demux, "invalid xml stream" );
264 case XML_READER_ENDELEM:
265 /* element end tag */
266 psz_name = xml_ReaderName( p_xml_reader );
269 msg_Err( p_demux, "invalid xml stream" );
273 /* leave if the current parent node <playlist> is terminated */
274 if( !strcmp( psz_name, psz_element ) )
279 /* there MUST have been a start tag for that element name */
280 if( !p_handler || !p_handler->name
281 || strcmp( p_handler->name, psz_name ))
283 msg_Err( p_demux, "there's no open element left for <%s>",
289 if( p_handler->pf_handler.smpl )
291 p_handler->pf_handler.smpl( p_input_item, p_handler->name,
299 /* unknown/unexpected xml node */
300 msg_Err( p_demux, "unexpected xml node %i", i_node );
310 * \brief parses the tracklist node which only may contain <track>s
312 static vlc_bool_t parse_tracklist_node COMPLEX_INTERFACE
318 /* now parse the <track>s */
319 while( xml_ReaderRead( p_xml_reader ) == 1 )
321 i_node = xml_ReaderNodeType( p_xml_reader );
322 if( i_node == XML_READER_STARTELEM )
324 psz_name = xml_ReaderName( p_xml_reader );
327 msg_Err( p_demux, "unexpected end of xml data" );
331 if( strcmp( psz_name, "track") )
333 msg_Err( p_demux, "unexpected child of <trackList>: <%s>",
340 /* parse the track data in a separate function */
341 if( parse_track_node( p_demux, p_playlist, p_input_item,
342 p_xml_reader,"track" ) == VLC_TRUE )
345 else if( i_node == XML_READER_ENDELEM )
349 /* the <trackList> has to be terminated */
350 if( xml_ReaderNodeType( p_xml_reader ) != XML_READER_ENDELEM )
352 msg_Err( p_demux, "there's a missing </trackList>" );
356 psz_name = xml_ReaderName( p_xml_reader );
357 if( !psz_name || strcmp( psz_name, "trackList" ) )
359 msg_Err( p_demux, "expected: </trackList>, found: </%s>", psz_name );
365 msg_Dbg( p_demux, "parsed %i tracks successfully", i_ntracks );
371 * \brief parse one track element
372 * \param COMPLEX_INTERFACE
374 static vlc_bool_t parse_track_node COMPLEX_INTERFACE
376 input_item_t *p_new_input = NULL;
379 char *psz_value=NULL;
380 xml_elem_hnd_t *p_handler=NULL;
382 xml_elem_hnd_t track_elements[] =
383 { {"location", SIMPLE_CONTENT, {NULL} },
384 {"identifier", SIMPLE_CONTENT, {NULL} },
385 {"title", SIMPLE_CONTENT, {.smpl = set_item_info} },
386 {"creator", SIMPLE_CONTENT, {.smpl = set_item_info} },
387 {"annotation", SIMPLE_CONTENT, {.smpl = set_item_info} },
388 {"info", SIMPLE_CONTENT, {NULL} },
389 {"image", SIMPLE_CONTENT, {.smpl = set_item_info} },
390 {"album", SIMPLE_CONTENT, {.smpl = set_item_info} },
391 {"trackNum", SIMPLE_CONTENT, {.smpl = set_item_info} },
392 {"duration", SIMPLE_CONTENT, {.smpl = set_item_info} },
393 {"link", SIMPLE_CONTENT, {NULL} },
394 {"meta", SIMPLE_CONTENT, {NULL} },
395 {"extension", COMPLEX_CONTENT, {.cmplx = skip_element} },
396 {NULL, UNKNOWN_CONTENT, {NULL} }
399 while( xml_ReaderRead( p_xml_reader ) == 1 )
401 i_node = xml_ReaderNodeType( p_xml_reader );
404 case XML_READER_NONE:
407 case XML_READER_STARTELEM:
408 /* element start tag */
409 psz_name = xml_ReaderName( p_xml_reader );
410 if( !psz_name || !*psz_name )
412 msg_Err( p_demux, "invalid xml stream" );
417 for( p_handler = track_elements;
418 p_handler->name && strcmp( psz_name, p_handler->name );
420 if( !p_handler->name )
422 msg_Err( p_demux, "unexpected element <%s>", psz_name );
427 /* complex content is parsed in a separate function */
428 if( p_handler->type == COMPLEX_CONTENT )
433 "at <%s> level no new item has been allocated",
438 if( p_handler->pf_handler.cmplx( p_demux,
455 case XML_READER_TEXT:
456 /* simple element content */
458 psz_value = xml_ReaderValue( p_xml_reader );
461 msg_Err( p_demux, "invalid xml stream" );
467 case XML_READER_ENDELEM:
468 /* element end tag */
469 psz_name = xml_ReaderName( p_xml_reader );
472 msg_Err( p_demux, "invalid xml stream" );
476 /* leave if the current parent node <track> is terminated */
477 if( !strcmp( psz_name, psz_element ) )
480 input_ItemAddSubItem( p_input_item, p_new_input );
481 if( p_demux->p_sys->i_identifier <
482 p_demux->p_sys->i_tracklist_entries )
484 p_demux->p_sys->pp_tracklist[
485 p_demux->p_sys->i_identifier ] = p_new_input;
489 if( p_demux->p_sys->i_identifier >
490 p_demux->p_sys->i_tracklist_entries )
492 p_demux->p_sys->i_tracklist_entries =
493 p_demux->p_sys->i_identifier;
495 INSERT_ELEM( p_demux->p_sys->pp_tracklist,
496 p_demux->p_sys->i_tracklist_entries,
497 p_demux->p_sys->i_tracklist_entries,
502 /* there MUST have been a start tag for that element name */
503 if( !p_handler || !p_handler->name
504 || strcmp( p_handler->name, psz_name ))
506 msg_Err( p_demux, "there's no open element left for <%s>",
512 /* special case: location */
513 if( !strcmp( p_handler->name, "location" ) )
516 /* there MUST NOT be an item */
519 msg_Err( p_demux, "item <%s> already created",
524 psz_uri = decode_URI_duplicate( psz_value );
528 if( p_demux->p_sys->psz_base &&
529 !strstr( psz_uri, "://" ) )
531 char* psz_tmp = malloc(
532 strlen(p_demux->p_sys->psz_base) +
533 strlen(psz_uri) +1 );
536 msg_Err( p_demux, "out of memory");
539 sprintf( psz_tmp, "%s%s",
540 p_demux->p_sys->psz_base, psz_uri );
544 p_new_input = input_ItemNewExt( p_playlist, psz_uri,
547 input_ItemCopyOptions( p_input_item, p_new_input );
558 else if( !strcmp( p_handler->name, "identifier" ) )
560 p_demux->p_sys->i_identifier = atoi( psz_value );
564 /* there MUST be an item */
567 msg_Err( p_demux, "item not yet created at <%s>",
572 if( p_handler->pf_handler.smpl )
574 p_handler->pf_handler.smpl( p_new_input,
585 /* unknown/unexpected xml node */
586 msg_Err( p_demux, "unexpected xml node %i", i_node );
592 msg_Err( p_demux, "unexpected end of xml data" );
598 * \brief handles the supported <track> sub-elements
600 static vlc_bool_t set_item_info SIMPLE_INTERFACE
602 /* exit if setting is impossible */
603 if( !psz_name || !psz_value || !p_input )
607 /* re-convert xml special characters inside psz_value */
608 resolve_xml_special_chars( psz_value );
610 /* handle each info element in a separate "if" clause */
611 if( !strcmp( psz_name, "title" ) )
613 input_item_SetTitle( p_input, psz_value );
615 else if( !strcmp( psz_name, "creator" ) )
617 input_item_SetArtist( p_input, psz_value );
619 else if( !strcmp( psz_name, "album" ) )
621 input_item_SetAlbum( p_input, psz_value );
624 else if( !strcmp( psz_name, "trackNum" ) )
626 input_item_SetTrackNum( p_input, psz_value );
628 else if( !strcmp( psz_name, "duration" ) )
630 long i_num = atol( psz_value );
631 input_item_SetDuration( p_input, (mtime_t) i_num*1000 );
633 else if( !strcmp( psz_name, "annotation" ) )
635 input_item_SetDescription( p_input, psz_value );
637 else if( !strcmp( psz_name, "image" ) )
639 input_item_SetArtURL( p_input, psz_value );
646 * \brief parse the extension node of a XSPF playlist
648 static vlc_bool_t parse_extension_node COMPLEX_INTERFACE
650 char *psz_name = NULL;
651 char *psz_value = NULL;
652 char *psz_title = NULL;
654 xml_elem_hnd_t *p_handler = NULL;
656 xml_elem_hnd_t pl_elements[] =
657 { {"node", COMPLEX_CONTENT, {.cmplx = parse_extension_node} },
658 {"item", COMPLEX_CONTENT, {.cmplx = parse_extitem_node} },
659 {NULL, UNKNOWN_CONTENT, {NULL} }
662 /* read all extension node attributes */
663 while( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
665 psz_name = xml_ReaderName( p_xml_reader );
666 psz_value = xml_ReaderValue( p_xml_reader );
667 if( !psz_name || !psz_value )
669 msg_Err( p_demux, "invalid xml stream @ <node>" );
673 /* attribute: title */
674 if( !strcmp( psz_name, "title" ) )
676 psz_title = unescape_URI_duplicate( psz_value );
678 /* unknown attribute */
680 msg_Warn( p_demux, "invalid <node> attribute:\"%s\"", psz_name);
685 /* attribute title is mandatory except for <extension> */
686 if( !strcmp( psz_element, "node" ) && !psz_title )
688 msg_Warn( p_demux, "<node> requires \"title\" attribute" );
691 if( psz_title ) free( psz_title );
693 /* parse the child elements */
694 while( xml_ReaderRead( p_xml_reader ) == 1 )
696 i_node = xml_ReaderNodeType( p_xml_reader );
699 case XML_READER_NONE:
701 case XML_READER_STARTELEM:
702 /* element start tag */
703 psz_name = xml_ReaderName( p_xml_reader );
704 if( !psz_name || !*psz_name )
706 msg_Err( p_demux, "invalid xml stream" );
711 for( p_handler = pl_elements;
712 p_handler->name && strcmp( psz_name, p_handler->name );
714 if( !p_handler->name )
716 msg_Err( p_demux, "unexpected element <%s>", psz_name );
721 /* complex content is parsed in a separate function */
722 if( p_handler->type == COMPLEX_CONTENT )
724 if( p_handler->pf_handler.cmplx( p_demux,
741 case XML_READER_TEXT:
742 /* simple element content */
744 psz_value = xml_ReaderValue( p_xml_reader );
747 msg_Err( p_demux, "invalid xml stream" );
753 case XML_READER_ENDELEM:
754 /* element end tag */
755 psz_name = xml_ReaderName( p_xml_reader );
758 msg_Err( p_demux, "invalid xml stream" );
762 /* leave if the current parent node is terminated */
763 if( !strcmp( psz_name, psz_element ) )
768 /* there MUST have been a start tag for that element name */
769 if( !p_handler || !p_handler->name
770 || strcmp( p_handler->name, psz_name ))
772 msg_Err( p_demux, "there's no open element left for <%s>",
778 if( p_handler->pf_handler.smpl )
780 p_handler->pf_handler.smpl( p_input_item, p_handler->name,
788 /* unknown/unexpected xml node */
789 msg_Err( p_demux, "unexpected xml node %i", i_node );
799 * \brief parse the extension item node of a XSPF playlist
801 static vlc_bool_t parse_extitem_node COMPLEX_INTERFACE
803 char *psz_name = NULL;
804 char *psz_value = NULL;
807 /* read all extension item attributes */
808 while( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
810 psz_name = xml_ReaderName( p_xml_reader );
811 psz_value = xml_ReaderValue( p_xml_reader );
812 if( !psz_name || !psz_value )
814 msg_Err( p_demux, "invalid xml stream @ <item>" );
818 /* attribute: href */
819 if( !strcmp( psz_name, "href" ) )
821 i_href = atoi( psz_value );
823 /* unknown attribute */
825 msg_Warn( p_demux, "invalid <item> attribute:\"%s\"", psz_name);
830 /* attribute href is mandatory */
833 msg_Warn( p_demux, "<item> requires \"href\" attribute" );
837 if( i_href > p_demux->p_sys->i_tracklist_entries )
839 msg_Warn( p_demux, "invalid \"href\" attribute" );
843 /* fix for #1293 - XTAG sends ENDELEM for self closing tag */
844 /* (libxml sends NONE) */
845 xml_ReaderRead( p_xml_reader );
851 * \brief skips complex element content that we can't manage
853 static vlc_bool_t skip_element COMPLEX_INTERFACE
857 while( xml_ReaderRead( p_xml_reader ) == 1 )
859 if( xml_ReaderNodeType( p_xml_reader ) == XML_READER_ENDELEM )
861 psz_endname = xml_ReaderName( p_xml_reader );
864 if( !strcmp( psz_element, psz_endname ) )