projects / melted / blob
? search:


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