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
34 #include "vlc_strings.h"
39 * \brief Prints the XSPF header to file, writes each item by xspf_export_item()
40 * and closes the open xml elements
41 * \param p_this the VLC playlist object
42 * \return VLC_SUCCESS if some memory is available, otherwise VLC_ENONMEM
44 int E_(xspf_export_playlist)( vlc_object_t *p_this )
46 const playlist_t *p_playlist = (playlist_t *)p_this;
47 const playlist_export_t *p_export =
48 (playlist_export_t *)p_playlist->p_private;
51 playlist_item_t *p_node = p_export->p_root;
53 /* write XSPF XML header */
54 fprintf( p_export->p_file, "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" );
55 fprintf( p_export->p_file,
56 "<playlist version=\"1\" xmlns=\"http://xspf.org/ns/0/\">\n" );
58 if( !p_node ) return VLC_SUCCESS;
60 /* save name of the playlist node */
61 psz_temp = convert_xml_special_chars( p_node->p_input->psz_name );
64 fprintf( p_export->p_file, "\t<title>%s</title>\n", psz_temp );
68 /* save location of the playlist node */
69 psz_temp = assertUTF8URI( p_export->psz_filename );
70 if( psz_temp && *psz_temp )
72 fprintf( p_export->p_file, "\t<location>%s</location>\n", psz_temp );
76 /* export all items in a flat format */
77 fprintf( p_export->p_file, "\t<trackList>\n" );
79 for( i = 0; i < p_node->i_children; i++ )
81 xspf_export_item( p_node->pp_children[i], p_export->p_file,
84 fprintf( p_export->p_file, "\t</trackList>\n" );
86 /* export the tree structure in <extension> */
87 fprintf( p_export->p_file, "\t<extension>\n" );
89 for( i = 0; i < p_node->i_children; i++ )
91 xspf_extension_item( p_node->pp_children[i], p_export->p_file,
94 fprintf( p_export->p_file, "\t</extension>\n" );
96 /* close the header elements */
97 fprintf( p_export->p_file, "</playlist>\n" );
103 * \brief exports one item to file or traverse if item is a node
104 * \param p_item playlist item to export
105 * \param p_file file to write xml-converted item to
106 * \param p_i_count counter for track identifiers
108 static void xspf_export_item( playlist_item_t *p_item, FILE *p_file,
114 if( !p_item ) return;
116 /* if we get a node here, we must traverse it */
117 if( p_item->i_children > 0 )
120 for( i = 0; i < p_item->i_children; i++ )
122 xspf_export_item( p_item->pp_children[i], p_file, p_i_count );
127 /* don't write empty nodes */
128 if( p_item->i_children == 0 )
133 /* leaves can be written directly */
134 fprintf( p_file, "\t\t<track>\n" );
136 /* print identifier and increase the counter */
137 fprintf( p_file, "\t\t\t<identifier>%i</identifier>\n", *p_i_count );
140 /* -> the location */
141 if( p_item->p_input->psz_uri && *p_item->p_input->psz_uri )
143 psz = assertUTF8URI( p_item->p_input->psz_uri );
144 fprintf( p_file, "\t\t\t<location>%s</location>\n", psz );
148 /* -> the name/title (only if different from uri)*/
149 if( p_item->p_input->psz_name &&
150 p_item->p_input->psz_uri &&
151 strcmp( p_item->p_input->psz_uri, p_item->p_input->psz_name ) )
153 psz_temp = convert_xml_special_chars( p_item->p_input->psz_name );
155 fprintf( p_file, "\t\t\t<title>%s</title>\n", psz_temp );
159 if( p_item->p_input->p_meta == NULL )
161 goto xspfexportitem_end;
164 /* -> the artist/creator */
165 psz = p_item->p_input->p_meta->psz_artist ?
166 strdup( p_item->p_input->p_meta->psz_artist ):
175 psz = p_item->p_input->p_meta->psz_author ?
176 strdup( p_item->p_input->p_meta->psz_author ):
179 psz_temp = convert_xml_special_chars( psz );
180 if( psz ) free( psz );
183 fprintf( p_file, "\t\t\t<creator>%s</creator>\n", psz_temp );
188 psz = p_item->p_input->p_meta->psz_album ?
189 strdup( p_item->p_input->p_meta->psz_album ):
191 psz_temp = convert_xml_special_chars( psz );
192 if( psz ) free( psz );
195 fprintf( p_file, "\t\t\t<album>%s</album>\n", psz_temp );
199 /* -> the track number */
200 psz = p_item->p_input->p_meta->psz_tracknum ?
201 strdup( p_item->p_input->p_meta->psz_tracknum ):
207 fprintf( p_file, "\t\t\t<trackNum>%i</trackNum>\n", atoi( psz ) );
213 /* -> the duration */
214 if( p_item->p_input->i_duration > 0 )
216 fprintf( p_file, "\t\t\t<duration>%ld</duration>\n",
217 (long)(p_item->p_input->i_duration / 1000) );
220 fprintf( p_file, "\t\t</track>\n" );
226 * \brief exports one item in extension to file and traverse if item is a node
227 * \param p_item playlist item to export
228 * \param p_file file to write xml-converted item to
229 * \param p_i_count counter for track identifiers
231 static void xspf_extension_item( playlist_item_t *p_item, FILE *p_file,
234 if( !p_item ) return;
236 /* if we get a node here, we must traverse it */
237 if( p_item->i_children >= 0 )
241 psz_temp = convert_xml_special_chars( p_item->p_input->psz_name );
242 fprintf( p_file, "\t\t<node title=\"%s\">\n",
243 *psz_temp ? p_item->p_input->psz_name : "" );
246 for( i = 0; i < p_item->i_children; i++ )
248 xspf_extension_item( p_item->pp_children[i], p_file, p_i_count );
251 fprintf( p_file, "\t\t</node>\n" );
256 /* print leaf and increase the counter */
257 fprintf( p_file, "\t\t\t<item href=\"%i\" />\n", *p_i_count );
264 * \param psz_name the location of the media ressource (e.g. local file,
265 * device, network stream, etc.)
266 * \return a new char buffer which asserts that the location is valid UTF-8
268 * \note the returned buffer must be freed, when it isn't used anymore
270 static char *assertUTF8URI( char *psz_name )
272 char *psz_ret = NULL; /**< the new result buffer to return */
273 char *psz_s = NULL, *psz_d = NULL; /**< src & dest pointers for URI conversion */
274 vlc_bool_t b_name_is_uri = VLC_FALSE;
276 if( !psz_name || !*psz_name )
279 /* check that string is valid UTF-8 */
280 /* XXX: Why do we even need to do that ? (all strings in core are UTF-8 encoded */
281 if( !( psz_s = EnsureUTF8( psz_name ) ) )
284 /* max. 3x for URI conversion (percent escaping) and
285 8 bytes for "file://" and NULL-termination */
286 psz_ret = (char *)malloc( sizeof(char)*strlen(psz_name)*6*3+8 );
290 /** \todo check for a valid scheme part preceding the colon */
291 if( strchr( psz_s, ':' ) )
294 b_name_is_uri = VLC_TRUE;
296 /* assume "file" scheme if no scheme-part is included */
299 strcpy( psz_ret, "file://" );
305 /* percent-encode all non-ASCII and the XML special characters and the percent sign itself */
306 if( *psz_s & B10000000 ||
311 ( *psz_s == '%' && !b_name_is_uri ) )
314 *psz_d++ = hexchars[(*psz_s >> 4) & B00001111];
315 *psz_d++ = hexchars[*psz_s & B00001111];
326 return (char *)realloc( psz_ret, sizeof(char)*strlen( psz_ret ) + 1 );