-/*
- * mlt_factory.c -- the factory method interfaces
- * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
- * Author: Charles Yates <charles.yates@pandora.be>
+/**
+ * \file mlt_factory.c
+ * \brief the factory method interfaces
+ *
+ * Copyright (C) 2003-2009 Ushodaya Enterprises Limited
+ * \author Charles Yates <charles.yates@pandora.be>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
-#include "config.h"
#include "mlt.h"
#include "mlt_repository.h"
#include <stdlib.h>
#include <string.h>
-/** Singleton repositories
-*/
+/** the default subdirectory of the libdir for holding modules (plugins) */
+#define PREFIX_LIB LIBDIR "/mlt"
+/** the default subdirectory of the install prefix for holding module (plugin) data */
+#define PREFIX_DATA PREFIX "/share/mlt"
+
-static char *mlt_prefix = NULL;
+/** holds the full path to the modules directory - initialized and retained for the entire session */
+static char *mlt_directory = NULL;
+/** a global properties list for holding environment config data and things needing session-oriented cleanup */
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;
+/** the global repository singleton */
+static mlt_repository repository = NULL;
+/** the events object for the factory events */
static mlt_properties event_object = NULL;
+/** for tracking the unique_id set on each constructed service */
static int unique_id = 0;
-/** Event transmitters.
-*/
+/* Event transmitters. */
+
+/** the -create-request event transmitter
+ *
+ * \param listener
+ * \param owner
+ * \param this
+ * \param args
+ */
static void mlt_factory_create_request( mlt_listener listener, mlt_properties owner, mlt_service this, void **args )
{
listener( owner, this, ( char * )args[ 0 ], ( char * )args[ 1 ], ( mlt_service * )args[ 2 ] );
}
+/** the -create-done event transmitter
+ *
+ * \param listener
+ * \param owner
+ * \param this
+ * \param args
+ */
+
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.
-*/
+/** Construct the repository and factories.
+ *
+ * The environment variable MLT_PRODUCER is the name of a default producer often used by other services, defaults to "fezzil".
+ *
+ * The environment variable MLT_CONSUMER is the name of a default consumer, defaults to "sdl".
+ *
+ * The environment variable MLT_TEST_CARD is the name of a producer or file to be played when nothing is available (all tracks blank).
+ *
+ * The environment variable MLT_DATA overrides the default full path to the MLT and module supplemental data files, defaults to \p PREFIX_DATA.
+ *
+ * The environment variable MLT_PROFILE defaults to "dv_pal."
+ *
+ * The environment variable MLT_REPOSITORY overrides the default location of the plugin modules, defaults to \p PREFIX_LIB.
+ *
+ * \param directory an optional full path to a directory containing the modules that overrides the default and
+ * the MLT_REPOSITORY environment variable
+ * \return the repository
+ */
-int mlt_factory_init( const char *prefix )
+mlt_repository mlt_factory_init( const char *directory )
{
// Only initialise once
- if ( mlt_prefix == NULL )
+ if ( mlt_directory == NULL )
{
// Allow user over rides
- if ( prefix == NULL || !strcmp( prefix, "" ) )
- prefix = getenv( "MLT_REPOSITORY" );
+ if ( directory == NULL || !strcmp( directory, "" ) )
+ directory = getenv( "MLT_REPOSITORY" );
// If no directory is specified, default to install directory
- if ( prefix == NULL )
- prefix = PREFIX_DATA;
+ if ( directory == NULL )
+ directory = PREFIX_LIB;
// Store the prefix for later retrieval
- mlt_prefix = strdup( prefix );
+ mlt_directory = strdup( directory );
// Initialise the pool
mlt_pool_init( );
// Create the global properties
global_properties = mlt_properties_new( );
- // Create the object list.
- object_list = mlt_properties_new( );
-
- // Create a repository for each service type
- 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" );
+ // Create the repository of services
+ repository = mlt_repository_init( directory );
// Force a clean up when app closes
atexit( mlt_factory_close );
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" );
+ mlt_properties_set_or_default( global_properties, "MLT_DATA", getenv( "MLT_DATA" ), PREFIX_DATA );
}
- return 0;
+ return repository;
}
/** Fetch the events object.
-*/
+ *
+ * \return the global factory event object
+ */
mlt_properties mlt_factory_event_object( )
{
return event_object;
}
-/** Fetch the prefix used in this instance.
-*/
+/** Fetch the module directory used in this instance.
+ *
+ * \return the full path to the module directory that this session is using
+ */
-const char *mlt_factory_prefix( )
+const char *mlt_factory_directory( )
{
- return mlt_prefix;
+ return mlt_directory;
}
/** Get a value from the environment.
-*/
+ *
+ * \param name the name of a MLT (runtime configuration) environment variable
+ * \return the value of the variable
+ */
char *mlt_environment( const char *name )
{
- return mlt_properties_get( global_properties, name );
+ if ( global_properties )
+ return mlt_properties_get( global_properties, name );
+ else
+ return NULL;
}
/** Set a value in the environment.
-*/
+ *
+ * \param name the name of a MLT environment variable
+ * \param value the value of the variable
+ * \return true on error
+ */
int mlt_environment_set( const char *name, const char *value )
{
- return mlt_properties_set( global_properties, name, value );
+ if ( global_properties )
+ return mlt_properties_set( global_properties, name, value );
+ else
+ return -1;
}
+/** Set some properties common to all services.
+ *
+ * This sets _unique_id, \p mlt_type, \p mlt_service (unless _mlt_service_hidden), and _profile.
+ *
+ * \param properties a service's properties list
+ * \param profile the \p mlt_profile supplied to the factory function
+ * \param type the MLT service class
+ * \param service the name of the service
+ */
+
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 );
}
/** Fetch a producer from the repository.
-*/
+ *
+ * \param profile the \p mlt_profile to use
+ * \param service the name of the producer (optional, defaults to MLT_PRODUCER)
+ * \param input an optional argument to the producer constructor, typically a string
+ * \return a new producer
+ */
mlt_producer mlt_factory_producer( mlt_profile profile, const char *service, void *input )
{
// Try to instantiate via the specified service
if ( obj == NULL )
{
- obj = mlt_repository_fetch( producers, profile, producer_type, service, input );
+ obj = mlt_repository_create( repository, profile, producer_type, service, input );
mlt_events_fire( event_object, "producer-create-done", service, input, obj, NULL );
if ( obj != NULL )
{
}
/** Fetch a filter from the repository.
-*/
+ *
+ * \param profile the \p mlt_profile to use
+ * \param service the name of the filter
+ * \param input an optional argument to the filter constructor, typically a string
+ * \return a new filter
+ */
mlt_filter mlt_factory_filter( mlt_profile profile, const char *service, void *input )
{
if ( obj == NULL )
{
- obj = mlt_repository_fetch( filters, profile, filter_type, service, input );
+ obj = mlt_repository_create( repository, profile, filter_type, service, input );
mlt_events_fire( event_object, "filter-create-done", service, input, obj, NULL );
}
}
/** Fetch a transition from the repository.
-*/
+ *
+ * \param profile the \p mlt_profile to use
+ * \param service the name of the transition
+ * \param input an optional argument to the transition constructor, typically a string
+ * \return a new transition
+ */
mlt_transition mlt_factory_transition( mlt_profile profile, const char *service, void *input )
{
if ( obj == NULL )
{
- obj = mlt_repository_fetch( transitions, profile, filter_type, service, input );
+ obj = mlt_repository_create( repository, profile, transition_type, service, input );
mlt_events_fire( event_object, "transition-create-done", service, input, obj, NULL );
}
return obj;
}
-/** Fetch a consumer from the repository
-*/
+/** Fetch a consumer from the repository.
+ *
+ * \param profile the \p mlt_profile to use
+ * \param service the name of the consumer (optional, defaults to MLT_CONSUMER)
+ * \param input an optional argument to the consumer constructor, typically a string
+ * \return a new consumer
+ */
mlt_consumer mlt_factory_consumer( mlt_profile profile, const char *service, void *input )
{
if ( obj == NULL )
{
- obj = mlt_repository_fetch( consumers, profile, consumer_type, service, input );
+ obj = mlt_repository_create( repository, profile, consumer_type, service, input );
mlt_events_fire( event_object, "consumer-create-done", service, input, obj, NULL );
}
}
/** Register an object for clean up.
-*/
+ *
+ * \param ptr an opaque pointer to anything allocated on the heap
+ * \param destructor the function pointer of the deallocation subroutine (e.g., free or \p mlt_pool_release)
+ */
void mlt_factory_register_for_clean_up( void *ptr, mlt_destructor destructor )
{
}
/** Close the factory.
-*/
+ *
+ * Cleanup all resources for the session.
+ */
void mlt_factory_close( )
{
- if ( mlt_prefix != NULL )
+ if ( mlt_directory != 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 );
- mlt_prefix = NULL;
+ mlt_repository_close( repository );
+ free( mlt_directory );
+ mlt_directory = NULL;
mlt_pool_close( );
}
}
projects / mlt / blobdiff