X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;ds=sidebyside;f=src%2Fframework%2Fmlt_repository.c;h=e5e5e79388458f3d31fd46f22edafb8d9fcf51a6;hb=7a813d44afa9d1d1639b64610f7b28156c13c595;hp=f821abb414f45fa9035421ac0895198ca509f5cb;hpb=e5fd66367b6f976e3bcb0ada98408afcb40cb2ce;p=mlt

diff --git a/src/framework/mlt_repository.c b/src/framework/mlt_repository.c
index f821abb4..e5e5e793 100644
--- a/src/framework/mlt_repository.c
+++ b/src/framework/mlt_repository.c
@@ -1,10 +1,11 @@
 /**
  * \file mlt_repository.c
  * \brief provides a map between service and shared objects
+ * \see mlt_repository_s
  *
- * Copyright (C) 2003-2008 Ushodaya Enterprises Limited
+ * Copyright (C) 2003-2009 Ushodaya Enterprises Limited
  * \author Charles Yates <charles.yates@pandora.be>
- *         Dan Dennedy <dan@dennedy.org>
+ * \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
@@ -24,28 +25,43 @@
 #include "mlt_repository.h"
 #include "mlt_properties.h"
 #include "mlt_tokeniser.h"
+#include "mlt_log.h"
+#include "mlt_factory.h"
 
 #include <stdio.h>
 #include <stdlib.h>
 #include <dlfcn.h>
 #include <string.h>
+#include <limits.h>
+#include <dirent.h>
+#include <sys/stat.h>
+
+/** the default subdirectory of the datadir for holding presets */
+#define PRESETS_DIR "/presets"
 
 /** \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
 };
 
-/** Construct a new repository
-*/
+/** 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 )
 {
@@ -54,12 +70,12 @@ mlt_repository mlt_repository_init( const char *directory )
 		return NULL;
 
 	// Construct the repository
-	mlt_repository this = calloc( sizeof( struct mlt_repository_s ), 1 );
-	mlt_properties_init( &this->parent, this );
-	this->consumers = mlt_properties_new();
-	this->filters = mlt_properties_new();
-	this->producers = mlt_properties_new();
-	this->transitions = mlt_properties_new();
+	mlt_repository self = calloc( 1, sizeof( struct mlt_repository_s ));
+	mlt_properties_init( &self->parent, self );
+	self->consumers = mlt_properties_new();
+	self->filters = mlt_properties_new();
+	self->producers = mlt_properties_new();
+	self->transitions = mlt_properties_new();
 
 	// Get the directory list
 	mlt_properties dir = mlt_properties_new();
@@ -87,10 +103,10 @@ mlt_repository mlt_repository_init( const char *directory )
 			// Call the registration function
 			if ( symbol_ptr != NULL )
 			{
-				symbol_ptr( this );
+				symbol_ptr( self );
 
 				// Register the object file for closure
-				mlt_properties_set_data( &this->parent, object_name, object, 0, ( mlt_destructor )dlclose, NULL );
+				mlt_properties_set_data( &self->parent, object_name, object, 0, ( mlt_destructor )dlclose, NULL );
 			}
 			else
 			{
@@ -99,15 +115,22 @@ mlt_repository mlt_repository_init( const char *directory )
 		}
 		else if ( strstr( object_name, "libmlt" ) )
 		{
-			fprintf( stderr, "%s, %s: failed to dlopen %s\n", __FILE__, __FUNCTION__, object_name );
+			mlt_log( NULL, MLT_LOG_WARNING, "%s: failed to dlopen %s\n  (%s)\n", __FUNCTION__, object_name, dlerror() );
 		}
 	}
 
 	mlt_properties_close( dir );
 
-	return this;
+	return self;
 }
 
+/** 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();
@@ -115,33 +138,49 @@ static mlt_properties new_service( void *symbol )
 	return properties;
 }
 
-/** Register a service with the repository
-    Typically, this is invoked by a module within its mlt_register().
-*/
+/** Register a service with the repository.
+ *
+ * Typically, this is invoked by a module within its mlt_register().
+ *
+ * \public \memberof mlt_repository_s
+ * \param self 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 )
+void mlt_repository_register( mlt_repository self, 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, new_service( symbol ), 0, ( mlt_destructor )mlt_properties_close, NULL );
+			mlt_properties_set_data( self->consumers, service, new_service( symbol ), 0, ( mlt_destructor )mlt_properties_close, NULL );
 			break;
 		case filter_type:
-			mlt_properties_set_data( this->filters, service, new_service( symbol ), 0, ( mlt_destructor )mlt_properties_close, NULL );
+			mlt_properties_set_data( self->filters, service, new_service( symbol ), 0, ( mlt_destructor )mlt_properties_close, NULL );
 			break;
 		case producer_type:
-			mlt_properties_set_data( this->producers, service, new_service( symbol ), 0, ( mlt_destructor )mlt_properties_close, NULL );
+			mlt_properties_set_data( self->producers, service, new_service( symbol ), 0, ( mlt_destructor )mlt_properties_close, NULL );
 			break;
 		case transition_type:
-			mlt_properties_set_data( this->transitions, service, new_service( symbol ), 0, ( mlt_destructor )mlt_properties_close, NULL );
+			mlt_properties_set_data( self->transitions, service, new_service( symbol ), 0, ( mlt_destructor )mlt_properties_close, NULL );
 			break;
 		default:
 			break;
 	}
 }
 
-static mlt_properties get_service_properties( mlt_repository this, mlt_service_type type, const char *service )
+/** Get the repository properties for particular service class.
+ *
+ * \private \memberof mlt_repository_s
+ * \param self 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 self, mlt_service_type type, const char *service )
 {
 	mlt_properties service_properties = NULL;
 
@@ -149,16 +188,16 @@ static mlt_properties get_service_properties( mlt_repository this, mlt_service_t
 	switch ( type )
 	{
 		case consumer_type:
-			service_properties = mlt_properties_get_data( this->consumers, service, NULL );
+			service_properties = mlt_properties_get_data( self->consumers, service, NULL );
 			break;
 		case filter_type:
-			service_properties = mlt_properties_get_data( this->filters, service, NULL );
+			service_properties = mlt_properties_get_data( self->filters, service, NULL );
 			break;
 		case producer_type:
-			service_properties = mlt_properties_get_data( this->producers, service, NULL );
+			service_properties = mlt_properties_get_data( self->producers, service, NULL );
 			break;
 		case transition_type:
-			service_properties = mlt_properties_get_data( this->transitions, service, NULL );
+			service_properties = mlt_properties_get_data( self->transitions, service, NULL );
 			break;
 		default:
 			break;
@@ -166,12 +205,19 @@ static mlt_properties get_service_properties( mlt_repository this, mlt_service_t
 	return service_properties;
 }
 
-/** Construct a new instance of a service
-*/
+/** Construct a new instance of a service.
+ *
+ * \public \memberof mlt_repository_s
+ * \param self 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, void *input )
+void *mlt_repository_create( mlt_repository self, mlt_profile profile, mlt_service_type type, const char *service, const void *input )
 {
-	mlt_properties properties = get_service_properties( this, type, service );
+	mlt_properties properties = get_service_properties( self, type, service );
 	if ( properties != NULL )
 	{
 		mlt_register_callback symbol_ptr = mlt_properties_get_data( properties, "symbol", NULL );
@@ -182,54 +228,83 @@ void *mlt_repository_create( mlt_repository this, mlt_profile profile, mlt_servi
 	return NULL;
 }
 
-/** Destroy a repository
-*/
+/** Destroy a repository and free its resources.
+ *
+ * \public \memberof mlt_repository_s
+ * \param self a repository
+ */
 
