]> git.sesse.net Git - mlt/blobdiff - src/framework/mlt_factory.c
mlt_factory.c: guard against accessing mlt_environment before it is ready
[mlt] / src / framework / mlt_factory.c
index 9223178994163a2542f7d7395862c80fdfd77b55..4a14decc98ef02ed28e9335b81a629522d68ca7a 100644 (file)
@@ -3,25 +3,26 @@
  * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
  * Author: Charles Yates <charles.yates@pandora.be>
  *
- * 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
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
  *
- * This program is distributed in the hope that it will be useful,
+ * This library is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software Foundation,
- * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
 #include "config.h"
 #include "mlt.h"
 #include "mlt_repository.h"
 
+#include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 
 */
 
 static char *mlt_prefix = NULL;
+static mlt_properties global_properties = NULL;
 static mlt_properties object_list = NULL;
 static mlt_repository producers = NULL;
 static mlt_repository filters = NULL;
 static mlt_repository transitions = NULL;
 static mlt_repository consumers = NULL;
+static mlt_properties event_object = NULL;
+static int unique_id = 0;
+
+/** Event transmitters.
+*/
+
+static void mlt_factory_create_request( mlt_listener listener, mlt_properties owner, mlt_service this, void **args )
+{
+       if ( listener != NULL )
+               listener( owner, this, ( char * )args[ 0 ], ( char * )args[ 1 ], ( mlt_service * )args[ 2 ] );
+}
+
+static void mlt_factory_create_done( mlt_listener listener, mlt_properties owner, mlt_service this, void **args )
+{
+       if ( listener != NULL )
+               listener( owner, this, ( char * )args[ 0 ], ( char * )args[ 1 ], ( mlt_service )args[ 2 ] );
+}
 
 /** Construct the factories.
 */
 
-int mlt_factory_init( char *prefix )
+int mlt_factory_init( const char *prefix )
 {
        // Only initialise once
        if ( mlt_prefix == NULL )
        {
+               // Allow user over rides
+               if ( prefix == NULL || !strcmp( prefix, "" ) )
+                       prefix = getenv( "MLT_REPOSITORY" );
+
                // If no directory is specified, default to install directory
                if ( prefix == NULL )
                        prefix = PREFIX_DATA;
@@ -50,20 +73,59 @@ int mlt_factory_init( char *prefix )
                // Store the prefix for later retrieval
                mlt_prefix = strdup( prefix );
 
+               // Initialise the pool
+               mlt_pool_init( );
+
+               // Create and set up the events object
+               event_object = mlt_properties_new( );
+               mlt_events_init( event_object );
+               mlt_events_register( event_object, "producer-create-request", ( mlt_transmitter )mlt_factory_create_request );
+               mlt_events_register( event_object, "producer-create-done", ( mlt_transmitter )mlt_factory_create_done );
+               mlt_events_register( event_object, "filter-create-request", ( mlt_transmitter )mlt_factory_create_request );
+               mlt_events_register( event_object, "filter-create-done", ( mlt_transmitter )mlt_factory_create_done );
+               mlt_events_register( event_object, "transition-create-request", ( mlt_transmitter )mlt_factory_create_request );
+               mlt_events_register( event_object, "transition-create-done", ( mlt_transmitter )mlt_factory_create_done );
+               mlt_events_register( event_object, "consumer-create-request", ( mlt_transmitter )mlt_factory_create_request );
+               mlt_events_register( event_object, "consumer-create-done", ( mlt_transmitter )mlt_factory_create_done );
+
+               // Create the global properties
+               global_properties = mlt_properties_new( );
+
                // Create the object list.
-               object_list = calloc( sizeof( struct mlt_properties_s ), 1 );
-               mlt_properties_init( object_list, NULL );
+               object_list = mlt_properties_new( );
 
                // Create a repository for each service type
-               producers = mlt_repository_init( object_list, prefix, "producers.dat", "mlt_create_producer" );
-               filters = mlt_repository_init( object_list, prefix, "filters.dat", "mlt_create_filter" );
-               transitions = mlt_repository_init( object_list, prefix, "transitions.dat", "mlt_create_transition" );
-               consumers = mlt_repository_init( object_list, prefix, "consumers.dat", "mlt_create_consumer" );
+               producers = mlt_repository_init( object_list, prefix, "producers", "mlt_create_producer" );
+               filters = mlt_repository_init( object_list, prefix, "filters", "mlt_create_filter" );
+               transitions = mlt_repository_init( object_list, prefix, "transitions", "mlt_create_transition" );
+               consumers = mlt_repository_init( object_list, prefix, "consumers", "mlt_create_consumer" );
+
+               // Force a clean up when app closes
+               atexit( mlt_factory_close );
        }
 
+       // Allow property refresh on a subsequent initialisation
+       if ( global_properties != NULL )
+       {
+               mlt_properties_set_or_default( global_properties, "MLT_NORMALISATION", getenv( "MLT_NORMALISATION" ), "PAL" );
+               mlt_properties_set_or_default( global_properties, "MLT_PRODUCER", getenv( "MLT_PRODUCER" ), "fezzik" );
+               mlt_properties_set_or_default( global_properties, "MLT_CONSUMER", getenv( "MLT_CONSUMER" ), "sdl" );
+               mlt_properties_set( global_properties, "MLT_TEST_CARD", getenv( "MLT_TEST_CARD" ) );
+               mlt_properties_set_or_default( global_properties, "MLT_PROFILE", getenv( "MLT_PROFILE" ), "dv_pal" );
+       }
+
+
        return 0;
 }
 
