X-Git-Url: http://research.m1stereo.tv/gitweb?a=blobdiff_plain;f=src%2Fframework%2Fmlt_repository.c;h=c843ecb2f4d9cfeadd10006e81b573c347180c58;hb=f4d4669b66a9f23be85527f65dec19a566db561c;hp=7f474f33a8ff4c87e7f16b0f65545126757b1766;hpb=16b6d374cf80004b192aae74a55b0452c7ee809d;p=melted

diff --git a/src/framework/mlt_repository.c b/src/framework/mlt_repository.c
index 7f474f3..c843ecb 100644
--- a/src/framework/mlt_repository.c
+++ b/src/framework/mlt_repository.c
@@ -1,7 +1,11 @@
-/*
- * repository.c -- provides a map between service and shared objects
- * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
- * Author: Charles Yates <charles.yates@pandora.be>
+/**
+ * \file mlt_repository.c
+ * \brief provides a map between service and shared objects
+ * \see mlt_repository_s
+ *
+ * Copyright (C) 2003-2009 Ushodaya Enterprises Limited
+ * \author Charles Yates <charles.yates@pandora.be>
+ * \author Dan Dennedy <dan@dennedy.org>
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -20,23 +24,44 @@
 
 #include "mlt_repository.h"
 #include "mlt_properties.h"
+#include "mlt_tokeniser.h"
+#include "mlt_log.h"
 
 #include <stdio.h>
 #include <stdlib.h>
 #include <dlfcn.h>
 #include <string.h>
 
+/** \brief Repository class
+ *
+ * The Repository is a collection of plugin modules and their services and service metadata.
+ *
+ * \extends mlt_properties_s
+ * \properties \p language a cached list of user locales
+ */
+
 struct mlt_repository_s
 {
-	struct mlt_properties_s parent; // a list of object files
-	mlt_properties consumers; // lists of entry points
-	mlt_properties filters;
-	mlt_properties producers;
-	mlt_properties transitions;
+	struct mlt_properties_s parent; /// a list of object files
+	mlt_properties consumers;       /// a list of entry points for consumers
+	mlt_properties filters;         /// a list of entry points for filters
+	mlt_properties producers;       /// a list of entry points for producers
+	mlt_properties transitions;     /// a list of entry points for transitions
 };
 
-mlt_repository mlt_repository_init( const char *prefix )
+/** Construct a new repository.
+ *
+ * \public \memberof mlt_repository_s
+ * \param directory the full path of a directory from which to read modules
+ * \return a new repository or NULL if failed
+ */
+
+mlt_repository mlt_repository_init( const char *directory )
 {
+	// Safety check
+	if ( directory == NULL || strcmp( directory, "" ) == 0 )
+		return NULL;
+
 	// Construct the repository
 	mlt_repository this = calloc( sizeof( struct mlt_repository_s ), 1 );
 	mlt_properties_init( &this->parent, this );
@@ -44,12 +69,12 @@ mlt_repository mlt_repository_init( const char *prefix )
 	this->filters = mlt_properties_new();
 	this->producers = mlt_properties_new();
 	this->transitions = mlt_properties_new();
-	
+
 	// Get the directory list
 	mlt_properties dir = mlt_properties_new();
-	int count = mlt_properties_dir_list( dir, prefix, NULL, 0 );
+	int count = mlt_properties_dir_list( dir, directory, NULL, 0 );
 	int i;
-	
+
 	// Iterate over files
 	for ( i = 0; i < count; i++ )
 	{
@@ -62,17 +87,17 @@ mlt_repository mlt_repository_init( const char *prefix )
 			flags |= RTLD_GLOBAL;
 
 		// Open the shared object
-		void *object = dlopen( object_name, flags );		
+		void *object = dlopen( object_name, flags );
 		if ( object != NULL )
 		{
 			// Get the registration function
-			int ( *symbol_ptr )( mlt_repository ) = dlsym( object, "mlt_register" );
-			
+			mlt_repository_callback symbol_ptr = dlsym( object, "mlt_register" );
+
 			// Call the registration function
 			if ( symbol_ptr != NULL )
 			{
 				symbol_ptr( this );
-				
+
 				// Register the object file for closure
 				mlt_properties_set_data( &this->parent, object_name, object, 0, ( mlt_destructor )dlclose, NULL );
 			}
@@ -81,60 +106,127 @@ mlt_repository mlt_repository_init( const char *prefix )
 				dlclose( object );
 			}
 		}
+		else if ( strstr( object_name, "libmlt" ) )
+		{
+			mlt_log( NULL, MLT_LOG_WARNING, "%s: failed to dlopen %s\n  (%s)\n", __FUNCTION__, object_name, dlerror() );
+		}
 	}
