modules/misc/playlist/xspf.c

   1 /******************************************************************************
   2  * xspf.c : XSPF playlist export functions
   3  ******************************************************************************
   4  * Copyright (C) 2006-2009 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Daniel Stränger <vlc at schmaller dot de>
   8  *          Yoann Peronneau <yoann@videolan.org>
   9  *
  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.
  14  *
  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.
  19  *
  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  *******************************************************************************/
  24
  25 /**
  26  * \file modules/misc/playlist/xspf.c
  27  * \brief XSPF playlist export functions
  28  */
  29 #ifdef HAVE_CONFIG_H
  30 # include "config.h"
  31 #endif
  32
  33 #include <vlc_common.h>
  34 #include <vlc_playlist.h>
  35 #include <vlc_input.h>
  36 #include <vlc_strings.h>
  37 #include <vlc_url.h>
  38
  39 #include <assert.h>
  40
  41 int xspf_export_playlist( vlc_object_t *p_this );
  42
  43 static char *input_xml( input_item_t *p_item, char *(*func)(input_item_t *) )
  44 {
  45     char *tmp = func( p_item );
  46     if( tmp == NULL )
  47         return NULL;
  48     char *ret = convert_xml_special_chars( tmp );
  49     free( tmp );
  50     return ret;
  51 }
  52
  53 /**
  54  * \brief exports one item to file or traverse if item is a node
  55  * \param p_item playlist item to export
  56  * \param p_file file to write xml-converted item to
  57  * \param p_i_count counter for track identifiers
  58  */
  59 static void xspf_export_item( playlist_item_t *p_item, FILE *p_file,
  60                               int *p_i_count )
  61 {
  62     if( !p_item ) return;
  63
  64     /* if we get a node here, we must traverse it */
  65     if( p_item->i_children > 0 )
  66     {
  67         for( int i = 0; i < p_item->i_children; i++ )
  68             xspf_export_item( p_item->pp_children[i], p_file, p_i_count );
  69         return;
  70     }
  71
  72     /* don't write empty nodes */
  73     if( p_item->i_children == 0 )
  74         return;
  75
  76     input_item_t *p_input = p_item->p_input;
  77     char *psz;
  78     mtime_t i_duration;
  79
  80     /* leaves can be written directly */
  81     fputs( "\t\t<track>\n", p_file );
  82
  83     /* -> the location */
  84
  85     char *psz_uri = input_xml( p_input, input_item_GetURI );
  86     if( psz_uri && *psz_uri )
  87         fprintf( p_file, "\t\t\t<location>%s</location>\n", psz_uri );
  88
  89     /* -> the name/title (only if different from uri)*/
  90     psz = input_xml( p_input, input_item_GetTitle );
  91     if( psz && strcmp( psz_uri, psz ) )
  92         fprintf( p_file, "\t\t\t<title>%s</title>\n", psz );
  93     free( psz );
  94     free( psz_uri );
  95
  96     if( p_item->p_input->p_meta == NULL )
  97     {
  98         goto xspfexportitem_end;
  99     }
 100
 101     /* -> the artist/creator */
 102     psz = input_xml( p_input, input_item_GetArtist );
 103     if( psz && *psz )
 104         fprintf( p_file, "\t\t\t<creator>%s</creator>\n", psz );
 105     free( psz );
 106
 107     /* -> the album */
 108     psz = input_xml( p_input, input_item_GetAlbum );
 109     if( psz && *psz )
 110         fprintf( p_file, "\t\t\t<album>%s</album>\n", psz );
 111     free( psz );
 112
 113     /* -> the track number */
 114     psz = input_xml( p_input, input_item_GetTrackNum );
 115     if( psz )
 116     {
 117         int i_tracknum = atoi( psz );
 118
 119         free( psz );
 120         if( i_tracknum > 0 )
 121             fprintf( p_file, "\t\t\t<trackNum>%i</trackNum>\n", i_tracknum );
 122     }
 123
 124     /* -> the description */
 125     psz = input_xml( p_input, input_item_GetDescription );
 126     if( psz && *psz )
 127         fprintf( p_file, "\t\t\t<annotation>%s</annotation>\n", psz );
 128     free( psz );
 129
 130     psz = input_xml( p_input, input_item_GetURL );
 131     if( psz && *psz )
 132         fprintf( p_file, "\t\t\t<info>%s</info>\n", psz );
 133     free( psz );
 134
 135     psz = input_xml( p_input, input_item_GetArtURL );
 136     if( psz && *psz )
 137         fprintf( p_file, "\t\t\t<image>%s</image>\n", psz );
 138     free( psz );
 139
 140 xspfexportitem_end:
 141     /* -> the duration */
 142     i_duration = input_item_GetDuration( p_item->p_input );
 143     if( i_duration > 0 )
 144         fprintf( p_file, "\t\t\t<duration>%"PRIu64"</duration>\n",
 145                  i_duration / 1000 );
 146
 147     /* export the intenal id and the input's options (bookmarks, ...)
 148      * in <extension> */
 149     fputs( "\t\t\t<extension application=\""
 150            "http://www.videolan.org/vlc/playlist/0\">\n", p_file );
 151
 152     /* print the id and increase the counter */
 153     fprintf( p_file, "\t\t\t\t<vlc:id>%i</vlc:id>\n", *p_i_count );
 154     ( *p_i_count )++;
 155
 156     for( int i = 0; i < p_item->p_input->i_options; i++ )
 157     {
 158         char* psz_src = p_item->p_input->ppsz_options[i];
 159         char* psz_ret = NULL;
 160
 161         if ( psz_src[0] == ':' )
 162             psz_src++;
 163
 164         psz_ret = convert_xml_special_chars( psz_src );
 165         if ( psz_ret == NULL )
 166             continue;
 167
 168         fprintf( p_file, "\t\t\t\t<vlc:option>%s</vlc:option>\n", psz_ret );
 169         free( psz_ret );
 170     }
 171     fputs( "\t\t\t</extension>\n", p_file );
 172     fputs( "\t\t</track>\n", p_file );
 173 }
 174
 175 /**
 176  * \brief exports one item in extension to file and traverse if item is a node
 177  * \param p_item playlist item to export
 178  * \param p_file file to write xml-converted item to
 179  * \param p_i_count counter for track identifiers
 180  */
 181 static void xspf_extension_item( playlist_item_t *p_item, FILE *p_file,
 182                                  int *p_i_count )
 183 {
 184     if( !p_item ) return;
 185
 186     /* if we get a node here, we must traverse it */
 187     if( p_item->i_children >= 0 )
 188     {
 189         int i;
 190         char *psz_temp = NULL;
 191         if( p_item->p_input->psz_name )
 192             psz_temp = convert_xml_special_chars( p_item->p_input->psz_name );
 193         fprintf( p_file, "\t\t<vlc:node title=\"%s\">\n",
 194                  psz_temp ? psz_temp : "" );
 195         free( psz_temp );
 196
 197         for( i = 0; i < p_item->i_children; i++ )
 198         {
 199             xspf_extension_item( p_item->pp_children[i], p_file, p_i_count );
 200         }
 201
 202         fprintf( p_file, "\t\t</vlc:node>\n" );
 203         return;
 204     }
 205
 206
 207     /* print leaf and increase the counter */
 208     fprintf( p_file, "\t\t\t<vlc:item tid=\"%i\"/>\n", *p_i_count );
 209     ( *p_i_count )++;
 210
 211     return;
 212 }
 213
 214 /**
 215  * \brief Prints the XSPF header to file, writes each item by xspf_export_item()
 216  * and closes the open xml elements
 217  * \param p_this the VLC playlist object
 218  * \return VLC_SUCCESS if some memory is available, otherwise VLC_ENONMEM
 219  */
 220 int xspf_export_playlist( vlc_object_t *p_this )
 221 {
 222     const playlist_export_t *p_export = (playlist_export_t *)p_this;
 223     int               i, i_count;
 224     char             *psz_temp;
 225     playlist_item_t  *p_node = p_export->p_root;
 226
 227     /* write XSPF XML header */
 228     fprintf( p_export->p_file, "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" );
 229     fprintf( p_export->p_file,
 230              "<playlist xmlns=\"http://xspf.org/ns/0/\" " \
 231               "xmlns:vlc=\"http://www.videolan.org/vlc/playlist/ns/0/\" " \
 232               "version=\"1\">\n" );
 233
 234     if( !p_node ) return VLC_SUCCESS;
 235
 236     /* save name of the playlist node */
 237     psz_temp = convert_xml_special_chars( p_node->p_input->psz_name );
 238     if( *psz_temp )
 239     {
 240         fprintf(  p_export->p_file, "\t<title>%s</title>\n", psz_temp );
 241     }
 242     free( psz_temp );
 243
 244     /* export all items in a flat format */
 245     fprintf( p_export->p_file, "\t<trackList>\n" );
 246     i_count = 0;
 247     for( i = 0; i < p_node->i_children; i++ )
 248     {
 249         xspf_export_item( p_node->pp_children[i], p_export->p_file,
 250                           &i_count );
 251     }
 252     fprintf( p_export->p_file, "\t</trackList>\n" );
 253
 254     /* export the tree structure in <extension> */
 255     fprintf( p_export->p_file, "\t<extension application=\"" \
 256              "http://www.videolan.org/vlc/playlist/0\">\n" );
 257     i_count = 0;
 258     for( i = 0; i < p_node->i_children; i++ )
 259     {
 260         xspf_extension_item( p_node->pp_children[i], p_export->p_file,
 261                              &i_count );
 262     }
 263     fprintf( p_export->p_file, "\t</extension>\n" );
 264
 265     /* close the header elements */
 266     fprintf( p_export->p_file, "</playlist>\n" );
 267
 268     return VLC_SUCCESS;
 269 }