1 /*******************************************************************************
2 * itml.c : iTunes Music Library import functions
3 *******************************************************************************
4 * Copyright (C) 2007 the VideoLAN team
7 * Authors: Yoann Peronneau <yoann@videolan.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *******************************************************************************/
24 * \file modules/demux/playlist/itml.c
25 * \brief iTunes Music Library import functions
32 #include <vlc_common.h>
33 #include <vlc_demux.h>
37 #include "vlc_strings.h"
46 static int Control( demux_t *, int, va_list );
47 static int Demux( demux_t * );
50 * \brief iTML submodule initialization function
52 int Import_iTML( vlc_object_t *p_this )
54 DEMUX_BY_EXTENSION_OR_FORCED_MSG( ".xml", "itml",
55 "using iTunes Media Library reader" );
59 void Close_iTML( vlc_object_t *p_this )
61 demux_t *p_demux = (demux_t *)p_this;
62 free( p_demux->p_sys );
66 * \brief demuxer function for iTML parsing
68 int Demux( demux_t *p_demux )
70 int i_ret = VLC_SUCCESS;
72 xml_reader_t *p_xml_reader = NULL;
73 char *psz_name = NULL;
75 p_demux->p_sys->i_ntracks = 0;
77 /* create new xml parser from stream */
78 p_xml = xml_Create( p_demux );
83 p_xml_reader = xml_ReaderCreate( p_xml, p_demux->s );
88 /* locating the root node */
89 if( i_ret == VLC_SUCCESS )
93 if( xml_ReaderRead( p_xml_reader ) != 1 )
95 msg_Err( p_demux, "can't read xml stream" );
98 } while( i_ret == VLC_SUCCESS &&
99 xml_ReaderNodeType( p_xml_reader ) != XML_READER_STARTELEM );
101 /* checking root node name */
102 if( i_ret == VLC_SUCCESS )
104 psz_name = xml_ReaderName( p_xml_reader );
105 if( !psz_name || strcmp( psz_name, "plist" ) )
107 msg_Err( p_demux, "invalid root node name: %s", psz_name );
108 i_ret = VLC_EGENERIC;
113 if( i_ret == VLC_SUCCESS )
115 xml_elem_hnd_t pl_elements[] =
116 { {"dict", COMPLEX_CONTENT, {.cmplx = parse_plist_dict} } };
117 i_ret = parse_plist_node( p_demux, p_current_input,
118 NULL, p_xml_reader, "plist",
120 HANDLE_PLAY_AND_RELEASE;
124 xml_ReaderDelete( p_xml, p_xml_reader );
127 return 0; /* Needed for correct operation of go back */
130 /** \brief dummy function for demux callback interface */
131 static int Control( demux_t *p_demux, int i_query, va_list args )
133 VLC_UNUSED(p_demux); VLC_UNUSED(i_query); VLC_UNUSED(args);
138 * \brief parse the root node of the playlist
140 static bool parse_plist_node COMPLEX_INTERFACE
142 VLC_UNUSED(p_track); VLC_UNUSED(psz_element);
143 char *psz_name = NULL;
144 char *psz_value = NULL;
145 bool b_version_found = false;
147 /* read all playlist attributes */
148 while( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
150 psz_name = xml_ReaderName( p_xml_reader );
151 psz_value = xml_ReaderValue( p_xml_reader );
152 if( !psz_name || !psz_value )
154 msg_Err( p_demux, "invalid xml stream @ <plist>" );
158 /* attribute: version */
159 if( !strcmp( psz_name, "version" ) )
161 b_version_found = true;
162 if( strcmp( psz_value, "1.0" ) )
163 msg_Warn( p_demux, "unsupported iTunes Media Library version" );
165 /* unknown attribute */
167 msg_Warn( p_demux, "invalid <plist> attribute:\"%s\"", psz_name);
171 /* attribute version is mandatory !!! */
172 if( !b_version_found )
173 msg_Warn( p_demux, "<plist> requires \"version\" attribute" );
175 return parse_dict( p_demux, p_input_item, NULL, p_xml_reader,
176 "plist", p_handlers );
180 * \brief parse a <dict>
181 * \param COMPLEX_INTERFACE
183 static bool parse_dict COMPLEX_INTERFACE
186 char *psz_name = NULL;
187 char *psz_value = NULL;
188 char *psz_key = NULL;
189 xml_elem_hnd_t *p_handler = NULL;
191 while( xml_ReaderRead( p_xml_reader ) == 1 )
193 i_node = xml_ReaderNodeType( p_xml_reader );
196 case XML_READER_NONE:
199 case XML_READER_STARTELEM:
200 /* element start tag */
201 psz_name = xml_ReaderName( p_xml_reader );
202 if( !psz_name || !*psz_name )
204 msg_Err( p_demux, "invalid xml stream" );
209 for( p_handler = p_handlers;
210 p_handler->name && strcmp( psz_name, p_handler->name );
212 if( !p_handler->name )
214 msg_Err( p_demux, "unexpected element <%s>", psz_name );
219 /* complex content is parsed in a separate function */
220 if( p_handler->type == COMPLEX_CONTENT )
222 if( p_handler->pf_handler.cmplx( p_demux,
240 case XML_READER_TEXT:
241 /* simple element content */
243 psz_value = xml_ReaderValue( p_xml_reader );
246 msg_Err( p_demux, "invalid xml stream" );
252 case XML_READER_ENDELEM:
253 /* element end tag */
254 psz_name = xml_ReaderName( p_xml_reader );
257 msg_Err( p_demux, "invalid xml stream" );
261 /* leave if the current parent node <track> is terminated */
262 if( !strcmp( psz_name, psz_element ) )
267 /* there MUST have been a start tag for that element name */
268 if( !p_handler || !p_handler->name
269 || strcmp( p_handler->name, psz_name ))
271 msg_Err( p_demux, "there's no open element left for <%s>",
276 /* special case: key */
277 if( !strcmp( p_handler->name, "key" ) )
279 psz_key = strdup( psz_value );
281 /* call the simple handler */
282 else if( p_handler->pf_handler.smpl )
284 p_handler->pf_handler.smpl( p_track, psz_key, psz_value );
291 /* unknown/unexpected xml node */
292 msg_Err( p_demux, "unexpected xml node %i", i_node );
298 msg_Err( p_demux, "unexpected end of xml data" );
303 static bool parse_plist_dict COMPLEX_INTERFACE
305 VLC_UNUSED(p_track); VLC_UNUSED(psz_element); VLC_UNUSED(p_handlers);
306 xml_elem_hnd_t pl_elements[] =
307 { {"dict", COMPLEX_CONTENT, {.cmplx = parse_tracks_dict} },
308 {"array", SIMPLE_CONTENT, {NULL} },
309 {"key", SIMPLE_CONTENT, {NULL} },
310 {"integer", SIMPLE_CONTENT, {NULL} },
311 {"string", SIMPLE_CONTENT, {NULL} },
312 {"date", SIMPLE_CONTENT, {NULL} },
313 {"true", SIMPLE_CONTENT, {NULL} },
314 {"false", SIMPLE_CONTENT, {NULL} },
315 {NULL, UNKNOWN_CONTENT, {NULL} }
318 return parse_dict( p_demux, p_input_item, NULL, p_xml_reader,
319 "dict", pl_elements );
322 static bool parse_tracks_dict COMPLEX_INTERFACE
324 VLC_UNUSED(p_track); VLC_UNUSED(psz_element); VLC_UNUSED(p_handlers);
325 xml_elem_hnd_t tracks_elements[] =
326 { {"dict", COMPLEX_CONTENT, {.cmplx = parse_track_dict} },
327 {"key", SIMPLE_CONTENT, {NULL} },
328 {NULL, UNKNOWN_CONTENT, {NULL} }
331 parse_dict( p_demux, p_input_item, NULL, p_xml_reader,
332 "dict", tracks_elements );
334 msg_Info( p_demux, "added %i tracks successfully",
335 p_demux->p_sys->i_ntracks );
340 static bool parse_track_dict COMPLEX_INTERFACE
342 VLC_UNUSED(psz_element); VLC_UNUSED(p_handlers);
343 input_item_t *p_new_input = NULL;
345 char *psz_uri = NULL;
346 p_track = new_track();
348 xml_elem_hnd_t track_elements[] =
349 { {"array", COMPLEX_CONTENT, {.cmplx = skip_element} },
350 {"key", SIMPLE_CONTENT, {.smpl = save_data} },
351 {"integer", SIMPLE_CONTENT, {.smpl = save_data} },
352 {"string", SIMPLE_CONTENT, {.smpl = save_data} },
353 {"date", SIMPLE_CONTENT, {.smpl = save_data} },
354 {"true", SIMPLE_CONTENT, {NULL} },
355 {"false", SIMPLE_CONTENT, {NULL} },
356 {NULL, UNKNOWN_CONTENT, {NULL} }
359 i_ret = parse_dict( p_demux, p_input_item, p_track,
360 p_xml_reader, "dict", track_elements );
362 msg_Dbg( p_demux, "name: %s, artist: %s, album: %s, genre: %s, trackNum: %s, location: %s",
363 p_track->name, p_track->artist, p_track->album, p_track->genre, p_track->trackNum, p_track->location );
365 if( !p_track->location )
367 msg_Err( p_demux, "Track needs Location" );
368 free_track( p_track );
372 psz_uri = decode_URI_duplicate( p_track->location );
376 if( strlen( psz_uri ) > 17 &&
377 !strncmp( psz_uri, "file://localhost/", 17 ) )
379 /* remove 'localhost/' */
380 memmove( psz_uri + 7, psz_uri + 17, strlen( psz_uri ) - 9 );
381 msg_Info( p_demux, "Adding '%s'", psz_uri );
383 p_new_input = input_item_NewExt( p_demux, psz_uri,
385 input_item_AddSubItem( p_input_item, p_new_input );
388 add_meta( p_new_input, p_track );
389 vlc_gc_decref( p_new_input );
391 p_demux->p_sys->i_ntracks++;
395 msg_Err( p_demux, "Don't know how to handle %s", psz_uri );
400 free_track( p_track );
404 static track_elem_t *new_track()
406 track_elem_t *p_track = NULL;
407 p_track = (track_elem_t *)malloc( sizeof( track_elem_t ) );
410 p_track->name = NULL;
411 p_track->artist = NULL;
412 p_track->album = NULL;
413 p_track->genre = NULL;
414 p_track->trackNum = NULL;
415 p_track->location = NULL;
416 p_track->duration = 0;
421 static void free_track( track_elem_t *p_track )
423 fprintf( stderr, "free track\n" );
427 FREE( p_track->name )
428 FREE( p_track->artist )
429 FREE( p_track->album )
430 FREE( p_track->genre )
431 FREE( p_track->trackNum )
432 FREE( p_track->location )
433 p_track->duration = 0;
437 static bool save_data SIMPLE_INTERFACE
439 /* exit if setting is impossible */
440 if( !psz_name || !psz_value || !p_track )
443 /* re-convert xml special characters inside psz_value */
444 resolve_xml_special_chars( psz_value );
446 #define SAVE_INFO( name, value ) \
447 if( !strcmp( psz_name, name ) ) { p_track->value = strdup( psz_value ); }
449 SAVE_INFO( "Name", name )
450 else SAVE_INFO( "Artist", artist )
451 else SAVE_INFO( "Album", album )
452 else SAVE_INFO( "Genre", genre )
453 else SAVE_INFO( "Track Number", trackNum )
454 else SAVE_INFO( "Location", location )
455 else if( !strcmp( psz_name, "Total Time" ) )
457 long i_num = atol( psz_value );
458 p_track->duration = (mtime_t) i_num*1000;
464 * \brief handles the supported <track> sub-elements
466 static bool add_meta( input_item_t *p_input_item,
467 track_elem_t *p_track )
469 /* exit if setting is impossible */
470 if( !p_input_item || !p_track )
473 #define SET_INFO( func, prop ) \
474 if( p_track->prop ) { func( p_input_item, p_track->prop ); }
476 SET_INFO( input_item_SetTitle, name )
477 SET_INFO( input_item_SetArtist, artist )
478 SET_INFO( input_item_SetAlbum, album )
479 SET_INFO( input_item_SetGenre, genre )
480 SET_INFO( input_item_SetTrackNum, trackNum )
481 SET_INFO( input_item_SetDuration, duration )
486 * \brief skips complex element content that we can't manage
488 static bool skip_element COMPLEX_INTERFACE
490 VLC_UNUSED(p_demux); VLC_UNUSED(p_input_item);
491 VLC_UNUSED(p_track); VLC_UNUSED(p_handlers);
494 while( xml_ReaderRead( p_xml_reader ) == 1 )
496 if( xml_ReaderNodeType( p_xml_reader ) == XML_READER_ENDELEM )
498 psz_endname = xml_ReaderName( p_xml_reader );
501 if( !strcmp( psz_element, psz_endname ) )