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>
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.
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.
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.
22 #include "mlt_consumer.h"
23 #include "mlt_factory.h"
24 #include "mlt_producer.h"
25 #include "mlt_frame.h"
31 static void mlt_consumer_frame_show( mlt_listener listener, mlt_properties owner, mlt_service this, void **args );
33 /** Public final methods
36 int mlt_consumer_init( mlt_consumer this, void *child )
39 memset( this, 0, sizeof( struct mlt_consumer_s ) );
41 error = mlt_service_init( &this->parent, this );
44 // Get the properties from the service
45 mlt_properties properties = MLT_SERVICE_PROPERTIES( &this->parent );
47 // Get the normalisation preference
48 char *normalisation = mlt_environment( "MLT_NORMALISATION" );
50 // Deal with normalisation
51 if ( normalisation == NULL || strcmp( normalisation, "NTSC" ) )
53 mlt_properties_set( properties, "normalisation", "PAL" );
54 mlt_properties_set_double( properties, "fps", 25.0 );
55 mlt_properties_set_int( properties, "width", 720 );
56 mlt_properties_set_int( properties, "height", 576 );
57 mlt_properties_set_int( properties, "progressive", 0 );
58 mlt_properties_set_double( properties, "aspect_ratio", 59.0 / 54.0 );
62 mlt_properties_set( properties, "normalisation", "NTSC" );
63 mlt_properties_set_double( properties, "fps", 30000.0 / 1001.0 );
64 mlt_properties_set_int( properties, "width", 720 );
65 mlt_properties_set_int( properties, "height", 480 );
66 mlt_properties_set_int( properties, "progressive", 0 );
67 mlt_properties_set_double( properties, "aspect_ratio", 10.0 / 11.0 );
70 // Default rescaler for all consumers
71 mlt_properties_set( properties, "rescale", "bilinear" );
73 // Default read ahead buffer size
74 mlt_properties_set_int( properties, "buffer", 25 );
76 // Default audio frequency and channels
77 mlt_properties_set_int( properties, "frequency", 48000 );
78 mlt_properties_set_int( properties, "channels", 2 );
80 // Default of all consumers is real time
81 mlt_properties_set_int( properties, "real_time", 1 );
83 // Default to environment test card
84 mlt_properties_set( properties, "test_card", mlt_environment( "MLT_TEST_CARD" ) );
86 // Hmm - default all consumers to yuv422 :-/
87 this->format = mlt_image_yuv422;
89 mlt_events_register( properties, "consumer-frame-show", ( mlt_transmitter )mlt_consumer_frame_show );
90 mlt_events_register( properties, "consumer-stopped", NULL );
92 // Create the push mutex and condition
93 pthread_mutex_init( &this->put_mutex, NULL );
94 pthread_cond_init( &this->put_cond, NULL );
100 static void mlt_consumer_frame_show( mlt_listener listener, mlt_properties owner, mlt_service this, void **args )
102 if ( listener != NULL )
103 listener( owner, this, ( mlt_frame )args[ 0 ] );
106 /** Create a new consumer.
109 mlt_consumer mlt_consumer_new( )
111 // Create the memory for the structure
112 mlt_consumer this = malloc( sizeof( struct mlt_consumer_s ) );
116 mlt_consumer_init( this, NULL );
122 /** Get the parent service object.
125 mlt_service mlt_consumer_service( mlt_consumer this )
127 return this != NULL ? &this->parent : NULL;
130 /** Get the consumer properties.
133 mlt_properties mlt_consumer_properties( mlt_consumer this )
135 return this != NULL ? MLT_SERVICE_PROPERTIES( &this->parent ) : NULL;
138 /** Connect the consumer to the producer.
141 int mlt_consumer_connect( mlt_consumer this, mlt_service producer )
143 return mlt_service_connect_producer( &this->parent, producer, 0 );
146 /** Start the consumer.
149 int mlt_consumer_start( mlt_consumer this )
152 mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
154 // Determine if there's a test card producer
155 char *test_card = mlt_properties_get( properties, "test_card" );
157 // Just to make sure nothing is hanging around...
158 mlt_frame_close( this->put );
162 if ( test_card != NULL )
164 if ( mlt_properties_get_data( properties, "test_card_producer", NULL ) == NULL )
166 // Create a test card producer
167 mlt_producer producer = mlt_factory_producer( NULL, test_card );
169 // Do we have a producer
170 if ( producer != NULL )
172 // Test card should loop I guess...
173 mlt_properties_set( MLT_PRODUCER_PROPERTIES( producer ), "eof", "pause" );
174 mlt_producer_set_speed( producer, 0 );
175 mlt_producer_set_in_and_out( producer, 0, 0 );
177 // Set the test card on the consumer
178 mlt_properties_set_data( properties, "test_card_producer", producer, 0, ( mlt_destructor )mlt_producer_close, NULL );
184 // Allow the hash table to speed things up
185 mlt_properties_set_data( properties, "test_card_producer", NULL, 0, NULL, NULL );
188 // Check and run an ante command
189 if ( mlt_properties_get( properties, "ante" ) )
190 system( mlt_properties_get( properties, "ante" ) );
192 // Set the real_time preference
193 this->real_time = mlt_properties_get_int( properties, "real_time" );
196 if ( this->start != NULL )
197 return this->start( this );
202 /** An alternative method to feed frames into the consumer - only valid if
203 the consumer itself is not connected.
206 int mlt_consumer_put_frame( mlt_consumer this, mlt_frame frame )
210 // Get the service assoicated to the consumer
211 mlt_service service = MLT_CONSUMER_SERVICE( this );
213 if ( mlt_service_producer( service ) == NULL )
217 pthread_mutex_lock( &this->put_mutex );
218 while ( !mlt_consumer_is_stopped( this ) && this->put != NULL )
220 gettimeofday( &now, NULL );
221 tm.tv_sec = now.tv_sec + 1;
222 tm.tv_nsec = now.tv_usec * 1000;
223 pthread_cond_timedwait( &this->put_cond, &this->put_mutex, &tm );
225 if ( !mlt_consumer_is_stopped( this ) && this->put == NULL )
228 mlt_frame_close( frame );
229 pthread_cond_broadcast( &this->put_cond );
230 pthread_mutex_unlock( &this->put_mutex );
234 mlt_frame_close( frame );
240 /** Protected method for consumer to get frames from connected service
243 mlt_frame mlt_consumer_get_frame( mlt_consumer this )
246 mlt_frame frame = NULL;
248 // Get the service assoicated to the consumer
249 mlt_service service = MLT_CONSUMER_SERVICE( this );
251 // Get the consumer properties
252 mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
255 if ( mlt_service_producer( service ) == NULL && mlt_properties_get_int( properties, "put_mode" ) )
259 pthread_mutex_lock( &this->put_mutex );
260 while ( !mlt_consumer_is_stopped( this ) && this->put == NULL )
262 gettimeofday( &now, NULL );
263 tm.tv_sec = now.tv_sec + 1;
264 tm.tv_nsec = now.tv_usec * 1000;
265 pthread_cond_timedwait( &this->put_cond, &this->put_mutex, &tm );
269 pthread_cond_broadcast( &this->put_cond );
270 pthread_mutex_unlock( &this->put_mutex );
272 mlt_service_apply_filters( service, frame, 0 );
274 else if ( mlt_service_producer( service ) != NULL )
276 mlt_service_get_frame( service, &frame, 0 );
281 // Get the frame properties
282 mlt_properties frame_properties = MLT_FRAME_PROPERTIES( frame );
284 // Get the test card producer
285 mlt_producer test_card = mlt_properties_get_data( properties, "test_card_producer", NULL );
287 // Attach the test frame producer to it.
288 if ( test_card != NULL )
289 mlt_properties_set_data( frame_properties, "test_card_producer", test_card, 0, NULL, NULL );
291 // Attach the rescale property
292 mlt_properties_set( frame_properties, "rescale.interp", mlt_properties_get( properties, "rescale" ) );
294 // Aspect ratio and other jiggery pokery
295 mlt_properties_set_double( frame_properties, "consumer_aspect_ratio", mlt_properties_get_double( properties, "aspect_ratio" ) );
296 if ( mlt_properties_get_int( properties, "progressive" ) || mlt_properties_get_int( properties, "deinterlace" ) )
297 mlt_properties_set_int( frame_properties, "consumer_deinterlace", 1 );
304 static inline long time_difference( struct timeval *time1 )
306 struct timeval time2;
307 time2.tv_sec = time1->tv_sec;
308 time2.tv_usec = time1->tv_usec;
309 gettimeofday( time1, NULL );
310 return time1->tv_sec * 1000000 + time1->tv_usec - time2.tv_sec * 1000000 - time2.tv_usec;
313 static void *consumer_read_ahead_thread( void *arg )
315 // The argument is the consumer
316 mlt_consumer this = arg;
318 // Get the properties of the consumer
319 mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
321 // Get the width and height
322 int width = mlt_properties_get_int( properties, "width" );
323 int height = mlt_properties_get_int( properties, "height" );
325 // See if video is turned off
326 int video_off = mlt_properties_get_int( properties, "video_off" );
328 // Get the audio settings
329 mlt_audio_format afmt = mlt_audio_pcm;
331 double fps = mlt_properties_get_double( properties, "fps" );
332 int channels = mlt_properties_get_int( properties, "channels" );
333 int frequency = mlt_properties_get_int( properties, "frequency" );
337 // See if audio is turned off
338 int audio_off = mlt_properties_get_int( properties, "audio_off" );
340 // Get the maximum size of the buffer
341 int buffer = mlt_properties_get_int( properties, "buffer" ) + 1;
343 // General frame variable
344 mlt_frame frame = NULL;
345 uint8_t *image = NULL;
350 // Average time for get_frame and get_image
353 int64_t time_wait = 0;
354 int64_t time_frame = 0;
355 int64_t time_process = 0;
358 // Get the first frame
359 frame = mlt_consumer_get_frame( this );
361 // Get the image of the first frame
363 mlt_frame_get_image( frame, &image, &this->format, &width, &height, 0 );
367 samples = mlt_sample_calculator( fps, frequency, counter++ );
368 mlt_frame_get_audio( frame, &pcm, &afmt, &frequency, &channels, &samples );
369 frame->get_audio = NULL;
372 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "rendered", 1 );
374 // Get the starting time (can ignore the times above)
375 gettimeofday( &ante, NULL );
377 // Continue to read ahead
378 while ( this->ahead )
380 // Put the current frame into the queue
381 pthread_mutex_lock( &this->mutex );
382 while( this->ahead && mlt_deque_count( this->queue ) >= buffer )
383 pthread_cond_wait( &this->cond, &this->mutex );
384 mlt_deque_push_back( this->queue, frame );
385 pthread_cond_broadcast( &this->cond );
386 pthread_mutex_unlock( &this->mutex );
388 time_wait += time_difference( &ante );
390 // Get the next frame
391 frame = mlt_consumer_get_frame( this );
392 time_frame += time_difference( &ante );
394 // If there's no frame, we're probably stopped...
398 // Increment the count
401 // All non normal playback frames should be shown
402 if ( mlt_properties_get_int( MLT_FRAME_PROPERTIES( frame ), "_speed" ) != 1 )
415 // Get the image, mark as rendered and time it
417 mlt_frame_get_image( frame, &image, &this->format, &width, &height, 0 );
418 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "rendered", 1 );
422 // Increment the number of sequentially skipped frames
426 // If we've reached an unacceptable level, reset everything
437 // Always process audio
440 samples = mlt_sample_calculator( fps, frequency, counter++ );
441 mlt_frame_get_audio( frame, &pcm, &afmt, &frequency, &channels, &samples );
442 frame->get_audio = NULL;
445 // Increment the time take for this frame
446 time_process += time_difference( &ante );
448 // Determine if the next frame should be skipped
449 if ( mlt_deque_count( this->queue ) <= 5 && ( ( time_wait + time_frame + time_process ) / count ) > 40000 )
453 // Remove the last frame
454 mlt_frame_close( frame );
459 static void consumer_read_ahead_start( mlt_consumer this )
461 pthread_attr_t thread_attributes;
466 // Create the frame queue
467 this->queue = mlt_deque_init( );
470 pthread_mutex_init( &this->mutex, NULL );
472 // Create the condition
473 pthread_cond_init( &this->cond, NULL );
475 // Inherit the scheduling priority
476 pthread_attr_init( &thread_attributes );
477 pthread_attr_setinheritsched( &thread_attributes, PTHREAD_INHERIT_SCHED );
479 // Create the read ahead
480 pthread_create( &this->ahead_thread, &thread_attributes, consumer_read_ahead_thread, this );
483 static void consumer_read_ahead_stop( mlt_consumer this )
485 // Make sure we're running
488 // Inform thread to stop
491 // Broadcast to the condition in case it's waiting
492 pthread_mutex_lock( &this->mutex );
493 pthread_cond_broadcast( &this->cond );
494 pthread_mutex_unlock( &this->mutex );
496 // Broadcast to the put condition in case it's waiting
497 pthread_mutex_lock( &this->put_mutex );
498 pthread_cond_broadcast( &this->put_cond );
499 pthread_mutex_unlock( &this->put_mutex );
502 pthread_join( this->ahead_thread, NULL );
505 pthread_mutex_destroy( &this->mutex );
507 // Destroy the condition
508 pthread_cond_destroy( &this->cond );
511 while ( mlt_deque_count( this->queue ) )
512 mlt_frame_close( mlt_deque_pop_back( this->queue ) );
515 mlt_deque_close( this->queue );
519 void mlt_consumer_purge( mlt_consumer this )
523 pthread_mutex_lock( &this->mutex );
524 while ( mlt_deque_count( this->queue ) )
525 mlt_frame_close( mlt_deque_pop_back( this->queue ) );
526 pthread_cond_broadcast( &this->cond );
527 pthread_mutex_unlock( &this->mutex );
531 mlt_frame mlt_consumer_rt_frame( mlt_consumer this )
534 mlt_frame frame = NULL;
536 // Get the properties
537 mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
539 // Check if the user has requested real time or not
540 if ( this->real_time )
544 // Is the read ahead running?
545 if ( this->ahead == 0 )
547 int buffer = mlt_properties_get_int( properties, "buffer" );
548 int prefill = mlt_properties_get_int( properties, "prefill" );
549 consumer_read_ahead_start( this );
551 size = prefill > 0 && prefill < buffer ? prefill : buffer;
554 // Get frame from queue
555 pthread_mutex_lock( &this->mutex );
556 while( this->ahead && mlt_deque_count( this->queue ) < size )
557 pthread_cond_wait( &this->cond, &this->mutex );
558 frame = mlt_deque_pop_front( this->queue );
559 pthread_cond_broadcast( &this->cond );
560 pthread_mutex_unlock( &this->mutex );
564 // Get the frame in non real time
565 frame = mlt_consumer_get_frame( this );
567 // This isn't true, but from the consumers perspective it is
569 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "rendered", 1 );
575 /** Callback for the implementation to indicate a stopped condition.
578 void mlt_consumer_stopped( mlt_consumer this )
580 mlt_properties_set_int( MLT_CONSUMER_PROPERTIES( this ), "running", 0 );
581 mlt_events_fire( MLT_CONSUMER_PROPERTIES( this ), "consumer-stopped", NULL );
584 /** Stop the consumer.
587 int mlt_consumer_stop( mlt_consumer this )
590 mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
593 if ( this->stop != NULL )
596 // Check if the user has requested real time or not and stop if necessary
597 if ( mlt_properties_get_int( properties, "real_time" ) )
598 consumer_read_ahead_stop( this );
601 pthread_mutex_lock( &this->put_mutex );
602 pthread_cond_broadcast( &this->put_cond );
603 pthread_mutex_unlock( &this->put_mutex );
605 // Kill the test card
606 mlt_properties_set_data( properties, "test_card_producer", NULL, 0, NULL, NULL );
608 // Check and run a post command
609 if ( mlt_properties_get( properties, "post" ) )
610 system( mlt_properties_get( properties, "post" ) );
612 if ( this->put != NULL )
614 mlt_frame_close( this->put );
621 /** Determine if the consumer is stopped.
624 int mlt_consumer_is_stopped( mlt_consumer this )
626 // Check if the consumer is stopped
627 if ( this->is_stopped != NULL )
628 return this->is_stopped( this );
633 /** Close the consumer.
636 void mlt_consumer_close( mlt_consumer this )
638 if ( this != NULL && mlt_properties_dec_ref( MLT_CONSUMER_PROPERTIES( this ) ) <= 0 )
640 // Get the childs close function
641 void ( *consumer_close )( ) = this->close;
643 // Make sure it only gets called once
645 this->parent.close = NULL;
647 // Destroy the push mutex and condition
648 pthread_cond_broadcast( &this->put_cond );
649 pthread_mutex_destroy( &this->put_mutex );
650 pthread_cond_destroy( &this->put_cond );
652 // Call the childs close if available
653 if ( consumer_close != NULL )
654 consumer_close( this );
656 mlt_service_close( &this->parent );