git.sesse.net Git - mlt/blob - src/framework/mlt_factory.c

   1 /*
   2  * mlt_factory.c -- the factory method interfaces
   3  * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
   4  * Author: Charles Yates <charles.yates@pandora.be>
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 #include "config.h"
  22 #include "mlt.h"
  23 #include "mlt_repository.h"
  24
  25 #include <stdio.h>
  26 #include <stdlib.h>
  27 #include <string.h>
  28
  29 /** Singleton repositories
  30 */
  31
  32 static char *mlt_prefix = NULL;
  33 static mlt_properties global_properties = NULL;
  34 static mlt_properties object_list = NULL;
  35 static mlt_repository producers = NULL;
  36 static mlt_repository filters = NULL;
  37 static mlt_repository transitions = NULL;
  38 static mlt_repository consumers = NULL;
  39 static mlt_properties event_object = NULL;
  40 static int unique_id = 0;
  41
  42 /** Event transmitters.
  43 */
  44
  45 static void mlt_factory_create_request( mlt_listener listener, mlt_properties owner, mlt_service this, void **args )
  46 {
  47         if ( listener != NULL )
  48                 listener( owner, this, ( char * )args[ 0 ], ( char * )args[ 1 ], ( mlt_service * )args[ 2 ] );
  49 }
  50
  51 static void mlt_factory_create_done( mlt_listener listener, mlt_properties owner, mlt_service this, void **args )
  52 {
  53         if ( listener != NULL )
  54                 listener( owner, this, ( char * )args[ 0 ], ( char * )args[ 1 ], ( mlt_service )args[ 2 ] );
  55 }
  56
  57 /** Construct the factories.
  58 */
  59
  60 int mlt_factory_init( const char *prefix )
  61 {
  62         // Only initialise once
  63         if ( mlt_prefix == NULL )
  64         {
  65                 // Allow user over rides
  66                 if ( prefix == NULL || !strcmp( prefix, "" ) )
  67                         prefix = getenv( "MLT_REPOSITORY" );
  68
  69                 // If no directory is specified, default to install directory
  70                 if ( prefix == NULL )
  71                         prefix = PREFIX_DATA;
  72
  73                 // Store the prefix for later retrieval
  74                 mlt_prefix = strdup( prefix );
  75
  76                 // Initialise the pool
  77                 mlt_pool_init( );
  78
  79                 // Create and set up the events object
  80                 event_object = mlt_properties_new( );
  81                 mlt_events_init( event_object );
  82                 mlt_events_register( event_object, "producer-create-request", ( mlt_transmitter )mlt_factory_create_request );
  83                 mlt_events_register( event_object, "producer-create-done", ( mlt_transmitter )mlt_factory_create_done );
  84                 mlt_events_register( event_object, "filter-create-request", ( mlt_transmitter )mlt_factory_create_request );
  85                 mlt_events_register( event_object, "filter-create-done", ( mlt_transmitter )mlt_factory_create_done );
  86                 mlt_events_register( event_object, "transition-create-request", ( mlt_transmitter )mlt_factory_create_request );
  87                 mlt_events_register( event_object, "transition-create-done", ( mlt_transmitter )mlt_factory_create_done );
  88                 mlt_events_register( event_object, "consumer-create-request", ( mlt_transmitter )mlt_factory_create_request );
  89                 mlt_events_register( event_object, "consumer-create-done", ( mlt_transmitter )mlt_factory_create_done );
  90
  91                 // Create the global properties
  92                 global_properties = mlt_properties_new( );
  93
  94                 // Create the object list.
  95                 object_list = mlt_properties_new( );
  96
  97                 // Create a repository for each service type
  98                 producers = mlt_repository_init( object_list, prefix, "producers", "mlt_create_producer" );
  99                 filters = mlt_repository_init( object_list, prefix, "filters", "mlt_create_filter" );
 100                 transitions = mlt_repository_init( object_list, prefix, "transitions", "mlt_create_transition" );
 101                 consumers = mlt_repository_init( object_list, prefix, "consumers", "mlt_create_consumer" );
 102
 103                 // Force a clean up when app closes
 104                 atexit( mlt_factory_close );
 105         }
 106
 107         // Allow property refresh on a subsequent initialisation
 108         if ( global_properties != NULL )
 109         {
 110                 mlt_properties_set_or_default( global_properties, "MLT_NORMALISATION", getenv( "MLT_NORMALISATION" ), "PAL" );
 111                 mlt_properties_set_or_default( global_properties, "MLT_PRODUCER", getenv( "MLT_PRODUCER" ), "fezzik" );
 112                 mlt_properties_set_or_default( global_properties, "MLT_CONSUMER", getenv( "MLT_CONSUMER" ), "sdl" );
 113                 mlt_properties_set( global_properties, "MLT_TEST_CARD", getenv( "MLT_TEST_CARD" ) );
 114                 mlt_properties_set_or_default( global_properties, "MLT_PROFILE", getenv( "MLT_PROFILE" ), "dv_pal" );
 115
 116                 // Load the most appropriate profile
 117                 // MLT_PROFILE preferred
 118                 if ( getenv( "MLT_PROFILE" ) )
 119                 {
 120                         if ( !mlt_profile_select( mlt_environment( "MLT_PROFILE" ) ) )
 121                                 mlt_profile_load_file( mlt_environment( "MLT_PROFILE" ) );
 122                 }
 123                 // MLT_NORMALISATION backwards compatibility
 124                 else if ( strcmp( mlt_environment( "MLT_NORMALISATION" ), "PAL" ) )
 125                         mlt_profile_select( "dv_ntsc" );
 126                 else
 127                         mlt_profile_select( "dv_pal" );
 128         }
 129
 130
 131         return 0;
 132 }
 133
 134 /** Fetch the events object.
 135 */
 136
 137 mlt_properties mlt_factory_event_object( )
 138 {
 139         return event_object;
 140 }
 141
 142 /** Fetch the prefix used in this instance.
 143 */
 144
 145 const char *mlt_factory_prefix( )
 146 {
 147         return mlt_prefix;
 148 }
 149
 150 /** Get a value from the environment.
 151 */
 152
 153 char *mlt_environment( const char *name )
 154 {
 155         return mlt_properties_get( global_properties, name );
 156 }
 157
 158 /** Set a value in the environment.
 159 */
 160
 161 int mlt_environment_set( const char *name, const char *value )
 162 {
 163         return mlt_properties_set( global_properties, name, value );
 164 }
 165
 166 /** Fetch a producer from the repository.
 167 */
 168
 169 mlt_producer mlt_factory_producer( const char *service, void *input )
 170 {
 171         mlt_producer obj = NULL;
 172
 173         // Pick up the default normalising producer if necessary
 174         if ( service == NULL )
 175                 service = mlt_environment( "MLT_PRODUCER" );
 176
 177         // Offer the application the chance to 'create'
 178         mlt_events_fire( event_object, "producer-create-request", service, input, &obj, NULL );
 179
 180         // Try to instantiate via the specified service
 181         if ( obj == NULL )
 182         {
 183                 obj = mlt_repository_fetch( producers, service, input );
 184                 mlt_events_fire( event_object, "producer-create-done", service, input, obj, NULL );
 185                 if ( obj != NULL )
 186                 {
 187                         mlt_properties properties = MLT_PRODUCER_PROPERTIES( obj );
 188                         mlt_properties_set_int( properties, "_unique_id", ++ unique_id );
 189                         mlt_properties_set( properties, "mlt_type", "producer" );
 190                         if ( mlt_properties_get_int( properties, "_mlt_service_hidden" ) == 0 )
 191                                 mlt_properties_set( properties, "mlt_service", service );
 192                 }
 193         }
 194         return obj;
 195 }
 196
 197 /** Fetch a filter from the repository.
 198 */
 199
 200 mlt_filter mlt_factory_filter( const char *service, void *input )
 201 {
 202         mlt_filter obj = NULL;
 203
 204         // Offer the application the chance to 'create'
 205         mlt_events_fire( event_object, "filter-create-request", service, input, &obj, NULL );
 206
 207         if ( obj == NULL )
 208         {
 209                 obj = mlt_repository_fetch( filters, service, input );
 210                 mlt_events_fire( event_object, "filter-create-done", service, input, obj, NULL );
 211         }
 212
 213         if ( obj != NULL )
 214         {
 215                 mlt_properties properties = MLT_FILTER_PROPERTIES( obj );
 216                 mlt_properties_set_int( properties, "_unique_id", ++ unique_id );
 217                 mlt_properties_set( properties, "mlt_type", "filter" );
 218                 mlt_properties_set( properties, "mlt_service", service );
 219         }
 220         return obj;
 221 }
 222
 223 /** Fetch a transition from the repository.
 224 */
 225
 226 mlt_transition mlt_factory_transition( const char *service, void *input )
 227 {
 228         mlt_transition obj = NULL;
 229
 230         // Offer the application the chance to 'create'
 231         mlt_events_fire( event_object, "transition-create-request", service, input, &obj, NULL );
 232
 233         if ( obj == NULL )
 234         {
 235                 obj = mlt_repository_fetch( transitions, service, input );
 236                 mlt_events_fire( event_object, "transition-create-done", service, input, obj, NULL );
 237         }
 238
 239         if ( obj != NULL )
 240         {
 241                 mlt_properties properties = MLT_TRANSITION_PROPERTIES( obj );
 242                 mlt_properties_set_int( properties, "_unique_id", ++ unique_id );
 243                 mlt_properties_set( properties, "mlt_type", "transition" );
 244                 mlt_properties_set( properties, "mlt_service", service );
 245         }
 246         return obj;
 247 }
 248
 249 /** Fetch a consumer from the repository
 250 */
 251
 252 mlt_consumer mlt_factory_consumer( const char *service, void *input )
 253 {
 254         mlt_consumer obj = NULL;
 255
 256         if ( service == NULL )
 257                 service = mlt_environment( "MLT_CONSUMER" );
 258
 259         // Offer the application the chance to 'create'
 260         mlt_events_fire( event_object, "consumer-create-request", service, input, &obj, NULL );
 261
 262         if ( obj == NULL )
 263         {
 264                 obj = mlt_repository_fetch( consumers, service, input );
 265                 mlt_events_fire( event_object, "consumer-create-done", service, input, obj, NULL );
 266         }
 267
 268         if ( obj != NULL )
 269         {
 270                 mlt_properties properties = MLT_CONSUMER_PROPERTIES( obj );
 271                 mlt_properties_set_int( properties, "_unique_id", ++ unique_id );
 272                 mlt_properties_set( properties, "mlt_type", "consumer" );
 273                 mlt_properties_set( properties, "mlt_service", service );
 274         }
 275         return obj;
 276 }
 277
 278 /** Register an object for clean up.
 279 */
 280
 281 void mlt_factory_register_for_clean_up( void *ptr, mlt_destructor destructor )
 282 {
 283         char unique[ 256 ];
 284         sprintf( unique, "%08d", mlt_properties_count( global_properties ) );
 285         mlt_properties_set_data( global_properties, unique, ptr, 0, destructor, NULL );
 286 }
 287
 288 /** Close the factory.
 289 */
 290
 291 void mlt_factory_close( )
 292 {
 293         if ( mlt_prefix != NULL )
 294         {
 295                 mlt_properties_close( event_object );
 296                 mlt_repository_close( producers );
 297                 mlt_repository_close( filters );
 298                 mlt_repository_close( transitions );
 299                 mlt_repository_close( consumers );
 300                 mlt_properties_close( global_properties );
 301                 mlt_properties_close( object_list );
 302                 free( mlt_prefix );
 303                 mlt_prefix = NULL;
 304                 mlt_pool_close( );
 305                 mlt_profile_close();
 306         }
 307 }