-void mlt_repository_close( mlt_repository this )
+void mlt_repository_close( mlt_repository self )
 {
-	mlt_properties_close( this->consumers );
-	mlt_properties_close( this->filters );
-	mlt_properties_close( this->producers );
-	mlt_properties_close( this->transitions );
-	mlt_properties_close( &this->parent );
-	free( this );
+	mlt_properties_close( self->consumers );
+	mlt_properties_close( self->filters );
+	mlt_properties_close( self->producers );
+	mlt_properties_close( self->transitions );
+	mlt_properties_close( &self->parent );
+	free( self );
 }
 
-/** Get the list of registered consumers
-*/
+/** 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
-*/
+/** 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
-*/
+/** 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
-*/
+/** 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!
-*/
+/** 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 );
@@ -237,9 +312,16 @@ void mlt_repository_register_metadata( mlt_repository self, mlt_service_type typ
 	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.
-*/
+/** 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 )
 {
@@ -275,6 +357,12 @@ mlt_properties mlt_repository_metadata( mlt_repository self, mlt_service_type ty
 	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" );
@@ -293,7 +381,15 @@ static char *getenv_locale()
 }
 
 /** 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 )
 {
@@ -337,3 +433,74 @@ mlt_properties mlt_repository_languages( mlt_repository self )
 	mlt_properties_set_data( &self->parent, "languages", languages, 0, ( mlt_destructor )mlt_properties_close, NULL );
 	return languages;
 }
+
+static void list_presets( mlt_properties properties, const char *path, const char *dirname )
+{
+	DIR *dir = opendir( dirname );
+
+	if ( dir )
+	{
+		struct dirent *de = readdir( dir );
+		char fullname[ PATH_MAX ];
+
+		while ( de != NULL )
+		{
+			if ( de->d_name[0] != '.' && de->d_name[strlen( de->d_name ) - 1] != '~' )
+			{
+				struct stat info;
+
+				snprintf( fullname, sizeof(fullname), "%s/%s", dirname, de->d_name );
+				stat( fullname, &info );
+				if ( S_ISDIR( info.st_mode ) )
+				{
+					// recurse into subdirectories
+					char sub[ PATH_MAX ];
+					if ( path )
+						snprintf( sub, sizeof(sub), "%s/%s", path, de->d_name );
+					else
+						strncpy( sub, de->d_name, sizeof(sub) );
+					list_presets( properties, sub, fullname );
+				}
+				else
+				{
+					// load the preset
+					mlt_properties preset = mlt_properties_load( fullname );
+					if ( preset && mlt_properties_count( preset ) )
+					{
+						snprintf( fullname, 1024, "%s/%s", path, de->d_name );
+						mlt_properties_set_data( properties, fullname, preset, 0, (mlt_destructor) mlt_properties_close, NULL );
+					}
+				}
+			}
+			de = readdir( dir );
+		}
+		closedir( dir );
+	}
+}
+
+/** Get the list of presets.
+ *
+ * \public \memberof mlt_repository_s
+ * \return a properties list of all the presets
+ */
+
+mlt_properties mlt_repository_presets( )
+{
+	mlt_properties result = mlt_properties_new();
+	char *path = getenv( "MLT_PRESETS_PATH" );
+
+	if ( path )
+	{
+		path = strdup( path );
+	}
+	else
+	{
+		path = malloc( strlen( mlt_environment( "MLT_DATA" ) ) + strlen( PRESETS_DIR ) + 1 );
+		strcpy( path, mlt_environment( "MLT_DATA" ) );
+		strcat( path, PRESETS_DIR );
+	}
+	list_presets( result, NULL, path );
+	free( path );
+
+	return result;
+}