+/** Fetch the events object.
+*/
+
+mlt_properties mlt_factory_event_object( )
+{
+       return event_object;
+}
+
 /** Fetch the prefix used in this instance.
 */
 
@@ -72,17 +134,62 @@ const char *mlt_factory_prefix( )
        return mlt_prefix;
 }
 
+/** Get a value from the environment.
+*/
+
+char *mlt_environment( const char *name )
+{
+       if ( global_properties )
+               return mlt_properties_get( global_properties, name );
+       else
+               return NULL;
+}
+
+/** Set a value in the environment.
+*/
+
+int mlt_environment_set( const char *name, const char *value )
+{
+       if ( global_properties )
+               return mlt_properties_set( global_properties, name, value );
+       else
+               return -1;
+}
+
+static void set_common_properties( mlt_properties properties, mlt_profile profile, const char *type, const char *service )
+{
+       mlt_properties_set_int( properties, "_unique_id", ++ unique_id );
+       mlt_properties_set( properties, "mlt_type", type );
+       if ( mlt_properties_get_int( properties, "_mlt_service_hidden" ) == 0 )
+               mlt_properties_set( properties, "mlt_service", service );
+       if ( profile != NULL )
+               mlt_properties_set_data( properties, "_profile", profile, 0, NULL, NULL );
+}
+
 /** Fetch a producer from the repository.
 */
 
-mlt_producer mlt_factory_producer( char *service, void *input )
+mlt_producer mlt_factory_producer( mlt_profile profile, const char *service, void *input )
 {
-       mlt_producer obj = mlt_repository_fetch( producers, service, input );
-       if ( obj != NULL )
+       mlt_producer obj = NULL;
+
+       // Pick up the default normalising producer if necessary
+       if ( service == NULL )
+               service = mlt_environment( "MLT_PRODUCER" );
+
+       // Offer the application the chance to 'create'
+       mlt_events_fire( event_object, "producer-create-request", service, input, &obj, NULL );
+
+       // Try to instantiate via the specified service
+       if ( obj == NULL )
        {
-               mlt_properties properties = mlt_producer_properties( obj );
-               mlt_properties_set( properties, "mlt_type", "producer" );
-               mlt_properties_set( properties, "mlt_service", service );
+               obj = mlt_repository_fetch( producers, profile, producer_type, service, input );
+               mlt_events_fire( event_object, "producer-create-done", service, input, obj, NULL );
+               if ( obj != NULL )
+               {
+                       mlt_properties properties = MLT_PRODUCER_PROPERTIES( obj );
+                       set_common_properties( properties, profile, "producer", service );
+               }
        }
        return obj;
 }
@@ -90,14 +197,23 @@ mlt_producer mlt_factory_producer( char *service, void *input )
 /** Fetch a filter from the repository.
 */
 
