X-Git-Url: http://research.m1stereo.tv/gitweb?a=blobdiff_plain;f=src%2Fframework%2Fmlt_repository.c;h=c843ecb2f4d9cfeadd10006e81b573c347180c58;hb=d5d878221c3123ef1d3a335dbc2b1878b3fdb983;hp=eab27776962237a0f61b63329300ef5e1e55befb;hpb=798c42620d0e5ca75150884270e7539d378649f3;p=melted diff --git a/src/framework/mlt_repository.c b/src/framework/mlt_repository.c index eab2777..c843ecb 100644 --- a/src/framework/mlt_repository.c +++ b/src/framework/mlt_repository.c @@ -1,8 +1,11 @@ -/* - * repository.c -- provides a map between service and shared objects - * Copyright (C) 2003-2004 Ushodaya Enterprises Limited - * Author: Charles Yates - * Contributor: Dan Dennedy +/** + * \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 + * \author Dan Dennedy * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public @@ -22,30 +25,43 @@ #include "mlt_repository.h" #include "mlt_properties.h" #include "mlt_tokeniser.h" +#include "mlt_log.h" #include #include #include #include +/** \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 ) { // 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 ); @@ -58,7 +74,7 @@ mlt_repository mlt_repository_init( const char *directory ) mlt_properties dir = mlt_properties_new(); int count = mlt_properties_dir_list( dir, directory, NULL, 0 ); int i; - + // Iterate over files for ( i = 0; i < count; i++ ) { @@ -71,17 +87,17 @@ mlt_repository mlt_repository_init( const char *directory ) 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 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 ); } @@ -92,13 +108,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; } +/** 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(); @@ -106,9 +131,16 @@ 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 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 ) { @@ -132,6 +164,15 @@ void mlt_repository_register( mlt_repository this, mlt_service_type service_type } } +/** 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 ) { mlt_properties service_properties = NULL; @@ -157,24 +198,34 @@ 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 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, void *input ) +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 -*/ +/** Destroy a repository and free its resources. + * + * \public \memberof mlt_repository_s + * \param this a repository + */ void mlt_repository_close( mlt_repository this ) { @@ -186,41 +237,67 @@ void mlt_repository_close( mlt_repository this ) free( this ); } -/** 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 ); @@ -228,15 +305,22 @@ 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 ) { mlt_properties metadata = NULL; mlt_properties properties = get_service_properties( self, type, service ); - + // If this is a valid service if ( properties ) { @@ -252,10 +336,10 @@ mlt_properties mlt_repository_metadata( mlt_repository self, mlt_service_type ty { // 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 @@ -266,6 +350,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" ); @@ -284,18 +374,27 @@ 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 ) { mlt_properties languages = mlt_properties_get_data( &self->parent, "languages", NULL ); if ( languages ) return languages; - - const char *locale = getenv_locale(); + 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 ) @@ -317,6 +416,7 @@ mlt_properties mlt_repository_languages( mlt_repository self ) { mlt_properties_set( languages, "0", "en" ); } + free( locale ); mlt_tokeniser_close( tokeniser ); } else