projects / melted / blob
? search:


63e320e5b7342bf3f282bae8c3003042d2fef6d6
[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_service parent = MLT_SERVICE( mlt_producer_cut_parent( MLT_PRODUCER( service ) ) );
240
241 if ( context->pass == 0 )
242 {
243 mlt_properties properties = mlt_service_properties( parent );
244 // Get a new id - if already allocated, do nothing
245 char *id = westley_get_id( context, parent, westley_producer );
246 if ( id == NULL )
247 return;
248
249 child = xmlNewChild( node, NULL, "producer", NULL );
250
251 // Set the id
252 xmlNewProp( child, "id", id );
253 xmlNewProp( child, "in", mlt_properties_get( properties, "in" ) );
254 xmlNewProp( child, "out", mlt_properties_get( properties, "out" ) );
255 serialise_properties( context, properties, child );
256 serialise_service_filters( context, service, child );
257
258 // Add producer to the map
259 mlt_properties_set_int( context->hide_map, id, mlt_properties_get_int( properties, "hide" ) );
260 }
261 else
262 {
263 char *id = westley_get_id( context, parent, westley_existing );
264 mlt_properties properties = mlt_service_properties( service );
265 xmlNewProp( node, "parent", id );
266 xmlNewProp( node, "in", mlt_properties_get( properties, "in" ) );
267 xmlNewProp( node, "out", mlt_properties_get( properties, "out" ) );
268 }
269 }
270
271 static void serialise_tractor( serialise_context context, mlt_service service, xmlNode *node );
272
273 static void serialise_multitrack( serialise_context context, mlt_service service, xmlNode *node )
274 {
275 int i;
276
277 if ( context->pass == 0 )
278 {
279 // Iterate over the tracks to collect the producers
280 for ( i = 0; i < mlt_multitrack_count( MLT_MULTITRACK( service ) ); i++ )
281 {
282 mlt_producer producer = mlt_producer_cut_parent( mlt_multitrack_track( MLT_MULTITRACK( service ), i ) );
283 serialise_service( context, MLT_SERVICE( producer ), node );
284 }
285 }
286 else
287 {
288 // Get a new id - if already allocated, do nothing
289 char *id = westley_get_id( context, service, westley_multitrack );
290 if ( id == NULL )
291 return;
292
293 // Serialise the tracks
294 for ( i = 0; i < mlt_multitrack_count( MLT_MULTITRACK( service ) ); i++ )
295 {
296 xmlNode *track = xmlNewChild( node, NULL, "track", NULL );
297 int hide = 0;
298 mlt_producer producer = mlt_multitrack_track( MLT_MULTITRACK( service ), i );
299 mlt_properties properties = mlt_producer_properties( producer );
300
301 mlt_service parent = MLT_SERVICE( mlt_producer_cut_parent( producer ) );
302
303 char *id = westley_get_id( context, MLT_SERVICE( parent ), westley_existing );
304 xmlNewProp( track, "producer", id );
305 if ( mlt_properties_get_int( properties, "_cut" ) == 1 )
306 {
307 xmlNewProp( track, "in", mlt_properties_get( properties, "in" ) );
308 xmlNewProp( track, "out", mlt_properties_get( properties, "out" ) );
309 }
310
311 hide = mlt_properties_get_int( context->hide_map, id );
312 if ( hide )
313 xmlNewProp( track, "hide", hide == 1 ? "video" : ( hide == 2 ? "audio" : "both" ) );
314 }
315 serialise_service_filters( context, service, node );
316 }
317 }
318
319 static void serialise_playlist( serialise_context context, mlt_service service, xmlNode *node )
320 {
321 int i;
322 xmlNode *child = node;
323 mlt_playlist_clip_info info;
324 mlt_properties properties = mlt_service_properties( service );
325
326 if ( context->pass == 0 )
327 {
328 // Get a new id - if already allocated, do nothing
329 char *id = westley_get_id( context, service, westley_playlist );
330 if ( id == NULL )
331 return;
332
333 // Iterate over the playlist entries to collect the producers
334 for ( i = 0; i < mlt_playlist_count( MLT_PLAYLIST( service ) ); i++ )
335 {
336 if ( ! mlt_playlist_get_clip_info( MLT_PLAYLIST( service ), &info, i ) )
337 {
338 if ( info.producer != NULL )
339 {
340 mlt_producer producer = mlt_producer_cut_parent( info.producer );
341 char *service_s = mlt_properties_get( mlt_producer_properties( producer ), "mlt_service" );
342 char *resource_s = mlt_properties_get( mlt_producer_properties( producer ), "resource" );
343 if ( resource_s != NULL && !strcmp( resource_s, "<playlist>" ) )
344 serialise_playlist( context, MLT_SERVICE( producer ), node );
345 else if ( service_s != NULL && strcmp( service_s, "blank" ) != 0 )
346 serialise_service( context, MLT_SERVICE( producer ), node );
347 }
348 }
349 }
350
351 child = xmlNewChild( node, NULL, "playlist", NULL );
352
353 // Set the id
354 xmlNewProp( child, "id", id );
355
356 // Add producer to the map
357 mlt_properties_set_int( context->hide_map, id, mlt_properties_get_int( properties, "hide" ) );
358
359 // Iterate over the playlist entries
360 for ( i = 0; i < mlt_playlist_count( MLT_PLAYLIST( service ) ); i++ )
361 {
362 if ( ! mlt_playlist_get_clip_info( MLT_PLAYLIST( service ), &info, i ) )
363 {
364 mlt_producer producer = mlt_producer_cut_parent( info.producer );
365 char *service_s = mlt_properties_get( mlt_producer_properties( producer ), "mlt_service" );
366 if ( service_s != NULL && strcmp( service_s, "blank" ) == 0 )
367 {
368 char length[ 20 ];
369 length[ 19 ] = '\0';
370 xmlNode *entry = xmlNewChild( child, NULL, "blank", NULL );
371 snprintf( length, 19, "%d", info.frame_count );
372 xmlNewProp( entry, "length", length );
373 }
374 else
375 {
376 char temp[ 20 ];
377 xmlNode *entry = xmlNewChild( child, NULL, "entry", NULL );
378 id = westley_get_id( context, MLT_SERVICE( producer ), westley_existing );
379 xmlNewProp( entry, "producer", id );
380 sprintf( temp, "%d", info.frame_in );
381 xmlNewProp( entry, "in", temp );
382 sprintf( temp, "%d", info.frame_out );
383 xmlNewProp( entry, "out", temp );
384 if ( info.repeat > 1 )
385 {
386 sprintf( temp, "%d", info.repeat );
387 xmlNewProp( entry, "repeat", temp );
388 }
389 if ( mlt_producer_is_cut( info.cut ) )
390 serialise_service_filters( context, mlt_producer_service( info.cut ), entry );
391 }
392 }
393 }
394
395 serialise_service_filters( context, service, child );
396 }
397 else if ( strcmp( (const char*) node->name, "tractor" ) != 0 )
398 {
399 char *id = westley_get_id( context, service, westley_existing );
400 xmlNewProp( node, "producer", id );
401 }
402 }
403
404 static void serialise_tractor( serialise_context context, mlt_service service, xmlNode *node )
405 {
406 xmlNode *child = node;
407 mlt_properties properties = mlt_service_properties( service );
408
409 if ( context->pass == 0 )
410 {
411 // Recurse on connected producer
412 serialise_service( context, mlt_service_producer( service ), node );
413 }
414 else
415 {
416 // Get a new id - if already allocated, do nothing
417 char *id = westley_get_id( context, service, westley_tractor );
418 if ( id == NULL )
419 return;
420
421 child = xmlNewChild( node, NULL, "tractor", NULL );
422
423 // Set the id
424 xmlNewProp( child, "id", id );
425 xmlNewProp( child, "in", mlt_properties_get( properties, "in" ) );
426 xmlNewProp( child, "out", mlt_properties_get( properties, "out" ) );
427
428 // Recurse on connected producer
429 serialise_service( context, mlt_service_producer( service ), child );
430 serialise_service_filters( context, service, child );
431 }
432 }
433
434 static void serialise_filter( serialise_context context, mlt_service service, xmlNode *node )
435 {
436 xmlNode *child = node;
437 mlt_properties properties = mlt_service_properties( service );
438
439 // Recurse on connected producer
440 serialise_service( context, mlt_service_producer( service ), node );
441
442 if ( context->pass == 1 )
443 {
444 // Get a new id - if already allocated, do nothing
445 char *id = westley_get_id( context, service, westley_filter );
446 if ( id == NULL )
447 return;
448
449 child = xmlNewChild( node, NULL, "filter", NULL );
450
451 // Set the id
452 xmlNewProp( child, "id", id );
453 xmlNewProp( child, "in", mlt_properties_get( properties, "in" ) );
454 xmlNewProp( child, "out", mlt_properties_get( properties, "out" ) );
455
456 serialise_properties( context, properties, child );
457 serialise_service_filters( context, service, child );
458 }
459 }
460
461 static void serialise_transition( serialise_context context, mlt_service service, xmlNode *node )
462 {
463 xmlNode *child = node;
464 mlt_properties properties = mlt_service_properties( service );
465
466 // Recurse on connected producer
467 serialise_service( context, MLT_SERVICE( MLT_TRANSITION( service )->producer ), node );
468
469 if ( context->pass == 1 )
470 {
471 // Get a new id - if already allocated, do nothing
472 char *id = westley_get_id( context, service, westley_transition );
473 if ( id == NULL )
474 return;
475
476 child = xmlNewChild( node, NULL, "transition", NULL );
477
478 // Set the id
479 xmlNewProp( child, "id", id );
480 xmlNewProp( child, "in", mlt_properties_get( properties, "in" ) );
481 xmlNewProp( child, "out", mlt_properties_get( properties, "out" ) );
482
483 serialise_properties( context, properties, child );
484 serialise_service_filters( context, service, child );
485 }
486 }
487
488 static void serialise_service( serialise_context context, mlt_service service, xmlNode *node )
489 {
490 // Iterate over consumer/producer connections
491 while ( service != NULL )
492 {
493 mlt_properties properties = mlt_service_properties( service );
494 char *mlt_type = mlt_properties_get( properties, "mlt_type" );
495
496 // Tell about the producer
497 if ( strcmp( mlt_type, "producer" ) == 0 )
498 {
499 char *mlt_service = mlt_properties_get( properties, "mlt_service" );
500 if ( mlt_properties_get( properties, "westley" ) == NULL && !strcmp( mlt_service, "tractor" ) )
501 {
502 context->pass = 0;
503 serialise_tractor( context, service, node );
504 context->pass = 1;
505 serialise_tractor( context, service, node );
506 context->pass = 0;
507 break;
508 }
509 else
510 {
511 serialise_producer( context, service, node );
512 }
513 if ( mlt_properties_get( properties, "westley" ) != NULL )
514 break;
515 }
516
517 // Tell about the framework container producers
518 else if ( strcmp( mlt_type, "mlt_producer" ) == 0 )
519 {
520 char *resource = mlt_properties_get( properties, "resource" );
521
522 // Recurse on multitrack's tracks
523 if ( strcmp( resource, "<multitrack>" ) == 0 )
524 {
525 serialise_multitrack( context, service, node );
526 break;
527 }
528
529 // Recurse on playlist's clips
530 else if ( strcmp( resource, "<playlist>" ) == 0 )
531 {
532 serialise_playlist( context, service, node );
533 }
534
535 // Recurse on tractor's producer
536 else if ( strcmp( resource, "<tractor>" ) == 0 )
537 {
538 context->pass = 0;
539 serialise_tractor( context, service, node );
540 context->pass = 1;
541 serialise_tractor( context, service, node );
542 context->pass = 0;
543 break;
544 }
545
546 // Treat it as a normal producer
547 else
548 {
549 serialise_producer( context, service, node );
550 }
551 }
552
553 // Tell about a filter
554 else if ( strcmp( mlt_type, "filter" ) == 0 )
555 {
556 serialise_filter( context, service, node );
557 break;
558 }
559
560 // Tell about a transition
561 else if ( strcmp( mlt_type, "transition" ) == 0 )
562 {
563 serialise_transition( context, service, node );
564 break;
565 }
566
567 // Get the next connected service
568 service = mlt_service_producer( service );
569 }
570 }
571
572 xmlDocPtr westley_make_doc( mlt_service service )
573 {
574 mlt_properties properties = mlt_service_properties( service );
575 xmlDocPtr doc = xmlNewDoc( "1.0" );
576 xmlNodePtr root = xmlNewNode( NULL, "westley" );
577 struct serialise_context_s *context = calloc( 1, sizeof( struct serialise_context_s ) );
578
579 xmlDocSetRootElement( doc, root );
580
581 // If we have root, then deal with it now
582 if ( mlt_properties_get( properties, "root" ) != NULL )
583 {
584 xmlNewProp( root, "root", mlt_properties_get( properties, "root" ) );
585 context->root = strdup( mlt_properties_get( properties, "root" ) );
586 }
587 else
588 {
589 context->root = strdup( "" );
590 }
591
592 // Assign a title property
593 if ( mlt_properties_get( properties, "title" ) != NULL )
594 xmlNewProp( root, "title", mlt_properties_get( properties, "title" ) );
595
596 // Construct the context maps
597 context->id_map = mlt_properties_new();
598 context->hide_map = mlt_properties_new();
599
600 // Ensure producer is a framework producer
601 mlt_properties_set( mlt_service_properties( service ), "mlt_type", "mlt_producer" );
602
603 // In pass one, we serialise the end producers and playlists,
604 // adding them to a map keyed by address.
605 serialise_service( context, service, root );
606
607 // In pass two, we serialise the tractor and reference the
608 // producers and playlists
609 context->pass++;
610 serialise_service( context, service, root );
611
612 // Cleanup resource
613 mlt_properties_close( context->id_map );
614 mlt_properties_close( context->hide_map );
615 free( context->root );
616 free( context );
617
618 return doc;
619 }
620
621 static int consumer_start( mlt_consumer this )
622 {
623 xmlDocPtr doc = NULL;
624
625 // Get the producer service
626 mlt_service service = mlt_service_producer( mlt_consumer_service( this ) );
627 if ( service != NULL )
628 {
629 mlt_properties properties = mlt_consumer_properties( this );
630 char *resource = mlt_properties_get( properties, "resource" );
631
632 // Set the title if provided
633 if ( mlt_properties_get( properties, "title" ) )
634 mlt_properties_set( mlt_service_properties( service ), "title", mlt_properties_get( properties, "title" ) );
635 else if ( mlt_properties_get( mlt_service_properties( service ), "title" ) == NULL )
636 mlt_properties_set( mlt_service_properties( service ), "title", "Anonymous Submission" );
637
638 // Check for a root on the consumer properties and pass to service
639 if ( mlt_properties_get( properties, "root" ) )
640 mlt_properties_set( mlt_service_properties( service ), "root", mlt_properties_get( properties, "root" ) );
641
642 // Specify roots in other cases...
643 if ( resource != NULL && mlt_properties_get( properties, "root" ) == NULL )
644 {
645 // Get the current working directory
646 char *cwd = getcwd( NULL, 0 );
647 mlt_properties_set( mlt_service_properties( service ), "root", cwd );
648 free( cwd );
649 }
650
651 // Make the document
652 doc = westley_make_doc( service );
653
654 // Handle the output
655 if ( resource == NULL || !strcmp( resource, "" ) )
656 {
657 xmlDocFormatDump( stdout, doc, 1 );
658 }
659 else if ( strchr( resource, '.' ) == NULL )
660 {
661 xmlChar *buffer = NULL;
662 int length = 0;
663 xmlDocDumpMemory( doc, &buffer, &length );
664 mlt_properties_set( properties, resource, buffer );
665 xmlFree( buffer );
666 }
667 else
668 {
669 xmlSaveFormatFile( resource, doc, 1 );
670 }
671
672 // Close the document
673 xmlFreeDoc( doc );
674 }
675
676 mlt_consumer_stop( this );
677
678 mlt_consumer_stopped( this );
679
680 return 0;
681 }
682
683 static int consumer_is_stopped( mlt_consumer this )
684 {
685 return 1;
686 }
my melted branch