fix for in/out during serialisation
[melted] / src / modules / westley / consumer_westley.c
1 /*
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>
5 *
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.
10 *
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.
15 *
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.
19 */
20
21 #include "consumer_westley.h"
22 #include <framework/mlt.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <pthread.h>
27 #include <unistd.h>
28 #include <libxml/tree.h>
29
30 #define ID_SIZE 128
31
32 // This maintains counters for adding ids to elements
33 struct serialise_context_s
34 {
35 mlt_properties id_map;
36 int producer_count;
37 int multitrack_count;
38 int playlist_count;
39 int tractor_count;
40 int filter_count;
41 int transition_count;
42 int pass;
43 mlt_properties hide_map;
44 char *root;
45 };
46 typedef struct serialise_context_s* serialise_context;
47
48 /** Forward references to static functions.
49 */
50
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 );
54
55 typedef enum
56 {
57 westley_existing,
58 westley_producer,
59 westley_multitrack,
60 westley_playlist,
61 westley_tractor,
62 westley_filter,
63 westley_transition
64 }
65 westley_type;
66
67 /** Create or retrieve an id associated to this service.
68 */
69
70 static char *westley_get_id( serialise_context context, mlt_service service, westley_type type )
71 {
72 char *id = NULL;
73 int i = 0;
74 mlt_properties map = context->id_map;
75
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 )
79 break;
80
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 )
83 {
84 // Attempt to reuse existing id
85 id = mlt_properties_get( mlt_service_properties( service ), "id" );
86
87 // If no id, or the id is used in the map (for another service), then
88 // create a new one.
89 if ( id == NULL || mlt_properties_get_data( map, id, NULL ) != NULL )
90 {
91 char temp[ ID_SIZE ];
92 do
93 {
94 switch( type )
95 {
96 case westley_producer:
97 sprintf( temp, "producer%d", context->producer_count ++ );
98 break;
99 case westley_multitrack:
100 sprintf( temp, "multitrack%d", context->multitrack_count ++ );
101 break;
102 case westley_playlist:
103 sprintf( temp, "playlist%d", context->playlist_count ++ );
104 break;
105 case westley_tractor:
106 sprintf( temp, "tractor%d", context->tractor_count ++ );
107 break;
108 case westley_filter:
109 sprintf( temp, "filter%d", context->filter_count ++ );
110 break;
111 case westley_transition:
112 sprintf( temp, "transition%d", context->transition_count ++ );
113 break;
114 case westley_existing:
115 // Never gets here
116 break;
117 }
118 }
119 while( mlt_properties_get_data( map, temp, NULL ) != NULL );
120
121 // Set the data at the generated name
122 mlt_properties_set_data( map, temp, service, 0, NULL, NULL );
123
124 // Get the pointer to the name (i is the end of the list)
125 id = mlt_properties_get_name( map, i );
126 }
127 else
128 {
129 // Store the existing id in the map
130 mlt_properties_set_data( map, id, service, 0, NULL, NULL );
131 }
132 }
133 else if ( type == westley_existing )
134 {
135 id = mlt_properties_get_name( map, i );
136 }
137
138 return id;
139 }
140
141 /** This is what will be called by the factory - anything can be passed in
142 via the argument, but keep it simple.
143 */
144
145 mlt_consumer consumer_westley_init( char *arg )
146 {
147 // Create the consumer object
148 mlt_consumer this = calloc( sizeof( struct mlt_consumer_s ), 1 );
149
150 // If no malloc'd and consumer init ok
151 if ( this != NULL && mlt_consumer_init( this, NULL ) == 0 )
152 {
153 // Allow thread to be started/stopped
154 this->start = consumer_start;
155 this->is_stopped = consumer_is_stopped;
156
157 mlt_properties_set( mlt_consumer_properties( this ), "resource", arg );
158
159 // Return the consumer produced
160 return this;
161 }
162
163 // malloc or consumer init failed
164 free( this );
165
166 // Indicate failure
167 return NULL;
168 }
169
170 static inline void serialise_properties( serialise_context context, mlt_properties properties, xmlNode *node )
171 {
172 int i;
173 xmlNode *p;
174
175 // Enumerate the properties
176 for ( i = 0; i < mlt_properties_count( properties ); i++ )
177 {
178 char *name = mlt_properties_get_name( properties, i );
179 if ( name != NULL &&
180 name[ 0 ] != '_' &&
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 )
189 {
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 );
195 else
196 xmlNodeSetContent( p, value );
197 }
198 }
199 }
200
201 static inline void serialise_service_filters( serialise_context context, mlt_service service, xmlNode *node )
202 {
203 int i;
204 xmlNode *p;
205 mlt_filter filter = NULL;
206
207 // Enumerate the filters
208 for ( i = 0; ( filter = mlt_producer_filter( MLT_PRODUCER( service ), i ) ) != NULL; i ++ )
209 {
210 mlt_properties properties = mlt_filter_properties( filter );
211 if ( mlt_properties_get_int( properties, "_fezzik" ) == 0 )
212 {
213 // Get a new id - if already allocated, do nothing
214 char *id = westley_get_id( context, mlt_filter_service( filter ), westley_filter );
215 if ( id != NULL )
216 {
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 )
222 {
223 char temp[ 20 ];
224 sprintf( temp, "%d", in );
225 xmlNewProp( p, "in", temp );
226 sprintf( temp, "%d", out );
227 xmlNewProp( p, "out", temp );
228 }
229 serialise_properties( context, properties, p );
230 serialise_service_filters( context, mlt_filter_service( filter ), p );
231 }
232 }
233 }
234 }
235
236 static void serialise_producer( serialise_context context, mlt_service service, xmlNode *node )
237 {
238 xmlNode *child = node;
239 mlt_properties properties = mlt_service_properties( service );
240
241 if ( context->pass == 0 )
242 {
243 // Get a new id - if already allocated, do nothing
244 char *id = westley_get_id( context, service, westley_producer );
245 if ( id == NULL )
246 return;
247
248 child = xmlNewChild( node, NULL, "producer", NULL );
249
250 // Set the id
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 );
256
257 // Add producer to the map
258 mlt_properties_set_int( context->hide_map, id, mlt_properties_get_int( properties, "hide" ) );
259 }
260 else
261 {
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 );
265 }
266 }
267
268 static void serialise_multitrack( serialise_context context, mlt_service service, xmlNode *node )
269 {
270 int i;
271
272 if ( context->pass == 0 )
273 {
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 );
277 }
278 else
279 {
280 // Get a new id - if already allocated, do nothing
281 char *id = westley_get_id( context, service, westley_multitrack );
282 if ( id == NULL )
283 return;
284
285 // Serialise the tracks
286 for ( i = 0; i < mlt_multitrack_count( MLT_MULTITRACK( service ) ); i++ )
287 {
288 xmlNode *track = xmlNewChild( node, NULL, "track", NULL );
289 int hide = 0;
290 mlt_producer producer = mlt_multitrack_track( MLT_MULTITRACK( service ), i );
291
292 char *id = westley_get_id( context, MLT_SERVICE( producer ), westley_existing );
293 xmlNewProp( track, "producer", id );
294
295 hide = mlt_properties_get_int( context->hide_map, id );
296 if ( hide )
297 xmlNewProp( track, "hide", hide == 1 ? "video" : ( hide == 2 ? "audio" : "both" ) );
298 }
299 serialise_service_filters( context, service, node );
300 }
301 }
302
303 static void serialise_tractor( serialise_context context, mlt_service service, xmlNode *node );
304
305 static void serialise_playlist( serialise_context context, mlt_service service, xmlNode *node )
306 {
307 int i;
308 xmlNode *child = node;
309 mlt_playlist_clip_info info;
310 mlt_properties properties = mlt_service_properties( service );
311
312 if ( context->pass == 0 )
313 {
314 // Get a new id - if already allocated, do nothing
315 char *id = westley_get_id( context, service, westley_playlist );
316 if ( id == NULL )
317 return;
318
319 // Iterate over the playlist entries to collect the producers
320 for ( i = 0; i < mlt_playlist_count( MLT_PLAYLIST( service ) ); i++ )
321 {
322 if ( ! mlt_playlist_get_clip_info( MLT_PLAYLIST( service ), &info, i ) )
323 {
324 if ( info.producer != NULL )
325 {
326 char *service_s = mlt_properties_get( mlt_producer_properties( info.producer ), "mlt_service" );
327 char *resource_s = mlt_properties_get( mlt_producer_properties( info.producer ), "resource" );
328 if ( resource_s != NULL && !strcmp( resource_s, "<tractor>" ) )
329 {
330 serialise_tractor( context, MLT_SERVICE( info.producer ), node );
331 context->pass ++;
332 serialise_tractor( context, MLT_SERVICE( info.producer ), node );
333 context->pass --;
334 }
335 else if ( service_s != NULL && strcmp( service_s, "blank" ) != 0 )
336 serialise_service( context, MLT_SERVICE( info.producer ), node );
337 else if ( resource_s != NULL && !strcmp( resource_s, "<playlist>" ) )
338 serialise_playlist( context, MLT_SERVICE( info.producer ), node );
339 }
340 }
341 }
342
343 child = xmlNewChild( node, NULL, "playlist", NULL );
344
345 // Set the id
346 xmlNewProp( child, "id", id );
347
348 // Add producer to the map
349 mlt_properties_set_int( context->hide_map, id, mlt_properties_get_int( properties, "hide" ) );
350
351 // Iterate over the playlist entries
352 for ( i = 0; i < mlt_playlist_count( MLT_PLAYLIST( service ) ); i++ )
353 {
354 if ( ! mlt_playlist_get_clip_info( MLT_PLAYLIST( service ), &info, i ) )
355 {
356 char *service_s = mlt_properties_get( mlt_producer_properties( info.producer ), "mlt_service" );
357 if ( service_s != NULL && strcmp( service_s, "blank" ) == 0 )
358 {
359 char length[ 20 ];
360 length[ 19 ] = '\0';
361 xmlNode *entry = xmlNewChild( child, NULL, "blank", NULL );
362 snprintf( length, 19, "%d", info.frame_count );
363 xmlNewProp( entry, "length", length );
364 }
365 else
366 {
367 char temp[ 20 ];
368 xmlNode *entry = xmlNewChild( child, NULL, "entry", NULL );
369 id = westley_get_id( context, MLT_SERVICE( info.producer ), westley_existing );
370 xmlNewProp( entry, "producer", id );
371 sprintf( temp, "%d", info.frame_in );
372 xmlNewProp( entry, "in", temp );
373 sprintf( temp, "%d", info.frame_out );
374 xmlNewProp( entry, "out", temp );
375 }
376 }
377 }
378
379 serialise_service_filters( context, service, child );
380 }
381 else if ( strcmp( (const char*) node->name, "tractor" ) != 0 )
382 {
383 char *id = westley_get_id( context, service, westley_existing );
384 xmlNewProp( node, "producer", id );
385 }
386 }
387
388 static void serialise_tractor( serialise_context context, mlt_service service, xmlNode *node )
389 {
390 xmlNode *child = node;
391 mlt_properties properties = mlt_service_properties( service );
392
393 if ( context->pass == 0 )
394 {
395 // Recurse on connected producer
396 serialise_service( context, mlt_service_producer( service ), node );
397 }
398 else
399 {
400 // Get a new id - if already allocated, do nothing
401 char *id = westley_get_id( context, service, westley_tractor );
402 if ( id == NULL )
403 return;
404
405 child = xmlNewChild( node, NULL, "tractor", NULL );
406
407 // Set the id
408 xmlNewProp( child, "id", id );
409 xmlNewProp( child, "in", mlt_properties_get( properties, "in" ) );
410 xmlNewProp( child, "out", mlt_properties_get( properties, "out" ) );
411
412 // Recurse on connected producer
413 serialise_service( context, mlt_service_producer( service ), child );
414 serialise_service_filters( context, service, child );
415 }
416 }
417
418 static void serialise_filter( serialise_context context, mlt_service service, xmlNode *node )
419 {
420 xmlNode *child = node;
421 mlt_properties properties = mlt_service_properties( service );
422
423 // Recurse on connected producer
424 serialise_service( context, mlt_service_producer( service ), node );
425
426 if ( context->pass == 1 )
427 {
428 // Get a new id - if already allocated, do nothing
429 char *id = westley_get_id( context, service, westley_filter );
430 if ( id == NULL )
431 return;
432
433 child = xmlNewChild( node, NULL, "filter", NULL );
434
435 // Set the id
436 xmlNewProp( child, "id", id );
437 xmlNewProp( child, "in", mlt_properties_get( properties, "in" ) );
438 xmlNewProp( child, "out", mlt_properties_get( properties, "out" ) );
439
440 serialise_properties( context, properties, child );
441 serialise_service_filters( context, service, child );
442 }
443 }
444
445 static void serialise_transition( serialise_context context, mlt_service service, xmlNode *node )
446 {
447 xmlNode *child = node;
448 mlt_properties properties = mlt_service_properties( service );
449
450 // Recurse on connected producer
451 serialise_service( context, MLT_SERVICE( MLT_TRANSITION( service )->producer ), node );
452
453 if ( context->pass == 1 )
454 {
455 // Get a new id - if already allocated, do nothing
456 char *id = westley_get_id( context, service, westley_transition );
457 if ( id == NULL )
458 return;
459
460 child = xmlNewChild( node, NULL, "transition", NULL );
461
462 // Set the id
463 xmlNewProp( child, "id", id );
464 xmlNewProp( child, "in", mlt_properties_get( properties, "in" ) );
465 xmlNewProp( child, "out", mlt_properties_get( properties, "out" ) );
466
467 serialise_properties( context, properties, child );
468 serialise_service_filters( context, service, child );
469 }
470 }
471
472 static void serialise_service( serialise_context context, mlt_service service, xmlNode *node )
473 {
474 // Iterate over consumer/producer connections
475 while ( service != NULL )
476 {
477 mlt_properties properties = mlt_service_properties( service );
478 char *mlt_type = mlt_properties_get( properties, "mlt_type" );
479
480 // Tell about the producer
481 if ( strcmp( mlt_type, "producer" ) == 0 )
482 {
483 serialise_producer( context, service, node );
484 if ( mlt_properties_get( properties, "westley" ) != NULL )
485 break;
486 }
487
488 // Tell about the framework container producers
489 else if ( strcmp( mlt_type, "mlt_producer" ) == 0 )
490 {
491 char *resource = mlt_properties_get( properties, "resource" );
492
493 // Recurse on multitrack's tracks
494 if ( strcmp( resource, "<multitrack>" ) == 0 )
495 {
496 serialise_multitrack( context, service, node );
497 break;
498 }
499
500 // Recurse on playlist's clips
501 else if ( strcmp( resource, "<playlist>" ) == 0 )
502 {
503 serialise_playlist( context, service, node );
504 }
505
506 // Recurse on tractor's producer
507 else if ( strcmp( resource, "<tractor>" ) == 0 )
508 {
509 serialise_tractor( context, service, node );
510 break;
511 }
512
513 // Treat it as a normal producer
514 else
515 {
516 serialise_producer( context, service, node );
517 }
518 }
519
520 // Tell about a filter
521 else if ( strcmp( mlt_type, "filter" ) == 0 )
522 {
523 serialise_filter( context, service, node );
524 break;
525 }
526
527 // Tell about a transition
528 else if ( strcmp( mlt_type, "transition" ) == 0 )
529 {
530 serialise_transition( context, service, node );
531 break;
532 }
533
534 // Get the next connected service
535 service = mlt_service_producer( service );
536 }
537 }
538
539 xmlDocPtr westley_make_doc( mlt_service service )
540 {
541 mlt_properties properties = mlt_service_properties( service );
542 xmlDocPtr doc = xmlNewDoc( "1.0" );
543 xmlNodePtr root = xmlNewNode( NULL, "westley" );
544 struct serialise_context_s *context = calloc( 1, sizeof( struct serialise_context_s ) );
545
546 xmlDocSetRootElement( doc, root );
547
548 // If we have root, then deal with it now
549 if ( mlt_properties_get( properties, "root" ) != NULL )
550 {
551 xmlNewProp( root, "root", mlt_properties_get( properties, "root" ) );
552 context->root = strdup( mlt_properties_get( properties, "root" ) );
553 }
554 else
555 {
556 context->root = strdup( "" );
557 }
558
559 // Assign a title property
560 if ( mlt_properties_get( properties, "title" ) != NULL )
561 xmlNewProp( root, "title", mlt_properties_get( properties, "title" ) );
562
563 // Construct the context maps
564 context->id_map = mlt_properties_new();
565 context->hide_map = mlt_properties_new();
566
567 // Ensure producer is a framework producer
568 mlt_properties_set( mlt_service_properties( service ), "mlt_type", "mlt_producer" );
569
570 // In pass one, we serialise the end producers and playlists,
571 // adding them to a map keyed by address.
572 serialise_service( context, service, root );
573
574 // In pass two, we serialise the tractor and reference the
575 // producers and playlists
576 context->pass++;
577 serialise_service( context, service, root );
578
579 // Cleanup resource
580 mlt_properties_close( context->id_map );
581 mlt_properties_close( context->hide_map );
582 free( context->root );
583 free( context );
584
585 return doc;
586 }
587
588 static int consumer_start( mlt_consumer this )
589 {
590 xmlDocPtr doc = NULL;
591
592 // Get the producer service
593 mlt_service service = mlt_service_producer( mlt_consumer_service( this ) );
594 if ( service != NULL )
595 {
596 mlt_properties properties = mlt_consumer_properties( this );
597 char *resource = mlt_properties_get( properties, "resource" );
598
599 // Set the title if provided
600 if ( mlt_properties_get( properties, "title" ) )
601 mlt_properties_set( mlt_service_properties( service ), "title", mlt_properties_get( properties, "title" ) );
602 else if ( mlt_properties_get( mlt_service_properties( service ), "title" ) == NULL )
603 mlt_properties_set( mlt_service_properties( service ), "title", "Anonymous Submission" );
604
605 // Check for a root on the consumer properties and pass to service
606 if ( mlt_properties_get( properties, "root" ) )
607 mlt_properties_set( mlt_service_properties( service ), "root", mlt_properties_get( properties, "root" ) );
608
609 // Specify roots in other cases...
610 if ( resource != NULL && mlt_properties_get( properties, "root" ) == NULL )
611 {
612 // Get the current working directory
613 char *cwd = getcwd( NULL, 0 );
614 mlt_properties_set( mlt_service_properties( service ), "root", cwd );
615 free( cwd );
616 }
617
618 // Make the document
619 doc = westley_make_doc( service );
620
621 // Handle the output
622 if ( resource == NULL || !strcmp( resource, "" ) )
623 {
624 xmlDocFormatDump( stdout, doc, 1 );
625 }
626 else if ( !strcmp( resource, "buffer" ) )
627 {
628 xmlChar *buffer = NULL;
629 int length = 0;
630 xmlDocDumpMemory( doc, &buffer, &length );
631 mlt_properties_set_data( properties, "buffer", buffer, length, xmlFree, NULL );
632 }
633 else
634 {
635 xmlSaveFormatFile( resource, doc, 1 );
636 }
637
638 // Close the document
639 xmlFreeDoc( doc );
640 }
641
642 mlt_consumer_stop( this );
643
644 mlt_consumer_stopped( this );
645
646 return 0;
647 }
648
649 static int consumer_is_stopped( mlt_consumer this )
650 {
651 return 1;
652 }