1 /******************************************************************************
2 * xspf.c : XSPF playlist export 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 *******************************************************************************/
26 * \file modules/misc/playlist/xspf.c
27 * \brief XSPF playlist export functions
33 #include <vlc_common.h>
34 #include <vlc_interface.h>
35 #include <vlc_playlist.h>
36 #include <vlc_input.h>
38 #include <vlc_strings.h>
40 #include <vlc_charset.h>
46 * \brief Prints the XSPF header to file, writes each item by xspf_export_item()
47 * and closes the open xml elements
48 * \param p_this the VLC playlist object
49 * \return VLC_SUCCESS if some memory is available, otherwise VLC_ENONMEM
51 int xspf_export_playlist( vlc_object_t *p_this )
53 const playlist_t *p_playlist = (playlist_t *)p_this;
54 const playlist_export_t *p_export =
55 (playlist_export_t *)p_playlist->p_private;
58 playlist_item_t *p_node = p_export->p_root;
60 /* write XSPF XML header */
61 fprintf( p_export->p_file, "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" );
62 fprintf( p_export->p_file,
63 "<playlist version=\"1\" xmlns=\"http://xspf.org/ns/0/\">\n" );
65 if( !p_node ) return VLC_SUCCESS;
67 /* save name of the playlist node */
68 psz_temp = convert_xml_special_chars( p_node->p_input->psz_name );
71 fprintf( p_export->p_file, "\t<title>%s</title>\n", psz_temp );
75 /* save location of the playlist node */
76 psz_temp = assertUTF8URI( p_export->psz_filename );
77 if( psz_temp && *psz_temp )
79 fprintf( p_export->p_file, "\t<location>%s</location>\n", psz_temp );
83 /* export all items in a flat format */
84 fprintf( p_export->p_file, "\t<trackList>\n" );
86 for( i = 0; i < p_node->i_children; i++ )
88 xspf_export_item( p_node->pp_children[i], p_export->p_file,
91 fprintf( p_export->p_file, "\t</trackList>\n" );
93 /* export the tree structure in <extension> */
94 fprintf( p_export->p_file, "\t<extension application=\"http://www.videolan.org/vlc/playlist/0\">\n" );
96 for( i = 0; i < p_node->i_children; i++ )
98 xspf_extension_item( p_node->pp_children[i], p_export->p_file,
101 fprintf( p_export->p_file, "\t</extension>\n" );
103 /* close the header elements */
104 fprintf( p_export->p_file, "</playlist>\n" );
110 * \brief exports one item to file or traverse if item is a node
111 * \param p_item playlist item to export
112 * \param p_file file to write xml-converted item to
113 * \param p_i_count counter for track identifiers
115 static void xspf_export_item( playlist_item_t *p_item, FILE *p_file,
123 if( !p_item ) return;
125 /* if we get a node here, we must traverse it */
126 if( p_item->i_children > 0 )
129 for( i = 0; i < p_item->i_children; i++ )
131 xspf_export_item( p_item->pp_children[i], p_file, p_i_count );
136 /* don't write empty nodes */
137 if( p_item->i_children == 0 )
142 /* leaves can be written directly */
143 fprintf( p_file, "\t\t<track>\n" );
145 /* print identifier and increase the counter */
146 fprintf( p_file, "\t\t\t<identifier>%i</identifier>\n", *p_i_count );
149 /* -> the location */
151 char *psz_uri = input_item_GetURI( p_item->p_input );
153 if( psz_uri && *psz_uri )
155 psz = assertUTF8URI( psz_uri );
156 fprintf( p_file, "\t\t\t<location>%s</location>\n", psz );
160 /* -> the name/title (only if different from uri)*/
161 char *psz_name = input_item_GetTitle( p_item->p_input );
162 if( psz_name && psz_uri && strcmp( psz_uri, psz_name ) )
164 psz_temp = convert_xml_special_chars( psz_name );
166 fprintf( p_file, "\t\t\t<title>%s</title>\n", psz_temp );
172 if( p_item->p_input->p_meta == NULL )
174 goto xspfexportitem_end;
177 /* -> the artist/creator */
178 psz = input_item_GetArtist( p_item->p_input );
179 if( psz == NULL ) psz = strdup( "" );
180 psz_temp = convert_xml_special_chars( psz );
184 fprintf( p_file, "\t\t\t<creator>%s</creator>\n", psz_temp );
189 psz = input_item_GetAlbum( p_item->p_input );
190 if( psz == NULL ) psz = strdup( "" );
191 psz_temp = convert_xml_special_chars( psz );
195 fprintf( p_file, "\t\t\t<album>%s</album>\n", psz_temp );
199 /* -> the track number */
200 psz = input_item_GetTrackNum( p_item->p_input );
201 if( psz == NULL ) psz = strdup( "" );
204 int i_tracknum = atoi( psz );
206 fprintf( p_file, "\t\t\t<trackNum>%i</trackNum>\n", i_tracknum );
210 /* -> the description */
211 psz = input_item_GetDescription( p_item->p_input );
212 if( psz == NULL ) psz = strdup( "" );
213 psz_temp = convert_xml_special_chars( psz );
217 fprintf( p_file, "\t\t\t<annotation>%s</annotation>\n", psz_temp );
221 psz = input_item_GetArtURL( p_item->p_input );
222 if( psz == NULL ) psz = strdup( "" );
223 if( !EMPTY_STR( psz ) )
225 psz_uri = assertUTF8URI( psz );
226 fprintf( p_file, "\t\t\t<image>%s</image>\n", psz_uri );
231 /* export the input's options (bookmarks, ...) in <extension> */
232 fprintf( p_file, "\t\t\t<extension application=\"http://www.videolan.org/vlc/playlist/0\">\n" );
233 for( i = 0; i < p_item->p_input->i_options; i++ )
235 fprintf( p_file, "\t\t\t\t<option>%s</option>\n",
236 p_item->p_input->ppsz_options[i][0] == ':' ?
237 p_item->p_input->ppsz_options[i] + 1 :
238 p_item->p_input->ppsz_options[i] );
240 fprintf( p_file, "\t\t\t</extension>\n" );
243 /* -> the duration */
244 i_duration = input_item_GetDuration( p_item->p_input );
247 fprintf( p_file, "\t\t\t<duration>%ld</duration>\n",
248 (long)(i_duration / 1000) );
251 fprintf( p_file, "\t\t</track>\n" );
257 * \brief exports one item in extension to file and traverse if item is a node
258 * \param p_item playlist item to export
259 * \param p_file file to write xml-converted item to
260 * \param p_i_count counter for track identifiers
262 static void xspf_extension_item( playlist_item_t *p_item, FILE *p_file,
265 if( !p_item ) return;
267 /* if we get a node here, we must traverse it */
268 if( p_item->i_children >= 0 )
272 psz_temp = convert_xml_special_chars( p_item->p_input->psz_name );
273 fprintf( p_file, "\t\t<node title=\"%s\">\n",
274 *psz_temp ? psz_temp : "" );
277 for( i = 0; i < p_item->i_children; i++ )
279 xspf_extension_item( p_item->pp_children[i], p_file, p_i_count );
282 fprintf( p_file, "\t\t</node>\n" );
287 /* print leaf and increase the counter */
288 fprintf( p_file, "\t\t\t<item href=\"%i\" />\n", *p_i_count );
295 * \param psz_name the location of the media ressource (e.g. local file,
296 * device, network stream, etc.)
297 * \return a new char buffer which asserts that the location is valid UTF-8
299 * \note the returned buffer must be freed, when it isn't used anymore
301 static char *assertUTF8URI( char *psz_name )
303 char *psz_ret = NULL; /**< the new result buffer to return */
304 char *psz_s = NULL, *psz_d = NULL; /**< src & dest pointers for URI conversion */
305 bool b_uri_is_file = false; /**< we do additional %-encoding if the URI is a file:// one */
307 if( !psz_name || !*psz_name )
310 /* check that string is valid UTF-8 */
311 /* XXX: Why do we even need to do that ? (all strings in core are UTF-8 encoded */
312 if( !( psz_s = EnsureUTF8( psz_name ) ) )
315 /* max. 3x for URI conversion (percent escaping) and
316 8 bytes for "file://" and NULL-termination */
317 psz_ret = (char *)malloc( sizeof(char)*strlen(psz_name)*6*3+8 );
321 /** \todo check for a valid scheme part preceding the colon */
322 size_t i_delim = strcspn( psz_s, ":" );
323 if( i_delim != strlen( psz_s ) )
325 i_delim++; /* skip the ':' */
326 strncpy( psz_ret, psz_s, i_delim );
327 psz_d = psz_ret + i_delim;
329 if( !strncmp( psz_s, "file://", 7 ) )
330 b_uri_is_file = true;
334 /* assume "file" scheme if no scheme-part is included */
337 strcpy( psz_ret, "file://" );
339 b_uri_is_file = true;
344 /* percent-encode all non-ASCII and the XML special characters and the percent sign itself */
345 if( *psz_s & B10000000 ||
364 *psz_d++ = hexchars[(*psz_s >> 4) & B00001111];
365 *psz_d++ = hexchars[*psz_s & B00001111];
376 return (char *)realloc( psz_ret, sizeof(char)*strlen( psz_ret ) + 1 );