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

   1 /*
   2  * mlt_properties.h -- base properties class
   3  * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
   4  * Author: Charles Yates <charles.yates@pandora.be>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  19  */
  20
  21 #ifndef _MLT_PROPERTIES_H_
  22 #define _MLT_PROPERTIES_H_
  23
  24 #include "mlt_types.h"
  25 #include "mlt_events.h"
  26 #include <stdio.h>
  27
  28 /** The properties base class defines the basic property propagation and
  29         handling.
  30 */
  31
  32 struct mlt_properties_s
  33 {
  34         void *child;
  35         void *local;
  36         mlt_destructor close;
  37         void *close_object;
  38 };
  39
  40 /** Public interface.
  41 */
  42
  43 extern int mlt_properties_init( mlt_properties, void *child );
  44 extern mlt_properties mlt_properties_new( );
  45 extern mlt_properties mlt_properties_load( const char *file );
  46 extern int mlt_properties_inc_ref( mlt_properties self );
  47 extern int mlt_properties_dec_ref( mlt_properties self );
  48 extern int mlt_properties_ref_count( mlt_properties self );
  49 extern void mlt_properties_mirror( mlt_properties self, mlt_properties that );
  50 extern int mlt_properties_inherit( mlt_properties self, mlt_properties that );
  51 extern int mlt_properties_pass( mlt_properties self, mlt_properties that, const char *prefix );
  52 extern void mlt_properties_pass_property( mlt_properties self, mlt_properties that, const char *name );
  53 extern int mlt_properties_pass_list( mlt_properties self, mlt_properties that, const char *list );
  54 extern int mlt_properties_set( mlt_properties self, const char *name, const char *value );
  55 extern int mlt_properties_set_or_default( mlt_properties self, const char *name, const char *value, const char *def );
  56 extern int mlt_properties_parse( mlt_properties self, const char *namevalue );
  57 extern char *mlt_properties_get( mlt_properties self, const char *name );
  58 extern char *mlt_properties_get_name( mlt_properties self, int index );
  59 extern char *mlt_properties_get_value( mlt_properties self, int index );
  60 extern void *mlt_properties_get_data_at( mlt_properties self, int index, int *size );
  61 extern int mlt_properties_get_int( mlt_properties self, const char *name );
  62 extern int mlt_properties_set_int( mlt_properties self, const char *name, int value );
  63 extern int64_t mlt_properties_get_int64( mlt_properties self, const char *name );
  64 extern int mlt_properties_set_int64( mlt_properties self, const char *name, int64_t value );
  65 extern double mlt_properties_get_double( mlt_properties self, const char *name );
  66 extern int mlt_properties_set_double( mlt_properties self, const char *name, double value );
  67 extern mlt_position mlt_properties_get_position( mlt_properties self, const char *name );
  68 extern int mlt_properties_set_position( mlt_properties self, const char *name, mlt_position value );
  69 extern int mlt_properties_set_data( mlt_properties self, const char *name, void *value, int length, mlt_destructor, mlt_serialiser );
  70 extern void *mlt_properties_get_data( mlt_properties self, const char *name, int *length );
  71 extern int mlt_properties_rename( mlt_properties self, const char *source, const char *dest );
  72 extern int mlt_properties_count( mlt_properties self );
  73 extern void mlt_properties_dump( mlt_properties self, FILE *output );
  74 extern void mlt_properties_debug( mlt_properties self, const char *title, FILE *output );
  75 extern int mlt_properties_save( mlt_properties, const char * );
  76 extern int mlt_properties_dir_list( mlt_properties, const char *, const char *, int );
  77 extern void mlt_properties_close( mlt_properties self );
  78
  79 #endif