2 * consumer_westley.c -- a libxml2 serialiser 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 #include "consumer_westley.h"
22 #include <framework/mlt.h>
28 #include <libxml/tree.h>
32 // This maintains counters for adding ids to elements
33 struct serialise_context_s
35 mlt_properties id_map
;
43 mlt_properties hide_map
;
47 typedef struct serialise_context_s
* serialise_context
;
49 /** Forward references to static functions.
52 static int consumer_start( mlt_consumer parent
);
53 static int consumer_is_stopped( mlt_consumer
this );
54 static void serialise_service( serialise_context context
, mlt_service service
, xmlNode
*node
);
68 /** Create or retrieve an id associated to this service.
71 static char *westley_get_id( serialise_context context
, mlt_service service
, westley_type type
)
75 mlt_properties map
= context
->id_map
;
77 // Search the map for the service
78 for ( i
= 0; i
< mlt_properties_count( map
); i
++ )
79 if ( mlt_properties_get_data_at( map
, i
, NULL
) == service
)
82 // If the service is not in the map, and the type indicates a new id is needed...
83 if ( i
>= mlt_properties_count( map
) && type
!= westley_existing
)
85 // Attempt to reuse existing id
86 id
= mlt_properties_get( MLT_SERVICE_PROPERTIES( service
), "id" );
88 // If no id, or the id is used in the map (for another service), then
90 if ( id
== NULL
|| mlt_properties_get_data( map
, id
, NULL
) != NULL
)
97 case westley_producer
:
98 sprintf( temp
, "producer%d", context
->producer_count
++ );
100 case westley_multitrack
:
101 sprintf( temp
, "multitrack%d", context
->multitrack_count
++ );
103 case westley_playlist
:
104 sprintf( temp
, "playlist%d", context
->playlist_count
++ );
106 case westley_tractor
:
107 sprintf( temp
, "tractor%d", context
->tractor_count
++ );
110 sprintf( temp
, "filter%d", context
->filter_count
++ );
112 case westley_transition
:
113 sprintf( temp
, "transition%d", context
->transition_count
++ );
115 case westley_existing
:
120 while( mlt_properties_get_data( map
, temp
, NULL
) != NULL
);
122 // Set the data at the generated name
123 mlt_properties_set_data( map
, temp
, service
, 0, NULL
, NULL
);
125 // Get the pointer to the name (i is the end of the list)
126 id
= mlt_properties_get_name( map
, i
);
130 // Store the existing id in the map
131 mlt_properties_set_data( map
, id
, service
, 0, NULL
, NULL
);
134 else if ( type
== westley_existing
)
136 id
= mlt_properties_get_name( map
, i
);
142 /** This is what will be called by the factory - anything can be passed in
143 via the argument, but keep it simple.
146 mlt_consumer
consumer_westley_init( char *arg
)
148 // Create the consumer object
149 mlt_consumer
this = calloc( sizeof( struct mlt_consumer_s
), 1 );
151 // If no malloc'd and consumer init ok
152 if ( this != NULL
&& mlt_consumer_init( this, NULL
) == 0 )
154 // Allow thread to be started/stopped
155 this->start
= consumer_start
;
156 this->is_stopped
= consumer_is_stopped
;
158 mlt_properties_set( MLT_CONSUMER_PROPERTIES( this ), "resource", arg
);
160 // Return the consumer produced
164 // malloc or consumer init failed
171 static void serialise_properties( serialise_context context
, mlt_properties properties
, xmlNode
*node
)
176 // Enumerate the properties
177 for ( i
= 0; i
< mlt_properties_count( properties
); i
++ )
179 char *name
= mlt_properties_get_name( properties
, i
);
182 mlt_properties_get_value( properties
, i
) != NULL
&&
183 strcmp( name
, "westley" ) != 0 &&
184 strcmp( name
, "in" ) != 0 &&
185 strcmp( name
, "out" ) != 0 &&
186 strcmp( name
, "id" ) != 0 &&
187 strcmp( name
, "root" ) != 0 &&
188 strcmp( name
, "width" ) != 0 &&
189 strcmp( name
, "height" ) != 0 )
191 char *value
= mlt_properties_get_value( properties
, i
);
192 if ( strcmp( context
->root
, "" ) && !strncmp( value
, context
->root
, strlen( context
->root
) ) )
193 value
+= strlen( context
->root
) + 1;
194 p
= xmlNewTextChild( node
, NULL
, "property", value
);
195 xmlNewProp( p
, "name", name
);
200 static void serialise_store_properties( serialise_context context
, mlt_properties properties
, xmlNode
*node
, char *store
)
205 // Enumerate the properties
206 for ( i
= 0; store
!= NULL
&& i
< mlt_properties_count( properties
); i
++ )
208 char *name
= mlt_properties_get_name( properties
, i
);
209 if ( !strncmp( name
, store
, strlen( store
) ) )
211 char *value
= mlt_properties_get_value( properties
, i
);
214 if ( strcmp( context
->root
, "" ) && !strncmp( value
, context
->root
, strlen( context
->root
) ) )
215 value
+= strlen( context
->root
) + 1;
216 p
= xmlNewTextChild( node
, NULL
, "property", value
);
217 xmlNewProp( p
, "name", name
);
223 static inline void serialise_service_filters( serialise_context context
, mlt_service service
, xmlNode
*node
)
227 mlt_filter filter
= NULL
;
229 // Enumerate the filters
230 for ( i
= 0; ( filter
= mlt_producer_filter( MLT_PRODUCER( service
), i
) ) != NULL
; i
++ )
232 mlt_properties properties
= MLT_FILTER_PROPERTIES( filter
);
233 if ( mlt_properties_get_int( properties
, "_fezzik" ) == 0 )
235 // Get a new id - if already allocated, do nothing
236 char *id
= westley_get_id( context
, MLT_FILTER_SERVICE( filter
), westley_filter
);
239 int in
= mlt_properties_get_position( properties
, "in" );
240 int out
= mlt_properties_get_position( properties
, "out" );
241 p
= xmlNewChild( node
, NULL
, "filter", NULL
);
242 xmlNewProp( p
, "id", id
);
243 if ( in
!= 0 || out
!= 0 )
246 sprintf( temp
, "%d", in
);
247 xmlNewProp( p
, "in", temp
);
248 sprintf( temp
, "%d", out
);
249 xmlNewProp( p
, "out", temp
);
251 serialise_properties( context
, properties
, p
);
252 serialise_service_filters( context
, MLT_FILTER_SERVICE( filter
), p
);
258 static void serialise_producer( serialise_context context
, mlt_service service
, xmlNode
*node
)
260 xmlNode
*child
= node
;
261 mlt_service parent
= MLT_SERVICE( mlt_producer_cut_parent( MLT_PRODUCER( service
) ) );
263 if ( context
->pass
== 0 )
265 mlt_properties properties
= MLT_SERVICE_PROPERTIES( parent
);
266 // Get a new id - if already allocated, do nothing
267 char *id
= westley_get_id( context
, parent
, westley_producer
);
271 child
= xmlNewChild( node
, NULL
, "producer", NULL
);
274 xmlNewProp( child
, "id", id
);
275 xmlNewProp( child
, "in", mlt_properties_get( properties
, "in" ) );
276 xmlNewProp( child
, "out", mlt_properties_get( properties
, "out" ) );
277 serialise_properties( context
, properties
, child
);
278 serialise_service_filters( context
, service
, child
);
280 // Add producer to the map
281 mlt_properties_set_int( context
->hide_map
, id
, mlt_properties_get_int( properties
, "hide" ) );
285 char *id
= westley_get_id( context
, parent
, westley_existing
);
286 mlt_properties properties
= MLT_SERVICE_PROPERTIES( service
);
287 xmlNewProp( node
, "parent", id
);
288 xmlNewProp( node
, "in", mlt_properties_get( properties
, "in" ) );
289 xmlNewProp( node
, "out", mlt_properties_get( properties
, "out" ) );
293 static void serialise_tractor( serialise_context context
, mlt_service service
, xmlNode
*node
);
295 static void serialise_multitrack( serialise_context context
, mlt_service service
, xmlNode
*node
)
299 if ( context
->pass
== 0 )
301 // Iterate over the tracks to collect the producers
302 for ( i
= 0; i
< mlt_multitrack_count( MLT_MULTITRACK( service
) ); i
++ )
304 mlt_producer producer
= mlt_producer_cut_parent( mlt_multitrack_track( MLT_MULTITRACK( service
), i
) );
305 serialise_service( context
, MLT_SERVICE( producer
), node
);
310 // Get a new id - if already allocated, do nothing
311 char *id
= westley_get_id( context
, service
, westley_multitrack
);
315 // Serialise the tracks
316 for ( i
= 0; i
< mlt_multitrack_count( MLT_MULTITRACK( service
) ); i
++ )
318 xmlNode
*track
= xmlNewChild( node
, NULL
, "track", NULL
);
320 mlt_producer producer
= mlt_multitrack_track( MLT_MULTITRACK( service
), i
);
321 mlt_properties properties
= MLT_PRODUCER_PROPERTIES( producer
);
323 mlt_service parent
= MLT_SERVICE( mlt_producer_cut_parent( producer
) );
325 char *id
= westley_get_id( context
, MLT_SERVICE( parent
), westley_existing
);
326 xmlNewProp( track
, "producer", id
);
327 if ( mlt_producer_is_cut( producer
) )
329 xmlNewProp( track
, "in", mlt_properties_get( properties
, "in" ) );
330 xmlNewProp( track
, "out", mlt_properties_get( properties
, "out" ) );
331 serialise_store_properties( context
, MLT_PRODUCER_PROPERTIES( producer
), track
, context
->store
);
332 serialise_store_properties( context
, MLT_PRODUCER_PROPERTIES( producer
), track
, "meta." );
333 serialise_service_filters( context
, MLT_PRODUCER_SERVICE( producer
), track
);
336 hide
= mlt_properties_get_int( context
->hide_map
, id
);
338 xmlNewProp( track
, "hide", hide
== 1 ?
"video" : ( hide
== 2 ?
"audio" : "both" ) );
340 serialise_service_filters( context
, service
, node
);
344 static void serialise_playlist( serialise_context context
, mlt_service service
, xmlNode
*node
)
347 xmlNode
*child
= node
;
348 mlt_playlist_clip_info info
;
349 mlt_properties properties
= MLT_SERVICE_PROPERTIES( service
);
351 if ( context
->pass
== 0 )
353 // Get a new id - if already allocated, do nothing
354 char *id
= westley_get_id( context
, service
, westley_playlist
);
358 // Iterate over the playlist entries to collect the producers
359 for ( i
= 0; i
< mlt_playlist_count( MLT_PLAYLIST( service
) ); i
++ )
361 if ( ! mlt_playlist_get_clip_info( MLT_PLAYLIST( service
), &info
, i
) )
363 if ( info
.producer
!= NULL
)
365 mlt_producer producer
= mlt_producer_cut_parent( info
.producer
);
366 char *service_s
= mlt_properties_get( MLT_PRODUCER_PROPERTIES( producer
), "mlt_service" );
367 char *resource_s
= mlt_properties_get( MLT_PRODUCER_PROPERTIES( producer
), "resource" );
368 if ( resource_s
!= NULL
&& !strcmp( resource_s
, "<playlist>" ) )
369 serialise_playlist( context
, MLT_SERVICE( producer
), node
);
370 else if ( service_s
!= NULL
&& strcmp( service_s
, "blank" ) != 0 )
371 serialise_service( context
, MLT_SERVICE( producer
), node
);
376 child
= xmlNewChild( node
, NULL
, "playlist", NULL
);
379 xmlNewProp( child
, "id", id
);
381 // Store application specific properties
382 serialise_store_properties( context
, properties
, child
, context
->store
);
383 serialise_store_properties( context
, properties
, child
, "meta." );
385 // Add producer to the map
386 mlt_properties_set_int( context
->hide_map
, id
, mlt_properties_get_int( properties
, "hide" ) );
388 // Iterate over the playlist entries
389 for ( i
= 0; i
< mlt_playlist_count( MLT_PLAYLIST( service
) ); i
++ )
391 if ( ! mlt_playlist_get_clip_info( MLT_PLAYLIST( service
), &info
, i
) )
393 mlt_producer producer
= mlt_producer_cut_parent( info
.producer
);
394 char *service_s
= mlt_properties_get( MLT_PRODUCER_PROPERTIES( producer
), "mlt_service" );
395 if ( service_s
!= NULL
&& strcmp( service_s
, "blank" ) == 0 )
399 xmlNode
*entry
= xmlNewChild( child
, NULL
, "blank", NULL
);
400 snprintf( length
, 19, "%d", info
.frame_count
);
401 xmlNewProp( entry
, "length", length
);
406 xmlNode
*entry
= xmlNewChild( child
, NULL
, "entry", NULL
);
407 id
= westley_get_id( context
, MLT_SERVICE( producer
), westley_existing
);
408 xmlNewProp( entry
, "producer", id
);
409 sprintf( temp
, "%d", info
.frame_in
);
410 xmlNewProp( entry
, "in", temp
);
411 sprintf( temp
, "%d", info
.frame_out
);
412 xmlNewProp( entry
, "out", temp
);
413 if ( info
.repeat
> 1 )
415 sprintf( temp
, "%d", info
.repeat
);
416 xmlNewProp( entry
, "repeat", temp
);
418 if ( mlt_producer_is_cut( info
.cut
) )
420 serialise_store_properties( context
, MLT_PRODUCER_PROPERTIES( info
.cut
), entry
, context
->store
);
421 serialise_store_properties( context
, MLT_PRODUCER_PROPERTIES( info
.cut
), entry
, "meta." );
422 serialise_service_filters( context
, MLT_PRODUCER_SERVICE( info
.cut
), entry
);
428 serialise_service_filters( context
, service
, child
);
430 else if ( strcmp( (const char*) node
->name
, "tractor" ) != 0 )
432 char *id
= westley_get_id( context
, service
, westley_existing
);
433 xmlNewProp( node
, "producer", id
);
437 static void serialise_tractor( serialise_context context
, mlt_service service
, xmlNode
*node
)
439 xmlNode
*child
= node
;
440 mlt_properties properties
= MLT_SERVICE_PROPERTIES( service
);
442 if ( context
->pass
== 0 )
444 // Recurse on connected producer
445 serialise_service( context
, mlt_service_producer( service
), node
);
449 // Get a new id - if already allocated, do nothing
450 char *id
= westley_get_id( context
, service
, westley_tractor
);
454 child
= xmlNewChild( node
, NULL
, "tractor", NULL
);
457 xmlNewProp( child
, "id", id
);
458 xmlNewProp( child
, "in", mlt_properties_get( properties
, "in" ) );
459 xmlNewProp( child
, "out", mlt_properties_get( properties
, "out" ) );
461 // Store application specific properties
462 serialise_store_properties( context
, MLT_SERVICE_PROPERTIES( service
), child
, context
->store
);
463 serialise_store_properties( context
, MLT_SERVICE_PROPERTIES( service
), child
, "meta." );
465 // Recurse on connected producer
466 serialise_service( context
, mlt_service_producer( service
), child
);
467 serialise_service_filters( context
, service
, child
);
471 static void serialise_filter( serialise_context context
, mlt_service service
, xmlNode
*node
)
473 xmlNode
*child
= node
;
474 mlt_properties properties
= MLT_SERVICE_PROPERTIES( service
);
476 // Recurse on connected producer
477 serialise_service( context
, mlt_service_producer( service
), node
);
479 if ( context
->pass
== 1 )
481 // Get a new id - if already allocated, do nothing
482 char *id
= westley_get_id( context
, service
, westley_filter
);
486 child
= xmlNewChild( node
, NULL
, "filter", NULL
);
489 xmlNewProp( child
, "id", id
);
490 xmlNewProp( child
, "in", mlt_properties_get( properties
, "in" ) );
491 xmlNewProp( child
, "out", mlt_properties_get( properties
, "out" ) );
493 serialise_properties( context
, properties
, child
);
494 serialise_service_filters( context
, service
, child
);
498 static void serialise_transition( serialise_context context
, mlt_service service
, xmlNode
*node
)
500 xmlNode
*child
= node
;
501 mlt_properties properties
= MLT_SERVICE_PROPERTIES( service
);
503 // Recurse on connected producer
504 serialise_service( context
, MLT_SERVICE( MLT_TRANSITION( service
)->producer
), node
);
506 if ( context
->pass
== 1 )
508 // Get a new id - if already allocated, do nothing
509 char *id
= westley_get_id( context
, service
, westley_transition
);
513 child
= xmlNewChild( node
, NULL
, "transition", NULL
);
516 xmlNewProp( child
, "id", id
);
517 xmlNewProp( child
, "in", mlt_properties_get( properties
, "in" ) );
518 xmlNewProp( child
, "out", mlt_properties_get( properties
, "out" ) );
520 serialise_properties( context
, properties
, child
);
521 serialise_service_filters( context
, service
, child
);
525 static void serialise_service( serialise_context context
, mlt_service service
, xmlNode
*node
)
527 // Iterate over consumer/producer connections
528 while ( service
!= NULL
)
530 mlt_properties properties
= MLT_SERVICE_PROPERTIES( service
);
531 char *mlt_type
= mlt_properties_get( properties
, "mlt_type" );
533 // Tell about the producer
534 if ( strcmp( mlt_type
, "producer" ) == 0 )
536 char *mlt_service
= mlt_properties_get( properties
, "mlt_service" );
537 if ( mlt_properties_get( properties
, "westley" ) == NULL
&& !strcmp( mlt_service
, "tractor" ) )
540 serialise_tractor( context
, service
, node
);
542 serialise_tractor( context
, service
, node
);
548 serialise_producer( context
, service
, node
);
550 if ( mlt_properties_get( properties
, "westley" ) != NULL
)
554 // Tell about the framework container producers
555 else if ( strcmp( mlt_type
, "mlt_producer" ) == 0 )
557 char *resource
= mlt_properties_get( properties
, "resource" );
559 // Recurse on multitrack's tracks
560 if ( strcmp( resource
, "<multitrack>" ) == 0 )
562 serialise_multitrack( context
, service
, node
);
566 // Recurse on playlist's clips
567 else if ( strcmp( resource
, "<playlist>" ) == 0 )
569 serialise_playlist( context
, service
, node
);
572 // Recurse on tractor's producer
573 else if ( strcmp( resource
, "<tractor>" ) == 0 )
576 serialise_tractor( context
, service
, node
);
578 serialise_tractor( context
, service
, node
);
583 // Treat it as a normal producer
586 serialise_producer( context
, service
, node
);
590 // Tell about a filter
591 else if ( strcmp( mlt_type
, "filter" ) == 0 )
593 serialise_filter( context
, service
, node
);
597 // Tell about a transition
598 else if ( strcmp( mlt_type
, "transition" ) == 0 )
600 serialise_transition( context
, service
, node
);
604 // Get the next connected service
605 service
= mlt_service_producer( service
);
609 xmlDocPtr
westley_make_doc( mlt_consumer consumer
, mlt_service service
)
611 mlt_properties properties
= MLT_SERVICE_PROPERTIES( service
);
612 xmlDocPtr doc
= xmlNewDoc( "1.0" );
613 xmlNodePtr root
= xmlNewNode( NULL
, "westley" );
614 struct serialise_context_s
*context
= calloc( 1, sizeof( struct serialise_context_s
) );
616 xmlDocSetRootElement( doc
, root
);
618 // If we have root, then deal with it now
619 if ( mlt_properties_get( properties
, "root" ) != NULL
)
621 xmlNewProp( root
, "root", mlt_properties_get( properties
, "root" ) );
622 context
->root
= strdup( mlt_properties_get( properties
, "root" ) );
626 context
->root
= strdup( "" );
629 // Assign the additional 'storage' pattern for properties
630 context
->store
= mlt_properties_get( MLT_CONSUMER_PROPERTIES( consumer
), "store" );
632 // Assign a title property
633 if ( mlt_properties_get( properties
, "title" ) != NULL
)
634 xmlNewProp( root
, "title", mlt_properties_get( properties
, "title" ) );
636 // Construct the context maps
637 context
->id_map
= mlt_properties_new();
638 context
->hide_map
= mlt_properties_new();
640 // Ensure producer is a framework producer
641 mlt_properties_set( MLT_SERVICE_PROPERTIES( service
), "mlt_type", "mlt_producer" );
643 // In pass one, we serialise the end producers and playlists,
644 // adding them to a map keyed by address.
645 serialise_service( context
, service
, root
);
647 // In pass two, we serialise the tractor and reference the
648 // producers and playlists
650 serialise_service( context
, service
, root
);
653 mlt_properties_close( context
->id_map
);
654 mlt_properties_close( context
->hide_map
);
655 free( context
->root
);
661 static int consumer_start( mlt_consumer
this )
663 xmlDocPtr doc
= NULL
;
665 // Get the producer service
666 mlt_service service
= mlt_service_producer( MLT_CONSUMER_SERVICE( this ) );
667 if ( service
!= NULL
)
669 mlt_properties properties
= MLT_CONSUMER_PROPERTIES( this );
670 char *resource
= mlt_properties_get( properties
, "resource" );
672 // Set the title if provided
673 if ( mlt_properties_get( properties
, "title" ) )
674 mlt_properties_set( MLT_SERVICE_PROPERTIES( service
), "title", mlt_properties_get( properties
, "title" ) );
675 else if ( mlt_properties_get( MLT_SERVICE_PROPERTIES( service
), "title" ) == NULL
)
676 mlt_properties_set( MLT_SERVICE_PROPERTIES( service
), "title", "Anonymous Submission" );
678 // Check for a root on the consumer properties and pass to service
679 if ( mlt_properties_get( properties
, "root" ) )
680 mlt_properties_set( MLT_SERVICE_PROPERTIES( service
), "root", mlt_properties_get( properties
, "root" ) );
682 // Specify roots in other cases...
683 if ( resource
!= NULL
&& mlt_properties_get( properties
, "root" ) == NULL
)
685 // Get the current working directory
686 char *cwd
= getcwd( NULL
, 0 );
687 mlt_properties_set( MLT_SERVICE_PROPERTIES( service
), "root", cwd
);
692 doc
= westley_make_doc( this, service
);
695 if ( resource
== NULL
|| !strcmp( resource
, "" ) )
697 xmlDocFormatDump( stdout
, doc
, 1 );
699 else if ( strchr( resource
, '.' ) == NULL
)
701 xmlChar
*buffer
= NULL
;
703 xmlDocDumpMemoryEnc( doc
, &buffer
, &length
, "utf-8" );
704 mlt_properties_set( properties
, resource
, buffer
);
709 xmlSaveFormatFileEnc( resource
, doc
, "utf-8", 1 );
712 // Close the document
716 mlt_consumer_stop( this );
718 mlt_consumer_stopped( this );
723 static int consumer_is_stopped( mlt_consumer
this )