]> git.sesse.net Git - vlc/blobdiff - modules/demux/playlist/itml.c
XML: simplify demuxers
[vlc] / modules / demux / playlist / itml.c
index 39b31a136a3b1434fd2b4d396f0ea2b3f9e31e8e..bc37dd6a8b6bf055eab283d14a81b87d6e604482 100644 (file)
@@ -2,7 +2,7 @@
  * itml.c : iTunes Music Library import functions
  *******************************************************************************
  * Copyright (C) 2007 the VideoLAN team
- * $Id$
+ * $Id$
  *
  * Authors: Yoann Peronneau <yoann@videolan.org>
  *
  * \brief iTunes Music Library import functions
  */
 
-#include <vlc/vlc.h>
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <vlc_common.h>
 #include <vlc_demux.h>
+#include <vlc_xml.h>
+#include <vlc_strings.h>
+#include <vlc_url.h>
 
-#include "playlist.h"
-#include "vlc_xml.h"
-#include "vlc_strings.h"
-#include "vlc_url.h"
 #include "itml.h"
+#include "playlist.h"
 
 struct demux_sys_t
 {
@@ -45,14 +49,14 @@ static int Demux( demux_t * );
 /**
  * \brief iTML submodule initialization function
  */
-int E_(Import_iTML)( vlc_object_t *p_this )
+int Import_iTML( vlc_object_t *p_this )
 {
     DEMUX_BY_EXTENSION_OR_FORCED_MSG( ".xml", "itml",
                                       "using iTunes Media Library reader" );
     return VLC_SUCCESS;
 }
 
-void E_(Close_iTML)( vlc_object_t *p_this )
+void Close_iTML( vlc_object_t *p_this )
 {
     demux_t *p_demux = (demux_t *)p_this;
     free( p_demux->p_sys );
@@ -63,80 +67,72 @@ void E_(Close_iTML)( vlc_object_t *p_this )
  */
 int Demux( demux_t *p_demux )
 {
-    int i_ret = VLC_SUCCESS;
-    xml_t *p_xml = NULL;
-    xml_reader_t *p_xml_reader = NULL;
+    xml_reader_t *p_xml_reader;
     char *psz_name = NULL;
-    INIT_PLAYLIST_STUFF;
+
+    input_item_t *p_current_input = GetCurrentItem(p_demux);
     p_demux->p_sys->i_ntracks = 0;
 
     /* create new xml parser from stream */
-    p_xml = xml_Create( p_demux );
-    if( !p_xml )
-        i_ret = VLC_ENOMOD;
-    else
-    {
-        p_xml_reader = xml_ReaderCreate( p_xml, p_demux->s );
-        if( !p_xml_reader )
-            i_ret = VLC_EGENERIC;
-    }
+    p_xml_reader = xml_ReaderCreate( p_demux, p_demux->s );
+    if( !p_xml_reader )
+        goto end;
 
     /* locating the root node */
-    if( i_ret == VLC_SUCCESS )
+    do
     {
-        do
+        if( xml_ReaderRead( p_xml_reader ) != 1 )
         {
-            if( xml_ReaderRead( p_xml_reader ) != 1 )
-            {
-                msg_Err( p_demux, "can't read xml stream" );
-                i_ret = VLC_EGENERIC;
-            }
-        } while( i_ret == VLC_SUCCESS &&
-                 xml_ReaderNodeType( p_xml_reader ) != XML_READER_STARTELEM );
-    }
-    /* checking root node name */
-    if( i_ret == VLC_SUCCESS )
-    {
-        psz_name = xml_ReaderName( p_xml_reader );
-        if( !psz_name || strcmp( psz_name, "plist" ) )
-        {
-            msg_Err( p_demux, "invalid root node name: %s", psz_name );
-            i_ret = VLC_EGENERIC;
+            msg_Err( p_demux, "can't read xml stream" );
+            goto end;
         }
-        FREE_NAME();
-    }
+    } while( xml_ReaderNodeType( p_xml_reader ) != XML_READER_STARTELEM );
 
-    if( i_ret == VLC_SUCCESS )
+    /* checking root node name */
+    psz_name = xml_ReaderName( p_xml_reader );
+    if( !psz_name || strcmp( psz_name, "plist" ) )
     {
-        xml_elem_hnd_t pl_elements[] =
-            { {"dict",    COMPLEX_CONTENT, {.cmplx = parse_plist_dict} } };
-        i_ret = parse_plist_node( p_demux, p_playlist, p_current_input,
-                                     NULL, p_xml_reader, "plist",
-                                     pl_elements );
-        HANDLE_PLAY_AND_RELEASE;
+        msg_Err( p_demux, "invalid root node name: %s", psz_name );
+        goto end;
     }
 
+    input_item_node_t *p_subitems = input_item_node_Create( p_current_input );
+    xml_elem_hnd_t pl_elements[] =
+        { {"dict",    COMPLEX_CONTENT, {.cmplx = parse_plist_dict} } };
+    parse_plist_node( p_demux, p_subitems, NULL, p_xml_reader, "plist",
+                      pl_elements );
+    input_item_node_PostAndDelete( p_subitems );
+
+    vlc_gc_decref(p_current_input);
+
+end:
+    free( psz_name );
     if( p_xml_reader )
-        xml_ReaderDelete( p_xml, p_xml_reader );
-    if( p_xml )
-        xml_Delete( p_xml );
-    return -1; /* Needed for correct operation of go back */
+        xml_ReaderDelete( p_xml_reader );
+
+    /* Needed for correct operation of go back */
+    return 0;
 }
 
 /** \brief dummy function for demux callback interface */
 static int Control( demux_t *p_demux, int i_query, va_list args )
 {
+    VLC_UNUSED(p_demux); VLC_UNUSED(i_query); VLC_UNUSED(args);
     return VLC_EGENERIC;
 }
 
 /**
  * \brief parse the root node of the playlist
  */
-static vlc_bool_t parse_plist_node COMPLEX_INTERFACE
+static bool parse_plist_node( demux_t *p_demux, input_item_node_t *p_input_node,
+                              track_elem_t *p_track, xml_reader_t *p_xml_reader,
+                              const char *psz_element,
+                              xml_elem_hnd_t *p_handlers )
 {
-    char *psz_name = NULL;
-    char *psz_value = NULL;
-    vlc_bool_t b_version_found = VLC_FALSE;
+    VLC_UNUSED(p_track); VLC_UNUSED(psz_element);
+    char *psz_name;
+    char *psz_value;
+    bool b_version_found = false;
 
     /* read all playlist attributes */
     while( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
@@ -146,13 +142,14 @@ static vlc_bool_t parse_plist_node COMPLEX_INTERFACE
         if( !psz_name || !psz_value )
         {
             msg_Err( p_demux, "invalid xml stream @ <plist>" );
-            FREE_ATT();
-            return VLC_FALSE;
+            free( psz_name );
+            free( psz_value );
+            return false;
         }
         /* attribute: version */
         if( !strcmp( psz_name, "version" ) )
         {
-            b_version_found = VLC_TRUE;
+            b_version_found = true;
             if( strcmp( psz_value, "1.0" ) )
                 msg_Warn( p_demux, "unsupported iTunes Media Library version" );
         }
@@ -160,13 +157,15 @@ static vlc_bool_t parse_plist_node COMPLEX_INTERFACE
         else
             msg_Warn( p_demux, "invalid <plist> attribute:\"%s\"", psz_name);
 
-        FREE_ATT();
+        free( psz_name );
+        free( psz_value );
     }
+
     /* attribute version is mandatory !!! */
     if( !b_version_found )
         msg_Warn( p_demux, "<plist> requires \"version\" attribute" );
 
-    return parse_dict( p_demux, p_playlist, p_input_item, NULL, p_xml_reader,
+    return parse_dict( p_demux, p_input_node, NULL, p_xml_reader,
                        "plist", p_handlers );
 }
 
@@ -174,129 +173,128 @@ static vlc_bool_t parse_plist_node COMPLEX_INTERFACE
  * \brief parse a <dict>
  * \param COMPLEX_INTERFACE
  */
-static vlc_bool_t parse_dict COMPLEX_INTERFACE
+static bool parse_dict( demux_t *p_demux, input_item_node_t *p_input_node,
+                        track_elem_t *p_track, xml_reader_t *p_xml_reader,
+                        const char *psz_element, xml_elem_hnd_t *p_handlers )
 {
     int i_node;
     char *psz_name = NULL;
     char *psz_value = NULL;
     char *psz_key = NULL;
     xml_elem_hnd_t *p_handler = NULL;
+    bool b_ret = false;
 
     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_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_KEY();
-                    return VLC_FALSE;
-                }
-                /* choose handler */
-                for( p_handler = p_handlers;
+        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" );
+                goto end;
+            }
+            /* choose handler */
+            for( p_handler = p_handlers;
                      p_handler->name && strcmp( psz_name, p_handler->name );
                      p_handler++ );
-                if( !p_handler->name )
+            if( !p_handler->name )
+            {
+                msg_Err( p_demux, "unexpected element <%s>", psz_name );
+                goto end;
+            }
+            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_input_node, NULL,
+                                                 p_xml_reader, p_handler->name,
+                                                 NULL ) )
                 {
-                    msg_Err( p_demux, "unexpected element <%s>", psz_name );
+                    p_handler = NULL;
                     FREE_ATT_KEY();
-                    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_input_item,
-                                                     NULL,
-                                                     p_xml_reader,
-                                                     p_handler->name,
-                                                     NULL ) )
-                    {
-                        p_handler = NULL;
-                        FREE_ATT_KEY();
-                    }
-                    else
-                    {
-                        FREE_ATT_KEY();
-                        return VLC_FALSE;
-                    }
                 }
