]> git.sesse.net Git - vlc/blobdiff - modules/demux/playlist/xspf.c
Preparse playlist items that don't have enough meta
[vlc] / modules / demux / playlist / xspf.c
index fd1c359074dfd479f9cf16639438f05d34c5625b..7be83eb4614d51d36197fbfddaf9c6de5f3c9438 100644 (file)
@@ -1,5 +1,11 @@
 /*******************************************************************************
- * Copyright (C) 2006 Daniel Stränger <vlc at schmaller dot de>
+ * xspf.c : XSPF playlist import functions
+ *******************************************************************************
+ * Copyright (C) 2006 the VideoLAN team
+ * $Id$
+ *
+ * Authors: Daniel Stränger <vlc at schmaller dot de>
+ *          Yoann Peronneau <yoann@videolan.org>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
 #include "playlist.h"
 #include "vlc_xml.h"
 #include "vlc_strings.h"
+#include "vlc_url.h"
 #include "xspf.h"
 
-struct demux_sys_t 
+struct demux_sys_t
 {
     playlist_item_t *p_item_in_category;
-    int i_parent_id;
+    input_item_t **pp_tracklist;
+    int i_tracklist_entries;
+    int i_identifier;
+    char * psz_base;
 };
 
+static int Control( demux_t *, int, va_list );
+static int Demux( demux_t * );
+
 /**
  * \brief XSPF submodule initialization function
  */
-int E_(xspf_import_Activate)( vlc_object_t *p_this )
+int E_(Import_xspf)( vlc_object_t *p_this )
 {
-    demux_t *p_demux = (demux_t *)p_this;
-    char    *psz_ext;
-
-    psz_ext = strrchr( p_demux->psz_path, '.' );
-
-    if( ( psz_ext && !strcasecmp( psz_ext, ".xspf") ) ||
-        ( p_demux->psz_demux && !strcmp(p_demux->psz_demux, "xspf-open") ) )
-    {
-        ;
-    }
-    else
-    {
-        return VLC_EGENERIC;
-    }
-    msg_Dbg( p_demux, "using xspf playlist import");
-
-    p_demux->p_sys = (demux_sys_t*)malloc(sizeof(demux_sys_t ) );
-
-    p_demux->pf_control = xspf_import_Control;
-    p_demux->pf_demux = xspf_import_Demux;
-
+    DEMUX_BY_EXTENSION_OR_FORCED_MSG( ".xspf", "xspf-open",
+                                      "using XSPF playlist reader" );
     return VLC_SUCCESS;
 }
 
+void E_(Close_xspf)( vlc_object_t *p_this )
+{
+    demux_t *p_demux = (demux_t *)p_this;
+    FREENULL( p_demux->p_sys->psz_base);
+    free( p_demux->p_sys );
+}
+
 /**
  * \brief demuxer function for XSPF parsing
  */
-int xspf_import_Demux( demux_t *p_demux )
+int Demux( demux_t *p_demux )
 {
     int i_ret = VLC_SUCCESS;
     xml_t *p_xml = NULL;
@@ -75,7 +76,10 @@ int xspf_import_Demux( demux_t *p_demux )
     char *psz_name = NULL;
     INIT_PLAYLIST_STUFF;
     p_demux->p_sys->p_item_in_category = p_item_in_category;
-    p_demux->p_sys->i_parent_id = i_parent_id;
+    p_demux->p_sys->pp_tracklist = NULL;
+    p_demux->p_sys->i_tracklist_entries = 0;
+    p_demux->p_sys->i_identifier = -1;
+    p_demux->p_sys->psz_base = NULL;
 
     /* create new xml parser from stream */
     p_xml = xml_Create( p_demux );
@@ -113,20 +117,18 @@ int xspf_import_Demux( demux_t *p_demux )
         FREE_NAME();
     }
 
-    i_ret = parse_playlist_node( p_demux, p_playlist, p_current, NULL, 
+    i_ret = parse_playlist_node( p_demux, p_playlist, p_current, NULL,
                                  p_xml_reader, "playlist" );
     HANDLE_PLAY_AND_RELEASE;
     if( p_xml_reader )
         xml_ReaderDelete( p_xml, p_xml_reader );
     if( p_xml )
         xml_Delete( p_xml );
-
-    return i_ret;
-    return 0;
+    return -1; /* Needed for correct operation of go back */
 }
 
 /** \brief dummy function for demux callback interface */
