git.sesse.net Git - mlt/blob - src/modules/xml/consumer_xml.c

   1 /*
   2  * consumer_xml.c -- a libxml2 serialiser of mlt service networks
   3  * Copyright (C) 2003-2009 Ushodaya Enterprises Limited
   4  * Author: Dan Dennedy <dan@dennedy.org>
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library 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 GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 #include <framework/mlt.h>
  22 #include <stdio.h>
  23 #include <stdlib.h>
  24 #include <string.h>
  25 #include <unistd.h>
  26 #include <locale.h>
  27 #include <libxml/tree.h>
  28 #include <pthread.h>
  29 #include <wchar.h>
  30
  31 #define ID_SIZE 128
  32 #define TIME_PROPERTY "_consumer_xml"
  33
  34 #define _x (const xmlChar*)
  35 #define _s (const char*)
  36
  37 // This maintains counters for adding ids to elements
  38 struct serialise_context_s
  39 {
  40         mlt_properties id_map;
  41         int producer_count;
  42         int multitrack_count;
  43         int playlist_count;
  44         int tractor_count;
  45         int filter_count;
  46         int transition_count;
  47         int pass;
  48         mlt_properties hide_map;
  49         char *root;
  50         char *store;
  51         int no_meta;
  52         mlt_profile profile;
  53         mlt_time_format time_format;
  54 };
  55 typedef struct serialise_context_s* serialise_context;
  56
  57 /** Forward references to static functions.
  58 */
  59
  60 static int consumer_start( mlt_consumer parent );
  61 static int consumer_stop( mlt_consumer parent );
  62 static int consumer_is_stopped( mlt_consumer this );
  63 static void *consumer_thread( void *arg );
  64 static void serialise_service( serialise_context context, mlt_service service, xmlNode *node );
  65
  66 static char* filter_restricted( const char *in )
  67 {
  68         if ( !in ) return NULL;
  69         size_t n = strlen( in );
  70         char *out = calloc( 1, n + 1 );
  71         char *p = out;
  72         mbstate_t mbs;
  73         memset( &mbs, 0, sizeof(mbs) );
  74         while ( *in )
  75         {
  76                 wchar_t w;
  77                 size_t c = mbrtowc( &w, in, n, &mbs );
  78                 if ( c <= 0 || c > n ) break;
  79                 n -= c;
  80                 in += c;
  81                 if ( w == 0x9 || w == 0xA || w == 0xD ||
  82                                 ( w >= 0x20 && w <= 0xD7FF ) ||
  83                                 ( w >= 0xE000 && w <= 0xFFFD ) ||
  84                                 ( w >= 0x10000 && w <= 0x10FFFF ) )
  85                 {
  86                         mbstate_t ps;
  87                         memset( &ps, 0, sizeof(ps) );
  88                         c = wcrtomb( p, w, &ps );
  89                         if ( c > 0 )
  90                                 p += c;
  91                 }
  92         }
  93         return out;
  94 }
  95
  96 typedef enum
  97 {
  98         xml_existing,
  99         xml_producer,
 100         xml_multitrack,
 101         xml_playlist,
 102         xml_tractor,
 103         xml_filter,
 104         xml_transition
 105 }
 106 xml_type;
 107
 108 /** Create or retrieve an id associated to this service.
 109 */
 110
 111 static char *xml_get_id( serialise_context context, mlt_service service, xml_type type )
 112 {
 113         char *id = NULL;
 114         int i = 0;
 115         mlt_properties map = context->id_map;
 116
 117         // Search the map for the service
 118         for ( i = 0; i < mlt_properties_count( map ); i ++ )
 119                 if ( mlt_properties_get_data_at( map, i, NULL ) == service )
 120                         break;
 121
 122         // If the service is not in the map, and the type indicates a new id is needed...
 123         if ( i >= mlt_properties_count( map ) && type != xml_existing )
 124         {
 125                 // Attempt to reuse existing id
 126                 id = mlt_properties_get( MLT_SERVICE_PROPERTIES( service ), "id" );
 127
 128                 // If no id, or the id is used in the map (for another service), then
 129                 // create a new one.
 130                 if ( id == NULL || mlt_properties_get_data( map, id, NULL ) != NULL )
 131                 {
 132                         char temp[ ID_SIZE ];
 133                         do
 134                         {
 135                                 switch( type )
 136                                 {
 137                                         case xml_producer:
 138                                                 sprintf( temp, "producer%d", context->producer_count ++ );
 139                                                 break;
 140                                         case xml_multitrack:
 141                                                 sprintf( temp, "multitrack%d", context->multitrack_count ++ );
 142                                                 break;
 143                                         case xml_playlist:
 144                                                 sprintf( temp, "playlist%d", context->playlist_count ++ );
 145                                                 break;
 146                                         case xml_tractor:
 147                                                 sprintf( temp, "tractor%d", context->tractor_count ++ );
 148                                                 break;
 149                                         case xml_filter:
 150                                                 sprintf( temp, "filter%d", context->filter_count ++ );
 151                                                 break;
 152                                         case xml_transition:
 153                                                 sprintf( temp, "transition%d", context->transition_count ++ );
 154                                                 break;
 155                                         case xml_existing:
 156                                                 // Never gets here
 157                                                 break;
 158                                 }
 159                         }
 160                         while( mlt_properties_get_data( map, temp, NULL ) != NULL );
 161
 162                         // Set the data at the generated name
 163                         mlt_properties_set_data( map, temp, service, 0, NULL, NULL );
 164
 165                         // Get the pointer to the name (i is the end of the list)
 166                         id = mlt_properties_get_name( map, i );
 167                 }
 168                 else
 169                 {
 170                         // Store the existing id in the map
 171                         mlt_properties_set_data( map, id, service, 0, NULL, NULL );
 172                 }
 173         }
 174         else if ( type == xml_existing )
 175         {
 176                 id = mlt_properties_get_name( map, i );
 177         }
 178
 179         return id;
 180 }
 181
 182 /** This is what will be called by the factory - anything can be passed in
 183         via the argument, but keep it simple.
 184 */
 185
 186 mlt_consumer consumer_xml_init( mlt_profile profile, mlt_service_type type, const char *id, char *arg )
 187 {
 188         // Create the consumer object
 189         mlt_consumer this = calloc( 1, sizeof( struct mlt_consumer_s ) );
 190
 191         // If no malloc'd and consumer init ok
 192         if ( this != NULL && mlt_consumer_init( this, NULL, profile ) == 0 )
 193         {
 194                 // Allow thread to be started/stopped
 195                 this->start = consumer_start;
 196                 this->stop = consumer_stop;
 197                 this->is_stopped = consumer_is_stopped;
 198
 199                 mlt_properties_set( MLT_CONSUMER_PROPERTIES( this ), "resource", arg );
 200                 mlt_properties_set_int( MLT_CONSUMER_PROPERTIES( this ), "real_time", -1 );
 201                 mlt_properties_set_int( MLT_CONSUMER_PROPERTIES( this ), "prefill", 1 );
 202                 mlt_properties_set_int( MLT_CONSUMER_PROPERTIES( this ), "terminate_on_pause", 1 );
 203
 204                 // Return the consumer produced
 205                 return this;
 206         }
 207
 208         // malloc or consumer init failed
 209         free( this );
 210
 211         // Indicate failure
 212         return NULL;
 213 }
 214
 215 static void serialise_properties( serialise_context context, mlt_properties properties, xmlNode *node )
 216 {
 217         int i;
 218         xmlNode *p;
 219
 220         // Enumerate the properties
 221         for ( i = 0; i < mlt_properties_count( properties ); i++ )
 222         {
 223                 char *name = mlt_properties_get_name( properties, i );
 224                 if ( name != NULL &&
 225                          name[ 0 ] != '_' &&
 226                          mlt_properties_get_value( properties, i ) != NULL &&
 227                          ( !context->no_meta || strncmp( name, "meta.", 5 ) ) &&
 228                          strcmp( name, "mlt" ) &&
 229                          strcmp( name, "in" ) &&
 230                          strcmp( name, "out" ) &&
 231                          strcmp( name, "id" ) &&
 232                          strcmp( name, "title" ) &&
 233                          strcmp( name, "root" ) &&
 234                          strcmp( name, "width" ) &&
 235                          strcmp( name, "height" ) )
 236                 {
 237                         char *value = NULL;
 238                         if ( !strcmp( name, "length" ) )
 239                         {
 240                                 char *time = mlt_properties_get_time( properties, name, context->time_format );
 241                                 if ( time )
 242                                         value = strdup( time );
 243                         }
 244                         else
 245                                 value = filter_restricted( mlt_properties_get_value( properties, i ) );
 246                         if ( value )
 247                         {
 248                                 int rootlen = strlen( context->root );
 249                                 // convert absolute path to relative
 250                                 if ( rootlen && !strncmp( value, context->root, rootlen ) && value[ rootlen ] == '/' )
 251                                         p = xmlNewTextChild( node, NULL, _x("property"), _x(value + rootlen + 1 ) );
 252                                 else
 253                                         p = xmlNewTextChild( node, NULL, _x("property"), _x(value) );
 254                                 xmlNewProp( p, _x("name"), _x(name) );
 255                                 free( value );
 256                         }
 257                 }
 258         }
 259 }
 260
 261 static void serialise_store_properties( serialise_context context, mlt_properties properties, xmlNode *node, const char *store )
 262 {
 263         int i;
 264         xmlNode *p;
 265
 266         // Enumerate the properties
 267         for ( i = 0; store != NULL && i < mlt_properties_count( properties ); i++ )
 268         {
 269                 char *name = mlt_properties_get_name( properties, i );
 270                 if ( !strncmp( name, store, strlen( store ) ) )
 271                 {
 272                         char *value = filter_restricted( mlt_properties_get_value( properties, i ) );
 273                         if ( value )
 274                         {
 275                                 int rootlen = strlen( context->root );
 276                                 // convert absolute path to relative
 277                                 if ( rootlen && !strncmp( value, context->root, rootlen ) && value[ rootlen ] == '/' )
 278                                         p = xmlNewTextChild( node, NULL, _x("property"), _x(value + rootlen + 1) );
 279                                 else
 280                                         p = xmlNewTextChild( node, NULL, _x("property"), _x(value) );
 281                                 xmlNewProp( p, _x("name"), _x(name) );
 282                                 free( value );
 283                         }
 284                 }
 285         }
 286 }
 287
 288 static inline void serialise_service_filters( serialise_context context, mlt_service service, xmlNode *node )
 289 {
 290         int i;
 291         xmlNode *p;
 292         mlt_filter filter = NULL;
 293
 294         // Enumerate the filters
 295         for ( i = 0; ( filter = mlt_producer_filter( MLT_PRODUCER( service ), i ) ) != NULL; i ++ )
 296         {
 297                 mlt_properties properties = MLT_FILTER_PROPERTIES( filter );
 298                 if ( mlt_properties_get_int( properties, "_loader" ) == 0 )
 299                 {
 300                         // Get a new id - if already allocated, do nothing
 301                         char *id = xml_get_id( context, MLT_FILTER_SERVICE( filter ), xml_filter );
 302                         if ( id != NULL )
 303                         {
 304                                 p = xmlNewChild( node, NULL, _x("filter"), NULL );
 305                                 xmlNewProp( p, _x("id"), _x(id) );
 306                                 if ( mlt_properties_get( properties, "title" ) )
 307                                         xmlNewProp( p, _x("title"), _x(mlt_properties_get( properties, "title" )) );
 308                                 if ( mlt_properties_get_position( properties, "in" ) )
 309                                         xmlNewProp( p, _x("in"), _x( mlt_properties_get_time( properties, "in", context->time_format ) ) );
 310                                 if ( mlt_properties_get_position( properties, "out" ) )
 311                                         xmlNewProp( p, _x("out"), _x( mlt_properties_get_time( properties, "out", context->time_format ) ) );
 312                                 serialise_properties( context, properties, p );
 313                                 serialise_service_filters( context, MLT_FILTER_SERVICE( filter ), p );
 314                         }
 315                 }
 316         }
 317 }
 318
 319 static void serialise_producer( serialise_context context, mlt_service service, xmlNode *node )
 320 {
 321         xmlNode *child = node;
 322         mlt_service parent = MLT_SERVICE( mlt_producer_cut_parent( MLT_PRODUCER( service ) ) );
 323
 324         if ( context->pass == 0 )
 325         {
 326                 mlt_properties properties = MLT_SERVICE_PROPERTIES( parent );
 327                 // Get a new id - if already allocated, do nothing
 328                 char *id = xml_get_id( context, parent, xml_producer );
 329                 if ( id == NULL )
 330                         return;
 331
 332                 child = xmlNewChild( node, NULL, _x("producer"), NULL );
 333
 334                 // Set the id
 335                 xmlNewProp( child, _x("id"), _x(id) );
 336                 if ( mlt_properties_get( properties, "title" ) )
 337                         xmlNewProp( child, _x("title"), _x(mlt_properties_get( properties, "title" )) );
 338                 xmlNewProp( child, _x("in"), _x(mlt_properties_get_time( properties, "in", context->time_format )) );
 339                 xmlNewProp( child, _x("out"), _x(mlt_properties_get_time( properties, "out", context->time_format )) );
 340                 serialise_properties( context, properties, child );
 341                 serialise_service_filters( context, service, child );
 342
 343                 // Add producer to the map
 344                 mlt_properties_set_int( context->hide_map, id, mlt_properties_get_int( properties, "hide" ) );
 345         }
 346         else
 347         {
 348                 char *id = xml_get_id( context, parent, xml_existing );
 349                 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
 350                 xmlNewProp( node, _x("parent"), _x(id) );
 351                 xmlNewProp( node, _x("in"), _x(mlt_properties_get_time( properties, "in", context->time_format )) );
 352                 xmlNewProp( node, _x("out"), _x(mlt_properties_get_time( properties, "out", context->time_format )) );
 353         }
 354 }
 355
 356 static void serialise_tractor( serialise_context context, mlt_service service, xmlNode *node );
 357
 358 static void serialise_multitrack( serialise_context context, mlt_service service, xmlNode *node )
 359 {
 360         int i;
 361
 362         if ( context->pass == 0 )
 363         {
 364                 // Iterate over the tracks to collect the producers
 365                 for ( i = 0; i < mlt_multitrack_count( MLT_MULTITRACK( service ) ); i++ )
 366                 {
 367                         mlt_producer producer = mlt_producer_cut_parent( mlt_multitrack_track( MLT_MULTITRACK( service ), i ) );
 368                         serialise_service( context, MLT_SERVICE( producer ), node );
 369                 }
 370         }
 371         else
 372         {
 373                 // Get a new id - if already allocated, do nothing
 374                 char *id = xml_get_id( context, service, xml_multitrack );
 375                 if ( id == NULL )
 376                         return;
 377
 378                 // Serialise the tracks
 379                 for ( i = 0; i < mlt_multitrack_count( MLT_MULTITRACK( service ) ); i++ )
 380                 {
 381                         xmlNode *track = xmlNewChild( node, NULL, _x("track"), NULL );
 382                         int hide = 0;
 383                         mlt_producer producer = mlt_multitrack_track( MLT_MULTITRACK( service ), i );
 384                         mlt_properties properties = MLT_PRODUCER_PROPERTIES( producer );
 385
 386                         mlt_service parent = MLT_SERVICE( mlt_producer_cut_parent( producer ) );
 387
 388                         char *id = xml_get_id( context, MLT_SERVICE( parent ), xml_existing );
 389                         xmlNewProp( track, _x("producer"), _x(id) );
 390                         if ( mlt_producer_is_cut( producer ) )
 391                         {
 392                                 xmlNewProp( track, _x("in"), _x( mlt_properties_get_time( properties, "in", context->time_format ) ) );
 393                                 xmlNewProp( track, _x("out"), _x( mlt_properties_get_time( properties, "out", context->time_format ) ) );
 394                                 serialise_store_properties( context, MLT_PRODUCER_PROPERTIES( producer ), track, context->store );
 395                                 if ( !context->no_meta )
 396                                         serialise_store_properties( context, MLT_PRODUCER_PROPERTIES( producer ), track, "meta." );
 397                                 serialise_service_filters( context, MLT_PRODUCER_SERVICE( producer ), track );
 398                         }
 399
 400                         hide = mlt_properties_get_int( context->hide_map, id );
 401                         if ( hide )
 402                                 xmlNewProp( track, _x("hide"), _x( hide == 1 ? "video" : ( hide == 2 ? "audio" : "both" ) ) );
 403                 }
 404                 serialise_service_filters( context, service, node );
 405         }
 406 }
 407
 408 static void serialise_playlist( serialise_context context, mlt_service service, xmlNode *node )
 409 {
 410         int i;
 411         xmlNode *child = node;
 412         mlt_playlist_clip_info info;
 413         mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
 414
 415         if ( context->pass == 0 )
 416         {
 417                 // Get a new id - if already allocated, do nothing
 418                 char *id = xml_get_id( context, service, xml_playlist );
 419                 if ( id == NULL )
 420                         return;
 421
 422                 // Iterate over the playlist entries to collect the producers
 423                 for ( i = 0; i < mlt_playlist_count( MLT_PLAYLIST( service ) ); i++ )
 424                 {
 425                         if ( ! mlt_playlist_get_clip_info( MLT_PLAYLIST( service ), &info, i ) )
 426                         {
 427                                 if ( info.producer != NULL )
 428                                 {
 429                                         mlt_producer producer = mlt_producer_cut_parent( info.producer );
 430                                         char *service_s = mlt_properties_get( MLT_PRODUCER_PROPERTIES( producer ), "mlt_service" );
 431                                         char *resource_s = mlt_properties_get( MLT_PRODUCER_PROPERTIES( producer ), "resource" );
 432                                         if ( resource_s != NULL && !strcmp( resource_s, "<playlist>" ) )
 433                                                 serialise_playlist( context, MLT_SERVICE( producer ), node );
 434                                         else if ( service_s != NULL && strcmp( service_s, "blank" ) != 0 )
 435                                                 serialise_service( context, MLT_SERVICE( producer ), node );
 436                                 }
 437                         }
 438                 }
 439
 440                 child = xmlNewChild( node, NULL, _x("playlist"), NULL );
 441
 442                 // Set the id
 443                 xmlNewProp( child, _x("id"), _x(id) );
 444                 if ( mlt_properties_get( properties, "title" ) )
 445                         xmlNewProp( child, _x("title"), _x(mlt_properties_get( properties, "title" )) );
 446
 447                 // Store application specific properties
 448                 serialise_store_properties( context, properties, child, context->store );
 449                 if ( !context->no_meta )
 450                         serialise_store_properties( context, properties, child, "meta." );
 451
 452                 // Add producer to the map
 453                 mlt_properties_set_int( context->hide_map, id, mlt_properties_get_int( properties, "hide" ) );
 454
 455                 // Iterate over the playlist entries
 456                 for ( i = 0; i < mlt_playlist_count( MLT_PLAYLIST( service ) ); i++ )
 457                 {
 458                         if ( ! mlt_playlist_get_clip_info( MLT_PLAYLIST( service ), &info, i ) )
 459                         {
 460                                 mlt_producer producer = mlt_producer_cut_parent( info.producer );
 461                                 mlt_properties producer_props = MLT_PRODUCER_PROPERTIES( producer );
 462                                 char *service_s = mlt_properties_get( producer_props, "mlt_service" );
 463                                 if ( service_s != NULL && strcmp( service_s, "blank" ) == 0 )
 464                                 {
 465                                         xmlNode *entry = xmlNewChild( child, NULL, _x("blank"), NULL );
 466                                         mlt_properties_set_data( producer_props, "_profile", context->profile, 0, NULL, NULL );
 467                                         mlt_properties_set_position( producer_props, TIME_PROPERTY, info.frame_count );
 468                                         xmlNewProp( entry, _x("length"), _x( mlt_properties_get_time( producer_props, TIME_PROPERTY, context->time_format ) ) );
 469                                 }
 470                                 else
 471                                 {
 472                                         char temp[ 20 ];
 473                                         xmlNode *entry = xmlNewChild( child, NULL, _x("entry"), NULL );
 474                                         id = xml_get_id( context, MLT_SERVICE( producer ), xml_existing );
 475                                         xmlNewProp( entry, _x("producer"), _x(id) );
 476                                         mlt_properties_set_position( producer_props, TIME_PROPERTY, info.frame_in );
 477                                         xmlNewProp( entry, _x("in"), _x( mlt_properties_get_time( producer_props, TIME_PROPERTY, context->time_format ) ) );
 478                                         mlt_properties_set_position( producer_props, TIME_PROPERTY, info.frame_out );
 479                                         xmlNewProp( entry, _x("out"), _x( mlt_properties_get_time( producer_props, TIME_PROPERTY, context->time_format ) ) );
 480                                         if ( info.repeat > 1 )
 481                                         {
 482                                                 sprintf( temp, "%d", info.repeat );
 483                                                 xmlNewProp( entry, _x("repeat"), _x(temp) );
 484                                         }
 485                                         if ( mlt_producer_is_cut( info.cut ) )
 486                                         {
 487                                                 serialise_store_properties( context, MLT_PRODUCER_PROPERTIES( info.cut ), entry, context->store );
 488                                                 if ( !context->no_meta )
 489                                                         serialise_store_properties( context, MLT_PRODUCER_PROPERTIES( info.cut ), entry, "meta." );
 490                                                 serialise_service_filters( context, MLT_PRODUCER_SERVICE( info.cut ), entry );
 491                                         }
 492                                 }
 493                         }
 494                 }
 495
 496                 serialise_service_filters( context, service, child );
 497         }
 498         else if ( xmlStrcmp( node->name, _x("tractor") ) != 0 )
 499         {
 500                 char *id = xml_get_id( context, service, xml_existing );
 501                 xmlNewProp( node, _x("producer"), _x(id) );
 502         }
 503 }
 504
 505 static void serialise_tractor( serialise_context context, mlt_service service, xmlNode *node )
 506 {
 507         xmlNode *child = node;
 508         mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
 509
 510         if ( context->pass == 0 )
 511         {
 512                 // Recurse on connected producer
 513                 serialise_service( context, mlt_service_producer( service ), node );
 514         }
 515         else
 516         {
 517                 // Get a new id - if already allocated, do nothing
 518                 char *id = xml_get_id( context, service, xml_tractor );
 519                 if ( id == NULL )
 520                         return;
 521
 522                 child = xmlNewChild( node, NULL, _x("tractor"), NULL );
 523
 524                 // Set the id
 525                 xmlNewProp( child, _x("id"), _x(id) );
 526                 if ( mlt_properties_get( properties, "title" ) )
 527                         xmlNewProp( child, _x("title"), _x(mlt_properties_get( properties, "title" )) );
 528                 if ( mlt_properties_get( properties, "global_feed" ) )
 529                         xmlNewProp( child, _x("global_feed"), _x(mlt_properties_get( properties, "global_feed" )) );
 530                 if ( mlt_properties_get_position( properties, "in" ) >= 0 )
 531                         xmlNewProp( child, _x("in"), _x(mlt_properties_get_time( properties, "in", context->time_format )) );
 532                 if ( mlt_properties_get_position( properties, "out" ) >= 0 )
 533                         xmlNewProp( child, _x("out"), _x(mlt_properties_get_time( properties, "out", context->time_format )) );
 534
 535                 // Store application specific properties
 536                 serialise_store_properties( context, MLT_SERVICE_PROPERTIES( service ), child, context->store );
 537                 if ( !context->no_meta )
 538                         serialise_store_properties( context, MLT_SERVICE_PROPERTIES( service ), child, "meta." );
 539
 540                 // Recurse on connected producer
 541                 serialise_service( context, mlt_service_producer( service ), child );
 542                 serialise_service_filters( context, service, child );
 543         }
 544 }
 545
 546 static void serialise_filter( serialise_context context, mlt_service service, xmlNode *node )
 547 {
 548         xmlNode *child = node;
 549         mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
 550
 551         // Recurse on connected producer
 552         serialise_service( context, mlt_service_producer( service ), node );
 553
 554         if ( context->pass == 1 )
 555         {
 556                 // Get a new id - if already allocated, do nothing
 557                 char *id = xml_get_id( context, service, xml_filter );
 558                 if ( id == NULL )
 559                         return;
 560
 561                 child = xmlNewChild( node, NULL, _x("filter"), NULL );
 562
 563                 // Set the id
 564                 xmlNewProp( child, _x("id"), _x(id) );
 565                 if ( mlt_properties_get( properties, "title" ) )
 566                         xmlNewProp( child, _x("title"), _x(mlt_properties_get( properties, "title" )) );
 567                 if ( mlt_properties_get_position( properties, "in" ) )
 568                         xmlNewProp( child, _x("in"), _x( mlt_properties_get_time( properties, "in", context->time_format ) ) );
 569                 if ( mlt_properties_get_position( properties, "out" ) )
 570                         xmlNewProp( child, _x("out"), _x( mlt_properties_get_time( properties, "out", context->time_format ) ) );
 571
 572                 serialise_properties( context, properties, child );
 573                 serialise_service_filters( context, service, child );
 574         }
 575 }
 576
 577 static void serialise_transition( serialise_context context, mlt_service service, xmlNode *node )
 578 {
 579         xmlNode *child = node;
 580         mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
 581
 582         // Recurse on connected producer
 583         serialise_service( context, MLT_SERVICE( MLT_TRANSITION( service )->producer ), node );
 584
 585         if ( context->pass == 1 )
 586         {
 587                 // Get a new id - if already allocated, do nothing
 588                 char *id = xml_get_id( context, service, xml_transition );
 589                 if ( id == NULL )
 590                         return;
 591
 592                 child = xmlNewChild( node, NULL, _x("transition"), NULL );
 593
 594                 // Set the id
 595                 xmlNewProp( child, _x("id"), _x(id) );
 596                 if ( mlt_properties_get( properties, "title" ) )
 597                         xmlNewProp( child, _x("title"), _x(mlt_properties_get( properties, "title" )) );
 598                 if ( mlt_properties_get_position( properties, "in" ) )
 599                         xmlNewProp( child, _x("in"), _x( mlt_properties_get_time( properties, "in", context->time_format ) ) );
 600                 if ( mlt_properties_get_position( properties, "out" ) )
 601                         xmlNewProp( child, _x("out"), _x( mlt_properties_get_time( properties, "out", context->time_format ) ) );
 602
 603                 serialise_properties( context, properties, child );
 604                 serialise_service_filters( context, service, child );
 605         }
 606 }
 607
 608 static void serialise_service( serialise_context context, mlt_service service, xmlNode *node )
 609 {
 610         // Iterate over consumer/producer connections
 611         while ( service != NULL )
 612         {
 613                 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
 614                 char *mlt_type = mlt_properties_get( properties, "mlt_type" );
 615
 616                 // Tell about the producer
 617                 if ( strcmp( mlt_type, "producer" ) == 0 )
 618                 {
 619                         char *mlt_service = mlt_properties_get( properties, "mlt_service" );
 620                         if ( mlt_properties_get( properties, "xml" ) == NULL && ( mlt_service != NULL && !strcmp( mlt_service, "tractor" ) ) )
 621                         {
 622                                 context->pass = 0;
 623                                 serialise_tractor( context, service, node );
 624                                 context->pass = 1;
 625                                 serialise_tractor( context, service, node );
 626                                 context->pass = 0;
 627                                 break;
 628                         }
 629                         else
 630                         {
 631                                 serialise_producer( context, service, node );
 632                         }
 633                         if ( mlt_properties_get( properties, "xml" ) != NULL )
 634                                 break;
 635                 }
 636
 637                 // Tell about the framework container producers
 638                 else if ( strcmp( mlt_type, "mlt_producer" ) == 0 )
 639                 {
 640                         char *resource = mlt_properties_get( properties, "resource" );
 641
 642                         // Recurse on multitrack's tracks
 643                         if ( resource && strcmp( resource, "<multitrack>" ) == 0 )
 644                         {
 645                                 serialise_multitrack( context, service, node );
 646                                 break;
 647                         }
 648
 649                         // Recurse on playlist's clips
 650                         else if ( resource && strcmp( resource, "<playlist>" ) == 0 )
 651                         {
 652                                 serialise_playlist( context, service, node );
 653                         }
 654
 655                         // Recurse on tractor's producer
 656                         else if ( resource && strcmp( resource, "<tractor>" ) == 0 )
 657                         {
 658                                 context->pass = 0;
 659                                 serialise_tractor( context, service, node );
 660                                 context->pass = 1;
 661                                 serialise_tractor( context, service, node );
 662                                 context->pass = 0;
 663                                 break;
 664                         }
 665
 666                         // Treat it as a normal producer
 667                         else
 668                         {
 669                                 serialise_producer( context, service, node );
 670                                 if ( mlt_properties_get( properties, "xml" ) != NULL )
 671                                         break;
 672                         }
 673                 }
 674
 675                 // Tell about a filter
 676                 else if ( strcmp( mlt_type, "filter" ) == 0 )
 677                 {
 678                         serialise_filter( context, service, node );
 679                         break;
 680                 }
 681
 682                 // Tell about a transition
 683                 else if ( strcmp( mlt_type, "transition" ) == 0 )
 684                 {
 685                         serialise_transition( context, service, node );
 686                         break;
 687                 }
 688
 689                 // Get the next connected service
 690                 service = mlt_service_producer( service );
 691         }
 692 }
 693
 694 xmlDocPtr xml_make_doc( mlt_consumer consumer, mlt_service service )
 695 {
 696         mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
 697         xmlDocPtr doc = xmlNewDoc( _x("1.0") );
 698         xmlNodePtr root = xmlNewNode( NULL, _x("mlt") );
 699         struct serialise_context_s *context = calloc( 1, sizeof( struct serialise_context_s ) );
 700         mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( consumer ) );
 701         char tmpstr[ 32 ];
 702
 703         xmlDocSetRootElement( doc, root );
 704
 705         // Indicate the numeric locale
 706         xmlNewProp( root, _x("LC_NUMERIC"), _x( setlocale( LC_NUMERIC, NULL ) ) );
 707
 708         // Indicate the version
 709         xmlNewProp( root, _x("version"), _x( mlt_version_get_string() ) );
 710
 711         // If we have root, then deal with it now
 712         if ( mlt_properties_get( properties, "root" ) != NULL )
 713         {
 714                 xmlNewProp( root, _x("root"), _x(mlt_properties_get( properties, "root" )) );
 715                 context->root = strdup( mlt_properties_get( properties, "root" ) );
 716         }
 717         else
 718         {
 719                 context->root = strdup( "" );
 720         }
 721
 722         // Assign the additional 'storage' pattern for properties
 723         context->store = mlt_properties_get( MLT_CONSUMER_PROPERTIES( consumer ), "store" );
 724         context->no_meta = mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( consumer ), "no_meta" );
 725         const char *time_format = mlt_properties_get( MLT_CONSUMER_PROPERTIES( consumer ), "time_format" );
 726         if ( time_format && ( !strcmp( time_format, "smpte" ) || !strcmp( time_format, "SMPTE" )
 727                         || !strcmp( time_format, "timecode" ) ) )
 728                 context->time_format = mlt_time_smpte;
 729         else if ( time_format && ( !strcmp( time_format, "clock" ) || !strcmp( time_format, "CLOCK" ) ) )
 730                 context->time_format = mlt_time_clock;
 731
 732         // Assign a title property
 733         if ( mlt_properties_get( properties, "title" ) != NULL )
 734                 xmlNewProp( root, _x("title"), _x(mlt_properties_get( properties, "title" )) );
 735         mlt_properties_set_int( properties, "global_feed", 1 );
 736
 737         // Add a profile child element
 738         if ( profile )
 739         {
 740                 xmlNodePtr profile_node = xmlNewChild( root, NULL, _x("profile"), NULL );
 741                 if ( profile->description )
 742                         xmlNewProp( profile_node, _x("description"), _x(profile->description) );
 743                 sprintf( tmpstr, "%d", profile->width );
 744                 xmlNewProp( profile_node, _x("width"), _x(tmpstr) );
 745                 sprintf( tmpstr, "%d", profile->height );
 746                 xmlNewProp( profile_node, _x("height"), _x(tmpstr) );
 747                 sprintf( tmpstr, "%d", profile->progressive );
 748                 xmlNewProp( profile_node, _x("progressive"), _x(tmpstr) );
 749                 sprintf( tmpstr, "%d", profile->sample_aspect_num );
 750                 xmlNewProp( profile_node, _x("sample_aspect_num"), _x(tmpstr) );
 751                 sprintf( tmpstr, "%d", profile->sample_aspect_den );
 752                 xmlNewProp( profile_node, _x("sample_aspect_den"), _x(tmpstr) );
 753                 sprintf( tmpstr, "%d", profile->display_aspect_num );
 754                 xmlNewProp( profile_node, _x("display_aspect_num"), _x(tmpstr) );
 755                 sprintf( tmpstr, "%d", profile->display_aspect_den );
 756                 xmlNewProp( profile_node, _x("display_aspect_den"), _x(tmpstr) );
 757                 sprintf( tmpstr, "%d", profile->frame_rate_num );
 758                 xmlNewProp( profile_node, _x("frame_rate_num"), _x(tmpstr) );
 759                 sprintf( tmpstr, "%d", profile->frame_rate_den );
 760                 xmlNewProp( profile_node, _x("frame_rate_den"), _x(tmpstr) );
 761                 sprintf( tmpstr, "%d", profile->colorspace );
 762                 xmlNewProp( profile_node, _x("colorspace"), _x(tmpstr) );
 763                 context->profile = profile;
 764         }
 765
 766         // Construct the context maps
 767         context->id_map = mlt_properties_new();
 768         context->hide_map = mlt_properties_new();
 769
 770         // Ensure producer is a framework producer
 771         mlt_properties_set( MLT_SERVICE_PROPERTIES( service ), "mlt_type", "mlt_producer" );
 772
 773         // In pass one, we serialise the end producers and playlists,
 774         // adding them to a map keyed by address.
 775         serialise_service( context, service, root );
 776
 777         // In pass two, we serialise the tractor and reference the
 778         // producers and playlists
 779         context->pass++;
 780         serialise_service( context, service, root );
 781
 782         // Cleanup resource
 783         mlt_properties_close( context->id_map );
 784         mlt_properties_close( context->hide_map );
 785         free( context->root );
 786         free( context );
 787
 788         return doc;
 789 }
 790
 791
 792 static void output_xml( mlt_consumer this )
 793 {
 794         // Get the producer service
 795         mlt_service service = mlt_service_producer( MLT_CONSUMER_SERVICE( this ) );
 796         mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
 797         char *resource =  mlt_properties_get( properties, "resource" );
 798         xmlDocPtr doc = NULL;
 799
 800         if ( !service ) return;
 801
 802         // Set the title if provided
 803         if ( mlt_properties_get( properties, "title" ) )
 804                 mlt_properties_set( MLT_SERVICE_PROPERTIES( service ), "title", mlt_properties_get( properties, "title" ) );
 805         else if ( mlt_properties_get( MLT_SERVICE_PROPERTIES( service ), "title" ) == NULL )
 806                 mlt_properties_set( MLT_SERVICE_PROPERTIES( service ), "title", "Anonymous Submission" );
 807
 808         // Check for a root on the consumer properties and pass to service
 809         if ( mlt_properties_get( properties, "root" ) )
 810                 mlt_properties_set( MLT_SERVICE_PROPERTIES( service ), "root", mlt_properties_get( properties, "root" ) );
 811
 812         // Specify roots in other cases...
 813         if ( resource != NULL && mlt_properties_get( properties, "root" ) == NULL )
 814         {
 815                 // Get the current working directory
 816                 char *cwd = getcwd( NULL, 0 );
 817                 mlt_properties_set( MLT_SERVICE_PROPERTIES( service ), "root", cwd );
 818                 free( cwd );
 819         }
 820
 821         // Make the document
 822         doc = xml_make_doc( this, service );
 823
 824         // Handle the output
 825         if ( resource == NULL || !strcmp( resource, "" ) )
 826         {
 827                 xmlDocFormatDump( stdout, doc, 1 );
 828         }
 829         else if ( strchr( resource, '.' ) == NULL )
 830         {
 831                 xmlChar *buffer = NULL;
 832                 int length = 0;
 833                 xmlDocDumpMemoryEnc( doc, &buffer, &length, "utf-8" );
 834                 mlt_properties_set( properties, resource, _s(buffer) );
 835 #ifdef WIN32
 836                 xmlFreeFunc xmlFree = NULL;
 837                 xmlMemGet( &xmlFree, NULL, NULL, NULL);
 838 #endif
 839                 xmlFree( buffer );
 840         }
 841         else
 842         {
 843                 xmlSaveFormatFileEnc( resource, doc, "utf-8", 1 );
 844         }
 845
 846         // Close the document
 847         xmlFreeDoc( doc );
 848 }
 849 static int consumer_start( mlt_consumer this )
 850 {
 851         mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
 852
 853         if ( mlt_properties_get_int( properties, "all" ) )
 854         {
 855                 // Check that we're not already running
 856                 if ( !mlt_properties_get_int( properties, "running" ) )
 857                 {
 858                         // Allocate a thread
 859                         pthread_t *thread = calloc( 1, sizeof( pthread_t ) );
 860
 861                         // Assign the thread to properties
 862                         mlt_properties_set_data( properties, "thread", thread, sizeof( pthread_t ), free, NULL );
 863
 864                         // Set the running state
 865                         mlt_properties_set_int( properties, "running", 1 );
 866                         mlt_properties_set_int( properties, "joined", 0 );
 867
 868                         // Create the thread
 869                         pthread_create( thread, NULL, consumer_thread, this );
 870                 }
 871         }
 872         else
 873         {
 874                 output_xml( this );
 875                 mlt_consumer_stop( this );
 876                 mlt_consumer_stopped( this );
 877         }
 878         return 0;
 879 }
 880
 881 static int consumer_is_stopped( mlt_consumer this )
 882 {
 883         mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
 884         return !mlt_properties_get_int( properties, "running" );
 885 }
 886
 887 static int consumer_stop( mlt_consumer this )
 888 {
 889         // Get the properties
 890         mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
 891
 892         // Check that we're running
 893         if ( !mlt_properties_get_int( properties, "joined" ) )
 894         {
 895                 // Get the thread
 896                 pthread_t *thread = mlt_properties_get_data( properties, "thread", NULL );
 897
 898                 // Stop the thread
 899                 mlt_properties_set_int( properties, "running", 0 );
 900                 mlt_properties_set_int( properties, "joined", 1 );
 901
 902                 // Wait for termination
 903                 if ( thread )
 904                         pthread_join( *thread, NULL );
 905         }
 906
 907         return 0;
 908 }
 909
 910 static void *consumer_thread( void *arg )
 911 {
 912         // Map the argument to the object
 913         mlt_consumer this = arg;
 914
 915         // Get the properties
 916         mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
 917
 918         // Convenience functionality
 919         int terminate_on_pause = mlt_properties_get_int( properties, "terminate_on_pause" );
 920         int terminated = 0;
 921
 922         // Frame and size
 923         mlt_frame frame = NULL;
 924
 925         int video_off = mlt_properties_get_int( properties, "video_off" );
 926         int audio_off = mlt_properties_get_int( properties, "audio_off" );
 927
 928         // Loop while running
 929         while( !terminated && mlt_properties_get_int( properties, "running" ) )
 930         {
 931                 // Get the frame
 932                 frame = mlt_consumer_rt_frame( this );
 933
 934                 // Check for termination
 935                 if ( terminate_on_pause && frame != NULL )
 936                         terminated = mlt_properties_get_double( MLT_FRAME_PROPERTIES( frame ), "_speed" ) == 0.0;
 937
 938                 // Check that we have a frame to work with
 939                 if ( frame )
 940                 {
 941                         int width = 0, height = 0;
 942                         int frequency = mlt_properties_get_int( properties, "frequency" );
 943                         int channels = mlt_properties_get_int( properties, "channels" );
 944                         int samples = 0;
 945                         mlt_image_format iformat = mlt_image_yuv422;
 946                         mlt_audio_format aformat = mlt_audio_s16;
 947                         uint8_t *buffer;
 948
 949                         if ( !video_off )
 950                                 mlt_frame_get_image( frame, &buffer, &iformat, &width, &height, 0 );
 951                         if ( !audio_off )
 952                                 mlt_frame_get_audio( frame, (void**) &buffer, &aformat, &frequency, &channels, &samples );
 953
 954                         // Close the frame
 955                         mlt_events_fire( properties, "consumer-frame-show", frame, NULL );
 956                         mlt_frame_close( frame );
 957                 }
 958         }
 959         output_xml( this );
 960
 961         // Indicate that the consumer is stopped
 962         mlt_properties_set_int( properties, "running", 0 );
 963         mlt_consumer_stopped( this );
 964
 965         return NULL;
 966 }