projects / melted / blob
? search:


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