git.sesse.net Git - mlt/blob - src/framework/mlt_repository.h

   1 /**
   2  * \file mlt_repository.h
   3  * \brief provides a map between service and shared objects
   4  *
   5  * Copyright (C) 2003-2008 Ushodaya Enterprises Limited
   6  * \author Charles Yates <charles.yates@pandora.be>
   7  *         Dan Dennedy <dan@dennedy.org>
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public
  11  * License as published by the Free Software Foundation; either
  12  * version 2.1 of the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with this library; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22  */
  23
  24 #ifndef _MLT_REPOSITORY_H_
  25 #define _MLT_REPOSITORY_H_
  26
  27 #include "mlt_types.h"
  28 #include "mlt_profile.h"
  29
  30 /** Repository structure forward reference.
  31 */
  32
  33 typedef struct mlt_repository_s *mlt_repository;
  34
  35 /** This callback is the main entry point into a module, which must be exported
  36     with the symbol "mlt_register".
  37     Inside the callback, the module registers the additional callbacks below.
  38 */
  39
  40 typedef void ( *mlt_repository_callback )( mlt_repository );
  41
  42 /** These are callback functions that modules implement to construct services
  43     and metadata.
  44 */
  45 typedef void *( *mlt_register_callback )( mlt_profile, mlt_service_type, const char * /* service name */, void * /* arg */ );
  46 typedef mlt_properties ( *mlt_metadata_callback )( mlt_service_type, const char * /* service name */, void * /* callback_data */ );
  47
  48 /** These convenience macros can be used to register services in a more declarative manner.
  49 */
  50 #define MLT_REPOSITORY void mlt_register( mlt_repository repository )
  51 #define MLT_REGISTER( type, service, symbol  ) ( mlt_repository_register( repository, (type), (service), ( mlt_register_callback )(symbol) ) )
  52 #define MLT_REGISTER_METADATA( type, service, callback, data ) ( mlt_repository_register_metadata( repository, (type), (service), ( mlt_metadata_callback )(callback), (data) ) )
  53
  54 /** Public functions.
  55 */
  56
  57 extern mlt_repository mlt_repository_init( const char *directory );
  58 extern void mlt_repository_register( mlt_repository self, mlt_service_type service_type, const char *service, mlt_register_callback );
  59 extern void *mlt_repository_create( mlt_repository self, mlt_profile profile, mlt_service_type type, const char *service, void *arg );
  60 extern void mlt_repository_close( mlt_repository self );
  61 extern mlt_properties mlt_repository_consumers( mlt_repository self );
  62 extern mlt_properties mlt_repository_filters( mlt_repository self );
  63 extern mlt_properties mlt_repository_producers( mlt_repository self );
  64 extern mlt_properties mlt_repository_transitions( mlt_repository self );
  65 extern void mlt_repository_register_metadata( mlt_repository self, mlt_service_type type, const char *service, mlt_metadata_callback, void *callback_data );
  66 extern mlt_properties mlt_repository_metadata( mlt_repository self, mlt_service_type type, const char *service );
  67 extern mlt_properties mlt_repository_languages( mlt_repository self );
  68
  69 #endif
  70