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_strings.h"
37 * \brief Prints the XSPF header to file, writes each item by xspf_export_item()
38 * and closes the open xml elements
39 * \param p_this the VLC playlist object
40 * \return VLC_SUCCESS if some memory is available, otherwise VLC_ENONMEM
42 int E_(xspf_export_playlist)( vlc_object_t *p_this )
44 const playlist_t *p_playlist = (playlist_t *)p_this;
45 const playlist_export_t *p_export =
46 (playlist_export_t *)p_playlist->p_private;
49 playlist_item_t **pp_items = NULL;
51 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 pp_items = p_node->pp_children;
62 i_size = p_node->i_children;
64 /* save name of the playlist node */
65 psz_temp = convert_xml_special_chars( p_node->p_input->psz_name );
68 fprintf( p_export->p_file, "\t<title>%s</title>\n", psz_temp );
72 /* save location of the playlist node */
73 psz_temp = assertUTF8URI( p_export->psz_filename );
74 if( psz_temp && *psz_temp )
76 fprintf( p_export->p_file, "\t<location>%s</location>\n", psz_temp );
80 /* export all items in a flat format */
81 fprintf( p_export->p_file, "\t<trackList>\n" );
83 for( i = 0; i < p_node->i_children; i++ )
85 xspf_export_item( p_node->pp_children[i], p_export->p_file,
88 fprintf( p_export->p_file, "\t</trackList>\n" );
90 /* export the tree structure in <extension> */
91 fprintf( p_export->p_file, "\t<extension>\n" );
93 for( i = 0; i < p_node->i_children; i++ )
95 xspf_extension_item( p_node->pp_children[i], p_export->p_file,
98 fprintf( p_export->p_file, "\t</extension>\n" );
100 /* close the header elements */
101 fprintf( p_export->p_file, "</playlist>\n" );
107 * \brief exports one item to file or traverse if item is a node
108 * \param p_item playlist item to export
109 * \param p_file file to write xml-converted item to
110 * \param p_i_count counter for track identifiers
112 static void xspf_export_item( playlist_item_t *p_item, FILE *p_file,
118 if( !p_item ) return;
120 /* if we get a node here, we must traverse it */
121 if( p_item->i_children > 0 )
124 for( i = 0; i < p_item->i_children; i++ )
126 xspf_export_item( p_item->pp_children[i], p_file, p_i_count );
131 /* leaves can be written directly */
132 fprintf( p_file, "\t\t<track>\n" );
134 /* print identifier and increase the counter */
135 fprintf( p_file, "\t\t\t<identifier>%d</identifier>\n", *p_i_count );
138 /* -> the location */
139 if( p_item->p_input->psz_uri && *p_item->p_input->psz_uri )
141 psz = assertUTF8URI( p_item->p_input->psz_uri );
142 fprintf( p_file, "\t\t\t<location>%s</location>\n", psz );
146 /* -> the name/title (only if different from uri)*/
147 if( p_item->p_input->psz_name &&
148 p_item->p_input->psz_uri &&
149 strcmp( p_item->p_input->psz_uri, p_item->p_input->psz_name ) )
151 psz_temp = convert_xml_special_chars( p_item->p_input->psz_name );
153 fprintf( p_file, "\t\t\t<title>%s</title>\n", psz_temp );
157 if( p_item->p_input->p_meta == NULL )
159 goto xspfexportitem_end;
162 /* -> the artist/creator */
163 psz = p_item->p_input->p_meta->psz_artist ?
164 strdup( p_item->p_input->p_meta->psz_artist ):
173 psz = p_item->p_input->p_meta->psz_author ?
174 strdup( p_item->p_input->p_meta->psz_author ):
177 psz_temp = convert_xml_special_chars( psz );
178 if( psz ) free( psz );
181 fprintf( p_file, "\t\t\t<creator>%s</creator>\n", psz_temp );
186 psz = p_item->p_input->p_meta->psz_album ?
187 strdup( p_item->p_input->p_meta->psz_album ):
189 psz_temp = convert_xml_special_chars( psz );
190 if( psz ) free( psz );
193 fprintf( p_file, "\t\t\t<album>%s</album>\n", psz_temp );
197 /* -> the track number */
198 psz = p_item->p_input->p_meta->psz_tracknum ?
199 strdup( p_item->p_input->p_meta->psz_tracknum ):
205 fprintf( p_file, "\t\t\t<trackNum>%i</trackNum>\n", atoi( psz ) );
211 /* -> the duration */
212 if( p_item->p_input->i_duration > 0 )
214 fprintf( p_file, "\t\t\t<duration>%ld</duration>\n",
215 (long)(p_item->p_input->i_duration / 1000) );
218 fprintf( p_file, "\t\t</track>\n" );
224 * \brief exports one item in extension to file and traverse if item is a node
225 * \param p_item playlist item to export
226 * \param p_file file to write xml-converted item to
227 * \param p_i_count counter for track identifiers
229 static void xspf_extension_item( playlist_item_t *p_item, FILE *p_file,
232 if( !p_item ) return;
234 /* if we get a node here, we must traverse it */
235 if( p_item->i_children > 0 )
239 fprintf( p_file, "\t\t<node>\n" );
240 fprintf( p_file, "\t\t\t<title>%s</title>\n",
241 p_item->p_input->psz_name );
243 for( i = 0; i < p_item->i_children; i++ )
245 xspf_extension_item( p_item->pp_children[i], p_file, p_i_count );
248 fprintf( p_file, "\t\t</node>\n" );
253 /* print leaf and increase the counter */
254 fprintf( p_file, "\t\t\t<item href=\"%d\" />\n", *p_i_count );
261 * \param psz_name the location of the media ressource (e.g. local file,
262 * device, network stream, etc.)
263 * \return a new char buffer which asserts that the location is valid UTF-8
265 * \note the returned buffer must be freed, when it isn't used anymore
267 static char *assertUTF8URI( char *psz_name )
269 char *psz_ret = NULL; /**< the new result buffer to return */
270 char *psz_s = NULL, *psz_d = NULL; /**< src & dest pointers for URI conversion */
271 vlc_bool_t b_name_is_uri = VLC_FALSE;
273 if( !psz_name || !*psz_name )
276 /* check that string is valid UTF-8 */
277 /* XXX: Why do we even need to do that ? (all strings in core are UTF-8 encoded */
278 if( !( psz_s = EnsureUTF8( psz_name ) ) )
281 /* max. 3x for URI conversion (percent escaping) and
282 8 bytes for "file://" and NULL-termination */
283 psz_ret = (char *)malloc( sizeof(char)*strlen(psz_name)*6*3+8 );
287 /** \todo check for a valid scheme part preceding the colon */
288 if( strchr( psz_s, ':' ) )
291 b_name_is_uri = VLC_TRUE;
293 /* assume "file" scheme if no scheme-part is included */
296 strcpy( psz_ret, "file://" );
302 /* percent-encode all non-ASCII and the XML special characters and the percent sign itself */
303 if( *psz_s & B10000000 ||
308 ( *psz_s == '%' && !b_name_is_uri ) )
311 *psz_d++ = hexchars[(*psz_s >> 4) & B00001111];
312 *psz_d++ = hexchars[*psz_s & B00001111];
323 return (char *)realloc( psz_ret, sizeof(char)*strlen( psz_ret ) + 1 );