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->psz_base);
64 free( p_demux->p_sys );
68 * \brief demuxer function for XSPF parsing
70 int Demux( demux_t *p_demux )
72 int i_ret = VLC_SUCCESS;
74 xml_reader_t *p_xml_reader = NULL;
75 char *psz_name = NULL;
77 p_demux->p_sys->p_item_in_category = p_item_in_category;
78 p_demux->p_sys->pp_tracklist = NULL;
79 p_demux->p_sys->i_tracklist_entries = 0;
80 p_demux->p_sys->i_identifier = -1;
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, NULL,
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_item current playlist item
140 * \param p_input current input item
141 * \param p_xml_reader xml reader instance
142 * \param psz_element name of element to parse
144 static vlc_bool_t parse_playlist_node COMPLEX_INTERFACE
147 char *psz_value=NULL;
148 vlc_bool_t b_version_found = VLC_FALSE;
150 xml_elem_hnd_t *p_handler=NULL;
152 xml_elem_hnd_t pl_elements[] =
153 { {"title", SIMPLE_CONTENT, {.smpl = set_item_info} },
154 {"creator", SIMPLE_CONTENT, {.smpl = set_item_info} },
155 {"annotation", SIMPLE_CONTENT, {NULL} },
156 {"info", SIMPLE_CONTENT, {NULL} },
157 {"location", SIMPLE_CONTENT, {NULL} },
158 {"identifier", SIMPLE_CONTENT, {NULL} },
159 {"image", SIMPLE_CONTENT, {NULL} },
160 {"date", SIMPLE_CONTENT, {NULL} },
161 {"license", SIMPLE_CONTENT, {NULL} },
162 {"attribution", COMPLEX_CONTENT, {.cmplx = skip_element} },
163 {"link", SIMPLE_CONTENT, {NULL} },
164 {"meta", SIMPLE_CONTENT, {NULL} },
165 {"extension", COMPLEX_CONTENT, {.cmplx = parse_extension_node} },
166 {"trackList", COMPLEX_CONTENT, {.cmplx = parse_tracklist_node} },
167 {NULL, UNKNOWN_CONTENT, {NULL} }
170 /* read all playlist attributes */
171 while( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
173 psz_name = xml_ReaderName( p_xml_reader );
174 psz_value = xml_ReaderValue( p_xml_reader );
175 if( !psz_name || !psz_value )
177 msg_Err( p_demux, "invalid xml stream @ <playlist>" );
181 /* attribute: version */
182 if( !strcmp( psz_name, "version" ) )
184 b_version_found = VLC_TRUE;
185 if( strcmp( psz_value, "0" ) && strcmp( psz_value, "1" ) )
186 msg_Warn( p_demux, "unsupported XSPF version" );
188 /* attribute: xmlns */
189 else if( !strcmp( psz_name, "xmlns" ) )
191 else if( !strcmp( psz_name, "xml:base" ) )
193 p_demux->p_sys->psz_base = decode_URI_duplicate( psz_value );
195 /* unknown attribute */
197 msg_Warn( p_demux, "invalid <playlist> attribute:\"%s\"", psz_name);
201 /* attribute version is mandatory !!! */
202 if( !b_version_found )
203 msg_Warn( p_demux, "<playlist> requires \"version\" attribute" );
205 /* parse the child elements - we only take care of <trackList> */
206 while( xml_ReaderRead( p_xml_reader ) == 1 )
208 i_node = xml_ReaderNodeType( p_xml_reader );
211 case XML_READER_NONE:
213 case XML_READER_STARTELEM:
214 /* element start tag */
215 psz_name = xml_ReaderName( p_xml_reader );
216 if( !psz_name || !*psz_name )
218 msg_Err( p_demux, "invalid xml stream" );
223 for( p_handler = pl_elements;
224 p_handler->name && strcmp( psz_name, p_handler->name );
226 if( !p_handler->name )
228 msg_Err( p_demux, "unexpected element <%s>", psz_name );
233 /* complex content is parsed in a separate function */
234 if( p_handler->type == COMPLEX_CONTENT )
236 if( p_handler->pf_handler.cmplx( p_demux,
253 case XML_READER_TEXT:
254 /* simple element content */
256 psz_value = xml_ReaderValue( p_xml_reader );
259 msg_Err( p_demux, "invalid xml stream" );
265 case XML_READER_ENDELEM:
266 /* element end tag */
267 psz_name = xml_ReaderName( p_xml_reader );
270 msg_Err( p_demux, "invalid xml stream" );
274 /* leave if the current parent node <playlist> is terminated */
275 if( !strcmp( psz_name, psz_element ) )
280 /* there MUST have been a start tag for that element name */
281 if( !p_handler || !p_handler->name
282 || strcmp( p_handler->name, psz_name ))
284 msg_Err( p_demux, "there's no open element left for <%s>",
290 if( p_handler->pf_handler.smpl )
292 p_handler->pf_handler.smpl( p_item, NULL, p_handler->name,
300 /* unknown/unexpected xml node */
301 msg_Err( p_demux, "unexpected xml node %i", i_node );
311 * \brief parses the tracklist node which only may contain <track>s
313 static vlc_bool_t parse_tracklist_node COMPLEX_INTERFACE
319 /* now parse the <track>s */
320 while( xml_ReaderRead( p_xml_reader ) == 1 )
322 i_node = xml_ReaderNodeType( p_xml_reader );
323 if( i_node == XML_READER_STARTELEM )
325 psz_name = xml_ReaderName( p_xml_reader );
328 msg_Err( p_demux, "unexpected end of xml data" );
332 if( strcmp( psz_name, "track") )
334 msg_Err( p_demux, "unexpected child of <trackList>: <%s>",
341 /* parse the track data in a separate function */
342 if( parse_track_node( p_demux, p_playlist, p_item, NULL,
343 p_xml_reader,"track" ) == VLC_TRUE )
346 else if( i_node == XML_READER_ENDELEM )
350 /* the <trackList> has to be terminated */
351 if( xml_ReaderNodeType( p_xml_reader ) != XML_READER_ENDELEM )
353 msg_Err( p_demux, "there's a missing </trackList>" );
357 psz_name = xml_ReaderName( p_xml_reader );
358 if( !psz_name || strcmp( psz_name, "trackList" ) )
360 msg_Err( p_demux, "expected: </trackList>, found: </%s>", psz_name );
366 msg_Dbg( p_demux, "parsed %i tracks successfully", i_ntracks );
372 * \brief parse one track element
373 * \param COMPLEX_INTERFACE
375 static vlc_bool_t parse_track_node COMPLEX_INTERFACE
377 input_item_t *p_new_input = NULL;
380 char *psz_value=NULL;
381 xml_elem_hnd_t *p_handler=NULL;
383 xml_elem_hnd_t track_elements[] =
384 { {"location", SIMPLE_CONTENT, {NULL} },
385 {"identifier", SIMPLE_CONTENT, {NULL} },
386 {"title", SIMPLE_CONTENT, {.smpl = set_item_info} },
387 {"creator", SIMPLE_CONTENT, {.smpl = set_item_info} },
388 {"annotation", SIMPLE_CONTENT, {NULL} },
389 {"info", SIMPLE_CONTENT, {NULL} },
390 {"image", SIMPLE_CONTENT, {NULL} },
391 {"album", SIMPLE_CONTENT, {.smpl = set_item_info} },
392 {"trackNum", SIMPLE_CONTENT, {.smpl = set_item_info} },
393 {"duration", SIMPLE_CONTENT, {.smpl = set_item_info} },
394 {"link", SIMPLE_CONTENT, {NULL} },
395 {"meta", SIMPLE_CONTENT, {NULL} },
396 {"extension", COMPLEX_CONTENT, {.cmplx = skip_element} },
397 {NULL, UNKNOWN_CONTENT, {NULL} }
400 while( xml_ReaderRead( p_xml_reader ) == 1 )
402 i_node = xml_ReaderNodeType( p_xml_reader );
405 case XML_READER_NONE:
408 case XML_READER_STARTELEM:
409 /* element start tag */
410 psz_name = xml_ReaderName( p_xml_reader );
411 if( !psz_name || !*psz_name )
413 msg_Err( p_demux, "invalid xml stream" );
418 for( p_handler = track_elements;
419 p_handler->name && strcmp( psz_name, p_handler->name );
421 if( !p_handler->name )
423 msg_Err( p_demux, "unexpected element <%s>", psz_name );
428 /* complex content is parsed in a separate function */
429 if( p_handler->type == COMPLEX_CONTENT )
434 "at <%s> level no new item has been allocated",
439 if( p_handler->pf_handler.cmplx( p_demux,
456 case XML_READER_TEXT:
457 /* simple element content */
459 psz_value = xml_ReaderValue( p_xml_reader );
462 msg_Err( p_demux, "invalid xml stream" );
468 case XML_READER_ENDELEM:
469 /* element end tag */
470 psz_name = xml_ReaderName( p_xml_reader );
473 msg_Err( p_demux, "invalid xml stream" );
477 /* leave if the current parent node <track> is terminated */
478 if( !strcmp( psz_name, psz_element ) )
481 playlist_BothAddInput( p_playlist, p_new_input,
482 p_demux->p_sys->p_item_in_category,
483 PLAYLIST_APPEND | PLAYLIST_SPREPARSE,
484 PLAYLIST_END, NULL, NULL, VLC_FALSE );
485 if( p_demux->p_sys->i_identifier <
486 p_demux->p_sys->i_tracklist_entries )
488 p_demux->p_sys->pp_tracklist[
489 p_demux->p_sys->i_identifier ] = p_new_input;
493 if( p_demux->p_sys->i_identifier >
494 p_demux->p_sys->i_tracklist_entries )
496 p_demux->p_sys->i_tracklist_entries =
497 p_demux->p_sys->i_identifier;
499 INSERT_ELEM( p_demux->p_sys->pp_tracklist,
500 p_demux->p_sys->i_tracklist_entries,
501 p_demux->p_sys->i_tracklist_entries,
506 /* there MUST have been a start tag for that element name */
507 if( !p_handler || !p_handler->name
508 || strcmp( p_handler->name, psz_name ))
510 msg_Err( p_demux, "there's no open element left for <%s>",
516 /* special case: location */
517 if( !strcmp( p_handler->name, "location" ) )
520 /* there MUST NOT be an item */
523 msg_Err( p_demux, "item <%s> already created",
528 psz_uri = decode_URI_duplicate( psz_value );
532 if( p_demux->p_sys->psz_base &&
533 !strstr( psz_uri, "://" ) )
535 char* psz_tmp = malloc(
536 strlen(p_demux->p_sys->psz_base) +
537 strlen(psz_uri) +1 );
540 msg_Err( p_demux, "out of memory");
543 sprintf( psz_tmp, "%s%s",
544 p_demux->p_sys->psz_base, psz_uri );
548 p_new_input = input_ItemNewExt( p_playlist, psz_uri,
550 p_new_input->p_meta = vlc_meta_New();
552 input_ItemCopyOptions( p_item->p_input, p_new_input );
563 else if( !strcmp( p_handler->name, "identifier" ) )
565 p_demux->p_sys->i_identifier = atoi( psz_value );
569 /* there MUST be an item */
572 msg_Err( p_demux, "item not yet created at <%s>",
577 if( p_handler->pf_handler.smpl )
579 p_handler->pf_handler.smpl( NULL, p_new_input,
590 /* unknown/unexpected xml node */
591 msg_Err( p_demux, "unexpected xml node %i", i_node );
597 msg_Err( p_demux, "unexpected end of xml data" );
603 * \brief handles the supported <track> sub-elements
605 static vlc_bool_t set_item_info SIMPLE_INTERFACE
607 /* exit if setting is impossible */
608 if( !psz_name || !psz_value || !p_input )
612 /* re-convert xml special characters inside psz_value */
613 resolve_xml_special_chars( psz_value );
615 /* handle each info element in a separate "if" clause */
616 if( !strcmp( psz_name, "title" ) )
618 p_input->psz_name = strdup( (char*)psz_value );
620 else if( !strcmp( psz_name, "creator" ) )
622 vlc_meta_SetArtist( p_input->p_meta, psz_value );
624 else if( !strcmp( psz_name, "album" ) )
626 vlc_meta_SetAlbum( p_input->p_meta, psz_value );
629 else if( !strcmp( psz_name, "trackNum" ) )
631 vlc_meta_SetTracknum( p_input->p_meta, psz_value );
633 else if( !strcmp( psz_name, "duration" ) )
635 long i_num = atol( psz_value );
636 p_input->i_duration = i_num*1000;
638 else if( !strcmp( psz_name, "annotation" ) )
640 vlc_meta_SetDescription( p_input->p_meta, psz_value );
647 * \brief parse the extension node of a XSPF playlist
649 static vlc_bool_t parse_extension_node COMPLEX_INTERFACE
651 char *psz_name = NULL;
652 char *psz_value = NULL;
653 char *psz_title = NULL;
655 xml_elem_hnd_t *p_handler = NULL;
657 xml_elem_hnd_t pl_elements[] =
658 { {"node", COMPLEX_CONTENT, {.cmplx = parse_extension_node} },
659 {"item", COMPLEX_CONTENT, {.cmplx = parse_extitem_node} },
660 {NULL, UNKNOWN_CONTENT, {NULL} }
663 /* read all extension node attributes */
664 while( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
666 psz_name = xml_ReaderName( p_xml_reader );
667 psz_value = xml_ReaderValue( p_xml_reader );
668 if( !psz_name || !psz_value )
670 msg_Err( p_demux, "invalid xml stream @ <node>" );
674 /* attribute: title */
675 if( !strcmp( psz_name, "title" ) )
677 psz_title = unescape_URI_duplicate( psz_value );
679 /* unknown attribute */
681 msg_Warn( p_demux, "invalid <node> attribute:\"%s\"", psz_name);
686 /* attribute title is mandatory except for <extension> */
687 if( !strcmp( psz_element, "node" ) && !psz_title )
689 msg_Warn( p_demux, "<node> requires \"title\" attribute" );
692 if( psz_title ) free( psz_title );
694 /* parse the child elements */
695 while( xml_ReaderRead( p_xml_reader ) == 1 )
697 i_node = xml_ReaderNodeType( p_xml_reader );
700 case XML_READER_NONE:
702 case XML_READER_STARTELEM:
703 /* element start tag */
704 psz_name = xml_ReaderName( p_xml_reader );
705 if( !psz_name || !*psz_name )
707 msg_Err( p_demux, "invalid xml stream" );
712 for( p_handler = pl_elements;
713 p_handler->name && strcmp( psz_name, p_handler->name );
715 if( !p_handler->name )
717 msg_Err( p_demux, "unexpected element <%s>", psz_name );
722 /* complex content is parsed in a separate function */
723 if( p_handler->type == COMPLEX_CONTENT )
725 if( p_handler->pf_handler.cmplx( p_demux,
742 case XML_READER_TEXT:
743 /* simple element content */
745 psz_value = xml_ReaderValue( p_xml_reader );
748 msg_Err( p_demux, "invalid xml stream" );
754 case XML_READER_ENDELEM:
755 /* element end tag */
756 psz_name = xml_ReaderName( p_xml_reader );
759 msg_Err( p_demux, "invalid xml stream" );
763 /* leave if the current parent node is terminated */
764 if( !strcmp( psz_name, psz_element ) )
769 /* there MUST have been a start tag for that element name */
770 if( !p_handler || !p_handler->name
771 || strcmp( p_handler->name, psz_name ))
773 msg_Err( p_demux, "there's no open element left for <%s>",
779 if( p_handler->pf_handler.smpl )
781 p_handler->pf_handler.smpl( p_item, NULL, p_handler->name,
789 /* unknown/unexpected xml node */
790 msg_Err( p_demux, "unexpected xml node %i", i_node );
800 * \brief parse the extension item node of a XSPF playlist
802 static vlc_bool_t parse_extitem_node COMPLEX_INTERFACE
804 char *psz_name = NULL;
805 char *psz_value = NULL;
808 /* read all extension item attributes */
809 while( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
811 psz_name = xml_ReaderName( p_xml_reader );
812 psz_value = xml_ReaderValue( p_xml_reader );
813 if( !psz_name || !psz_value )
815 msg_Err( p_demux, "invalid xml stream @ <item>" );
819 /* attribute: href */
820 if( !strcmp( psz_name, "href" ) )
822 i_href = atoi( psz_value );
824 /* unknown attribute */
826 msg_Warn( p_demux, "invalid <item> attribute:\"%s\"", psz_name);
831 /* attribute href is mandatory */
834 msg_Warn( p_demux, "<item> requires \"href\" attribute" );
838 if( i_href > p_demux->p_sys->i_tracklist_entries )
840 msg_Warn( p_demux, "invalid \"href\" attribute" );
847 * \brief skips complex element content that we can't manage
849 static vlc_bool_t skip_element COMPLEX_INTERFACE
853 while( xml_ReaderRead( p_xml_reader ) == 1 )
855 if( xml_ReaderNodeType( p_xml_reader ) == XML_READER_ENDELEM )
857 psz_endname = xml_ReaderName( p_xml_reader );
860 if( !strcmp( psz_element, psz_endname ) )