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_service service
= mlt_tractor_service( mlt_tractor_new( ) );
291 mlt_properties properties
= mlt_service_properties( service
);
293 track_service( context
->destructors
, service
, (mlt_destructor
) mlt_tractor_close
);
295 for ( ; atts
!= NULL
&& *atts
!= NULL
; atts
+= 2 )
296 mlt_properties_set( mlt_service_properties( service
), (char*) atts
[0], (char*) atts
[1] );
298 if ( mlt_properties_get( properties
, "id" ) != NULL
)
299 mlt_properties_set_data( context
->producer_map
, mlt_properties_get( properties
, "id" ), service
, 0, NULL
, NULL
);
301 context_push_service( context
, service
, mlt_tractor_type
);
304 static void on_end_tractor( deserialise_context context
, const xmlChar
*name
)
307 enum service_type type
;
308 mlt_service tractor
= context_pop_service( context
, &type
);
310 if ( tractor
!= NULL
&& type
== mlt_tractor_type
)
312 // See if the tractor should be added to a playlist or multitrack
313 if ( add_producer( context
, tractor
, 0, mlt_producer_get_out( MLT_PRODUCER( tractor
) ) ) == 0 )
314 context_push_service( context
, tractor
, type
);
318 static void on_start_multitrack( deserialise_context context
, const xmlChar
*name
, const xmlChar
**atts
)
320 enum service_type type
;
321 mlt_service parent
= context_pop_service( context
, &type
);
323 // If we don't have a parent, then create one now, providing we're in a state where we can
324 if ( parent
== NULL
|| ( type
== mlt_playlist_type
|| type
== mlt_multitrack_type
) )
326 // Push the parent back
327 if ( parent
!= NULL
)
328 context_push_service( context
, parent
, type
);
330 // Create a tractor to contain the multitrack
331 parent
= mlt_tractor_service( mlt_tractor_new( ) );
332 track_service( context
->destructors
, parent
, (mlt_destructor
) mlt_tractor_close
);
333 type
= mlt_tractor_type
;
335 // Flag it as a synthesised tractor for clean up later
336 mlt_properties_set_int( mlt_service_properties( parent
), "fezzik_synth", 1 );
339 if ( type
== mlt_tractor_type
)
341 mlt_service service
= MLT_SERVICE( mlt_tractor_multitrack( MLT_TRACTOR( parent
) ) );
342 mlt_properties properties
= mlt_service_properties( service
);
343 for ( ; atts
!= NULL
&& *atts
!= NULL
; atts
+= 2 )
344 mlt_properties_set( properties
, (char*) atts
[0], (char*) atts
[1] );
346 if ( mlt_properties_get( properties
, "id" ) != NULL
)
347 mlt_properties_set_data( context
->producer_map
, mlt_properties_get( properties
,"id" ), service
, 0, NULL
, NULL
);
349 context_push_service( context
, parent
, type
);
350 context_push_service( context
, service
, mlt_multitrack_type
);
354 fprintf( stderr
, "Invalid multitrack position\n" );
358 static void on_end_multitrack( deserialise_context context
, const xmlChar
*name
)
360 // Get the multitrack from the stack
361 enum service_type type
;
362 mlt_service service
= context_pop_service( context
, &type
);
364 if ( service
== NULL
|| type
!= mlt_multitrack_type
)
365 fprintf( stderr
, "End multitrack in the wrong state...\n" );
368 static void on_start_playlist( deserialise_context context
, const xmlChar
*name
, const xmlChar
**atts
)
370 mlt_service service
= mlt_playlist_service( mlt_playlist_init() );
371 mlt_properties properties
= mlt_service_properties( service
);
373 track_service( context
->destructors
, service
, (mlt_destructor
) mlt_playlist_close
);
375 for ( ; atts
!= NULL
&& *atts
!= NULL
; atts
+= 2 )
377 mlt_properties_set( properties
, ( char* )atts
[0], ( char* )atts
[1] );
379 // Out will be overwritten later as we append, so we need to save it
380 if ( strcmp( atts
[ 0 ], "out" ) == 0 )
381 mlt_properties_set( properties
, "_westley.out", ( char* )atts
[ 1 ] );
384 if ( mlt_properties_get( properties
, "id" ) != NULL
)
385 mlt_properties_set_data( context
->producer_map
, mlt_properties_get( properties
, "id" ), service
, 0, NULL
, NULL
);
387 context_push_service( context
, service
, mlt_playlist_type
);
390 static void on_end_playlist( deserialise_context context
, const xmlChar
*name
)
392 // Get the playlist from the stack
393 enum service_type type
;
394 mlt_service service
= context_pop_service( context
, &type
);
396 if ( service
!= NULL
&& type
== mlt_playlist_type
)
398 mlt_properties properties
= mlt_service_properties( service
);
399 mlt_position in
= mlt_properties_get_position( properties
, "in" );
400 mlt_position out
= mlt_properties_get_position( properties
, "out" );
402 // See if the playlist should be added to a playlist or multitrack
403 if ( add_producer( context
, service
, in
, out
) == 0 )
404 context_push_service( context
, service
, type
);
408 fprintf( stderr
, "Invalid state of playlist end\n" );
412 static void on_start_producer( deserialise_context context
, const xmlChar
*name
, const xmlChar
**atts
)
414 // use a dummy service to hold properties to allow arbitrary nesting
415 mlt_service service
= calloc( 1, sizeof( struct mlt_service_s
) );
416 mlt_service_init( service
, NULL
);
418 mlt_properties properties
= mlt_service_properties( service
);
420 context_push_service( context
, service
, mlt_dummy_producer_type
);
422 for ( ; atts
!= NULL
&& *atts
!= NULL
; atts
+= 2 )
423 mlt_properties_set( properties
, (char*) atts
[0], (char*) atts
[1] );
426 static void on_end_producer( deserialise_context context
, const xmlChar
*name
)
428 enum service_type type
;
429 mlt_service service
= context_pop_service( context
, &type
);
430 mlt_properties properties
= mlt_service_properties( service
);
432 if ( service
!= NULL
&& type
== mlt_dummy_producer_type
)
434 mlt_service producer
= NULL
;
436 qualify_property( context
, properties
, "resource" );
437 char *resource
= mlt_properties_get( properties
, "resource" );
439 // Let Kino-SMIL src be a synonym for resource
440 if ( resource
== NULL
)
442 qualify_property( context
, properties
, "src" );
443 resource
= mlt_properties_get( properties
, "src" );
446 // Instantiate the producer
447 if ( mlt_properties_get( properties
, "mlt_service" ) != NULL
)
450 strncpy( temp
, mlt_properties_get( properties
, "mlt_service" ), 1024 );
451 if ( resource
!= NULL
)
454 strncat( temp
, resource
, 1023 - strlen( temp
) );
456 producer
= MLT_SERVICE( mlt_factory_producer( "fezzik", temp
) );
459 // Just in case the plugin requested doesn't exist...
460 if ( producer
== NULL
&& resource
!= NULL
)
461 producer
= MLT_SERVICE( mlt_factory_producer( "fezzik", resource
) );
463 // Track this producer
464 track_service( context
->destructors
, producer
, (mlt_destructor
) mlt_producer_close
);
466 // Propogate the properties
467 qualify_property( context
, properties
, "resource" );
468 qualify_property( context
, properties
, "luma" );
469 qualify_property( context
, properties
, "luma.resource" );
470 qualify_property( context
, properties
, "composite.luma" );
471 qualify_property( context
, properties
, "producer.resource" );
473 // Handle in/out properties separately
474 mlt_position in
= -1;
475 mlt_position out
= -1;
478 if ( mlt_properties_get( properties
, "in" ) != NULL
)
479 in
= mlt_properties_get_position( properties
, "in" );
480 // Let Kino-SMIL clipBegin be a synonym for in
481 if ( mlt_properties_get( properties
, "clipBegin" ) != NULL
)
482 in
= mlt_properties_get_position( properties
, "clipBegin" );
484 if ( mlt_properties_get( properties
, "out" ) != NULL
)
485 out
= mlt_properties_get_position( properties
, "out" );
486 // Let Kino-SMIL clipEnd be a synonym for out
487 if ( mlt_properties_get( properties
, "clipEnd" ) != NULL
)
488 out
= mlt_properties_get_position( properties
, "clipEnd" );
491 mlt_properties_set( properties
, "in", NULL
);
492 mlt_properties_set( properties
, "out", NULL
);
494 // Inherit the properties
495 mlt_properties_inherit( mlt_service_properties( producer
), properties
);
497 // Attach all filters from service onto producer
498 attach_filters( producer
, service
);
500 // Add the producer to the producer map
501 if ( mlt_properties_get( properties
, "id" ) != NULL
)
502 mlt_properties_set_data( context
->producer_map
, mlt_properties_get(properties
, "id"), producer
, 0, NULL
, NULL
);
504 // See if the producer should be added to a playlist or multitrack
505 if ( add_producer( context
, producer
, in
, out
) == 0 )
507 // Otherwise, set in and out on...
508 if ( in
!= -1 || out
!= -1 )
510 // Get the parent service
511 enum service_type type
;
512 mlt_service parent
= context_pop_service( context
, &type
);
513 if ( parent
!= NULL
)
515 // Get the parent properties
516 properties
= mlt_service_properties( parent
);
518 char *resource
= mlt_properties_get( properties
, "resource" );
520 // Put the parent producer back
521 context_push_service( context
, parent
, type
);
523 // If the parent is a track or entry
524 if ( resource
&& ( strcmp( resource
, "<entry>" ) == 0 ) )
526 mlt_properties_set_position( properties
, "in", in
);
527 mlt_properties_set_position( properties
, "out", out
);
531 // Otherwise, set in and out on producer directly
532 mlt_producer_set_in_and_out( MLT_PRODUCER( producer
), in
, out
);
537 // Otherwise, set in and out on producer directly
538 mlt_producer_set_in_and_out( MLT_PRODUCER( producer
), in
, out
);
542 // Push the producer onto the stack
543 context_push_service( context
, producer
, mlt_producer_type
);
546 mlt_service_close( service
);
550 static void on_start_blank( deserialise_context context
, const xmlChar
*name
, const xmlChar
**atts
)
552 // Get the playlist from the stack
553 enum service_type type
;
554 mlt_service service
= context_pop_service( context
, &type
);
555 mlt_position length
= 0;
557 if ( type
== mlt_playlist_type
&& service
!= NULL
)
559 // Look for the length attribute
560 for ( ; atts
!= NULL
&& *atts
!= NULL
; atts
+= 2 )
562 if ( strcmp( atts
[0], "length" ) == 0 )
564 length
= atoll( atts
[1] );
569 // Append a blank to the playlist
570 mlt_playlist_blank( MLT_PLAYLIST( service
), length
- 1 );
572 // Push the playlist back onto the stack
573 context_push_service( context
, service
, type
);
577 fprintf( stderr
, "blank without a playlist - a definite no no\n" );
581 static void on_start_entry( deserialise_context context
, const xmlChar
*name
, const xmlChar
**atts
)
583 mlt_producer entry
= NULL
;
584 mlt_properties temp
= mlt_properties_new( );
586 for ( ; atts
!= NULL
&& *atts
!= NULL
; atts
+= 2 )
588 mlt_properties_set( temp
, (char*) atts
[0], (char*) atts
[1] );
590 // Look for the producer attribute
591 if ( strcmp( atts
[ 0 ], "producer" ) == 0 )
593 mlt_producer producer
= mlt_properties_get_data( context
->producer_map
, (char*) atts
[1], NULL
);
594 if ( producer
!= NULL
)
595 mlt_properties_set_data( temp
, "producer", producer
, 0, NULL
, NULL
);
599 // If we have a valid entry
600 if ( mlt_properties_get_data( temp
, "producer", NULL
) != NULL
)
602 mlt_playlist_clip_info info
;
603 enum service_type parent_type
;
604 mlt_service parent
= context_pop_service( context
, &parent_type
);
605 mlt_producer producer
= mlt_properties_get_data( temp
, "producer", NULL
);
607 if ( parent_type
== mlt_playlist_type
)
609 // Append the producer to the playlist
610 if ( mlt_properties_get( temp
, "in" ) != NULL
|| mlt_properties_get( temp
, "out" ) != NULL
)
612 mlt_playlist_append_io( MLT_PLAYLIST( parent
), producer
,
613 mlt_properties_get_position( temp
, "in" ),
614 mlt_properties_get_position( temp
, "out" ) );
618 mlt_playlist_append( MLT_PLAYLIST( parent
), producer
);
621 // Handle the repeat property
622 if ( mlt_properties_get_int( temp
, "repeat" ) > 0 )
624 mlt_playlist_repeat_clip( MLT_PLAYLIST( parent
),
625 mlt_playlist_count( MLT_PLAYLIST( parent
) ) - 1,
626 mlt_properties_get_int( temp
, "repeat" ) );
629 mlt_playlist_get_clip_info( MLT_PLAYLIST( parent
), &info
, mlt_playlist_count( MLT_PLAYLIST( parent
) ) - 1 );
634 fprintf( stderr
, "Entry not part of a playlist...\n" );
637 context_push_service( context
, parent
, parent_type
);
640 // Push the cut onto the stack
641 context_push_service( context
, mlt_producer_service( entry
), mlt_entry_type
);
643 mlt_properties_close( temp
);
646 static void on_end_entry( deserialise_context context
, const xmlChar
*name
)
648 // Get the entry from the stack
649 enum service_type entry_type
;
650 mlt_service entry
= context_pop_service( context
, &entry_type
);
652 if ( entry
== NULL
&& entry_type
!= mlt_entry_type
)
654 fprintf( stderr
, "Invalid state at end of entry\n" );
658 static void on_start_track( deserialise_context context
, const xmlChar
*name
, const xmlChar
**atts
)
660 // use a dummy service to hold properties to allow arbitrary nesting
661 mlt_service service
= calloc( 1, sizeof( struct mlt_service_s
) );
662 mlt_service_init( service
, NULL
);
664 // Push the dummy service onto the stack
665 context_push_service( context
, service
, mlt_entry_type
);
667 mlt_properties_set( mlt_service_properties( service
), "resource", "<track>" );
669 for ( ; atts
!= NULL
&& *atts
!= NULL
; atts
+= 2 )
671 mlt_properties_set( mlt_service_properties( service
), (char*) atts
[0], (char*) atts
[1] );
673 // Look for the producer attribute
674 if ( strcmp( atts
[ 0 ], "producer" ) == 0 )
676 mlt_producer producer
= mlt_properties_get_data( context
->producer_map
, (char*) atts
[1], NULL
);
677 if ( producer
!= NULL
)
678 mlt_properties_set_data( mlt_service_properties( service
), "producer", producer
, 0, NULL
, NULL
);
683 static void on_end_track( deserialise_context context
, const xmlChar
*name
)
685 // Get the track from the stack
686 enum service_type track_type
;
687 mlt_service track
= context_pop_service( context
, &track_type
);
689 if ( track
!= NULL
&& track_type
== mlt_entry_type
)
691 mlt_properties track_props
= mlt_service_properties( track
);
692 enum service_type parent_type
;
693 mlt_service parent
= context_pop_service( context
, &parent_type
);
694 mlt_multitrack multitrack
= NULL
;
696 mlt_producer producer
= mlt_properties_get_data( track_props
, "producer", NULL
);
697 mlt_properties producer_props
= mlt_producer_properties( producer
);
699 if ( parent_type
== mlt_tractor_type
)
700 multitrack
= mlt_tractor_multitrack( MLT_TRACTOR( parent
) );
701 else if ( parent_type
== mlt_multitrack_type
)
702 multitrack
= MLT_MULTITRACK( parent
);
704 fprintf( stderr
, "track contained in an invalid container\n" );
706 if ( multitrack
!= NULL
)
708 // Set producer i/o if specified
709 if ( mlt_properties_get( track_props
, "in" ) != NULL
||
710 mlt_properties_get( track_props
, "out" ) != NULL
)
712 mlt_producer cut
= mlt_producer_cut( MLT_PRODUCER( producer
),
713 mlt_properties_get_position( track_props
, "in" ),
714 mlt_properties_get_position( track_props
, "out" ) );
715 mlt_properties_set_int( mlt_producer_properties( cut
), "cut", 1 );
716 mlt_multitrack_connect( multitrack
, cut
, mlt_multitrack_count( multitrack
) );
717 mlt_producer_close( cut
);
721 mlt_multitrack_connect( multitrack
, producer
, mlt_multitrack_count( multitrack
) );
724 // Set the hide state of the track producer
725 char *hide_s
= mlt_properties_get( track_props
, "hide" );
726 if ( hide_s
!= NULL
)
728 if ( strcmp( hide_s
, "video" ) == 0 )
729 mlt_properties_set_int( producer_props
, "hide", 1 );
730 else if ( strcmp( hide_s
, "audio" ) == 0 )
731 mlt_properties_set_int( producer_props
, "hide", 2 );
732 else if ( strcmp( hide_s
, "both" ) == 0 )
733 mlt_properties_set_int( producer_props
, "hide", 3 );
737 if ( parent
!= NULL
)
738 context_push_service( context
, parent
, parent_type
);
740 mlt_service_close( track
);
744 fprintf( stderr
, "Invalid state at end of track\n" );
748 static void on_start_filter( deserialise_context context
, const xmlChar
*name
, const xmlChar
**atts
)
750 // use a dummy service to hold properties to allow arbitrary nesting
751 mlt_service service
= calloc( 1, sizeof( struct mlt_service_s
) );
752 mlt_service_init( service
, NULL
);
754 mlt_properties properties
= mlt_service_properties( service
);
756 context_push_service( context
, service
, mlt_dummy_filter_type
);
758 // Set the properties
759 for ( ; atts
!= NULL
&& *atts
!= NULL
; atts
+= 2 )
760 mlt_properties_set( properties
, (char*) atts
[0], (char*) atts
[1] );
763 static void on_end_filter( deserialise_context context
, const xmlChar
*name
)
765 enum service_type type
;
766 mlt_service service
= context_pop_service( context
, &type
);
767 mlt_properties properties
= mlt_service_properties( service
);
769 enum service_type parent_type
;
770 mlt_service parent
= context_pop_service( context
, &parent_type
);
772 if ( service
!= NULL
&& type
== mlt_dummy_filter_type
)
774 mlt_service filter
= MLT_SERVICE( mlt_factory_filter( mlt_properties_get( properties
, "mlt_service" ), NULL
) );
775 mlt_properties filter_props
= mlt_service_properties( filter
);
777 track_service( context
->destructors
, filter
, (mlt_destructor
) mlt_filter_close
);
779 // Propogate the properties
780 qualify_property( context
, properties
, "resource" );
781 qualify_property( context
, properties
, "luma" );
782 qualify_property( context
, properties
, "luma.resource" );
783 qualify_property( context
, properties
, "composite.luma" );
784 qualify_property( context
, properties
, "producer.resource" );
785 mlt_properties_inherit( filter_props
, properties
);
787 // Attach all filters from service onto filter
788 attach_filters( filter
, service
);
790 // Associate the filter with the parent
791 if ( parent
!= NULL
)
793 if ( parent_type
== mlt_tractor_type
)
795 mlt_field field
= mlt_tractor_field( MLT_TRACTOR( parent
) );
796 mlt_field_plant_filter( field
, MLT_FILTER( filter
), mlt_properties_get_int( properties
, "track" ) );
797 mlt_filter_set_in_and_out( MLT_FILTER( filter
),
798 mlt_properties_get_int( properties
, "in" ),
799 mlt_properties_get_int( properties
, "out" ) );
803 mlt_service_attach( parent
, MLT_FILTER( filter
) );
806 // Put the parent back on the stack
807 context_push_service( context
, parent
, parent_type
);
811 fprintf( stderr
, "filter closed with invalid parent...\n" );
814 // Close the dummy filter service
815 mlt_service_close( service
);
819 fprintf( stderr
, "Invalid top of stack on filter close\n" );
823 static void on_start_transition( deserialise_context context
, const xmlChar
*name
, const xmlChar
**atts
)
825 // use a dummy service to hold properties to allow arbitrary nesting
826 mlt_service service
= calloc( 1, sizeof( struct mlt_service_s
) );
827 mlt_service_init( service
, NULL
);
829 mlt_properties properties
= mlt_service_properties( service
);
831 context_push_service( context
, service
, mlt_dummy_transition_type
);
833 // Set the properties
834 for ( ; atts
!= NULL
&& *atts
!= NULL
; atts
+= 2 )
835 mlt_properties_set( properties
, (char*) atts
[0], (char*) atts
[1] );
838 static void on_end_transition( deserialise_context context
, const xmlChar
*name
)
840 enum service_type type
;
841 mlt_service service
= context_pop_service( context
, &type
);
842 mlt_properties properties
= mlt_service_properties( service
);
844 enum service_type parent_type
;
845 mlt_service parent
= context_pop_service( context
, &parent_type
);
847 if ( service
!= NULL
&& type
== mlt_dummy_transition_type
)
849 mlt_service effect
= MLT_SERVICE( mlt_factory_transition(mlt_properties_get(properties
,"mlt_service"), NULL
) );
850 mlt_properties effect_props
= mlt_service_properties( effect
);
852 track_service( context
->destructors
, effect
, (mlt_destructor
) mlt_transition_close
);
854 // Propogate the properties
855 qualify_property( context
, properties
, "resource" );
856 qualify_property( context
, properties
, "luma" );
857 qualify_property( context
, properties
, "luma.resource" );
858 qualify_property( context
, properties
, "composite.luma" );
859 qualify_property( context
, properties
, "producer.resource" );
860 mlt_properties_inherit( effect_props
, properties
);
862 // Attach all filters from service onto effect
863 attach_filters( effect
, service
);
865 // Associate the filter with the parent
866 if ( parent
!= NULL
)
868 if ( parent_type
== mlt_tractor_type
)
870 mlt_field field
= mlt_tractor_field( MLT_TRACTOR( parent
) );
871 if ( mlt_properties_get_int( properties
, "a_track" ) == mlt_properties_get_int( properties
, "b_track" ) )
872 mlt_properties_set_int( properties
, "b_track", mlt_properties_get_int( properties
, "a_track" ) + 1 );
873 mlt_field_plant_transition( field
, MLT_TRANSITION( effect
),
874 mlt_properties_get_int( properties
, "a_track" ),
875 mlt_properties_get_int( properties
, "b_track" ) );
876 mlt_transition_set_in_and_out( MLT_TRANSITION( effect
),
877 mlt_properties_get_int( properties
, "in" ),
878 mlt_properties_get_int( properties
, "out" ) );
882 fprintf( stderr
, "Misplaced transition - ignoring\n" );
885 // Put the parent back on the stack
886 context_push_service( context
, parent
, parent_type
);
890 fprintf( stderr
, "transition closed with invalid parent...\n" );
893 // Close the dummy filter service
894 mlt_service_close( service
);
898 fprintf( stderr
, "Invalid top of stack on transition close\n" );
902 static void on_start_property( deserialise_context context
, const xmlChar
*name
, const xmlChar
**atts
)
904 enum service_type type
;
905 mlt_service service
= context_pop_service( context
, &type
);
906 mlt_properties properties
= mlt_service_properties( service
);
909 if ( service
!= NULL
)
911 // Set the properties
912 for ( ; atts
!= NULL
&& *atts
!= NULL
; atts
+= 2 )
914 if ( strcmp( atts
[ 0 ], "name" ) == 0 )
915 context
->property
= strdup( atts
[ 1 ] );
916 else if ( strcmp( atts
[ 0 ], "value" ) == 0 )
917 value
= (char*) atts
[ 1 ];
920 if ( context
->property
!= NULL
&& value
!= NULL
)
921 mlt_properties_set( properties
, context
->property
, value
);
923 // Tell parser to collect any further nodes for serialisation
924 context
->is_value
= 1;
926 context_push_service( context
, service
, type
);
930 fprintf( stderr
, "Property without a service '%s'?\n", ( char * )name
);
934 static void on_end_property( deserialise_context context
, const xmlChar
*name
)
936 enum service_type type
;
937 mlt_service service
= context_pop_service( context
, &type
);
938 mlt_properties properties
= mlt_service_properties( service
);
940 if ( service
!= NULL
)
942 // Tell parser to stop building a tree
943 context
->is_value
= 0;
945 // See if there is a xml tree for the value
946 if ( context
->property
!= NULL
&& context
->value_doc
!= NULL
)
951 // Serialise the tree to get value
952 xmlDocDumpMemory( context
->value_doc
, &value
, &size
);
953 mlt_properties_set( properties
, context
->property
, value
);
955 xmlFreeDoc( context
->value_doc
);
956 context
->value_doc
= NULL
;
959 // Close this property handling
960 free( context
->property
);
961 context
->property
= NULL
;
963 context_push_service( context
, service
, type
);
967 fprintf( stderr
, "Property without a service '%s'??\n", (char *)name
);
971 static void on_start_element( void *ctx
, const xmlChar
*name
, const xmlChar
**atts
)
973 struct _xmlParserCtxt
*xmlcontext
= ( struct _xmlParserCtxt
* )ctx
;
974 deserialise_context context
= ( deserialise_context
)( xmlcontext
->_private
);
976 //printf("on_start_element: %s\n", name );
977 context
->branch
[ context
->depth
] ++;
980 // Build a tree from nodes within a property value
981 if ( context
->is_value
== 1 )
983 xmlNodePtr node
= xmlNewNode( NULL
, name
);
985 if ( context
->value_doc
== NULL
)
988 context
->value_doc
= xmlNewDoc( "1.0" );
989 xmlDocSetRootElement( context
->value_doc
, node
);
993 // Append child to tree
994 xmlAddChild( context
->stack_node
[ context
->stack_node_size
- 1 ], node
);
996 context_push_node( context
, node
);
998 // Set the attributes
999 for ( ; atts
!= NULL
&& *atts
!= NULL
; atts
+= 2 )
1000 xmlSetProp( node
, atts
[ 0 ], atts
[ 1 ] );
1002 else if ( strcmp( name
, "tractor" ) == 0 )
1003 on_start_tractor( context
, name
, atts
);
1004 else if ( strcmp( name
, "multitrack" ) == 0 )
1005 on_start_multitrack( context
, name
, atts
);
1006 else if ( strcmp( name
, "playlist" ) == 0 || strcmp( name
, "seq" ) == 0 || strcmp( name
, "smil" ) == 0 )
1007 on_start_playlist( context
, name
, atts
);
1008 else if ( strcmp( name
, "producer" ) == 0 || strcmp( name
, "video" ) == 0 )
1009 on_start_producer( context
, name
, atts
);
1010 else if ( strcmp( name
, "blank" ) == 0 )
1011 on_start_blank( context
, name
, atts
);
1012 else if ( strcmp( name
, "entry" ) == 0 )
1013 on_start_entry( context
, name
, atts
);
1014 else if ( strcmp( name
, "track" ) == 0 )
1015 on_start_track( context
, name
, atts
);
1016 else if ( strcmp( name
, "filter" ) == 0 )
1017 on_start_filter( context
, name
, atts
);
1018 else if ( strcmp( name
, "transition" ) == 0 )
1019 on_start_transition( context
, name
, atts
);
1020 else if ( strcmp( name
, "property" ) == 0 )
1021 on_start_property( context
, name
, atts
);
1022 else if ( strcmp( name
, "westley" ) == 0 )
1023 for ( ; atts
!= NULL
&& *atts
!= NULL
; atts
+= 2 )
1024 mlt_properties_set( context
->producer_map
, ( char * )atts
[ 0 ], ( char * )atts
[ 1 ] );
1027 static void on_end_element( void *ctx
, const xmlChar
*name
)
1029 struct _xmlParserCtxt
*xmlcontext
= ( struct _xmlParserCtxt
* )ctx
;
1030 deserialise_context context
= ( deserialise_context
)( xmlcontext
->_private
);
1032 //printf("on_end_element: %s\n", name );
1033 if ( context
->is_value
== 1 && strcmp( name
, "property" ) != 0 )
1034 context_pop_node( context
);
1035 else if ( strcmp( name
, "multitrack" ) == 0 )
1036 on_end_multitrack( context
, name
);
1037 else if ( strcmp( name
, "playlist" ) == 0 || strcmp( name
, "seq" ) == 0 || strcmp( name
, "smil" ) == 0 )
1038 on_end_playlist( context
, name
);
1039 else if ( strcmp( name
, "track" ) == 0 )
1040 on_end_track( context
, name
);
1041 else if ( strcmp( name
, "entry" ) == 0 )
1042 on_end_entry( context
, name
);
1043 else if ( strcmp( name
, "tractor" ) == 0 )
1044 on_end_tractor( context
, name
);
1045 else if ( strcmp( name
, "property" ) == 0 )
1046 on_end_property( context
, name
);
1047 else if ( strcmp( name
, "producer" ) == 0 || strcmp( name
, "video" ) == 0 )
1048 on_end_producer( context
, name
);
1049 else if ( strcmp( name
, "filter" ) == 0 )
1050 on_end_filter( context
, name
);
1051 else if ( strcmp( name
, "transition" ) == 0 )
1052 on_end_transition( context
, name
);
1054 context
->branch
[ context
->depth
] = 0;
1058 static void on_characters( void *ctx
, const xmlChar
*ch
, int len
)
1060 struct _xmlParserCtxt
*xmlcontext
= ( struct _xmlParserCtxt
* )ctx
;
1061 deserialise_context context
= ( deserialise_context
)( xmlcontext
->_private
);
1062 char *value
= calloc( len
+ 1, 1 );
1063 enum service_type type
;
1064 mlt_service service
= context_pop_service( context
, &type
);
1065 mlt_properties properties
= mlt_service_properties( service
);
1067 if ( service
!= NULL
)
1068 context_push_service( context
, service
, type
);
1071 strncpy( value
, (const char*) ch
, len
);
1073 if ( context
->stack_node_size
> 0 )
1074 xmlNodeAddContent( context
->stack_node
[ context
->stack_node_size
- 1 ], ( xmlChar
* )value
);
1076 // libxml2 generates an on_characters immediately after a get_entity within
1077 // an element value, and we ignore it because it is called again during
1078 // actual substitution.
1079 else if ( context
->property
!= NULL
&& context
->entity_is_replace
== 0 )
1081 char *s
= mlt_properties_get( properties
, context
->property
);
1084 // Append new text to existing content
1085 char *new = calloc( strlen( s
) + len
+ 1, 1 );
1087 strcat( new, value
);
1088 mlt_properties_set( properties
, context
->property
, new );
1092 mlt_properties_set( properties
, context
->property
, value
);
1094 context
->entity_is_replace
= 0;
1099 /** Convert parameters parsed from resource into entity declarations.
1101 static void params_to_entities( deserialise_context context
)
1103 if ( context
->params
!= NULL
)
1107 // Add our params as entitiy declarations
1108 for ( i
= 0; i
< mlt_properties_count( context
->params
); i
++ )
1110 xmlChar
*name
= ( xmlChar
* )mlt_properties_get_name( context
->params
, i
);
1111 xmlAddDocEntity( context
->entity_doc
, name
, XML_INTERNAL_GENERAL_ENTITY
,
1112 context
->publicId
, context
->systemId
, ( xmlChar
* )mlt_properties_get( context
->params
, name
) );
1116 mlt_properties_close( context
->params
);
1117 context
->params
= NULL
;
1121 // The following 3 facilitate entity substitution in the SAX parser
1122 static void on_internal_subset( void *ctx
, const xmlChar
* name
,
1123 const xmlChar
* publicId
, const xmlChar
* systemId
)
1125 struct _xmlParserCtxt
*xmlcontext
= ( struct _xmlParserCtxt
* )ctx
;
1126 deserialise_context context
= ( deserialise_context
)( xmlcontext
->_private
);
1128 context
->publicId
= publicId
;
1129 context
->systemId
= systemId
;
1130 xmlCreateIntSubset( context
->entity_doc
, name
, publicId
, systemId
);
1132 // Override default entities with our parameters
1133 params_to_entities( context
);
1136 static void on_entity_declaration( void *ctx
, const xmlChar
* name
, int type
,
1137 const xmlChar
* publicId
, const xmlChar
* systemId
, xmlChar
* content
)
1139 struct _xmlParserCtxt
*xmlcontext
= ( struct _xmlParserCtxt
* )ctx
;
1140 deserialise_context context
= ( deserialise_context
)( xmlcontext
->_private
);
1142 xmlAddDocEntity( context
->entity_doc
, name
, type
, publicId
, systemId
, content
);
1145 xmlEntityPtr
on_get_entity( void *ctx
, const xmlChar
* name
)
1147 struct _xmlParserCtxt
*xmlcontext
= ( struct _xmlParserCtxt
* )ctx
;
1148 deserialise_context context
= ( deserialise_context
)( xmlcontext
->_private
);
1149 xmlEntityPtr e
= NULL
;
1151 // Setup for entity declarations if not ready
1152 if ( xmlGetIntSubset( context
->entity_doc
) == NULL
)
1154 xmlCreateIntSubset( context
->entity_doc
, "westley", "", "" );
1155 context
->publicId
= "";
1156 context
->systemId
= "";
1159 // Add our parameters if not already
1160 params_to_entities( context
);
1162 e
= xmlGetDocEntity( context
->entity_doc
, name
);
1164 // Send signal to on_characters that an entity substitutin is pending
1166 context
->entity_is_replace
= 1;
1171 /** Convert a hexadecimal character to its value.
1173 static int tohex( char p
)
1175 return isdigit( p
) ? p
- '0' : tolower( p
) - 'a' + 10;
1178 /** Decode a url-encoded string containing hexadecimal character sequences.
1180 static char *url_decode( char *dest
, char *src
)
1188 *p
++ = ( tohex( *( src
+ 1 ) ) << 4 ) | tohex( *( src
+ 2 ) );
1201 /** Extract the filename from a URL attaching parameters to a properties list.
1203 static void parse_url( mlt_properties properties
, char *url
)
1206 int n
= strlen( url
);
1210 for ( i
= 0; i
< n
; i
++ )
1227 if ( name
!= NULL
&& value
!= NULL
)
1228 mlt_properties_set( properties
, name
, value
);
1234 if ( name
!= NULL
&& value
!= NULL
)
1235 mlt_properties_set( properties
, name
, value
);
1238 mlt_producer
producer_westley_init( int info
, char *data
)
1242 xmlSAXHandler
*sax
= calloc( 1, sizeof( xmlSAXHandler
) );
1243 struct deserialise_context_s
*context
= calloc( 1, sizeof( struct deserialise_context_s
) );
1244 mlt_properties properties
= NULL
;
1246 struct _xmlParserCtxt
*xmlcontext
;
1247 int well_formed
= 0;
1248 char *filename
= NULL
;
1250 context
->producer_map
= mlt_properties_new();
1251 context
->destructors
= mlt_properties_new();
1252 context
->params
= mlt_properties_new();
1254 // Decode URL and parse parameters
1255 mlt_properties_set( context
->producer_map
, "root", "" );
1258 filename
= strdup( data
);
1259 parse_url( context
->params
, url_decode( filename
, data
) );
1261 // We need the directory prefix which was used for the westley
1262 if ( strchr( filename
, '/' ) )
1265 mlt_properties_set( context
->producer_map
, "root", filename
);
1266 root
= mlt_properties_get( context
->producer_map
, "root" );
1267 *( strrchr( root
, '/' ) ) = '\0';
1269 // If we don't have an absolute path here, we're heading for disaster...
1270 if ( root
[ 0 ] != '/' )
1272 char *cwd
= getcwd( NULL
, 0 );
1273 char *real
= malloc( strlen( cwd
) + strlen( root
) + 2 );
1274 sprintf( real
, "%s/%s", cwd
, root
);
1275 mlt_properties_set( context
->producer_map
, "root", real
);
1282 // We need to track the number of registered filters
1283 mlt_properties_set_int( context
->destructors
, "registered", 0 );
1285 // Setup SAX callbacks
1286 sax
->startElement
= on_start_element
;
1287 sax
->endElement
= on_end_element
;
1288 sax
->characters
= on_characters
;
1289 sax
->cdataBlock
= on_characters
;
1290 sax
->internalSubset
= on_internal_subset
;
1291 sax
->entityDecl
= on_entity_declaration
;
1292 sax
->getEntity
= on_get_entity
;
1294 // Setup libxml2 SAX parsing
1296 xmlSubstituteEntitiesDefault( 1 );
1297 // This is used to facilitate entity substitution in the SAX parser
1298 context
->entity_doc
= xmlNewDoc( "1.0" );
1300 xmlcontext
= xmlCreateFileParserCtxt( filename
);
1302 xmlcontext
= xmlCreateMemoryParserCtxt( data
, strlen( data
) );
1304 // Invalid context - clean up and return NULL
1305 if ( xmlcontext
== NULL
)
1307 mlt_properties_close( context
->producer_map
);
1308 mlt_properties_close( context
->destructors
);
1309 mlt_properties_close( context
->params
);
1316 xmlcontext
->sax
= sax
;
1317 xmlcontext
->_private
= ( void* )context
;
1320 xmlParseDocument( xmlcontext
);
1321 well_formed
= xmlcontext
->wellFormed
;
1323 // Cleanup after parsing
1324 xmlFreeDoc( context
->entity_doc
);
1326 xmlcontext
->sax
= NULL
;
1327 xmlcontext
->_private
= NULL
;
1328 xmlFreeParserCtxt( xmlcontext
);
1329 xmlMemoryDump( ); // for debugging
1331 // Get the last producer on the stack
1332 enum service_type type
;
1333 mlt_service service
= context_pop_service( context
, &type
);
1334 if ( well_formed
&& service
!= NULL
)
1336 // Verify it is a producer service (mlt_type="mlt_producer")
1337 // (producer, playlist, multitrack)
1338 char *type
= mlt_properties_get( mlt_service_properties( service
), "mlt_type" );
1339 if ( type
== NULL
|| ( strcmp( type
, "mlt_producer" ) != 0 && strcmp( type
, "producer" ) != 0 ) )
1344 xmlDocPtr doc
= westley_make_doc( service
);
1345 xmlDocFormatDump( stdout
, doc
, 1 );
1350 if ( well_formed
&& service
!= NULL
)
1352 char *title
= mlt_properties_get( context
->producer_map
, "title" );
1354 // Need the complete producer list for various reasons
1355 properties
= context
->destructors
;
1357 // Now make sure we don't have a reference to the service in the properties
1358 for ( i
= mlt_properties_count( properties
) - 1; i
>= 1; i
-- )
1360 char *name
= mlt_properties_get_name( properties
, i
);
1361 if ( mlt_properties_get_data( properties
, name
, NULL
) == service
)
1363 mlt_properties_set_data( properties
, name
, service
, 0, NULL
, NULL
);
1368 // We are done referencing destructor property list
1369 // Set this var to service properties for convenience
1370 properties
= mlt_service_properties( service
);
1373 mlt_properties_set( properties
, "title", title
);
1375 // Optimise for overlapping producers
1376 mlt_producer_optimise( MLT_PRODUCER( service
) );
1378 // Handle deep copies
1379 if ( getenv( "MLT_WESTLEY_DEEP" ) == NULL
)
1381 // Now assign additional properties
1383 mlt_properties_set( properties
, "resource", data
);
1385 // This tells consumer_westley not to deep copy
1386 mlt_properties_set( properties
, "westley", "was here" );
1390 // Allow the project to be edited
1391 mlt_properties_set( properties
, "_westley", "was here" );
1392 mlt_properties_set_int( properties
, "_mlt_service_hidden", 1 );
1397 // Return null if not well formed
1402 mlt_properties_close( context
->producer_map
);
1403 if ( context
->params
!= NULL
)
1404 mlt_properties_close( context
->params
);
1405 mlt_properties_close( context
->destructors
);
1409 return MLT_PRODUCER( service
);