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                 xmlNewProp( child, _x("in"), _x(mlt_properties_get_time( properties, "in", context->time_format )) );
 531                 xmlNewProp( child, _x("out"), _x(mlt_properties_get_time( properties, "out", context->time_format )) );
 532
 533                 // Store application specific properties
 534                 serialise_store_properties( context, MLT_SERVICE_PROPERTIES( service ), child, context->store );
 535                 if ( !context->no_meta )
 536                         serialise_store_properties( context, MLT_SERVICE_PROPERTIES( service ), child, "meta." );
 537
 538                 // Recurse on connected producer
 539                 serialise_service( context, mlt_service_producer( service ), child );
 540                 serialise_service_filters( context, service, child );
 541         }
 542 }
 543
 544 static void serialise_filter( serialise_context context, mlt_service service, xmlNode *node )
 545 {
 546         xmlNode *child = node;
 547         mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
 548
 549         // Recurse on connected producer
 550         serialise_service( context, mlt_service_producer( service ), node );
 551
 552         if ( context->pass == 1 )
 553         {
 554                 // Get a new id - if already allocated, do nothing
 555                 char *id = xml_get_id( context, service, xml_filter );
 556                 if ( id == NULL )
 557                         return;
 558
 559                 child = xmlNewChild( node, NULL, _x("filter"), NULL );
 560
 561                 // Set the id
 562                 xmlNewProp( child, _x("id"), _x(id) );
 563                 if ( mlt_properties_get( properties, "title" ) )
 564                         xmlNewProp( child, _x("title"), _x(mlt_properties_get( properties, "title" )) );
 565                 if ( mlt_properties_get_position( properties, "in" ) )
 566                         xmlNewProp( child, _x("in"), _x( mlt_properties_get_time( properties, "in", context->time_format ) ) );
 567                 if ( mlt_properties_get_position( properties, "out" ) )
 568                         xmlNewProp( child, _x("out"), _x( mlt_properties_get_time( properties, "out", context->time_format ) ) );
 569
 570                 serialise_properties( context, properties, child );
 571                 serialise_service_filters( context, service, child );
 572         }
 573 }
 574
 575 static void serialise_transition( serialise_context context, mlt_service service, xmlNode *node )
 576 {
 577         xmlNode *child = node;
 578         mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
 579
 580         // Recurse on connected producer
 581         serialise_service( context, MLT_SERVICE( MLT_TRANSITION( service )->producer ), node );
 582
 583         if ( context->pass == 1 )
 584         {
 585                 // Get a new id - if already allocated, do nothing
 586                 char *id = xml_get_id( context, service, xml_transition );
 587                 if ( id == NULL )
 588                         return;
 589
 590                 child = xmlNewChild( node, NULL, _x("transition"), NULL );
 591
 592                 // Set the id
 593                 xmlNewProp( child, _x("id"), _x(id) );
 594                 if ( mlt_properties_get( properties, "title" ) )
 595                         xmlNewProp( child, _x("title"), _x(mlt_properties_get( properties, "title" )) );
 596                 if ( mlt_properties_get_position( properties, "in" ) )
 597                         xmlNewProp( child, _x("in"), _x( mlt_properties_get_time( properties, "in", context->time_format ) ) );
 598                 if ( mlt_properties_get_position( properties, "out" ) )
 599                         xmlNewProp( child, _x("out"), _x( mlt_properties_get_time( properties, "out", context->time_format ) ) );
 600
 601                 serialise_properties( context, properties, child );
 602                 serialise_service_filters( context, service, child );
 603         }
 604 }
 605
 606 static void serialise_service( serialise_context context, mlt_service service, xmlNode *node )
 607 {
 608         // Iterate over consumer/producer connections
 609         while ( service != NULL )
 610         {
 611                 mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
 612                 char *mlt_type = mlt_properties_get( properties, "mlt_type" );
 613
 614                 // Tell about the producer
 615                 if ( strcmp( mlt_type, "producer" ) == 0 )
 616                 {
 617                         char *mlt_service = mlt_properties_get( properties, "mlt_service" );
 618                         if ( mlt_properties_get( properties, "xml" ) == NULL && ( mlt_service != NULL && !strcmp( mlt_service, "tractor" ) ) )
 619                         {
 620                                 context->pass = 0;
 621                                 serialise_tractor( context, service, node );
 622                                 context->pass = 1;
 623                                 serialise_tractor( context, service, node );
 624                                 context->pass = 0;
 625                                 break;
 626                         }
 627                         else
 628                         {
 629                                 serialise_producer( context, service, node );
 630                         }
 631                         if ( mlt_properties_get( properties, "xml" ) != NULL )
 632                                 break;
 633                 }
 634
 635                 // Tell about the framework container producers
 636                 else if ( strcmp( mlt_type, "mlt_producer" ) == 0 )
 637                 {
 638                         char *resource = mlt_properties_get( properties, "resource" );
 639
 640                         // Recurse on multitrack's tracks
 641                         if ( resource && strcmp( resource, "<multitrack>" ) == 0 )
 642                         {
 643                                 serialise_multitrack( context, service, node );
 644                                 break;
 645                         }
 646
 647                         // Recurse on playlist's clips
 648                         else if ( resource && strcmp( resource, "<playlist>" ) == 0 )
 649                         {
 650                                 serialise_playlist( context, service, node );
 651                         }
 652
 653                         // Recurse on tractor's producer
 654                         else if ( resource && strcmp( resource, "<tractor>" ) == 0 )
 655                         {
 656                                 context->pass = 0;
 657                                 serialise_tractor( context, service, node );
 658                                 context->pass = 1;
 659                                 serialise_tractor( context, service, node );
 660                                 context->pass = 0;
 661                                 break;
 662                         }
 663
 664                         // Treat it as a normal producer
 665                         else
 666                         {
 667                                 serialise_producer( context, service, node );
 668                         }
 669                 }
 670
 671                 // Tell about a filter
 672                 else if ( strcmp( mlt_type, "filter" ) == 0 )
 673                 {
 674                         serialise_filter( context, service, node );
 675                         break;
 676                 }
 677
 678                 // Tell about a transition
 679                 else if ( strcmp( mlt_type, "transition" ) == 0 )
 680                 {
 681                         serialise_transition( context, service, node );
 682                         break;
 683                 }
 684
 685                 // Get the next connected service
 686                 service = mlt_service_producer( service );
 687         }
 688 }
 689
 690 xmlDocPtr xml_make_doc( mlt_consumer consumer, mlt_service service )
 691 {
 692         mlt_properties properties = MLT_SERVICE_PROPERTIES( service );
 693         xmlDocPtr doc = xmlNewDoc( _x("1.0") );
 694         xmlNodePtr root = xmlNewNode( NULL, _x("mlt") );
 695         struct serialise_context_s *context = calloc( 1, sizeof( struct serialise_context_s ) );
 696         mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( consumer ) );
 697         char tmpstr[ 32 ];
 698
 699         xmlDocSetRootElement( doc, root );
 700
 701         // Indicate the numeric locale
 702         xmlNewProp( root, _x("LC_NUMERIC"), _x( setlocale( LC_NUMERIC, NULL ) ) );
 703
 704         // Indicate the version
 705         xmlNewProp( root, _x("version"), _x( mlt_version_get_string() ) );
 706
 707         // If we have root, then deal with it now
 708         if ( mlt_properties_get( properties, "root" ) != NULL )
 709         {
 710                 xmlNewProp( root, _x("root"), _x(mlt_properties_get( properties, "root" )) );
 711                 context->root = strdup( mlt_properties_get( properties, "root" ) );
 712         }
 713         else
 714         {
 715                 context->root = strdup( "" );
 716         }
 717
 718         // Assign the additional 'storage' pattern for properties
 719         context->store = mlt_properties_get( MLT_CONSUMER_PROPERTIES( consumer ), "store" );
 720         context->no_meta = mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( consumer ), "no_meta" );
 721         const char *time_format = mlt_properties_get( MLT_CONSUMER_PROPERTIES( consumer ), "time_format" );
 722         if ( time_format && ( !strcmp( time_format, "smpte" ) || !strcmp( time_format, "SMPTE" )
 723                         || !strcmp( time_format, "timecode" ) ) )
 724                 context->time_format = mlt_time_smpte;
 725         else if ( time_format && ( !strcmp( time_format, "clock" ) || !strcmp( time_format, "CLOCK" ) ) )
 726                 context->time_format = mlt_time_clock;
 727
 728         // Assign a title property
 729         if ( mlt_properties_get( properties, "title" ) != NULL )
 730                 xmlNewProp( root, _x("title"), _x(mlt_properties_get( properties, "title" )) );
 731         mlt_properties_set_int( properties, "global_feed", 1 );
 732
 733         // Add a profile child element
 734         if ( profile )
 735         {
 736                 xmlNodePtr profile_node = xmlNewChild( root, NULL, _x("profile"), NULL );
 737                 if ( profile->description )
 738                         xmlNewProp( profile_node, _x("description"), _x(profile->description) );
 739                 sprintf( tmpstr, "%d", profile->width );
 740                 xmlNewProp( profile_node, _x("width"), _x(tmpstr) );
 741                 sprintf( tmpstr, "%d", profile->height );
 742                 xmlNewProp( profile_node, _x("height"), _x(tmpstr) );
 743                 sprintf( tmpstr, "%d", profile->progressive );
 744                 xmlNewProp( profile_node, _x("progressive"), _x(tmpstr) );
 745                 sprintf( tmpstr, "%d", profile->sample_aspect_num );
 746                 xmlNewProp( profile_node, _x("sample_aspect_num"), _x(tmpstr) );
 747                 sprintf( tmpstr, "%d", profile->sample_aspect_den );
 748                 xmlNewProp( profile_node, _x("sample_aspect_den"), _x(tmpstr) );
 749                 sprintf( tmpstr, "%d", profile->display_aspect_num );
 750                 xmlNewProp( profile_node, _x("display_aspect_num"), _x(tmpstr) );
 751                 sprintf( tmpstr, "%d", profile->display_aspect_den );
 752                 xmlNewProp( profile_node, _x("display_aspect_den"), _x(tmpstr) );
 753                 sprintf( tmpstr, "%d", profile->frame_rate_num );
 754                 xmlNewProp( profile_node, _x("frame_rate_num"), _x(tmpstr) );
 755                 sprintf( tmpstr, "%d", profile->frame_rate_den );
 756                 xmlNewProp( profile_node, _x("frame_rate_den"), _x(tmpstr) );
 757                 sprintf( tmpstr, "%d", profile->colorspace );
 758                 xmlNewProp( profile_node, _x("colorspace"), _x(tmpstr) );
 759                 context->profile = profile;
 760         }
 761
 762         // Construct the context maps
 763         context->id_map = mlt_properties_new();
 764         context->hide_map = mlt_properties_new();
 765
 766         // Ensure producer is a framework producer
 767         mlt_properties_set( MLT_SERVICE_PROPERTIES( service ), "mlt_type", "mlt_producer" );
 768
 769         // In pass one, we serialise the end producers and playlists,
 770         // adding them to a map keyed by address.
 771         serialise_service( context, service, root );
 772
 773         // In pass two, we serialise the tractor and reference the
 774         // producers and playlists
 775         context->pass++;
 776         serialise_service( context, service, root );
 777
 778         // Cleanup resource
 779         mlt_properties_close( context->id_map );
 780         mlt_properties_close( context->hide_map );
 781         free( context->root );
 782         free( context );
 783
 784         return doc;
 785 }
 786
 787
 788 static void output_xml( mlt_consumer this )
 789 {
 790         // Get the producer service
 791         mlt_service service = mlt_service_producer( MLT_CONSUMER_SERVICE( this ) );
 792         mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
 793         char *resource =  mlt_properties_get( properties, "resource" );
 794         xmlDocPtr doc = NULL;
 795
 796         if ( !service ) return;
 797
 798         // Set the title if provided
 799         if ( mlt_properties_get( properties, "title" ) )
 800                 mlt_properties_set( MLT_SERVICE_PROPERTIES( service ), "title", mlt_properties_get( properties, "title" ) );
 801         else if ( mlt_properties_get( MLT_SERVICE_PROPERTIES( service ), "title" ) == NULL )
 802                 mlt_properties_set( MLT_SERVICE_PROPERTIES( service ), "title", "Anonymous Submission" );
 803
 804         // Check for a root on the consumer properties and pass to service
 805         if ( mlt_properties_get( properties, "root" ) )
 806                 mlt_properties_set( MLT_SERVICE_PROPERTIES( service ), "root", mlt_properties_get( properties, "root" ) );
 807
 808         // Specify roots in other cases...
 809         if ( resource != NULL && mlt_properties_get( properties, "root" ) == NULL )
 810         {
 811                 // Get the current working directory
 812                 char *cwd = getcwd( NULL, 0 );
 813                 mlt_properties_set( MLT_SERVICE_PROPERTIES( service ), "root", cwd );
 814                 free( cwd );
 815         }
 816
 817         // Make the document
 818         doc = xml_make_doc( this, service );
 819
 820         // Handle the output
 821         if ( resource == NULL || !strcmp( resource, "" ) )
 822         {
 823                 xmlDocFormatDump( stdout, doc, 1 );
 824         }
 825         else if ( strchr( resource, '.' ) == NULL )
 826         {
 827                 xmlChar *buffer = NULL;
 828                 int length = 0;
 829                 xmlDocDumpMemoryEnc( doc, &buffer, &length, "utf-8" );
 830                 mlt_properties_set( properties, resource, _s(buffer) );
 831 #ifdef WIN32
 832                 xmlFreeFunc xmlFree = NULL;
 833                 xmlMemGet( &xmlFree, NULL, NULL, NULL);
 834 #endif
 835                 xmlFree( buffer );
 836         }
 837         else
 838         {
 839                 xmlSaveFormatFileEnc( resource, doc, "utf-8", 1 );
 840         }
 841
 842         // Close the document
 843         xmlFreeDoc( doc );
 844 }
 845 static int consumer_start( mlt_consumer this )
 846 {
 847         mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
 848
 849         if ( mlt_properties_get_int( properties, "all" ) )
 850         {
 851                 // Check that we're not already running
 852                 if ( !mlt_properties_get_int( properties, "running" ) )
 853                 {
 854                         // Allocate a thread
 855                         pthread_t *thread = calloc( 1, sizeof( pthread_t ) );
 856
 857                         // Assign the thread to properties
 858                         mlt_properties_set_data( properties, "thread", thread, sizeof( pthread_t ), free, NULL );
 859
 860                         // Set the running state
 861                         mlt_properties_set_int( properties, "running", 1 );
 862                         mlt_properties_set_int( properties, "joined", 0 );
 863
 864                         // Create the thread
 865                         pthread_create( thread, NULL, consumer_thread, this );
 866                 }
 867         }
 868         else
 869         {
 870                 output_xml( this );
 871                 mlt_consumer_stop( this );
 872                 mlt_consumer_stopped( this );
 873         }
 874         return 0;
 875 }
 876
 877 static int consumer_is_stopped( mlt_consumer this )
 878 {
 879         mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
 880         return !mlt_properties_get_int( properties, "running" );
 881 }
 882
 883 static int consumer_stop( mlt_consumer this )
 884 {
 885         // Get the properties
 886         mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
 887
 888         // Check that we're running
 889         if ( !mlt_properties_get_int( properties, "joined" ) )
 890         {
 891                 // Get the thread
 892                 pthread_t *thread = mlt_properties_get_data( properties, "thread", NULL );
 893
 894                 // Stop the thread
 895                 mlt_properties_set_int( properties, "running", 0 );
 896                 mlt_properties_set_int( properties, "joined", 1 );
 897
 898                 // Wait for termination
 899                 if ( thread )
 900                         pthread_join( *thread, NULL );
 901         }
 902
 903         return 0;
 904 }
 905
 906 static void *consumer_thread( void *arg )
 907 {
 908         // Map the argument to the object
 909         mlt_consumer this = arg;
 910
 911         // Get the properties
 912         mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
 913
 914         // Convenience functionality
 915         int terminate_on_pause = mlt_properties_get_int( properties, "terminate_on_pause" );
 916         int terminated = 0;
 917
 918         // Frame and size
 919         mlt_frame frame = NULL;
 920
 921         // Loop while running
 922         while( !terminated && mlt_properties_get_int( properties, "running" ) )
 923         {
 924                 // Get the frame
 925                 frame = mlt_consumer_rt_frame( this );
 926
 927                 // Check for termination
 928                 if ( terminate_on_pause && frame != NULL )
 929                         terminated = mlt_properties_get_double( MLT_FRAME_PROPERTIES( frame ), "_speed" ) == 0.0;
 930
 931                 // Check that we have a frame to work with
 932                 if ( frame )
 933                 {
 934                         int width = 0, height = 0;
 935                         int frequency = mlt_properties_get_int( properties, "frequency" );
 936                         int channels = mlt_properties_get_int( properties, "channels" );
 937                         int samples = 0;
 938                         mlt_image_format iformat = mlt_image_yuv422;
 939                         mlt_audio_format aformat = mlt_audio_s16;
 940                         uint8_t *buffer;
 941
 942                         mlt_frame_get_image( frame, &buffer, &iformat, &width, &height, 0 );
 943                         mlt_frame_get_audio( frame, (void**) &buffer, &aformat, &frequency, &channels, &samples );
 944
 945                         // Close the frame
 946                         mlt_events_fire( properties, "consumer-frame-show", frame, NULL );
 947                         mlt_frame_close( frame );
 948                 }
 949         }
 950         output_xml( this );
 951
 952         // Indicate that the consumer is stopped
 953         mlt_properties_set_int( properties, "running", 0 );
 954         mlt_consumer_stopped( this );
 955
 956         return NULL;
 957 }