-	
+
+	mlt_properties_close( dir );
+
 	return this;
 }
 
-void mlt_repository_register( mlt_repository this, mlt_service_type service_type, const char *service, void *symbol )
+/** Create a properties list for a service holding a function pointer to its constructor function.
+ *
+ * \private \memberof mlt_repository_s
+ * \param symbol a pointer to a function that can create the service.
+ * \return a properties list
+ */
+
+static mlt_properties new_service( void *symbol )
+{
+	mlt_properties properties = mlt_properties_new();
+	mlt_properties_set_data( properties, "symbol", symbol, 0, NULL, NULL );
+	return properties;
+}
+
+/** Register a service with the repository.
+ *
+ * Typically, this is invoked by a module within its mlt_register().
+ *
+ * \public \memberof mlt_repository_s
+ * \param this a repository
+ * \param service_type a service class
+ * \param service the name of a service
+ * \param symbol a pointer to a function to create the service
+ */
+
+void mlt_repository_register( mlt_repository this, mlt_service_type service_type, const char *service, mlt_register_callback symbol )
 {
 	// Add the entry point to the corresponding service list
 	switch ( service_type )
 	{
 		case consumer_type:
-			mlt_properties_set_data( this->consumers, service, symbol, 0, NULL, NULL );
+			mlt_properties_set_data( this->consumers, service, new_service( symbol ), 0, ( mlt_destructor )mlt_properties_close, NULL );
 			break;
 		case filter_type:
-			mlt_properties_set_data( this->filters, service, symbol, 0, NULL, NULL );
+			mlt_properties_set_data( this->filters, service, new_service( symbol ), 0, ( mlt_destructor )mlt_properties_close, NULL );
 			break;
 		case producer_type:
-			mlt_properties_set_data( this->producers, service, symbol, 0, NULL, NULL );
+			mlt_properties_set_data( this->producers, service, new_service( symbol ), 0, ( mlt_destructor )mlt_properties_close, NULL );
 			break;
 		case transition_type:
-			mlt_properties_set_data( this->transitions, service, symbol, 0, NULL, NULL );
+			mlt_properties_set_data( this->transitions, service, new_service( symbol ), 0, ( mlt_destructor )mlt_properties_close, NULL );
 			break;
 		default:
 			break;
 	}
 }
 
