git.sesse.net Git - mlt/blob - src/framework/mlt_consumer.c

   1 /**
   2  * \file mlt_consumer.c
   3  * \brief abstraction for all consumer services
   4  * \see mlt_consumer_s
   5  *
   6  * Copyright (C) 2003-2010 Ushodaya Enterprises Limited
   7  * \author Charles Yates <charles.yates@pandora.be>
   8  * \author Dan Dennedy <dan@dennedy.org>
   9  *
  10  * This library is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public
  12  * License as published by the Free Software Foundation; either
  13  * version 2.1 of the License, or (at your option) any later version.
  14  *
  15  * This library is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with this library; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  23  */
  24
  25 #include "mlt_consumer.h"
  26 #include "mlt_factory.h"
  27 #include "mlt_producer.h"
  28 #include "mlt_frame.h"
  29 #include "mlt_profile.h"
  30 #include "mlt_log.h"
  31
  32 #include <stdio.h>
  33 #include <string.h>
  34 #include <stdlib.h>
  35 #include <sys/time.h>
  36
  37 /** Define this if you want an automatic deinterlace (if necessary) when the
  38  * consumer's producer is not running at normal speed.
  39  */
  40 #undef DEINTERLACE_ON_NOT_NORMAL_SPEED
  41
  42 /** This is not the ideal place for this, but it is needed by VDPAU as well.
  43  */
  44 pthread_mutex_t mlt_sdl_mutex = PTHREAD_MUTEX_INITIALIZER;
  45
  46 static void mlt_consumer_frame_render( mlt_listener listener, mlt_properties owner, mlt_service self, void **args );
  47 static void mlt_consumer_frame_show( mlt_listener listener, mlt_properties owner, mlt_service self, void **args );
  48 static void mlt_consumer_property_changed( mlt_properties owner, mlt_consumer self, char *name );
  49 static void apply_profile_properties( mlt_consumer self, mlt_profile profile, mlt_properties properties );
  50 static void on_consumer_frame_show( mlt_properties owner, mlt_consumer self, mlt_frame frame );
  51
  52 /** Initialize a consumer service.
  53  *
  54  * \public \memberof mlt_consumer_s
  55  * \param self the consumer to initialize
  56  * \param child a pointer to the object for the subclass
  57  * \param profile the \p mlt_profile_s to use (optional but recommended,
  58  * uses the environment variable MLT if self is NULL)
  59  * \return true if there was an error
  60  */
  61
  62 int mlt_consumer_init( mlt_consumer self, void *child, mlt_profile profile )
  63 {
  64         int error = 0;
  65         memset( self, 0, sizeof( struct mlt_consumer_s ) );
  66         self->child = child;
  67         error = mlt_service_init( &self->parent, self );
  68         if ( error == 0 )
  69         {
  70                 // Get the properties from the service
  71                 mlt_properties properties = MLT_SERVICE_PROPERTIES( &self->parent );
  72
  73                 // Apply profile to properties
  74                 if ( profile == NULL )
  75                 {
  76                         // Normally the application creates the profile and controls its lifetime
  77                         // This is the fallback exception handling
  78                         profile = mlt_profile_init( NULL );
  79                         mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
  80                         mlt_properties_set_data( properties, "_profile", profile, 0, (mlt_destructor)mlt_profile_close, NULL );
  81                 }
  82                 apply_profile_properties( self, profile, properties );
  83
  84                 // Default rescaler for all consumers
  85                 mlt_properties_set( properties, "rescale", "bilinear" );
  86
  87                 // Default read ahead buffer size
  88                 mlt_properties_set_int( properties, "buffer", 25 );
  89                 mlt_properties_set_int( properties, "drop_max", 5 );
  90
  91                 // Default audio frequency and channels
  92                 mlt_properties_set_int( properties, "frequency", 48000 );
  93                 mlt_properties_set_int( properties, "channels", 2 );
  94
  95                 // Default of all consumers is real time
  96                 mlt_properties_set_int( properties, "real_time", 1 );
  97
  98                 // Default to environment test card
  99                 mlt_properties_set( properties, "test_card", mlt_environment( "MLT_TEST_CARD" ) );
 100
 101                 // Hmm - default all consumers to yuv422 :-/
 102                 self->format = mlt_image_yuv422;
 103                 mlt_properties_set( properties, "mlt_image_format", mlt_image_format_name( self->format ) );
 104                 mlt_properties_set( properties, "mlt_audio_format", mlt_audio_format_name( mlt_audio_s16 ) );
 105
 106                 mlt_events_register( properties, "consumer-frame-show", ( mlt_transmitter )mlt_consumer_frame_show );
 107                 mlt_events_register( properties, "consumer-frame-render", ( mlt_transmitter )mlt_consumer_frame_render );
 108                 mlt_events_register( properties, "consumer-stopped", NULL );
 109                 mlt_events_listen( properties, self, "consumer-frame-show", ( mlt_listener )on_consumer_frame_show );
 110
 111                 // Register a property-changed listener to handle the profile property -
 112                 // subsequent properties can override the profile
 113                 self->event_listener = mlt_events_listen( properties, self, "property-changed", ( mlt_listener )mlt_consumer_property_changed );
 114
 115                 // Create the push mutex and condition
 116                 pthread_mutex_init( &self->put_mutex, NULL );
 117                 pthread_cond_init( &self->put_cond, NULL );
 118
 119         }
 120         return error;
 121 }
 122
 123 /** Convert the profile into properties on the consumer.
 124  *
 125  * \private \memberof mlt_consumer_s
 126  * \param self a consumer
 127  * \param profile a profile
 128  * \param properties a properties list (typically, the consumer's)
 129  */
 130
 131 static void apply_profile_properties( mlt_consumer self, mlt_profile profile, mlt_properties properties )
 132 {
 133         mlt_event_block( self->event_listener );
 134         mlt_properties_set_double( properties, "fps", mlt_profile_fps( profile ) );
 135         mlt_properties_set_int( properties, "frame_rate_num", profile->frame_rate_num );
 136         mlt_properties_set_int( properties, "frame_rate_den", profile->frame_rate_den );
 137         mlt_properties_set_int( properties, "width", profile->width );
 138         mlt_properties_set_int( properties, "height", profile->height );
 139         mlt_properties_set_int( properties, "progressive", profile->progressive );
 140         mlt_properties_set_double( properties, "aspect_ratio", mlt_profile_sar( profile )  );
 141         mlt_properties_set_int( properties, "sample_aspect_num", profile->sample_aspect_num );
 142         mlt_properties_set_int( properties, "sample_aspect_den", profile->sample_aspect_den );
 143         mlt_properties_set_double( properties, "display_ratio", mlt_profile_dar( profile )  );
 144         mlt_properties_set_int( properties, "display_aspect_num", profile->display_aspect_num );
 145         mlt_properties_set_int( properties, "display_aspect_num", profile->display_aspect_num );
 146         mlt_properties_set_int( properties, "colorspace", profile->colorspace );
 147         mlt_event_unblock( self->event_listener );
 148 }
 149
 150 /** The property-changed event listener
 151  *
 152  * \private \memberof mlt_consumer_s
 153  * \param owner the events object
 154  * \param self the consumer
 155  * \param name the name of the property that changed
 156  */
 157
 158 static void mlt_consumer_property_changed( mlt_properties owner, mlt_consumer self, char *name )
 159 {
 160         if ( !strcmp( name, "mlt_profile" ) )
 161         {
 162                 // Get the properies
 163                 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
 164
 165                 // Get the current profile
 166                 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
 167
 168                 // Load the new profile
 169                 mlt_profile new_profile = mlt_profile_init( mlt_properties_get( properties, name ) );
 170
 171                 if ( new_profile )
 172                 {
 173                         // Copy the profile
 174                         if ( profile != NULL )
 175                         {
 176                                 free( profile->description );
 177                                 memcpy( profile, new_profile, sizeof( struct mlt_profile_s ) );
 178                                 profile->description = strdup( new_profile->description );
 179                         }
 180                         else
 181                         {
 182                                 profile = new_profile;
 183                         }
 184
 185                         // Apply to properties
 186                         apply_profile_properties( self, profile, properties );
 187                         mlt_profile_close( new_profile );
 188                 }
 189         }
 190         else if ( !strcmp( name, "frame_rate_num" ) )
 191         {
 192                 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
 193                 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
 194                 if ( profile )
 195                 {
 196                         profile->frame_rate_num = mlt_properties_get_int( properties, "frame_rate_num" );
 197                         mlt_properties_set_double( properties, "fps", mlt_profile_fps( profile ) );
 198                 }
 199         }
 200         else if ( !strcmp( name, "frame_rate_den" ) )
 201         {
 202                 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
 203                 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
 204                 if ( profile )
 205                 {
 206                         profile->frame_rate_den = mlt_properties_get_int( properties, "frame_rate_den" );
 207                         mlt_properties_set_double( properties, "fps", mlt_profile_fps( profile ) );
 208                 }
 209         }
 210         else if ( !strcmp( name, "width" ) )
 211         {
 212                 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
 213                 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
 214                 if ( profile )
 215                         profile->width = mlt_properties_get_int( properties, "width" );
 216         }
 217         else if ( !strcmp( name, "height" ) )
 218         {
 219                 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
 220                 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
 221                 if ( profile )
 222                         profile->height = mlt_properties_get_int( properties, "height" );
 223         }
 224         else if ( !strcmp( name, "progressive" ) )
 225         {
 226                 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
 227                 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
 228                 if ( profile )
 229                         profile->progressive = mlt_properties_get_int( properties, "progressive" );
 230         }
 231         else if ( !strcmp( name, "sample_aspect_num" ) )
 232         {
 233                 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
 234                 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
 235                 if ( profile )
 236                 {
 237                         profile->sample_aspect_num = mlt_properties_get_int( properties, "sample_aspect_num" );
 238                         mlt_properties_set_double( properties, "aspect_ratio", mlt_profile_sar( profile )  );
 239                 }
 240         }
 241         else if ( !strcmp( name, "sample_aspect_den" ) )
 242         {
 243                 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
 244                 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
 245                 if ( profile )
 246                 {
 247                         profile->sample_aspect_den = mlt_properties_get_int( properties, "sample_aspect_den" );
 248                         mlt_properties_set_double( properties, "aspect_ratio", mlt_profile_sar( profile )  );
 249                 }
 250         }
 251         else if ( !strcmp( name, "display_aspect_num" ) )
 252         {
 253                 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
 254                 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
 255                 if ( profile )
 256                 {
 257                         profile->display_aspect_num = mlt_properties_get_int( properties, "display_aspect_num" );
 258                         mlt_properties_set_double( properties, "display_ratio", mlt_profile_dar( profile )  );
 259                 }
 260         }
 261         else if ( !strcmp( name, "display_aspect_den" ) )
 262         {
 263                 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
 264                 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
 265                 if ( profile )
 266                 {
 267                         profile->display_aspect_den = mlt_properties_get_int( properties, "display_aspect_den" );
 268                         mlt_properties_set_double( properties, "display_ratio", mlt_profile_dar( profile )  );
 269                 }
 270         }
 271         else if ( !strcmp( name, "colorspace" ) )
 272         {
 273                 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
 274                 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
 275                 if ( profile )
 276                         profile->colorspace = mlt_properties_get_int( properties, "colorspace" );
 277         }
 278 }
 279
 280 /** The transmitter for the consumer-frame-show event
 281  *
 282  * Invokes the listener.
 283  *
 284  * \private \memberof mlt_consumer_s
 285  * \param listener a function pointer that will be invoked
 286  * \param owner the events object that will be passed to \p listener
 287  * \param self a service that will be passed to \p listener
 288  * \param args an array of pointers - the first entry is passed as a frame to \p listener
 289  */
 290
 291 static void mlt_consumer_frame_show( mlt_listener listener, mlt_properties owner, mlt_service self, void **args )
 292 {
 293         if ( listener != NULL )
 294                 listener( owner, self, ( mlt_frame )args[ 0 ] );
 295 }
 296
 297 /** The transmitter for the consumer-frame-render event
 298  *
 299  * Invokes the listener.
 300  *
 301  * \private \memberof mlt_consumer_s
 302  * \param listener a function pointer that will be invoked
 303  * \param owner the events object that will be passed to \p listener
 304  * \param self a service that will be passed to \p listener
 305  * \param args an array of pointers - the first entry is passed as a frame to \p listener
 306  */
 307
 308 static void mlt_consumer_frame_render( mlt_listener listener, mlt_properties owner, mlt_service self, void **args )
 309 {
 310         if ( listener != NULL )
 311                 listener( owner, self, ( mlt_frame )args[ 0 ] );
 312 }
 313
 314 /** A listener on the consumer-frame-show event
 315  *
 316  * Saves the position of the frame shown.
 317  *
 318  * \private \memberof mlt_consumer_s
 319  * \param owner the events object
 320  * \param consumer the consumer on which this event occurred
 321  * \param frame the frame that was shown
 322  */
 323
 324 static void on_consumer_frame_show( mlt_properties owner, mlt_consumer consumer, mlt_frame frame )
 325 {
 326         if ( frame )
 327                 consumer->position = mlt_frame_get_position( frame );
 328 }
 329
 330 /** Create a new consumer.
 331  *
 332  * \public \memberof mlt_consumer_s
 333  * \param profile a profile (optional, but recommended)
 334  * \return a new consumer
 335  */
 336
 337 mlt_consumer mlt_consumer_new( mlt_profile profile )
 338 {
 339         // Create the memory for the structure
 340         mlt_consumer self = malloc( sizeof( struct mlt_consumer_s ) );
 341
 342         // Initialise it
 343         if ( self != NULL && mlt_consumer_init( self, NULL, profile ) == 0 )
 344         {
 345                 // Return it
 346                 return self;
 347         }
 348         else
 349         {
 350                 free(self);
 351                 return NULL;
 352         }
 353 }
 354
 355 /** Get the parent service object.
 356  *
 357  * \public \memberof mlt_consumer_s
 358  * \param self a consumer
 359  * \return the parent service class
 360  * \see MLT_CONSUMER_SERVICE
 361  */
 362
 363 mlt_service mlt_consumer_service( mlt_consumer self )
 364 {
 365         return self != NULL ? &self->parent : NULL;
 366 }
 367
 368 /** Get the consumer properties.
 369  *
 370  * \public \memberof mlt_consumer_s
 371  * \param self a consumer
 372  * \return the consumer's properties list
 373  * \see MLT_CONSUMER_PROPERTIES
 374  */
 375
 376 mlt_properties mlt_consumer_properties( mlt_consumer self )
 377 {
 378         return self != NULL ? MLT_SERVICE_PROPERTIES( &self->parent ) : NULL;
 379 }
 380
 381 /** Connect the consumer to the producer.
 382  *
 383  * \public \memberof mlt_consumer_s
 384  * \param self a consumer
 385  * \param producer a producer
 386  * \return > 0 warning, == 0 success, < 0 serious error,
 387  *         1 = this service does not accept input,
 388  *         2 = the producer is invalid,
 389  *         3 = the producer is already registered with this consumer
 390  */
 391
 392 int mlt_consumer_connect( mlt_consumer self, mlt_service producer )
 393 {
 394         return mlt_service_connect_producer( &self->parent, producer, 0 );
 395 }
 396
 397 /** Start the consumer.
 398  *
 399  * \public \memberof mlt_consumer_s
 400  * \param self a consumer
 401  * \return true if there was an error
 402  */
 403
 404 int mlt_consumer_start( mlt_consumer self )
 405 {
 406         if ( !mlt_consumer_is_stopped( self ) )
 407                 return 0;
 408
 409         // Stop listening to the property-changed event
 410         mlt_event_block( self->event_listener );
 411
 412         // Get the properies
 413         mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
 414
 415         // Determine if there's a test card producer
 416         char *test_card = mlt_properties_get( properties, "test_card" );
 417
 418         // Just to make sure nothing is hanging around...
 419         pthread_mutex_lock( &self->put_mutex );
 420         self->put = NULL;
 421         self->put_active = 1;
 422         pthread_mutex_unlock( &self->put_mutex );
 423
 424         // Deal with it now.
 425         if ( test_card != NULL )
 426         {
 427                 if ( mlt_properties_get_data( properties, "test_card_producer", NULL ) == NULL )
 428                 {
 429                         // Create a test card producer
 430                         mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
 431                         mlt_producer producer = mlt_factory_producer( profile, NULL, test_card );
 432
 433                         // Do we have a producer
 434                         if ( producer != NULL )
 435                         {
 436                                 // Test card should loop I guess...
 437                                 mlt_properties_set( MLT_PRODUCER_PROPERTIES( producer ), "eof", "loop" );
 438                                 //mlt_producer_set_speed( producer, 0 );
 439                                 //mlt_producer_set_in_and_out( producer, 0, 0 );
 440
 441                                 // Set the test card on the consumer
 442                                 mlt_properties_set_data( properties, "test_card_producer", producer, 0, ( mlt_destructor )mlt_producer_close, NULL );
 443                         }
 444                 }
 445         }
 446         else
 447         {
 448                 // Allow the hash table to speed things up
 449                 mlt_properties_set_data( properties, "test_card_producer", NULL, 0, NULL, NULL );
 450         }
 451
 452         // The profile could have changed between a stop and a restart.
 453         apply_profile_properties( self, mlt_service_profile( MLT_CONSUMER_SERVICE(self) ), properties );
 454
 455         // Set the frame duration in microseconds for the frame-dropping heuristic
 456         int frame_rate_num = mlt_properties_get_int( properties, "frame_rate_num" );
 457         int frame_rate_den = mlt_properties_get_int( properties, "frame_rate_den" );
 458         int frame_duration = 0;
 459
 460         if ( frame_rate_num && frame_rate_den )
 461         {
 462                 frame_duration = 1000000 / frame_rate_num * frame_rate_den;
 463         }
 464
 465         mlt_properties_set_int( properties, "frame_duration", frame_duration );
 466
 467         // Check and run an ante command
 468         if ( mlt_properties_get( properties, "ante" ) )
 469                 if ( system( mlt_properties_get( properties, "ante" ) ) == -1 )
 470                         mlt_log( MLT_CONSUMER_SERVICE( self ), MLT_LOG_ERROR, "system(%s) failed!\n", mlt_properties_get( properties, "ante" ) );
 471
 472         // Set the real_time preference
 473         self->real_time = mlt_properties_get_int( properties, "real_time" );
 474
 475         // For worker threads implementation, buffer must be at least # threads
 476         if ( abs( self->real_time ) > 1 && mlt_properties_get_int( properties, "buffer" ) <= abs( self->real_time ) )
 477                 mlt_properties_set_int( properties, "_buffer", abs( self->real_time ) + 1 );
 478
 479         // Get the image format to use for rendering threads
 480         const char* format = mlt_properties_get( properties, "mlt_image_format" );
 481         if ( format )
 482         {
 483                 if ( !strcmp( format, "rgb24" ) )
 484                         self->format = mlt_image_rgb24;
 485                 else if ( !strcmp( format, "rgb24a" ) )
 486                         self->format = mlt_image_rgb24a;
 487                 else if ( !strcmp( format, "yuv420p" ) )
 488                         self->format = mlt_image_yuv420p;
 489                 else if ( !strcmp( format, "none" ) )
 490                         self->format = mlt_image_none;
 491                 else
 492                         self->format = mlt_image_yuv422;
 493         }
 494
 495         // Start the service
 496         if ( self->start != NULL )
 497                 return self->start( self );
 498
 499         return 0;
 500 }
 501
 502 /** An alternative method to feed frames into the consumer.
 503  *
 504  * Only valid if the consumer itself is not connected.
 505  *
 506  * \public \memberof mlt_consumer_s
 507  * \param self a consumer
 508  * \param frame a frame
 509  * \return true (ignore self for now)
 510  */
 511
 512 int mlt_consumer_put_frame( mlt_consumer self, mlt_frame frame )
 513 {
 514         int error = 1;
 515
 516         // Get the service assoicated to the consumer
 517         mlt_service service = MLT_CONSUMER_SERVICE( self );
 518
 519         if ( mlt_service_producer( service ) == NULL )
 520         {
 521                 struct timeval now;
 522                 struct timespec tm;
 523                 pthread_mutex_lock( &self->put_mutex );
 524                 while ( self->put_active && self->put != NULL )
 525                 {
 526                         gettimeofday( &now, NULL );
 527                         tm.tv_sec = now.tv_sec + 1;
 528                         tm.tv_nsec = now.tv_usec * 1000;
 529                         pthread_cond_timedwait( &self->put_cond, &self->put_mutex, &tm );
 530                 }
 531                 if ( self->put_active && self->put == NULL )
 532                         self->put = frame;
 533                 else
 534                         mlt_frame_close( frame );
 535                 pthread_cond_broadcast( &self->put_cond );
 536                 pthread_mutex_unlock( &self->put_mutex );
 537         }
 538         else
 539         {
 540                 mlt_frame_close( frame );
 541         }
 542
 543         return error;
 544 }
 545
 546 /** Protected method for consumer to get frames from connected service
 547  *
 548  * \public \memberof mlt_consumer_s
 549  * \param self a consumer
 550  * \return a frame
 551  */
 552
 553 mlt_frame mlt_consumer_get_frame( mlt_consumer self )
 554 {
 555         // Frame to return
 556         mlt_frame frame = NULL;
 557
 558         // Get the service assoicated to the consumer
 559         mlt_service service = MLT_CONSUMER_SERVICE( self );
 560
 561         // Get the consumer properties
 562         mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
 563
 564         // Get the frame
 565         if ( mlt_service_producer( service ) == NULL && mlt_properties_get_int( properties, "put_mode" ) )
 566         {
 567                 struct timeval now;
 568                 struct timespec tm;
 569                 pthread_mutex_lock( &self->put_mutex );
 570                 while ( self->put_active && self->put == NULL )
 571                 {
 572                         gettimeofday( &now, NULL );
 573                         tm.tv_sec = now.tv_sec + 1;
 574                         tm.tv_nsec = now.tv_usec * 1000;
 575                         pthread_cond_timedwait( &self->put_cond, &self->put_mutex, &tm );
 576                 }
 577                 frame = self->put;
 578                 self->put = NULL;
 579                 pthread_cond_broadcast( &self->put_cond );
 580                 pthread_mutex_unlock( &self->put_mutex );
 581                 if ( frame != NULL )
 582                         mlt_service_apply_filters( service, frame, 0 );
 583         }
 584         else if ( mlt_service_producer( service ) != NULL )
 585         {
 586                 mlt_service_get_frame( service, &frame, 0 );
 587         }
 588         else
 589         {
 590                 frame = mlt_frame_init( service );
 591         }
 592
 593         if ( frame != NULL )
 594         {
 595                 // Get the frame properties
 596                 mlt_properties frame_properties = MLT_FRAME_PROPERTIES( frame );
 597
 598                 // Get the test card producer
 599                 mlt_producer test_card = mlt_properties_get_data( properties, "test_card_producer", NULL );
 600
 601                 // Attach the test frame producer to it.
 602                 if ( test_card != NULL )
 603                         mlt_properties_set_data( frame_properties, "test_card_producer", test_card, 0, NULL, NULL );
 604
 605                 // Pass along the interpolation and deinterlace options
 606                 // TODO: get rid of consumer_deinterlace and use profile.progressive
 607                 mlt_properties_set( frame_properties, "rescale.interp", mlt_properties_get( properties, "rescale" ) );
 608                 mlt_properties_set_int( frame_properties, "consumer_deinterlace", mlt_properties_get_int( properties, "progressive" ) | mlt_properties_get_int( properties, "deinterlace" ) );
 609                 mlt_properties_set( frame_properties, "deinterlace_method", mlt_properties_get( properties, "deinterlace_method" ) );
 610                 mlt_properties_set_int( frame_properties, "consumer_tff", mlt_properties_get_int( properties, "top_field_first" ) );
 611         }
 612
 613         // Return the frame
 614         return frame;
 615 }
 616
 617 /** Compute the time difference between now and a time value.
 618  *
 619  * \private \memberof mlt_consumer_s
 620  * \param time1 a time value to be compared against now
 621  * \return the difference in microseconds
 622  */
 623
 624 static inline long time_difference( struct timeval *time1 )
 625 {
 626         struct timeval time2;
 627         time2.tv_sec = time1->tv_sec;
 628         time2.tv_usec = time1->tv_usec;
 629         gettimeofday( time1, NULL );
 630         return time1->tv_sec * 1000000 + time1->tv_usec - time2.tv_sec * 1000000 - time2.tv_usec;
 631 }
 632
 633 /** The thread procedure for asynchronously pulling frames through the service
 634  * network connected to a consumer.
 635  *
 636  * \private \memberof mlt_consumer_s
 637  * \param arg a consumer
 638  */
 639
 640 static void *consumer_read_ahead_thread( void *arg )
 641 {
 642         // The argument is the consumer
 643         mlt_consumer self = arg;
 644
 645         // Get the properties of the consumer
 646         mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
 647
 648         // Get the width and height
 649         int width = mlt_properties_get_int( properties, "width" );
 650         int height = mlt_properties_get_int( properties, "height" );
 651
 652         // See if video is turned off
 653         int video_off = mlt_properties_get_int( properties, "video_off" );
 654         int preview_off = mlt_properties_get_int( properties, "preview_off" );
 655         int preview_format = mlt_properties_get_int( properties, "preview_format" );
 656
 657         // Get the audio settings
 658         mlt_audio_format afmt = mlt_audio_s16;
 659         const char *format = mlt_properties_get( properties, "mlt_audio_format" );
 660         if ( format )
 661         {
 662                 if ( !strcmp( format, "none" ) )
 663                         afmt = mlt_audio_none;
 664                 else if ( !strcmp( format, "s32" ) )
 665                         afmt = mlt_audio_s32;
 666                 else if ( !strcmp( format, "s32le" ) )
 667                         afmt = mlt_audio_s32le;
 668                 else if ( !strcmp( format, "float" ) )
 669                         afmt = mlt_audio_float;
 670                 else if ( !strcmp( format, "f32le" ) )
 671                         afmt = mlt_audio_f32le;
 672         }
 673         int counter = 0;
 674         double fps = mlt_properties_get_double( properties, "fps" );
 675         int channels = mlt_properties_get_int( properties, "channels" );
 676         int frequency = mlt_properties_get_int( properties, "frequency" );
 677         int samples = 0;
 678         void *audio = NULL;
 679
 680         // See if audio is turned off
 681         int audio_off = mlt_properties_get_int( properties, "audio_off" );
 682
 683         // Get the maximum size of the buffer
 684         int buffer = mlt_properties_get_int( properties, "buffer" ) + 1;
 685
 686         // General frame variable
 687         mlt_frame frame = NULL;
 688         uint8_t *image = NULL;
 689
 690         // Time structures
 691         struct timeval ante;
 692
 693         // Average time for get_frame and get_image
 694         int count = 0;
 695         int skipped = 0;
 696         int64_t time_process = 0;
 697         int skip_next = 0;
 698         mlt_position pos = 0;
 699         mlt_position start_pos = 0;
 700         mlt_position last_pos = 0;
 701         int frame_duration = mlt_properties_get_int( properties, "frame_duration" );
 702         int drop_max = mlt_properties_get_int( properties, "drop_max" );
 703
 704         if ( preview_off && preview_format != 0 )
 705                 self->format = preview_format;
 706
 707         // Get the first frame
 708         frame = mlt_consumer_get_frame( self );
 709
 710         if ( frame )
 711         {
 712                 // Get the image of the first frame
 713                 if ( !video_off )
 714                 {
 715                         mlt_events_fire( MLT_CONSUMER_PROPERTIES( self ), "consumer-frame-render", frame, NULL );
 716                         mlt_frame_get_image( frame, &image, &self->format, &width, &height, 0 );
 717                 }
 718
 719                 if ( !audio_off )
 720                 {
 721                         samples = mlt_sample_calculator( fps, frequency, counter++ );
 722                         mlt_frame_get_audio( frame, &audio, &afmt, &frequency, &channels, &samples );
 723                 }
 724
 725                 // Mark as rendered
 726                 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "rendered", 1 );
 727                 last_pos = start_pos = pos = mlt_frame_get_position( frame );
 728         }
 729
 730         // Get the starting time (can ignore the times above)
 731         gettimeofday( &ante, NULL );
 732
 733         // Continue to read ahead
 734         while ( self->ahead )
 735         {
 736                 // Put the current frame into the queue
 737                 pthread_mutex_lock( &self->queue_mutex );
 738                 while( self->ahead && mlt_deque_count( self->queue ) >= buffer )
 739                         pthread_cond_wait( &self->queue_cond, &self->queue_mutex );
 740                 mlt_deque_push_back( self->queue, frame );
 741                 pthread_cond_broadcast( &self->queue_cond );
 742                 pthread_mutex_unlock( &self->queue_mutex );
 743
 744                 // Get the next frame
 745                 frame = mlt_consumer_get_frame( self );
 746
 747                 // If there's no frame, we're probably stopped...
 748                 if ( frame == NULL )
 749                         continue;
 750                 pos = mlt_frame_get_position( frame );
 751
 752                 // Increment the counter used for averaging processing cost
 753                 count ++;
 754
 755                 // All non-normal playback frames should be shown
 756                 if ( mlt_properties_get_int( MLT_FRAME_PROPERTIES( frame ), "_speed" ) != 1 )
 757                 {
 758 #ifdef DEINTERLACE_ON_NOT_NORMAL_SPEED
 759                         mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "consumer_deinterlace", 1 );
 760 #endif
 761                         // Indicate seeking or trick-play
 762                         start_pos = pos;
 763                 }
 764
 765                 // If skip flag not set or frame-dropping disabled
 766                 if ( !skip_next || self->real_time == -1 )
 767                 {
 768                         if ( !video_off )
 769                         {
 770                                 // Reset width/height - could have been changed by previous mlt_frame_get_image
 771                                 width = mlt_properties_get_int( properties, "width" );
 772                                 height = mlt_properties_get_int( properties, "height" );
 773
 774                                 // Get the image
 775                                 mlt_events_fire( MLT_CONSUMER_PROPERTIES( self ), "consumer-frame-render", frame, NULL );
 776                                 mlt_frame_get_image( frame, &image, &self->format, &width, &height, 0 );
 777                         }
 778
 779                         // Indicate the rendered image is available.
 780                         mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "rendered", 1 );
 781
 782                         // Reset consecutively-skipped counter
 783                         skipped = 0;
 784                 }
 785                 else // Skip image processing
 786                 {
 787                         // Increment the number of consecutively-skipped frames
 788                         skipped++;
 789
 790                         // If too many (1 sec) consecutively-skipped frames
 791                         if ( skipped > drop_max )
 792                         {
 793                                 // Reset cost tracker
 794                                 time_process = 0;
 795                                 count = 1;
 796                                 mlt_log_verbose( self, "too many frames dropped - forcing next frame\n" );
 797                         }
 798                 }
 799
 800                 // Always process audio
 801                 if ( !audio_off )
 802                 {
 803                         samples = mlt_sample_calculator( fps, frequency, counter++ );
 804                         mlt_frame_get_audio( frame, &audio, &afmt, &frequency, &channels, &samples );
 805                 }
 806
 807                 // Get the time to process this frame
 808                 int64_t time_current = time_difference( &ante );
 809
 810                 // If the current time is not suddenly some large amount
 811                 if ( time_current < time_process / count * 20 || !time_process || count < 5 )
 812                 {
 813                         // Accumulate the cost for processing this frame
 814                         time_process += time_current;
 815                 }
 816                 else
 817                 {
 818                         mlt_log_debug( self, "current %"PRId64" threshold %"PRId64" count %d\n",
 819                                 time_current, (int64_t) (time_process / count * 20), count );
 820                         // Ignore the cost of this frame's time
 821                         count--;
 822                 }
 823
 824                 // Determine if we started, resumed, or seeked
 825                 if ( pos != last_pos + 1 )
 826                         start_pos = pos;
 827                 last_pos = pos;
 828
 829                 // Do not skip the first 20% of buffer at start, resume, or seek
 830                 if ( pos - start_pos <= buffer / 5 + 1 )
 831                 {
 832                         // Reset cost tracker
 833                         time_process = 0;
 834                         count = 1;
 835                 }
 836
 837                 // Reset skip flag
 838                 skip_next = 0;
 839
 840                 // Only consider skipping if the buffer level is low (or really small)
 841                 if ( mlt_deque_count( self->queue ) <= buffer / 5 + 1 )
 842                 {
 843                         // Skip next frame if average cost exceeds frame duration.
 844                         if ( time_process / count > frame_duration )
 845                                 skip_next = 1;
 846                         if ( skip_next )
 847                                 mlt_log_debug( self, "avg usec %"PRId64" (%"PRId64"/%d) duration %d\n",
 848                                         time_process/count, time_process, count, frame_duration);
 849                 }
 850         }
 851
 852         // Remove the last frame
 853         mlt_frame_close( frame );
 854
 855         return NULL;
 856 }
 857
 858 /** Locate the first unprocessed frame in the queue.
 859  *
 860  * When playing with realtime behavior, we do not use the true head, but
 861  * rather an adjusted process_head. The process_head is adjusted based on
 862  * the rate of frame-dropping or recovery from frame-dropping. The idea is
 863  * that as the level of frame-dropping increases to move the process_head
 864  * closer to the tail because the frames are not completing processing prior
 865  * to their playout! Then, as frames are not dropped the process_head moves
 866  * back closer to the head of the queue so that worker threads can work
 867  * ahead of the playout point (queue head).
 868  *
 869  * \private \memberof mlt_consumer_s
 870  * \param self a consumer
 871  * \return an index into the queue
 872  */
 873
 874 static inline int first_unprocessed_frame( mlt_consumer self )
 875 {
 876         int index = self->real_time <= 0 ? 0 : self->process_head;
 877         while ( index < mlt_deque_count( self->queue ) && MLT_FRAME( mlt_deque_peek( self->queue, index ) )->is_processing )
 878                 index++;
 879         return index;
 880 }
 881
 882 /** The worker thread procedure for parallel processing frames.
 883  *
 884  * \private \memberof mlt_consumer_s
 885  * \param arg a consumer
 886  */
 887
 888 static void *consumer_worker_thread( void *arg )
 889 {
 890         // The argument is the consumer
 891         mlt_consumer self = arg;
 892
 893         // Get the properties of the consumer
 894         mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
 895
 896         // Get the width and height
 897         int width = mlt_properties_get_int( properties, "width" );
 898         int height = mlt_properties_get_int( properties, "height" );
 899         mlt_image_format format = self->format;
 900
 901         // See if video is turned off
 902         int video_off = mlt_properties_get_int( properties, "video_off" );
 903         int preview_off = mlt_properties_get_int( properties, "preview_off" );
 904         int preview_format = mlt_properties_get_int( properties, "preview_format" );
 905
 906         // General frame variable
 907         mlt_frame frame = NULL;
 908         uint8_t *image = NULL;
 909
 910         if ( preview_off && preview_format != 0 )
 911                 format = preview_format;
 912
 913         // Continue to read ahead
 914         while ( self->ahead )
 915         {
 916                 // Get the next unprocessed frame from the work queue
 917                 pthread_mutex_lock( &self->queue_mutex );
 918                 int index = first_unprocessed_frame( self );
 919                 while ( self->ahead && index >= mlt_deque_count( self->queue ) )
 920                 {
 921                         mlt_log_debug( MLT_CONSUMER_SERVICE(self), "waiting in worker index = %d queue count = %d\n",
 922                                 index, mlt_deque_count( self->queue ) );
 923                         pthread_cond_wait( &self->queue_cond, &self->queue_mutex );
 924                         index = first_unprocessed_frame( self );
 925                 }
 926
 927                 // Mark the frame for processing
 928                 frame = mlt_deque_peek( self->queue, index );
 929                 if ( frame )
 930                 {
 931                         mlt_log_debug( MLT_CONSUMER_SERVICE(self), "worker processing index = %d frame %d queue count = %d\n",
 932                                 index, mlt_frame_get_position(frame), mlt_deque_count( self->queue ) );
 933                         frame->is_processing = 1;
 934                         mlt_properties_inc_ref( MLT_FRAME_PROPERTIES( frame ) );
 935                 }
 936                 pthread_mutex_unlock( &self->queue_mutex );
 937
 938                 // If there's no frame, we're probably stopped...
 939                 if ( frame == NULL )
 940                         continue;
 941
 942 #ifdef DEINTERLACE_ON_NOT_NORMAL_SPEED
 943                 // All non normal playback frames should be shown
 944                 if ( mlt_properties_get_int( MLT_FRAME_PROPERTIES( frame ), "_speed" ) != 1 )
 945                         mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "consumer_deinterlace", 1 );
 946 #endif
 947
 948                 // Get the image
 949                 if ( !video_off )
 950                 {
 951                         // Fetch width/height again
 952                         width = mlt_properties_get_int( properties, "width" );
 953                         height = mlt_properties_get_int( properties, "height" );
 954                         mlt_events_fire( MLT_CONSUMER_PROPERTIES( self ), "consumer-frame-render", frame, NULL );
 955                         mlt_frame_get_image( frame, &image, &format, &width, &height, 0 );
 956                 }
 957                 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "rendered", 1 );
 958                 mlt_frame_close( frame );
 959
 960                 // Tell a waiting thread (non-realtime main consumer thread) that we are done.
 961                 pthread_mutex_lock( &self->done_mutex );
 962                 pthread_cond_broadcast( &self->done_cond );
 963                 pthread_mutex_unlock( &self->done_mutex );
 964         }
 965
 966         return NULL;
 967 }
 968
 969 /** Start the read/render thread.
 970  *
 971  * \private \memberof mlt_consumer_s
 972  * \param self a consumer
 973  */
 974
 975 static void consumer_read_ahead_start( mlt_consumer self )
 976 {
 977         // We're running now
 978         self->ahead = 1;
 979
 980         // Create the frame queue
 981         self->queue = mlt_deque_init( );
 982
 983         // Create the queue mutex
 984         pthread_mutex_init( &self->queue_mutex, NULL );
 985
 986         // Create the condition
 987         pthread_cond_init( &self->queue_cond, NULL );
 988
 989         // Create the read ahead
 990         if ( mlt_properties_get( MLT_CONSUMER_PROPERTIES( self ), "priority" ) )
 991         {
 992                 struct sched_param priority;
 993                 priority.sched_priority = mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( self ), "priority" );
 994                 pthread_attr_t thread_attributes;
 995                 pthread_attr_init( &thread_attributes );
 996                 pthread_attr_setschedpolicy( &thread_attributes, SCHED_OTHER );
 997                 pthread_attr_setschedparam( &thread_attributes, &priority );
 998                 pthread_attr_setinheritsched( &thread_attributes, PTHREAD_EXPLICIT_SCHED );
 999                 pthread_attr_setscope( &thread_attributes, PTHREAD_SCOPE_SYSTEM );
1000                 if ( pthread_create( &self->ahead_thread, &thread_attributes, consumer_read_ahead_thread, self ) < 0 )
1001                         pthread_create( &self->ahead_thread, NULL, consumer_read_ahead_thread, self );
1002                 pthread_attr_destroy( &thread_attributes );
1003         }
1004         else
1005         {
1006                 pthread_create( &self->ahead_thread, NULL, consumer_read_ahead_thread, self );
1007         }
1008         self->started = 1;
1009 }
1010
1011 /** Start the worker threads.
1012  *
1013  * \private \memberof mlt_consumer_s
1014  * \param self a consumer
1015  */
1016
1017 static void consumer_work_start( mlt_consumer self )
1018 {
1019         int n = abs( self->real_time );
1020         pthread_t *thread = calloc( 1, sizeof( pthread_t ) * n );
1021
1022         // We're running now
1023         self->ahead = 1;
1024         self->threads = thread;
1025
1026         // These keep track of the accelleration of frame dropping or recovery.
1027         self->consecutive_dropped = 0;
1028         self->consecutive_rendered = 0;
1029
1030         // This is the position in the queue from which to look for a frame to process.
1031         // If we always start from the head, then we may likely not complete processing
1032         // before the frame is played out.
1033         self->process_head = 0;
1034
1035         // Create the queues
1036         self->queue = mlt_deque_init();
1037         self->worker_threads = mlt_deque_init();
1038
1039         // Create the mutexes
1040         pthread_mutex_init( &self->queue_mutex, NULL );
1041         pthread_mutex_init( &self->done_mutex, NULL );
1042
1043         // Create the conditions
1044         pthread_cond_init( &self->queue_cond, NULL );
1045         pthread_cond_init( &self->done_cond, NULL );
1046
1047         // Create the read ahead
1048         if ( mlt_properties_get( MLT_CONSUMER_PROPERTIES( self ), "priority" ) )
1049         {
1050
1051                 struct sched_param priority;
1052                 pthread_attr_t thread_attributes;
1053
1054                 priority.sched_priority = mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( self ), "priority" );
1055                 pthread_attr_init( &thread_attributes );
1056                 pthread_attr_setschedpolicy( &thread_attributes, SCHED_OTHER );
1057                 pthread_attr_setschedparam( &thread_attributes, &priority );
1058                 pthread_attr_setinheritsched( &thread_attributes, PTHREAD_EXPLICIT_SCHED );
1059                 pthread_attr_setscope( &thread_attributes, PTHREAD_SCOPE_SYSTEM );
1060
1061                 while ( n-- )
1062                 {
1063                         if ( pthread_create( thread, &thread_attributes, consumer_worker_thread, self ) < 0 )
1064                                 if ( pthread_create( thread, NULL, consumer_worker_thread, self ) == 0 )
1065                                         mlt_deque_push_back( self->worker_threads, thread );
1066                         thread++;
1067                 }
1068                 pthread_attr_destroy( &thread_attributes );
1069         }
1070
1071         else
1072         {
1073                 while ( n-- )
1074                 {
1075                         if ( pthread_create( thread, NULL, consumer_worker_thread, self ) == 0 )
1076                                 mlt_deque_push_back( self->worker_threads, thread );
1077                         thread++;
1078                 }
1079         }
1080         self->started = 1;
1081 }
1082
1083 /** Stop the read/render thread.
1084  *
1085  * \private \memberof mlt_consumer_s
1086  * \param self a consumer
1087  */
1088
1089 static void consumer_read_ahead_stop( mlt_consumer self )
1090 {
1091         // Make sure we're running
1092         if ( self->started )
1093         {
1094                 // Inform thread to stop
1095                 self->ahead = 0;
1096
1097                 // Broadcast to the condition in case it's waiting
1098                 pthread_mutex_lock( &self->queue_mutex );
1099                 pthread_cond_broadcast( &self->queue_cond );
1100                 pthread_mutex_unlock( &self->queue_mutex );
1101
1102                 // Broadcast to the put condition in case it's waiting
1103                 pthread_mutex_lock( &self->put_mutex );
1104                 pthread_cond_broadcast( &self->put_cond );
1105                 pthread_mutex_unlock( &self->put_mutex );
1106
1107                 // Join the thread
1108                 pthread_join( self->ahead_thread, NULL );
1109                 self->started = 0;
1110
1111                 // Destroy the frame queue mutex
1112                 pthread_mutex_destroy( &self->queue_mutex );
1113
1114                 // Destroy the condition
1115                 pthread_cond_destroy( &self->queue_cond );
1116
1117                 // Wipe the queue
1118                 while ( mlt_deque_count( self->queue ) )
1119                         mlt_frame_close( mlt_deque_pop_back( self->queue ) );
1120
1121                 // Close the queue
1122                 mlt_deque_close( self->queue );
1123         }
1124 }
1125
1126 /** Stop the worker threads.
1127  *
1128  * \private \memberof mlt_consumer_s
1129  * \param self a consumer
1130  */
1131
1132 static void consumer_work_stop( mlt_consumer self )
1133 {
1134         // Make sure we're running
1135         if ( self->started )
1136         {
1137                 // Inform thread to stop
1138                 self->ahead = 0;
1139
1140                 // Broadcast to the queue condition in case it's waiting
1141                 pthread_mutex_lock( &self->queue_mutex );
1142                 pthread_cond_broadcast( &self->queue_cond );
1143                 pthread_mutex_unlock( &self->queue_mutex );
1144
1145                 // Broadcast to the put condition in case it's waiting
1146                 pthread_mutex_lock( &self->put_mutex );
1147                 pthread_cond_broadcast( &self->put_cond );
1148                 pthread_mutex_unlock( &self->put_mutex );
1149
1150                 // Broadcast to the done condition in case it's waiting
1151                 pthread_mutex_lock( &self->done_mutex );
1152                 pthread_cond_broadcast( &self->done_cond );
1153                 pthread_mutex_unlock( &self->done_mutex );
1154
1155                 // Join the threads
1156                 pthread_t *thread;
1157                 while ( ( thread = mlt_deque_pop_back( self->worker_threads ) ) )
1158                         pthread_join( *thread, NULL );
1159
1160                 // Deallocate the array of threads
1161                 if ( self->threads )
1162                         free( self->threads );
1163
1164                 // Indicate that worker threads no longer running
1165                 self->started = 0;
1166
1167                 // Destroy the mutexes
1168                 pthread_mutex_destroy( &self->queue_mutex );
1169                 pthread_mutex_destroy( &self->done_mutex );
1170
1171                 // Destroy the conditions
1172                 pthread_cond_destroy( &self->queue_cond );
1173                 pthread_cond_destroy( &self->done_cond );
1174
1175                 // Wipe the queues
1176                 while ( mlt_deque_count( self->queue ) )
1177                         mlt_frame_close( mlt_deque_pop_back( self->queue ) );
1178
1179                 // Close the queues
1180                 mlt_deque_close( self->queue );
1181                 mlt_deque_close( self->worker_threads );
1182         }
1183 }
1184
1185 /** Flush the read/render thread's buffer.
1186  *
1187  * \public \memberof mlt_consumer_s
1188  * \param self a consumer
1189  */
1190
1191 void mlt_consumer_purge( mlt_consumer self )
1192 {
1193         if ( self && self->ahead )
1194         {
1195                 pthread_mutex_lock( &self->queue_mutex );
1196                 while ( mlt_deque_count( self->queue ) )
1197                         mlt_frame_close( mlt_deque_pop_back( self->queue ) );
1198                 pthread_cond_broadcast( &self->queue_cond );
1199                 pthread_mutex_unlock( &self->queue_mutex );
1200         }
1201 }
1202
1203 /** Use multiple worker threads and a work queue.
1204  */
1205
1206 static mlt_frame worker_get_frame( mlt_consumer self, mlt_properties properties )
1207 {
1208         // Frame to return
1209         mlt_frame frame = NULL;
1210
1211         double fps = mlt_properties_get_double( properties, "fps" );
1212         int threads = abs( self->real_time );
1213         int buffer = mlt_properties_get_int( properties, "_buffer" );
1214         buffer = buffer > 0 ? buffer : mlt_properties_get_int( properties, "buffer" );
1215         // This is a heuristic to determine a suitable minimum buffer size for the number of threads.
1216         int headroom = 2 + threads * threads;
1217         buffer = buffer < headroom ? headroom : buffer;
1218
1219         // Start worker threads if not already started.
1220         if ( ! self->ahead )
1221         {
1222                 int prefill = mlt_properties_get_int( properties, "prefill" );
1223                 prefill = prefill > 0 && prefill < buffer ? prefill : buffer;
1224
1225                 consumer_work_start( self );
1226
1227                 // Fill the work queue.
1228                 int i = buffer;
1229                 while ( self->ahead && i-- )
1230                 {
1231                         frame = mlt_consumer_get_frame( self );
1232                         if ( frame )
1233                         {
1234                                 pthread_mutex_lock( &self->queue_mutex );
1235                                 mlt_deque_push_back( self->queue, frame );
1236                                 pthread_cond_signal( &self->queue_cond );
1237                                 pthread_mutex_unlock( &self->queue_mutex );
1238                         }
1239                 }
1240
1241                 // Wait for prefill
1242                 while ( self->ahead && first_unprocessed_frame( self ) < prefill )
1243                 {
1244                         pthread_mutex_lock( &self->done_mutex );
1245                         pthread_cond_wait( &self->done_cond, &self->done_mutex );
1246                         pthread_mutex_unlock( &self->done_mutex );
1247                 }
1248                 self->process_head = threads;
1249         }
1250
1251 //      mlt_log_verbose( MLT_CONSUMER_SERVICE(self), "size %d done count %d work count %d process_head %d\n",
1252 //              threads, first_unprocessed_frame( self ), mlt_deque_count( self->queue ), self->process_head );
1253
1254         // Feed the work queue
1255         while ( self->ahead && mlt_deque_count( self->queue ) < buffer )
1256         {
1257                 frame = mlt_consumer_get_frame( self );
1258                 if ( ! frame )
1259                         return frame;
1260                 pthread_mutex_lock( &self->queue_mutex );
1261                 mlt_deque_push_back( self->queue, frame );
1262                 pthread_cond_signal( &self->queue_cond );
1263                 pthread_mutex_unlock( &self->queue_mutex );
1264         }
1265
1266         // Wait if not realtime.
1267         mlt_frame head_frame = MLT_FRAME( mlt_deque_peek_front( self->queue ) );
1268         while ( self->ahead && self->real_time < 0 &&
1269                 !( head_frame && mlt_properties_get_int( MLT_FRAME_PROPERTIES( head_frame ), "rendered" ) ) )
1270         {
1271                 pthread_mutex_lock( &self->done_mutex );
1272                 pthread_cond_wait( &self->done_cond, &self->done_mutex );
1273                 pthread_mutex_unlock( &self->done_mutex );
1274         }
1275
1276         // Get the frame from the queue.
1277         pthread_mutex_lock( &self->queue_mutex );
1278         frame = mlt_deque_pop_front( self->queue );
1279         pthread_mutex_unlock( &self->queue_mutex );
1280
1281         // Adapt the worker process head to the runtime conditions.
1282         if ( self->real_time > 0 )
1283         {
1284                 if ( frame && mlt_properties_get_int( MLT_FRAME_PROPERTIES( frame ), "rendered" ) )
1285                 {
1286                         self->consecutive_dropped = 0;
1287                         if ( self->process_head > threads && self->consecutive_rendered >= self->process_head )
1288                                 self->process_head--;
1289                         else
1290                                 self->consecutive_rendered++;
1291                 }
1292                 else
1293                 {
1294                         self->consecutive_rendered = 0;
1295                         if ( self->process_head < buffer - threads && self->consecutive_dropped > threads )
1296                                 self->process_head++;
1297                         else
1298                                 self->consecutive_dropped++;
1299                 }
1300 //              mlt_log_verbose( MLT_CONSUMER_SERVICE(self), "dropped %d rendered %d process_head %d\n",
1301 //                      self->consecutive_dropped, self->consecutive_rendered, self->process_head );
1302
1303                 // Check for too many consecutively dropped frames
1304                 if ( self->consecutive_dropped > mlt_properties_get_int( properties, "drop_max" ) )
1305                 {
1306                         int orig_buffer = mlt_properties_get_int( properties, "buffer" );
1307                         int prefill = mlt_properties_get_int( properties, "prefill" );
1308                         mlt_log_verbose( self, "too many frames dropped - " );
1309
1310                         // If using a default low-latency buffer level (SDL) and below the limit
1311                         if ( ( orig_buffer == 1 || prefill == 1 ) && buffer < (threads + 1) * 10 )
1312                         {
1313                                 // Auto-scale the buffer to compensate
1314                                 mlt_log_verbose( self, "increasing buffer to %d\n", buffer + threads );
1315                                 mlt_properties_set_int( properties, "_buffer", buffer + threads );
1316                                 self->consecutive_dropped = fps / 2;
1317                         }
1318                         else
1319                         {
1320                                 // Tell the consumer to render it
1321                                 mlt_log_verbose( self, "forcing next frame\n" );
1322                                 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "rendered", 1 );
1323                                 self->consecutive_dropped = 0;
1324                         }
1325                 }
1326         }
1327
1328         return frame;
1329 }
1330
1331 /** Get the next frame from the producer connected to a consumer.
1332  *
1333  * Typically, one uses this instead of \p mlt_consumer_get_frame to make
1334  * the asynchronous/real-time behavior configurable at runtime.
1335  * You should close the frame returned from this when you are done with it.
1336  *
1337  * \public \memberof mlt_consumer_s
1338  * \param self a consumer
1339  * \return a frame
1340  */
1341
1342 mlt_frame mlt_consumer_rt_frame( mlt_consumer self )
1343 {
1344         // Frame to return
1345         mlt_frame frame = NULL;
1346
1347         // Get the properties
1348         mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
1349
1350         // Check if the user has requested real time or not
1351         if ( self->real_time > 1 || self->real_time < -1 )
1352         {
1353                 // see above
1354                 return worker_get_frame( self, properties );
1355         }
1356         else if ( self->real_time == 1 || self->real_time == -1 )
1357         {
1358                 int size = 1;
1359
1360                 // Is the read ahead running?
1361                 if ( self->ahead == 0 )
1362                 {
1363                         int buffer = mlt_properties_get_int( properties, "buffer" );
1364                         int prefill = mlt_properties_get_int( properties, "prefill" );
1365                         consumer_read_ahead_start( self );
1366                         if ( buffer > 1 )
1367                                 size = prefill > 0 && prefill < buffer ? prefill : buffer;
1368                 }
1369
1370                 // Get frame from queue
1371                 pthread_mutex_lock( &self->queue_mutex );
1372                 while( self->ahead && mlt_deque_count( self->queue ) < size )
1373                         pthread_cond_wait( &self->queue_cond, &self->queue_mutex );
1374                 frame = mlt_deque_pop_front( self->queue );
1375                 pthread_cond_broadcast( &self->queue_cond );
1376                 pthread_mutex_unlock( &self->queue_mutex );
1377         }
1378         else // real_time == 0
1379         {
1380                 // Get the frame in non real time
1381                 frame = mlt_consumer_get_frame( self );
1382
1383                 // This isn't true, but from the consumers perspective it is
1384                 if ( frame != NULL )
1385                         mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "rendered", 1 );
1386         }
1387
1388         return frame;
1389 }
1390
1391 /** Callback for the implementation to indicate a stopped condition.
1392  *
1393  * \public \memberof mlt_consumer_s
1394  * \param self a consumer
1395  */
1396
1397 void mlt_consumer_stopped( mlt_consumer self )
1398 {
1399         mlt_properties_set_int( MLT_CONSUMER_PROPERTIES( self ), "running", 0 );
1400         mlt_events_fire( MLT_CONSUMER_PROPERTIES( self ), "consumer-stopped", NULL );
1401         mlt_event_unblock( self->event_listener );
1402 }
1403
1404 /** Stop the consumer.
1405  *
1406  * \public \memberof mlt_consumer_s
1407  * \param self a consumer
1408  * \return true if there was an error
1409  */
1410
1411 int mlt_consumer_stop( mlt_consumer self )
1412 {
1413         // Get the properies
1414         mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
1415
1416         // Just in case...
1417         mlt_log( MLT_CONSUMER_SERVICE( self ), MLT_LOG_DEBUG, "stopping put waiting\n" );
1418         pthread_mutex_lock( &self->put_mutex );
1419         self->put_active = 0;
1420         pthread_cond_broadcast( &self->put_cond );
1421         pthread_mutex_unlock( &self->put_mutex );
1422
1423         // Stop the consumer
1424         mlt_log( MLT_CONSUMER_SERVICE( self ), MLT_LOG_DEBUG, "stopping consumer\n" );
1425
1426         // Cancel the read ahead threads
1427         self->ahead = 0;
1428         if ( self->started )
1429         {
1430                 // Unblock the consumer calling mlt_consumer_rt_frame
1431                 pthread_mutex_lock( &self->queue_mutex );
1432                 pthread_cond_broadcast( &self->queue_cond );
1433                 pthread_mutex_unlock( &self->queue_mutex );
1434         }
1435
1436         // Invoke the child callback
1437         if ( self->stop != NULL )
1438                 self->stop( self );
1439
1440         // Check if the user has requested real time or not and stop if necessary
1441         mlt_log( MLT_CONSUMER_SERVICE( self ), MLT_LOG_DEBUG, "stopping read_ahead\n" );
1442         if ( abs( self->real_time ) == 1 )
1443                 consumer_read_ahead_stop( self );
1444         else if ( abs( self->real_time ) > 1 )
1445                 consumer_work_stop( self );
1446
1447         // Kill the test card
1448         mlt_properties_set_data( properties, "test_card_producer", NULL, 0, NULL, NULL );
1449
1450         // Check and run a post command
1451         if ( mlt_properties_get( properties, "post" ) )
1452                 if (system( mlt_properties_get( properties, "post" ) ) == -1 )
1453                         mlt_log( MLT_CONSUMER_SERVICE( self ), MLT_LOG_ERROR, "system(%s) failed!\n", mlt_properties_get( properties, "post" ) );
1454
1455         mlt_log( MLT_CONSUMER_SERVICE( self ), MLT_LOG_DEBUG, "stopped\n" );
1456
1457         return 0;
1458 }
1459
1460 /** Determine if the consumer is stopped.
1461  *
1462  * \public \memberof mlt_consumer_s
1463  * \param self a consumer
1464  * \return true if the consumer is stopped
1465  */
1466
1467 int mlt_consumer_is_stopped( mlt_consumer self )
1468 {
1469         // Check if the consumer is stopped
1470         if ( self && self->is_stopped )
1471                 return self->is_stopped( self );
1472
1473         return 0;
1474 }
1475
1476 /** Close and destroy the consumer.
1477  *
1478  * \public \memberof mlt_consumer_s
1479  * \param self a consumer
1480  */
1481
1482 void mlt_consumer_close( mlt_consumer self )
1483 {
1484         if ( self != NULL && mlt_properties_dec_ref( MLT_CONSUMER_PROPERTIES( self ) ) <= 0 )
1485         {
1486                 // Get the childs close function
1487                 void ( *consumer_close )( ) = self->close;
1488
1489                 if ( consumer_close )
1490                 {
1491                         // Just in case...
1492                         //mlt_consumer_stop( self );
1493
1494                         self->close = NULL;
1495                         consumer_close( self );
1496                 }
1497                 else
1498                 {
1499                         // Make sure it only gets called once
1500                         self->parent.close = NULL;
1501
1502                         // Destroy the push mutex and condition
1503                         pthread_mutex_destroy( &self->put_mutex );
1504                         pthread_cond_destroy( &self->put_cond );
1505
1506                         mlt_service_close( &self->parent );
1507                 }
1508         }
1509 }
1510
1511 /** Get the position of the last frame shown.
1512  *
1513  * \public \memberof mlt_consumer_s
1514  * \param consumer a consumer
1515  * \return the position
1516  */
1517
1518 mlt_position mlt_consumer_position( mlt_consumer consumer )
1519 {
1520         return consumer->position;
1521 }
1522