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;
46 typedef struct serialise_context_s* serialise_context;
48 /** Forward references to static functions.
51 static int consumer_start( mlt_consumer parent );
52 static int consumer_is_stopped( mlt_consumer this );
53 static void serialise_service( serialise_context context, mlt_service service, xmlNode *node );
67 /** Create or retrieve an id associated to this service.
70 static char *westley_get_id( serialise_context context, mlt_service service, westley_type type )
74 mlt_properties map = context->id_map;
76 // Search the map for the service
77 for ( i = 0; i < mlt_properties_count( map ); i ++ )
78 if ( mlt_properties_get_data_at( map, i, NULL ) == service )
81 // If the service is not in the map, and the type indicates a new id is needed...
82 if ( i >= mlt_properties_count( map ) && type != westley_existing )
84 // Attempt to reuse existing id
85 id = mlt_properties_get( mlt_service_properties( service ), "id" );
87 // If no id, or the id is used in the map (for another service), then
89 if ( id == NULL || mlt_properties_get_data( map, id, NULL ) != NULL )
96 case westley_producer:
97 sprintf( temp, "producer%d", context->producer_count ++ );
99 case westley_multitrack:
100 sprintf( temp, "multitrack%d", context->multitrack_count ++ );
102 case westley_playlist:
103 sprintf( temp, "playlist%d", context->playlist_count ++ );
105 case westley_tractor:
106 sprintf( temp, "tractor%d", context->tractor_count ++ );
109 sprintf( temp, "filter%d", context->filter_count ++ );
111 case westley_transition:
112 sprintf( temp, "transition%d", context->transition_count ++ );
114 case westley_existing:
119 while( mlt_properties_get_data( map, temp, NULL ) != NULL );
121 // Set the data at the generated name
122 mlt_properties_set_data( map, temp, service, 0, NULL, NULL );
124 // Get the pointer to the name (i is the end of the list)
125 id = mlt_properties_get_name( map, i );
129 // Store the existing id in the map
130 mlt_properties_set_data( map, id, service, 0, NULL, NULL );
133 else if ( type == westley_existing )
135 id = mlt_properties_get_name( map, i );
141 /** This is what will be called by the factory - anything can be passed in
142 via the argument, but keep it simple.
145 mlt_consumer consumer_westley_init( char *arg )
147 // Create the consumer object
148 mlt_consumer this = calloc( sizeof( struct mlt_consumer_s ), 1 );
150 // If no malloc'd and consumer init ok
151 if ( this != NULL && mlt_consumer_init( this, NULL ) == 0 )
153 // Allow thread to be started/stopped
154 this->start = consumer_start;
155 this->is_stopped = consumer_is_stopped;
157 mlt_properties_set( mlt_consumer_properties( this ), "resource", arg );
159 // Return the consumer produced
163 // malloc or consumer init failed
170 static inline void serialise_properties( serialise_context context, mlt_properties properties, xmlNode *node )
175 // Enumerate the properties
176 for ( i = 0; i < mlt_properties_count( properties ); i++ )
178 char *name = mlt_properties_get_name( properties, i );
181 mlt_properties_get_value( properties, i ) != NULL &&
182 strcmp( name, "westley" ) != 0 &&
183 strcmp( name, "in" ) != 0 &&
184 strcmp( name, "out" ) != 0 &&
185 strcmp( name, "id" ) != 0 &&
186 strcmp( name, "root" ) != 0 &&
187 strcmp( name, "width" ) != 0 &&
188 strcmp( name, "height" ) != 0 )
190 char *value = mlt_properties_get_value( properties, i );
191 p = xmlNewChild( node, NULL, "property", NULL );
192 xmlNewProp( p, "name", mlt_properties_get_name( properties, i ) );
193 if ( strcmp( context->root, "" ) && !strncmp( value, context->root, strlen( context->root ) ) )
194 xmlNodeSetContent( p, value + strlen( context->root ) + 1 );
196 xmlNodeSetContent( p, value );
201 static inline void serialise_service_filters( serialise_context context, mlt_service service, xmlNode *node )
205 mlt_filter filter = NULL;
207 // Enumerate the filters
208 for ( i = 0; ( filter = mlt_producer_filter( MLT_PRODUCER( service ), i ) ) != NULL; i ++ )
210 mlt_properties properties = mlt_filter_properties( filter );
211 if ( mlt_properties_get_int( properties, "_fezzik" ) == 0 )
213 // Get a new id - if already allocated, do nothing
214 char *id = westley_get_id( context, mlt_filter_service( filter ), westley_filter );
217 int in = mlt_properties_get_position( properties, "in" );
218 int out = mlt_properties_get_position( properties, "out" );
219 p = xmlNewChild( node, NULL, "filter", NULL );
220 xmlNewProp( p, "id", id );
221 if ( in != 0 || out != 0 )
224 sprintf( temp, "%d", in );
225 xmlNewProp( p, "in", temp );
226 sprintf( temp, "%d", out );
227 xmlNewProp( p, "out", temp );
229 serialise_properties( context, properties, p );
230 serialise_service_filters( context, mlt_filter_service( filter ), p );
236 static void serialise_producer( serialise_context context, mlt_service service, xmlNode *node )
238 xmlNode *child = node;
239 mlt_service parent = MLT_SERVICE( mlt_producer_cut_parent( MLT_PRODUCER( service ) ) );
241 if ( context->pass == 0 )
243 mlt_properties properties = mlt_service_properties( parent );
244 // Get a new id - if already allocated, do nothing
245 char *id = westley_get_id( context, parent, westley_producer );
249 child = xmlNewChild( node, NULL, "producer", NULL );
252 xmlNewProp( child, "id", id );
253 xmlNewProp( child, "in", mlt_properties_get( properties, "in" ) );
254 xmlNewProp( child, "out", mlt_properties_get( properties, "out" ) );
255 serialise_properties( context, properties, child );
256 serialise_service_filters( context, service, child );
258 // Add producer to the map
259 mlt_properties_set_int( context->hide_map, id, mlt_properties_get_int( properties, "hide" ) );
263 char *id = westley_get_id( context, parent, westley_existing );
264 mlt_properties properties = mlt_service_properties( service );
265 xmlNewProp( node, "parent", id );
266 xmlNewProp( node, "in", mlt_properties_get( properties, "in" ) );
267 xmlNewProp( node, "out", mlt_properties_get( properties, "out" ) );
271 static void serialise_multitrack( serialise_context context, mlt_service service, xmlNode *node )
275 if ( context->pass == 0 )
277 // Iterate over the tracks to collect the producers
278 for ( i = 0; i < mlt_multitrack_count( MLT_MULTITRACK( service ) ); i++ )
279 serialise_service( context, MLT_SERVICE( mlt_multitrack_track( MLT_MULTITRACK( service ), i ) ), node );
283 // Get a new id - if already allocated, do nothing
284 char *id = westley_get_id( context, service, westley_multitrack );
288 // Serialise the tracks
289 for ( i = 0; i < mlt_multitrack_count( MLT_MULTITRACK( service ) ); i++ )
291 xmlNode *track = xmlNewChild( node, NULL, "track", NULL );
293 mlt_producer producer = mlt_multitrack_track( MLT_MULTITRACK( service ), i );
294 mlt_properties properties = mlt_producer_properties( producer );
296 mlt_service parent = MLT_SERVICE( mlt_producer_cut_parent( producer ) );
298 char *id = westley_get_id( context, MLT_SERVICE( parent ), westley_existing );
299 xmlNewProp( track, "producer", id );
300 xmlNewProp( track, "in", mlt_properties_get( properties, "in" ) );
301 xmlNewProp( track, "out", mlt_properties_get( properties, "out" ) );
303 hide = mlt_properties_get_int( context->hide_map, id );
305 xmlNewProp( track, "hide", hide == 1 ? "video" : ( hide == 2 ? "audio" : "both" ) );
307 serialise_service_filters( context, service, node );
311 static void serialise_tractor( serialise_context context, mlt_service service, xmlNode *node );
313 static void serialise_playlist( serialise_context context, mlt_service service, xmlNode *node )
316 xmlNode *child = node;
317 mlt_playlist_clip_info info;
318 mlt_properties properties = mlt_service_properties( service );
320 if ( context->pass == 0 )
322 // Get a new id - if already allocated, do nothing
323 char *id = westley_get_id( context, service, westley_playlist );
327 // Iterate over the playlist entries to collect the producers
328 for ( i = 0; i < mlt_playlist_count( MLT_PLAYLIST( service ) ); i++ )
330 if ( ! mlt_playlist_get_clip_info( MLT_PLAYLIST( service ), &info, i ) )
332 if ( info.producer != NULL )
334 mlt_producer producer = mlt_producer_cut_parent( info.producer );
335 char *service_s = mlt_properties_get( mlt_producer_properties( producer ), "mlt_service" );
336 char *resource_s = mlt_properties_get( mlt_producer_properties( producer ), "resource" );
337 if ( resource_s != NULL && !strcmp( resource_s, "<tractor>" ) )
339 serialise_tractor( context, MLT_SERVICE( producer ), node );
341 serialise_tractor( context, MLT_SERVICE( producer ), node );
344 else if ( service_s != NULL && strcmp( service_s, "blank" ) != 0 )
345 serialise_service( context, MLT_SERVICE( producer ), node );
346 else if ( resource_s != NULL && !strcmp( resource_s, "<playlist>" ) )
347 serialise_playlist( context, MLT_SERVICE( producer ), node );
352 child = xmlNewChild( node, NULL, "playlist", NULL );
355 xmlNewProp( child, "id", id );
357 // Add producer to the map
358 mlt_properties_set_int( context->hide_map, id, mlt_properties_get_int( properties, "hide" ) );
360 // Iterate over the playlist entries
361 for ( i = 0; i < mlt_playlist_count( MLT_PLAYLIST( service ) ); i++ )
363 if ( ! mlt_playlist_get_clip_info( MLT_PLAYLIST( service ), &info, i ) )
365 mlt_producer producer = mlt_producer_cut_parent( info.producer );
366 char *service_s = mlt_properties_get( mlt_producer_properties( producer ), "mlt_service" );
367 if ( service_s != NULL && strcmp( service_s, "blank" ) == 0 )
371 xmlNode *entry = xmlNewChild( child, NULL, "blank", NULL );
372 snprintf( length, 19, "%d", info.frame_count );
373 xmlNewProp( entry, "length", length );
378 xmlNode *entry = xmlNewChild( child, NULL, "entry", NULL );
379 id = westley_get_id( context, MLT_SERVICE( producer ), westley_existing );
380 xmlNewProp( entry, "producer", id );
381 sprintf( temp, "%d", info.frame_in );
382 xmlNewProp( entry, "in", temp );
383 sprintf( temp, "%d", info.frame_out );
384 xmlNewProp( entry, "out", temp );
385 if ( mlt_producer_is_cut( info.producer ) )
386 serialise_service_filters( context, mlt_producer_service( info.producer ), entry );
391 serialise_service_filters( context, service, child );
393 else if ( strcmp( (const char*) node->name, "tractor" ) != 0 )
395 char *id = westley_get_id( context, service, westley_existing );
396 xmlNewProp( node, "producer", id );
400 static void serialise_tractor( serialise_context context, mlt_service service, xmlNode *node )
402 xmlNode *child = node;
403 mlt_properties properties = mlt_service_properties( service );
405 if ( context->pass == 0 )
407 // Recurse on connected producer
408 serialise_service( context, mlt_service_producer( service ), node );
412 // Get a new id - if already allocated, do nothing
413 char *id = westley_get_id( context, service, westley_tractor );
417 child = xmlNewChild( node, NULL, "tractor", NULL );
420 xmlNewProp( child, "id", id );
421 xmlNewProp( child, "in", mlt_properties_get( properties, "in" ) );
422 xmlNewProp( child, "out", mlt_properties_get( properties, "out" ) );
424 // Recurse on connected producer
425 serialise_service( context, mlt_service_producer( service ), child );
426 serialise_service_filters( context, service, child );
430 static void serialise_filter( serialise_context context, mlt_service service, xmlNode *node )
432 xmlNode *child = node;
433 mlt_properties properties = mlt_service_properties( service );
435 // Recurse on connected producer
436 serialise_service( context, mlt_service_producer( service ), node );
438 if ( context->pass == 1 )
440 // Get a new id - if already allocated, do nothing
441 char *id = westley_get_id( context, service, westley_filter );
445 child = xmlNewChild( node, NULL, "filter", NULL );
448 xmlNewProp( child, "id", id );
449 xmlNewProp( child, "in", mlt_properties_get( properties, "in" ) );
450 xmlNewProp( child, "out", mlt_properties_get( properties, "out" ) );
452 serialise_properties( context, properties, child );
453 serialise_service_filters( context, service, child );
457 static void serialise_transition( serialise_context context, mlt_service service, xmlNode *node )
459 xmlNode *child = node;
460 mlt_properties properties = mlt_service_properties( service );
462 // Recurse on connected producer
463 serialise_service( context, MLT_SERVICE( MLT_TRANSITION( service )->producer ), node );
465 if ( context->pass == 1 )
467 // Get a new id - if already allocated, do nothing
468 char *id = westley_get_id( context, service, westley_transition );
472 child = xmlNewChild( node, NULL, "transition", NULL );
475 xmlNewProp( child, "id", id );
476 xmlNewProp( child, "in", mlt_properties_get( properties, "in" ) );
477 xmlNewProp( child, "out", mlt_properties_get( properties, "out" ) );
479 serialise_properties( context, properties, child );
480 serialise_service_filters( context, service, child );
484 static void serialise_service( serialise_context context, mlt_service service, xmlNode *node )
486 // Iterate over consumer/producer connections
487 while ( service != NULL )
489 mlt_properties properties = mlt_service_properties( service );
490 char *mlt_type = mlt_properties_get( properties, "mlt_type" );
492 // Tell about the producer
493 if ( strcmp( mlt_type, "producer" ) == 0 )
495 serialise_producer( context, service, node );
496 if ( mlt_properties_get( properties, "westley" ) != NULL )
500 // Tell about the framework container producers
501 else if ( strcmp( mlt_type, "mlt_producer" ) == 0 )
503 char *resource = mlt_properties_get( properties, "resource" );
505 // Recurse on multitrack's tracks
506 if ( strcmp( resource, "<multitrack>" ) == 0 )
508 serialise_multitrack( context, service, node );
512 // Recurse on playlist's clips
513 else if ( strcmp( resource, "<playlist>" ) == 0 )
515 serialise_playlist( context, service, node );
518 // Recurse on tractor's producer
519 else if ( strcmp( resource, "<tractor>" ) == 0 )
521 serialise_tractor( context, service, node );
525 // Treat it as a normal producer
528 serialise_producer( context, service, node );
532 // Tell about a filter
533 else if ( strcmp( mlt_type, "filter" ) == 0 )
535 serialise_filter( context, service, node );
539 // Tell about a transition
540 else if ( strcmp( mlt_type, "transition" ) == 0 )
542 serialise_transition( context, service, node );
546 // Get the next connected service
547 service = mlt_service_producer( service );
551 xmlDocPtr westley_make_doc( mlt_service service )
553 mlt_properties properties = mlt_service_properties( service );
554 xmlDocPtr doc = xmlNewDoc( "1.0" );
555 xmlNodePtr root = xmlNewNode( NULL, "westley" );
556 struct serialise_context_s *context = calloc( 1, sizeof( struct serialise_context_s ) );
558 xmlDocSetRootElement( doc, root );
560 // If we have root, then deal with it now
561 if ( mlt_properties_get( properties, "root" ) != NULL )
563 xmlNewProp( root, "root", mlt_properties_get( properties, "root" ) );
564 context->root = strdup( mlt_properties_get( properties, "root" ) );
568 context->root = strdup( "" );
571 // Assign a title property
572 if ( mlt_properties_get( properties, "title" ) != NULL )
573 xmlNewProp( root, "title", mlt_properties_get( properties, "title" ) );
575 // Construct the context maps
576 context->id_map = mlt_properties_new();
577 context->hide_map = mlt_properties_new();
579 // Ensure producer is a framework producer
580 mlt_properties_set( mlt_service_properties( service ), "mlt_type", "mlt_producer" );
582 // In pass one, we serialise the end producers and playlists,
583 // adding them to a map keyed by address.
584 serialise_service( context, service, root );
586 // In pass two, we serialise the tractor and reference the
587 // producers and playlists
589 serialise_service( context, service, root );
592 mlt_properties_close( context->id_map );
593 mlt_properties_close( context->hide_map );
594 free( context->root );
600 static int consumer_start( mlt_consumer this )
602 xmlDocPtr doc = NULL;
604 // Get the producer service
605 mlt_service service = mlt_service_producer( mlt_consumer_service( this ) );
606 if ( service != NULL )
608 mlt_properties properties = mlt_consumer_properties( this );
609 char *resource = mlt_properties_get( properties, "resource" );
611 // Set the title if provided
612 if ( mlt_properties_get( properties, "title" ) )
613 mlt_properties_set( mlt_service_properties( service ), "title", mlt_properties_get( properties, "title" ) );
614 else if ( mlt_properties_get( mlt_service_properties( service ), "title" ) == NULL )
615 mlt_properties_set( mlt_service_properties( service ), "title", "Anonymous Submission" );
617 // Check for a root on the consumer properties and pass to service
618 if ( mlt_properties_get( properties, "root" ) )
619 mlt_properties_set( mlt_service_properties( service ), "root", mlt_properties_get( properties, "root" ) );
621 // Specify roots in other cases...
622 if ( resource != NULL && mlt_properties_get( properties, "root" ) == NULL )
624 // Get the current working directory
625 char *cwd = getcwd( NULL, 0 );
626 mlt_properties_set( mlt_service_properties( service ), "root", cwd );
631 doc = westley_make_doc( service );
634 if ( resource == NULL || !strcmp( resource, "" ) )
636 xmlDocFormatDump( stdout, doc, 1 );
638 else if ( !strcmp( resource, "buffer" ) )
640 xmlChar *buffer = NULL;
642 xmlDocDumpMemory( doc, &buffer, &length );
643 mlt_properties_set_data( properties, "buffer", buffer, length, xmlFree, NULL );
647 xmlSaveFormatFile( resource, doc, 1 );
650 // Close the document
654 mlt_consumer_stop( this );
656 mlt_consumer_stopped( this );
661 static int consumer_is_stopped( mlt_consumer this )