-void *mlt_repository_fetch( mlt_repository this, mlt_profile profile, mlt_service_type type, const char *service, void *input )
+/** Get the repository properties for particular service class.
+ *
+ * \private \memberof mlt_repository_s
+ * \param this a repository
+ * \param type a service class
+ * \param service the name of a service
+ * \return a properties list or NULL if error
+ */
+
+static mlt_properties get_service_properties( mlt_repository this, mlt_service_type type, const char *service )
 {
-	void *( *symbol_ptr )( mlt_profile, mlt_service_type, const char *, void * ) = NULL;
+	mlt_properties service_properties = NULL;
 
 	// Get the entry point from the corresponding service list
 	switch ( type )
 	{
 		case consumer_type:
-			symbol_ptr = mlt_properties_get_data( this->consumers, service, NULL );
+			service_properties = mlt_properties_get_data( this->consumers, service, NULL );
 			break;
 		case filter_type:
-			symbol_ptr = mlt_properties_get_data( this->filters, service, NULL );
+			service_properties = mlt_properties_get_data( this->filters, service, NULL );
 			break;
 		case producer_type:
-			symbol_ptr = mlt_properties_get_data( this->producers, service, NULL );
+			service_properties = mlt_properties_get_data( this->producers, service, NULL );
 			break;
 		case transition_type:
-			symbol_ptr = mlt_properties_get_data( this->transitions, service, NULL );
+			service_properties = mlt_properties_get_data( this->transitions, service, NULL );
 			break;
 		default:
 			break;
 	}
-	
-	// Construct the service
-	return ( symbol_ptr != NULL ) ? symbol_ptr( profile, type, service, input ) : NULL;
+	return service_properties;
+}
+
+/** Construct a new instance of a service.
+ *
+ * \public \memberof mlt_repository_s
+ * \param this a repository
+ * \param profile a \p mlt_profile to give the service
+ * \param type a service class
+ * \param service the name of the service
+ * \param input an optional argument to the service constructor
+ */
+
+void *mlt_repository_create( mlt_repository this, mlt_profile profile, mlt_service_type type, const char *service, const void *input )
+{
+	mlt_properties properties = get_service_properties( this, type, service );
+	if ( properties != NULL )
+	{
+		mlt_register_callback symbol_ptr = mlt_properties_get_data( properties, "symbol", NULL );
+
+		// Construct the service
+		return ( symbol_ptr != NULL ) ? symbol_ptr( profile, type, service, input ) : NULL;
+	}
+	return NULL;
 }
 
+/** Destroy a repository and free its resources.
+ *
+ * \public \memberof mlt_repository_s
+ * \param this a repository
+ */
+
 void mlt_repository_close( mlt_repository this )
 {
 	mlt_properties_close( this->consumers );
@@ -144,3 +236,193 @@ void mlt_repository_close( mlt_repository this )
 	mlt_properties_close( &this->parent );
 	free( this );
 }
