Updates to vid.stab module.

[mlt] / src / framework / mlt_properties.h

diff --git a/src/framework/mlt_properties.h b/src/framework/mlt_properties.h
index abfe8b0df191522fc59a1f08a1805756cdbe328c..f4a44c0e6ca99233de3f80a0d2794e524bd8d873 100644 (file)
--- a/src/framework/mlt_properties.h
+++ b/src/framework/mlt_properties.h
@@ -1,7 +1,11 @@
-/*
- * mlt_properties.h -- base properties class
- * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
- * Author: Charles Yates <charles.yates@pandora.be>
+/**
+ * \file mlt_properties.h
+ * \brief Properties class declaration
+ * \see mlt_properties_s
+ *
+ * Copyright (C) 2003-2013 Ushodaya Enterprises Limited
+ * \author Charles Yates <charles.yates@pandora.be>
+ * \author Dan Dennedy <dan@dennedy.org>
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -25,24 +29,28 @@
 #include "mlt_events.h"
 #include <stdio.h>
 
-/** The properties base class defines the basic property propagation and
-       handling.
-*/
+/** \brief Properties class
+ *
+ * Properties is a combination list/dictionary of name/::mlt_property pairs.
+ * It is also a base class for many of the other MLT classes.
+ */
 
 struct mlt_properties_s
 {
-       void *child;
-       void *local;
+       void *child; /**< \private the object of a subclass */
+       void *local; /**< \private instance object */
+
+       /** the destructor virtual function */
        mlt_destructor close;
-       void *close_object;
+       void *close_object;  /**< the object supplied to the close virtual function */
 };
 
-/** Public interface.
-*/
-
 extern int mlt_properties_init( mlt_properties, void *child );
 extern mlt_properties mlt_properties_new( );
+extern int mlt_properties_set_lcnumeric( mlt_properties, const char *locale );
+extern const char* mlt_properties_get_lcnumeric( mlt_properties self );
 extern mlt_properties mlt_properties_load( const char *file );
+extern int mlt_properties_preset( mlt_properties self, const char *name );
 extern int mlt_properties_inc_ref( mlt_properties self );
 extern int mlt_properties_dec_ref( mlt_properties self );
 extern int mlt_properties_ref_count( mlt_properties self );
@@ -75,5 +83,30 @@ extern void mlt_properties_debug( mlt_properties self, const char *title, FILE *
 extern int mlt_properties_save( mlt_properties, const char * );
 extern int mlt_properties_dir_list( mlt_properties, const char *, const char *, int );
 extern void mlt_properties_close( mlt_properties self );
+extern int mlt_properties_is_sequence( mlt_properties self );
+extern mlt_properties mlt_properties_parse_yaml( const char *file );
+extern char *mlt_properties_serialise_yaml( mlt_properties self );
+extern void mlt_properties_lock( mlt_properties self );
+extern void mlt_properties_unlock( mlt_properties self );
+
+extern char *mlt_properties_get_time( mlt_properties, const char* name, mlt_time_format );
+extern char *mlt_properties_frames_to_time( mlt_properties, mlt_position, mlt_time_format );
+extern mlt_position mlt_properties_time_to_frames( mlt_properties, const char* time );
+
+extern mlt_color mlt_properties_get_color( mlt_properties, const char* name );
+extern int mlt_properties_set_color( mlt_properties, const char* name, mlt_color value );
+
+extern char* mlt_properties_anim_get( mlt_properties self, const char *name, int position, int length );
+extern int mlt_properties_anim_set( mlt_properties self, const char *name, const char *value, int position, int length );
+extern int mlt_properties_anim_get_int( mlt_properties self, const char *name, int position, int length );
+extern int mlt_properties_anim_set_int( mlt_properties self, const char *name, int value, int position, int length, mlt_keyframe_type keyframe_type );
+extern double mlt_properties_anim_get_double( mlt_properties self, const char *name, int position, int length );
+extern int mlt_properties_anim_set_double( mlt_properties self, const char *name, double value, int position, int length, mlt_keyframe_type keyframe_type );
+extern mlt_animation mlt_properties_get_animation( mlt_properties self, const char *name );
+
+extern int mlt_properties_set_rect( mlt_properties self, const char *name, mlt_rect value );
+extern mlt_rect mlt_properties_get_rect( mlt_properties self, const char *name );
+extern int mlt_properties_anim_set_rect( mlt_properties self, const char *name, mlt_rect value, int position, int length, mlt_keyframe_type keyframe_type );
+extern mlt_rect mlt_properties_anim_get_rect( mlt_properties self, const char *name, int position, int length );
 
 #endif