X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=src%2Fframework%2Fmlt_repository.h;h=29fb33735636204c8ff7316d36203d0134544aff;hb=c391321305b734567e7bb9310f15831d17b085b0;hp=5873d90900f5d08068af5eb9841af5fed40d1c4c;hpb=e5fd66367b6f976e3bcb0ada98408afcb40cb2ce;p=mlt diff --git a/src/framework/mlt_repository.h b/src/framework/mlt_repository.h index 5873d909..29fb3373 100644 --- a/src/framework/mlt_repository.h +++ b/src/framework/mlt_repository.h @@ -1,10 +1,11 @@ /** * \file mlt_repository.h * \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 - * Dan Dennedy + * \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 @@ -27,36 +28,36 @@ #include "mlt_types.h" #include "mlt_profile.h" -/** Repository structure forward reference. -*/ - -typedef struct mlt_repository_s *mlt_repository; - /** This callback is the main entry point into a module, which must be exported - with the symbol "mlt_register". - Inside the callback, the module registers the additional callbacks below. -*/ + * with the symbol "mlt_register". + * + * Inside the callback, the module registers the additional callbacks below. + */ typedef void ( *mlt_repository_callback )( mlt_repository ); -/** These are callback functions that modules implement to construct services - and metadata. -*/ -typedef void *( *mlt_register_callback )( mlt_profile, mlt_service_type, const char * /* service name */, void * /* arg */ ); +/** The callback function that modules implement to construct a service. + */ + +typedef void *( *mlt_register_callback )( mlt_profile, mlt_service_type, const char * /* service name */, const void * /* arg */ ); + +/** The callback function that modules implement to supply metadata as a properties list. + */ + typedef mlt_properties ( *mlt_metadata_callback )( mlt_service_type, const char * /* service name */, void * /* callback_data */ ); -/** These convenience macros can be used to register services in a more declarative manner. -*/ +/** A convenience macro to create an entry point for service registration. */ #define MLT_REPOSITORY void mlt_register( mlt_repository repository ) + +/** A convenience macro to a register service in a more declarative manner. */ #define MLT_REGISTER( type, service, symbol ) ( mlt_repository_register( repository, (type), (service), ( mlt_register_callback )(symbol) ) ) -#define MLT_REGISTER_METADATA( type, service, callback, data ) ( mlt_repository_register_metadata( repository, (type), (service), ( mlt_metadata_callback )(callback), (data) ) ) -/** Public functions. -*/ +/** A convenience macro to a register metadata in a more declarative manner. */ +#define MLT_REGISTER_METADATA( type, service, callback, data ) ( mlt_repository_register_metadata( repository, (type), (service), ( mlt_metadata_callback )(callback), (data) ) ) extern mlt_repository mlt_repository_init( const char *directory ); extern void mlt_repository_register( mlt_repository self, mlt_service_type service_type, const char *service, mlt_register_callback ); -extern void *mlt_repository_create( mlt_repository self, mlt_profile profile, mlt_service_type type, const char *service, void *arg ); +extern void *mlt_repository_create( mlt_repository self, mlt_profile profile, mlt_service_type type, const char *service, const void *arg ); extern void mlt_repository_close( mlt_repository self ); extern mlt_properties mlt_repository_consumers( mlt_repository self ); extern mlt_properties mlt_repository_filters( mlt_repository self ); @@ -65,6 +66,7 @@ extern mlt_properties mlt_repository_transitions( mlt_repository self ); extern void mlt_repository_register_metadata( mlt_repository self, mlt_service_type type, const char *service, mlt_metadata_callback, void *callback_data ); extern mlt_properties mlt_repository_metadata( mlt_repository self, mlt_service_type type, const char *service ); extern mlt_properties mlt_repository_languages( mlt_repository self ); +extern mlt_properties mlt_repository_presets( ); #endif