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
31 #include <vlc_interface.h>
32 #include <vlc_playlist.h>
33 #include <vlc_input.h>
35 #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>\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,
115 if( !p_item ) return;
117 /* if we get a node here, we must traverse it */
118 if( p_item->i_children > 0 )
121 for( i = 0; i < p_item->i_children; i++ )
123 xspf_export_item( p_item->pp_children[i], p_file, p_i_count );
128 /* don't write empty nodes */
129 if( p_item->i_children == 0 )
134 /* leaves can be written directly */
135 fprintf( p_file, "\t\t<track>\n" );
137 /* print identifier and increase the counter */
138 fprintf( p_file, "\t\t\t<identifier>%i</identifier>\n", *p_i_count );
141 /* -> the location */
142 if( p_item->p_input->psz_uri && *p_item->p_input->psz_uri )
144 psz = assertUTF8URI( p_item->p_input->psz_uri );
145 fprintf( p_file, "\t\t\t<location>%s</location>\n", psz );
149 /* -> the name/title (only if different from uri)*/
150 if( p_item->p_input->psz_name &&
151 p_item->p_input->psz_uri &&
152 strcmp( p_item->p_input->psz_uri, p_item->p_input->psz_name ) )
154 psz_temp = convert_xml_special_chars( p_item->p_input->psz_name );
156 fprintf( p_file, "\t\t\t<title>%s</title>\n", psz_temp );
160 if( p_item->p_input->p_meta == NULL )
162 goto xspfexportitem_end;
165 /* -> the artist/creator */
166 psz = input_item_GetArtist( p_item->p_input );
167 if( psz == NULL ) psz = strdup( "" );
168 psz_temp = convert_xml_special_chars( psz );
172 fprintf( p_file, "\t\t\t<creator>%s</creator>\n", psz_temp );
177 psz = input_item_GetAlbum( p_item->p_input );
178 if( psz == NULL ) psz = strdup( "" );
179 psz_temp = convert_xml_special_chars( psz );
183 fprintf( p_file, "\t\t\t<album>%s</album>\n", psz_temp );
187 /* -> the track number */
188 psz = input_item_GetTrackNum( p_item->p_input );
189 if( psz == NULL ) psz = strdup( "" );
194 fprintf( p_file, "\t\t\t<trackNum>%i</trackNum>\n", atoi( psz ) );
199 /* -> the description */
200 psz = input_item_GetDescription( p_item->p_input );
201 if( psz == NULL ) psz = strdup( "" );
202 psz_temp = convert_xml_special_chars( psz );
206 fprintf( p_file, "\t\t\t<annotation>%s</annotation>\n", psz_temp );
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 psz_temp = convert_xml_special_chars( p_item->p_input->psz_name );
240 fprintf( p_file, "\t\t<node title=\"%s\">\n",
241 *psz_temp ? p_item->p_input->psz_name : "" );
244 for( i = 0; i < p_item->i_children; i++ )
246 xspf_extension_item( p_item->pp_children[i], p_file, p_i_count );
249 fprintf( p_file, "\t\t</node>\n" );
254 /* print leaf and increase the counter */
255 fprintf( p_file, "\t\t\t<item href=\"%i\" />\n", *p_i_count );
262 * \param psz_name the location of the media ressource (e.g. local file,
263 * device, network stream, etc.)
264 * \return a new char buffer which asserts that the location is valid UTF-8
266 * \note the returned buffer must be freed, when it isn't used anymore
268 static char *assertUTF8URI( char *psz_name )
270 char *psz_ret = NULL; /**< the new result buffer to return */
271 char *psz_s = NULL, *psz_d = NULL; /**< src & dest pointers for URI conversion */
272 vlc_bool_t b_name_is_uri = VLC_FALSE;
274 if( !psz_name || !*psz_name )
277 /* check that string is valid UTF-8 */
278 /* XXX: Why do we even need to do that ? (all strings in core are UTF-8 encoded */
279 if( !( psz_s = EnsureUTF8( psz_name ) ) )
282 /* max. 3x for URI conversion (percent escaping) and
283 8 bytes for "file://" and NULL-termination */
284 psz_ret = (char *)malloc( sizeof(char)*strlen(psz_name)*6*3+8 );
288 /** \todo check for a valid scheme part preceding the colon */
289 if( strchr( psz_s, ':' ) )
292 b_name_is_uri = VLC_TRUE;
294 /* assume "file" scheme if no scheme-part is included */
297 strcpy( psz_ret, "file://" );
303 /* percent-encode all non-ASCII and the XML special characters and the percent sign itself */
304 if( *psz_s & B10000000 ||
309 ( *psz_s == '%' && !b_name_is_uri ) )
312 *psz_d++ = hexchars[(*psz_s >> 4) & B00001111];
313 *psz_d++ = hexchars[*psz_s & B00001111];
324 return (char *)realloc( psz_ret, sizeof(char)*strlen( psz_ret ) + 1 );