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" );
448 int fx_cut = mlt_properties_get_int( properties, "meta.fx_cut" );
450 // Let Kino-SMIL src be a synonym for resource
451 if ( resource == NULL )
453 qualify_property( context, properties, "src" );
454 resource = mlt_properties_get( properties, "src" );
457 // Instantiate the producer
458 if ( !fx_cut && mlt_properties_get( properties, "mlt_service" ) != NULL )
461 strncpy( temp, mlt_properties_get( properties, "mlt_service" ), 1024 );
462 if ( resource != NULL )
465 strncat( temp, resource, 1023 - strlen( temp ) );
467 producer = MLT_SERVICE( mlt_factory_producer( "fezzik", temp ) );
471 producer = MLT_SERVICE( mlt_factory_producer( mlt_properties_get( properties, "mlt_service" ), resource ) );
474 // Just in case the plugin requested doesn't exist...
475 if ( producer == NULL && resource != NULL )
476 producer = MLT_SERVICE( mlt_factory_producer( "fezzik", resource ) );
478 if ( producer == NULL )
479 producer = MLT_SERVICE( mlt_factory_producer( "fezzik", "+INVALID.txt" ) );
481 // Track this producer
482 track_service( context->destructors, producer, (mlt_destructor) mlt_producer_close );
484 // Propogate the properties
485 qualify_property( context, properties, "resource" );
486 qualify_property( context, properties, "luma" );
487 qualify_property( context, properties, "luma.resource" );
488 qualify_property( context, properties, "composite.luma" );
489 qualify_property( context, properties, "producer.resource" );
491 // Handle in/out properties separately
492 mlt_position in = -1;
493 mlt_position out = -1;
496 if ( mlt_properties_get( properties, "in" ) != NULL )
497 in = mlt_properties_get_position( properties, "in" );
498 // Let Kino-SMIL clipBegin be a synonym for in
499 if ( mlt_properties_get( properties, "clipBegin" ) != NULL )
500 in = mlt_properties_get_position( properties, "clipBegin" );
502 if ( mlt_properties_get( properties, "out" ) != NULL )
503 out = mlt_properties_get_position( properties, "out" );
504 // Let Kino-SMIL clipEnd be a synonym for out
505 if ( mlt_properties_get( properties, "clipEnd" ) != NULL )
506 out = mlt_properties_get_position( properties, "clipEnd" );
509 mlt_properties_set( properties, "in", NULL );
510 mlt_properties_set( properties, "out", NULL );
512 // Inherit the properties
513 mlt_properties_inherit( MLT_SERVICE_PROPERTIES( producer ), properties );
515 // Attach all filters from service onto producer
516 attach_filters( producer, service );
518 // Add the producer to the producer map
519 if ( mlt_properties_get( properties, "id" ) != NULL )
520 mlt_properties_set_data( context->producer_map, mlt_properties_get(properties, "id"), producer, 0, NULL, NULL );
522 // See if the producer should be added to a playlist or multitrack
523 if ( add_producer( context, producer, in, out ) == 0 )
525 // Otherwise, set in and out on...
526 if ( in != -1 || out != -1 )
528 // Get the parent service
529 enum service_type type;
530 mlt_service parent = context_pop_service( context, &type );
531 if ( parent != NULL )
533 // Get the parent properties
534 properties = MLT_SERVICE_PROPERTIES( parent );
536 char *resource = mlt_properties_get( properties, "resource" );
538 // Put the parent producer back
539 context_push_service( context, parent, type );
541 // If the parent is a track or entry
542 if ( resource && ( strcmp( resource, "<entry>" ) == 0 ) )
544 mlt_properties_set_position( properties, "in", in );
545 mlt_properties_set_position( properties, "out", out );
549 // Otherwise, set in and out on producer directly
550 mlt_producer_set_in_and_out( MLT_PRODUCER( producer ), in, out );
555 // Otherwise, set in and out on producer directly
556 mlt_producer_set_in_and_out( MLT_PRODUCER( producer ), in, out );
560 // Push the producer onto the stack
561 context_push_service( context, producer, mlt_producer_type );
564 mlt_service_close( service );
568 static void on_start_blank( deserialise_context context, const xmlChar *name, const xmlChar **atts)
570 // Get the playlist from the stack
571 enum service_type type;
572 mlt_service service = context_pop_service( context, &type );
573 mlt_position length = 0;
575 if ( type == mlt_playlist_type && service != NULL )
577 // Look for the length attribute
578 for ( ; atts != NULL && *atts != NULL; atts += 2 )
580 if ( strcmp( atts[0], "length" ) == 0 )
582 length = atoll( atts[1] );
587 // Append a blank to the playlist
588 mlt_playlist_blank( MLT_PLAYLIST( service ), length - 1 );
590 // Push the playlist back onto the stack
591 context_push_service( context, service, type );
595 fprintf( stderr, "blank without a playlist - a definite no no\n" );
599 static void on_start_entry( deserialise_context context, const xmlChar *name, const xmlChar **atts)
601 mlt_producer entry = NULL;
602 mlt_properties temp = mlt_properties_new( );
604 for ( ; atts != NULL && *atts != NULL; atts += 2 )
606 mlt_properties_set( temp, (char*) atts[0], atts[1] == NULL ? "" : (char*) atts[1] );
608 // Look for the producer attribute
609 if ( strcmp( atts[ 0 ], "producer" ) == 0 )
611 mlt_producer producer = mlt_properties_get_data( context->producer_map, (char*) atts[1], NULL );
612 if ( producer != NULL )
613 mlt_properties_set_data( temp, "producer", producer, 0, NULL, NULL );
617 // If we have a valid entry
618 if ( mlt_properties_get_data( temp, "producer", NULL ) != NULL )
620 mlt_playlist_clip_info info;
621 enum service_type parent_type;
622 mlt_service parent = context_pop_service( context, &parent_type );
623 mlt_producer producer = mlt_properties_get_data( temp, "producer", NULL );
625 if ( parent_type == mlt_playlist_type )
627 // Append the producer to the playlist
628 if ( mlt_properties_get( temp, "in" ) != NULL || mlt_properties_get( temp, "out" ) != NULL )
630 mlt_playlist_append_io( MLT_PLAYLIST( parent ), producer,
631 mlt_properties_get_position( temp, "in" ),
632 mlt_properties_get_position( temp, "out" ) );
636 mlt_playlist_append( MLT_PLAYLIST( parent ), producer );
639 // Handle the repeat property
640 if ( mlt_properties_get_int( temp, "repeat" ) > 0 )
642 mlt_playlist_repeat_clip( MLT_PLAYLIST( parent ),
643 mlt_playlist_count( MLT_PLAYLIST( parent ) ) - 1,
644 mlt_properties_get_int( temp, "repeat" ) );
647 mlt_playlist_get_clip_info( MLT_PLAYLIST( parent ), &info, mlt_playlist_count( MLT_PLAYLIST( parent ) ) - 1 );
652 fprintf( stderr, "Entry not part of a playlist...\n" );
655 context_push_service( context, parent, parent_type );
658 // Push the cut onto the stack
659 context_push_service( context, MLT_PRODUCER_SERVICE( entry ), mlt_entry_type );
661 mlt_properties_close( temp );
664 static void on_end_entry( deserialise_context context, const xmlChar *name )
666 // Get the entry from the stack
667 enum service_type entry_type;
668 mlt_service entry = context_pop_service( context, &entry_type );
670 if ( entry == NULL && entry_type != mlt_entry_type )
672 fprintf( stderr, "Invalid state at end of entry\n" );
676 static void on_start_track( deserialise_context context, const xmlChar *name, const xmlChar **atts)
678 // use a dummy service to hold properties to allow arbitrary nesting
679 mlt_service service = calloc( 1, sizeof( struct mlt_service_s ) );
680 mlt_service_init( service, NULL );
682 // Push the dummy service onto the stack
683 context_push_service( context, service, mlt_entry_type );
685 mlt_properties_set( MLT_SERVICE_PROPERTIES( service ), "resource", "<track>" );
687 for ( ; atts != NULL && *atts != NULL; atts += 2 )
689 mlt_properties_set( MLT_SERVICE_PROPERTIES( service ), (char*) atts[0], atts[1] == NULL ? "" : (char*) atts[1] );
691 // Look for the producer attribute
692 if ( strcmp( atts[ 0 ], "producer" ) == 0 )
694 mlt_producer producer = mlt_properties_get_data( context->producer_map, (char*) atts[1], NULL );
695 if ( producer != NULL )
696 mlt_properties_set_data( MLT_SERVICE_PROPERTIES( service ), "producer", producer, 0, NULL, NULL );
701 static void on_end_track( deserialise_context context, const xmlChar *name )
703 // Get the track from the stack
704 enum service_type track_type;
705 mlt_service track = context_pop_service( context, &track_type );
707 if ( track != NULL && track_type == mlt_entry_type )
709 mlt_properties track_props = MLT_SERVICE_PROPERTIES( track );
710 enum service_type parent_type;
711 mlt_service parent = context_pop_service( context, &parent_type );
712 mlt_multitrack multitrack = NULL;
714 mlt_producer producer = mlt_properties_get_data( track_props, "producer", NULL );
715 mlt_properties producer_props = MLT_PRODUCER_PROPERTIES( producer );
717 if ( parent_type == mlt_tractor_type )
718 multitrack = mlt_tractor_multitrack( MLT_TRACTOR( parent ) );
719 else if ( parent_type == mlt_multitrack_type )
720 multitrack = MLT_MULTITRACK( parent );
722 fprintf( stderr, "track contained in an invalid container\n" );
724 if ( multitrack != NULL )
726 // Set producer i/o if specified
727 if ( mlt_properties_get( track_props, "in" ) != NULL ||
728 mlt_properties_get( track_props, "out" ) != NULL )
730 mlt_producer cut = mlt_producer_cut( MLT_PRODUCER( producer ),
731 mlt_properties_get_position( track_props, "in" ),
732 mlt_properties_get_position( track_props, "out" ) );
733 mlt_multitrack_connect( multitrack, cut, mlt_multitrack_count( multitrack ) );
734 mlt_properties_inherit( MLT_PRODUCER_PROPERTIES( cut ), track_props );
735 track_props = MLT_PRODUCER_PROPERTIES( cut );
736 mlt_producer_close( cut );
740 mlt_multitrack_connect( multitrack, producer, mlt_multitrack_count( multitrack ) );
743 // Set the hide state of the track producer
744 char *hide_s = mlt_properties_get( track_props, "hide" );
745 if ( hide_s != NULL )
747 if ( strcmp( hide_s, "video" ) == 0 )
748 mlt_properties_set_int( producer_props, "hide", 1 );
749 else if ( strcmp( hide_s, "audio" ) == 0 )
750 mlt_properties_set_int( producer_props, "hide", 2 );
751 else if ( strcmp( hide_s, "both" ) == 0 )
752 mlt_properties_set_int( producer_props, "hide", 3 );
756 if ( parent != NULL )
757 context_push_service( context, parent, parent_type );
759 mlt_service_close( track );
763 fprintf( stderr, "Invalid state at end of track\n" );
767 static void on_start_filter( deserialise_context context, const xmlChar *name, const xmlChar **atts)
769 // use a dummy service to hold properties to allow arbitrary nesting
770 mlt_service service = calloc( 1, sizeof( struct mlt_service_s ) );
771 mlt_service_init( service, NULL );
773 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
775 context_push_service( context, service, mlt_dummy_filter_type );
777 // Set the properties
778 for ( ; atts != NULL && *atts != NULL; atts += 2 )
779 mlt_properties_set( properties, (char*) atts[0], (char*) atts[1] );
782 static void on_end_filter( deserialise_context context, const xmlChar *name )
784 enum service_type type;
785 mlt_service service = context_pop_service( context, &type );
786 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
788 enum service_type parent_type;
789 mlt_service parent = context_pop_service( context, &parent_type );
791 if ( service != NULL && type == mlt_dummy_filter_type )
793 mlt_service filter = MLT_SERVICE( mlt_factory_filter( mlt_properties_get( properties, "mlt_service" ), NULL ) );
794 mlt_properties filter_props = MLT_SERVICE_PROPERTIES( filter );
796 track_service( context->destructors, filter, (mlt_destructor) mlt_filter_close );
798 // Propogate the properties
799 qualify_property( context, properties, "resource" );
800 qualify_property( context, properties, "luma" );
801 qualify_property( context, properties, "luma.resource" );
802 qualify_property( context, properties, "composite.luma" );
803 qualify_property( context, properties, "producer.resource" );
804 mlt_properties_inherit( filter_props, properties );
806 // Attach all filters from service onto filter
807 attach_filters( filter, service );
809 // Associate the filter with the parent
810 if ( parent != NULL )
812 if ( parent_type == mlt_tractor_type )
814 mlt_field field = mlt_tractor_field( MLT_TRACTOR( parent ) );
815 mlt_field_plant_filter( field, MLT_FILTER( filter ), mlt_properties_get_int( properties, "track" ) );
816 mlt_filter_set_in_and_out( MLT_FILTER( filter ),
817 mlt_properties_get_int( properties, "in" ),
818 mlt_properties_get_int( properties, "out" ) );
822 mlt_service_attach( parent, MLT_FILTER( filter ) );
825 // Put the parent back on the stack
826 context_push_service( context, parent, parent_type );
830 fprintf( stderr, "filter closed with invalid parent...\n" );
833 // Close the dummy filter service
834 mlt_service_close( service );
838 fprintf( stderr, "Invalid top of stack on filter close\n" );
842 static void on_start_transition( deserialise_context context, const xmlChar *name, const xmlChar **atts)
844 // use a dummy service to hold properties to allow arbitrary nesting
845 mlt_service service = calloc( 1, sizeof( struct mlt_service_s ) );
846 mlt_service_init( service, NULL );
848 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
850 context_push_service( context, service, mlt_dummy_transition_type );
852 // Set the properties
853 for ( ; atts != NULL && *atts != NULL; atts += 2 )
854 mlt_properties_set( properties, (char*) atts[0], (char*) atts[1] );
857 static void on_end_transition( deserialise_context context, const xmlChar *name )
859 enum service_type type;
860 mlt_service service = context_pop_service( context, &type );
861 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
863 enum service_type parent_type;
864 mlt_service parent = context_pop_service( context, &parent_type );
866 if ( service != NULL && type == mlt_dummy_transition_type )
868 mlt_service effect = MLT_SERVICE( mlt_factory_transition(mlt_properties_get(properties,"mlt_service"), NULL ) );
869 mlt_properties effect_props = MLT_SERVICE_PROPERTIES( effect );
871 track_service( context->destructors, effect, (mlt_destructor) mlt_transition_close );
873 // Propogate the properties
874 qualify_property( context, properties, "resource" );
875 qualify_property( context, properties, "luma" );
876 qualify_property( context, properties, "luma.resource" );
877 qualify_property( context, properties, "composite.luma" );
878 qualify_property( context, properties, "producer.resource" );
879 mlt_properties_inherit( effect_props, properties );
881 // Attach all filters from service onto effect
882 attach_filters( effect, service );
884 // Associate the filter with the parent
885 if ( parent != NULL )
887 if ( parent_type == mlt_tractor_type )
889 mlt_field field = mlt_tractor_field( MLT_TRACTOR( parent ) );
890 if ( mlt_properties_get_int( properties, "a_track" ) == mlt_properties_get_int( properties, "b_track" ) )
891 mlt_properties_set_int( properties, "b_track", mlt_properties_get_int( properties, "a_track" ) + 1 );
892 mlt_field_plant_transition( field, MLT_TRANSITION( effect ),
893 mlt_properties_get_int( properties, "a_track" ),
894 mlt_properties_get_int( properties, "b_track" ) );
895 mlt_transition_set_in_and_out( MLT_TRANSITION( effect ),
896 mlt_properties_get_int( properties, "in" ),
897 mlt_properties_get_int( properties, "out" ) );
901 fprintf( stderr, "Misplaced transition - ignoring\n" );
904 // Put the parent back on the stack
905 context_push_service( context, parent, parent_type );
909 fprintf( stderr, "transition closed with invalid parent...\n" );
912 // Close the dummy filter service
913 mlt_service_close( service );
917 fprintf( stderr, "Invalid top of stack on transition close\n" );
921 static void on_start_property( deserialise_context context, const xmlChar *name, const xmlChar **atts)
923 enum service_type type;
924 mlt_service service = context_pop_service( context, &type );
925 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
928 if ( service != NULL )
930 // Set the properties
931 for ( ; atts != NULL && *atts != NULL; atts += 2 )
933 if ( strcmp( atts[ 0 ], "name" ) == 0 )
934 context->property = strdup( atts[ 1 ] );
935 else if ( strcmp( atts[ 0 ], "value" ) == 0 )
936 value = (char*) atts[ 1 ];
939 if ( context->property != NULL )
940 mlt_properties_set( properties, context->property, value == NULL ? "" : value );
942 // Tell parser to collect any further nodes for serialisation
943 context->is_value = 1;
945 context_push_service( context, service, type );
949 fprintf( stderr, "Property without a service '%s'?\n", ( char * )name );
953 static void on_end_property( deserialise_context context, const xmlChar *name )
955 enum service_type type;
956 mlt_service service = context_pop_service( context, &type );
957 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
959 if ( service != NULL )
961 // Tell parser to stop building a tree
962 context->is_value = 0;
964 // See if there is a xml tree for the value
965 if ( context->property != NULL && context->value_doc != NULL )
970 // Serialise the tree to get value
971 xmlDocDumpMemory( context->value_doc, &value, &size );
972 mlt_properties_set( properties, context->property, value );
974 xmlFreeDoc( context->value_doc );
975 context->value_doc = NULL;
978 // Close this property handling
979 free( context->property );
980 context->property = NULL;
982 context_push_service( context, service, type );
986 fprintf( stderr, "Property without a service '%s'??\n", (char *)name );
990 static void on_start_element( void *ctx, const xmlChar *name, const xmlChar **atts)
992 struct _xmlParserCtxt *xmlcontext = ( struct _xmlParserCtxt* )ctx;
993 deserialise_context context = ( deserialise_context )( xmlcontext->_private );
995 //printf("on_start_element: %s\n", name );
996 context->branch[ context->depth ] ++;
999 // Build a tree from nodes within a property value
1000 if ( context->is_value == 1 )
1002 xmlNodePtr node = xmlNewNode( NULL, name );
1004 if ( context->value_doc == NULL )
1007 context->value_doc = xmlNewDoc( "1.0" );
1008 xmlDocSetRootElement( context->value_doc, node );
1012 // Append child to tree
1013 xmlAddChild( context->stack_node[ context->stack_node_size - 1 ], node );
1015 context_push_node( context, node );
1017 // Set the attributes
1018 for ( ; atts != NULL && *atts != NULL; atts += 2 )
1019 xmlSetProp( node, atts[ 0 ], atts[ 1 ] );
1021 else if ( strcmp( name, "tractor" ) == 0 )
1022 on_start_tractor( context, name, atts );
1023 else if ( strcmp( name, "multitrack" ) == 0 )
1024 on_start_multitrack( context, name, atts );
1025 else if ( strcmp( name, "playlist" ) == 0 || strcmp( name, "seq" ) == 0 || strcmp( name, "smil" ) == 0 )
1026 on_start_playlist( context, name, atts );
1027 else if ( strcmp( name, "producer" ) == 0 || strcmp( name, "video" ) == 0 )
1028 on_start_producer( context, name, atts );
1029 else if ( strcmp( name, "blank" ) == 0 )
1030 on_start_blank( context, name, atts );
1031 else if ( strcmp( name, "entry" ) == 0 )
1032 on_start_entry( context, name, atts );
1033 else if ( strcmp( name, "track" ) == 0 )
1034 on_start_track( context, name, atts );
1035 else if ( strcmp( name, "filter" ) == 0 )
1036 on_start_filter( context, name, atts );
1037 else if ( strcmp( name, "transition" ) == 0 )
1038 on_start_transition( context, name, atts );
1039 else if ( strcmp( name, "property" ) == 0 )
1040 on_start_property( context, name, atts );
1041 else if ( strcmp( name, "westley" ) == 0 )
1042 for ( ; atts != NULL && *atts != NULL; atts += 2 )
1043 mlt_properties_set( context->producer_map, ( char * )atts[ 0 ], ( char * )atts[ 1 ] );
1046 static void on_end_element( void *ctx, const xmlChar *name )
1048 struct _xmlParserCtxt *xmlcontext = ( struct _xmlParserCtxt* )ctx;
1049 deserialise_context context = ( deserialise_context )( xmlcontext->_private );
1051 //printf("on_end_element: %s\n", name );
1052 if ( context->is_value == 1 && strcmp( name, "property" ) != 0 )
1053 context_pop_node( context );
1054 else if ( strcmp( name, "multitrack" ) == 0 )
1055 on_end_multitrack( context, name );
1056 else if ( strcmp( name, "playlist" ) == 0 || strcmp( name, "seq" ) == 0 || strcmp( name, "smil" ) == 0 )
1057 on_end_playlist( context, name );
1058 else if ( strcmp( name, "track" ) == 0 )
1059 on_end_track( context, name );
1060 else if ( strcmp( name, "entry" ) == 0 )
1061 on_end_entry( context, name );
1062 else if ( strcmp( name, "tractor" ) == 0 )
1063 on_end_tractor( context, name );
1064 else if ( strcmp( name, "property" ) == 0 )
1065 on_end_property( context, name );
1066 else if ( strcmp( name, "producer" ) == 0 || strcmp( name, "video" ) == 0 )
1067 on_end_producer( context, name );
1068 else if ( strcmp( name, "filter" ) == 0 )
1069 on_end_filter( context, name );
1070 else if ( strcmp( name, "transition" ) == 0 )
1071 on_end_transition( context, name );
1073 context->branch[ context->depth ] = 0;
1077 static void on_characters( void *ctx, const xmlChar *ch, int len )
1079 struct _xmlParserCtxt *xmlcontext = ( struct _xmlParserCtxt* )ctx;
1080 deserialise_context context = ( deserialise_context )( xmlcontext->_private );
1081 char *value = calloc( len + 1, 1 );
1082 enum service_type type;
1083 mlt_service service = context_pop_service( context, &type );
1084 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
1086 if ( service != NULL )
1087 context_push_service( context, service, type );
1090 strncpy( value, (const char*) ch, len );
1092 if ( context->stack_node_size > 0 )
1093 xmlNodeAddContent( context->stack_node[ context->stack_node_size - 1 ], ( xmlChar* )value );
1095 // libxml2 generates an on_characters immediately after a get_entity within
1096 // an element value, and we ignore it because it is called again during
1097 // actual substitution.
1098 else if ( context->property != NULL && context->entity_is_replace == 0 )
1100 char *s = mlt_properties_get( properties, context->property );
1103 // Append new text to existing content
1104 char *new = calloc( strlen( s ) + len + 1, 1 );
1106 strcat( new, value );
1107 mlt_properties_set( properties, context->property, new );
1111 mlt_properties_set( properties, context->property, value );
1113 context->entity_is_replace = 0;
1118 /** Convert parameters parsed from resource into entity declarations.
1120 static void params_to_entities( deserialise_context context )
1122 if ( context->params != NULL )
1126 // Add our params as entitiy declarations
1127 for ( i = 0; i < mlt_properties_count( context->params ); i++ )
1129 xmlChar *name = ( xmlChar* )mlt_properties_get_name( context->params, i );
1130 xmlAddDocEntity( context->entity_doc, name, XML_INTERNAL_GENERAL_ENTITY,
1131 context->publicId, context->systemId, ( xmlChar* )mlt_properties_get( context->params, name ) );
1135 mlt_properties_close( context->params );
1136 context->params = NULL;
1140 // The following 3 facilitate entity substitution in the SAX parser
1141 static void on_internal_subset( void *ctx, const xmlChar* name,
1142 const xmlChar* publicId, const xmlChar* systemId )
1144 struct _xmlParserCtxt *xmlcontext = ( struct _xmlParserCtxt* )ctx;
1145 deserialise_context context = ( deserialise_context )( xmlcontext->_private );
1147 context->publicId = publicId;
1148 context->systemId = systemId;
1149 xmlCreateIntSubset( context->entity_doc, name, publicId, systemId );
1151 // Override default entities with our parameters
1152 params_to_entities( context );
1155 // TODO: Check this with Dan... I think this is for westley parameterisation
1156 // but it's breaking standard escaped entities (like < etc).
1157 static void on_entity_declaration( void *ctx, const xmlChar* name, int type,
1158 const xmlChar* publicId, const xmlChar* systemId, xmlChar* content)
1160 struct _xmlParserCtxt *xmlcontext = ( struct _xmlParserCtxt* )ctx;
1161 deserialise_context context = ( deserialise_context )( xmlcontext->_private );
1163 xmlAddDocEntity( context->entity_doc, name, type, publicId, systemId, content );
1166 // TODO: Check this functionality (see on_entity_declaration)
1167 static xmlEntityPtr on_get_entity( void *ctx, const xmlChar* name )
1169 struct _xmlParserCtxt *xmlcontext = ( struct _xmlParserCtxt* )ctx;
1170 deserialise_context context = ( deserialise_context )( xmlcontext->_private );
1171 xmlEntityPtr e = NULL;
1173 // Setup for entity declarations if not ready
1174 if ( xmlGetIntSubset( context->entity_doc ) == NULL )
1176 xmlCreateIntSubset( context->entity_doc, "westley", "", "" );
1177 context->publicId = "";
1178 context->systemId = "";
1181 // Add our parameters if not already
1182 params_to_entities( context );
1184 e = xmlGetPredefinedEntity( name );
1186 // Send signal to on_characters that an entity substitutin is pending
1189 e = xmlGetDocEntity( context->entity_doc, name );
1191 context->entity_is_replace = 1;
1197 /** Convert a hexadecimal character to its value.
1199 static int tohex( char p )
1201 return isdigit( p ) ? p - '0' : tolower( p ) - 'a' + 10;
1204 /** Decode a url-encoded string containing hexadecimal character sequences.
1206 static char *url_decode( char *dest, char *src )
1214 *p ++ = ( tohex( *( src + 1 ) ) << 4 ) | tohex( *( src + 2 ) );
1227 /** Extract the filename from a URL attaching parameters to a properties list.
1229 static void parse_url( mlt_properties properties, char *url )
1232 int n = strlen( url );
1236 for ( i = 0; i < n; i++ )
1253 if ( name != NULL && value != NULL )
1254 mlt_properties_set( properties, name, value );
1260 if ( name != NULL && value != NULL )
1261 mlt_properties_set( properties, name, value );
1264 // Quick workaround to avoid unecessary libxml2 warnings
1265 static int file_exists( char *file )
1267 char *name = strdup( file );
1269 if ( name != NULL && strchr( name, '?' ) )
1270 *( strchr( name, '?' ) ) = '\0';
1273 FILE *f = fopen( name, "r" );
1275 if ( exists ) fclose( f );
1281 mlt_producer producer_westley_init( int info, char *data )
1283 xmlSAXHandler *sax = calloc( 1, sizeof( xmlSAXHandler ) );
1284 struct deserialise_context_s *context = calloc( 1, sizeof( struct deserialise_context_s ) );
1285 mlt_properties properties = NULL;
1287 struct _xmlParserCtxt *xmlcontext;
1288 int well_formed = 0;
1289 char *filename = NULL;
1291 if ( data == NULL || !strcmp( data, "" ) || ( info == 0 && !file_exists( data ) ) )
1294 context = calloc( 1, sizeof( struct deserialise_context_s ) );
1295 if ( context == NULL )
1298 context->producer_map = mlt_properties_new();
1299 context->destructors = mlt_properties_new();
1300 context->params = mlt_properties_new();
1302 // Decode URL and parse parameters
1303 mlt_properties_set( context->producer_map, "root", "" );
1306 filename = strdup( data );
1307 parse_url( context->params, url_decode( filename, data ) );
1309 // We need the directory prefix which was used for the westley
1310 if ( strchr( filename, '/' ) )
1313 mlt_properties_set( context->producer_map, "root", filename );
1314 root = mlt_properties_get( context->producer_map, "root" );
1315 *( strrchr( root, '/' ) ) = '\0';
1317 // If we don't have an absolute path here, we're heading for disaster...
1318 if ( root[ 0 ] != '/' )
1320 char *cwd = getcwd( NULL, 0 );
1321 char *real = malloc( strlen( cwd ) + strlen( root ) + 2 );
1322 sprintf( real, "%s/%s", cwd, root );
1323 mlt_properties_set( context->producer_map, "root", real );
1330 // We need to track the number of registered filters
1331 mlt_properties_set_int( context->destructors, "registered", 0 );
1333 // Setup SAX callbacks
1334 sax->startElement = on_start_element;
1335 sax->endElement = on_end_element;
1336 sax->characters = on_characters;
1337 sax->cdataBlock = on_characters;
1338 sax->internalSubset = on_internal_subset;
1339 sax->entityDecl = on_entity_declaration;
1340 sax->getEntity = on_get_entity;
1342 // Setup libxml2 SAX parsing
1344 xmlSubstituteEntitiesDefault( 1 );
1345 // This is used to facilitate entity substitution in the SAX parser
1346 context->entity_doc = xmlNewDoc( "1.0" );
1348 xmlcontext = xmlCreateFileParserCtxt( filename );
1350 xmlcontext = xmlCreateMemoryParserCtxt( data, strlen( data ) );
1352 // Invalid context - clean up and return NULL
1353 if ( xmlcontext == NULL )
1355 mlt_properties_close( context->producer_map );
1356 mlt_properties_close( context->destructors );
1357 mlt_properties_close( context->params );
1364 xmlcontext->sax = sax;
1365 xmlcontext->_private = ( void* )context;
1368 xmlParseDocument( xmlcontext );
1369 well_formed = xmlcontext->wellFormed;
1371 // Cleanup after parsing
1372 xmlFreeDoc( context->entity_doc );
1374 xmlcontext->sax = NULL;
1375 xmlcontext->_private = NULL;
1376 xmlFreeParserCtxt( xmlcontext );
1377 xmlMemoryDump( ); // for debugging
1379 // Get the last producer on the stack
1380 enum service_type type;
1381 mlt_service service = context_pop_service( context, &type );
1382 if ( well_formed && service != NULL )
1384 // Verify it is a producer service (mlt_type="mlt_producer")
1385 // (producer, playlist, multitrack)
1386 char *type = mlt_properties_get( MLT_SERVICE_PROPERTIES( service ), "mlt_type" );
1387 if ( type == NULL || ( strcmp( type, "mlt_producer" ) != 0 && strcmp( type, "producer" ) != 0 ) )
1392 xmlDocPtr doc = westley_make_doc( service );
1393 xmlDocFormatDump( stdout, doc, 1 );
1398 if ( well_formed && service != NULL )
1400 char *title = mlt_properties_get( context->producer_map, "title" );
1402 // Need the complete producer list for various reasons
1403 properties = context->destructors;
1405 // Now make sure we don't have a reference to the service in the properties
1406 for ( i = mlt_properties_count( properties ) - 1; i >= 1; i -- )
1408 char *name = mlt_properties_get_name( properties, i );
1409 if ( mlt_properties_get_data( properties, name, NULL ) == service )
1411 mlt_properties_set_data( properties, name, service, 0, NULL, NULL );
1416 // We are done referencing destructor property list
1417 // Set this var to service properties for convenience
1418 properties = MLT_SERVICE_PROPERTIES( service );
1421 mlt_properties_set( properties, "title", title );
1423 // Optimise for overlapping producers
1424 mlt_producer_optimise( MLT_PRODUCER( service ) );
1426 // Handle deep copies
1427 if ( getenv( "MLT_WESTLEY_DEEP" ) == NULL )
1429 // Now assign additional properties
1431 mlt_properties_set( properties, "resource", data );
1433 // This tells consumer_westley not to deep copy
1434 mlt_properties_set( properties, "westley", "was here" );
1438 // Allow the project to be edited
1439 mlt_properties_set( properties, "_westley", "was here" );
1440 mlt_properties_set_int( properties, "_mlt_service_hidden", 1 );
1445 // Return null if not well formed
1450 mlt_properties_close( context->producer_map );
1451 if ( context->params != NULL )
1452 mlt_properties_close( context->params );
1453 mlt_properties_close( context->destructors );
1457 return MLT_PRODUCER( service );