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 static void on_end_producer( deserialise_context context, const xmlChar *name )
438 enum service_type type;
439 mlt_service service = context_pop_service( context, &type );
440 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
442 if ( service != NULL && type == mlt_dummy_producer_type )
444 mlt_service producer = NULL;
446 qualify_property( context, properties, "resource" );
447 char *resource = mlt_properties_get( properties, "resource" );
449 // Let Kino-SMIL src be a synonym for resource
450 if ( resource == NULL )
452 qualify_property( context, properties, "src" );
453 resource = mlt_properties_get( properties, "src" );
456 // Instantiate the producer
457 if ( mlt_properties_get( properties, "mlt_service" ) != NULL )
460 strncpy( temp, mlt_properties_get( properties, "mlt_service" ), 1024 );
461 if ( resource != NULL )
464 strncat( temp, resource, 1023 - strlen( temp ) );
466 producer = MLT_SERVICE( mlt_factory_producer( "fezzik", temp ) );
469 // Just in case the plugin requested doesn't exist...
470 if ( producer == NULL && resource != NULL )
471 producer = MLT_SERVICE( mlt_factory_producer( "fezzik", resource ) );
473 if ( producer == NULL )
474 producer = MLT_SERVICE( mlt_factory_producer( "fezzik", "+INVALID.txt" ) );
476 // Track this producer
477 track_service( context->destructors, producer, (mlt_destructor) mlt_producer_close );
479 // Propogate the properties
480 qualify_property( context, properties, "resource" );
481 qualify_property( context, properties, "luma" );
482 qualify_property( context, properties, "luma.resource" );
483 qualify_property( context, properties, "composite.luma" );
484 qualify_property( context, properties, "producer.resource" );
486 // Handle in/out properties separately
487 mlt_position in = -1;
488 mlt_position out = -1;
491 if ( mlt_properties_get( properties, "in" ) != NULL )
492 in = mlt_properties_get_position( properties, "in" );
493 // Let Kino-SMIL clipBegin be a synonym for in
494 if ( mlt_properties_get( properties, "clipBegin" ) != NULL )
495 in = mlt_properties_get_position( properties, "clipBegin" );
497 if ( mlt_properties_get( properties, "out" ) != NULL )
498 out = mlt_properties_get_position( properties, "out" );
499 // Let Kino-SMIL clipEnd be a synonym for out
500 if ( mlt_properties_get( properties, "clipEnd" ) != NULL )
501 out = mlt_properties_get_position( properties, "clipEnd" );
504 mlt_properties_set( properties, "in", NULL );
505 mlt_properties_set( properties, "out", NULL );
507 // Inherit the properties
508 mlt_properties_inherit( MLT_SERVICE_PROPERTIES( producer ), properties );
510 // Attach all filters from service onto producer
511 attach_filters( producer, service );
513 // Add the producer to the producer map
514 if ( mlt_properties_get( properties, "id" ) != NULL )
515 mlt_properties_set_data( context->producer_map, mlt_properties_get(properties, "id"), producer, 0, NULL, NULL );
517 // See if the producer should be added to a playlist or multitrack
518 if ( add_producer( context, producer, in, out ) == 0 )
520 // Otherwise, set in and out on...
521 if ( in != -1 || out != -1 )
523 // Get the parent service
524 enum service_type type;
525 mlt_service parent = context_pop_service( context, &type );
526 if ( parent != NULL )
528 // Get the parent properties
529 properties = MLT_SERVICE_PROPERTIES( parent );
531 char *resource = mlt_properties_get( properties, "resource" );
533 // Put the parent producer back
534 context_push_service( context, parent, type );
536 // If the parent is a track or entry
537 if ( resource && ( strcmp( resource, "<entry>" ) == 0 ) )
539 mlt_properties_set_position( properties, "in", in );
540 mlt_properties_set_position( properties, "out", out );
544 // Otherwise, set in and out on producer directly
545 mlt_producer_set_in_and_out( MLT_PRODUCER( producer ), in, out );
550 // Otherwise, set in and out on producer directly
551 mlt_producer_set_in_and_out( MLT_PRODUCER( producer ), in, out );
555 // Push the producer onto the stack
556 context_push_service( context, producer, mlt_producer_type );
559 mlt_service_close( service );
563 static void on_start_blank( deserialise_context context, const xmlChar *name, const xmlChar **atts)
565 // Get the playlist from the stack
566 enum service_type type;
567 mlt_service service = context_pop_service( context, &type );
568 mlt_position length = 0;
570 if ( type == mlt_playlist_type && service != NULL )
572 // Look for the length attribute
573 for ( ; atts != NULL && *atts != NULL; atts += 2 )
575 if ( strcmp( atts[0], "length" ) == 0 )
577 length = atoll( atts[1] );
582 // Append a blank to the playlist
583 mlt_playlist_blank( MLT_PLAYLIST( service ), length - 1 );
585 // Push the playlist back onto the stack
586 context_push_service( context, service, type );
590 fprintf( stderr, "blank without a playlist - a definite no no\n" );
594 static void on_start_entry( deserialise_context context, const xmlChar *name, const xmlChar **atts)
596 mlt_producer entry = NULL;
597 mlt_properties temp = mlt_properties_new( );
599 for ( ; atts != NULL && *atts != NULL; atts += 2 )
601 mlt_properties_set( temp, (char*) atts[0], atts[1] == NULL ? "" : (char*) atts[1] );
603 // Look for the producer attribute
604 if ( strcmp( atts[ 0 ], "producer" ) == 0 )
606 mlt_producer producer = mlt_properties_get_data( context->producer_map, (char*) atts[1], NULL );
607 if ( producer != NULL )
608 mlt_properties_set_data( temp, "producer", producer, 0, NULL, NULL );
612 // If we have a valid entry
613 if ( mlt_properties_get_data( temp, "producer", NULL ) != NULL )
615 mlt_playlist_clip_info info;
616 enum service_type parent_type;
617 mlt_service parent = context_pop_service( context, &parent_type );
618 mlt_producer producer = mlt_properties_get_data( temp, "producer", NULL );
620 if ( parent_type == mlt_playlist_type )
622 // Append the producer to the playlist
623 if ( mlt_properties_get( temp, "in" ) != NULL || mlt_properties_get( temp, "out" ) != NULL )
625 mlt_playlist_append_io( MLT_PLAYLIST( parent ), producer,
626 mlt_properties_get_position( temp, "in" ),
627 mlt_properties_get_position( temp, "out" ) );
631 mlt_playlist_append( MLT_PLAYLIST( parent ), producer );
634 // Handle the repeat property
635 if ( mlt_properties_get_int( temp, "repeat" ) > 0 )
637 mlt_playlist_repeat_clip( MLT_PLAYLIST( parent ),
638 mlt_playlist_count( MLT_PLAYLIST( parent ) ) - 1,
639 mlt_properties_get_int( temp, "repeat" ) );
642 mlt_playlist_get_clip_info( MLT_PLAYLIST( parent ), &info, mlt_playlist_count( MLT_PLAYLIST( parent ) ) - 1 );
647 fprintf( stderr, "Entry not part of a playlist...\n" );
650 context_push_service( context, parent, parent_type );
653 // Push the cut onto the stack
654 context_push_service( context, MLT_PRODUCER_SERVICE( entry ), mlt_entry_type );
656 mlt_properties_close( temp );
659 static void on_end_entry( deserialise_context context, const xmlChar *name )
661 // Get the entry from the stack
662 enum service_type entry_type;
663 mlt_service entry = context_pop_service( context, &entry_type );
665 if ( entry == NULL && entry_type != mlt_entry_type )
667 fprintf( stderr, "Invalid state at end of entry\n" );
671 static void on_start_track( deserialise_context context, const xmlChar *name, const xmlChar **atts)
673 // use a dummy service to hold properties to allow arbitrary nesting
674 mlt_service service = calloc( 1, sizeof( struct mlt_service_s ) );
675 mlt_service_init( service, NULL );
677 // Push the dummy service onto the stack
678 context_push_service( context, service, mlt_entry_type );
680 mlt_properties_set( MLT_SERVICE_PROPERTIES( service ), "resource", "<track>" );
682 for ( ; atts != NULL && *atts != NULL; atts += 2 )
684 mlt_properties_set( MLT_SERVICE_PROPERTIES( service ), (char*) atts[0], atts[1] == NULL ? "" : (char*) atts[1] );
686 // Look for the producer attribute
687 if ( strcmp( atts[ 0 ], "producer" ) == 0 )
689 mlt_producer producer = mlt_properties_get_data( context->producer_map, (char*) atts[1], NULL );
690 if ( producer != NULL )
691 mlt_properties_set_data( MLT_SERVICE_PROPERTIES( service ), "producer", producer, 0, NULL, NULL );
696 static void on_end_track( deserialise_context context, const xmlChar *name )
698 // Get the track from the stack
699 enum service_type track_type;
700 mlt_service track = context_pop_service( context, &track_type );
702 if ( track != NULL && track_type == mlt_entry_type )
704 mlt_properties track_props = MLT_SERVICE_PROPERTIES( track );
705 enum service_type parent_type;
706 mlt_service parent = context_pop_service( context, &parent_type );
707 mlt_multitrack multitrack = NULL;
709 mlt_producer producer = mlt_properties_get_data( track_props, "producer", NULL );
710 mlt_properties producer_props = MLT_PRODUCER_PROPERTIES( producer );
712 if ( parent_type == mlt_tractor_type )
713 multitrack = mlt_tractor_multitrack( MLT_TRACTOR( parent ) );
714 else if ( parent_type == mlt_multitrack_type )
715 multitrack = MLT_MULTITRACK( parent );
717 fprintf( stderr, "track contained in an invalid container\n" );
719 if ( multitrack != NULL )
721 // Set producer i/o if specified
722 if ( mlt_properties_get( track_props, "in" ) != NULL ||
723 mlt_properties_get( track_props, "out" ) != NULL )
725 mlt_producer cut = mlt_producer_cut( MLT_PRODUCER( producer ),
726 mlt_properties_get_position( track_props, "in" ),
727 mlt_properties_get_position( track_props, "out" ) );
728 mlt_multitrack_connect( multitrack, cut, mlt_multitrack_count( multitrack ) );
729 mlt_properties_inherit( MLT_PRODUCER_PROPERTIES( cut ), track_props );
730 track_props = MLT_PRODUCER_PROPERTIES( cut );
731 mlt_producer_close( cut );
735 mlt_multitrack_connect( multitrack, producer, mlt_multitrack_count( multitrack ) );
738 // Set the hide state of the track producer
739 char *hide_s = mlt_properties_get( track_props, "hide" );
740 if ( hide_s != NULL )
742 if ( strcmp( hide_s, "video" ) == 0 )
743 mlt_properties_set_int( producer_props, "hide", 1 );
744 else if ( strcmp( hide_s, "audio" ) == 0 )
745 mlt_properties_set_int( producer_props, "hide", 2 );
746 else if ( strcmp( hide_s, "both" ) == 0 )
747 mlt_properties_set_int( producer_props, "hide", 3 );
751 if ( parent != NULL )
752 context_push_service( context, parent, parent_type );
754 mlt_service_close( track );
758 fprintf( stderr, "Invalid state at end of track\n" );
762 static void on_start_filter( deserialise_context context, const xmlChar *name, const xmlChar **atts)
764 // use a dummy service to hold properties to allow arbitrary nesting
765 mlt_service service = calloc( 1, sizeof( struct mlt_service_s ) );
766 mlt_service_init( service, NULL );
768 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
770 context_push_service( context, service, mlt_dummy_filter_type );
772 // Set the properties
773 for ( ; atts != NULL && *atts != NULL; atts += 2 )
774 mlt_properties_set( properties, (char*) atts[0], (char*) atts[1] );
777 static void on_end_filter( deserialise_context context, const xmlChar *name )
779 enum service_type type;
780 mlt_service service = context_pop_service( context, &type );
781 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
783 enum service_type parent_type;
784 mlt_service parent = context_pop_service( context, &parent_type );
786 if ( service != NULL && type == mlt_dummy_filter_type )
788 mlt_service filter = MLT_SERVICE( mlt_factory_filter( mlt_properties_get( properties, "mlt_service" ), NULL ) );
789 mlt_properties filter_props = MLT_SERVICE_PROPERTIES( filter );
791 track_service( context->destructors, filter, (mlt_destructor) mlt_filter_close );
793 // Propogate the properties
794 qualify_property( context, properties, "resource" );
795 qualify_property( context, properties, "luma" );
796 qualify_property( context, properties, "luma.resource" );
797 qualify_property( context, properties, "composite.luma" );
798 qualify_property( context, properties, "producer.resource" );
799 mlt_properties_inherit( filter_props, properties );
801 // Attach all filters from service onto filter
802 attach_filters( filter, service );
804 // Associate the filter with the parent
805 if ( parent != NULL )
807 if ( parent_type == mlt_tractor_type )
809 mlt_field field = mlt_tractor_field( MLT_TRACTOR( parent ) );
810 mlt_field_plant_filter( field, MLT_FILTER( filter ), mlt_properties_get_int( properties, "track" ) );
811 mlt_filter_set_in_and_out( MLT_FILTER( filter ),
812 mlt_properties_get_int( properties, "in" ),
813 mlt_properties_get_int( properties, "out" ) );
817 mlt_service_attach( parent, MLT_FILTER( filter ) );
820 // Put the parent back on the stack
821 context_push_service( context, parent, parent_type );
825 fprintf( stderr, "filter closed with invalid parent...\n" );
828 // Close the dummy filter service
829 mlt_service_close( service );
833 fprintf( stderr, "Invalid top of stack on filter close\n" );
837 static void on_start_transition( deserialise_context context, const xmlChar *name, const xmlChar **atts)
839 // use a dummy service to hold properties to allow arbitrary nesting
840 mlt_service service = calloc( 1, sizeof( struct mlt_service_s ) );
841 mlt_service_init( service, NULL );
843 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
845 context_push_service( context, service, mlt_dummy_transition_type );
847 // Set the properties
848 for ( ; atts != NULL && *atts != NULL; atts += 2 )
849 mlt_properties_set( properties, (char*) atts[0], (char*) atts[1] );
852 static void on_end_transition( deserialise_context context, const xmlChar *name )
854 enum service_type type;
855 mlt_service service = context_pop_service( context, &type );
856 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
858 enum service_type parent_type;
859 mlt_service parent = context_pop_service( context, &parent_type );
861 if ( service != NULL && type == mlt_dummy_transition_type )
863 mlt_service effect = MLT_SERVICE( mlt_factory_transition(mlt_properties_get(properties,"mlt_service"), NULL ) );
864 mlt_properties effect_props = MLT_SERVICE_PROPERTIES( effect );
866 track_service( context->destructors, effect, (mlt_destructor) mlt_transition_close );
868 // Propogate the properties
869 qualify_property( context, properties, "resource" );
870 qualify_property( context, properties, "luma" );
871 qualify_property( context, properties, "luma.resource" );
872 qualify_property( context, properties, "composite.luma" );
873 qualify_property( context, properties, "producer.resource" );
874 mlt_properties_inherit( effect_props, properties );
876 // Attach all filters from service onto effect
877 attach_filters( effect, service );
879 // Associate the filter with the parent
880 if ( parent != NULL )
882 if ( parent_type == mlt_tractor_type )
884 mlt_field field = mlt_tractor_field( MLT_TRACTOR( parent ) );
885 if ( mlt_properties_get_int( properties, "a_track" ) == mlt_properties_get_int( properties, "b_track" ) )
886 mlt_properties_set_int( properties, "b_track", mlt_properties_get_int( properties, "a_track" ) + 1 );
887 mlt_field_plant_transition( field, MLT_TRANSITION( effect ),
888 mlt_properties_get_int( properties, "a_track" ),
889 mlt_properties_get_int( properties, "b_track" ) );
890 mlt_transition_set_in_and_out( MLT_TRANSITION( effect ),
891 mlt_properties_get_int( properties, "in" ),
892 mlt_properties_get_int( properties, "out" ) );
896 fprintf( stderr, "Misplaced transition - ignoring\n" );
899 // Put the parent back on the stack
900 context_push_service( context, parent, parent_type );
904 fprintf( stderr, "transition closed with invalid parent...\n" );
907 // Close the dummy filter service
908 mlt_service_close( service );
912 fprintf( stderr, "Invalid top of stack on transition close\n" );
916 static void on_start_property( deserialise_context context, const xmlChar *name, const xmlChar **atts)
918 enum service_type type;
919 mlt_service service = context_pop_service( context, &type );
920 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
923 if ( service != NULL )
925 // Set the properties
926 for ( ; atts != NULL && *atts != NULL; atts += 2 )
928 if ( strcmp( atts[ 0 ], "name" ) == 0 )
929 context->property = strdup( atts[ 1 ] );
930 else if ( strcmp( atts[ 0 ], "value" ) == 0 )
931 value = (char*) atts[ 1 ];
934 if ( context->property != NULL )
935 mlt_properties_set( properties, context->property, value == NULL ? "" : value );
937 // Tell parser to collect any further nodes for serialisation
938 context->is_value = 1;
940 context_push_service( context, service, type );
944 fprintf( stderr, "Property without a service '%s'?\n", ( char * )name );
948 static void on_end_property( deserialise_context context, const xmlChar *name )
950 enum service_type type;
951 mlt_service service = context_pop_service( context, &type );
952 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
954 if ( service != NULL )
956 // Tell parser to stop building a tree
957 context->is_value = 0;
959 // See if there is a xml tree for the value
960 if ( context->property != NULL && context->value_doc != NULL )
965 // Serialise the tree to get value
966 xmlDocDumpMemory( context->value_doc, &value, &size );
967 mlt_properties_set( properties, context->property, value );
969 xmlFreeDoc( context->value_doc );
970 context->value_doc = NULL;
973 // Close this property handling
974 free( context->property );
975 context->property = NULL;
977 context_push_service( context, service, type );
981 fprintf( stderr, "Property without a service '%s'??\n", (char *)name );
985 static void on_start_element( void *ctx, const xmlChar *name, const xmlChar **atts)
987 struct _xmlParserCtxt *xmlcontext = ( struct _xmlParserCtxt* )ctx;
988 deserialise_context context = ( deserialise_context )( xmlcontext->_private );
990 //printf("on_start_element: %s\n", name );
991 context->branch[ context->depth ] ++;
994 // Build a tree from nodes within a property value
995 if ( context->is_value == 1 )
997 xmlNodePtr node = xmlNewNode( NULL, name );
999 if ( context->value_doc == NULL )
1002 context->value_doc = xmlNewDoc( "1.0" );
1003 xmlDocSetRootElement( context->value_doc, node );
1007 // Append child to tree
1008 xmlAddChild( context->stack_node[ context->stack_node_size - 1 ], node );
1010 context_push_node( context, node );
1012 // Set the attributes
1013 for ( ; atts != NULL && *atts != NULL; atts += 2 )
1014 xmlSetProp( node, atts[ 0 ], atts[ 1 ] );
1016 else if ( strcmp( name, "tractor" ) == 0 )
1017 on_start_tractor( context, name, atts );
1018 else if ( strcmp( name, "multitrack" ) == 0 )
1019 on_start_multitrack( context, name, atts );
1020 else if ( strcmp( name, "playlist" ) == 0 || strcmp( name, "seq" ) == 0 || strcmp( name, "smil" ) == 0 )
1021 on_start_playlist( context, name, atts );
1022 else if ( strcmp( name, "producer" ) == 0 || strcmp( name, "video" ) == 0 )
1023 on_start_producer( context, name, atts );
1024 else if ( strcmp( name, "blank" ) == 0 )
1025 on_start_blank( context, name, atts );
1026 else if ( strcmp( name, "entry" ) == 0 )
1027 on_start_entry( context, name, atts );
1028 else if ( strcmp( name, "track" ) == 0 )
1029 on_start_track( context, name, atts );
1030 else if ( strcmp( name, "filter" ) == 0 )
1031 on_start_filter( context, name, atts );
1032 else if ( strcmp( name, "transition" ) == 0 )
1033 on_start_transition( context, name, atts );
1034 else if ( strcmp( name, "property" ) == 0 )
1035 on_start_property( context, name, atts );
1036 else if ( strcmp( name, "westley" ) == 0 )
1037 for ( ; atts != NULL && *atts != NULL; atts += 2 )
1038 mlt_properties_set( context->producer_map, ( char * )atts[ 0 ], ( char * )atts[ 1 ] );
1041 static void on_end_element( void *ctx, const xmlChar *name )
1043 struct _xmlParserCtxt *xmlcontext = ( struct _xmlParserCtxt* )ctx;
1044 deserialise_context context = ( deserialise_context )( xmlcontext->_private );
1046 //printf("on_end_element: %s\n", name );
1047 if ( context->is_value == 1 && strcmp( name, "property" ) != 0 )
1048 context_pop_node( context );
1049 else if ( strcmp( name, "multitrack" ) == 0 )
1050 on_end_multitrack( context, name );
1051 else if ( strcmp( name, "playlist" ) == 0 || strcmp( name, "seq" ) == 0 || strcmp( name, "smil" ) == 0 )
1052 on_end_playlist( context, name );
1053 else if ( strcmp( name, "track" ) == 0 )
1054 on_end_track( context, name );
1055 else if ( strcmp( name, "entry" ) == 0 )
1056 on_end_entry( context, name );
1057 else if ( strcmp( name, "tractor" ) == 0 )
1058 on_end_tractor( context, name );
1059 else if ( strcmp( name, "property" ) == 0 )
1060 on_end_property( context, name );
1061 else if ( strcmp( name, "producer" ) == 0 || strcmp( name, "video" ) == 0 )
1062 on_end_producer( context, name );
1063 else if ( strcmp( name, "filter" ) == 0 )
1064 on_end_filter( context, name );
1065 else if ( strcmp( name, "transition" ) == 0 )
1066 on_end_transition( context, name );
1068 context->branch[ context->depth ] = 0;
1072 static void on_characters( void *ctx, const xmlChar *ch, int len )
1074 struct _xmlParserCtxt *xmlcontext = ( struct _xmlParserCtxt* )ctx;
1075 deserialise_context context = ( deserialise_context )( xmlcontext->_private );
1076 char *value = calloc( len + 1, 1 );
1077 enum service_type type;
1078 mlt_service service = context_pop_service( context, &type );
1079 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
1081 if ( service != NULL )
1082 context_push_service( context, service, type );
1085 strncpy( value, (const char*) ch, len );
1087 if ( context->stack_node_size > 0 )
1088 xmlNodeAddContent( context->stack_node[ context->stack_node_size - 1 ], ( xmlChar* )value );
1090 // libxml2 generates an on_characters immediately after a get_entity within
1091 // an element value, and we ignore it because it is called again during
1092 // actual substitution.
1093 else if ( context->property != NULL && context->entity_is_replace == 0 )
1095 char *s = mlt_properties_get( properties, context->property );
1098 // Append new text to existing content
1099 char *new = calloc( strlen( s ) + len + 1, 1 );
1101 strcat( new, value );
1102 mlt_properties_set( properties, context->property, new );
1106 mlt_properties_set( properties, context->property, value );
1108 context->entity_is_replace = 0;
1113 /** Convert parameters parsed from resource into entity declarations.
1115 static void params_to_entities( deserialise_context context )
1117 if ( context->params != NULL )
1121 // Add our params as entitiy declarations
1122 for ( i = 0; i < mlt_properties_count( context->params ); i++ )
1124 xmlChar *name = ( xmlChar* )mlt_properties_get_name( context->params, i );
1125 xmlAddDocEntity( context->entity_doc, name, XML_INTERNAL_GENERAL_ENTITY,
1126 context->publicId, context->systemId, ( xmlChar* )mlt_properties_get( context->params, name ) );
1130 mlt_properties_close( context->params );
1131 context->params = NULL;
1135 // The following 3 facilitate entity substitution in the SAX parser
1136 static void on_internal_subset( void *ctx, const xmlChar* name,
1137 const xmlChar* publicId, const xmlChar* systemId )
1139 struct _xmlParserCtxt *xmlcontext = ( struct _xmlParserCtxt* )ctx;
1140 deserialise_context context = ( deserialise_context )( xmlcontext->_private );
1142 context->publicId = publicId;
1143 context->systemId = systemId;
1144 xmlCreateIntSubset( context->entity_doc, name, publicId, systemId );
1146 // Override default entities with our parameters
1147 params_to_entities( context );
1150 // TODO: Check this with Dan... I think this is for westley parameterisation
1151 // but it's breaking standard escaped entities (like < etc).
1152 static void on_entity_declaration( void *ctx, const xmlChar* name, int type,
1153 const xmlChar* publicId, const xmlChar* systemId, xmlChar* content)
1155 struct _xmlParserCtxt *xmlcontext = ( struct _xmlParserCtxt* )ctx;
1156 deserialise_context context = ( deserialise_context )( xmlcontext->_private );
1158 xmlAddDocEntity( context->entity_doc, name, type, publicId, systemId, content );
1161 // TODO: Check this functionality (see on_entity_declaration)
1162 static xmlEntityPtr on_get_entity( void *ctx, const xmlChar* name )
1164 struct _xmlParserCtxt *xmlcontext = ( struct _xmlParserCtxt* )ctx;
1165 deserialise_context context = ( deserialise_context )( xmlcontext->_private );
1166 xmlEntityPtr e = NULL;
1168 // Setup for entity declarations if not ready
1169 if ( xmlGetIntSubset( context->entity_doc ) == NULL )
1171 xmlCreateIntSubset( context->entity_doc, "westley", "", "" );
1172 context->publicId = "";
1173 context->systemId = "";
1176 // Add our parameters if not already
1177 params_to_entities( context );
1179 e = xmlGetDocEntity( context->entity_doc, name );
1181 // Send signal to on_characters that an entity substitutin is pending
1183 context->entity_is_replace = 1;
1188 /** Convert a hexadecimal character to its value.
1190 static int tohex( char p )
1192 return isdigit( p ) ? p - '0' : tolower( p ) - 'a' + 10;
1195 /** Decode a url-encoded string containing hexadecimal character sequences.
1197 static char *url_decode( char *dest, char *src )
1205 *p ++ = ( tohex( *( src + 1 ) ) << 4 ) | tohex( *( src + 2 ) );
1218 /** Extract the filename from a URL attaching parameters to a properties list.
1220 static void parse_url( mlt_properties properties, char *url )
1223 int n = strlen( url );
1227 for ( i = 0; i < n; i++ )
1244 if ( name != NULL && value != NULL )
1245 mlt_properties_set( properties, name, value );
1251 if ( name != NULL && value != NULL )
1252 mlt_properties_set( properties, name, value );
1255 mlt_producer producer_westley_init( int info, char *data )
1259 xmlSAXHandler *sax = calloc( 1, sizeof( xmlSAXHandler ) );
1260 struct deserialise_context_s *context = calloc( 1, sizeof( struct deserialise_context_s ) );
1261 mlt_properties properties = NULL;
1263 struct _xmlParserCtxt *xmlcontext;
1264 int well_formed = 0;
1265 char *filename = NULL;
1267 context->producer_map = mlt_properties_new();
1268 context->destructors = mlt_properties_new();
1269 context->params = mlt_properties_new();
1271 // Decode URL and parse parameters
1272 mlt_properties_set( context->producer_map, "root", "" );
1275 filename = strdup( data );
1276 parse_url( context->params, url_decode( filename, data ) );
1278 // We need the directory prefix which was used for the westley
1279 if ( strchr( filename, '/' ) )
1282 mlt_properties_set( context->producer_map, "root", filename );
1283 root = mlt_properties_get( context->producer_map, "root" );
1284 *( strrchr( root, '/' ) ) = '\0';
1286 // If we don't have an absolute path here, we're heading for disaster...
1287 if ( root[ 0 ] != '/' )
1289 char *cwd = getcwd( NULL, 0 );
1290 char *real = malloc( strlen( cwd ) + strlen( root ) + 2 );
1291 sprintf( real, "%s/%s", cwd, root );
1292 mlt_properties_set( context->producer_map, "root", real );
1299 // We need to track the number of registered filters
1300 mlt_properties_set_int( context->destructors, "registered", 0 );
1302 // Setup SAX callbacks
1303 sax->startElement = on_start_element;
1304 sax->endElement = on_end_element;
1305 sax->characters = on_characters;
1306 sax->cdataBlock = on_characters;
1307 sax->internalSubset = on_internal_subset;
1308 sax->entityDecl = on_entity_declaration;
1309 //sax->getEntity = on_get_entity;
1311 // Setup libxml2 SAX parsing
1313 xmlSubstituteEntitiesDefault( 1 );
1314 // This is used to facilitate entity substitution in the SAX parser
1315 context->entity_doc = xmlNewDoc( "1.0" );
1317 xmlcontext = xmlCreateFileParserCtxt( filename );
1319 xmlcontext = xmlCreateMemoryParserCtxt( data, strlen( data ) );
1321 // Invalid context - clean up and return NULL
1322 if ( xmlcontext == NULL )
1324 mlt_properties_close( context->producer_map );
1325 mlt_properties_close( context->destructors );
1326 mlt_properties_close( context->params );
1333 xmlcontext->sax = sax;
1334 xmlcontext->_private = ( void* )context;
1337 xmlParseDocument( xmlcontext );
1338 well_formed = xmlcontext->wellFormed;
1340 // Cleanup after parsing
1341 xmlFreeDoc( context->entity_doc );
1343 xmlcontext->sax = NULL;
1344 xmlcontext->_private = NULL;
1345 xmlFreeParserCtxt( xmlcontext );
1346 xmlMemoryDump( ); // for debugging
1348 // Get the last producer on the stack
1349 enum service_type type;
1350 mlt_service service = context_pop_service( context, &type );
1351 if ( well_formed && service != NULL )
1353 // Verify it is a producer service (mlt_type="mlt_producer")
1354 // (producer, playlist, multitrack)
1355 char *type = mlt_properties_get( MLT_SERVICE_PROPERTIES( service ), "mlt_type" );
1356 if ( type == NULL || ( strcmp( type, "mlt_producer" ) != 0 && strcmp( type, "producer" ) != 0 ) )
1361 xmlDocPtr doc = westley_make_doc( service );
1362 xmlDocFormatDump( stdout, doc, 1 );
1367 if ( well_formed && service != NULL )
1369 char *title = mlt_properties_get( context->producer_map, "title" );
1371 // Need the complete producer list for various reasons
1372 properties = context->destructors;
1374 // Now make sure we don't have a reference to the service in the properties
1375 for ( i = mlt_properties_count( properties ) - 1; i >= 1; i -- )
1377 char *name = mlt_properties_get_name( properties, i );
1378 if ( mlt_properties_get_data( properties, name, NULL ) == service )
1380 mlt_properties_set_data( properties, name, service, 0, NULL, NULL );
1385 // We are done referencing destructor property list
1386 // Set this var to service properties for convenience
1387 properties = MLT_SERVICE_PROPERTIES( service );
1390 mlt_properties_set( properties, "title", title );
1392 // Optimise for overlapping producers
1393 mlt_producer_optimise( MLT_PRODUCER( service ) );
1395 // Handle deep copies
1396 if ( getenv( "MLT_WESTLEY_DEEP" ) == NULL )
1398 // Now assign additional properties
1400 mlt_properties_set( properties, "resource", data );
1402 // This tells consumer_westley not to deep copy
1403 mlt_properties_set( properties, "westley", "was here" );
1407 // Allow the project to be edited
1408 mlt_properties_set( properties, "_westley", "was here" );
1409 mlt_properties_set_int( properties, "_mlt_service_hidden", 1 );
1414 // Return null if not well formed
1419 mlt_properties_close( context->producer_map );
1420 if ( context->params != NULL )
1421 mlt_properties_close( context->params );
1422 mlt_properties_close( context->destructors );
1426 return MLT_PRODUCER( service );