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/input.h>
35 #include "vlc_strings.h"
40 playlist_item_t *p_item_in_category;
42 input_item_t **pp_tracklist;
43 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_(xspf_import_Activate)( vlc_object_t *p_this )
55 DEMUX_BY_EXTENSION_OR_FORCED_MSG( ".xspf", "xspf-open",
56 "using XSPF playlist reader" );
61 * \brief demuxer function for XSPF parsing
63 int Demux( demux_t *p_demux )
65 int i_ret = VLC_SUCCESS;
67 xml_reader_t *p_xml_reader = NULL;
68 char *psz_name = NULL;
70 p_demux->p_sys->p_item_in_category = p_item_in_category;
71 p_demux->p_sys->i_parent_id = i_parent_id;
72 p_demux->p_sys->pp_tracklist = NULL;
73 p_demux->p_sys->i_tracklist_entries = 0;
74 p_demux->p_sys->i_identifier = -1;
76 /* create new xml parser from stream */
77 p_xml = xml_Create( p_demux );
82 p_xml_reader = xml_ReaderCreate( p_xml, p_demux->s );
87 /* locating the root node */
88 if( i_ret == VLC_SUCCESS )
92 if( xml_ReaderRead( p_xml_reader ) != 1 )
94 msg_Err( p_demux, "can't read xml stream" );
97 } while( i_ret == VLC_SUCCESS &&
98 xml_ReaderNodeType( p_xml_reader ) != XML_READER_STARTELEM );
100 /* checking root node name */
101 if( i_ret == VLC_SUCCESS )
103 psz_name = xml_ReaderName( p_xml_reader );
104 if( !psz_name || strcmp( psz_name, "playlist" ) )
106 msg_Err( p_demux, "invalid root node name: %s", psz_name );
107 i_ret = VLC_EGENERIC;
112 i_ret = parse_playlist_node( p_demux, p_playlist, p_current, NULL,
113 p_xml_reader, "playlist" );
114 HANDLE_PLAY_AND_RELEASE;
116 xml_ReaderDelete( p_xml, p_xml_reader );
124 /** \brief dummy function for demux callback interface */
125 static int Control( demux_t *p_demux, int i_query, va_list args )
131 * \brief parse the root node of a XSPF playlist
132 * \param p_demux demuxer instance
133 * \param p_playlist playlist instance
134 * \param p_item current playlist item
135 * \param p_input current input item
136 * \param p_xml_reader xml reader instance
137 * \param psz_element name of element to parse
139 static vlc_bool_t parse_playlist_node COMPLEX_INTERFACE
142 char *psz_value=NULL;
143 vlc_bool_t b_version_found = VLC_FALSE;
145 xml_elem_hnd_t *p_handler=NULL;
147 xml_elem_hnd_t pl_elements[] =
148 { {"title", SIMPLE_CONTENT, {.smpl = set_item_info} },
149 {"creator", SIMPLE_CONTENT, {.smpl = set_item_info} },
150 {"annotation", SIMPLE_CONTENT, {NULL} },
151 {"info", SIMPLE_CONTENT, {NULL} },
152 {"location", SIMPLE_CONTENT, {NULL} },
153 {"identifier", SIMPLE_CONTENT, {NULL} },
154 {"image", SIMPLE_CONTENT, {NULL} },
155 {"date", SIMPLE_CONTENT, {NULL} },
156 {"license", SIMPLE_CONTENT, {NULL} },
157 {"attribution", COMPLEX_CONTENT, {.cmplx = skip_element} },
158 {"link", SIMPLE_CONTENT, {NULL} },
159 {"meta", SIMPLE_CONTENT, {NULL} },
160 {"extension", COMPLEX_CONTENT, {.cmplx = parse_extension_node} },
161 {"trackList", COMPLEX_CONTENT, {.cmplx = parse_tracklist_node} },
162 {NULL, UNKNOWN_CONTENT, {NULL} }
165 /* read all playlist attributes */
166 while( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
168 psz_name = xml_ReaderName( p_xml_reader );
169 psz_value = xml_ReaderValue( p_xml_reader );
170 if( !psz_name || !psz_value )
172 msg_Err( p_demux, "invalid xml stream @ <playlist>" );
176 /* attribute: version */
177 if( !strcmp( psz_name, "version" ) )
179 b_version_found = VLC_TRUE;
180 if( strcmp( psz_value, "0" ) && strcmp( psz_value, "1" ) )
181 msg_Warn( p_demux, "unsupported XSPF version" );
183 /* attribute: xmlns */
184 else if( !strcmp( psz_name, "xmlns" ) )
186 /* unknown attribute */
188 msg_Warn( p_demux, "invalid <playlist> attribute:\"%s\"", psz_name);
192 /* attribute version is mandatory !!! */
193 if( !b_version_found )
194 msg_Warn( p_demux, "<playlist> requires \"version\" attribute" );
196 /* parse the child elements - we only take care of <trackList> */
197 while( xml_ReaderRead( p_xml_reader ) == 1 )
199 i_node = xml_ReaderNodeType( p_xml_reader );
202 case XML_READER_NONE:
204 case XML_READER_STARTELEM:
205 /* element start tag */
206 psz_name = xml_ReaderName( p_xml_reader );
207 if( !psz_name || !*psz_name )
209 msg_Err( p_demux, "invalid xml stream" );
214 for( p_handler = pl_elements;
215 p_handler->name && strcmp( psz_name, p_handler->name );
217 if( !p_handler->name )
219 msg_Err( p_demux, "unexpected element <%s>", psz_name );
224 /* complex content is parsed in a separate function */
225 if( p_handler->type == COMPLEX_CONTENT )
227 if( p_handler->pf_handler.cmplx( p_demux,
244 case XML_READER_TEXT:
245 /* simple element content */
247 psz_value = xml_ReaderValue( p_xml_reader );
250 msg_Err( p_demux, "invalid xml stream" );
256 case XML_READER_ENDELEM:
257 /* element end tag */
258 psz_name = xml_ReaderName( p_xml_reader );
261 msg_Err( p_demux, "invalid xml stream" );
265 /* leave if the current parent node <playlist> is terminated */
266 if( !strcmp( psz_name, psz_element ) )
271 /* there MUST have been a start tag for that element name */
272 if( !p_handler || !p_handler->name
273 || strcmp( p_handler->name, psz_name ))
275 msg_Err( p_demux, "there's no open element left for <%s>",
281 if( p_handler->pf_handler.smpl )
283 p_handler->pf_handler.smpl( p_item, NULL, p_handler->name,
291 /* unknown/unexpected xml node */
292 msg_Err( p_demux, "unexpected xml node %i", i_node );
302 * \brief parses the tracklist node which only may contain <track>s
304 static vlc_bool_t parse_tracklist_node COMPLEX_INTERFACE
310 /* now parse the <track>s */
311 while( xml_ReaderRead( p_xml_reader ) == 1 )
313 i_node = xml_ReaderNodeType( p_xml_reader );
314 if( i_node == XML_READER_STARTELEM )
316 psz_name = xml_ReaderName( p_xml_reader );
319 msg_Err( p_demux, "unexpected end of xml data" );
323 if( strcmp( psz_name, "track") )
325 msg_Err( p_demux, "unexpected child of <trackList>: <%s>",
332 /* parse the track data in a separate function */
333 if( parse_track_node( p_demux, p_playlist, p_item, NULL,
334 p_xml_reader,"track" ) == VLC_TRUE )
337 else if( i_node == XML_READER_ENDELEM )
341 /* the <trackList> has to be terminated */
342 if( xml_ReaderNodeType( p_xml_reader ) != XML_READER_ENDELEM )
344 msg_Err( p_demux, "there's a missing </trackList>" );
348 psz_name = xml_ReaderName( p_xml_reader );
349 if( !psz_name || strcmp( psz_name, "trackList" ) )
351 msg_Err( p_demux, "expected: </trackList>, found: </%s>", psz_name );
357 msg_Dbg( p_demux, "parsed %i tracks successfully", i_ntracks );
363 * \brief parse one track element
364 * \param COMPLEX_INTERFACE
366 static vlc_bool_t parse_track_node COMPLEX_INTERFACE
368 input_item_t *p_new_input = NULL;
371 char *psz_value=NULL;
372 xml_elem_hnd_t *p_handler=NULL;
374 xml_elem_hnd_t track_elements[] =
375 { {"location", SIMPLE_CONTENT, {NULL} },
376 {"identifier", SIMPLE_CONTENT, {NULL} },
377 {"title", SIMPLE_CONTENT, {.smpl = set_item_info} },
378 {"creator", SIMPLE_CONTENT, {.smpl = set_item_info} },
379 {"annotation", SIMPLE_CONTENT, {NULL} },
380 {"info", SIMPLE_CONTENT, {NULL} },
381 {"image", SIMPLE_CONTENT, {NULL} },
382 {"album", SIMPLE_CONTENT, {.smpl = set_item_info} },
383 {"trackNum", SIMPLE_CONTENT, {.smpl = set_item_info} },
384 {"duration", SIMPLE_CONTENT, {.smpl = set_item_info} },
385 {"link", SIMPLE_CONTENT, {NULL} },
386 {"meta", SIMPLE_CONTENT, {NULL} },
387 {"extension", COMPLEX_CONTENT, {.cmplx = skip_element} },
388 {NULL, UNKNOWN_CONTENT, {NULL} }
391 while( xml_ReaderRead( p_xml_reader ) == 1 )
393 i_node = xml_ReaderNodeType( p_xml_reader );
396 case XML_READER_NONE:
399 case XML_READER_STARTELEM:
400 /* element start tag */
401 psz_name = xml_ReaderName( p_xml_reader );
402 if( !psz_name || !*psz_name )
404 msg_Err( p_demux, "invalid xml stream" );
409 for( p_handler = track_elements;
410 p_handler->name && strcmp( psz_name, p_handler->name );
412 if( !p_handler->name )
414 msg_Err( p_demux, "unexpected element <%s>", psz_name );
419 /* complex content is parsed in a separate function */
420 if( p_handler->type == COMPLEX_CONTENT )
425 "at <%s> level no new item has been allocated",
430 if( p_handler->pf_handler.cmplx( p_demux,
447 case XML_READER_TEXT:
448 /* simple element content */
450 psz_value = xml_ReaderValue( p_xml_reader );
453 msg_Err( p_demux, "invalid xml stream" );
459 case XML_READER_ENDELEM:
460 /* element end tag */
461 psz_name = xml_ReaderName( p_xml_reader );
464 msg_Err( p_demux, "invalid xml stream" );
468 /* leave if the current parent node <track> is terminated */
469 if( !strcmp( psz_name, psz_element ) )
473 playlist_AddWhereverNeeded( p_playlist, p_new_input,
474 p_item, p_demux->p_sys->p_item_in_category,
475 (p_demux->p_sys->i_parent_id >0 ) ? VLC_TRUE:
476 VLC_FALSE, PLAYLIST_APPEND );
477 if( p_demux->p_sys->i_identifier <
478 p_demux->p_sys->i_tracklist_entries )
480 p_demux->p_sys->pp_tracklist[
481 p_demux->p_sys->i_identifier ] = p_new_input;
485 if( p_demux->p_sys->i_identifier >
486 p_demux->p_sys->i_tracklist_entries )
488 p_demux->p_sys->i_tracklist_entries =
489 p_demux->p_sys->i_identifier;
491 INSERT_ELEM( p_demux->p_sys->pp_tracklist,
492 p_demux->p_sys->i_tracklist_entries,
493 p_demux->p_sys->i_tracklist_entries,
498 /* there MUST have been a start tag for that element name */
499 if( !p_handler || !p_handler->name
500 || strcmp( p_handler->name, psz_name ))
502 msg_Err( p_demux, "there's no open element left for <%s>",
508 /* special case: location */
509 if( !strcmp( p_handler->name, "location" ) )
512 /* there MUST NOT be an item */
515 msg_Err( p_demux, "item <%s> already created",
520 psz_uri = unescape_URI_duplicate( psz_value );
524 p_new_input = input_ItemNewExt( p_playlist, psz_uri,
526 p_new_input->p_meta = vlc_meta_New();
528 vlc_input_item_CopyOptions( p_item->p_input, p_new_input );
539 else if( !strcmp( p_handler->name, "identifier" ) )
541 p_demux->p_sys->i_identifier = atoi( psz_value );
545 /* there MUST be an item */
548 msg_Err( p_demux, "item not yet created at <%s>",
553 if( p_handler->pf_handler.smpl )
555 p_handler->pf_handler.smpl( NULL, p_input,
566 /* unknown/unexpected xml node */
567 msg_Err( p_demux, "unexpected xml node %i", i_node );
573 msg_Err( p_demux, "unexpected end of xml data" );
579 * \brief handles the supported <track> sub-elements
581 static vlc_bool_t set_item_info SIMPLE_INTERFACE
583 /* exit if setting is impossible */
584 if( !psz_name || !psz_value || !p_input )
587 /* re-convert xml special characters inside psz_value */
588 resolve_xml_special_chars( psz_value );
590 /* handle each info element in a separate "if" clause */
591 if( !strcmp( psz_name, "title" ) )
593 p_input->psz_name = strdup( (char*)psz_value );
595 else if( !strcmp( psz_name, "creator" ) )
597 vlc_meta_SetArtist( p_input->p_meta, psz_value );
599 else if( !strcmp( psz_name, "album" ) )
601 vlc_meta_SetAlbum( p_input->p_meta, psz_value );
604 else if( !strcmp( psz_name, "trackNum" ) )
606 vlc_meta_SetTracknum( p_input->p_meta, psz_value );
608 else if( !strcmp( psz_name, "duration" ) )
610 long i_num = atol( psz_value );
611 p_input->i_duration = i_num*1000;
618 * \brief parse the extension node of a XSPF playlist
620 static vlc_bool_t parse_extension_node COMPLEX_INTERFACE
622 char *psz_name = NULL;
623 char *psz_value = NULL;
624 char *psz_title = NULL;
626 xml_elem_hnd_t *p_handler = NULL;
628 xml_elem_hnd_t pl_elements[] =
629 { {"node", COMPLEX_CONTENT, {.cmplx = parse_extension_node} },
630 {"item", COMPLEX_CONTENT, {.cmplx = parse_extitem_node} },
631 {NULL, UNKNOWN_CONTENT, {NULL} }
634 /* read all extension node attributes */
635 while( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
637 psz_name = xml_ReaderName( p_xml_reader );
638 psz_value = xml_ReaderValue( p_xml_reader );
639 if( !psz_name || !psz_value )
641 msg_Err( p_demux, "invalid xml stream @ <node>" );
645 /* attribute: title */
646 if( !strcmp( psz_name, "title" ) )
648 psz_title = unescape_URI_duplicate( psz_value );
650 /* unknown attribute */
652 msg_Warn( p_demux, "invalid <node> attribute:\"%s\"", psz_name);
657 /* attribute title is mandatory except for <extension> */
658 if( !strcmp( psz_element, "node" ) && !psz_title )
660 msg_Warn( p_demux, "<node> requires \"title\" attribute" );
664 if( !strcmp( psz_element, "node" ) )
666 fprintf( stderr, " node: %s\n", psz_title );
668 if( psz_title ) free( psz_title );
670 /* parse the child elements */
671 while( xml_ReaderRead( p_xml_reader ) == 1 )
673 i_node = xml_ReaderNodeType( p_xml_reader );
676 case XML_READER_NONE:
678 case XML_READER_STARTELEM:
679 /* element start tag */
680 psz_name = xml_ReaderName( p_xml_reader );
681 if( !psz_name || !*psz_name )
683 msg_Err( p_demux, "invalid xml stream" );
688 for( p_handler = pl_elements;
689 p_handler->name && strcmp( psz_name, p_handler->name );
691 if( !p_handler->name )
693 msg_Err( p_demux, "unexpected element <%s>", psz_name );
698 /* complex content is parsed in a separate function */
699 if( p_handler->type == COMPLEX_CONTENT )
701 if( p_handler->pf_handler.cmplx( p_demux,
718 case XML_READER_TEXT:
719 /* simple element content */
721 psz_value = xml_ReaderValue( p_xml_reader );
724 msg_Err( p_demux, "invalid xml stream" );
730 case XML_READER_ENDELEM:
731 /* element end tag */
732 psz_name = xml_ReaderName( p_xml_reader );
735 msg_Err( p_demux, "invalid xml stream" );
739 /* leave if the current parent node is terminated */
740 if( !strcmp( psz_name, psz_element ) )
742 fprintf( stderr, " </node>\n" );
746 /* there MUST have been a start tag for that element name */
747 if( !p_handler || !p_handler->name
748 || strcmp( p_handler->name, psz_name ))
750 msg_Err( p_demux, "there's no open element left for <%s>",
756 if( p_handler->pf_handler.smpl )
758 p_handler->pf_handler.smpl( p_item, NULL, p_handler->name,
766 /* unknown/unexpected xml node */
767 msg_Err( p_demux, "unexpected xml node %i", i_node );
777 * \brief parse the extension item node of a XSPF playlist
779 static vlc_bool_t parse_extitem_node COMPLEX_INTERFACE
781 char *psz_name = NULL;
782 char *psz_value = NULL;
785 /* read all extension item attributes */
786 while( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
788 psz_name = xml_ReaderName( p_xml_reader );
789 psz_value = xml_ReaderValue( p_xml_reader );
790 if( !psz_name || !psz_value )
792 msg_Err( p_demux, "invalid xml stream @ <item>" );
796 /* attribute: href */
797 if( !strcmp( psz_name, "href" ) )
799 i_href = atoi( psz_value );
801 /* unknown attribute */
803 msg_Warn( p_demux, "invalid <item> attribute:\"%s\"", psz_name);
808 /* attribute href is mandatory */
811 msg_Warn( p_demux, "<item> requires \"href\" attribute" );
815 if( i_href > p_demux->p_sys->i_tracklist_entries )
817 msg_Warn( p_demux, "invalid \"href\" attribute" );
821 fprintf( stderr, " %s\n", p_demux->p_sys->pp_tracklist[i_href]->psz_name );
827 * \brief skips complex element content that we can't manage
829 static vlc_bool_t skip_element COMPLEX_INTERFACE
833 while( xml_ReaderRead( p_xml_reader ) == 1 )
835 if( xml_ReaderNodeType( p_xml_reader ) == XML_READER_ENDELEM )
837 psz_endname = xml_ReaderName( p_xml_reader );
840 if( !strcmp( psz_element, psz_endname ) )