field order normalisation fix, add .vob to fezzik, field order detection for avformat
[melted] / src / modules / westley / producer_westley.c
index 4ddc892..ff1649d 100644 (file)
 
 // TODO: destroy unreferenced producers (they are currently destroyed
 //       when the returned producer is closed).
-// TODO: determine why deserialise_context can not be released.
 
 #include "producer_westley.h"
 #include <framework/mlt.h>
 #include <stdlib.h>
 #include <string.h>
 #include <stdio.h>
+#include <ctype.h>
 
 #include <libxml/parser.h>
 #include <libxml/parserInternals.h> // for xmlCreateFileParserCtxt
@@ -53,8 +53,12 @@ struct deserialise_context_s
        xmlNodePtr stack_node[ STACK_SIZE ];
        int stack_node_size;
        xmlDocPtr entity_doc;
+       int entity_is_replace;
        int depth;
        int branch[ STACK_SIZE ];
+       const xmlChar *publicId;
+       const xmlChar *systemId;
+       mlt_properties params;
 };
 typedef struct deserialise_context_s *deserialise_context;
 
@@ -137,6 +141,33 @@ static void track_service( mlt_properties properties, void *service, mlt_destruc
 }
 
 
+// Prepend the property value with the document root
+static inline void qualify_property( deserialise_context context, mlt_properties properties, char *name )
+{
+       char *resource = mlt_properties_get( properties, name );
+       if ( resource != NULL )
+       {
+               // Qualify file name properties 
+               char *root = mlt_properties_get( context->producer_map, "_root" );
+               if ( root != NULL )
+               {
+                       char *full_resource = malloc( strlen( root ) + strlen( resource ) + 1 );
+                       if ( resource[ 0 ] != '/' )
+                       {
+                               strcpy( full_resource, root );
+                               strcat( full_resource, resource );
+                       }
+                       else
+                       {
+                               strcpy( full_resource, resource );
+                       }
+                       mlt_properties_set( properties, name, full_resource );
+                       free( full_resource );
+               }
+       }
+}
+
+
 // Forward declarations
 static void on_end_track( deserialise_context context, const xmlChar *name );
 static void on_end_entry( deserialise_context context, const xmlChar *name );
@@ -634,32 +665,32 @@ static void on_end_producer( deserialise_context context, const xmlChar *name )
        if ( properties == NULL )
                return;
                
+       qualify_property( context, properties, "resource" );
        char *resource = mlt_properties_get( properties, "resource" );
        // Let Kino-SMIL src be a synonym for resource
        if ( resource == NULL )
+       {
+               qualify_property( context, properties, "src" );
                resource = mlt_properties_get( properties, "src" );
-       
+       }
+
        // Instantiate the producer
        if ( mlt_properties_get( properties, "mlt_service" ) != NULL )
        {
-               service = MLT_SERVICE( mlt_factory_producer( "fezzik", mlt_properties_get( properties, "mlt_service" ) ) );
+               char temp[ 1024 ];
+               strncpy( temp, mlt_properties_get( properties, "mlt_service" ), 1024 );
+               if ( resource != NULL )
+               {
+                       strcat( temp, ":" );
+                       strncat( temp, resource, 1023 - strlen( temp ) );
+               }
+               service = MLT_SERVICE( mlt_factory_producer( "fezzik", temp ) );
        }
        if ( service == NULL && resource != NULL )
        {
-               char *root = mlt_properties_get( context->producer_map, "_root" );
-               char *full_resource = malloc( strlen( root ) + strlen( resource ) + 1 );
-               if ( resource[ 0 ] != '/' )
-               {
-                       strcpy( full_resource, root );
-                       strcat( full_resource, resource );
-               }
-               else
-               {
-                       strcpy( full_resource, resource );
-               }
-               service = MLT_SERVICE( mlt_factory_producer( "fezzik", full_resource ) );
-               free( full_resource );
+               service = MLT_SERVICE( mlt_factory_producer( "fezzik", resource ) );
        }
+       
        if ( service == NULL )
                return;
        track_service( context->destructors, service, (mlt_destructor) mlt_producer_close );
@@ -782,6 +813,11 @@ static void on_end_filter( deserialise_context context, const xmlChar *name )
                mlt_properties_set_position( properties, "out", mlt_producer_get_out( MLT_PRODUCER( producer ) ) );
 
        // Propogate the properties
