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 serialise_properties( context
, properties
, child
);
253 serialise_service_filters( context
, service
, child
);
255 // Add producer to the map
256 mlt_properties_set_int( context
->hide_map
, id
, mlt_properties_get_int( properties
, "hide" ) );
260 // Get a new id - if already allocated, do nothing
261 char *id
= westley_get_id( context
, service
, westley_existing
);
262 xmlNewProp( node
, "producer", id
);
266 static void serialise_multitrack( serialise_context context
, mlt_service service
, xmlNode
*node
)
270 if ( context
->pass
== 0 )
272 // Iterate over the tracks to collect the producers
273 for ( i
= 0; i
< mlt_multitrack_count( MLT_MULTITRACK( service
) ); i
++ )
274 serialise_service( context
, MLT_SERVICE( mlt_multitrack_track( MLT_MULTITRACK( service
), i
) ), node
);
278 // Get a new id - if already allocated, do nothing
279 char *id
= westley_get_id( context
, service
, westley_multitrack
);
283 // Serialise the tracks
284 for ( i
= 0; i
< mlt_multitrack_count( MLT_MULTITRACK( service
) ); i
++ )
286 xmlNode
*track
= xmlNewChild( node
, NULL
, "track", NULL
);
288 mlt_producer producer
= mlt_multitrack_track( MLT_MULTITRACK( service
), i
);
290 char *id
= westley_get_id( context
, MLT_SERVICE( producer
), westley_existing
);
291 xmlNewProp( track
, "producer", id
);
293 hide
= mlt_properties_get_int( context
->hide_map
, id
);
295 xmlNewProp( track
, "hide", hide
== 1 ?
"video" : ( hide
== 2 ?
"audio" : "both" ) );
297 serialise_service_filters( context
, service
, node
);
301 static void serialise_tractor( serialise_context context
, mlt_service service
, xmlNode
*node
);
303 static void serialise_playlist( serialise_context context
, mlt_service service
, xmlNode
*node
)
306 xmlNode
*child
= node
;
307 mlt_playlist_clip_info info
;
308 mlt_properties properties
= mlt_service_properties( service
);
310 if ( context
->pass
== 0 )
312 // Get a new id - if already allocated, do nothing
313 char *id
= westley_get_id( context
, service
, westley_playlist
);
317 // Iterate over the playlist entries to collect the producers
318 for ( i
= 0; i
< mlt_playlist_count( MLT_PLAYLIST( service
) ); i
++ )
320 if ( ! mlt_playlist_get_clip_info( MLT_PLAYLIST( service
), &info
, i
) )
322 if ( info
.producer
!= NULL
)
324 char *service_s
= mlt_properties_get( mlt_producer_properties( info
.producer
), "mlt_service" );
325 char *resource_s
= mlt_properties_get( mlt_producer_properties( info
.producer
), "resource" );
326 if ( resource_s
!= NULL
&& !strcmp( resource_s
, "<tractor>" ) )
328 serialise_tractor( context
, MLT_SERVICE( info
.producer
), node
);
330 serialise_tractor( context
, MLT_SERVICE( info
.producer
), node
);
333 else if ( service_s
!= NULL
&& strcmp( service_s
, "blank" ) != 0 )
334 serialise_service( context
, MLT_SERVICE( info
.producer
), node
);
335 else if ( resource_s
!= NULL
&& !strcmp( resource_s
, "<playlist>" ) )
336 serialise_playlist( context
, MLT_SERVICE( info
.producer
), node
);
341 child
= xmlNewChild( node
, NULL
, "playlist", NULL
);
344 xmlNewProp( child
, "id", id
);
346 // Add producer to the map
347 mlt_properties_set_int( context
->hide_map
, id
, mlt_properties_get_int( properties
, "hide" ) );
349 // Iterate over the playlist entries
350 for ( i
= 0; i
< mlt_playlist_count( MLT_PLAYLIST( service
) ); i
++ )
352 if ( ! mlt_playlist_get_clip_info( MLT_PLAYLIST( service
), &info
, i
) )
354 char *service_s
= mlt_properties_get( mlt_producer_properties( info
.producer
), "mlt_service" );
355 if ( service_s
!= NULL
&& strcmp( service_s
, "blank" ) == 0 )
359 xmlNode
*entry
= xmlNewChild( child
, NULL
, "blank", NULL
);
360 snprintf( length
, 19, "%d", info
.frame_count
);
361 xmlNewProp( entry
, "length", length
);
366 xmlNode
*entry
= xmlNewChild( child
, NULL
, "entry", NULL
);
367 id
= westley_get_id( context
, MLT_SERVICE( info
.producer
), westley_existing
);
368 xmlNewProp( entry
, "producer", id
);
369 sprintf( temp
, "%d", info
.frame_in
);
370 xmlNewProp( entry
, "in", temp
);
371 sprintf( temp
, "%d", info
.frame_out
);
372 xmlNewProp( entry
, "out", temp
);
377 serialise_service_filters( context
, service
, child
);
379 else if ( strcmp( (const char*) node
->name
, "tractor" ) != 0 )
381 char *id
= westley_get_id( context
, service
, westley_existing
);
382 xmlNewProp( node
, "producer", id
);
386 static void serialise_tractor( serialise_context context
, mlt_service service
, xmlNode
*node
)
388 xmlNode
*child
= node
;
389 mlt_properties properties
= mlt_service_properties( service
);
391 if ( context
->pass
== 0 )
393 // Recurse on connected producer
394 serialise_service( context
, mlt_service_producer( service
), node
);
398 // Get a new id - if already allocated, do nothing
399 char *id
= westley_get_id( context
, service
, westley_tractor
);
403 child
= xmlNewChild( node
, NULL
, "tractor", NULL
);
406 xmlNewProp( child
, "id", id
);
407 xmlNewProp( child
, "in", mlt_properties_get( properties
, "in" ) );
408 xmlNewProp( child
, "out", mlt_properties_get( properties
, "out" ) );
410 // Recurse on connected producer
411 serialise_service( context
, mlt_service_producer( service
), child
);
412 serialise_service_filters( context
, service
, child
);
416 static void serialise_filter( serialise_context context
, mlt_service service
, xmlNode
*node
)
418 xmlNode
*child
= node
;
419 mlt_properties properties
= mlt_service_properties( service
);
421 // Recurse on connected producer
422 serialise_service( context
, mlt_service_producer( service
), node
);
424 if ( context
->pass
== 1 )
426 // Get a new id - if already allocated, do nothing
427 char *id
= westley_get_id( context
, service
, westley_filter
);
431 child
= xmlNewChild( node
, NULL
, "filter", NULL
);
434 xmlNewProp( child
, "id", id
);
435 xmlNewProp( child
, "in", mlt_properties_get( properties
, "in" ) );
436 xmlNewProp( child
, "out", mlt_properties_get( properties
, "out" ) );
438 serialise_properties( context
, properties
, child
);
439 serialise_service_filters( context
, service
, child
);
443 static void serialise_transition( serialise_context context
, mlt_service service
, xmlNode
*node
)
445 xmlNode
*child
= node
;
446 mlt_properties properties
= mlt_service_properties( service
);
448 // Recurse on connected producer
449 serialise_service( context
, MLT_SERVICE( MLT_TRANSITION( service
)->producer
), node
);
451 if ( context
->pass
== 1 )
453 // Get a new id - if already allocated, do nothing
454 char *id
= westley_get_id( context
, service
, westley_transition
);
458 child
= xmlNewChild( node
, NULL
, "transition", NULL
);
461 xmlNewProp( child
, "id", id
);
462 xmlNewProp( child
, "in", mlt_properties_get( properties
, "in" ) );
463 xmlNewProp( child
, "out", mlt_properties_get( properties
, "out" ) );
465 serialise_properties( context
, properties
, child
);
466 serialise_service_filters( context
, service
, child
);
470 static void serialise_service( serialise_context context
, mlt_service service
, xmlNode
*node
)
472 // Iterate over consumer/producer connections
473 while ( service
!= NULL
)
475 mlt_properties properties
= mlt_service_properties( service
);
476 char *mlt_type
= mlt_properties_get( properties
, "mlt_type" );
478 // Tell about the producer
479 if ( strcmp( mlt_type
, "producer" ) == 0 )
481 serialise_producer( context
, service
, node
);
482 if ( mlt_properties_get( properties
, "westley" ) != NULL
)
486 // Tell about the framework container producers
487 else if ( strcmp( mlt_type
, "mlt_producer" ) == 0 )
489 char *resource
= mlt_properties_get( properties
, "resource" );
491 // Recurse on multitrack's tracks
492 if ( strcmp( resource
, "<multitrack>" ) == 0 )
494 serialise_multitrack( context
, service
, node
);
498 // Recurse on playlist's clips
499 else if ( strcmp( resource
, "<playlist>" ) == 0 )
501 serialise_playlist( context
, service
, node
);
504 // Recurse on tractor's producer
505 else if ( strcmp( resource
, "<tractor>" ) == 0 )
507 serialise_tractor( context
, service
, node
);
511 // Treat it as a normal producer
514 serialise_producer( context
, service
, node
);
518 // Tell about a filter
519 else if ( strcmp( mlt_type
, "filter" ) == 0 )
521 serialise_filter( context
, service
, node
);
525 // Tell about a transition
526 else if ( strcmp( mlt_type
, "transition" ) == 0 )
528 serialise_transition( context
, service
, node
);
532 // Get the next connected service
533 service
= mlt_service_producer( service
);
537 xmlDocPtr
westley_make_doc( mlt_service service
)
539 mlt_properties properties
= mlt_service_properties( service
);
540 xmlDocPtr doc
= xmlNewDoc( "1.0" );
541 xmlNodePtr root
= xmlNewNode( NULL
, "westley" );
542 struct serialise_context_s
*context
= calloc( 1, sizeof( struct serialise_context_s
) );
544 xmlDocSetRootElement( doc
, root
);
546 // If we have root, then deal with it now
547 if ( mlt_properties_get( properties
, "root" ) != NULL
)
549 xmlNewProp( root
, "root", mlt_properties_get( properties
, "root" ) );
550 context
->root
= strdup( mlt_properties_get( properties
, "root" ) );
554 context
->root
= strdup( "" );
557 // Assign a title property
558 if ( mlt_properties_get( properties
, "title" ) != NULL
)
559 xmlNewProp( root
, "title", mlt_properties_get( properties
, "title" ) );
561 // Construct the context maps
562 context
->id_map
= mlt_properties_new();
563 context
->hide_map
= mlt_properties_new();
565 // Ensure producer is a framework producer
566 mlt_properties_set( mlt_service_properties( service
), "mlt_type", "mlt_producer" );
568 // In pass one, we serialise the end producers and playlists,
569 // adding them to a map keyed by address.
570 serialise_service( context
, service
, root
);
572 // In pass two, we serialise the tractor and reference the
573 // producers and playlists
575 serialise_service( context
, service
, root
);
578 mlt_properties_close( context
->id_map
);
579 mlt_properties_close( context
->hide_map
);
580 free( context
->root
);
586 static int consumer_start( mlt_consumer
this )
588 xmlDocPtr doc
= NULL
;
590 // Get the producer service
591 mlt_service service
= mlt_service_producer( mlt_consumer_service( this ) );
592 if ( service
!= NULL
)
594 mlt_properties properties
= mlt_consumer_properties( this );
595 char *resource
= mlt_properties_get( properties
, "resource" );
597 // Set the title if provided
598 if ( mlt_properties_get( properties
, "title" ) )
599 mlt_properties_set( mlt_service_properties( service
), "title", mlt_properties_get( properties
, "title" ) );
600 else if ( mlt_properties_get( mlt_service_properties( service
), "title" ) == NULL
)
601 mlt_properties_set( mlt_service_properties( service
), "title", "Anonymous Submission" );
603 // Check for a root on the consumer properties and pass to service
604 if ( mlt_properties_get( properties
, "root" ) )
605 mlt_properties_set( mlt_service_properties( service
), "root", mlt_properties_get( properties
, "root" ) );
607 // Specify roots in other cases...
608 if ( resource
!= NULL
&& mlt_properties_get( properties
, "root" ) == NULL
)
610 // Get the current working directory
611 char *cwd
= getcwd( NULL
, 0 );
612 mlt_properties_set( mlt_service_properties( service
), "root", cwd
);
617 doc
= westley_make_doc( service
);
620 if ( resource
== NULL
|| !strcmp( resource
, "" ) )
622 xmlDocFormatDump( stdout
, doc
, 1 );
624 else if ( !strcmp( resource
, "buffer" ) )
626 xmlChar
*buffer
= NULL
;
628 xmlDocDumpMemory( doc
, &buffer
, &length
);
629 mlt_properties_set_data( properties
, "buffer", buffer
, length
, xmlFree
, NULL
);
633 xmlSaveFormatFile( resource
, doc
, 1 );
636 // Close the document
640 mlt_consumer_stop( this );
642 mlt_consumer_stopped( this );
647 static int consumer_is_stopped( mlt_consumer
this )