Cleanup license declarations and remove dv1394d references.
[melted] / src / framework / mlt_properties.c
index 972ad93..bb49c85 100644 (file)
@@ -3,19 +3,19 @@
  * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
  * Author: Charles Yates <charles.yates@pandora.be>
  *
- * 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.
+ * 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 program is distributed in the hope that it will be useful,
+ * 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
  */
 
 #include "config.h"
@@ -27,6 +27,9 @@
 #include <string.h>
 #include <ctype.h>
 
+#include <sys/types.h>
+#include <dirent.h>
+
 /* ---------------- // Private Implementation // ---------------- */
 
 /** Private implementation of the property list.
@@ -47,7 +50,7 @@ property_list;
 /** Memory leak checks.
 */
 
-#define _MLT_PROPERTY_CHECKS_
+//#define _MLT_PROPERTY_CHECKS_ 2
 
 #ifdef _MLT_PROPERTY_CHECKS_
 static int properties_created = 0;
@@ -101,7 +104,7 @@ mlt_properties mlt_properties_new( )
 /** Load properties from a file.
 */
 
-mlt_properties mlt_properties_load( char *filename )
+mlt_properties mlt_properties_load( const char *filename )
 {
        // Construct a standalone properties object
        mlt_properties this = mlt_properties_new( );
@@ -116,6 +119,7 @@ mlt_properties mlt_properties_load( char *filename )
                {
                        // Temp string
                        char temp[ 1024 ];
+                       char last[ 1024 ] = "";
 
                        // Read each string from the file
                        while( fgets( temp, 1024, file ) )
@@ -123,6 +127,19 @@ mlt_properties mlt_properties_load( char *filename )
                                // Chomp the string
                                temp[ strlen( temp ) - 1 ] = '\0';
 
+                               // Check if the line starts with a .
+                               if ( temp[ 0 ] == '.' )
+                               {
+                                       char temp2[ 1024 ];
+                                       sprintf( temp2, "%s%s", last, temp );
+                                       strcpy( temp, temp2 );
+                               }
+                               else if ( strchr( temp, '=' ) )
+                               {
+                                       strcpy( last, temp );
+                                       *( strchr( last, '=' ) ) = '\0';
+                               }
+
                                // Parse and set the property
                                if ( strcmp( temp, "" ) && temp[ 0 ] != '#' )
                                        mlt_properties_parse( this, temp );
@@ -137,7 +154,7 @@ mlt_properties mlt_properties_load( char *filename )
        return this;
 }
 
-static inline int generate_hash( char *name )
+static inline int generate_hash( const char *name )
 {
        int hash = 0;
        int i = 1;
@@ -151,7 +168,7 @@ static inline int generate_hash( char *name )
        real producer.
 */
 
-static inline void mlt_properties_do_mirror( mlt_properties this, char *name )
+static inline void mlt_properties_do_mirror( mlt_properties this, const char *name )
 {
        property_list *list = this->local;
        if ( list->mirror != NULL ) 
@@ -188,7 +205,20 @@ int mlt_properties_dec_ref( mlt_properties this )
        return 0;
 }
 
-/** Allow the specification of a mirror.
+/** Return the ref count of this object.
+*/
+
+int mlt_properties_ref_count( mlt_properties this )
+{
+       if ( this != NULL )
+       {
+               property_list *list = this->local;
+               return list->ref_count;
+       }
+       return 0;
+}
+
+/** Mirror properties set on 'this' to 'that'.
 */
 
 void mlt_properties_mirror( mlt_properties this, mlt_properties that )
@@ -219,7 +249,7 @@ int mlt_properties_inherit( mlt_properties this, mlt_properties that )
 /** Pass all properties from 'that' that match the prefix to 'this' (excluding the prefix).
 */
 
-int mlt_properties_pass( mlt_properties this, mlt_properties that, char *prefix )
+int mlt_properties_pass( mlt_properties this, mlt_properties that, const char *prefix )
 {
        int count = mlt_properties_count( that );
        int length = strlen( prefix );
@@ -240,7 +270,7 @@ int mlt_properties_pass( mlt_properties this, mlt_properties that, char *prefix
 /** Locate a property by name
 */
 
-static inline mlt_property mlt_properties_find( mlt_properties this, char *name )
+static inline mlt_property mlt_properties_find( mlt_properties this, const char *name )
 {
        property_list *list = this->local;
        mlt_property value = NULL;
@@ -267,7 +297,7 @@ static inline mlt_property mlt_properties_find( mlt_properties this, char *name
 /** Add a new property.
 */
 
-static mlt_property mlt_properties_add( mlt_properties this, char *name )
+static mlt_property mlt_properties_add( mlt_properties this, const char *name )
 {
        property_list *list = this->local;
        int key = generate_hash( name );
@@ -276,7 +306,7 @@ static mlt_property mlt_properties_add( mlt_properties this, char *name )
        if ( list->count == list->size )
        {
                list->size += 50;
-               list->name = realloc( list->name, list->size * sizeof( char * ) );
+               list->name = realloc( list->name, list->size * sizeof( const char * ) );
                list->value = realloc( list->value, list->size * sizeof( mlt_property ) );
        }
 
@@ -295,7 +325,7 @@ static mlt_property mlt_properties_add( mlt_properties this, char *name )
 /** Fetch a property by name - this includes add if not found.
 */
 
-static mlt_property mlt_properties_fetch( mlt_properties this, char *name )
+static mlt_property mlt_properties_fetch( mlt_properties this, const char *name )
 {
        // Try to find an existing property first
        mlt_property property = mlt_properties_find( this, name );
@@ -308,10 +338,56 @@ static mlt_property mlt_properties_fetch( mlt_properties this, char *name )
        return property;
 }
 
+/** Pass property 'name' from 'that' to 'this' 
+* Who to blame: Zach <zachary.drew@gmail.com>
+*/
+
+void mlt_properties_pass_property( mlt_properties this, mlt_properties that, const char *name )
+{
+       // Make sure the source property isn't null.
+       mlt_property that_prop = mlt_properties_find( that, name );
+       if( that_prop == NULL )
+               return;
+
+       mlt_property_pass( mlt_properties_fetch( this, name ), that_prop );
+}
+
+/** Pass all properties from 'that' to 'this' as found in comma seperated 'list'.
+* Who to blame: Zach <zachary.drew@gmail.com>
+*/
+
+int mlt_properties_pass_list( mlt_properties this, mlt_properties that, const char *list )
+{
+       char *props = strdup( list );
+       char *ptr = props;
+       char *delim = " ,\t\n"; // Any combination of spaces, commas, tabs, and newlines
+       int count, done = 0;
+
+       while( !done )
+       {
+               count = strcspn( ptr, delim );
+
+               if( ptr[count] == '\0' )
+                       done = 1;
+               else
+                       ptr[count] = '\0';      // Make it a real string
+
+               mlt_properties_pass_property( this, that, ptr );
+
+               ptr += count + 1;
+               ptr += strspn( ptr, delim );
+       }
+
+       free( props );
+
+       return 0;
+}
+
+
 /** Set the property.
 */
 
-int mlt_properties_set( mlt_properties this, char *name, char *value )
+int mlt_properties_set( mlt_properties this, const char *name, const char *value )
 {
        int error = 1;
 
@@ -319,12 +395,21 @@ int mlt_properties_set( mlt_properties this, char *name, char *value )
        mlt_property property = mlt_properties_fetch( this, name );
 
        // Set it if not NULL
-       if ( property != NULL && ( value == NULL || value[ 0 ] != '@' ) )
+       if ( property == NULL )
+       {
+               fprintf( stderr, "Whoops - %s not found (should never occur)\n", name );
+       }
+       else if ( value == NULL )
        {
                error = mlt_property_set_string( property, value );
                mlt_properties_do_mirror( this, name );
        }
-       else if ( property != NULL && value[ 0 ] == '@' )
+       else if ( *value != '@' )
+       {
+               error = mlt_property_set_string( property, value );
+               mlt_properties_do_mirror( this, name );
+       }
+       else if ( value[ 0 ] == '@' )
        {
                int total = 0;
                int current = 0;
@@ -381,7 +466,7 @@ int mlt_properties_set( mlt_properties this, char *name, char *value )
 /** Set or default the property.
 */
 
-int mlt_properties_set_or_default( mlt_properties this, char *name, char *value, char *def )
+int mlt_properties_set_or_default( mlt_properties this, const char *name, const char *value, const char *def )
 {
        return mlt_properties_set( this, name, value == NULL ? def : value );
 }
@@ -389,7 +474,7 @@ int mlt_properties_set_or_default( mlt_properties this, char *name, char *value,
 /** Get a string value by name.
 */
 
-char *mlt_properties_get( mlt_properties this, char *name )
+char *mlt_properties_get( mlt_properties this, const char *name )
 {
        mlt_property value = mlt_properties_find( this, name );
        return value == NULL ? NULL : mlt_property_get_string( value );
@@ -440,7 +525,7 @@ int mlt_properties_count( mlt_properties this )
 /** Set a value by parsing a name=value string
 */
 
-int mlt_properties_parse( mlt_properties this, char *namevalue )
+int mlt_properties_parse( mlt_properties this, const char *namevalue )
 {
        char *name = strdup( namevalue );
        char *value = NULL;
@@ -479,7 +564,7 @@ int mlt_properties_parse( mlt_properties this, char *namevalue )
 /** Get a value associated to the name.
 */
 
-int mlt_properties_get_int( mlt_properties this, char *name )
+int mlt_properties_get_int( mlt_properties this, const char *name )
 {
        mlt_property value = mlt_properties_find( this, name );
        return value == NULL ? 0 : mlt_property_get_int( value );
@@ -488,7 +573,7 @@ int mlt_properties_get_int( mlt_properties this, char *name )
 /** Set a value associated to the name.
 */
 
-int mlt_properties_set_int( mlt_properties this, char *name, int value )
+int mlt_properties_set_int( mlt_properties this, const char *name, int value )
 {
        int error = 1;
 
@@ -510,7 +595,38 @@ int mlt_properties_set_int( mlt_properties this, char *name, int value )
 /** Get a value associated to the name.
 */
 
-double mlt_properties_get_double( mlt_properties this, char *name )
+int64_t mlt_properties_get_int64( mlt_properties this, const char *name )
+{
+       mlt_property value = mlt_properties_find( this, name );
+       return value == NULL ? 0 : mlt_property_get_int64( value );
+}
+
+/** Set a value associated to the name.
+*/
+
+int mlt_properties_set_int64( mlt_properties this, const char *name, int64_t value )
+{
+       int error = 1;
+
+       // Fetch the property to work with
+       mlt_property property = mlt_properties_fetch( this, name );
+
+       // Set it if not NULL
+       if ( property != NULL )
+       {
+               error = mlt_property_set_int64( property, value );
+               mlt_properties_do_mirror( this, name );
+       }
+
+       mlt_events_fire( this, "property-changed", name, NULL );
+
+       return error;
+}
+
+/** Get a value associated to the name.
+*/
+
+double mlt_properties_get_double( mlt_properties this, const char *name )
 {
        mlt_property value = mlt_properties_find( this, name );
        return value == NULL ? 0 : mlt_property_get_double( value );
@@ -519,7 +635,7 @@ double mlt_properties_get_double( mlt_properties this, char *name )
 /** Set a value associated to the name.
 */
 
-int mlt_properties_set_double( mlt_properties this, char *name, double value )
+int mlt_properties_set_double( mlt_properties this, const char *name, double value )
 {
        int error = 1;
 
@@ -541,7 +657,7 @@ int mlt_properties_set_double( mlt_properties this, char *name, double value )
 /** Get a value associated to the name.
 */
 
-mlt_position mlt_properties_get_position( mlt_properties this, char *name )
+mlt_position mlt_properties_get_position( mlt_properties this, const char *name )
 {
        mlt_property value = mlt_properties_find( this, name );
        return value == NULL ? 0 : mlt_property_get_position( value );
@@ -550,7 +666,7 @@ mlt_position mlt_properties_get_position( mlt_properties this, char *name )
 /** Set a value associated to the name.
 */
 
-int mlt_properties_set_position( mlt_properties this, char *name, mlt_position value )
+int mlt_properties_set_position( mlt_properties this, const char *name, mlt_position value )
 {
        int error = 1;
 
@@ -572,7 +688,7 @@ int mlt_properties_set_position( mlt_properties this, char *name, mlt_position v
 /** Get a value associated to the name.
 */
 
-void *mlt_properties_get_data( mlt_properties this, char *name, int *length )
+void *mlt_properties_get_data( mlt_properties this, const char *name, int *length )
 {
        mlt_property value = mlt_properties_find( this, name );
        return value == NULL ? NULL : mlt_property_get_data( value, length );
@@ -581,7 +697,7 @@ void *mlt_properties_get_data( mlt_properties this, char *name, int *length )
 /** Set a value associated to the name.
 */
 
-int mlt_properties_set_data( mlt_properties this, char *name, void *value, int length, mlt_destructor destroy, mlt_serialiser serialise )
+int mlt_properties_set_data( mlt_properties this, const char *name, void *value, int length, mlt_destructor destroy, mlt_serialiser serialise )
 {
        int error = 1;
 
@@ -600,7 +716,7 @@ int mlt_properties_set_data( mlt_properties this, char *name, void *value, int l
 /** Rename a property.
 */
 
-int mlt_properties_rename( mlt_properties this, char *source, char *dest )
+int mlt_properties_rename( mlt_properties this, const char *source, const char *dest )
 {
        mlt_property value = mlt_properties_find( this, dest );
 
@@ -637,9 +753,10 @@ void mlt_properties_dump( mlt_properties this, FILE *output )
                        fprintf( output, "%s=%s\n", list->name[ i ], mlt_properties_get( this, list->name[ i ] ) );
 }
 
-void mlt_properties_debug( mlt_properties this, char *title, FILE *output )
+void mlt_properties_debug( mlt_properties this, const char *title, FILE *output )
 {
-       fprintf( stderr, "%s: ", title );
+       if ( output == NULL ) output = stderr;
+       fprintf( output, "%s: ", title );
        if ( this != NULL )
        {
                property_list *list = this->local;
@@ -648,9 +765,101 @@ void mlt_properties_debug( mlt_properties this, char *title, FILE *output )
                for ( i = 0; i < list->count; i ++ )
                        if ( mlt_properties_get( this, list->name[ i ] ) != NULL )
                                fprintf( output, ", %s=%s", list->name[ i ], mlt_properties_get( this, list->name[ i ] ) );
+                       else
+                               fprintf( output, ", %s=%p", list->name[ i ], mlt_properties_get_data( this, list->name[ i ], NULL ) );
                fprintf( output, " ]" );
        }
-       fprintf( stderr, "\n" );
+       fprintf( output, "\n" );
+}
+
+int mlt_properties_save( mlt_properties this, const char *filename )
+{
+       int error = 1;
+       FILE *f = fopen( filename, "w" );
+       if ( f != NULL )
+       {
+               mlt_properties_dump( this, f );
+               fclose( f );
+               error = 0;
+       }
+       return error;
+}
+
+/* This is a very basic cross platform fnmatch replacement - it will fail in
+** many cases, but for the basic *.XXX and YYY*.XXX, it will work ok.
+*/
+
+static int mlt_fnmatch( const char *wild, const char *file )
+{
+       int f = 0;
+       int w = 0;
+
+       while( f < strlen( file ) && w < strlen( wild ) )
+       {
+               if ( wild[ w ] == '*' )
+               {
+                       w ++;
+                       if ( w == strlen( wild ) )
+                               f = strlen( file );
+                       while ( f != strlen( file ) && tolower( file[ f ] ) != tolower( wild[ w ] ) )
+                               f ++;
+               }
+               else if ( wild[ w ] == '?' || tolower( file[ f ] ) == tolower( wild[ w ] ) )
+               {
+                       f ++;
+                       w ++;
+               }
+               else if ( wild[ 0 ] == '*' )
+               {
+                       w = 0;
+               }
+               else
+               {
+                       return 0;
+               }
+       }
+
+       return strlen( file ) == f &&  strlen( wild ) == w;
+}
+
+static int mlt_compare( const void *this, const void *that )
+{
+       return strcmp( mlt_property_get_string( *( mlt_property * )this ), mlt_property_get_string( *( mlt_property * )that ) );
+}
+
+/* Obtains an optionally sorted list of the files found in a directory with a specific wild card.
+ * Entries in the list have a numeric name (running from 0 to count - 1). Only values change
+ * position if sort is enabled. Designed to be posix compatible (linux, os/x, mingw etc).
+ */
+
+int mlt_properties_dir_list( mlt_properties this, const char *dirname, const char *pattern, int sort )
+{
+       DIR *dir = opendir( dirname );
+
+       if ( dir )
+       {
+               char key[ 20 ];
+               struct dirent *de = readdir( dir );
+               char fullname[ 1024 ];
+               while( de != NULL )
+               {
+                       sprintf( key, "%d", mlt_properties_count( this ) );
+                       snprintf( fullname, 1024, "%s/%s", dirname, de->d_name );
+                       if ( de->d_name[ 0 ] != '.' && mlt_fnmatch( pattern, de->d_name ) )
+                               mlt_properties_set( this, key, fullname );
+                       de = readdir( dir );
+               }
+
+               closedir( dir );
+       }
+
+       if ( sort && mlt_properties_count( this ) )
+       {
+               property_list *list = this->local;
+               qsort( list->value, mlt_properties_count( this ), sizeof( mlt_property ), mlt_compare );
+       }
+
+       return mlt_properties_count( this );
 }
 
 /** Close the list.
@@ -669,10 +878,12 @@ void mlt_properties_close( mlt_properties this )
                        property_list *list = this->local;
                        int index = 0;
 
-#ifdef _MLT_PROPERTY_CHECKS_
+#if _MLT_PROPERTY_CHECKS_ == 1
                        // Show debug info
                        mlt_properties_debug( this, "Closing", stderr );
+#endif
 
+#ifdef _MLT_PROPERTY_CHECKS_
                        // Increment destroyed count
                        properties_destroyed ++;