-                break;
+                else
+                    goto end;
+            }
+            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_KEY();
-                    return VLC_FALSE;
-                }
-                break;
+        case XML_READER_TEXT:
+            /* simple element content */
+            free( psz_value );
+            psz_value = xml_ReaderValue( p_xml_reader );
+            if( !psz_value )
+            {
+                msg_Err( p_demux, "invalid xml stream" );
+                goto end;
+            }
+            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_KEY();
-                    return VLC_FALSE;
-                }
-                /* leave if the current parent node <track> is terminated */
-                if( !strcmp( psz_name, psz_element ) )
-                {
-                    FREE_ATT_KEY();
-                    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_KEY();
-                    return VLC_FALSE;
-                }
-                /* special case: key */
-                if( !strcmp( p_handler->name, "key" ) )
-                {
-                    psz_key = strdup( psz_value );
-                }
-                /* call the simple handler */
-                else if( p_handler->pf_handler.smpl )
-                {
-                    p_handler->pf_handler.smpl( p_track, psz_key, 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_KEY();
-                return VLC_FALSE;
+        case XML_READER_ENDELEM:
+            /* element end tag */
+            psz_name = xml_ReaderName( p_xml_reader );
+            if( !psz_name )
+            {
+                msg_Err( p_demux, "invalid xml stream" );
+                goto end;
+            }
+            /* leave if the current parent node <track> is terminated */
+            if( !strcmp( psz_name, psz_element ) )
+            {
+                b_ret = true;
+                goto end;
+            }
+            /* 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 );
+                goto end;
+            }
+            /* special case: key */
+            if( !strcmp( p_handler->name, "key" ) )
+            {
+                free( psz_key );
+                psz_key = strdup( psz_value );
+            }
+            /* call the simple handler */
+            else if( p_handler->pf_handler.smpl )
+            {
+                p_handler->pf_handler.smpl( p_track, psz_key, psz_value );
+            }
+            FREE_ATT();
+            p_handler = NULL;
+            break;
+
+        default:
+            /* unknown/unexpected xml node */
+            msg_Err( p_demux, "unexpected xml node %i", i_node );
+            goto end;
         }
         FREE_NAME();
     }
     msg_Err( p_demux, "unexpected end of xml data" );
