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

   1 /*
   2  * mlt_consumer.c -- abstraction for all consumer services
   3  * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
   4  * Author: Charles Yates <charles.yates@pandora.be>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  19  */
  20
  21 #include "config.h"
  22 #include "mlt_consumer.h"
  23 #include "mlt_factory.h"
  24 #include "mlt_producer.h"
  25 #include "mlt_frame.h"
  26 #include <stdio.h>
  27 #include <string.h>
  28 #include <stdlib.h>
  29 #include <sys/time.h>
  30
  31 /** Public final methods
  32 */
  33
  34 int mlt_consumer_init( mlt_consumer this, void *child )
  35 {
  36         int error = 0;
  37         memset( this, 0, sizeof( struct mlt_consumer_s ) );
  38         this->child = child;
  39         error = mlt_service_init( &this->parent, this );
  40         if ( error == 0 )
  41         {
  42                 // Get the properties from the service
  43                 mlt_properties properties = mlt_service_properties( &this->parent );
  44
  45                 // Get the normalisation preference
  46                 char *normalisation = mlt_environment( "MLT_NORMALISATION" );
  47
  48                 // Deal with normalisation
  49                 if ( normalisation == NULL || strcmp( normalisation, "NTSC" ) )
  50                 {
  51                         mlt_properties_set( properties, "normalisation", "PAL" );
  52                         mlt_properties_set_double( properties, "fps", 25.0 );
  53                         mlt_properties_set_int( properties, "width", 720 );
  54                         mlt_properties_set_int( properties, "height", 576 );
  55                         mlt_properties_set_int( properties, "progressive", 0 );
  56                         mlt_properties_set_double( properties, "aspect_ratio", 128.0 / 117.0 );
  57                 }
  58                 else
  59                 {
  60                         mlt_properties_set( properties, "normalisation", "NTSC" );
  61                         mlt_properties_set_double( properties, "fps", 30000.0 / 1001.0 );
  62                         mlt_properties_set_int( properties, "width", 720 );
  63                         mlt_properties_set_int( properties, "height", 480 );
  64                         mlt_properties_set_int( properties, "progressive", 0 );
  65                         mlt_properties_set_double( properties, "aspect_ratio", 72.0 / 79.0 );
  66                 }
  67
  68                 // Default rescaler for all consumers
  69                 mlt_properties_set( properties, "rescale", "bilinear" );
  70
  71                 // Default read ahead buffer size
  72                 mlt_properties_set_int( properties, "buffer", 25 );
  73
  74                 // Default audio frequency and channels
  75                 mlt_properties_set_int( properties, "frequency", 48000 );
  76                 mlt_properties_set_int( properties, "channels", 2 );
  77
  78                 // Default of all consumers is real time
  79                 mlt_properties_set_int( properties, "real_time", 1 );
  80
  81                 // Hmm - default all consumers to yuv422 :-/
  82                 this->format = mlt_image_yuv422;
  83         }
  84         return error;
  85 }
  86
  87 /** Create a new consumer.
  88 */
  89
  90 mlt_consumer mlt_consumer_new( )
  91 {
  92         // Create the memory for the structure
  93         mlt_consumer this = malloc( sizeof( struct mlt_consumer_s ) );
  94
  95         // Initialise it
  96         if ( this != NULL )
  97                 mlt_consumer_init( this, NULL );
  98
  99         // Return it
 100         return this;
 101 }
 102
 103 /** Get the parent service object.
 104 */
 105
 106 mlt_service mlt_consumer_service( mlt_consumer this )
 107 {
 108         return &this->parent;
 109 }
 110
 111 /** Get the consumer properties.
 112 */
 113
 114 mlt_properties mlt_consumer_properties( mlt_consumer this )
 115 {
 116         return mlt_service_properties( &this->parent );
 117 }
 118
 119 /** Connect the consumer to the producer.
 120 */
 121
 122 int mlt_consumer_connect( mlt_consumer this, mlt_service producer )
 123 {
 124         return mlt_service_connect_producer( &this->parent, producer, 0 );
 125 }
 126
 127 /** Start the consumer.
 128 */
 129
 130 int mlt_consumer_start( mlt_consumer this )
 131 {
 132         // Get the properies
 133         mlt_properties properties = mlt_consumer_properties( this );
 134
 135         // Determine if there's a test card producer
 136         char *test_card = mlt_properties_get( properties, "test_card" );
 137
 138         // Deal with it now.
 139         if ( test_card != NULL )
 140         {
 141                 if ( mlt_properties_get_data( properties, "test_card_producer", NULL ) == NULL )
 142                 {
 143                         // Create a test card producer
 144                         // TODO: do we want to use fezzik here?
 145                         mlt_producer producer = mlt_factory_producer( "fezzik", test_card );
 146
 147                         // Do we have a producer
 148                         if ( producer != NULL )
 149                         {
 150                                 // Test card should loop I guess...
 151                                 mlt_properties_set( mlt_producer_properties( producer ), "eof", "loop" );
 152
 153                                 // Set the test card on the consumer
 154                                 mlt_properties_set_data( properties, "test_card_producer", producer, 0, ( mlt_destructor )mlt_producer_close, NULL );
 155                         }
 156
 157                         // Check and run an ante command
 158                         if ( mlt_properties_get( properties, "ante" ) )
 159                                 system( mlt_properties_get( properties, "ante" ) );
 160                 }
 161         }
 162         else
 163         {
 164                 // Allow the hash table to speed things up
 165                 mlt_properties_set_data( properties, "test_card_producer", NULL, 0, NULL, NULL );
 166         }
 167
 168         // Start the service
 169         if ( this->start != NULL )
 170                 return this->start( this );
 171
 172         return 0;
 173 }
 174
 175 /** Protected method :-/ for consumer to get frames from connected service
 176 */
 177
 178 mlt_frame mlt_consumer_get_frame( mlt_consumer this )
 179 {
 180         // Frame to return
 181         mlt_frame frame = NULL;
 182
 183         // Get the service assoicated to the consumer
 184         mlt_service service = mlt_consumer_service( this );
 185
 186         // Get the frame
 187         if ( mlt_service_get_frame( service, &frame, 0 ) == 0 )
 188         {
 189                 // Get the consumer properties
 190                 mlt_properties properties = mlt_consumer_properties( this );
 191
 192                 // Get the frame properties
 193                 mlt_properties frame_properties = mlt_frame_properties( frame );
 194
 195                 // Get the test card producer
 196                 mlt_producer test_card = mlt_properties_get_data( properties, "test_card_producer", NULL );
 197
 198                 // Attach the test frame producer to it.
 199                 if ( test_card != NULL )
 200                         mlt_properties_set_data( frame_properties, "test_card_producer", test_card, 0, NULL, NULL );
 201
 202                 // Attach the rescale property
 203                 mlt_properties_set( frame_properties, "rescale.interp", mlt_properties_get( properties, "rescale" ) );
 204
 205                 // Aspect ratio and other jiggery pokery
 206                 mlt_properties_set_double( frame_properties, "consumer_aspect_ratio", mlt_properties_get_double( properties, "aspect_ratio" ) );
 207                 mlt_properties_set_int( frame_properties, "consumer_progressive", mlt_properties_get_int( properties, "progressive" ) );
 208                 mlt_properties_set_int( frame_properties, "consumer_deinterlace", mlt_properties_get_int( properties, "deinterlace" ) );
 209         }
 210
 211         // Return the frame
 212         return frame;
 213 }
 214
 215 static inline long time_difference( struct timeval *time1 )
 216 {
 217         struct timeval time2;
 218         time2.tv_sec = time1->tv_sec;
 219         time2.tv_usec = time1->tv_usec;
 220         gettimeofday( time1, NULL );
 221         return time1->tv_sec * 1000000 + time1->tv_usec - time2.tv_sec * 1000000 - time2.tv_usec;
 222 }
 223
 224 static void *consumer_read_ahead_thread( void *arg )
 225 {
 226         // The argument is the consumer
 227         mlt_consumer this = arg;
 228
 229         // Get the properties of the consumer
 230         mlt_properties properties = mlt_consumer_properties( this );
 231
 232         // Get the width and height
 233         int width = mlt_properties_get_int( properties, "width" );
 234         int height = mlt_properties_get_int( properties, "height" );
 235
 236         // Get the maximum size of the buffer
 237         int buffer = mlt_properties_get_int( properties, "buffer" );
 238
 239         // General frame variable
 240         mlt_frame frame = NULL;
 241         uint8_t *image = NULL;
 242
 243         // Time structures
 244         struct timeval ante;
 245
 246         // Average time for get_frame and get_image
 247         int count = 1;
 248         int skipped = 0;
 249         int64_t time_wait = 0;
 250         int64_t time_frame = 0;
 251         int64_t time_image = 0;
 252
 253         // Get the first frame
 254         frame = mlt_consumer_get_frame( this );
 255
 256         // Get the image of the first frame
 257         mlt_frame_get_image( frame, &image, &this->format, &width, &height, 0 );
 258         mlt_properties_set_int( mlt_frame_properties( frame ), "rendered", 1 );
 259
 260         // Get the starting time (can ignore the times above)
 261         gettimeofday( &ante, NULL );
 262
 263         // Continue to read ahead
 264         while ( this->ahead )
 265         {
 266                 // Put the current frame into the queue
 267                 pthread_mutex_lock( &this->mutex );
 268                 while( this->ahead && mlt_deque_count( this->queue ) >= buffer )
 269                         pthread_cond_wait( &this->cond, &this->mutex );
 270                 mlt_deque_push_back( this->queue, frame );
 271                 pthread_cond_broadcast( &this->cond );
 272                 pthread_mutex_unlock( &this->mutex );
 273                 time_wait += time_difference( &ante );
 274
 275                 // Get the next frame
 276                 frame = mlt_consumer_get_frame( this );
 277                 time_frame += time_difference( &ante );
 278
 279                 // Increment the count
 280                 count ++;
 281
 282                 // Get the image
 283                 if ( ( time_frame + time_image ) / count < ( 40000 - ( time_wait / count ) ) )
 284                 {
 285                         // Get the image, mark as rendered and time it
 286                         mlt_frame_get_image( frame, &image, &this->format, &width, &height, 0 );
 287                         mlt_properties_set_int( mlt_frame_properties( frame ), "rendered", 1 );
 288                         time_image += time_difference( &ante );
 289
 290                         // Reset the skipped count
 291                         skipped = 0;
 292                 }
 293                 else
 294                 {
 295                         // Increment the number of sequentially skipped frames
 296                         skipped ++;
 297
 298                         // If we've reached an unacceptable level, reset everything
 299                         if ( skipped > 10 )
 300                         {
 301                                 skipped = 0;
 302                                 time_frame = 0;
 303                                 time_image = 0;
 304                                 time_wait = 0;
 305                                 count = 0;
 306                         }
 307                 }
 308         }
 309
 310         // Remove the last frame
 311         mlt_frame_close( frame );
 312
 313         return NULL;
 314 }
 315
 316 static void consumer_read_ahead_start( mlt_consumer this )
 317 {
 318         pthread_attr_t thread_attributes;
 319
 320         // We're running now
 321         this->ahead = 1;
 322
 323         // Create the frame queue
 324         this->queue = mlt_deque_init( );
 325
 326         // Create the mutex
 327         pthread_mutex_init( &this->mutex, NULL );
 328
 329         // Create the condition
 330         pthread_cond_init( &this->cond, NULL );
 331
 332         // Inherit the scheduling priority
 333         pthread_attr_init( &thread_attributes );
 334         pthread_attr_setinheritsched( &thread_attributes, PTHREAD_INHERIT_SCHED );
 335
 336         // Create the read ahead
 337         pthread_create( &this->ahead_thread, &thread_attributes, consumer_read_ahead_thread, this );
 338
 339 }
 340
 341 static void consumer_read_ahead_stop( mlt_consumer this )
 342 {
 343         // Make sure we're running
 344         if ( this->ahead )
 345         {
 346                 // Inform thread to stop
 347                 this->ahead = 0;
 348
 349                 // Broadcast to the condition in case it's waiting
 350                 pthread_mutex_lock( &this->mutex );
 351                 pthread_cond_broadcast( &this->cond );
 352                 pthread_mutex_unlock( &this->mutex );
 353
 354                 // Join the thread
 355                 pthread_join( this->ahead_thread, NULL );
 356
 357                 // Destroy the mutex
 358                 pthread_mutex_destroy( &this->mutex );
 359
 360                 // Destroy the condition
 361                 pthread_cond_destroy( &this->cond );
 362
 363                 // Wipe the queue
 364                 while ( mlt_deque_count( this->queue ) )
 365                         mlt_frame_close( mlt_deque_pop_back( this->queue ) );
 366         }
 367 }
 368
 369 mlt_frame mlt_consumer_rt_frame( mlt_consumer this )
 370 {
 371         // Frame to return
 372         mlt_frame frame = NULL;
 373
 374         // Get the properties
 375         mlt_properties properties = mlt_consumer_properties( this );
 376
 377         // Check if the user has requested real time or not
 378         if ( mlt_properties_get_int( properties, "real_time" ) )
 379         {
 380                 int size = 1;
 381
 382                 // Is the read ahead running?
 383                 if ( this->ahead == 0 )
 384                 {
 385                         int buffer = mlt_properties_get_int( properties, "buffer" );
 386                         consumer_read_ahead_start( this );
 387                         if ( buffer > 1 )
 388                                 size = buffer / 2;
 389                 }
 390
 391                 // Get frame from queue
 392                 pthread_mutex_lock( &this->mutex );
 393                 while( this->ahead && mlt_deque_count( this->queue ) < size )
 394                         pthread_cond_wait( &this->cond, &this->mutex );
 395                 frame = mlt_deque_pop_front( this->queue );
 396                 pthread_cond_broadcast( &this->cond );
 397                 pthread_mutex_unlock( &this->mutex );
 398         }
 399         else
 400         {
 401                 // Get the frame in non real time
 402                 frame = mlt_consumer_get_frame( this );
 403
 404                 // This isn't true, but from the consumers perspective it is
 405                 mlt_properties_set_int( mlt_frame_properties( frame ), "rendered", 1 );
 406         }
 407
 408         return frame;
 409 }
 410
 411 /** Stop the consumer.
 412 */
 413
 414 int mlt_consumer_stop( mlt_consumer this )
 415 {
 416         // Get the properies
 417         mlt_properties properties = mlt_consumer_properties( this );
 418
 419         // Stop the consumer
 420         if ( this->stop != NULL )
 421                 this->stop( this );
 422
 423         // Check if the user has requested real time or not and stop if necessary
 424         if ( mlt_properties_get_int( properties, "real_time" ) )
 425                 consumer_read_ahead_stop( this );
 426
 427         // Kill the test card
 428         mlt_properties_set_data( properties, "test_card_producer", NULL, 0, NULL, NULL );
 429
 430         // Check and run a post command
 431         if ( mlt_properties_get( properties, "post" ) )
 432                 system( mlt_properties_get( properties, "post" ) );
 433
 434         return 0;
 435 }
 436
 437 /** Determine if the consumer is stopped.
 438 */
 439
 440 int mlt_consumer_is_stopped( mlt_consumer this )
 441 {
 442         // Check if the consumer is stopped
 443         if ( this->is_stopped != NULL )
 444                 return this->is_stopped( this );
 445
 446         return 0;
 447 }
 448
 449 /** Close the consumer.
 450 */
 451
 452 void mlt_consumer_close( mlt_consumer this )
 453 {
 454         // Get the childs close function
 455         void ( *consumer_close )( ) = this->close;
 456
 457         // Make sure it only gets called once
 458         this->close = NULL;
 459
 460         // Call the childs close if available
 461         if ( consumer_close != NULL )
 462                 consumer_close( this );
 463         else
 464                 mlt_service_close( &this->parent );
 465 }