+
+/** Get the list of registered consumers.
+ *
+ * \public \memberof mlt_repository_s
+ * \param self a repository
+ * \return a properties list containing all of the consumers
+ */
+
+mlt_properties mlt_repository_consumers( mlt_repository self )
+{
+	return self->consumers;
+}
+
+/** Get the list of registered filters.
+ *
+ * \public \memberof mlt_repository_s
+ * \param self a repository
+ * \return a properties list of all of the filters
+ */
+
+mlt_properties mlt_repository_filters( mlt_repository self )
+{
+	return self->filters;
+}
+
+/** Get the list of registered producers.
+ *
+ * \public \memberof mlt_repository_s
+ * \param self a repository
+ * \return a properties list of all of the producers
+ */
+
+mlt_properties mlt_repository_producers( mlt_repository self )
+{
+	return self->producers;
+}
+
+/** Get the list of registered transitions.
+ *
+ * \public \memberof mlt_repository_s
+ * \param self a repository
+ * \return a properties list of all of the transitions
+ */
+
+mlt_properties mlt_repository_transitions( mlt_repository self )
+{
+	return self->transitions;
+}
+
+/** Register the metadata for a service.
+ *
+ * IMPORTANT: mlt_repository will take responsibility for deallocating the metadata properties
+ * that you supply!
+ *
+ * \public \memberof mlt_repository_s
+ * \param self a repository
+ * \param type a service class
+ * \param service the name of a service
+ * \param callback the pointer to a function that can supply metadata
+ * \param callback_data an opaque user data pointer to be supplied on the callback
+ */
+
+void mlt_repository_register_metadata( mlt_repository self, mlt_service_type type, const char *service, mlt_metadata_callback callback, void *callback_data )
+{
+	mlt_properties service_properties = get_service_properties( self, type, service );
+	mlt_properties_set_data( service_properties, "metadata_cb", callback, 0, NULL, NULL );
+	mlt_properties_set_data( service_properties, "metadata_cb_data", callback_data, 0, NULL, NULL );
+}
+
+/** Get the metadata about a service.
+ *
+ * Returns NULL if service or its metadata are unavailable.
+ *
+ * \public \memberof mlt_repository_s
+ * \param self a repository
+ * \param type a service class
+ * \param service the name of a service
+ * \return the service metadata as a structured properties list
+ */
+
+mlt_properties mlt_repository_metadata( mlt_repository self, mlt_service_type type, const char *service )
+{
+	mlt_properties metadata = NULL;
+	mlt_properties properties = get_service_properties( self, type, service );
+
+	// If this is a valid service
+	if ( properties )
+	{
+		// Lookup cached metadata
+		metadata = mlt_properties_get_data( properties, "metadata", NULL );
+		if ( ! metadata )
+		{
+			// Not cached, so get the registered metadata callback function
+			mlt_metadata_callback callback = mlt_properties_get_data( properties, "metadata_cb", NULL );
+
+			// If a metadata callback function is registered
+			if ( callback )
+			{
+				// Fetch the callback data arg
+				void *data = mlt_properties_get_data( properties, "metadata_cb_data", NULL );
+
+				// Fetch the metadata through the callback
+				metadata = callback( type, service, data );
+
+				// Cache the metadata
+				if ( metadata )
+					// Include dellocation and serialisation
+					mlt_properties_set_data( properties, "metadata", metadata, 0, ( mlt_destructor )mlt_properties_close, ( mlt_serialiser )mlt_properties_serialise_yaml );
+			}
+		}
+	}
+	return metadata;
+}
+
+/** Try to determine the locale from some commonly used environment variables.
+ *
+ * \private \memberof mlt_repository_s
+ * \return a string containing the locale id or NULL if unknown
+ */
+
+static char *getenv_locale()
+{
+	char *s = getenv( "LANGUAGE" );
+	if ( s && s[0] )
+		return s;
+	s = getenv( "LC_ALL" );
+	if ( s && s[0] )
+		return s;
+	s = getenv( "LC_MESSAGES" );
+	if ( s && s[0] )
+		return s;
+	s = getenv( "LANG" );
+	if ( s && s[0] )
+		return s;
+	return NULL;
+}
+
+/** Return a list of user-preferred language codes taken from environment variables.
+ *
+ * A module should use this to locate a localized YAML Tiny file from which to build
+ * its metadata strucutured properties.
+ *
+ * \public \memberof mlt_repository_s
+ * \param self a repository
+ * \return a properties list that is a list (not a map) of locales, defaults to "en" if not
+ * overridden by environment variables, in order: LANGUAGE, LC_ALL, LC_MESSAGES, LANG
+ */
+
+mlt_properties mlt_repository_languages( mlt_repository self )
+{
+	mlt_properties languages = mlt_properties_get_data( &self->parent, "languages", NULL );
+	if ( languages )
+		return languages;
+
+	languages = mlt_properties_new();
+	char *locale = getenv_locale();
+	if ( locale )
+	{
+		locale = strdup( locale );
+		mlt_tokeniser tokeniser = mlt_tokeniser_init();
+		int count = mlt_tokeniser_parse_new( tokeniser, locale, ":" );
+		if ( count )
+		{
+			int i;
+			for ( i = 0; i < count; i++ )
+			{
+				char *locale = mlt_tokeniser_get_string( tokeniser, i );
+				if ( strcmp( locale, "C" ) == 0 || strcmp( locale, "POSIX" ) == 0 )
+					locale = "en";
+				else if ( strlen( locale ) > 2 )
+					locale[2] = 0;
+				char string[21];
+				snprintf( string, sizeof(string), "%d", i );
+				mlt_properties_set( languages, string, locale );
+			}
+		}
+		else
+		{
+			mlt_properties_set( languages, "0", "en" );
+		}
+		free( locale );
+		mlt_tokeniser_close( tokeniser );
+	}
+	else
+	{
+		mlt_properties_set( languages, "0", "en" );
+	}
+	mlt_properties_set_data( &self->parent, "languages", languages, 0, ( mlt_destructor )mlt_properties_close, NULL );
+	return languages;
+}