-    FREE_ATT_KEY();
-    return VLC_FALSE;
+
+end:
+    free( psz_name );
+    free( psz_value );
+    free( psz_key );
+    return b_ret;
 }
 
-static vlc_bool_t parse_plist_dict COMPLEX_INTERFACE
+static bool parse_plist_dict( demux_t *p_demux, input_item_node_t *p_input_node,
+                              track_elem_t *p_track, xml_reader_t *p_xml_reader,
+                              const char *psz_element,
+                              xml_elem_hnd_t *p_handlers )
 {
+    VLC_UNUSED(p_track); VLC_UNUSED(psz_element); VLC_UNUSED(p_handlers);
     xml_elem_hnd_t pl_elements[] =
         { {"dict",    COMPLEX_CONTENT, {.cmplx = parse_tracks_dict} },
           {"array",   SIMPLE_CONTENT,  {NULL} },
@@ -309,32 +307,39 @@ static vlc_bool_t parse_plist_dict COMPLEX_INTERFACE
           {NULL,      UNKNOWN_CONTENT, {NULL} }
         };
 
-    return parse_dict( p_demux, p_playlist, p_input_item, NULL, p_xml_reader,
+    return parse_dict( p_demux, p_input_node, NULL, p_xml_reader,
                        "dict", pl_elements );
 }
 
-static vlc_bool_t parse_tracks_dict COMPLEX_INTERFACE
+static bool parse_tracks_dict( demux_t *p_demux, input_item_node_t *p_input_node,
+                               track_elem_t *p_track, xml_reader_t *p_xml_reader,
+                               const char *psz_element,
+                               xml_elem_hnd_t *p_handlers )
 {
+    VLC_UNUSED(p_track); VLC_UNUSED(psz_element); VLC_UNUSED(p_handlers);
     xml_elem_hnd_t tracks_elements[] =
         { {"dict",    COMPLEX_CONTENT, {.cmplx = parse_track_dict} },
           {"key",     SIMPLE_CONTENT,  {NULL} },
           {NULL,      UNKNOWN_CONTENT, {NULL} }
         };
 
-    parse_dict( p_demux, p_playlist, p_input_item, NULL, p_xml_reader,
+    parse_dict( p_demux, p_input_node, NULL, p_xml_reader,
                 "dict", tracks_elements );
 
     msg_Info( p_demux, "added %i tracks successfully",
               p_demux->p_sys->i_ntracks );
 
-    return VLC_TRUE;
+    return true;
 }
 
-static vlc_bool_t parse_track_dict COMPLEX_INTERFACE
+static bool parse_track_dict( demux_t *p_demux, input_item_node_t *p_input_node,
+                              track_elem_t *p_track, xml_reader_t *p_xml_reader,
+                              const char *psz_element,
+                              xml_elem_hnd_t *p_handlers )
 {
+    VLC_UNUSED(psz_element); VLC_UNUSED(p_handlers);
     input_item_t *p_new_input = NULL;
-    int i_ret = -1;
-    char *psz_uri = NULL;
+    int i_ret;
     p_track = new_track();
 
     xml_elem_hnd_t track_elements[] =
@@ -348,7 +353,7 @@ static vlc_bool_t parse_track_dict COMPLEX_INTERFACE
           {NULL,      UNKNOWN_CONTENT, {NULL} }
         };
 
-    i_ret = parse_dict( p_demux, p_playlist, p_input_item, p_track,
+    i_ret = parse_dict( p_demux, p_input_node, p_track,
                         p_xml_reader, "dict", track_elements );
 
     msg_Dbg( p_demux, "name: %s, artist: %s, album: %s, genre: %s, trackNum: %s, location: %s",
@@ -358,35 +363,18 @@ static vlc_bool_t parse_track_dict COMPLEX_INTERFACE
     {
         msg_Err( p_demux, "Track needs Location" );
         free_track( p_track );
-        return VLC_FALSE;
+        return false;
     }
 
-    psz_uri = decode_URI_duplicate( p_track->location );
+    msg_Info( p_demux, "Adding '%s'", p_track->location );
+    p_new_input = input_item_New( p_demux, p_track->location, NULL );
+    input_item_node_AppendItem( p_input_node, p_new_input );
 
-    if( psz_uri )
-    {
-        if( strlen( psz_uri ) > 17 &&
-            !strncmp( psz_uri, "file://localhost/", 17 ) )
-        {
-            /* remove 'localhost/' */
-            strcpy( psz_uri + 7, psz_uri + 17 );
-            msg_Info( p_demux, "Adding '%s'", psz_uri );
-
-            p_new_input = input_ItemNewExt( p_playlist, psz_uri,
-                                            NULL, 0, NULL, -1 );
-            input_ItemAddSubItem( p_input_item, p_new_input );
+    /* add meta info */
+    add_meta( p_new_input, p_track );
+    vlc_gc_decref( p_new_input );
 
-            /* add meta info */
-            add_meta( p_new_input, p_track );
-
-            p_demux->p_sys->i_ntracks++;
-        }
-        else
-        {
-            msg_Err( p_demux, "Don't know how to handle %s", psz_uri );
-        }
-        free( psz_uri );
-    }
+    p_demux->p_sys->i_ntracks++;
 
     free_track( p_track );
     return i_ret;
@@ -394,8 +382,8 @@ static vlc_bool_t parse_track_dict COMPLEX_INTERFACE
 
 static track_elem_t *new_track()
 {
-    track_elem_t *p_track = NULL;
-    p_track = (track_elem_t *)malloc( sizeof( track_elem_t ) );
+    track_elem_t *p_track;
+    p_track = malloc( sizeof( track_elem_t ) );
     if( p_track )
     {
         p_track->name = NULL;
@@ -415,21 +403,22 @@ static void free_track( track_elem_t *p_track )
     if ( !p_track )
         return;
 
-    FREE( p_track->name )
-    FREE( p_track->artist )
-    FREE( p_track->album )
-    FREE( p_track->genre )
-    FREE( p_track->trackNum )
-    FREE( p_track->location )
+    FREENULL( p_track->name );
+    FREENULL( p_track->artist );
+    FREENULL( p_track->album );
+    FREENULL( p_track->genre );
+    FREENULL( p_track->trackNum );
+    FREENULL( p_track->location );
     p_track->duration = 0;
     free( p_track );
 }
 
-static vlc_bool_t save_data SIMPLE_INTERFACE
+static bool save_data( track_elem_t *p_track, const char *psz_name,
+                       char *psz_value)
 {
     /* exit if setting is impossible */
     if( !psz_name || !psz_value || !p_track )
-        return VLC_FALSE;
+        return false;
 
     /* re-convert xml special characters inside psz_value */
     resolve_xml_special_chars( psz_value );
@@ -448,36 +437,40 @@ static vlc_bool_t save_data SIMPLE_INTERFACE
         long i_num = atol( psz_value );
         p_track->duration = (mtime_t) i_num*1000;
     }
-    return VLC_TRUE;
+#undef SAVE_INFO
+    return true;
 }
 
 /**
  * \brief handles the supported <track> sub-elements
  */
-static vlc_bool_t add_meta( input_item_t *p_input_item,
-                            track_elem_t *p_track )
+static bool add_meta( input_item_t *p_input_item, track_elem_t *p_track )
 {
     /* exit if setting is impossible */
     if( !p_input_item || !p_track )
-        return VLC_FALSE;
-
-#define SET_INFO( func, prop ) \
-    if( p_track->prop ) { func( p_input_item, p_track->prop ); }
-
-    SET_INFO( input_item_SetTitle, name )
-    SET_INFO( input_item_SetArtist, artist )
-    SET_INFO( input_item_SetAlbum, album )
-    SET_INFO( input_item_SetGenre, genre )
-    SET_INFO( input_item_SetTrackNum, trackNum )
-    SET_INFO( input_item_SetDuration, duration )
-    return VLC_TRUE;
+        return false;
+
+#define SET_INFO( type, prop ) \
+    if( p_track->prop ) {input_item_Set##type( p_input_item, p_track->prop );}
+    SET_INFO( Title, name )
+    SET_INFO( Artist, artist )
+    SET_INFO( Album, album )
+    SET_INFO( Genre, genre )
+    SET_INFO( TrackNum, trackNum )
+    SET_INFO( Duration, duration )
+#undef SET_INFO
+    return true;
 }
 
 /**
  * \brief skips complex element content that we can't manage
  */
-static vlc_bool_t skip_element COMPLEX_INTERFACE
+static bool skip_element( demux_t *p_demux, input_item_node_t *p_input_node,
+                          track_elem_t *p_track, xml_reader_t *p_xml_reader,
+                          const char *psz_element, xml_elem_hnd_t *p_handlers )
 {
+    VLC_UNUSED(p_demux); VLC_UNUSED(p_input_node);
+    VLC_UNUSED(p_track); VLC_UNUSED(p_handlers);
     char *psz_endname;
 
     while( xml_ReaderRead( p_xml_reader ) == 1 )
@@ -486,15 +479,15 @@ static vlc_bool_t skip_element COMPLEX_INTERFACE
         {
             psz_endname = xml_ReaderName( p_xml_reader );
             if( !psz_endname )
-                return VLC_FALSE;
+                return false;
             if( !strcmp( psz_element, psz_endname ) )
             {
                 free( psz_endname );
-                return VLC_TRUE;
+                return true;
             }
             else
                 free( psz_endname );
         }
     }
-    return VLC_FALSE;
+    return false;
 }