Add doxygen documentation for mlt_profile, mlt_pool, mlt_repository, and mlt_factory.

[mlt] / src / framework / mlt_repository.h

diff --git a/src/framework/mlt_repository.h b/src/framework/mlt_repository.h
index afab1cc808c08cee2f30a01064cb4cc744d81947..428efc87422602237927420428fbb8cbde25a4bd 100644 (file)
--- a/src/framework/mlt_repository.h
+++ b/src/framework/mlt_repository.h
@@ -1,37 +1,71 @@
-/*
- * repository.h -- 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.h
+ * \brief provides a map between service and shared objects
+ * \see mlt_repository_s
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
+ * Copyright (C) 2003-2009 Ushodaya Enterprises Limited
+ * \author Charles Yates <charles.yates@pandora.be>
+ * \author Dan Dennedy <dan@dennedy.org>
  *
- * This program is distributed in the hope that it will be useful,
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software Foundation,
- * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
 #ifndef _MLT_REPOSITORY_H_
 #define _MLT_REPOSITORY_H_
 
-/** Repository structure forward reference.
-*/
+#include "mlt_types.h"
+#include "mlt_profile.h"
+
+/** 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.
+ */
+
+typedef void ( *mlt_repository_callback )( mlt_repository );
+
+/** The callback function that modules implement to construct a service.
+ */
+
+typedef void *( *mlt_register_callback )( mlt_profile, mlt_service_type, const char * /* service name */, 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 */ );
+
+/** A convenience macro to create an entry point for service registration. */
+#define MLT_REPOSITORY void mlt_register( mlt_repository repository )
 
-typedef struct mlt_repository_s *mlt_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) ) )
 
-/** 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( char *file, char *symbol );
-extern void *mlt_repository_fetch( mlt_repository this, char *service, void *input );
-extern void mlt_repository_close( mlt_repository this );
+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_close( mlt_repository self );
+extern mlt_properties mlt_repository_consumers( mlt_repository self );
+extern mlt_properties mlt_repository_filters( mlt_repository self );
+extern mlt_properties mlt_repository_producers( mlt_repository self );
+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 );
 
 #endif