-int xspf_import_Control( demux_t *p_demux, int i_query, va_list args )
+static int Control( demux_t *p_demux, int i_query, va_list args )
 {
     return VLC_EGENERIC;
 }
@@ -161,7 +163,7 @@ static vlc_bool_t parse_playlist_node COMPLEX_INTERFACE
           {"attribution",  COMPLEX_CONTENT, {.cmplx = skip_element} },
           {"link",         SIMPLE_CONTENT,  {NULL} },
           {"meta",         SIMPLE_CONTENT,  {NULL} },
-          {"extension",    COMPLEX_CONTENT, {.cmplx = skip_element} },
+          {"extension",    COMPLEX_CONTENT, {.cmplx = parse_extension_node} },
           {"trackList",    COMPLEX_CONTENT, {.cmplx = parse_tracklist_node} },
           {NULL,           UNKNOWN_CONTENT, {NULL} }
         };
@@ -187,6 +189,10 @@ static vlc_bool_t parse_playlist_node COMPLEX_INTERFACE
         /* attribute: xmlns */
         else if( !strcmp( psz_name, "xmlns" ) )
             ;
+        else if( !strcmp( psz_name, "xml:base" ) )
+        {
+            p_demux->p_sys->psz_base = decode_URI_duplicate( psz_value );
+        }
         /* unknown attribute */
         else
             msg_Warn( p_demux, "invalid <playlist> attribute:\"%s\"", psz_name);
@@ -473,11 +479,29 @@ static vlc_bool_t parse_track_node COMPLEX_INTERFACE
                 if( !strcmp( psz_name, psz_element ) )
                 {
                     FREE_ATT();
-                    /* Add it */
-                    playlist_AddWhereverNeeded( p_playlist, p_new_input,
-                              p_item, p_demux->p_sys->p_item_in_category,
-                              (p_demux->p_sys->i_parent_id >0 ) ? VLC_TRUE:
-                              VLC_FALSE, PLAYLIST_APPEND );
+                    playlist_BothAddInput( p_playlist, p_new_input,
+                                           p_demux->p_sys->p_item_in_category,
+                                           PLAYLIST_APPEND | PLAYLIST_SPREPARSE,
+                                           PLAYLIST_END );
+                    if( p_demux->p_sys->i_identifier <
+                        p_demux->p_sys->i_tracklist_entries )
+                    {
+                        p_demux->p_sys->pp_tracklist[
+                            p_demux->p_sys->i_identifier ] = p_new_input;
+                    }
+                    else
+                    {
+                        if( p_demux->p_sys->i_identifier >
+                            p_demux->p_sys->i_tracklist_entries )
+                        {
+                            p_demux->p_sys->i_tracklist_entries =
+                                p_demux->p_sys->i_identifier;
+                        }
+                        INSERT_ELEM( p_demux->p_sys->pp_tracklist,
+                                     p_demux->p_sys->i_tracklist_entries,
+                                     p_demux->p_sys->i_tracklist_entries,
+                                     p_new_input );
+                    }
                     return VLC_TRUE;
                 }
                 /* there MUST have been a start tag for that element name */
@@ -502,15 +526,31 @@ static vlc_bool_t parse_track_node COMPLEX_INTERFACE
                         FREE_ATT();
                         return VLC_FALSE;
                     }
-                    psz_uri = unescape_URI_duplicate( psz_value );
+                    psz_uri = decode_URI_duplicate( psz_value );
 
                     if( psz_uri )
                     {
+                        if( p_demux->p_sys->psz_base && 
+                            !strstr( psz_uri, "://" ) )
+                        {
+                           char* psz_tmp = malloc( 
+                                   strlen(p_demux->p_sys->psz_base) + 
+                                   strlen(psz_uri) +1 );
+                           if( !psz_tmp )
+                           {
+                               msg_Err( p_demux, "out of memory");
+                               return VLC_FALSE;
+                           }
+                           sprintf( psz_tmp, "%s%s", 
+                                    p_demux->p_sys->psz_base, psz_uri );
+                           free( psz_uri );
+                           psz_uri = psz_tmp;
+                        }
                         p_new_input = input_ItemNewExt( p_playlist, psz_uri,
                                                         NULL, 0, NULL, -1 );
                         p_new_input->p_meta = vlc_meta_New();
                         free( psz_uri );
-                        vlc_input_item_CopyOptions( p_item->p_input, p_new_input );
+                        input_ItemCopyOptions( p_item->p_input, p_new_input );
                         psz_uri = NULL;
                         FREE_ATT();
                         p_handler = NULL;
@@ -521,6 +561,10 @@ static vlc_bool_t parse_track_node COMPLEX_INTERFACE
                         return VLC_FALSE;
                     }
                 }
