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
30 #include <vlc_interface.h>
31 #include <vlc_playlist.h>
32 #include <vlc_input.h>
34 #include <vlc_strings.h>
36 #include <vlc_charset.h>
40 * \brief Prints the XSPF header to file, writes each item by xspf_export_item()
41 * and closes the open xml elements
42 * \param p_this the VLC playlist object
43 * \return VLC_SUCCESS if some memory is available, otherwise VLC_ENONMEM
45 int E_(xspf_export_playlist)( vlc_object_t *p_this )
47 const playlist_t *p_playlist = (playlist_t *)p_this;
48 const playlist_export_t *p_export =
49 (playlist_export_t *)p_playlist->p_private;
52 playlist_item_t *p_node = p_export->p_root;
54 /* write XSPF XML header */
55 fprintf( p_export->p_file, "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" );
56 fprintf( p_export->p_file,
57 "<playlist version=\"1\" xmlns=\"http://xspf.org/ns/0/\">\n" );
59 if( !p_node ) return VLC_SUCCESS;
61 /* save name of the playlist node */
62 psz_temp = convert_xml_special_chars( p_node->p_input->psz_name );
65 fprintf( p_export->p_file, "\t<title>%s</title>\n", psz_temp );
69 /* save location of the playlist node */
70 psz_temp = assertUTF8URI( p_export->psz_filename );
71 if( psz_temp && *psz_temp )
73 fprintf( p_export->p_file, "\t<location>%s</location>\n", psz_temp );
77 /* export all items in a flat format */
78 fprintf( p_export->p_file, "\t<trackList>\n" );
80 for( i = 0; i < p_node->i_children; i++ )
82 xspf_export_item( p_node->pp_children[i], p_export->p_file,
85 fprintf( p_export->p_file, "\t</trackList>\n" );
87 /* export the tree structure in <extension> */
88 fprintf( p_export->p_file, "\t<extension application=\"http://www.videolan.org/vlc/playlist/0\">\n" );
90 for( i = 0; i < p_node->i_children; i++ )
92 xspf_extension_item( p_node->pp_children[i], p_export->p_file,
95 fprintf( p_export->p_file, "\t</extension>\n" );
97 /* close the header elements */
98 fprintf( p_export->p_file, "</playlist>\n" );
104 * \brief exports one item to file or traverse if item is a node
105 * \param p_item playlist item to export
106 * \param p_file file to write xml-converted item to
107 * \param p_i_count counter for track identifiers
109 static void xspf_export_item( playlist_item_t *p_item, FILE *p_file,
116 if( !p_item ) return;
118 /* if we get a node here, we must traverse it */
119 if( p_item->i_children > 0 )
122 for( i = 0; i < p_item->i_children; i++ )
124 xspf_export_item( p_item->pp_children[i], p_file, p_i_count );
129 /* don't write empty nodes */
130 if( p_item->i_children == 0 )
135 /* leaves can be written directly */
136 fprintf( p_file, "\t\t<track>\n" );
138 /* print identifier and increase the counter */
139 fprintf( p_file, "\t\t\t<identifier>%i</identifier>\n", *p_i_count );
142 /* -> the location */
144 char *psz_uri = input_item_GetURI( p_item->p_input );
146 if( psz_uri && *psz_uri )
148 psz = assertUTF8URI( psz_uri );
149 fprintf( p_file, "\t\t\t<location>%s</location>\n", psz );
153 /* -> the name/title (only if different from uri)*/
154 char *psz_name = input_item_GetTitle( p_item->p_input );
155 if( psz_name && psz_uri && strcmp( psz_uri, psz_name ) )
157 psz_temp = convert_xml_special_chars( psz_name );
159 fprintf( p_file, "\t\t\t<title>%s</title>\n", psz_temp );
165 if( p_item->p_input->p_meta == NULL )
167 goto xspfexportitem_end;
170 /* -> the artist/creator */
171 psz = input_item_GetArtist( p_item->p_input );
172 if( psz == NULL ) psz = strdup( "" );
173 psz_temp = convert_xml_special_chars( psz );
177 fprintf( p_file, "\t\t\t<creator>%s</creator>\n", psz_temp );
182 psz = input_item_GetAlbum( p_item->p_input );
183 if( psz == NULL ) psz = strdup( "" );
184 psz_temp = convert_xml_special_chars( psz );
188 fprintf( p_file, "\t\t\t<album>%s</album>\n", psz_temp );
192 /* -> the track number */
193 psz = input_item_GetTrackNum( p_item->p_input );
194 if( psz == NULL ) psz = strdup( "" );
197 int i_tracknum = atoi( psz );
199 fprintf( p_file, "\t\t\t<trackNum>%i</trackNum>\n", i_tracknum );
203 /* -> the description */
204 psz = input_item_GetDescription( p_item->p_input );
205 if( psz == NULL ) psz = strdup( "" );
206 psz_temp = convert_xml_special_chars( psz );
210 fprintf( p_file, "\t\t\t<annotation>%s</annotation>\n", psz_temp );
214 psz = input_item_GetArtURL( p_item->p_input );
215 if( psz == NULL ) psz = strdup( "" );
216 if( !EMPTY_STR( psz ) )
218 psz_uri = assertUTF8URI( psz );
219 fprintf( p_file, "\t\t\t<image>%s</image>\n", psz_uri );
225 /* -> the duration */
226 i_duration = input_item_GetDuration( p_item->p_input );
229 fprintf( p_file, "\t\t\t<duration>%ld</duration>\n",
230 (long)(i_duration / 1000) );
233 fprintf( p_file, "\t\t</track>\n" );
239 * \brief exports one item in extension to file and traverse if item is a node
240 * \param p_item playlist item to export
241 * \param p_file file to write xml-converted item to
242 * \param p_i_count counter for track identifiers
244 static void xspf_extension_item( playlist_item_t *p_item, FILE *p_file,
247 if( !p_item ) return;
249 /* if we get a node here, we must traverse it */
250 if( p_item->i_children >= 0 )
254 psz_temp = encode_URI_component( p_item->p_input->psz_name );
255 fprintf( p_file, "\t\t<node title=\"%s\">\n",
256 *psz_temp ? psz_temp : "" );
259 for( i = 0; i < p_item->i_children; i++ )
261 xspf_extension_item( p_item->pp_children[i], p_file, p_i_count );
264 fprintf( p_file, "\t\t</node>\n" );
269 /* print leaf and increase the counter */
270 fprintf( p_file, "\t\t\t<item href=\"%i\" />\n", *p_i_count );
277 * \param psz_name the location of the media ressource (e.g. local file,
278 * device, network stream, etc.)
279 * \return a new char buffer which asserts that the location is valid UTF-8
281 * \note the returned buffer must be freed, when it isn't used anymore
283 static char *assertUTF8URI( char *psz_name )
285 char *psz_ret = NULL; /**< the new result buffer to return */
286 char *psz_s = NULL, *psz_d = NULL; /**< src & dest pointers for URI conversion */
287 vlc_bool_t b_uri_is_file = VLC_FALSE; /**< we do additional %-encoding if the URI is a file:// one */
289 if( !psz_name || !*psz_name )
292 /* check that string is valid UTF-8 */
293 /* XXX: Why do we even need to do that ? (all strings in core are UTF-8 encoded */
294 if( !( psz_s = EnsureUTF8( psz_name ) ) )
297 /* max. 3x for URI conversion (percent escaping) and
298 8 bytes for "file://" and NULL-termination */
299 psz_ret = (char *)malloc( sizeof(char)*strlen(psz_name)*6*3+8 );
303 /** \todo check for a valid scheme part preceding the colon */
304 size_t i_delim = strcspn( psz_s, ":" );
305 if( i_delim != strlen( psz_s ) )
307 i_delim++; /* skip the ':' */
308 strncpy( psz_ret, psz_s, i_delim );
309 psz_d = psz_ret + i_delim;
312 if( !strncmp( psz_s, "file://", 7 ) )
313 b_uri_is_file = VLC_TRUE;
315 /* assume "file" scheme if no scheme-part is included */
318 strcpy( psz_ret, "file://" );
320 b_uri_is_file = VLC_TRUE;
325 /* percent-encode all non-ASCII and the XML special characters and the percent sign itself */
326 if( *psz_s & B10000000 ||
344 *psz_d++ = hexchars[(*psz_s >> 4) & B00001111];
345 *psz_d++ = hexchars[*psz_s & B00001111];
356 return (char *)realloc( psz_ret, sizeof(char)*strlen( psz_ret ) + 1 );