+       qualify_property( context, properties, "resource" );
+       qualify_property( context, properties, "luma" );
+       qualify_property( context, properties, "luma.resource" );
+       qualify_property( context, properties, "composite.luma" );
+       qualify_property( context, properties, "producer.resource" );
        mlt_properties_inherit( mlt_service_properties( service ), properties );
        mlt_properties_close( properties );
        context->producer_properties = NULL;
@@ -850,6 +886,11 @@ static void on_end_transition( deserialise_context context, const xmlChar *name
        track_service( context->destructors, service, (mlt_destructor) mlt_transition_close );
 
        // Propogate the properties
+       qualify_property( context, properties, "resource" );
+       qualify_property( context, properties, "luma" );
+       qualify_property( context, properties, "luma.resource" );
+       qualify_property( context, properties, "composite.luma" );
+       qualify_property( context, properties, "producer.resource" );
        mlt_properties_inherit( mlt_service_properties( service ), properties );
        mlt_properties_close( properties );
        context->producer_properties = NULL;
@@ -968,16 +1009,56 @@ static void on_characters( void *ctx, const xmlChar *ch, int len )
 
        value[ len ] = 0;
        strncpy( value, (const char*) ch, len );
-       
+
        if ( context->stack_node_size > 0 )
                xmlNodeAddContent( context->stack_node[ context->stack_node_size - 1 ], ( xmlChar* )value );
 
-       else if ( context->property != NULL && context->producer_properties != NULL )
-               mlt_properties_set( context->producer_properties, context->property, value );
+       // libxml2 generates an on_characters immediately after a get_entity within
+       // an element value, and we ignore it because it is called again during
+       // actual substitution.
+       else if ( context->property != NULL && context->producer_properties != NULL
+               && context->entity_is_replace == 0 )
+       {
+               char *s = mlt_properties_get( context->producer_properties, context->property );
+               if ( s != NULL )
+               {
+                       // Append new text to existing content
+                       char *new = calloc( strlen( s ) + len + 1, 1 );
+                       strcat( new, s );
+                       strcat( new, value );
+                       mlt_properties_set( context->producer_properties, context->property, new );
+                       free( new );
+               }
+               else
+                       mlt_properties_set( context->producer_properties, context->property, value );
+       }
+       context->entity_is_replace = 0;
                
        free( value);
 }
 
+/** Convert parameters parsed from resource into entity declarations.
+*/
+static void params_to_entities( deserialise_context context )
+{
+       if ( context->params != NULL )
+       {       
+               int i;
+               
+               // Add our params as entitiy declarations
+               for ( i = 0; i < mlt_properties_count( context->params ); i++ )
+               {
+                       xmlChar *name = ( xmlChar* )mlt_properties_get_name( context->params, i );
+                       xmlAddDocEntity( context->entity_doc, name, XML_INTERNAL_GENERAL_ENTITY,
+                               context->publicId, context->systemId, ( xmlChar* )mlt_properties_get( context->params, name ) );
+               }
+
+               // Flag completion
+               mlt_properties_close( context->params );
+               context->params = NULL;
+       }
+}
+
 // The following 3 facilitate entity substitution in the SAX parser
 static void on_internal_subset( void *ctx, const xmlChar* name,
        const xmlChar* publicId, const xmlChar* systemId )
