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                 // Default to environment test card
  82                 mlt_properties_set( properties, "test_card", mlt_environment( "MLT_TEST_CARD" ) );
  83
  84                 // Hmm - default all consumers to yuv422 :-/
  85                 this->format = mlt_image_yuv422;
  86         }
  87         return error;
  88 }
  89
  90 /** Create a new consumer.
  91 */
  92
  93 mlt_consumer mlt_consumer_new( )
  94 {
  95         // Create the memory for the structure
  96         mlt_consumer this = malloc( sizeof( struct mlt_consumer_s ) );
  97
  98         // Initialise it
  99         if ( this != NULL )
 100                 mlt_consumer_init( this, NULL );
 101
 102         // Return it
 103         return this;
 104 }
 105
 106 /** Get the parent service object.
 107 */
 108
 109 mlt_service mlt_consumer_service( mlt_consumer this )
 110 {
 111         return &this->parent;
 112 }
 113
 114 /** Get the consumer properties.
 115 */
 116
 117 mlt_properties mlt_consumer_properties( mlt_consumer this )
 118 {
 119         return mlt_service_properties( &this->parent );
 120 }
 121
 122 /** Connect the consumer to the producer.
 123 */
 124
 125 int mlt_consumer_connect( mlt_consumer this, mlt_service producer )
 126 {
 127         return mlt_service_connect_producer( &this->parent, producer, 0 );
 128 }
 129
 130 /** Start the consumer.
 131 */
 132
 133 int mlt_consumer_start( mlt_consumer this )
 134 {
 135         // Get the properies
 136         mlt_properties properties = mlt_consumer_properties( this );
 137
 138         // Determine if there's a test card producer
 139         char *test_card = mlt_properties_get( properties, "test_card" );
 140
 141         // Deal with it now.
 142         if ( test_card != NULL )
 143         {
 144                 if ( mlt_properties_get_data( properties, "test_card_producer", NULL ) == NULL )
 145                 {
 146                         // Create a test card producer
 147                         mlt_producer producer = mlt_factory_producer( NULL, test_card );
 148
 149                         // Do we have a producer
 150                         if ( producer != NULL )
 151                         {
 152                                 // Test card should loop I guess...
 153                                 mlt_properties_set( mlt_producer_properties( producer ), "eof", "loop" );
 154
 155                                 // Set the test card on the consumer
 156                                 mlt_properties_set_data( properties, "test_card_producer", producer, 0, ( mlt_destructor )mlt_producer_close, NULL );
 157                         }
 158
 159                         // Check and run an ante command
 160                         if ( mlt_properties_get( properties, "ante" ) )
 161                                 system( mlt_properties_get( properties, "ante" ) );
 162                 }
 163         }
 164         else
 165         {
 166                 // Allow the hash table to speed things up
 167                 mlt_properties_set_data( properties, "test_card_producer", NULL, 0, NULL, NULL );
 168         }
 169
 170         // Set the real_time preference
 171         this->real_time = mlt_properties_get_int( properties, "real_time" );
 172
 173         // Start the service
 174         if ( this->start != NULL )
 175                 return this->start( this );
 176
 177         return 0;
 178 }
 179
 180 /** Protected method for consumer to get frames from connected service
 181 */
 182
 183 mlt_frame mlt_consumer_get_frame( mlt_consumer this )
 184 {
 185         // Frame to return
 186         mlt_frame frame = NULL;
 187
 188         // Get the service assoicated to the consumer
 189         mlt_service service = mlt_consumer_service( this );
 190
 191         // Get the frame
 192         if ( mlt_service_get_frame( service, &frame, 0 ) == 0 )
 193         {
 194                 // Get the consumer properties
 195                 mlt_properties properties = mlt_consumer_properties( this );
 196
 197                 // Get the frame properties
 198                 mlt_properties frame_properties = mlt_frame_properties( frame );
 199
 200                 // Get the test card producer
 201                 mlt_producer test_card = mlt_properties_get_data( properties, "test_card_producer", NULL );
 202
 203                 // Attach the test frame producer to it.
 204                 if ( test_card != NULL )
 205                         mlt_properties_set_data( frame_properties, "test_card_producer", test_card, 0, NULL, NULL );
 206
 207                 // Attach the rescale property
 208                 mlt_properties_set( frame_properties, "rescale.interp", mlt_properties_get( properties, "rescale" ) );
 209
 210                 // Aspect ratio and other jiggery pokery
 211                 mlt_properties_set_double( frame_properties, "consumer_aspect_ratio", mlt_properties_get_double( properties, "aspect_ratio" ) );
 212                 mlt_properties_set_int( frame_properties, "consumer_progressive", mlt_properties_get_int( properties, "progressive" ) );
 213                 mlt_properties_set_int( frame_properties, "consumer_deinterlace", mlt_properties_get_int( properties, "deinterlace" ) );
 214         }
 215
 216         // Return the frame
 217         return frame;
 218 }
 219
 220 static inline long time_difference( struct timeval *time1 )
 221 {
 222         struct timeval time2;
 223         time2.tv_sec = time1->tv_sec;
 224         time2.tv_usec = time1->tv_usec;
 225         gettimeofday( time1, NULL );
 226         return time1->tv_sec * 1000000 + time1->tv_usec - time2.tv_sec * 1000000 - time2.tv_usec;
 227 }
 228
 229 static void *consumer_read_ahead_thread( void *arg )
 230 {
 231         // The argument is the consumer
 232         mlt_consumer this = arg;
 233
 234         // Get the properties of the consumer
 235         mlt_properties properties = mlt_consumer_properties( this );
 236
 237         // Get the width and height
 238         int width = mlt_properties_get_int( properties, "width" );
 239         int height = mlt_properties_get_int( properties, "height" );
 240
 241         // Get the maximum size of the buffer
 242         int buffer = mlt_properties_get_int( properties, "buffer" );
 243
 244         // General frame variable
 245         mlt_frame frame = NULL;
 246         uint8_t *image = NULL;
 247
 248         // Time structures
 249         struct timeval ante;
 250
 251         // Average time for get_frame and get_image
 252         int count = 1;
 253         int skipped = 0;
 254         int64_t time_wait = 0;
 255         int64_t time_frame = 0;
 256         int64_t time_image = 0;
 257
 258         // Get the first frame
 259         frame = mlt_consumer_get_frame( this );
 260
 261         // Get the image of the first frame
 262         mlt_frame_get_image( frame, &image, &this->format, &width, &height, 0 );
 263         mlt_properties_set_int( mlt_frame_properties( frame ), "rendered", 1 );
 264
 265         // Get the starting time (can ignore the times above)
 266         gettimeofday( &ante, NULL );
 267
 268         // Continue to read ahead
 269         while ( this->ahead )
 270         {
 271                 // Put the current frame into the queue
 272                 time_difference( &ante );
 273                 pthread_mutex_lock( &this->mutex );
 274                 while( this->ahead && mlt_deque_count( this->queue ) >= buffer )
 275                         pthread_cond_wait( &this->cond, &this->mutex );
 276                 mlt_deque_push_back( this->queue, frame );
 277                 pthread_cond_broadcast( &this->cond );
 278                 pthread_mutex_unlock( &this->mutex );
 279                 time_wait = time_difference( &ante );
 280
 281                 // Get the next frame
 282                 frame = mlt_consumer_get_frame( this );
 283                 time_frame += time_difference( &ante );
 284
 285                 // Increment the count
 286                 count ++;
 287
 288                 // All non normal playback frames should be shown
 289                 if ( mlt_properties_get_int( mlt_frame_properties( frame ), "_speed" ) != 1 )
 290                 {
 291                         skipped = 0;
 292                         time_frame = 0;
 293                         time_image = 0;
 294                         count = 1;
 295                 }
 296
 297                 // Get the image
 298                 if ( ( time_frame + time_image ) / count < 40000 )
 299                 {
 300                         // Get the image, mark as rendered and time it
 301                         mlt_frame_get_image( frame, &image, &this->format, &width, &height, 0 );
 302                         mlt_properties_set_int( mlt_frame_properties( frame ), "rendered", 1 );
 303                         time_image += time_difference( &ante );
 304
 305                         // Reset the skipped count
 306                         skipped = 0;
 307                 }
 308                 else
 309                 {
 310                         // Increment the number of sequentially skipped frames
 311                         skipped ++;
 312
 313                         // If we've reached an unacceptable level, reset everything
 314                         if ( skipped > 10 )
 315                         {
 316                                 skipped = 0;
 317                                 time_frame = 0;
 318                                 time_image = 0;
 319                                 count = 0;
 320                         }
 321                 }
 322         }
 323
 324         // Remove the last frame
 325         mlt_frame_close( frame );
 326
 327         return NULL;
 328 }
 329
 330 static void consumer_read_ahead_start( mlt_consumer this )
 331 {
 332         pthread_attr_t thread_attributes;
 333
 334         // We're running now
 335         this->ahead = 1;
 336
 337         // Create the frame queue
 338         this->queue = mlt_deque_init( );
 339
 340         // Create the mutex
 341         pthread_mutex_init( &this->mutex, NULL );
 342
 343         // Create the condition
 344         pthread_cond_init( &this->cond, NULL );
 345
 346         // Inherit the scheduling priority
 347         pthread_attr_init( &thread_attributes );
 348         pthread_attr_setinheritsched( &thread_attributes, PTHREAD_INHERIT_SCHED );
 349
 350         // Create the read ahead
 351         pthread_create( &this->ahead_thread, &thread_attributes, consumer_read_ahead_thread, this );
 352 }
 353
 354 static void consumer_read_ahead_stop( mlt_consumer this )
 355 {
 356         // Make sure we're running
 357         if ( this->ahead )
 358         {
 359                 // Inform thread to stop
 360                 this->ahead = 0;
 361
 362                 // Broadcast to the condition in case it's waiting
 363                 pthread_mutex_lock( &this->mutex );
 364                 pthread_cond_broadcast( &this->cond );
 365                 pthread_mutex_unlock( &this->mutex );
 366
 367                 // Join the thread
 368                 pthread_join( this->ahead_thread, NULL );
 369
 370                 // Destroy the mutex
 371                 pthread_mutex_destroy( &this->mutex );
 372
 373                 // Destroy the condition
 374                 pthread_cond_destroy( &this->cond );
 375
 376                 // Wipe the queue
 377                 while ( mlt_deque_count( this->queue ) )
 378                         mlt_frame_close( mlt_deque_pop_back( this->queue ) );
 379
 380                 // Close the queue
 381                 mlt_deque_close( this->queue );
 382         }
 383 }
 384
 385 mlt_frame mlt_consumer_rt_frame( mlt_consumer this )
 386 {
 387         // Frame to return
 388         mlt_frame frame = NULL;
 389
 390         // Get the properties
 391         mlt_properties properties = mlt_consumer_properties( this );
 392
 393         // Check if the user has requested real time or not
 394         if ( this->real_time )
 395         {
 396                 int size = 1;
 397
 398                 // Is the read ahead running?
 399                 if ( this->ahead == 0 )
 400                 {
 401                         int buffer = mlt_properties_get_int( properties, "buffer" );
 402                         consumer_read_ahead_start( this );
 403                         if ( buffer > 1 )
 404                                 size = buffer;
 405                 }
 406
 407                 // Get frame from queue
 408                 pthread_mutex_lock( &this->mutex );
 409                 while( this->ahead && mlt_deque_count( this->queue ) < size )
 410                         pthread_cond_wait( &this->cond, &this->mutex );
 411                 frame = mlt_deque_pop_front( this->queue );
 412                 pthread_cond_broadcast( &this->cond );
 413                 pthread_mutex_unlock( &this->mutex );
 414         }
 415         else
 416         {
 417                 // Get the frame in non real time
 418                 frame = mlt_consumer_get_frame( this );
 419
 420                 // This isn't true, but from the consumers perspective it is
 421                 mlt_properties_set_int( mlt_frame_properties( frame ), "rendered", 1 );
 422         }
 423
 424         return frame;
 425 }
 426
 427 /** Stop the consumer.
 428 */
 429
 430 int mlt_consumer_stop( mlt_consumer this )
 431 {
 432         // Get the properies
 433         mlt_properties properties = mlt_consumer_properties( this );
 434
 435         // Stop the consumer
 436         if ( this->stop != NULL )
 437                 this->stop( this );
 438
 439         // Check if the user has requested real time or not and stop if necessary
 440         if ( mlt_properties_get_int( properties, "real_time" ) )
 441                 consumer_read_ahead_stop( this );
 442
 443         // Kill the test card
 444         mlt_properties_set_data( properties, "test_card_producer", NULL, 0, NULL, NULL );
 445
 446         // Check and run a post command
 447         if ( mlt_properties_get( properties, "post" ) )
 448                 system( mlt_properties_get( properties, "post" ) );
 449
 450         return 0;
 451 }
 452
 453 /** Determine if the consumer is stopped.
 454 */
 455
 456 int mlt_consumer_is_stopped( mlt_consumer this )
 457 {
 458         // Check if the consumer is stopped
 459         if ( this->is_stopped != NULL )
 460                 return this->is_stopped( this );
 461
 462         return 0;
 463 }
 464
 465 /** Close the consumer.
 466 */
 467
 468 void mlt_consumer_close( mlt_consumer this )
 469 {
 470         // Get the childs close function
 471         void ( *consumer_close )( ) = this->close;
 472
 473         // Make sure it only gets called once
 474         this->close = NULL;
 475
 476         // Call the childs close if available
 477         if ( consumer_close != NULL )
 478                 consumer_close( this );
 479         else
 480                 mlt_service_close( &this->parent );
 481 }