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>
27 #include <libxml/tree.h>
31 // This maintains counters for adding ids to elements
32 struct serialise_context_s
41 mlt_properties producer_map;
42 mlt_properties hide_map;
44 typedef struct serialise_context_s* serialise_context;
46 /** Forward references to static functions.
49 static int consumer_start( mlt_consumer parent );
50 static int consumer_is_stopped( mlt_consumer this );
51 static void serialise_service( serialise_context context, mlt_service service, xmlNode *node );
53 /** This is what will be called by the factory - anything can be passed in
54 via the argument, but keep it simple.
57 mlt_consumer consumer_westley_init( char *arg )
59 // Create the consumer object
60 mlt_consumer this = calloc( sizeof( struct mlt_consumer_s ), 1 );
62 // If no malloc'd and consumer init ok
63 if ( this != NULL && mlt_consumer_init( this, NULL ) == 0 )
65 // Allow thread to be started/stopped
66 this->start = consumer_start;
67 this->is_stopped = consumer_is_stopped;
69 mlt_properties_set( mlt_consumer_properties( this ), "resource", arg );
71 // Return the consumer produced
75 // malloc or consumer init failed
82 static inline void serialise_properties( mlt_properties properties, xmlNode *node )
87 // Enumerate the properties
88 for ( i = 0; i < mlt_properties_count( properties ); i++ )
90 char *name = mlt_properties_get_name( properties, i );
93 mlt_properties_get_value( properties, i ) != NULL &&
94 strcmp( name, "westley" ) != 0 &&
95 strcmp( name, "in" ) != 0 &&
96 strcmp( name, "out" ) != 0 )
98 p = xmlNewChild( node, NULL, "property", NULL );
99 xmlNewProp( p, "name", mlt_properties_get_name( properties, i ) );
100 xmlNodeSetContent( p, mlt_properties_get_value( properties, i ) );
105 static void serialise_producer( serialise_context context, mlt_service service, xmlNode *node )
107 xmlNode *child = node;
108 char id[ ID_SIZE + 1 ];
110 mlt_properties properties = mlt_service_properties( service );
112 id[ ID_SIZE ] = '\0';
115 if ( context->pass == 0 )
117 child = xmlNewChild( node, NULL, "producer", NULL );
120 if ( mlt_properties_get( properties, "id" ) == NULL )
122 snprintf( id, ID_SIZE, "producer%d", context->producer_count++ );
123 xmlNewProp( child, "id", id );
126 strncpy( id, mlt_properties_get( properties, "id" ), ID_SIZE );
127 serialise_properties( properties, child );
129 // Add producer to the map
130 snprintf( key, 10, "%p", service );
131 mlt_properties_set( context->producer_map, key, id );
132 mlt_properties_set_int( context->hide_map, key, mlt_properties_get_int( properties, "hide" ) );
136 snprintf( key, 10, "%p", service );
137 xmlNewProp( node, "producer", mlt_properties_get( context->producer_map, key ) );
141 static void serialise_multitrack( serialise_context context, mlt_service service, xmlNode *node )
144 xmlNode *child = node;
145 char id[ ID_SIZE + 1 ];
147 mlt_properties properties = mlt_service_properties( service );
149 id[ ID_SIZE ] = '\0';
152 if ( context->pass == 0 )
154 // Iterate over the tracks to collect the producers
155 for ( i = 0; i < mlt_multitrack_count( MLT_MULTITRACK( service ) ); i++ )
156 serialise_service( context, MLT_SERVICE( mlt_multitrack_track( MLT_MULTITRACK( service ), i ) ), node );
160 // Create the multitrack node
161 child = xmlNewChild( node, NULL, "multitrack", NULL );
164 if ( mlt_properties_get( properties, "id" ) == NULL )
166 snprintf( id, ID_SIZE, "multitrack%d", context->multitrack_count++ );
167 xmlNewProp( child, "id", id );
170 // Serialise the tracks
171 for ( i = 0; i < mlt_multitrack_count( MLT_MULTITRACK( service ) ); i++ )
173 xmlNode *track = xmlNewChild( child, NULL, "track", NULL );
176 snprintf( key, 10, "%p", MLT_SERVICE( mlt_multitrack_track( MLT_MULTITRACK( service ), i ) ) );
177 xmlNewProp( track, "producer", mlt_properties_get( context->producer_map, key ) );
179 hide = mlt_properties_get_int( context->hide_map, key );
181 xmlNewProp( track, "hide", hide == 1 ? "video" : ( hide == 2 ? "audio" : "both" ) );
186 static void serialise_playlist( serialise_context context, mlt_service service, xmlNode *node )
189 xmlNode *child = node;
190 char id[ ID_SIZE + 1 ];
192 mlt_playlist_clip_info info;
193 mlt_properties properties = mlt_service_properties( service );
195 id[ ID_SIZE ] = '\0';
198 if ( context->pass == 0 )
200 // Iterate over the playlist entries to collect the producers
201 for ( i = 0; i < mlt_playlist_count( MLT_PLAYLIST( service ) ); i++ )
203 if ( ! mlt_playlist_get_clip_info( MLT_PLAYLIST( service ), &info, i ) )
205 if ( info.producer != NULL )
207 char *service_s = mlt_properties_get( mlt_producer_properties( info.producer ), "mlt_service" );
208 char *resource_s = mlt_properties_get( mlt_producer_properties( info.producer ), "resource" );
209 if ( service_s != NULL && strcmp( service_s, "blank" ) != 0 )
210 serialise_service( context, MLT_SERVICE( info.producer ), node );
211 else if ( resource_s != NULL && !strcmp( resource_s, "<playlist>" ) )
212 serialise_playlist( context, MLT_SERVICE( info.producer ), node );
217 child = xmlNewChild( node, NULL, "playlist", NULL );
220 if ( mlt_properties_get( properties, "id" ) == NULL )
222 snprintf( id, ID_SIZE, "playlist%d", context->playlist_count++ );
223 xmlNewProp( child, "id", id );
226 strncpy( id, mlt_properties_get( properties, "id" ), ID_SIZE );
228 // Add producer to the map
229 snprintf( key, 10, "%p", service );
230 mlt_properties_set( context->producer_map, key, id );
231 mlt_properties_set_int( context->hide_map, key, mlt_properties_get_int( properties, "hide" ) );
233 // Iterate over the playlist entries
234 for ( i = 0; i < mlt_playlist_count( MLT_PLAYLIST( service ) ); i++ )
236 if ( ! mlt_playlist_get_clip_info( MLT_PLAYLIST( service ), &info, i ) )
238 char *service_s = mlt_properties_get( mlt_producer_properties( info.producer ), "mlt_service" );
239 if ( service_s != NULL && strcmp( service_s, "blank" ) == 0 )
243 xmlNode *entry = xmlNewChild( child, NULL, "blank", NULL );
244 snprintf( length, 19, "%d", info.frame_count );
245 xmlNewProp( entry, "length", length );
250 xmlNode *entry = xmlNewChild( child, NULL, "entry", NULL );
251 snprintf( key, 10, "%p", MLT_SERVICE( info.producer ) );
252 xmlNewProp( entry, "producer", mlt_properties_get( context->producer_map, key ) );
253 sprintf( temp, "%d", info.frame_in );
254 xmlNewProp( entry, "in", temp );
255 sprintf( temp, "%d", info.frame_out );
256 xmlNewProp( entry, "out", temp );
261 else if ( strcmp( (const char*) node->name, "tractor" ) != 0 )
263 snprintf( key, 10, "%p", service );
264 xmlNewProp( node, "producer", mlt_properties_get( context->producer_map, key ) );
268 static void serialise_tractor( serialise_context context, mlt_service service, xmlNode *node )
270 xmlNode *child = node;
271 char id[ ID_SIZE + 1 ];
272 mlt_properties properties = mlt_service_properties( service );
274 id[ ID_SIZE ] = '\0';
276 if ( context->pass == 0 )
278 // Recurse on connected producer
279 serialise_service( context, mlt_service_producer( service ), node );
283 child = xmlNewChild( node, NULL, "tractor", NULL );
286 if ( mlt_properties_get( properties, "id" ) == NULL )
288 snprintf( id, ID_SIZE, "tractor%d", context->tractor_count++ );
289 xmlNewProp( child, "id", id );
292 xmlNewProp( child, "in", mlt_properties_get( properties, "in" ) );
293 xmlNewProp( child, "out", mlt_properties_get( properties, "out" ) );
295 // Recurse on connected producer
296 serialise_service( context, mlt_service_producer( service ), child );
300 static void serialise_filter( serialise_context context, mlt_service service, xmlNode *node )
302 xmlNode *child = node;
303 char id[ ID_SIZE + 1 ];
304 mlt_properties properties = mlt_service_properties( service );
306 id[ ID_SIZE ] = '\0';
308 // Recurse on connected producer
309 serialise_service( context, mlt_service_producer( service ), node );
311 if ( context->pass == 1 )
313 child = xmlNewChild( node, NULL, "filter", NULL );
316 if ( mlt_properties_get( properties, "id" ) == NULL )
318 snprintf( id, ID_SIZE, "filter%d", context->filter_count++ );
319 xmlNewProp( child, "id", id );
320 xmlNewProp( child, "in", mlt_properties_get( properties, "in" ) );
321 xmlNewProp( child, "out", mlt_properties_get( properties, "out" ) );
324 serialise_properties( properties, child );
328 static void serialise_transition( serialise_context context, mlt_service service, xmlNode *node )
330 xmlNode *child = node;
331 char id[ ID_SIZE + 1 ];
332 mlt_properties properties = mlt_service_properties( service );
334 id[ ID_SIZE ] = '\0';
336 // Recurse on connected producer
337 serialise_service( context, MLT_SERVICE( MLT_TRANSITION( service )->producer ), node );
339 if ( context->pass == 1 )
341 child = xmlNewChild( node, NULL, "transition", NULL );
344 if ( mlt_properties_get( properties, "id" ) == NULL )
346 snprintf( id, ID_SIZE, "transition%d", context->transition_count++ );
347 xmlNewProp( child, "id", id );
348 xmlNewProp( child, "in", mlt_properties_get( properties, "in" ) );
349 xmlNewProp( child, "out", mlt_properties_get( properties, "out" ) );
352 serialise_properties( properties, child );
356 static void serialise_service( serialise_context context, mlt_service service, xmlNode *node )
358 // Iterate over consumer/producer connections
359 while ( service != NULL )
361 mlt_properties properties = mlt_service_properties( service );
362 char *mlt_type = mlt_properties_get( properties, "mlt_type" );
364 // Tell about the producer
365 if ( strcmp( mlt_type, "producer" ) == 0 )
367 serialise_producer( context, service, node );
368 if ( mlt_properties_get( properties, "westley" ) != NULL )
372 // Tell about the framework container producers
373 else if ( strcmp( mlt_type, "mlt_producer" ) == 0 )
375 char *resource = mlt_properties_get( properties, "resource" );
377 // Recurse on multitrack's tracks
378 if ( strcmp( resource, "<multitrack>" ) == 0 )
380 serialise_multitrack( context, service, node );
384 // Recurse on playlist's clips
385 else if ( strcmp( resource, "<playlist>" ) == 0 )
387 serialise_playlist( context, service, node );
390 // Recurse on tractor's producer
391 else if ( strcmp( resource, "<tractor>" ) == 0 )
393 serialise_tractor( context, service, node );
398 // Tell about a filter
399 else if ( strcmp( mlt_type, "filter" ) == 0 )
401 serialise_filter( context, service, node );
405 // Tell about a transition
406 else if ( strcmp( mlt_type, "transition" ) == 0 )
408 serialise_transition( context, service, node );
412 // Get the next connected service
413 service = mlt_service_producer( service );
417 xmlDocPtr westley_make_doc( mlt_service service )
419 xmlDocPtr doc = xmlNewDoc( "1.0" );
420 xmlNodePtr root = xmlNewNode( NULL, "westley" );
421 struct serialise_context_s *context = calloc( 1, sizeof( struct serialise_context_s ) );
423 xmlDocSetRootElement( doc, root );
425 // Construct the context maps
426 context->producer_map = mlt_properties_new();
427 context->hide_map = mlt_properties_new();
429 // Ensure producer is a framework producer
430 mlt_properties_set( mlt_service_properties( service ), "mlt_type", "mlt_producer" );
432 // In pass one, we serialise the end producers and playlists,
433 // adding them to a map keyed by address.
434 serialise_service( context, service, root );
436 // In pass two, we serialise the tractor and reference the
437 // producers and playlists
439 serialise_service( context, service, root );
442 mlt_properties_close( context->producer_map );
443 mlt_properties_close( context->hide_map );
450 static int consumer_start( mlt_consumer this )
452 xmlDocPtr doc = NULL;
454 // Get the producer service
455 mlt_service service = mlt_service_producer( mlt_consumer_service( this ) );
456 if ( service != NULL )
458 doc = westley_make_doc( service );
460 if ( mlt_properties_get( mlt_consumer_properties( this ), "resource" ) == NULL )
461 xmlDocFormatDump( stdout, doc, 1 );
463 xmlSaveFormatFile( mlt_properties_get( mlt_consumer_properties( this ), "resource" ), doc, 1 );
468 mlt_consumer_stop( this );
473 static int consumer_is_stopped( mlt_consumer this )