@@ -985,7 +1066,12 @@ static void on_internal_subset( void *ctx, const xmlChar* name,
        struct _xmlParserCtxt *xmlcontext = ( struct _xmlParserCtxt* )ctx;
        deserialise_context context = ( deserialise_context )( xmlcontext->_private );
        
+       context->publicId = publicId;
+       context->systemId = systemId;
        xmlCreateIntSubset( context->entity_doc, name, publicId, systemId );
+       
+       // Override default entities with our parameters
+       params_to_entities( context );
 }
 
 static void on_entity_declaration( void *ctx, const xmlChar* name, int type, 
@@ -1001,22 +1087,113 @@ xmlEntityPtr on_get_entity( void *ctx, const xmlChar* name )
 {
        struct _xmlParserCtxt *xmlcontext = ( struct _xmlParserCtxt* )ctx;
        deserialise_context context = ( deserialise_context )( xmlcontext->_private );
+       xmlEntityPtr e = NULL;
+
+       // Setup for entity declarations if not ready
+       if ( xmlGetIntSubset( context->entity_doc ) == NULL )
+       {
+               xmlCreateIntSubset( context->entity_doc, "westley", "", "" );
+               context->publicId = "";
+               context->systemId = "";
+       }
+
+       // Add our parameters if not already
+       params_to_entities( context );
+       
+       e = xmlGetDocEntity( context->entity_doc, name );
+       
+       // Send signal to on_characters that an entity substitutin is pending
+       if ( e != NULL )
+               context->entity_is_replace = 1;
+       
+       return e;
+}
+
+/** Convert a hexadecimal character to its value.
+*/
+static int tohex( char p )
+{
+       return isdigit( p ) ? p - '0' : tolower( p ) - 'a' + 10;
+}
+
+/** Decode a url-encoded string containing hexadecimal character sequences.
+*/
+static char *url_decode( char *dest, char *src )
+{
+       char *p = dest;
+       
+       while ( *src )
+       {
+               if ( *src == '%' )
+               {
+                       *p ++ = ( tohex( *( src + 1 ) ) << 4 ) | tohex( *( src + 2 ) );
+                       src += 3;
+               }
+               else
+               {
+                       *p ++ = *src ++;
+               }
+       }
 
-       return xmlGetDocEntity( context->entity_doc, name );
+       *p = *src;
+       return dest;
 }
 
+/** Extract the filename from a URL attaching parameters to a properties list.
+*/
+static void parse_url( mlt_properties properties, char *url )
+{
+       int i;
+       int n = strlen( url );
+       char *name = NULL;
+       char *value = NULL;
+       
+       for ( i = 0; i < n; i++ )
+       {
+               switch ( url[ i ] )
+               {
+                       case '?':
+                               url[ i++ ] = '\0';
+                               name = &url[ i ];
+                               break;
+                       
+                       case ':':
+                       case '=':
+                               url[ i++ ] = '\0';
+                               value = &url[ i ];
+                               break;
+                       
+                       case '&':
+                               url[ i++ ] = '\0';
+                               if ( name != NULL && value != NULL )
+                                       mlt_properties_set( properties, name, value );
+                               name = &url[ i ];
+                               value = NULL;
+                               break;
+               }
+       }
+       if ( name != NULL && value != NULL )
+               mlt_properties_set( properties, name, value );
+}
 
-mlt_producer producer_westley_init( char *filename )
+mlt_producer producer_westley_init( char *url )
 {
+       if ( url == NULL )
+               return NULL;
        xmlSAXHandler *sax = calloc( 1, sizeof( xmlSAXHandler ) );
        struct deserialise_context_s *context = calloc( 1, sizeof( struct deserialise_context_s ) );
        mlt_properties properties = NULL;
        int i = 0;
        struct _xmlParserCtxt *xmlcontext;
        int well_formed = 0;
+       char *filename = strdup( url );
        
        context->producer_map = mlt_properties_new();
        context->destructors = mlt_properties_new();
+       context->params = mlt_properties_new();
+
+       // Decode URL and parse parameters      
+       parse_url( context->params, url_decode( filename, url ) );
 
        // We need to track the number of registered filters
        mlt_properties_set_int( context->destructors, "registered", 0 );
@@ -1104,7 +1281,7 @@ mlt_producer producer_westley_init( char *filename )
                mlt_properties_set_data( properties, "__destructors__", context->destructors, 0, (mlt_destructor) mlt_properties_close, NULL );
 
                // Now assign additional properties
-               mlt_properties_set( properties, "resource", filename );
+               mlt_properties_set( properties, "resource", url );
 
                // This tells consumer_westley not to deep copy
                mlt_properties_set( properties, "westley", "was here" );
@@ -1118,9 +1295,12 @@ mlt_producer producer_westley_init( char *filename )
                mlt_properties_close( context->destructors );
        }
 
-       free( context->stack_service );
+       // Clean up
        mlt_properties_close( context->producer_map );
-       //free( context );
+       if ( context->params != NULL )
+               mlt_properties_close( context->params );
+       free( context );
+       free( filename );
 
        return MLT_PRODUCER( service );
 }