projects / melted / blob
? search:


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