-mlt_filter mlt_factory_filter( char *service, void *input )
+mlt_filter mlt_factory_filter( mlt_profile profile, const char *service, void *input )
 {
-       mlt_filter obj = mlt_repository_fetch( filters, service, input );
+       mlt_filter obj = NULL;
+
+       // Offer the application the chance to 'create'
+       mlt_events_fire( event_object, "filter-create-request", service, input, &obj, NULL );
+
+       if ( obj == NULL )
+       {
+               obj = mlt_repository_fetch( filters, profile, filter_type, service, input );
+               mlt_events_fire( event_object, "filter-create-done", service, input, obj, NULL );
+       }
+
        if ( obj != NULL )
        {
-               mlt_properties properties = mlt_filter_properties( obj );
-               mlt_properties_set( properties, "mlt_type", "filter" );
-               mlt_properties_set( properties, "mlt_service", service );
+               mlt_properties properties = MLT_FILTER_PROPERTIES( obj );
+               set_common_properties( properties, profile, "filter", service );
        }
        return obj;
 }
@@ -105,14 +221,23 @@ mlt_filter mlt_factory_filter( char *service, void *input )
 /** Fetch a transition from the repository.
 */
 
-mlt_transition mlt_factory_transition( char *service, void *input )
+mlt_transition mlt_factory_transition( mlt_profile profile, const char *service, void *input )
 {
-       mlt_transition obj = mlt_repository_fetch( transitions, service, input );
+       mlt_transition obj = NULL;
+
+       // Offer the application the chance to 'create'
+       mlt_events_fire( event_object, "transition-create-request", service, input, &obj, NULL );
+
+       if ( obj == NULL )
+       {
+               obj = mlt_repository_fetch( transitions, profile, filter_type, service, input );
+               mlt_events_fire( event_object, "transition-create-done", service, input, obj, NULL );
+       }
+
        if ( obj != NULL )
        {
-               mlt_properties properties = mlt_transition_properties( obj );
-               mlt_properties_set( properties, "mlt_type", "transition" );
-               mlt_properties_set( properties, "mlt_service", service );
+               mlt_properties properties = MLT_TRANSITION_PROPERTIES( obj );
+               set_common_properties( properties, profile, "transition", service );
        }
        return obj;
 }
@@ -120,18 +245,40 @@ mlt_transition mlt_factory_transition( char *service, void *input )
 /** Fetch a consumer from the repository
 */
 
-mlt_consumer mlt_factory_consumer( char *service, void *input )
+mlt_consumer mlt_factory_consumer( mlt_profile profile, const char *service, void *input )
 {
-       mlt_consumer obj = mlt_repository_fetch( consumers, service, input );
+       mlt_consumer obj = NULL;
+
+       if ( service == NULL )
+               service = mlt_environment( "MLT_CONSUMER" );
+
+       // Offer the application the chance to 'create'
+       mlt_events_fire( event_object, "consumer-create-request", service, input, &obj, NULL );
+
+       if ( obj == NULL )
+       {
+               obj = mlt_repository_fetch( consumers, profile, consumer_type, service, input );
+               mlt_events_fire( event_object, "consumer-create-done", service, input, obj, NULL );
+       }
+
        if ( obj != NULL )
        {
-               mlt_properties properties = mlt_consumer_properties( obj );
-               mlt_properties_set( properties, "mlt_type", "consumer" );
-               mlt_properties_set( properties, "mlt_service", service );
+               mlt_properties properties = MLT_CONSUMER_PROPERTIES( obj );
+               set_common_properties( properties, profile, "consumer", service );
        }
        return obj;
 }
 
+/** Register an object for clean up.
+*/
+
+void mlt_factory_register_for_clean_up( void *ptr, mlt_destructor destructor )
+{
+       char unique[ 256 ];
+       sprintf( unique, "%08d", mlt_properties_count( global_properties ) );
+       mlt_properties_set_data( global_properties, unique, ptr, 0, destructor, NULL );
+}
+
 /** Close the factory.
 */
 
@@ -139,14 +286,15 @@ void mlt_factory_close( )
 {
        if ( mlt_prefix != NULL )
        {
+               mlt_properties_close( event_object );
                mlt_repository_close( producers );
                mlt_repository_close( filters );
                mlt_repository_close( transitions );
                mlt_repository_close( consumers );
+               mlt_properties_close( global_properties );
                mlt_properties_close( object_list );
                free( mlt_prefix );
-               free( object_list );
                mlt_prefix = NULL;
+               mlt_pool_close( );
        }
 }
-