2 * \file mlt_properties.c
3 * \brief Properties class definition
4 * \see mlt_properties_s
6 * Copyright (C) 2003-2009 Ushodaya Enterprises Limited
7 * \author Charles Yates <charles.yates@pandora.be>
8 * \author Dan Dennedy <dan@dennedy.org>
10 * This library is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Lesser General Public
12 * License as published by the Free Software Foundation; either
13 * version 2.1 of the License, or (at your option) any later version.
15 * This library is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with this library; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 #include "mlt_properties.h"
26 #include "mlt_property.h"
27 #include "mlt_deque.h"
29 #include "mlt_factory.h"
37 #include <sys/types.h>
43 #define PRESETS_DIR "/presets"
45 /** \brief private implementation of the property list */
54 mlt_properties mirror;
56 pthread_mutex_t mutex;
61 /* Memory leak checks */
63 //#define _MLT_PROPERTY_CHECKS_ 2
64 #ifdef _MLT_PROPERTY_CHECKS_
65 static int properties_created = 0;
66 static int properties_destroyed = 0;
69 /** Initialize a properties object that was already allocated.
71 * This does allocate its ::property_list, and it adds a reference count.
72 * \public \memberof mlt_properties_s
73 * \param self the properties structure to initialize
74 * \param child an opaque pointer to a subclass object
75 * \return true if failed
78 int mlt_properties_init( mlt_properties self, void *child )
82 #ifdef _MLT_PROPERTY_CHECKS_
83 // Increment number of properties created
84 properties_created ++;
88 memset( self, 0, sizeof( struct mlt_properties_s ) );
90 // Assign the child of the object
93 // Allocate the local structure
94 self->local = calloc( 1, sizeof( property_list ) );
96 // Increment the ref count
97 ( ( property_list * )self->local )->ref_count = 1;
98 pthread_mutex_init( &( ( property_list * )self->local )->mutex, NULL );;
101 // Check that initialisation was successful
102 return self != NULL && self->local == NULL;
105 /** Create a properties object.
107 * This allocates the properties structure and calls mlt_properties_init() on it.
108 * Free the properties object with mlt_properties_close().
109 * \public \memberof mlt_properties_s
110 * \return a new properties object
113 mlt_properties mlt_properties_new( )
115 // Construct a standalone properties object
116 mlt_properties self = calloc( 1, sizeof( struct mlt_properties_s ) );
119 mlt_properties_init( self, NULL );
121 // Return the pointer
125 /** Set the numeric locale used for string/double conversions.
127 * \public \memberof mlt_properties_s
128 * \param self a properties list
129 * \param locale the locale name
130 * \return true if error
133 int mlt_properties_set_lcnumeric( mlt_properties self, const char *locale )
137 if ( self && locale )
139 property_list *list = self->local;
141 #if defined(__linux__) || defined(__DARWIN__)
143 freelocale( list->locale );
144 list->locale = newlocale( LC_NUMERIC_MASK, locale, NULL );
146 error = list->locale == NULL;
154 /** Get the numeric locale for this properties object.
156 * Do not free the result.
157 * \public \memberof mlt_properties_s
158 * \param self a properties list
159 * \return the locale name if this properties has a specific locale it is using, NULL otherwise
162 const char* mlt_properties_get_lcnumeric( mlt_properties self )
164 property_list *list = self->local;
165 const char *result = NULL;
169 #if defined(__DARWIN__)
170 result = querylocale( LC_NUMERIC, list->locale );
171 #elif defined(__linux__)
172 result = list->locale->__names[ LC_NUMERIC ];
174 // TODO: not yet sure what to do on other platforms
180 static int load_properties( mlt_properties self, const char *filename )
183 FILE *file = fopen( filename, "r" );
185 // Load contents of file
190 char last[ 1024 ] = "";
192 // Read each string from the file
193 while( fgets( temp, 1024, file ) )
195 // Chomp the new line character from the string
196 int x = strlen( temp ) - 1;
197 if ( temp[x] == '\n' || temp[x] == '\r' )
200 // Check if the line starts with a .
201 if ( temp[ 0 ] == '.' )
204 sprintf( temp2, "%s%s", last, temp );
205 strcpy( temp, temp2 );
207 else if ( strchr( temp, '=' ) )
209 strcpy( last, temp );
210 *( strchr( last, '=' ) ) = '\0';
213 // Parse and set the property
214 if ( strcmp( temp, "" ) && temp[ 0 ] != '#' )
215 mlt_properties_parse( self, temp );
221 return file? 0 : errno;
224 /** Create a properties object by reading a .properties text file.
226 * Free the properties object with mlt_properties_close().
227 * \deprecated Please start using mlt_properties_parse_yaml().
228 * \public \memberof mlt_properties_s
229 * \param filename the absolute file name
230 * \return a new properties object
233 mlt_properties mlt_properties_load( const char *filename )
235 // Construct a standalone properties object
236 mlt_properties self = mlt_properties_new( );
239 load_properties( self, filename );
241 // Return the pointer
245 /** Set properties from a preset.
247 * Presets are typically installed to $prefix/share/mlt/presets/{type}/{service}/[{profile}/]{name}.
248 * For example, "/usr/share/mlt/presets/consumer/avformat/dv_ntsc_wide/DVD"
249 * could be an encoding preset for a widescreen NTSC DVD Video.
250 * Do not specify the type and service in the preset name parameter; these are
251 * inferred automatically from the service to which you are applying the preset.
252 * Using the example above and assuming you are calling this function on the
253 * avformat consumer, the name passed to the function should simply be DVD.
254 * Note that the profile portion of the path is optional, but a profile-specific
255 * preset with the same name as a more generic one is given a higher priority.
256 * \todo Look in a user-specific location - somewhere in the home directory.
258 * \public \memberof mlt_properties_s
259 * \param self a properties list
260 * \param name the name of a preset in a well-known location or the explicit path
261 * \return true if error
264 int mlt_properties_preset( mlt_properties self, const char *name )
266 struct stat stat_buff;
269 if ( !( self && name && strlen( name ) ) )
272 // See if name is an explicit file
273 if ( ! stat( name, &stat_buff ) )
275 return load_properties( self, name );
279 // Look for profile-specific preset before a generic one.
280 char *data = getenv( "MLT_PRESETS_PATH" );
281 const char *type = mlt_properties_get( self, "mlt_type" );
282 const char *service = mlt_properties_get( self, "mlt_service" );
283 const char *profile = mlt_environment( "MLT_PROFILE" );
288 data = strdup( data );
292 data = malloc( strlen( mlt_environment( "MLT_DATA" ) ) + strlen( PRESETS_DIR ) + 1 );
293 strcpy( data, mlt_environment( "MLT_DATA" ) );
294 strcat( data, PRESETS_DIR );
296 if ( data && type && service )
298 char *path = malloc( 5 + strlen(name) + strlen(data) + strlen(type) + strlen(service) + ( profile? strlen(profile) : 0 ) );
299 sprintf( path, "%s/%s/%s/%s/%s", data, type, service, profile, name );
300 if ( load_properties( self, path ) )
302 sprintf( path, "%s/%s/%s/%s", data, type, service, name );
303 error = load_properties( self, path );
316 /** Generate a hash key.
318 * \private \memberof mlt_properties_s
319 * \param name a string
323 static inline int generate_hash( const char *name )
328 hash = ( hash + ( i ++ * ( *name ++ & 31 ) ) ) % 199;
332 /** Copy a serializable property to a properties list that is mirroring this one.
334 * Special case - when a container (such as loader) is protecting another
335 * producer, we need to ensure that properties are passed through to the
337 * \private \memberof mlt_properties_s
338 * \param self a properties list
339 * \param name the name of the property to copy
342 static inline void mlt_properties_do_mirror( mlt_properties self, const char *name )
344 property_list *list = self->local;
345 if ( list->mirror != NULL )
347 char *value = mlt_properties_get( self, name );
349 mlt_properties_set( list->mirror, name, value );
353 /** Increment the reference count.
355 * \public \memberof mlt_properties_s
356 * \param self a properties list
357 * \return the new reference count
360 int mlt_properties_inc_ref( mlt_properties self )
365 property_list *list = self->local;
366 pthread_mutex_lock( &list->mutex );
367 result = ++ list->ref_count;
368 pthread_mutex_unlock( &list->mutex );
373 /** Decrement the reference count.
375 * \public \memberof mlt_properties_s
376 * \param self a properties list
377 * \return the new reference count
380 int mlt_properties_dec_ref( mlt_properties self )
385 property_list *list = self->local;
386 pthread_mutex_lock( &list->mutex );
387 result = -- list->ref_count;
388 pthread_mutex_unlock( &list->mutex );
393 /** Get the reference count.
395 * \public \memberof mlt_properties_s
396 * \param self a properties list
397 * \return the current reference count
400 int mlt_properties_ref_count( mlt_properties self )
404 property_list *list = self->local;
405 return list->ref_count;
410 /** Set a properties list to be a mirror copy of another.
412 * Note that this does not copy all existing properties. Rather, you must
413 * call this before setting the properties that you wish to copy.
414 * \public \memberof mlt_properties_s
415 * \param that the properties which will receive copies of the properties as they are set.
416 * \param self the properties to mirror
419 void mlt_properties_mirror( mlt_properties self, mlt_properties that )
421 property_list *list = self->local;
425 /** Copy all serializable properties to another properties list.
427 * \public \memberof mlt_properties_s
428 * \param self The properties to copy to
429 * \param that The properties to copy from
433 int mlt_properties_inherit( mlt_properties self, mlt_properties that )
435 int count = mlt_properties_count( that );
437 for ( i = 0; i < count; i ++ )
439 char *value = mlt_properties_get_value( that, i );
442 char *name = mlt_properties_get_name( that, i );
443 mlt_properties_set( self, name, value );
449 /** Pass all serializable properties that match a prefix to another properties object
451 * \public \memberof mlt_properties_s
452 * \param self the properties to copy to
453 * \param that The properties to copy from
454 * \param prefix the property names to match (required)
458 int mlt_properties_pass( mlt_properties self, mlt_properties that, const char *prefix )
460 int count = mlt_properties_count( that );
461 int length = strlen( prefix );
463 for ( i = 0; i < count; i ++ )
465 char *name = mlt_properties_get_name( that, i );
466 if ( !strncmp( name, prefix, length ) )
468 char *value = mlt_properties_get_value( that, i );
470 mlt_properties_set( self, name + length, value );
476 /** Locate a property by name.
478 * \private \memberof mlt_properties_s
479 * \param self a properties list
480 * \param name the property to lookup by name
481 * \return the property or NULL for failure
484 static inline mlt_property mlt_properties_find( mlt_properties self, const char *name )
486 property_list *list = self->local;
487 mlt_property value = NULL;
488 int key = generate_hash( name );
490 mlt_properties_lock( self );
492 int i = list->hash[ key ] - 1;
495 // Check if we're hashed
496 if ( list->count > 0 &&
497 name[ 0 ] == list->name[ i ][ 0 ] &&
498 !strcmp( list->name[ i ], name ) )
499 value = list->value[ i ];
502 for ( i = list->count - 1; value == NULL && i >= 0; i -- )
503 if ( name[ 0 ] == list->name[ i ][ 0 ] && !strcmp( list->name[ i ], name ) )
504 value = list->value[ i ];
506 mlt_properties_unlock( self );
511 /** Add a new property.
513 * \private \memberof mlt_properties_s
514 * \param self a properties list
515 * \param name the name of the new property
516 * \return the new property
519 static mlt_property mlt_properties_add( mlt_properties self, const char *name )
521 property_list *list = self->local;
522 int key = generate_hash( name );
525 mlt_properties_lock( self );
527 // Check that we have space and resize if necessary
528 if ( list->count == list->size )
531 list->name = realloc( list->name, list->size * sizeof( const char * ) );
532 list->value = realloc( list->value, list->size * sizeof( mlt_property ) );
535 // Assign name/value pair
536 list->name[ list->count ] = strdup( name );
537 list->value[ list->count ] = mlt_property_init( );
539 // Assign to hash table
540 if ( list->hash[ key ] == 0 )
541 list->hash[ key ] = list->count + 1;
543 // Return and increment count accordingly
544 result = list->value[ list->count ++ ];
546 mlt_properties_unlock( self );
551 /** Fetch a property by name and add one if not found.
553 * \private \memberof mlt_properties_s
554 * \param self a properties list
555 * \param name the property to lookup or add
556 * \return the property
559 static mlt_property mlt_properties_fetch( mlt_properties self, const char *name )
561 // Try to find an existing property first
562 mlt_property property = mlt_properties_find( self, name );
564 // If it wasn't found, create one
565 if ( property == NULL )
566 property = mlt_properties_add( self, name );
568 // Return the property
572 /** Copy a property to another properties list.
574 * \public \memberof mlt_properties_s
575 * \author Zach <zachary.drew@gmail.com>
576 * \param self the properties to copy to
577 * \param that the properties to copy from
578 * \param name the name of the property to copy
581 void mlt_properties_pass_property( mlt_properties self, mlt_properties that, const char *name )
583 // Make sure the source property isn't null.
584 mlt_property that_prop = mlt_properties_find( that, name );
585 if( that_prop == NULL )
588 mlt_property_pass( mlt_properties_fetch( self, name ), that_prop );
591 /** Copy all properties specified in a comma-separated list to another properties list.
593 * White space is also a delimiter.
594 * \public \memberof mlt_properties_s
595 * \author Zach <zachary.drew@gmail.com>
596 * \param self the properties to copy to
597 * \param that the properties to copy from
598 * \param list a delimited list of property names
603 int mlt_properties_pass_list( mlt_properties self, mlt_properties that, const char *list )
605 char *props = strdup( list );
607 const char *delim = " ,\t\n"; // Any combination of spaces, commas, tabs, and newlines
612 count = strcspn( ptr, delim );
614 if( ptr[count] == '\0' )
617 ptr[count] = '\0'; // Make it a real string
619 mlt_properties_pass_property( self, that, ptr );
623 ptr += strspn( ptr, delim );
632 /** Set a property to a string.
634 * The property name "properties" is reserved to load the preset in \p value.
635 * When the value begins with '@' then it is interpreted as a very simple math
636 * expression containing only the +, -, *, and / operators.
637 * The event "property-changed" is fired after the property has been set.
639 * This makes a copy of the string value you supply.
640 * \public \memberof mlt_properties_s
641 * \param self a properties list
642 * \param name the property to set
643 * \param value the property's new value
644 * \return true if error
647 int mlt_properties_set( mlt_properties self, const char *name, const char *value )
651 // Fetch the property to work with
652 mlt_property property = mlt_properties_fetch( self, name );
654 // Set it if not NULL
655 if ( property == NULL )
657 mlt_log( NULL, MLT_LOG_FATAL, "Whoops - %s not found (should never occur)\n", name );
659 else if ( value == NULL )
661 error = mlt_property_set_string( property, value );
662 mlt_properties_do_mirror( self, name );
664 else if ( *value != '@' )
666 error = mlt_property_set_string( property, value );
667 mlt_properties_do_mirror( self, name );
668 if ( !strcmp( name, "properties" ) )
669 mlt_properties_preset( self, value );
671 else if ( value[ 0 ] == '@' )
680 while ( *value != '\0' )
682 int length = strcspn( value, "+-*/" );
684 // Get the identifier
685 strncpy( id, value, length );
689 // Determine the value
690 if ( isdigit( id[ 0 ] ) )
691 current = atof( id );
693 current = mlt_properties_get_double( self, id );
695 // Apply the operation
708 total = total / current;
713 op = *value != '\0' ? *value ++ : ' ';
716 error = mlt_property_set_double( property, total );
717 mlt_properties_do_mirror( self, name );
720 mlt_events_fire( self, "property-changed", name, NULL );
725 /** Set or default a property to a string.
727 * This makes a copy of the string value you supply.
728 * \public \memberof mlt_properties_s
729 * \param self a properties list
730 * \param name the property to set
731 * \param value the string value to set or NULL to use the default
732 * \param def the default string if value is NULL
733 * \return true if error
736 int mlt_properties_set_or_default( mlt_properties self, const char *name, const char *value, const char *def )
738 return mlt_properties_set( self, name, value == NULL ? def : value );
741 /** Get a string value by name.
743 * Do not free the returned string. It's lifetime is controlled by the property
744 * and this properties object.
745 * \public \memberof mlt_properties_s
746 * \param self a properties list
747 * \param name the property to get
748 * \return the property's string value or NULL if it does not exist
751 char *mlt_properties_get( mlt_properties self, const char *name )
753 mlt_property value = mlt_properties_find( self, name );
754 property_list *list = self->local;
755 return value == NULL ? NULL : mlt_property_get_string_l( value, list->locale );
758 /** Get a property name by index.
760 * Do not free the returned string.
761 * \public \memberof mlt_properties_s
762 * \param self a properties list
763 * \param index the numeric index of the property
764 * \return the name of the property or NULL if index is out of range
767 char *mlt_properties_get_name( mlt_properties self, int index )
769 property_list *list = self->local;
770 if ( index >= 0 && index < list->count )
771 return list->name[ index ];
775 /** Get a property's string value by index.
777 * Do not free the returned string.
778 * \public \memberof mlt_properties_s
779 * \param self a properties list
780 * \param index the numeric index of the property
781 * \return the property value as a string or NULL if the index is out of range
784 char *mlt_properties_get_value( mlt_properties self, int index )
786 property_list *list = self->local;
787 if ( index >= 0 && index < list->count )
788 return mlt_property_get_string_l( list->value[ index ], list->locale );
792 /** Get a data value by index.
794 * Do not free the returned pointer if you supplied a destructor function when you
796 * \public \memberof mlt_properties_s
797 * \param self a properties list
798 * \param index the numeric index of the property
799 * \param[out] size the size of the binary data in bytes or NULL if the index is out of range
802 void *mlt_properties_get_data_at( mlt_properties self, int index, int *size )
804 property_list *list = self->local;
805 if ( index >= 0 && index < list->count )
806 return mlt_property_get_data( list->value[ index ], size );
810 /** Return the number of items in the list.
812 * \public \memberof mlt_properties_s
813 * \param self a properties list
814 * \return the number of property objects
817 int mlt_properties_count( mlt_properties self )
819 property_list *list = self->local;
823 /** Set a value by parsing a name=value string.
825 * \public \memberof mlt_properties_s
826 * \param self a properties list
827 * \param namevalue a string containing name and value delimited by '='
828 * \return true if there was an error
831 int mlt_properties_parse( mlt_properties self, const char *namevalue )
833 char *name = strdup( namevalue );
836 char *ptr = strchr( name, '=' );
844 value = strdup( ptr );
849 value = strdup( ptr );
850 if ( value != NULL && value[ strlen( value ) - 1 ] == '\"' )
851 value[ strlen( value ) - 1 ] = '\0';
856 value = strdup( "" );
859 error = mlt_properties_set( self, name, value );
867 /** Get an integer associated to the name.
869 * \public \memberof mlt_properties_s
870 * \param self a properties list
871 * \param name the property to get
872 * \return The integer value, 0 if not found (which may also be a legitimate value)
875 int mlt_properties_get_int( mlt_properties self, const char *name )
877 mlt_profile profile = mlt_properties_get_data( self, "_profile", NULL );
878 double fps = mlt_profile_fps( profile );
879 property_list *list = self->local;
880 mlt_property value = mlt_properties_find( self, name );
881 return value == NULL ? 0 : mlt_property_get_int( value, fps, list->locale );
884 /** Set a property to an integer value.
886 * \public \memberof mlt_properties_s
887 * \param self a properties list
888 * \param name the property to set
889 * \param value the integer
890 * \return true if error
893 int mlt_properties_set_int( mlt_properties self, const char *name, int value )
897 // Fetch the property to work with
898 mlt_property property = mlt_properties_fetch( self, name );
900 // Set it if not NULL
901 if ( property != NULL )
903 error = mlt_property_set_int( property, value );
904 mlt_properties_do_mirror( self, name );
907 mlt_events_fire( self, "property-changed", name, NULL );
912 /** Get a 64-bit integer associated to the name.
914 * \public \memberof mlt_properties_s
915 * \param self a properties list
916 * \param name the property to get
917 * \return the integer value, 0 if not found (which may also be a legitimate value)
920 int64_t mlt_properties_get_int64( mlt_properties self, const char *name )
922 mlt_property value = mlt_properties_find( self, name );
923 return value == NULL ? 0 : mlt_property_get_int64( value );
926 /** Set a property to a 64-bit integer value.
928 * \public \memberof mlt_properties_s
929 * \param self a properties list
930 * \param name the property to set
931 * \param value the integer
932 * \return true if error
935 int mlt_properties_set_int64( mlt_properties self, const char *name, int64_t value )
939 // Fetch the property to work with
940 mlt_property property = mlt_properties_fetch( self, name );
942 // Set it if not NULL
943 if ( property != NULL )
945 error = mlt_property_set_int64( property, value );
946 mlt_properties_do_mirror( self, name );
949 mlt_events_fire( self, "property-changed", name, NULL );
954 /** Get a floating point value associated to the name.
956 * \public \memberof mlt_properties_s
957 * \param self a properties list
958 * \param name the property to get
959 * \return the floating point, 0 if not found (which may also be a legitimate value)
962 double mlt_properties_get_double( mlt_properties self, const char *name )
964 mlt_profile profile = mlt_properties_get_data( self, "_profile", NULL );
965 double fps = mlt_profile_fps( profile );
966 mlt_property value = mlt_properties_find( self, name );
967 property_list *list = self->local;
968 return value == NULL ? 0 : mlt_property_get_double( value, fps, list->locale );
971 /** Set a property to a floating point value.
973 * \public \memberof mlt_properties_s
974 * \param self a properties list
975 * \param name the property to set
976 * \param value the floating point value
977 * \return true if error
980 int mlt_properties_set_double( mlt_properties self, const char *name, double value )
984 // Fetch the property to work with
985 mlt_property property = mlt_properties_fetch( self, name );
987 // Set it if not NULL
988 if ( property != NULL )
990 error = mlt_property_set_double( property, value );
991 mlt_properties_do_mirror( self, name );
994 mlt_events_fire( self, "property-changed", name, NULL );
999 /** Get a position value associated to the name.
1001 * \public \memberof mlt_properties_s
1002 * \param self a properties list
1003 * \param name the property to get
1004 * \return the position, 0 if not found (which may also be a legitimate value)
1007 mlt_position mlt_properties_get_position( mlt_properties self, const char *name )
1009 mlt_profile profile = mlt_properties_get_data( self, "_profile", NULL );
1010 double fps = mlt_profile_fps( profile );
1011 property_list *list = self->local;
1012 mlt_property value = mlt_properties_find( self, name );
1013 return value == NULL ? 0 : mlt_property_get_position( value, fps, list->locale );
1016 /** Set a property to a position value.
1018 * \public \memberof mlt_properties_s
1019 * \param self a properties list
1020 * \param name the property to get
1021 * \param value the position
1022 * \return true if error
1025 int mlt_properties_set_position( mlt_properties self, const char *name, mlt_position value )
1029 // Fetch the property to work with
1030 mlt_property property = mlt_properties_fetch( self, name );
1032 // Set it if not NULL
1033 if ( property != NULL )
1035 error = mlt_property_set_position( property, value );
1036 mlt_properties_do_mirror( self, name );
1039 mlt_events_fire( self, "property-changed", name, NULL );
1044 /** Get a binary data value associated to the name.
1046 * Do not free the returned pointer if you supplied a destructor function
1047 * when you set this property.
1048 * \public \memberof mlt_properties_s
1049 * \param self a properties list
1050 * \param name the property to get
1051 * \param[out] length The size of the binary data in bytes, if available (often it is not, you should know)
1054 void *mlt_properties_get_data( mlt_properties self, const char *name, int *length )
1056 mlt_property value = mlt_properties_find( self, name );
1057 return value == NULL ? NULL : mlt_property_get_data( value, length );
1060 /** Store binary data as a property.
1062 * \public \memberof mlt_properties_s
1063 * \param self a properties list
1064 * \param name the property to set
1065 * \param value an opaque pointer to binary data
1066 * \param length the size of the binary data in bytes (optional)
1067 * \param destroy a function to deallocate the binary data when the property is closed (optional)
1068 * \param serialise a function that can serialize the binary data as text (optional)
1069 * \return true if error
1072 int mlt_properties_set_data( mlt_properties self, const char *name, void *value, int length, mlt_destructor destroy, mlt_serialiser serialise )
1076 // Fetch the property to work with
1077 mlt_property property = mlt_properties_fetch( self, name );
1079 // Set it if not NULL
1080 if ( property != NULL )
1081 error = mlt_property_set_data( property, value, length, destroy, serialise );
1083 mlt_events_fire( self, "property-changed", name, NULL );
1088 /** Rename a property.
1090 * \public \memberof mlt_properties_s
1091 * \param self a properties list
1092 * \param source the property to rename
1093 * \param dest the new name
1094 * \return true if the name is already in use
1097 int mlt_properties_rename( mlt_properties self, const char *source, const char *dest )
1099 mlt_property value = mlt_properties_find( self, dest );
1101 if ( value == NULL )
1103 property_list *list = self->local;
1107 mlt_properties_lock( self );
1108 for ( i = 0; i < list->count; i ++ )
1110 if ( !strcmp( list->name[ i ], source ) )
1112 free( list->name[ i ] );
1113 list->name[ i ] = strdup( dest );
1114 list->hash[ generate_hash( dest ) ] = i + 1;
1118 mlt_properties_unlock( self );
1121 return value != NULL;
1124 /** Dump the properties to a file handle.
1126 * \public \memberof mlt_properties_s
1127 * \param self a properties list
1128 * \param output a file handle
1131 void mlt_properties_dump( mlt_properties self, FILE *output )
1133 property_list *list = self->local;
1135 for ( i = 0; i < list->count; i ++ )
1136 if ( mlt_properties_get( self, list->name[ i ] ) != NULL )
1137 fprintf( output, "%s=%s\n", list->name[ i ], mlt_properties_get( self, list->name[ i ] ) );
1140 /** Output the properties to a file handle.
1142 * This version includes reference counts and does not put each property on a new line.
1143 * \public \memberof mlt_properties_s
1144 * \param self a properties pointer
1145 * \param title a string to preface the output
1146 * \param output a file handle
1148 void mlt_properties_debug( mlt_properties self, const char *title, FILE *output )
1150 if ( output == NULL ) output = stderr;
1151 fprintf( output, "%s: ", title );
1154 property_list *list = self->local;
1156 fprintf( output, "[ ref=%d", list->ref_count );
1157 for ( i = 0; i < list->count; i ++ )
1158 if ( mlt_properties_get( self, list->name[ i ] ) != NULL )
1159 fprintf( output, ", %s=%s", list->name[ i ], mlt_properties_get( self, list->name[ i ] ) );
1161 fprintf( output, ", %s=%p", list->name[ i ], mlt_properties_get_data( self, list->name[ i ], NULL ) );
1162 fprintf( output, " ]" );
1164 fprintf( output, "\n" );
1167 /** Save the properties to a file by name.
1169 * This uses the dump format - one line per property.
1170 * \public \memberof mlt_properties_s
1171 * \param self a properties list
1172 * \param filename the name of a file to create or overwrite
1173 * \return true if there was an error
1176 int mlt_properties_save( mlt_properties self, const char *filename )
1179 FILE *f = fopen( filename, "w" );
1182 mlt_properties_dump( self, f );
1189 /* This is a very basic cross platform fnmatch replacement - it will fail in
1190 * many cases, but for the basic *.XXX and YYY*.XXX, it will work ok.
1193 /** Test whether a filename or pathname matches a shell-style pattern.
1195 * \private \memberof mlt_properties_s
1196 * \param wild a string containing a wildcard pattern
1197 * \param file the name of a file to test against
1198 * \return true if the file name matches the wildcard pattern
1201 static int mlt_fnmatch( const char *wild, const char *file )
1206 while( f < strlen( file ) && w < strlen( wild ) )
1208 if ( wild[ w ] == '*' )
1211 if ( w == strlen( wild ) )
1213 while ( f != strlen( file ) && tolower( file[ f ] ) != tolower( wild[ w ] ) )
1216 else if ( wild[ w ] == '?' || tolower( file[ f ] ) == tolower( wild[ w ] ) )
1221 else if ( wild[ 0 ] == '*' )
1231 return strlen( file ) == f && strlen( wild ) == w;
1234 /** Compare the string or serialized value of two properties.
1236 * \private \memberof mlt_properties_s
1237 * \param self a property
1238 * \param that a property
1239 * \return < 0 if \p self less than \p that, 0 if equal, or > 0 if \p self is greater than \p that
1242 static int mlt_compare( const void *self, const void *that )
1244 return strcmp( mlt_property_get_string( *( const mlt_property * )self ), mlt_property_get_string( *( const mlt_property * )that ) );
1247 /** Get the contents of a directory.
1249 * Obtains an optionally sorted list of the files found in a directory with a specific wild card.
1250 * Entries in the list have a numeric name (running from 0 to count - 1). Only values change
1251 * position if sort is enabled. Designed to be posix compatible (linux, os/x, mingw etc).
1252 * \public \memberof mlt_properties_s
1253 * \param self a properties list
1254 * \param dirname the name of the directory
1255 * \param pattern a wildcard pattern to filter the directory listing
1256 * \param sort Do you want to sort the directory listing?
1257 * \return the number of items in the directory listing
1260 int mlt_properties_dir_list( mlt_properties self, const char *dirname, const char *pattern, int sort )
1262 DIR *dir = opendir( dirname );
1267 struct dirent *de = readdir( dir );
1268 char fullname[ 1024 ];
1271 sprintf( key, "%d", mlt_properties_count( self ) );
1272 snprintf( fullname, 1024, "%s/%s", dirname, de->d_name );
1273 if ( pattern == NULL )
1274 mlt_properties_set( self, key, fullname );
1275 else if ( de->d_name[ 0 ] != '.' && mlt_fnmatch( pattern, de->d_name ) )
1276 mlt_properties_set( self, key, fullname );
1277 de = readdir( dir );
1283 if ( sort && mlt_properties_count( self ) )
1285 property_list *list = self->local;
1286 mlt_properties_lock( self );
1287 qsort( list->value, mlt_properties_count( self ), sizeof( mlt_property ), mlt_compare );
1288 mlt_properties_unlock( self );
1291 return mlt_properties_count( self );
1294 /** Close a properties object.
1296 * Deallocates the properties object and everything it contains.
1297 * \public \memberof mlt_properties_s
1298 * \param self a properties object
1301 void mlt_properties_close( mlt_properties self )
1303 if ( self != NULL && mlt_properties_dec_ref( self ) <= 0 )
1305 if ( self->close != NULL )
1307 self->close( self->close_object );
1311 property_list *list = self->local;
1314 #if _MLT_PROPERTY_CHECKS_ == 1
1316 mlt_properties_debug( self, "Closing", stderr );
1319 #ifdef _MLT_PROPERTY_CHECKS_
1320 // Increment destroyed count
1321 properties_destroyed ++;
1323 // Show current stats - these should match when the app is closed
1324 mlt_log( NULL, MLT_LOG_DEBUG, "Created %d, destroyed %d\n", properties_created, properties_destroyed );
1327 // Clean up names and values
1328 for ( index = list->count - 1; index >= 0; index -- )
1330 mlt_property_close( list->value[ index ] );
1331 free( list->name[ index ] );
1334 #if defined(__linux__) || defined(__DARWIN__)
1337 freelocale( list->locale );
1340 // Clear up the list
1341 pthread_mutex_destroy( &list->mutex );
1343 free( list->value );
1346 // Free self now if self has no child
1347 if ( self->child == NULL )
1353 /** Determine if the properties list is really just a sequence or ordered list.
1355 * \public \memberof mlt_properties_s
1356 * \param properties a properties list
1357 * \return true if all of the property names are numeric (a sequence)
1360 int mlt_properties_is_sequence( mlt_properties properties )
1363 int n = mlt_properties_count( properties );
1364 for ( i = 0; i < n; i++ )
1365 if ( ! isdigit( mlt_properties_get_name( properties, i )[0] ) )
1370 /** \brief YAML Tiny Parser context structure
1372 * YAML is a nifty text format popular in the Ruby world as a cleaner,
1373 * less verbose alternative to XML. See this Wikipedia topic for an overview:
1374 * http://en.wikipedia.org/wiki/YAML
1375 * The YAML specification is at:
1377 * YAML::Tiny is a Perl module that specifies a subset of YAML that we are
1378 * using here (for the same reasons):
1379 * http://search.cpan.org/~adamk/YAML-Tiny-1.25/lib/YAML/Tiny.pm
1383 struct yaml_parser_context
1390 unsigned int block_indent;
1393 typedef struct yaml_parser_context *yaml_parser;
1395 /** Remove spaces from the left side of a string.
1397 * \param s the string to trim
1398 * \return the number of characters removed
1401 static unsigned int ltrim( char **s )
1405 int n = strlen( c );
1406 for ( i = 0; i < n && *c == ' '; i++, c++ );
1411 /** Remove spaces from the right side of a string.
1413 * \param s the string to trim
1414 * \return the number of characters removed
1417 static unsigned int rtrim( char *s )
1419 int n = strlen( s );
1421 for ( i = n; i > 0 && s[i - 1] == ' '; --i )
1426 /** Parse a line of YAML Tiny.
1428 * Adds a property if needed.
1429 * \private \memberof yaml_parser_context
1430 * \param context a YAML Tiny Parser context
1431 * \param namevalue a line of YAML Tiny
1432 * \return true if there was an error
1435 static int parse_yaml( yaml_parser context, const char *namevalue )
1437 char *name_ = strdup( namevalue );
1441 char *ptr = strchr( name, ':' );
1442 unsigned int indent = ltrim( &name );
1443 mlt_properties properties = mlt_deque_peek_front( context->stack );
1445 // Ascending one more levels in the tree
1446 if ( indent < context->level )
1449 unsigned int n = ( context->level - indent ) / 2;
1450 for ( i = 0; i < n; i++ )
1451 mlt_deque_pop_front( context->stack );
1452 properties = mlt_deque_peek_front( context->stack );
1453 context->level = indent;
1456 // Descending a level in the tree
1457 else if ( indent > context->level && context->block == 0 )
1459 context->level = indent;
1462 // If there is a colon that is not part of a block
1463 if ( ptr && ( indent == context->level ) )
1465 // Reset block processing
1466 if ( context->block_name )
1468 free( context->block_name );
1469 context->block_name = NULL;
1473 // Terminate the name and setup the value pointer
1477 char *comment = strchr( ptr, '#' );
1483 // Trim leading and trailing spaces from bare value
1487 // No value means a child
1488 if ( strcmp( ptr, "" ) == 0 )
1490 mlt_properties child = mlt_properties_new();
1491 mlt_properties_set_lcnumeric( child, mlt_properties_get_lcnumeric( properties ) );
1492 mlt_properties_set_data( properties, name, child, 0,
1493 ( mlt_destructor )mlt_properties_close, NULL );
1494 mlt_deque_push_front( context->stack, child );
1500 // A dash indicates a sequence item
1501 if ( name[0] == '-' )
1503 mlt_properties child = mlt_properties_new();
1506 mlt_properties_set_lcnumeric( child, mlt_properties_get_lcnumeric( properties ) );
1507 snprintf( key, sizeof(key), "%d", context->index++ );
1508 mlt_properties_set_data( properties, key, child, 0,
1509 ( mlt_destructor )mlt_properties_close, NULL );
1510 mlt_deque_push_front( context->stack, child );
1513 context->level += ltrim( &name ) + 1;
1521 value = strdup( ptr );
1522 if ( value && value[ strlen( value ) - 1 ] == '\"' )
1523 value[ strlen( value ) - 1 ] = 0;
1526 // Value is folded or unfolded block
1527 else if ( *ptr == '|' || *ptr == '>' )
1529 context->block = *ptr;
1530 context->block_name = strdup( name );
1531 context->block_indent = 0;
1532 value = strdup( "" );
1538 value = strdup( ptr );
1542 // A list of scalars
1543 else if ( name[0] == '-' )
1545 // Reset block processing
1546 if ( context->block_name )
1548 free( context->block_name );
1549 context->block_name = NULL;
1555 snprintf( key, sizeof(key), "%d", context->index++ );
1559 char *comment = strchr( ptr, '#' );
1563 // Trim leading and trailing spaces from bare value
1571 value = strdup( ptr );
1572 if ( value && value[ strlen( value ) - 1 ] == '\"' )
1573 value[ strlen( value ) - 1 ] = 0;
1576 // Value is folded or unfolded block
1577 else if ( *ptr == '|' || *ptr == '>' )
1579 context->block = *ptr;
1580 context->block_name = strdup( key );
1581 context->block_indent = 0;
1582 value = strdup( "" );
1588 value = strdup( ptr );
1592 name = name_ = strdup( key );
1596 else if ( context->block == '|' )
1598 if ( context->block_indent == 0 )
1599 context->block_indent = indent;
1600 if ( indent > context->block_indent )
1601 name = &name_[ context->block_indent ];
1603 char *old_value = mlt_properties_get( properties, context->block_name );
1604 value = calloc( 1, strlen( old_value ) + strlen( name ) + 2 );
1605 strcpy( value, old_value );
1606 if ( strcmp( old_value, "" ) )
1607 strcat( value, "\n" );
1608 strcat( value, name );
1609 name = context->block_name;
1613 else if ( context->block == '>' )
1617 char *old_value = mlt_properties_get( properties, context->block_name );
1619 // Blank line (prepended with spaces) is new line
1620 if ( strcmp( name, "" ) == 0 )
1622 value = calloc( 1, strlen( old_value ) + 2 );
1623 strcat( value, old_value );
1624 strcat( value, "\n" );
1626 // Concatenate with space
1629 value = calloc( 1, strlen( old_value ) + strlen( name ) + 2 );
1630 strcat( value, old_value );
1631 if ( strcmp( old_value, "" ) && old_value[ strlen( old_value ) - 1 ] != '\n' )
1632 strcat( value, " " );
1633 strcat( value, name );
1635 name = context->block_name;
1640 value = strdup( "" );
1643 error = mlt_properties_set( properties, name, value );
1645 if ( !strcmp( name, "LC_NUMERIC" ) )
1646 mlt_properties_set_lcnumeric( properties, value );
1654 /** Parse a YAML Tiny file by name.
1656 * \public \memberof mlt_properties_s
1657 * \param filename the name of a text file containing YAML Tiny
1658 * \return a new properties list
1661 mlt_properties mlt_properties_parse_yaml( const char *filename )
1663 // Construct a standalone properties object
1664 mlt_properties self = mlt_properties_new( );
1669 FILE *file = fopen( filename, "r" );
1671 // Load contents of file
1676 char *ptemp = &temp[ 0 ];
1678 // Default to LC_NUMERIC = C
1679 mlt_properties_set_lcnumeric( self, "C" );
1682 yaml_parser context = calloc( 1, sizeof( struct yaml_parser_context ) );
1683 context->stack = mlt_deque_init();
1684 mlt_deque_push_front( context->stack, self );
1686 // Read each string from the file
1687 while( fgets( temp, 1024, file ) )
1689 // Check for end-of-stream
1690 if ( strncmp( ptemp, "...", 3 ) == 0 )
1694 temp[ strlen( temp ) - 1 ] = '\0';
1696 // Skip blank lines, comment lines, and document separator
1697 if ( strcmp( ptemp, "" ) && ptemp[ 0 ] != '#' && strncmp( ptemp, "---", 3 )
1698 && strncmp( ptemp, "%YAML", 5 ) && strncmp( ptemp, "% YAML", 6 ) )
1699 parse_yaml( context, temp );
1704 mlt_deque_close( context->stack );
1705 if ( context->block_name )
1706 free( context->block_name );
1711 // Return the pointer
1716 * YAML Tiny Serializer
1719 /** How many bytes to grow at a time */
1720 #define STRBUF_GROWTH (1024)
1722 /** \brief Private to mlt_properties_s, a self-growing buffer for building strings
1732 typedef struct strbuf_s *strbuf;
1734 /** Create a new string buffer
1736 * \private \memberof strbuf_s
1737 * \return a new string buffer
1740 static strbuf strbuf_new( )
1742 strbuf buffer = calloc( 1, sizeof( struct strbuf_s ) );
1743 buffer->size = STRBUF_GROWTH;
1744 buffer->string = calloc( 1, buffer->size );
1748 /** Destroy a string buffer
1750 * \private \memberof strbuf_s
1751 * \param buffer the string buffer to close
1754 static void strbuf_close( strbuf buffer )
1756 // We do not free buffer->string; strbuf user must save that pointer
1762 /** Format a string into a string buffer
1764 * A variable number of arguments follows the format string - one for each
1766 * \private \memberof strbuf_s
1767 * \param buffer the string buffer to write into
1768 * \param format a string that contains text and formatting instructions
1769 * \return the formatted string
1772 static char *strbuf_printf( strbuf buffer, const char *format, ... )
1774 while ( buffer->string )
1777 va_start( ap, format );
1778 size_t len = strlen( buffer->string );
1779 size_t remain = buffer->size - len - 1;
1780 int need = vsnprintf( buffer->string + len, remain, format, ap );
1782 if ( need > -1 && need < remain )
1784 buffer->string[ len ] = 0;
1785 buffer->size += need + STRBUF_GROWTH;
1786 buffer->string = realloc( buffer->string, buffer->size );
1788 return buffer->string;
1791 /** Indent a line of YAML Tiny.
1793 * \private \memberof strbuf_s
1794 * \param output a string buffer
1795 * \param indent the number of spaces to indent
1798 static inline void indent_yaml( strbuf output, int indent )
1801 for ( j = 0; j < indent; j++ )
1802 strbuf_printf( output, " " );
1805 /** Convert a line string into a YAML block literal.
1807 * \private \memberof strbuf_s
1808 * \param output a string buffer
1809 * \param value the string to format as a block literal
1810 * \param indent the number of spaces to indent
1813 static void output_yaml_block_literal( strbuf output, const char *value, int indent )
1815 char *v = strdup( value );
1817 char *eol = strchr( sol, '\n' );
1821 indent_yaml( output, indent );
1823 strbuf_printf( output, "%s\n", sol );
1825 eol = strchr( sol, '\n' );
1827 indent_yaml( output, indent );
1828 strbuf_printf( output, "%s\n", sol );
1831 /** Recursively serialize a properties list into a string buffer as YAML Tiny.
1833 * \private \memberof mlt_properties_s
1834 * \param self a properties list
1835 * \param output a string buffer to hold the serialized YAML Tiny
1836 * \param indent the number of spaces to indent (for recursion, initialize to 0)
1837 * \param is_parent_sequence Is this properties list really just a sequence (for recursion, initialize to 0)?
1840 static void serialise_yaml( mlt_properties self, strbuf output, int indent, int is_parent_sequence )
1842 property_list *list = self->local;
1845 for ( i = 0; i < list->count; i ++ )
1847 // This implementation assumes that all data elements are property lists.
1848 // Unfortunately, we do not have run time type identification.
1849 mlt_properties child = mlt_property_get_data( list->value[ i ], NULL );
1851 if ( mlt_properties_is_sequence( self ) )
1853 // Ignore hidden/non-serialisable items
1854 if ( list->name[ i ][ 0 ] != '_' )
1856 // Indicate a sequence item
1857 indent_yaml( output, indent );
1858 strbuf_printf( output, "- " );
1860 // If the value can be represented as a string
1861 const char *value = mlt_properties_get( self, list->name[ i ] );
1862 if ( value && strcmp( value, "" ) )
1864 // Determine if this is an unfolded block literal
1865 if ( strchr( value, '\n' ) )
1867 strbuf_printf( output, "|\n" );
1868 output_yaml_block_literal( output, value, indent + strlen( list->name[ i ] ) + strlen( "|" ) );
1872 strbuf_printf( output, "%s\n", value );
1878 serialise_yaml( child, output, indent + 2, 1 );
1882 // Assume this is a normal map-oriented properties list
1883 const char *value = mlt_properties_get( self, list->name[ i ] );
1885 // Ignore hidden/non-serialisable items
1886 // If the value can be represented as a string
1887 if ( list->name[ i ][ 0 ] != '_' && value && strcmp( value, "" ) )
1889 if ( is_parent_sequence == 0 )
1890 indent_yaml( output, indent );
1892 is_parent_sequence = 0;
1894 // Determine if this is an unfolded block literal
1895 if ( strchr( value, '\n' ) )
1897 strbuf_printf( output, "%s: |\n", list->name[ i ] );
1898 output_yaml_block_literal( output, value, indent + strlen( list->name[ i ] ) + strlen( ": " ) );
1902 strbuf_printf( output, "%s: %s\n", list->name[ i ], value );
1906 // Output a child as a map item
1909 indent_yaml( output, indent );
1910 strbuf_printf( output, "%s:\n", list->name[ i ] );
1913 serialise_yaml( child, output, indent + 2, 0 );
1919 /** Serialize a properties list as a string of YAML Tiny.
1921 * The caller MUST free the returned string!
1922 * This operates on properties containing properties as a hierarchical data
1924 * \public \memberof mlt_properties_s
1925 * \param self a properties list
1926 * \return a string containing YAML Tiny that represents the properties list
1929 char *mlt_properties_serialise_yaml( mlt_properties self )
1931 const char *lc_numeric = mlt_properties_get_lcnumeric( self );
1932 strbuf b = strbuf_new();
1933 strbuf_printf( b, "---\n" );
1934 mlt_properties_set_lcnumeric( self, "C" );
1935 serialise_yaml( self, b, 0, 0 );
1936 mlt_properties_set_lcnumeric( self, lc_numeric );
1937 strbuf_printf( b, "...\n" );
1938 char *ret = b->string;
1943 /** Protect a properties list against concurrent access.
1945 * \public \memberof mlt_properties_s
1946 * \param self a properties list
1949 void mlt_properties_lock( mlt_properties self )
1952 pthread_mutex_lock( &( ( property_list* )( self->local ) )->mutex );
1955 /** End protecting a properties list against concurrent access.
1957 * \public \memberof mlt_properties_s
1958 * \param self a properties list
1961 void mlt_properties_unlock( mlt_properties self )
1964 pthread_mutex_unlock( &( ( property_list* )( self->local ) )->mutex );
1967 /** Get a time string associated to the name.
1969 * Do not free the returned string. It's lifetime is controlled by the property.
1970 * \public \memberof mlt_properties_s
1971 * \param self a properties list
1972 * \param name the property to get
1973 * \param format the time format that you want
1974 * \return the property's time value or NULL if \p name does not exist or there is no profile
1977 char *mlt_properties_get_time( mlt_properties self, const char* name, mlt_time_format format )
1979 mlt_profile profile = mlt_properties_get_data( self, "_profile", NULL );
1982 double fps = mlt_profile_fps( profile );
1983 mlt_property value = mlt_properties_find( self, name );
1984 property_list *list = self->local;
1985 return value == NULL ? NULL : mlt_property_get_time( value, format, fps, list->locale );