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_properties properties
= mlt_service_properties( service
);
241 if ( context
->pass
== 0 )
243 // Get a new id - if already allocated, do nothing
244 char *id
= westley_get_id( context
, service
, westley_producer
);
248 child
= xmlNewChild( node
, NULL
, "producer", NULL
);
251 xmlNewProp( child
, "id", id
);
252 xmlNewProp( child
, "in", mlt_properties_get( properties
, "in" ) );
253 xmlNewProp( child
, "out", mlt_properties_get( properties
, "out" ) );
254 serialise_properties( context
, properties
, child
);
255 serialise_service_filters( context
, service
, child
);
257 // Add producer to the map
258 mlt_properties_set_int( context
->hide_map
, id
, mlt_properties_get_int( properties
, "hide" ) );
262 // Get a new id - if already allocated, do nothing
263 char *id
= westley_get_id( context
, service
, westley_existing
);
264 xmlNewProp( node
, "producer", id
);
268 static void serialise_multitrack( serialise_context context
, mlt_service service
, xmlNode
*node
)
272 if ( context
->pass
== 0 )
274 // Iterate over the tracks to collect the producers
275 for ( i
= 0; i
< mlt_multitrack_count( MLT_MULTITRACK( service
) ); i
++ )
276 serialise_service( context
, MLT_SERVICE( mlt_multitrack_track( MLT_MULTITRACK( service
), i
) ), node
);
280 // Get a new id - if already allocated, do nothing
281 char *id
= westley_get_id( context
, service
, westley_multitrack
);
285 // Serialise the tracks
286 for ( i
= 0; i
< mlt_multitrack_count( MLT_MULTITRACK( service
) ); i
++ )
288 xmlNode
*track
= xmlNewChild( node
, NULL
, "track", NULL
);
290 mlt_producer producer
= mlt_multitrack_track( MLT_MULTITRACK( service
), i
);
292 char *id
= westley_get_id( context
, MLT_SERVICE( producer
), westley_existing
);
293 xmlNewProp( track
, "producer", id
);
295 hide
= mlt_properties_get_int( context
->hide_map
, id
);
297 xmlNewProp( track
, "hide", hide
== 1 ?
"video" : ( hide
== 2 ?
"audio" : "both" ) );
299 serialise_service_filters( context
, service
, node
);
303 static void serialise_tractor( serialise_context context
, mlt_service service
, xmlNode
*node
);
305 static void serialise_playlist( serialise_context context
, mlt_service service
, xmlNode
*node
)
308 xmlNode
*child
= node
;
309 mlt_playlist_clip_info info
;
310 mlt_properties properties
= mlt_service_properties( service
);
312 if ( context
->pass
== 0 )
314 // Get a new id - if already allocated, do nothing
315 char *id
= westley_get_id( context
, service
, westley_playlist
);
319 // Iterate over the playlist entries to collect the producers
320 for ( i
= 0; i
< mlt_playlist_count( MLT_PLAYLIST( service
) ); i
++ )
322 if ( ! mlt_playlist_get_clip_info( MLT_PLAYLIST( service
), &info
, i
) )
324 if ( info
.producer
!= NULL
)
326 mlt_producer producer
= mlt_producer_cut_parent( info
.producer
);
327 char *service_s
= mlt_properties_get( mlt_producer_properties( producer
), "mlt_service" );
328 char *resource_s
= mlt_properties_get( mlt_producer_properties( producer
), "resource" );
329 if ( resource_s
!= NULL
&& !strcmp( resource_s
, "<tractor>" ) )
331 serialise_tractor( context
, MLT_SERVICE( producer
), node
);
333 serialise_tractor( context
, MLT_SERVICE( producer
), node
);
336 else if ( service_s
!= NULL
&& strcmp( service_s
, "blank" ) != 0 )
337 serialise_service( context
, MLT_SERVICE( producer
), node
);
338 else if ( resource_s
!= NULL
&& !strcmp( resource_s
, "<playlist>" ) )
339 serialise_playlist( context
, MLT_SERVICE( producer
), node
);
344 child
= xmlNewChild( node
, NULL
, "playlist", NULL
);
347 xmlNewProp( child
, "id", id
);
349 // Add producer to the map
350 mlt_properties_set_int( context
->hide_map
, id
, mlt_properties_get_int( properties
, "hide" ) );
352 // Iterate over the playlist entries
353 for ( i
= 0; i
< mlt_playlist_count( MLT_PLAYLIST( service
) ); i
++ )
355 if ( ! mlt_playlist_get_clip_info( MLT_PLAYLIST( service
), &info
, i
) )
357 mlt_producer producer
= mlt_producer_cut_parent( info
.producer
);
358 char *service_s
= mlt_properties_get( mlt_producer_properties( producer
), "mlt_service" );
359 if ( service_s
!= NULL
&& strcmp( service_s
, "blank" ) == 0 )
363 xmlNode
*entry
= xmlNewChild( child
, NULL
, "blank", NULL
);
364 snprintf( length
, 19, "%d", info
.frame_count
);
365 xmlNewProp( entry
, "length", length
);
370 xmlNode
*entry
= xmlNewChild( child
, NULL
, "entry", NULL
);
371 id
= westley_get_id( context
, MLT_SERVICE( producer
), westley_existing
);
372 xmlNewProp( entry
, "producer", id
);
373 sprintf( temp
, "%d", info
.frame_in
);
374 xmlNewProp( entry
, "in", temp
);
375 sprintf( temp
, "%d", info
.frame_out
);
376 xmlNewProp( entry
, "out", temp
);
377 if ( mlt_producer_is_cut( info
.producer
) )
378 serialise_service_filters( context
, mlt_producer_service( info
.producer
), entry
);
383 serialise_service_filters( context
, service
, child
);
385 else if ( strcmp( (const char*) node
->name
, "tractor" ) != 0 )
387 char *id
= westley_get_id( context
, service
, westley_existing
);
388 xmlNewProp( node
, "producer", id
);
392 static void serialise_tractor( serialise_context context
, mlt_service service
, xmlNode
*node
)
394 xmlNode
*child
= node
;
395 mlt_properties properties
= mlt_service_properties( service
);
397 if ( context
->pass
== 0 )
399 // Recurse on connected producer
400 serialise_service( context
, mlt_service_producer( service
), node
);
404 // Get a new id - if already allocated, do nothing
405 char *id
= westley_get_id( context
, service
, westley_tractor
);
409 child
= xmlNewChild( node
, NULL
, "tractor", NULL
);
412 xmlNewProp( child
, "id", id
);
413 xmlNewProp( child
, "in", mlt_properties_get( properties
, "in" ) );
414 xmlNewProp( child
, "out", mlt_properties_get( properties
, "out" ) );
416 // Recurse on connected producer
417 serialise_service( context
, mlt_service_producer( service
), child
);
418 serialise_service_filters( context
, service
, child
);
422 static void serialise_filter( serialise_context context
, mlt_service service
, xmlNode
*node
)
424 xmlNode
*child
= node
;
425 mlt_properties properties
= mlt_service_properties( service
);
427 // Recurse on connected producer
428 serialise_service( context
, mlt_service_producer( service
), node
);
430 if ( context
->pass
== 1 )
432 // Get a new id - if already allocated, do nothing
433 char *id
= westley_get_id( context
, service
, westley_filter
);
437 child
= xmlNewChild( node
, NULL
, "filter", NULL
);
440 xmlNewProp( child
, "id", id
);
441 xmlNewProp( child
, "in", mlt_properties_get( properties
, "in" ) );
442 xmlNewProp( child
, "out", mlt_properties_get( properties
, "out" ) );
444 serialise_properties( context
, properties
, child
);
445 serialise_service_filters( context
, service
, child
);
449 static void serialise_transition( serialise_context context
, mlt_service service
, xmlNode
*node
)
451 xmlNode
*child
= node
;
452 mlt_properties properties
= mlt_service_properties( service
);
454 // Recurse on connected producer
455 serialise_service( context
, MLT_SERVICE( MLT_TRANSITION( service
)->producer
), node
);
457 if ( context
->pass
== 1 )
459 // Get a new id - if already allocated, do nothing
460 char *id
= westley_get_id( context
, service
, westley_transition
);
464 child
= xmlNewChild( node
, NULL
, "transition", NULL
);
467 xmlNewProp( child
, "id", id
);
468 xmlNewProp( child
, "in", mlt_properties_get( properties
, "in" ) );
469 xmlNewProp( child
, "out", mlt_properties_get( properties
, "out" ) );
471 serialise_properties( context
, properties
, child
);
472 serialise_service_filters( context
, service
, child
);
476 static void serialise_service( serialise_context context
, mlt_service service
, xmlNode
*node
)
478 // Iterate over consumer/producer connections
479 while ( service
!= NULL
)
481 mlt_properties properties
= mlt_service_properties( service
);
482 char *mlt_type
= mlt_properties_get( properties
, "mlt_type" );
484 // Tell about the producer
485 if ( strcmp( mlt_type
, "producer" ) == 0 )
487 serialise_producer( context
, service
, node
);
488 if ( mlt_properties_get( properties
, "westley" ) != NULL
)
492 // Tell about the framework container producers
493 else if ( strcmp( mlt_type
, "mlt_producer" ) == 0 )
495 char *resource
= mlt_properties_get( properties
, "resource" );
497 // Recurse on multitrack's tracks
498 if ( strcmp( resource
, "<multitrack>" ) == 0 )
500 serialise_multitrack( context
, service
, node
);
504 // Recurse on playlist's clips
505 else if ( strcmp( resource
, "<playlist>" ) == 0 )
507 serialise_playlist( context
, service
, node
);
510 // Recurse on tractor's producer
511 else if ( strcmp( resource
, "<tractor>" ) == 0 )
513 serialise_tractor( context
, service
, node
);
517 // Treat it as a normal producer
520 serialise_producer( context
, service
, node
);
524 // Tell about a filter
525 else if ( strcmp( mlt_type
, "filter" ) == 0 )
527 serialise_filter( context
, service
, node
);
531 // Tell about a transition
532 else if ( strcmp( mlt_type
, "transition" ) == 0 )
534 serialise_transition( context
, service
, node
);
538 // Get the next connected service
539 service
= mlt_service_producer( service
);
543 xmlDocPtr
westley_make_doc( mlt_service service
)
545 mlt_properties properties
= mlt_service_properties( service
);
546 xmlDocPtr doc
= xmlNewDoc( "1.0" );
547 xmlNodePtr root
= xmlNewNode( NULL
, "westley" );
548 struct serialise_context_s
*context
= calloc( 1, sizeof( struct serialise_context_s
) );
550 xmlDocSetRootElement( doc
, root
);
552 // If we have root, then deal with it now
553 if ( mlt_properties_get( properties
, "root" ) != NULL
)
555 xmlNewProp( root
, "root", mlt_properties_get( properties
, "root" ) );
556 context
->root
= strdup( mlt_properties_get( properties
, "root" ) );
560 context
->root
= strdup( "" );
563 // Assign a title property
564 if ( mlt_properties_get( properties
, "title" ) != NULL
)
565 xmlNewProp( root
, "title", mlt_properties_get( properties
, "title" ) );
567 // Construct the context maps
568 context
->id_map
= mlt_properties_new();
569 context
->hide_map
= mlt_properties_new();
571 // Ensure producer is a framework producer
572 mlt_properties_set( mlt_service_properties( service
), "mlt_type", "mlt_producer" );
574 // In pass one, we serialise the end producers and playlists,
575 // adding them to a map keyed by address.
576 serialise_service( context
, service
, root
);
578 // In pass two, we serialise the tractor and reference the
579 // producers and playlists
581 serialise_service( context
, service
, root
);
584 mlt_properties_close( context
->id_map
);
585 mlt_properties_close( context
->hide_map
);
586 free( context
->root
);
592 static int consumer_start( mlt_consumer
this )
594 xmlDocPtr doc
= NULL
;
596 // Get the producer service
597 mlt_service service
= mlt_service_producer( mlt_consumer_service( this ) );
598 if ( service
!= NULL
)
600 mlt_properties properties
= mlt_consumer_properties( this );
601 char *resource
= mlt_properties_get( properties
, "resource" );
603 // Set the title if provided
604 if ( mlt_properties_get( properties
, "title" ) )
605 mlt_properties_set( mlt_service_properties( service
), "title", mlt_properties_get( properties
, "title" ) );
606 else if ( mlt_properties_get( mlt_service_properties( service
), "title" ) == NULL
)
607 mlt_properties_set( mlt_service_properties( service
), "title", "Anonymous Submission" );
609 // Check for a root on the consumer properties and pass to service
610 if ( mlt_properties_get( properties
, "root" ) )
611 mlt_properties_set( mlt_service_properties( service
), "root", mlt_properties_get( properties
, "root" ) );
613 // Specify roots in other cases...
614 if ( resource
!= NULL
&& mlt_properties_get( properties
, "root" ) == NULL
)
616 // Get the current working directory
617 char *cwd
= getcwd( NULL
, 0 );
618 mlt_properties_set( mlt_service_properties( service
), "root", cwd
);
623 doc
= westley_make_doc( service
);
626 if ( resource
== NULL
|| !strcmp( resource
, "" ) )
628 xmlDocFormatDump( stdout
, doc
, 1 );
630 else if ( !strcmp( resource
, "buffer" ) )
632 xmlChar
*buffer
= NULL
;
634 xmlDocDumpMemory( doc
, &buffer
, &length
);
635 mlt_properties_set_data( properties
, "buffer", buffer
, length
, xmlFree
, NULL
);
639 xmlSaveFormatFile( resource
, doc
, 1 );
642 // Close the document
646 mlt_consumer_stop( this );
648 mlt_consumer_stopped( this );
653 static int consumer_is_stopped( mlt_consumer
this )