2 * producer_westley.c -- a libxml2 parser of mlt service networks
3 * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
4 * Author: Dan Dennedy <dan@dennedy.org>
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.
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.
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.
21 // TODO: destroy unreferenced producers (they are currently destroyed
22 // when the returned producer is closed).
24 #include "producer_westley.h"
25 #include <framework/mlt.h>
32 #include <libxml/parser.h>
33 #include <libxml/parserInternals.h> // for xmlCreateFileParserCtxt
34 #include <libxml/tree.h>
36 #define STACK_SIZE 1000
37 #define BRANCH_SIG_LEN 4000
41 extern xmlDocPtr westley_make_doc( mlt_service service );
58 mlt_dummy_filter_type,
59 mlt_dummy_transition_type,
60 mlt_dummy_producer_type,
63 struct deserialise_context_s
65 enum service_type stack_types[ STACK_SIZE ];
66 mlt_service stack_service[ STACK_SIZE ];
67 int stack_service_size;
68 mlt_properties producer_map;
69 mlt_properties destructors;
73 xmlNodePtr stack_node[ STACK_SIZE ];
76 int entity_is_replace;
78 int branch[ STACK_SIZE ];
79 const xmlChar *publicId;
80 const xmlChar *systemId;
81 mlt_properties params;
83 typedef struct deserialise_context_s *deserialise_context;
85 /** Convert the numerical current branch address to a dot-delimited string.
87 static char *serialise_branch( deserialise_context this, char *s )
92 for ( i = 0; i < this->depth; i++ )
94 int len = strlen( s );
95 snprintf( s + len, BRANCH_SIG_LEN - len, "%d.", this->branch[ i ] );
103 static int context_push_service( deserialise_context this, mlt_service that, enum service_type type )
105 int ret = this->stack_service_size >= STACK_SIZE - 1;
108 this->stack_service[ this->stack_service_size ] = that;
109 this->stack_types[ this->stack_service_size++ ] = type;
111 // Record the tree branch on which this service lives
112 if ( that != NULL && mlt_properties_get( MLT_SERVICE_PROPERTIES( that ), "_westley_branch" ) == NULL )
114 char s[ BRANCH_SIG_LEN ];
115 mlt_properties_set( MLT_SERVICE_PROPERTIES( that ), "_westley_branch", serialise_branch( this, s ) );
124 static mlt_service context_pop_service( deserialise_context this, enum service_type *type )
126 mlt_service result = NULL;
127 if ( this->stack_service_size > 0 )
129 result = this->stack_service[ -- this->stack_service_size ];
131 *type = this->stack_types[ this->stack_service_size ];
139 static int context_push_node( deserialise_context this, xmlNodePtr node )
141 int ret = this->stack_node_size >= STACK_SIZE - 1;
143 this->stack_node[ this->stack_node_size ++ ] = node;
150 static xmlNodePtr context_pop_node( deserialise_context this )
152 xmlNodePtr result = NULL;
153 if ( this->stack_node_size > 0 )
154 result = this->stack_node[ -- this->stack_node_size ];
159 // Set the destructor on a new service
160 static void track_service( mlt_properties properties, void *service, mlt_destructor destructor )
162 int registered = mlt_properties_get_int( properties, "registered" );
163 char *key = mlt_properties_get( properties, "registered" );
164 mlt_properties_set_data( properties, key, service, 0, destructor, NULL );
165 mlt_properties_set_int( properties, "registered", ++ registered );
169 // Prepend the property value with the document root
170 static inline void qualify_property( deserialise_context context, mlt_properties properties, char *name )
172 char *resource = mlt_properties_get( properties, name );
173 if ( resource != NULL )
175 // Qualify file name properties
176 char *root = mlt_properties_get( context->producer_map, "root" );
177 if ( root != NULL && strcmp( root, "" ) )
179 char *full_resource = malloc( strlen( root ) + strlen( resource ) + 2 );
180 if ( resource[ 0 ] != '/' && strchr( resource, ':' ) == NULL )
182 strcpy( full_resource, root );
183 strcat( full_resource, "/" );
184 strcat( full_resource, resource );
188 strcpy( full_resource, resource );
190 mlt_properties_set( properties, name, full_resource );
191 free( full_resource );
197 /** This function adds a producer to a playlist or multitrack when
198 there is no entry or track element.
201 static int add_producer( deserialise_context context, mlt_service service, mlt_position in, mlt_position out )
203 // Return value (0 = service remains top of stack, 1 means it can be removed)
206 // Get the parent producer
207 enum service_type type;
208 mlt_service container = context_pop_service( context, &type );
211 if ( service != NULL && container != NULL )
213 char *container_branch = mlt_properties_get( MLT_SERVICE_PROPERTIES( container ), "_westley_branch" );
214 char *service_branch = mlt_properties_get( MLT_SERVICE_PROPERTIES( service ), "_westley_branch" );
215 contained = !strncmp( container_branch, service_branch, strlen( container_branch ) );
220 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
221 char *hide_s = mlt_properties_get( properties, "hide" );
223 // Indicate that this service is no longer top of stack
228 case mlt_tractor_type:
230 mlt_multitrack multitrack = mlt_tractor_multitrack( MLT_TRACTOR( container ) );
231 mlt_multitrack_connect( multitrack, MLT_PRODUCER( service ), mlt_multitrack_count( multitrack ) );
234 case mlt_multitrack_type:
236 mlt_multitrack_connect( MLT_MULTITRACK( container ),
237 MLT_PRODUCER( service ),
238 mlt_multitrack_count( MLT_MULTITRACK( container ) ) );
241 case mlt_playlist_type:
243 mlt_playlist_append_io( MLT_PLAYLIST( container ), MLT_PRODUCER( service ), in, out );
248 fprintf( stderr, "Producer defined inside something that isn't a container\n" );
252 // Set the hide state of the track producer
253 if ( hide_s != NULL )
255 if ( strcmp( hide_s, "video" ) == 0 )
256 mlt_properties_set_int( properties, "hide", 1 );
257 else if ( strcmp( hide_s, "audio" ) == 0 )
258 mlt_properties_set_int( properties, "hide", 2 );
259 else if ( strcmp( hide_s, "both" ) == 0 )
260 mlt_properties_set_int( properties, "hide", 3 );
264 // Put the parent producer back
265 if ( container != NULL )
266 context_push_service( context, container, type );
271 /** Attach filters defined on that to this.
274 static void attach_filters( mlt_service this, mlt_service that )
279 mlt_filter filter = NULL;
280 for ( i = 0; ( filter = mlt_service_filter( that, i ) ) != NULL; i ++ )
282 mlt_service_attach( this, filter );
283 attach_filters( MLT_FILTER_SERVICE( filter ), MLT_FILTER_SERVICE( filter ) );
288 static void on_start_tractor( deserialise_context context, const xmlChar *name, const xmlChar **atts)
290 mlt_tractor tractor = mlt_tractor_new( );
291 mlt_service service = MLT_TRACTOR_SERVICE( tractor );
292 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
294 track_service( context->destructors, service, (mlt_destructor) mlt_tractor_close );
296 for ( ; atts != NULL && *atts != NULL; atts += 2 )
297 mlt_properties_set( MLT_SERVICE_PROPERTIES( service ), (char*) atts[0], atts[1] == NULL ? "" : (char*) atts[1] );
299 mlt_properties_set_int( MLT_TRACTOR_PROPERTIES( tractor ), "global_feed", 1 );
301 if ( mlt_properties_get( properties, "id" ) != NULL )
302 mlt_properties_set_data( context->producer_map, mlt_properties_get( properties, "id" ), service, 0, NULL, NULL );
304 context_push_service( context, service, mlt_tractor_type );
307 static void on_end_tractor( deserialise_context context, const xmlChar *name )
310 enum service_type type;
311 mlt_service tractor = context_pop_service( context, &type );
313 if ( tractor != NULL && type == mlt_tractor_type )
315 // See if the tractor should be added to a playlist or multitrack
316 if ( add_producer( context, tractor, 0, mlt_producer_get_out( MLT_PRODUCER( tractor ) ) ) == 0 )
317 context_push_service( context, tractor, type );
321 fprintf( stderr, "Invalid state for tractor\n" );
325 static void on_start_multitrack( deserialise_context context, const xmlChar *name, const xmlChar **atts)
327 enum service_type type;
328 mlt_service parent = context_pop_service( context, &type );
330 // If we don't have a parent, then create one now, providing we're in a state where we can
331 if ( parent == NULL || ( type == mlt_playlist_type || type == mlt_multitrack_type ) )
333 mlt_tractor tractor = NULL;
334 // Push the parent back
335 if ( parent != NULL )
336 context_push_service( context, parent, type );
338 // Create a tractor to contain the multitrack
339 tractor = mlt_tractor_new( );
340 parent = MLT_TRACTOR_SERVICE( tractor );
341 track_service( context->destructors, parent, (mlt_destructor) mlt_tractor_close );
342 type = mlt_tractor_type;
344 // Flag it as a synthesised tractor for clean up later
345 mlt_properties_set_int( MLT_SERVICE_PROPERTIES( parent ), "fezzik_synth", 1 );
348 if ( type == mlt_tractor_type )
350 mlt_service service = MLT_SERVICE( mlt_tractor_multitrack( MLT_TRACTOR( parent ) ) );
351 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
352 for ( ; atts != NULL && *atts != NULL; atts += 2 )
353 mlt_properties_set( properties, (char*) atts[0], atts[1] == NULL ? "" : (char*) atts[1] );
355 if ( mlt_properties_get( properties, "id" ) != NULL )
356 mlt_properties_set_data( context->producer_map, mlt_properties_get( properties,"id" ), service, 0, NULL, NULL );
358 context_push_service( context, parent, type );
359 context_push_service( context, service, mlt_multitrack_type );
363 fprintf( stderr, "Invalid multitrack position\n" );
367 static void on_end_multitrack( deserialise_context context, const xmlChar *name )
369 // Get the multitrack from the stack
370 enum service_type type;
371 mlt_service service = context_pop_service( context, &type );
373 if ( service == NULL || type != mlt_multitrack_type )
374 fprintf( stderr, "End multitrack in the wrong state...\n" );
377 static void on_start_playlist( deserialise_context context, const xmlChar *name, const xmlChar **atts)
379 mlt_playlist playlist = mlt_playlist_init( );
380 mlt_service service = MLT_PLAYLIST_SERVICE( playlist );
381 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
383 track_service( context->destructors, service, (mlt_destructor) mlt_playlist_close );
385 for ( ; atts != NULL && *atts != NULL; atts += 2 )
387 mlt_properties_set( properties, (char*) atts[0], atts[1] == NULL ? "" : (char*) atts[1] );
389 // Out will be overwritten later as we append, so we need to save it
390 if ( strcmp( atts[ 0 ], "out" ) == 0 )
391 mlt_properties_set( properties, "_westley.out", ( char* )atts[ 1 ] );
394 if ( mlt_properties_get( properties, "id" ) != NULL )
395 mlt_properties_set_data( context->producer_map, mlt_properties_get( properties, "id" ), service, 0, NULL, NULL );
397 context_push_service( context, service, mlt_playlist_type );
400 static void on_end_playlist( deserialise_context context, const xmlChar *name )
402 // Get the playlist from the stack
403 enum service_type type;
404 mlt_service service = context_pop_service( context, &type );
406 if ( service != NULL && type == mlt_playlist_type )
408 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
409 mlt_position in = mlt_properties_get_position( properties, "in" );
410 mlt_position out = mlt_properties_get_position( properties, "out" );
412 // See if the playlist should be added to a playlist or multitrack
413 if ( add_producer( context, service, in, out ) == 0 )
414 context_push_service( context, service, type );
418 fprintf( stderr, "Invalid state of playlist end\n" );
422 static void on_start_producer( deserialise_context context, const xmlChar *name, const xmlChar **atts)
424 // use a dummy service to hold properties to allow arbitrary nesting
425 mlt_service service = calloc( 1, sizeof( struct mlt_service_s ) );
426 mlt_service_init( service, NULL );
428 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
430 context_push_service( context, service, mlt_dummy_producer_type );
432 for ( ; atts != NULL && *atts != NULL; atts += 2 )
433 mlt_properties_set( properties, (char*) atts[0], atts[1] == NULL ? "" : (char*) atts[1] );
436 // Parse a SMIL clock value (as produced by Kino 0.9.1) and return position in frames
437 static mlt_position parse_clock_value( char *value, double fps )
439 // This implementation expects a fully specified clock value - no optional
441 char *pos, *copy = strdup( value );
443 mlt_position result = -1;
446 pos = strchr( value, ':' );
453 pos = strchr( value, ':' );
460 pos = strchr( value, '.' );
469 result = ( fps * ( ( (hh * 3600) + (mm * 60) + ss ) * 1000 + ms ) / 1000 + 0.5 );
474 static void on_end_producer( deserialise_context context, const xmlChar *name )
476 enum service_type type;
477 mlt_service service = context_pop_service( context, &type );
478 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
480 if ( service != NULL && type == mlt_dummy_producer_type )
482 mlt_service producer = NULL;
484 qualify_property( context, properties, "resource" );
485 char *resource = mlt_properties_get( properties, "resource" );
487 // Let Kino-SMIL src be a synonym for resource
488 if ( resource == NULL )
490 qualify_property( context, properties, "src" );
491 resource = mlt_properties_get( properties, "src" );
494 // Instantiate the producer
495 if ( mlt_properties_get( properties, "mlt_service" ) != NULL )
498 strncpy( temp, mlt_properties_get( properties, "mlt_service" ), 1024 );
499 if ( resource != NULL )
502 strncat( temp, resource, 1023 - strlen( temp ) );
504 producer = MLT_SERVICE( mlt_factory_producer( "fezzik", temp ) );
507 // Just in case the plugin requested doesn't exist...
508 if ( producer == NULL && resource != NULL )
509 producer = MLT_SERVICE( mlt_factory_producer( "fezzik", resource ) );
511 if ( producer == NULL )
512 producer = MLT_SERVICE( mlt_factory_producer( "fezzik", "+INVALID.txt" ) );
514 if ( producer == NULL )
515 producer = MLT_SERVICE( mlt_factory_producer( "fezzik", "colour:red" ) );
517 // Track this producer
518 track_service( context->destructors, producer, (mlt_destructor) mlt_producer_close );
520 // Propogate the properties
521 qualify_property( context, properties, "resource" );
522 qualify_property( context, properties, "luma" );
523 qualify_property( context, properties, "luma.resource" );
524 qualify_property( context, properties, "composite.luma" );
525 qualify_property( context, properties, "producer.resource" );
527 // Handle in/out properties separately
528 mlt_position in = -1;
529 mlt_position out = -1;
532 if ( mlt_properties_get( properties, "in" ) != NULL )
533 in = mlt_properties_get_position( properties, "in" );
534 // Let Kino-SMIL clipBegin be a synonym for in
535 if ( mlt_properties_get( properties, "clipBegin" ) != NULL )
537 if ( strchr( mlt_properties_get( properties, "clipBegin" ), ':' ) )
539 in = parse_clock_value( mlt_properties_get( properties, "clipBegin" ),
540 mlt_properties_get_double( mlt_producer_properties( MLT_PRODUCER( producer ) ), "fps" ) );
542 // Parse frames value
543 in = mlt_properties_get_position( properties, "clipBegin" );
546 if ( mlt_properties_get( properties, "out" ) != NULL )
547 out = mlt_properties_get_position( properties, "out" );
548 // Let Kino-SMIL clipEnd be a synonym for out
549 if ( mlt_properties_get( properties, "clipEnd" ) != NULL )
551 if ( strchr( mlt_properties_get( properties, "clipEnd" ), ':' ) )
553 out = parse_clock_value( mlt_properties_get( properties, "clipEnd" ),
554 mlt_properties_get_double( mlt_producer_properties( MLT_PRODUCER( producer ) ), "fps" ) );
556 // Parse frames value
557 out = mlt_properties_get_position( properties, "clipEnd" );
560 mlt_properties_set( properties, "in", NULL );
561 mlt_properties_set( properties, "out", NULL );
563 // Inherit the properties
564 mlt_properties_inherit( MLT_SERVICE_PROPERTIES( producer ), properties );
566 // Attach all filters from service onto producer
567 attach_filters( producer, service );
569 // Add the producer to the producer map
570 if ( mlt_properties_get( properties, "id" ) != NULL )
571 mlt_properties_set_data( context->producer_map, mlt_properties_get(properties, "id"), producer, 0, NULL, NULL );
573 // See if the producer should be added to a playlist or multitrack
574 if ( add_producer( context, producer, in, out ) == 0 )
576 // Otherwise, set in and out on...
577 if ( in != -1 || out != -1 )
579 // Get the parent service
580 enum service_type type;
581 mlt_service parent = context_pop_service( context, &type );
582 if ( parent != NULL )
584 // Get the parent properties
585 properties = MLT_SERVICE_PROPERTIES( parent );
587 char *resource = mlt_properties_get( properties, "resource" );
589 // Put the parent producer back
590 context_push_service( context, parent, type );
592 // If the parent is a track or entry
593 if ( resource && ( strcmp( resource, "<entry>" ) == 0 ) )
595 mlt_properties_set_position( properties, "in", in );
596 mlt_properties_set_position( properties, "out", out );
600 // Otherwise, set in and out on producer directly
601 mlt_producer_set_in_and_out( MLT_PRODUCER( producer ), in, out );
606 // Otherwise, set in and out on producer directly
607 mlt_producer_set_in_and_out( MLT_PRODUCER( producer ), in, out );
611 // Push the producer onto the stack
612 context_push_service( context, producer, mlt_producer_type );
615 mlt_service_close( service );
619 static void on_start_blank( deserialise_context context, const xmlChar *name, const xmlChar **atts)
621 // Get the playlist from the stack
622 enum service_type type;
623 mlt_service service = context_pop_service( context, &type );
624 mlt_position length = 0;
626 if ( type == mlt_playlist_type && service != NULL )
628 // Look for the length attribute
629 for ( ; atts != NULL && *atts != NULL; atts += 2 )
631 if ( strcmp( atts[0], "length" ) == 0 )
633 length = atoll( atts[1] );
638 // Append a blank to the playlist
639 mlt_playlist_blank( MLT_PLAYLIST( service ), length - 1 );
641 // Push the playlist back onto the stack
642 context_push_service( context, service, type );
646 fprintf( stderr, "blank without a playlist - a definite no no\n" );
650 static void on_start_entry( deserialise_context context, const xmlChar *name, const xmlChar **atts)
652 mlt_producer entry = NULL;
653 mlt_properties temp = mlt_properties_new( );
655 for ( ; atts != NULL && *atts != NULL; atts += 2 )
657 mlt_properties_set( temp, (char*) atts[0], atts[1] == NULL ? "" : (char*) atts[1] );
659 // Look for the producer attribute
660 if ( strcmp( atts[ 0 ], "producer" ) == 0 )
662 mlt_producer producer = mlt_properties_get_data( context->producer_map, (char*) atts[1], NULL );
663 if ( producer != NULL )
664 mlt_properties_set_data( temp, "producer", producer, 0, NULL, NULL );
668 // If we have a valid entry
669 if ( mlt_properties_get_data( temp, "producer", NULL ) != NULL )
671 mlt_playlist_clip_info info;
672 enum service_type parent_type;
673 mlt_service parent = context_pop_service( context, &parent_type );
674 mlt_producer producer = mlt_properties_get_data( temp, "producer", NULL );
676 if ( parent_type == mlt_playlist_type )
678 // Append the producer to the playlist
679 if ( mlt_properties_get( temp, "in" ) != NULL || mlt_properties_get( temp, "out" ) != NULL )
681 mlt_playlist_append_io( MLT_PLAYLIST( parent ), producer,
682 mlt_properties_get_position( temp, "in" ),
683 mlt_properties_get_position( temp, "out" ) );
687 mlt_playlist_append( MLT_PLAYLIST( parent ), producer );
690 // Handle the repeat property
691 if ( mlt_properties_get_int( temp, "repeat" ) > 0 )
693 mlt_playlist_repeat_clip( MLT_PLAYLIST( parent ),
694 mlt_playlist_count( MLT_PLAYLIST( parent ) ) - 1,
695 mlt_properties_get_int( temp, "repeat" ) );
698 mlt_playlist_get_clip_info( MLT_PLAYLIST( parent ), &info, mlt_playlist_count( MLT_PLAYLIST( parent ) ) - 1 );
703 fprintf( stderr, "Entry not part of a playlist...\n" );
706 context_push_service( context, parent, parent_type );
709 // Push the cut onto the stack
710 context_push_service( context, MLT_PRODUCER_SERVICE( entry ), mlt_entry_type );
712 mlt_properties_close( temp );
715 static void on_end_entry( deserialise_context context, const xmlChar *name )
717 // Get the entry from the stack
718 enum service_type entry_type;
719 mlt_service entry = context_pop_service( context, &entry_type );
721 if ( entry == NULL && entry_type != mlt_entry_type )
723 fprintf( stderr, "Invalid state at end of entry\n" );
727 static void on_start_track( deserialise_context context, const xmlChar *name, const xmlChar **atts)
729 // use a dummy service to hold properties to allow arbitrary nesting
730 mlt_service service = calloc( 1, sizeof( struct mlt_service_s ) );
731 mlt_service_init( service, NULL );
733 // Push the dummy service onto the stack
734 context_push_service( context, service, mlt_entry_type );
736 mlt_properties_set( MLT_SERVICE_PROPERTIES( service ), "resource", "<track>" );
738 for ( ; atts != NULL && *atts != NULL; atts += 2 )
740 mlt_properties_set( MLT_SERVICE_PROPERTIES( service ), (char*) atts[0], atts[1] == NULL ? "" : (char*) atts[1] );
742 // Look for the producer attribute
743 if ( strcmp( atts[ 0 ], "producer" ) == 0 )
745 mlt_producer producer = mlt_properties_get_data( context->producer_map, (char*) atts[1], NULL );
746 if ( producer != NULL )
747 mlt_properties_set_data( MLT_SERVICE_PROPERTIES( service ), "producer", producer, 0, NULL, NULL );
752 static void on_end_track( deserialise_context context, const xmlChar *name )
754 // Get the track from the stack
755 enum service_type track_type;
756 mlt_service track = context_pop_service( context, &track_type );
758 if ( track != NULL && track_type == mlt_entry_type )
760 mlt_properties track_props = MLT_SERVICE_PROPERTIES( track );
761 enum service_type parent_type;
762 mlt_service parent = context_pop_service( context, &parent_type );
763 mlt_multitrack multitrack = NULL;
765 mlt_producer producer = mlt_properties_get_data( track_props, "producer", NULL );
766 mlt_properties producer_props = MLT_PRODUCER_PROPERTIES( producer );
768 if ( parent_type == mlt_tractor_type )
769 multitrack = mlt_tractor_multitrack( MLT_TRACTOR( parent ) );
770 else if ( parent_type == mlt_multitrack_type )
771 multitrack = MLT_MULTITRACK( parent );
773 fprintf( stderr, "track contained in an invalid container\n" );
775 if ( multitrack != NULL )
777 // Set producer i/o if specified
778 if ( mlt_properties_get( track_props, "in" ) != NULL ||
779 mlt_properties_get( track_props, "out" ) != NULL )
781 mlt_producer cut = mlt_producer_cut( MLT_PRODUCER( producer ),
782 mlt_properties_get_position( track_props, "in" ),
783 mlt_properties_get_position( track_props, "out" ) );
784 mlt_multitrack_connect( multitrack, cut, mlt_multitrack_count( multitrack ) );
785 mlt_properties_inherit( MLT_PRODUCER_PROPERTIES( cut ), track_props );
786 track_props = MLT_PRODUCER_PROPERTIES( cut );
787 mlt_producer_close( cut );
791 mlt_multitrack_connect( multitrack, producer, mlt_multitrack_count( multitrack ) );
794 // Set the hide state of the track producer
795 char *hide_s = mlt_properties_get( track_props, "hide" );
796 if ( hide_s != NULL )
798 if ( strcmp( hide_s, "video" ) == 0 )
799 mlt_properties_set_int( producer_props, "hide", 1 );
800 else if ( strcmp( hide_s, "audio" ) == 0 )
801 mlt_properties_set_int( producer_props, "hide", 2 );
802 else if ( strcmp( hide_s, "both" ) == 0 )
803 mlt_properties_set_int( producer_props, "hide", 3 );
807 if ( parent != NULL )
808 context_push_service( context, parent, parent_type );
810 mlt_service_close( track );
814 fprintf( stderr, "Invalid state at end of track\n" );
818 static void on_start_filter( deserialise_context context, const xmlChar *name, const xmlChar **atts)
820 // use a dummy service to hold properties to allow arbitrary nesting
821 mlt_service service = calloc( 1, sizeof( struct mlt_service_s ) );
822 mlt_service_init( service, NULL );
824 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
826 context_push_service( context, service, mlt_dummy_filter_type );
828 // Set the properties
829 for ( ; atts != NULL && *atts != NULL; atts += 2 )
830 mlt_properties_set( properties, (char*) atts[0], (char*) atts[1] );
833 static void on_end_filter( deserialise_context context, const xmlChar *name )
835 enum service_type type;
836 mlt_service service = context_pop_service( context, &type );
837 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
839 enum service_type parent_type;
840 mlt_service parent = context_pop_service( context, &parent_type );
842 if ( service != NULL && type == mlt_dummy_filter_type )
844 mlt_service filter = MLT_SERVICE( mlt_factory_filter( mlt_properties_get( properties, "mlt_service" ), NULL ) );
845 mlt_properties filter_props = MLT_SERVICE_PROPERTIES( filter );
847 track_service( context->destructors, filter, (mlt_destructor) mlt_filter_close );
849 // Propogate the properties
850 qualify_property( context, properties, "resource" );
851 qualify_property( context, properties, "luma" );
852 qualify_property( context, properties, "luma.resource" );
853 qualify_property( context, properties, "composite.luma" );
854 qualify_property( context, properties, "producer.resource" );
855 mlt_properties_inherit( filter_props, properties );
857 // Attach all filters from service onto filter
858 attach_filters( filter, service );
860 // Associate the filter with the parent
861 if ( parent != NULL )
863 if ( parent_type == mlt_tractor_type )
865 mlt_field field = mlt_tractor_field( MLT_TRACTOR( parent ) );
866 mlt_field_plant_filter( field, MLT_FILTER( filter ), mlt_properties_get_int( properties, "track" ) );
867 mlt_filter_set_in_and_out( MLT_FILTER( filter ),
868 mlt_properties_get_int( properties, "in" ),
869 mlt_properties_get_int( properties, "out" ) );
873 mlt_service_attach( parent, MLT_FILTER( filter ) );
876 // Put the parent back on the stack
877 context_push_service( context, parent, parent_type );
881 fprintf( stderr, "filter closed with invalid parent...\n" );
884 // Close the dummy filter service
885 mlt_service_close( service );
889 fprintf( stderr, "Invalid top of stack on filter close\n" );
893 static void on_start_transition( deserialise_context context, const xmlChar *name, const xmlChar **atts)
895 // use a dummy service to hold properties to allow arbitrary nesting
896 mlt_service service = calloc( 1, sizeof( struct mlt_service_s ) );
897 mlt_service_init( service, NULL );
899 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
901 context_push_service( context, service, mlt_dummy_transition_type );
903 // Set the properties
904 for ( ; atts != NULL && *atts != NULL; atts += 2 )
905 mlt_properties_set( properties, (char*) atts[0], (char*) atts[1] );
908 static void on_end_transition( deserialise_context context, const xmlChar *name )
910 enum service_type type;
911 mlt_service service = context_pop_service( context, &type );
912 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
914 enum service_type parent_type;
915 mlt_service parent = context_pop_service( context, &parent_type );
917 if ( service != NULL && type == mlt_dummy_transition_type )
919 mlt_service effect = MLT_SERVICE( mlt_factory_transition(mlt_properties_get(properties,"mlt_service"), NULL ) );
920 mlt_properties effect_props = MLT_SERVICE_PROPERTIES( effect );
922 track_service( context->destructors, effect, (mlt_destructor) mlt_transition_close );
924 // Propogate the properties
925 qualify_property( context, properties, "resource" );
926 qualify_property( context, properties, "luma" );
927 qualify_property( context, properties, "luma.resource" );
928 qualify_property( context, properties, "composite.luma" );
929 qualify_property( context, properties, "producer.resource" );
930 mlt_properties_inherit( effect_props, properties );
932 // Attach all filters from service onto effect
933 attach_filters( effect, service );
935 // Associate the filter with the parent
936 if ( parent != NULL )
938 if ( parent_type == mlt_tractor_type )
940 mlt_field field = mlt_tractor_field( MLT_TRACTOR( parent ) );
941 if ( mlt_properties_get_int( properties, "a_track" ) == mlt_properties_get_int( properties, "b_track" ) )
942 mlt_properties_set_int( properties, "b_track", mlt_properties_get_int( properties, "a_track" ) + 1 );
943 mlt_field_plant_transition( field, MLT_TRANSITION( effect ),
944 mlt_properties_get_int( properties, "a_track" ),
945 mlt_properties_get_int( properties, "b_track" ) );
946 mlt_transition_set_in_and_out( MLT_TRANSITION( effect ),
947 mlt_properties_get_int( properties, "in" ),
948 mlt_properties_get_int( properties, "out" ) );
952 fprintf( stderr, "Misplaced transition - ignoring\n" );
955 // Put the parent back on the stack
956 context_push_service( context, parent, parent_type );
960 fprintf( stderr, "transition closed with invalid parent...\n" );
963 // Close the dummy filter service
964 mlt_service_close( service );
968 fprintf( stderr, "Invalid top of stack on transition close\n" );
972 static void on_start_property( deserialise_context context, const xmlChar *name, const xmlChar **atts)
974 enum service_type type;
975 mlt_service service = context_pop_service( context, &type );
976 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
979 if ( service != NULL )
981 // Set the properties
982 for ( ; atts != NULL && *atts != NULL; atts += 2 )
984 if ( strcmp( atts[ 0 ], "name" ) == 0 )
985 context->property = strdup( atts[ 1 ] );
986 else if ( strcmp( atts[ 0 ], "value" ) == 0 )
987 value = (char*) atts[ 1 ];
990 if ( context->property != NULL )
991 mlt_properties_set( properties, context->property, value == NULL ? "" : value );
993 // Tell parser to collect any further nodes for serialisation
994 context->is_value = 1;
996 context_push_service( context, service, type );
1000 fprintf( stderr, "Property without a service '%s'?\n", ( char * )name );
1004 static void on_end_property( deserialise_context context, const xmlChar *name )
1006 enum service_type type;
1007 mlt_service service = context_pop_service( context, &type );
1008 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
1010 if ( service != NULL )
1012 // Tell parser to stop building a tree
1013 context->is_value = 0;
1015 // See if there is a xml tree for the value
1016 if ( context->property != NULL && context->value_doc != NULL )
1021 // Serialise the tree to get value
1022 xmlDocDumpMemory( context->value_doc, &value, &size );
1023 mlt_properties_set( properties, context->property, value );
1025 xmlFreeDoc( context->value_doc );
1026 context->value_doc = NULL;
1029 // Close this property handling
1030 free( context->property );
1031 context->property = NULL;
1033 context_push_service( context, service, type );
1037 fprintf( stderr, "Property without a service '%s'??\n", (char *)name );
1041 static void on_start_element( void *ctx, const xmlChar *name, const xmlChar **atts)
1043 struct _xmlParserCtxt *xmlcontext = ( struct _xmlParserCtxt* )ctx;
1044 deserialise_context context = ( deserialise_context )( xmlcontext->_private );
1046 //printf("on_start_element: %s\n", name );
1047 context->branch[ context->depth ] ++;
1050 // Build a tree from nodes within a property value
1051 if ( context->is_value == 1 )
1053 xmlNodePtr node = xmlNewNode( NULL, name );
1055 if ( context->value_doc == NULL )
1058 context->value_doc = xmlNewDoc( "1.0" );
1059 xmlDocSetRootElement( context->value_doc, node );
1063 // Append child to tree
1064 xmlAddChild( context->stack_node[ context->stack_node_size - 1 ], node );
1066 context_push_node( context, node );
1068 // Set the attributes
1069 for ( ; atts != NULL && *atts != NULL; atts += 2 )
1070 xmlSetProp( node, atts[ 0 ], atts[ 1 ] );
1072 else if ( strcmp( name, "tractor" ) == 0 )
1073 on_start_tractor( context, name, atts );
1074 else if ( strcmp( name, "multitrack" ) == 0 )
1075 on_start_multitrack( context, name, atts );
1076 else if ( strcmp( name, "playlist" ) == 0 || strcmp( name, "seq" ) == 0 || strcmp( name, "smil" ) == 0 )
1077 on_start_playlist( context, name, atts );
1078 else if ( strcmp( name, "producer" ) == 0 || strcmp( name, "video" ) == 0 )
1079 on_start_producer( context, name, atts );
1080 else if ( strcmp( name, "blank" ) == 0 )
1081 on_start_blank( context, name, atts );
1082 else if ( strcmp( name, "entry" ) == 0 )
1083 on_start_entry( context, name, atts );
1084 else if ( strcmp( name, "track" ) == 0 )
1085 on_start_track( context, name, atts );
1086 else if ( strcmp( name, "filter" ) == 0 )
1087 on_start_filter( context, name, atts );
1088 else if ( strcmp( name, "transition" ) == 0 )
1089 on_start_transition( context, name, atts );
1090 else if ( strcmp( name, "property" ) == 0 )
1091 on_start_property( context, name, atts );
1092 else if ( strcmp( name, "westley" ) == 0 )
1093 for ( ; atts != NULL && *atts != NULL; atts += 2 )
1094 mlt_properties_set( context->producer_map, ( char * )atts[ 0 ], ( char * )atts[ 1 ] );
1097 static void on_end_element( void *ctx, const xmlChar *name )
1099 struct _xmlParserCtxt *xmlcontext = ( struct _xmlParserCtxt* )ctx;
1100 deserialise_context context = ( deserialise_context )( xmlcontext->_private );
1102 //printf("on_end_element: %s\n", name );
1103 if ( context->is_value == 1 && strcmp( name, "property" ) != 0 )
1104 context_pop_node( context );
1105 else if ( strcmp( name, "multitrack" ) == 0 )
1106 on_end_multitrack( context, name );
1107 else if ( strcmp( name, "playlist" ) == 0 || strcmp( name, "seq" ) == 0 || strcmp( name, "smil" ) == 0 )
1108 on_end_playlist( context, name );
1109 else if ( strcmp( name, "track" ) == 0 )
1110 on_end_track( context, name );
1111 else if ( strcmp( name, "entry" ) == 0 )
1112 on_end_entry( context, name );
1113 else if ( strcmp( name, "tractor" ) == 0 )
1114 on_end_tractor( context, name );
1115 else if ( strcmp( name, "property" ) == 0 )
1116 on_end_property( context, name );
1117 else if ( strcmp( name, "producer" ) == 0 || strcmp( name, "video" ) == 0 )
1118 on_end_producer( context, name );
1119 else if ( strcmp( name, "filter" ) == 0 )
1120 on_end_filter( context, name );
1121 else if ( strcmp( name, "transition" ) == 0 )
1122 on_end_transition( context, name );
1124 context->branch[ context->depth ] = 0;
1128 static void on_characters( void *ctx, const xmlChar *ch, int len )
1130 struct _xmlParserCtxt *xmlcontext = ( struct _xmlParserCtxt* )ctx;
1131 deserialise_context context = ( deserialise_context )( xmlcontext->_private );
1132 char *value = calloc( len + 1, 1 );
1133 enum service_type type;
1134 mlt_service service = context_pop_service( context, &type );
1135 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
1137 if ( service != NULL )
1138 context_push_service( context, service, type );
1141 strncpy( value, (const char*) ch, len );
1143 if ( context->stack_node_size > 0 )
1144 xmlNodeAddContent( context->stack_node[ context->stack_node_size - 1 ], ( xmlChar* )value );
1146 // libxml2 generates an on_characters immediately after a get_entity within
1147 // an element value, and we ignore it because it is called again during
1148 // actual substitution.
1149 else if ( context->property != NULL && context->entity_is_replace == 0 )
1151 char *s = mlt_properties_get( properties, context->property );
1154 // Append new text to existing content
1155 char *new = calloc( strlen( s ) + len + 1, 1 );
1157 strcat( new, value );
1158 mlt_properties_set( properties, context->property, new );
1162 mlt_properties_set( properties, context->property, value );
1164 context->entity_is_replace = 0;
1169 /** Convert parameters parsed from resource into entity declarations.
1171 static void params_to_entities( deserialise_context context )
1173 if ( context->params != NULL )
1177 // Add our params as entitiy declarations
1178 for ( i = 0; i < mlt_properties_count( context->params ); i++ )
1180 xmlChar *name = ( xmlChar* )mlt_properties_get_name( context->params, i );
1181 xmlAddDocEntity( context->entity_doc, name, XML_INTERNAL_GENERAL_ENTITY,
1182 context->publicId, context->systemId, ( xmlChar* )mlt_properties_get( context->params, name ) );
1186 mlt_properties_close( context->params );
1187 context->params = NULL;
1191 // The following 3 facilitate entity substitution in the SAX parser
1192 static void on_internal_subset( void *ctx, const xmlChar* name,
1193 const xmlChar* publicId, const xmlChar* systemId )
1195 struct _xmlParserCtxt *xmlcontext = ( struct _xmlParserCtxt* )ctx;
1196 deserialise_context context = ( deserialise_context )( xmlcontext->_private );
1198 context->publicId = publicId;
1199 context->systemId = systemId;
1200 xmlCreateIntSubset( context->entity_doc, name, publicId, systemId );
1202 // Override default entities with our parameters
1203 params_to_entities( context );
1206 // TODO: Check this with Dan... I think this is for westley parameterisation
1207 // but it's breaking standard escaped entities (like < etc).
1208 static void on_entity_declaration( void *ctx, const xmlChar* name, int type,
1209 const xmlChar* publicId, const xmlChar* systemId, xmlChar* content)
1211 struct _xmlParserCtxt *xmlcontext = ( struct _xmlParserCtxt* )ctx;
1212 deserialise_context context = ( deserialise_context )( xmlcontext->_private );
1214 xmlAddDocEntity( context->entity_doc, name, type, publicId, systemId, content );
1217 // TODO: Check this functionality (see on_entity_declaration)
1218 static xmlEntityPtr on_get_entity( void *ctx, const xmlChar* name )
1220 struct _xmlParserCtxt *xmlcontext = ( struct _xmlParserCtxt* )ctx;
1221 deserialise_context context = ( deserialise_context )( xmlcontext->_private );
1222 xmlEntityPtr e = NULL;
1224 // Setup for entity declarations if not ready
1225 if ( xmlGetIntSubset( context->entity_doc ) == NULL )
1227 xmlCreateIntSubset( context->entity_doc, "westley", "", "" );
1228 context->publicId = "";
1229 context->systemId = "";
1232 // Add our parameters if not already
1233 params_to_entities( context );
1235 e = xmlGetPredefinedEntity( name );
1237 // Send signal to on_characters that an entity substitutin is pending
1240 e = xmlGetDocEntity( context->entity_doc, name );
1242 context->entity_is_replace = 1;
1248 /** Convert a hexadecimal character to its value.
1250 static int tohex( char p )
1252 return isdigit( p ) ? p - '0' : tolower( p ) - 'a' + 10;
1255 /** Decode a url-encoded string containing hexadecimal character sequences.
1257 static char *url_decode( char *dest, char *src )
1265 *p ++ = ( tohex( *( src + 1 ) ) << 4 ) | tohex( *( src + 2 ) );
1278 /** Extract the filename from a URL attaching parameters to a properties list.
1280 static void parse_url( mlt_properties properties, char *url )
1283 int n = strlen( url );
1287 for ( i = 0; i < n; i++ )
1304 if ( name != NULL && value != NULL )
1305 mlt_properties_set( properties, name, value );
1311 if ( name != NULL && value != NULL )
1312 mlt_properties_set( properties, name, value );
1315 // Quick workaround to avoid unecessary libxml2 warnings
1316 static int file_exists( char *file )
1318 char *name = strdup( file );
1320 if ( name != NULL && strchr( name, '?' ) )
1321 *( strchr( name, '?' ) ) = '\0';
1324 FILE *f = fopen( name, "r" );
1326 if ( exists ) fclose( f );
1332 mlt_producer producer_westley_init( int info, char *data )
1334 xmlSAXHandler *sax = calloc( 1, sizeof( xmlSAXHandler ) );
1335 struct deserialise_context_s *context = calloc( 1, sizeof( struct deserialise_context_s ) );
1336 mlt_properties properties = NULL;
1338 struct _xmlParserCtxt *xmlcontext;
1339 int well_formed = 0;
1340 char *filename = NULL;
1342 if ( data == NULL || !strcmp( data, "" ) || ( info == 0 && !file_exists( data ) ) )
1345 context = calloc( 1, sizeof( struct deserialise_context_s ) );
1346 if ( context == NULL )
1349 context->producer_map = mlt_properties_new();
1350 context->destructors = mlt_properties_new();
1351 context->params = mlt_properties_new();
1353 // Decode URL and parse parameters
1354 mlt_properties_set( context->producer_map, "root", "" );
1357 filename = strdup( data );
1358 parse_url( context->params, url_decode( filename, data ) );
1360 // We need the directory prefix which was used for the westley
1361 if ( strchr( filename, '/' ) )
1364 mlt_properties_set( context->producer_map, "root", filename );
1365 root = mlt_properties_get( context->producer_map, "root" );
1366 *( strrchr( root, '/' ) ) = '\0';
1368 // If we don't have an absolute path here, we're heading for disaster...
1369 if ( root[ 0 ] != '/' )
1371 char *cwd = getcwd( NULL, 0 );
1372 char *real = malloc( strlen( cwd ) + strlen( root ) + 2 );
1373 sprintf( real, "%s/%s", cwd, root );
1374 mlt_properties_set( context->producer_map, "root", real );
1381 // We need to track the number of registered filters
1382 mlt_properties_set_int( context->destructors, "registered", 0 );
1384 // Setup SAX callbacks
1385 sax->startElement = on_start_element;
1386 sax->endElement = on_end_element;
1387 sax->characters = on_characters;
1388 sax->cdataBlock = on_characters;
1389 sax->internalSubset = on_internal_subset;
1390 sax->entityDecl = on_entity_declaration;
1391 sax->getEntity = on_get_entity;
1393 // Setup libxml2 SAX parsing
1395 xmlSubstituteEntitiesDefault( 1 );
1396 // This is used to facilitate entity substitution in the SAX parser
1397 context->entity_doc = xmlNewDoc( "1.0" );
1399 xmlcontext = xmlCreateFileParserCtxt( filename );
1401 xmlcontext = xmlCreateMemoryParserCtxt( data, strlen( data ) );
1403 // Invalid context - clean up and return NULL
1404 if ( xmlcontext == NULL )
1406 mlt_properties_close( context->producer_map );
1407 mlt_properties_close( context->destructors );
1408 mlt_properties_close( context->params );
1415 xmlcontext->sax = sax;
1416 xmlcontext->_private = ( void* )context;
1419 xmlParseDocument( xmlcontext );
1420 well_formed = xmlcontext->wellFormed;
1422 // Cleanup after parsing
1423 xmlFreeDoc( context->entity_doc );
1425 xmlcontext->sax = NULL;
1426 xmlcontext->_private = NULL;
1427 xmlFreeParserCtxt( xmlcontext );
1428 xmlMemoryDump( ); // for debugging
1430 // Get the last producer on the stack
1431 enum service_type type;
1432 mlt_service service = context_pop_service( context, &type );
1433 if ( well_formed && service != NULL )
1435 // Verify it is a producer service (mlt_type="mlt_producer")
1436 // (producer, playlist, multitrack)
1437 char *type = mlt_properties_get( MLT_SERVICE_PROPERTIES( service ), "mlt_type" );
1438 if ( type == NULL || ( strcmp( type, "mlt_producer" ) != 0 && strcmp( type, "producer" ) != 0 ) )
1443 xmlDocPtr doc = westley_make_doc( service );
1444 xmlDocFormatDump( stdout, doc, 1 );
1449 if ( well_formed && service != NULL )
1451 char *title = mlt_properties_get( context->producer_map, "title" );
1453 // Need the complete producer list for various reasons
1454 properties = context->destructors;
1456 // Now make sure we don't have a reference to the service in the properties
1457 for ( i = mlt_properties_count( properties ) - 1; i >= 1; i -- )
1459 char *name = mlt_properties_get_name( properties, i );
1460 if ( mlt_properties_get_data( properties, name, NULL ) == service )
1462 mlt_properties_set_data( properties, name, service, 0, NULL, NULL );
1467 // We are done referencing destructor property list
1468 // Set this var to service properties for convenience
1469 properties = MLT_SERVICE_PROPERTIES( service );
1472 mlt_properties_set( properties, "title", title );
1474 // Optimise for overlapping producers
1475 mlt_producer_optimise( MLT_PRODUCER( service ) );
1477 // Handle deep copies
1478 if ( getenv( "MLT_WESTLEY_DEEP" ) == NULL )
1480 // Now assign additional properties
1482 mlt_properties_set( properties, "resource", data );
1484 // This tells consumer_westley not to deep copy
1485 mlt_properties_set( properties, "westley", "was here" );
1489 // Allow the project to be edited
1490 mlt_properties_set( properties, "_westley", "was here" );
1491 mlt_properties_set_int( properties, "_mlt_service_hidden", 1 );
1496 // Return null if not well formed
1501 mlt_properties_close( context->producer_map );
1502 if ( context->params != NULL )
1503 mlt_properties_close( context->params );
1504 mlt_properties_close( context->destructors );
1508 return MLT_PRODUCER( service );