+                else if( !strcmp( p_handler->name, "identifier" ) )
+                {
+                    p_demux->p_sys->i_identifier = atoi( psz_value );
+                }
                 else
                 {
                     /* there MUST be an item */
@@ -533,7 +577,7 @@ static vlc_bool_t parse_track_node COMPLEX_INTERFACE
                     }
                     if( p_handler->pf_handler.smpl )
                     {
-                        p_handler->pf_handler.smpl( NULL, p_input,
+                        p_handler->pf_handler.smpl( NULL, p_new_input,
                                                     p_handler->name,
                                                     psz_value );
                         FREE_ATT();
@@ -565,6 +609,7 @@ static vlc_bool_t set_item_info SIMPLE_INTERFACE
     if( !psz_name || !psz_value || !p_input )
         return VLC_FALSE;
 
+
     /* re-convert xml special characters inside psz_value */
     resolve_xml_special_chars( psz_value );
 
@@ -584,7 +629,7 @@ static vlc_bool_t set_item_info SIMPLE_INTERFACE
     }
     else if( !strcmp( psz_name, "trackNum" ) )
     {
-        vlc_meta_SetTracknum( p_input->p_meta, psz_value );    
+        vlc_meta_SetTracknum( p_input->p_meta, psz_value );
     }
     else if( !strcmp( psz_name, "duration" ) )
     {
@@ -594,6 +639,207 @@ static vlc_bool_t set_item_info SIMPLE_INTERFACE
     return VLC_TRUE;
 }
 
+
+/**
+ * \brief parse the extension node of a XSPF playlist
+ */
+static vlc_bool_t parse_extension_node COMPLEX_INTERFACE
+{
+    char *psz_name = NULL;
+    char *psz_value = NULL;
+    char *psz_title = NULL;
+    int i_node;
+    xml_elem_hnd_t *p_handler = NULL;
+
+    xml_elem_hnd_t pl_elements[] =
+        { {"node",  COMPLEX_CONTENT, {.cmplx = parse_extension_node} },
+          {"item",  COMPLEX_CONTENT, {.cmplx = parse_extitem_node} },
+          {NULL,    UNKNOWN_CONTENT, {NULL} }
+        };
+
+    /* read all extension node attributes */
+    while( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
+    {
+        psz_name = xml_ReaderName( p_xml_reader );
+        psz_value = xml_ReaderValue( p_xml_reader );
+        if( !psz_name || !psz_value )
+        {
+            msg_Err( p_demux, "invalid xml stream @ <node>" );
+            FREE_ATT();
+            return VLC_FALSE;
+        }
+        /* attribute: title */
+        if( !strcmp( psz_name, "title" ) )
+        {
+            psz_title = unescape_URI_duplicate( psz_value );
+        }
+        /* unknown attribute */
+        else
+            msg_Warn( p_demux, "invalid <node> attribute:\"%s\"", psz_name);
+
+        FREE_ATT();
+    }
+
+    /* attribute title is mandatory except for <extension> */
+    if( !strcmp( psz_element, "node" ) && !psz_title )
+    {
+        msg_Warn( p_demux, "<node> requires \"title\" attribute" );
+        return VLC_FALSE;
+    }
+    if( psz_title ) free( psz_title );
+
+    /* parse the child elements */
+    while( xml_ReaderRead( p_xml_reader ) == 1 )
+    {
+        i_node = xml_ReaderNodeType( p_xml_reader );
+        switch( i_node )
+        {
+            case XML_READER_NONE:
+                break;
+            case XML_READER_STARTELEM:
+                /*  element start tag  */
+                psz_name = xml_ReaderName( p_xml_reader );
+                if( !psz_name || !*psz_name )
+                {
+                    msg_Err( p_demux, "invalid xml stream" );
+                    FREE_ATT();
+                    return VLC_FALSE;
+                }
+                /* choose handler */
+                for( p_handler = pl_elements;
+                     p_handler->name && strcmp( psz_name, p_handler->name );
+                     p_handler++ );
+                if( !p_handler->name )
+                {
+                    msg_Err( p_demux, "unexpected element <%s>", psz_name );
+                    FREE_ATT();
+                    return VLC_FALSE;
+                }
+                FREE_NAME();
+                /* complex content is parsed in a separate function */
+                if( p_handler->type == COMPLEX_CONTENT )
+                {
+                    if( p_handler->pf_handler.cmplx( p_demux,
+                                                     p_playlist,
+                                                     p_item, NULL,
+                                                     p_xml_reader,
+                                                     p_handler->name ) )
+                    {
+                        p_handler = NULL;
+                        FREE_ATT();
+                    }
+                    else
+                    {
+                        FREE_ATT();
+                        return VLC_FALSE;
+                    }
+                }
+                break;
+
+            case XML_READER_TEXT:
+                /* simple element content */
+                FREE_ATT();
+                psz_value = xml_ReaderValue( p_xml_reader );
+                if( !psz_value )
+                {
+                    msg_Err( p_demux, "invalid xml stream" );
+                    FREE_ATT();
+                    return VLC_FALSE;
+                }
+                break;
+
+            case XML_READER_ENDELEM:
+                /* element end tag */
+                psz_name = xml_ReaderName( p_xml_reader );
+                if( !psz_name )
+                {
+                    msg_Err( p_demux, "invalid xml stream" );
+                    FREE_ATT();
+                    return VLC_FALSE;
+                }
+                /* leave if the current parent node is terminated */
+                if( !strcmp( psz_name, psz_element ) )
+                {
+                    FREE_ATT();
+                    return VLC_TRUE;
+                }
+                /* there MUST have been a start tag for that element name */
+                if( !p_handler || !p_handler->name
+                    || strcmp( p_handler->name, psz_name ))
+                {
+                    msg_Err( p_demux, "there's no open element left for <%s>",
+                             psz_name );
+                    FREE_ATT();
+                    return VLC_FALSE;
+                }
+
+                if( p_handler->pf_handler.smpl )
+                {
+                    p_handler->pf_handler.smpl( p_item, NULL, p_handler->name,
+                                                psz_value );
+                }
+                FREE_ATT();
+                p_handler = NULL;
+                break;
+
+            default:
+                /* unknown/unexpected xml node */
+                msg_Err( p_demux, "unexpected xml node %i", i_node );
+                FREE_ATT();
+                return VLC_FALSE;
+        }
+        FREE_NAME();
+    }
+    return VLC_FALSE;
+}
+
+/**
+ * \brief parse the extension item node of a XSPF playlist
+ */
+static vlc_bool_t parse_extitem_node COMPLEX_INTERFACE
+{
+    char *psz_name = NULL;
+    char *psz_value = NULL;
+    int i_href = -1;
+
+    /* read all extension item attributes */
+    while( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
+    {
+        psz_name = xml_ReaderName( p_xml_reader );
+        psz_value = xml_ReaderValue( p_xml_reader );
+        if( !psz_name || !psz_value )
+        {
+            msg_Err( p_demux, "invalid xml stream @ <item>" );
+            FREE_ATT();
+            return VLC_FALSE;
+        }
+        /* attribute: href */
+        if( !strcmp( psz_name, "href" ) )
+        {
+            i_href = atoi( psz_value );
+        }
+        /* unknown attribute */
+        else
+            msg_Warn( p_demux, "invalid <item> attribute:\"%s\"", psz_name);
+
+        FREE_ATT();
+    }
+
+    /* attribute href is mandatory */
+    if( i_href < 0 )
+    {
+        msg_Warn( p_demux, "<item> requires \"href\" attribute" );
+        return VLC_FALSE;
+    }
+
+    if( i_href > p_demux->p_sys->i_tracklist_entries )
+    {
+        msg_Warn( p_demux, "invalid \"href\" attribute" );
+        return VLC_FALSE;
+    }
+    return VLC_TRUE;
+}
+
 /**
  * \brief skips complex element content that we can't manage
  */