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
);
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
&& strcmp( mlt_properties_get( mlt_producer_properties( info
.producer
), "mlt_service" ), "blank" ) != 0 )
207 serialise_service( context
, MLT_SERVICE( info
.producer
), node
);
212 child
= xmlNewChild( node
, NULL
, "playlist", NULL
);
215 if ( mlt_properties_get( properties
, "id" ) == NULL
)
217 snprintf( id
, ID_SIZE
, "playlist%d", context
->playlist_count
++ );
218 xmlNewProp( child
, "id", id
);
221 strncpy( id
, mlt_properties_get( properties
, "id" ), ID_SIZE
);
223 // Add producer to the map
224 snprintf( key
, 10, "%p", service
);
225 mlt_properties_set( context
->producer_map
, key
, id
);
226 mlt_properties_set_int( context
->hide_map
, key
, mlt_properties_get_int( properties
, "hide" ) );
228 // Iterate over the playlist entries
229 for ( i
= 0; i
< mlt_playlist_count( MLT_PLAYLIST( service
) ); i
++ )
231 if ( ! mlt_playlist_get_clip_info( MLT_PLAYLIST( service
), &info
, i
) )
233 if ( strcmp( mlt_properties_get( mlt_producer_properties( info
.producer
), "mlt_service" ), "blank" ) == 0 )
237 xmlNode
*entry
= xmlNewChild( child
, NULL
, "blank", NULL
);
238 snprintf( length
, 19, "%d", info
.frame_count
);
239 xmlNewProp( entry
, "length", length
);
243 xmlNode
*entry
= xmlNewChild( child
, NULL
, "entry", NULL
);
244 snprintf( key
, 10, "%p", MLT_SERVICE( info
.producer
) );
245 xmlNewProp( entry
, "producer", mlt_properties_get( context
->producer_map
, key
) );
246 xmlNewProp( entry
, "in", mlt_properties_get( mlt_producer_properties( info
.producer
), "in" ) );
247 xmlNewProp( entry
, "out", mlt_properties_get( mlt_producer_properties( info
.producer
), "out" ) );
252 else if ( strcmp( (const char*) node
->name
, "tractor" ) != 0 )
254 snprintf( key
, 10, "%p", service
);
255 xmlNewProp( node
, "producer", mlt_properties_get( context
->producer_map
, key
) );
259 static void serialise_tractor( serialise_context context
, mlt_service service
, xmlNode
*node
)
261 xmlNode
*child
= node
;
262 char id
[ ID_SIZE
+ 1 ];
263 mlt_properties properties
= mlt_service_properties( service
);
265 id
[ ID_SIZE
] = '\0';
267 if ( context
->pass
== 0 )
269 // Recurse on connected producer
270 serialise_service( context
, mlt_service_get_producer( service
), node
);
274 child
= xmlNewChild( node
, NULL
, "tractor", NULL
);
277 if ( mlt_properties_get( properties
, "id" ) == NULL
)
279 snprintf( id
, ID_SIZE
, "tractor%d", context
->tractor_count
++ );
280 xmlNewProp( child
, "id", id
);
283 xmlNewProp( child
, "in", mlt_properties_get( properties
, "in" ) );
284 xmlNewProp( child
, "out", mlt_properties_get( properties
, "out" ) );
286 // Recurse on connected producer
287 serialise_service( context
, mlt_service_get_producer( service
), child
);
291 static void serialise_filter( serialise_context context
, mlt_service service
, xmlNode
*node
)
293 xmlNode
*child
= node
;
294 char id
[ ID_SIZE
+ 1 ];
295 mlt_properties properties
= mlt_service_properties( service
);
297 id
[ ID_SIZE
] = '\0';
299 // Recurse on connected producer
300 serialise_service( context
, MLT_SERVICE( MLT_FILTER( service
)->producer
), node
);
302 if ( context
->pass
== 1 )
304 child
= xmlNewChild( node
, NULL
, "filter", NULL
);
307 if ( mlt_properties_get( properties
, "id" ) == NULL
)
309 snprintf( id
, ID_SIZE
, "filter%d", context
->filter_count
++ );
310 xmlNewProp( child
, "id", id
);
311 xmlNewProp( child
, "in", mlt_properties_get( properties
, "in" ) );
312 xmlNewProp( child
, "out", mlt_properties_get( properties
, "out" ) );
315 serialise_properties( properties
, child
);
319 static void serialise_transition( serialise_context context
, mlt_service service
, xmlNode
*node
)
321 xmlNode
*child
= node
;
322 char id
[ ID_SIZE
+ 1 ];
323 mlt_properties properties
= mlt_service_properties( service
);
325 id
[ ID_SIZE
] = '\0';
327 // Recurse on connected producer
328 serialise_service( context
, MLT_SERVICE( MLT_TRANSITION( service
)->producer
), node
);
330 if ( context
->pass
== 1 )
332 child
= xmlNewChild( node
, NULL
, "transition", NULL
);
335 if ( mlt_properties_get( properties
, "id" ) == NULL
)
337 snprintf( id
, ID_SIZE
, "transition%d", context
->transition_count
++ );
338 xmlNewProp( child
, "id", id
);
339 xmlNewProp( child
, "in", mlt_properties_get( properties
, "in" ) );
340 xmlNewProp( child
, "out", mlt_properties_get( properties
, "out" ) );
343 serialise_properties( properties
, child
);
347 static void serialise_service( serialise_context context
, mlt_service service
, xmlNode
*node
)
349 // Iterate over consumer/producer connections
350 while ( service
!= NULL
)
352 mlt_properties properties
= mlt_service_properties( service
);
353 char *mlt_type
= mlt_properties_get( properties
, "mlt_type" );
355 // Tell about the producer
356 if ( strcmp( mlt_type
, "producer" ) == 0 )
358 serialise_producer( context
, service
, node
);
359 if ( mlt_properties_get( properties
, "westley" ) != NULL
)
363 // Tell about the framework container producers
364 else if ( strcmp( mlt_type
, "mlt_producer" ) == 0 )
366 char *resource
= mlt_properties_get( properties
, "resource" );
368 // Recurse on multitrack's tracks
369 if ( strcmp( resource
, "<multitrack>" ) == 0 )
371 serialise_multitrack( context
, service
, node
);
375 // Recurse on playlist's clips
376 else if ( strcmp( resource
, "<playlist>" ) == 0 )
378 serialise_playlist( context
, service
, node
);
381 // Recurse on tractor's producer
382 else if ( strcmp( resource
, "<tractor>" ) == 0 )
384 serialise_tractor( context
, service
, node
);
389 // Tell about a filter
390 else if ( strcmp( mlt_type
, "filter" ) == 0 )
392 serialise_filter( context
, service
, node
);
396 // Tell about a transition
397 else if ( strcmp( mlt_type
, "transition" ) == 0 )
399 serialise_transition( context
, service
, node
);
403 // Get the next connected service
404 service
= mlt_service_get_producer( service
);
408 static int consumer_start( mlt_consumer
this )
410 mlt_service inigo
= NULL
;
411 xmlDoc
*doc
= xmlNewDoc( "1.0" );
412 xmlNode
*root
= xmlNewNode( NULL
, "westley" );
413 xmlDocSetRootElement( doc
, root
);
415 // Get the producer service
416 mlt_service service
= mlt_service_get_producer( mlt_consumer_service( this ) );
417 if ( service
!= NULL
)
419 struct serialise_context_s
*context
= calloc( 1, sizeof( struct serialise_context_s
) );
421 // Construct the context maps
422 context
->producer_map
= mlt_properties_new();
423 context
->hide_map
= mlt_properties_new();
426 if ( mlt_properties_get( mlt_service_properties( service
), "mlt_service" ) != NULL
&&
427 strcmp( mlt_properties_get( mlt_service_properties( service
), "mlt_service" ), "inigo" ) == 0 )
430 // Ensure producer is a framework producer
431 mlt_properties_set( mlt_service_properties( service
), "mlt_type", "mlt_producer" );
433 // In pass one, we serialise the end producers and playlists,
434 // adding them to a map keyed by address.
435 serialise_service( context
, service
, root
);
437 // In pass two, we serialise the tractor and reference the
438 // producers and playlists
440 serialise_service( context
, service
, root
);
443 mlt_properties_close( context
->producer_map
);
444 mlt_properties_close( context
->hide_map
);
447 if ( mlt_properties_get( mlt_consumer_properties( this ), "resource" ) == NULL
)
448 xmlDocFormatDump( stdout
, doc
, 1 );
450 xmlSaveFormatFile( mlt_properties_get( mlt_consumer_properties( this ), "resource" ), doc
, 1 );
454 mlt_consumer_stop( this );
459 static int consumer_is_stopped( mlt_consumer
this )