research.m1stereo.tv/gitweb/ - melted/blob - 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 <libxml/tree.h>
  28
  29 #define ID_SIZE 128
  30
  31 // This maintains counters for adding ids to elements
  32 struct serialise_context_s
  33 {
  34         int producer_count;
  35         int multitrack_count;
  36         int playlist_count;
  37         int tractor_count;
  38         int filter_count;
  39         int transition_count;
  40         int pass;
  41         mlt_properties producer_map;
  42         mlt_properties hide_map;
  43 };
  44 typedef struct serialise_context_s* serialise_context;
  45
  46 /** Forward references to static functions.
  47 */
  48
  49 static int consumer_start( mlt_consumer parent );
  50 static int consumer_is_stopped( mlt_consumer this );
  51 static void serialise_service( serialise_context context, mlt_service service, xmlNode *node );
  52
  53 /** This is what will be called by the factory - anything can be passed in
  54         via the argument, but keep it simple.
  55 */
  56
  57 mlt_consumer consumer_westley_init( char *arg )
  58 {
  59         // Create the consumer object
  60         mlt_consumer this = calloc( sizeof( struct mlt_consumer_s ), 1 );
  61
  62         // If no malloc'd and consumer init ok
  63         if ( this != NULL && mlt_consumer_init( this, NULL ) == 0 )
  64         {
  65                 // Allow thread to be started/stopped
  66                 this->start = consumer_start;
  67                 this->is_stopped = consumer_is_stopped;
  68
  69                 mlt_properties_set( mlt_consumer_properties( this ), "resource", arg );
  70
  71                 // Return the consumer produced
  72                 return this;
  73         }
  74
  75         // malloc or consumer init failed
  76         free( this );
  77
  78         // Indicate failure
  79         return NULL;
  80 }
  81
  82 static inline void serialise_properties( mlt_properties properties, xmlNode *node )
  83 {
  84         int i;
  85         xmlNode *p;
  86
  87         // Enumerate the properties
  88         for ( i = 0; i < mlt_properties_count( properties ); i++ )
  89         {
  90                 char *name = mlt_properties_get_name( properties, i );
  91                 if ( name != NULL &&
  92                          name[ 0 ] != '_' &&
  93                          mlt_properties_get_value( properties, i ) != NULL &&
  94                          strcmp( name, "westley" ) != 0 &&
  95                          strcmp( name, "in" ) != 0 &&
  96                          strcmp( name, "out" ) != 0 )
  97                 {
  98                         p = xmlNewChild( node, NULL, "property", NULL );
  99                         xmlNewProp( p, "name", mlt_properties_get_name( properties, i ) );
 100                         xmlNodeSetContent( p, mlt_properties_get_value( properties, i ) );
 101                 }
 102         }
 103 }
 104
 105 static void serialise_producer( serialise_context context, mlt_service service, xmlNode *node )
 106 {
 107         xmlNode *child = node;
 108         char id[ ID_SIZE + 1 ];
 109         char key[ 11 ];
 110         mlt_properties properties = mlt_service_properties( service );
 111
 112         id[ ID_SIZE ] = '\0';
 113         key[ 10 ] = '\0';
 114
 115         if ( context->pass == 0 )
 116         {
 117                 child = xmlNewChild( node, NULL, "producer", NULL );
 118
 119                 // Set the id
 120                 if ( mlt_properties_get( properties, "id" ) == NULL )
 121                 {
 122                         snprintf( id, ID_SIZE, "producer%d", context->producer_count++ );
 123                         xmlNewProp( child, "id", id );
 124                 }
 125                 else
 126                         strncpy( id, mlt_properties_get( properties, "id" ), ID_SIZE );
 127                 serialise_properties( properties, child );
 128
 129                 // Add producer to the map
 130                 snprintf( key, 10, "%p", service );
 131                 mlt_properties_set( context->producer_map, key, id );
 132                 mlt_properties_set_int( context->hide_map, key, mlt_properties_get_int( properties, "hide" ) );
 133         }
 134         else
 135         {
 136                 snprintf( key, 10, "%p", service );
 137                 xmlNewProp( node, "producer", mlt_properties_get( context->producer_map, key ) );
 138         }
 139 }
 140
 141 static void serialise_multitrack( serialise_context context, mlt_service service, xmlNode *node )
 142 {
 143         int i;
 144         xmlNode *child = node;
 145         char id[ ID_SIZE + 1 ];
 146         char key[ 11 ];
 147         mlt_properties properties = mlt_service_properties( service );
 148
 149         id[ ID_SIZE ] = '\0';
 150         key[ 10 ] = '\0';
 151
 152         if ( context->pass == 0 )
 153         {
 154                 // Iterate over the tracks to collect the producers
 155                 for ( i = 0; i < mlt_multitrack_count( MLT_MULTITRACK( service ) ); i++ )
 156                         serialise_service( context, MLT_SERVICE( mlt_multitrack_track( MLT_MULTITRACK( service ), i ) ), node );
 157         }
 158
 159         else
 160         {
 161                 child = xmlNewChild( node, NULL, "multitrack", NULL );
 162
 163                 // Set the id
 164                 if ( mlt_properties_get( properties, "id" ) == NULL )
 165                 {
 166                         snprintf( id, ID_SIZE, "multitrack%d", context->multitrack_count++ );
 167                         xmlNewProp( child, "id", id );
 168                 }
 169
 170                 // Serialise the tracks
 171                 for ( i = 0; i < mlt_multitrack_count( MLT_MULTITRACK( service ) ); i++ )
 172                 {
 173                         xmlNode *track = xmlNewChild( child, NULL, "track", NULL );
 174                         int hide = 0;
 175
 176                         snprintf( key, 10, "%p", MLT_SERVICE( mlt_multitrack_track( MLT_MULTITRACK( service ), i ) ) );
 177                         xmlNewProp( track, "producer", mlt_properties_get( context->producer_map, key ) );
 178
 179                         hide = mlt_properties_get_int( context->hide_map, key );
 180                         if ( hide )
 181                                 xmlNewProp( track, "hide", hide == 1 ? "video" : ( hide == 2 ? "audio" : "both" ) );
 182                 }
 183         }
 184 }
 185
 186 static void serialise_playlist( serialise_context context, mlt_service service, xmlNode *node )
 187 {
 188         int i;
 189         xmlNode *child = node;
 190         char id[ ID_SIZE + 1 ];
 191         char key[ 11 ];
 192         mlt_playlist_clip_info info;
 193         mlt_properties properties = mlt_service_properties( service );
 194
 195         id[ ID_SIZE ] = '\0';
 196         key[ 10 ] = '\0';
 197
 198         if ( context->pass == 0 )
 199         {
 200                 // Iterate over the playlist entries to collect the producers
 201                 for ( i = 0; i < mlt_playlist_count( MLT_PLAYLIST( service ) ); i++ )
 202                 {
 203                         if ( ! mlt_playlist_get_clip_info( MLT_PLAYLIST( service ), &info, i ) )
 204                         {
 205                                 if ( info.producer && strcmp( mlt_properties_get( mlt_producer_properties( info.producer ), "mlt_service" ), "blank" ) != 0 )
 206                                 {
 207                                         serialise_service( context, MLT_SERVICE( info.producer ), node );
 208                                 }
 209                         }
 210                 }
 211
 212                 child = xmlNewChild( node, NULL, "playlist", NULL );
 213
 214                 // Set the id
 215                 if ( mlt_properties_get( properties, "id" ) == NULL )
 216                 {
 217                         snprintf( id, ID_SIZE, "playlist%d", context->playlist_count++ );
 218                         xmlNewProp( child, "id", id );
 219                 }
 220                 else
 221                         strncpy( id, mlt_properties_get( properties, "id" ), ID_SIZE );
 222
 223                 // Add producer to the map
 224                 snprintf( key, 10, "%p", service );
 225                 mlt_properties_set( context->producer_map, key, id );
 226                 mlt_properties_set_int( context->hide_map, key, mlt_properties_get_int( properties, "hide" ) );
 227
 228                 // Iterate over the playlist entries
 229                 for ( i = 0; i < mlt_playlist_count( MLT_PLAYLIST( service ) ); i++ )
 230                 {
 231                         if ( ! mlt_playlist_get_clip_info( MLT_PLAYLIST( service ), &info, i ) )
 232                         {
 233                                 if ( strcmp( mlt_properties_get( mlt_producer_properties( info.producer ), "mlt_service" ), "blank" ) == 0 )
 234                                 {
 235                                         char length[ 20 ];
 236                                         length[ 19 ] = '\0';
 237                                         xmlNode *entry = xmlNewChild( child, NULL, "blank", NULL );
 238                                         snprintf( length, 19, "%d", info.frame_count );
 239                                         xmlNewProp( entry, "length", length );
 240                                 }
 241                                 else
 242                                 {
 243                                         xmlNode *entry = xmlNewChild( child, NULL, "entry", NULL );
 244                                         snprintf( key, 10, "%p", MLT_SERVICE( info.producer ) );
 245                                         xmlNewProp( entry, "producer", mlt_properties_get( context->producer_map, key ) );
 246                                         xmlNewProp( entry, "in", mlt_properties_get( mlt_producer_properties( info.producer ), "in" ) );
 247                                         xmlNewProp( entry, "out", mlt_properties_get( mlt_producer_properties( info.producer ), "out" ) );
 248                                 }
 249                         }
 250                 }
 251         }
 252         else if ( strcmp( (const char*) node->name, "tractor" ) != 0 )
 253         {
 254                 snprintf( key, 10, "%p", service );
 255                 xmlNewProp( node, "producer", mlt_properties_get( context->producer_map, key ) );
 256         }
 257 }
 258
 259 static void serialise_tractor( serialise_context context, mlt_service service, xmlNode *node )
 260 {
 261         xmlNode *child = node;
 262         char id[ ID_SIZE + 1 ];
 263         mlt_properties properties = mlt_service_properties( service );
 264
 265         id[ ID_SIZE ] = '\0';
 266
 267         if ( context->pass == 0 )
 268         {
 269                 // Recurse on connected producer
 270                 serialise_service( context, mlt_service_get_producer( service ), node );
 271         }
 272         else
 273         {
 274                 child = xmlNewChild( node, NULL, "tractor", NULL );
 275
 276                 // Set the id
 277                 if ( mlt_properties_get( properties, "id" ) == NULL )
 278                 {
 279                         snprintf( id, ID_SIZE, "tractor%d", context->tractor_count++ );
 280                         xmlNewProp( child, "id", id );
 281                 }
 282
 283                 xmlNewProp( child, "in", mlt_properties_get( properties, "in" ) );
 284                 xmlNewProp( child, "out", mlt_properties_get( properties, "out" ) );
 285
 286                 // Recurse on connected producer
 287                 serialise_service( context, mlt_service_get_producer( service ), child );
 288         }
 289 }
 290
 291 static void serialise_filter( serialise_context context, mlt_service service, xmlNode *node )
 292 {
 293         xmlNode *child = node;
 294         char id[ ID_SIZE + 1 ];
 295         mlt_properties properties = mlt_service_properties( service );
 296
 297         id[ ID_SIZE ] = '\0';
 298
 299         // Recurse on connected producer
 300         serialise_service( context, MLT_SERVICE( MLT_FILTER( service )->producer ), node );
 301
 302         if ( context->pass == 1 )
 303         {
 304                 child = xmlNewChild( node, NULL, "filter", NULL );
 305
 306                 // Set the id
 307                 if ( mlt_properties_get( properties, "id" ) == NULL )
 308                 {
 309                         snprintf( id, ID_SIZE, "filter%d", context->filter_count++ );
 310                         xmlNewProp( child, "id", id );
 311                         xmlNewProp( child, "in", mlt_properties_get( properties, "in" ) );
 312                         xmlNewProp( child, "out", mlt_properties_get( properties, "out" ) );
 313                 }
 314
 315                 serialise_properties( properties, child );
 316         }
 317 }
 318
 319 static void serialise_transition( serialise_context context, mlt_service service, xmlNode *node )
 320 {
 321         xmlNode *child = node;
 322         char id[ ID_SIZE + 1 ];
 323         mlt_properties properties = mlt_service_properties( service );
 324
 325         id[ ID_SIZE ] = '\0';
 326
 327         // Recurse on connected producer
 328         serialise_service( context, MLT_SERVICE( MLT_TRANSITION( service )->producer ), node );
 329
 330         if ( context->pass == 1 )
 331         {
 332                 child = xmlNewChild( node, NULL, "transition", NULL );
 333
 334                 // Set the id
 335                 if ( mlt_properties_get( properties, "id" ) == NULL )
 336                 {
 337                         snprintf( id, ID_SIZE, "transition%d", context->transition_count++ );
 338                         xmlNewProp( child, "id", id );
 339                         xmlNewProp( child, "in", mlt_properties_get( properties, "in" ) );
 340                         xmlNewProp( child, "out", mlt_properties_get( properties, "out" ) );
 341                 }
 342
 343                 serialise_properties( properties, child );
 344         }
 345 }
 346
 347 static void serialise_service( serialise_context context, mlt_service service, xmlNode *node )
 348 {
 349         // Iterate over consumer/producer connections
 350         while ( service != NULL )
 351         {
 352                 mlt_properties properties = mlt_service_properties( service );
 353                 char *mlt_type = mlt_properties_get( properties, "mlt_type" );
 354
 355                 // Tell about the producer
 356                 if ( strcmp( mlt_type, "producer" ) == 0 )
 357                 {
 358                         serialise_producer( context, service, node );
 359                         if ( mlt_properties_get( properties, "westley" ) != NULL )
 360                                 break;
 361                 }
 362
 363                 // Tell about the framework container producers
 364                 else if ( strcmp( mlt_type, "mlt_producer" ) == 0 )
 365                 {
 366                         char *resource = mlt_properties_get( properties, "resource" );
 367
 368                         // Recurse on multitrack's tracks
 369                         if ( strcmp( resource, "<multitrack>" ) == 0 )
 370                         {
 371                                 serialise_multitrack( context, service, node );
 372                                 break;
 373                         }
 374
 375                         // Recurse on playlist's clips
 376                         else if ( strcmp( resource, "<playlist>" ) == 0 )
 377                         {
 378                                 serialise_playlist( context, service, node );
 379                         }
 380
 381                         // Recurse on tractor's producer
 382                         else if ( strcmp( resource, "<tractor>" ) == 0 )
 383                         {
 384                                 serialise_tractor( context, service, node );
 385                                 break;
 386                         }
 387                 }
 388
 389                 // Tell about a filter
 390                 else if ( strcmp( mlt_type, "filter" ) == 0 )
 391                 {
 392                         serialise_filter( context, service, node );
 393                         break;
 394                 }
 395
 396                 // Tell about a transition
 397                 else if ( strcmp( mlt_type, "transition" ) == 0 )
 398                 {
 399                         serialise_transition( context, service, node );
 400                         break;
 401                 }
 402
 403                 // Get the next connected service
 404                 service = mlt_service_get_producer( service );
 405         }
 406 }
 407
 408 static int consumer_start( mlt_consumer this )
 409 {
 410         mlt_service inigo = NULL;
 411         xmlDoc *doc = xmlNewDoc( "1.0" );
 412         xmlNode *root = xmlNewNode( NULL, "westley" );
 413         xmlDocSetRootElement( doc, root );
 414
 415         // Get the producer service
 416         mlt_service service = mlt_service_get_producer( mlt_consumer_service( this ) );
 417         if ( service != NULL )
 418         {
 419                 struct serialise_context_s *context = calloc( 1, sizeof( struct serialise_context_s ) );
 420
 421                 // Construct the context maps
 422                 context->producer_map = mlt_properties_new();
 423                 context->hide_map = mlt_properties_new();
 424
 425                 // Remember inigo
 426                 if ( mlt_properties_get( mlt_service_properties( service ), "mlt_service" ) != NULL &&
 427                                 strcmp( mlt_properties_get( mlt_service_properties( service ), "mlt_service" ), "inigo" ) == 0 )
 428                         inigo = service;
 429
 430                 // Ensure producer is a framework producer
 431                 mlt_properties_set( mlt_service_properties( service ), "mlt_type", "mlt_producer" );
 432
 433                 // In pass one, we serialise the end producers and playlists,
 434                 // adding them to a map keyed by address.
 435                 serialise_service( context, service, root );
 436
 437                 // In pass two, we serialise the tractor and reference the
 438                 // producers and playlists
 439                 context->pass++;
 440                 serialise_service( context, service, root );
 441
 442                 // Cleanup resource
 443                 mlt_properties_close( context->producer_map );
 444                 mlt_properties_close( context->hide_map );
 445                 free( context );
 446
 447                 if ( mlt_properties_get( mlt_consumer_properties( this ), "resource" ) == NULL )
 448                         xmlDocFormatDump( stdout, doc, 1 );
 449                 else
 450                         xmlSaveFormatFile( mlt_properties_get( mlt_consumer_properties( this ), "resource" ), doc, 1 );
 451         }
 452
 453         xmlFreeDoc( doc );
 454         mlt_consumer_stop( this );
 455
 456         return 0;
 457 }
 458
 459 static int consumer_is_stopped( mlt_consumer this )
 460 {
 461         return 1;
 462 }