Merge ../mlt
[melted] / src / framework / mlt_factory.h
index f2a9d22..29dc62a 100644 (file)
@@ -1,7 +1,9 @@
-/*
- * mlt_factory.h -- the factory method interfaces
- * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
- * Author: Charles Yates <charles.yates@pandora.be>
+/**
+ * \file mlt_factory.h
+ * \brief the factory method interfaces
+ *
+ * Copyright (C) 2003-2009 Ushodaya Enterprises Limited
+ * \author Charles Yates <charles.yates@pandora.be>
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
 #include "mlt_profile.h"
 #include "mlt_repository.h"
 
+/**
+ * \event \em producer-create-request fired when mlt_factory_producer is called
+ * \event \em producer-create-done fired when a producer registers itself
+ * \event \em filter-create-request fired when mlt_factory_filter is called
+ * \event \em filter-create-done fired when a filter registers itself
+ * \event \em transition-create-request fired when mlt_factory_transition is called
+ * \event \em transition-create-done fired when a transition registers itself
+ * \event \em consumer-create-request fired when mlt_factory_consumer is called
+ * \event \em consumer-create-done fired when a consumer registers itself
+ */
+
 extern mlt_repository mlt_factory_init( const char *directory );
 extern const char *mlt_factory_directory( );
 extern char *mlt_environment( const char *name );
 extern int mlt_environment_set( const char *name, const char *value );
 extern mlt_properties mlt_factory_event_object( );
-extern mlt_producer mlt_factory_producer( mlt_profile profile, const char *name, void *input );
-extern mlt_filter mlt_factory_filter( mlt_profile profile, const char *name, void *input );
-extern mlt_transition mlt_factory_transition( mlt_profile profile, const char *name, void *input );
-extern mlt_consumer mlt_factory_consumer( mlt_profile profile, const char *name, void *input );
+extern mlt_producer mlt_factory_producer( mlt_profile profile, const char *name, const void *input );
+extern mlt_filter mlt_factory_filter( mlt_profile profile, const char *name, const void *input );
+extern mlt_transition mlt_factory_transition( mlt_profile profile, const char *name, const void *input );
+extern mlt_consumer mlt_factory_consumer( mlt_profile profile, const char *name, const void *input );
 extern void mlt_factory_register_for_clean_up( void *ptr, mlt_destructor destructor );
 extern void mlt_factory_close( );
+extern mlt_properties mlt_global_properties( );
 
 #endif