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", "loop" );
175 // Set the test card on the consumer
176 mlt_properties_set_data( properties, "test_card_producer", producer, 0, ( mlt_destructor )mlt_producer_close, NULL );
182 // Allow the hash table to speed things up
183 mlt_properties_set_data( properties, "test_card_producer", NULL, 0, NULL, NULL );
186 // Check and run an ante command
187 if ( mlt_properties_get( properties, "ante" ) )
188 system( mlt_properties_get( properties, "ante" ) );
190 // Set the real_time preference
191 this->real_time = mlt_properties_get_int( properties, "real_time" );
194 if ( this->start != NULL )
195 return this->start( this );
200 /** An alternative method to feed frames into the consumer - only valid if
201 the consumer itself is not connected.
204 int mlt_consumer_put_frame( mlt_consumer this, mlt_frame frame )
208 // Get the service assoicated to the consumer
209 mlt_service service = mlt_consumer_service( this );
211 if ( mlt_service_producer( service ) == NULL )
215 pthread_mutex_lock( &this->put_mutex );
216 while ( !mlt_consumer_is_stopped( this ) && this->put != NULL )
218 gettimeofday( &now, NULL );
219 tm.tv_sec = now.tv_sec + 1;
220 tm.tv_nsec = now.tv_usec * 1000;
221 pthread_cond_timedwait( &this->put_cond, &this->put_mutex, &tm );
223 if ( this->put == NULL )
226 mlt_frame_close( frame );
227 pthread_cond_broadcast( &this->put_cond );
228 pthread_mutex_unlock( &this->put_mutex );
232 mlt_frame_close( frame );
238 /** Protected method for consumer to get frames from connected service
241 mlt_frame mlt_consumer_get_frame( mlt_consumer this )
244 mlt_frame frame = NULL;
246 // Get the service assoicated to the consumer
247 mlt_service service = mlt_consumer_service( this );
249 // Get the consumer properties
250 mlt_properties properties = mlt_consumer_properties( this );
253 if ( mlt_service_producer( service ) == NULL && mlt_properties_get_int( properties, "put_mode" ) )
257 pthread_mutex_lock( &this->put_mutex );
258 while ( !mlt_consumer_is_stopped( this ) && this->put == NULL )
260 gettimeofday( &now, NULL );
261 tm.tv_sec = now.tv_sec + 1;
262 tm.tv_nsec = now.tv_usec * 1000;
263 pthread_cond_timedwait( &this->put_cond, &this->put_mutex, &tm );
267 pthread_cond_broadcast( &this->put_cond );
268 pthread_mutex_unlock( &this->put_mutex );
270 mlt_service_apply_filters( service, frame, 0 );
272 else if ( mlt_service_producer( service ) != NULL )
274 mlt_service_get_frame( service, &frame, 0 );
279 // Get the frame properties
280 mlt_properties frame_properties = mlt_frame_properties( frame );
282 // Get the test card producer
283 mlt_producer test_card = mlt_properties_get_data( properties, "test_card_producer", NULL );
285 // Attach the test frame producer to it.
286 if ( test_card != NULL )
287 mlt_properties_set_data( frame_properties, "test_card_producer", test_card, 0, NULL, NULL );
289 // Attach the rescale property
290 mlt_properties_set( frame_properties, "rescale.interp", mlt_properties_get( properties, "rescale" ) );
292 // Aspect ratio and other jiggery pokery
293 mlt_properties_set_double( frame_properties, "consumer_aspect_ratio", mlt_properties_get_double( properties, "aspect_ratio" ) );
294 if ( mlt_properties_get_int( properties, "progressive" ) || mlt_properties_get_int( properties, "deinterlace" ) )
295 mlt_properties_set_int( frame_properties, "consumer_deinterlace", 1 );
302 static inline long time_difference( struct timeval *time1 )
304 struct timeval time2;
305 time2.tv_sec = time1->tv_sec;
306 time2.tv_usec = time1->tv_usec;
307 gettimeofday( time1, NULL );
308 return time1->tv_sec * 1000000 + time1->tv_usec - time2.tv_sec * 1000000 - time2.tv_usec;
311 static void *consumer_read_ahead_thread( void *arg )
313 // The argument is the consumer
314 mlt_consumer this = arg;
316 // Get the properties of the consumer
317 mlt_properties properties = mlt_consumer_properties( this );
319 // Get the width and height
320 int width = mlt_properties_get_int( properties, "width" );
321 int height = mlt_properties_get_int( properties, "height" );
323 // See if video is turned off
324 int video_off = mlt_properties_get_int( properties, "video_off" );
326 // Get the audio settings
327 mlt_audio_format afmt = mlt_audio_pcm;
329 double fps = mlt_properties_get_double( properties, "fps" );
330 int channels = mlt_properties_get_int( properties, "channels" );
331 int frequency = mlt_properties_get_int( properties, "frequency" );
335 // See if audio is turned off
336 int audio_off = mlt_properties_get_int( properties, "audio_off" );
338 // Get the maximum size of the buffer
339 int buffer = mlt_properties_get_int( properties, "buffer" ) + 1;
341 // General frame variable
342 mlt_frame frame = NULL;
343 uint8_t *image = NULL;
348 // Average time for get_frame and get_image
351 int64_t time_wait = 0;
352 int64_t time_frame = 0;
353 int64_t time_process = 0;
356 // Get the first frame
357 frame = mlt_consumer_get_frame( this );
359 // Get the image of the first frame
361 mlt_frame_get_image( frame, &image, &this->format, &width, &height, 0 );
365 samples = mlt_sample_calculator( fps, frequency, counter++ );
366 mlt_frame_get_audio( frame, &pcm, &afmt, &frequency, &channels, &samples );
367 frame->get_audio = NULL;
370 mlt_properties_set_int( mlt_frame_properties( frame ), "rendered", 1 );
372 // Get the starting time (can ignore the times above)
373 gettimeofday( &ante, NULL );
375 // Continue to read ahead
376 while ( this->ahead )
378 // Put the current frame into the queue
379 pthread_mutex_lock( &this->mutex );
380 while( this->ahead && mlt_deque_count( this->queue ) >= buffer )
381 pthread_cond_wait( &this->cond, &this->mutex );
382 mlt_deque_push_back( this->queue, frame );
383 pthread_cond_broadcast( &this->cond );
384 pthread_mutex_unlock( &this->mutex );
386 time_wait += time_difference( &ante );
388 // Get the next frame
389 frame = mlt_consumer_get_frame( this );
390 time_frame += time_difference( &ante );
392 // If there's no frame, we're probably stopped...
396 // Increment the count
399 // All non normal playback frames should be shown
400 if ( mlt_properties_get_int( mlt_frame_properties( frame ), "_speed" ) != 1 )
413 // Get the image, mark as rendered and time it
415 mlt_frame_get_image( frame, &image, &this->format, &width, &height, 0 );
416 mlt_properties_set_int( mlt_frame_properties( frame ), "rendered", 1 );
420 // Increment the number of sequentially skipped frames
424 // If we've reached an unacceptable level, reset everything
435 // Always process audio
438 samples = mlt_sample_calculator( fps, frequency, counter++ );
439 mlt_frame_get_audio( frame, &pcm, &afmt, &frequency, &channels, &samples );
440 frame->get_audio = NULL;
443 // Increment the time take for this frame
444 time_process += time_difference( &ante );
446 // Determine if the next frame should be skipped
447 if ( mlt_deque_count( this->queue ) <= 5 && ( ( time_wait + time_frame + time_process ) / count ) > 40000 )
451 // Remove the last frame
452 mlt_frame_close( frame );
457 static void consumer_read_ahead_start( mlt_consumer this )
459 pthread_attr_t thread_attributes;
464 // Create the frame queue
465 this->queue = mlt_deque_init( );
468 pthread_mutex_init( &this->mutex, NULL );
470 // Create the condition
471 pthread_cond_init( &this->cond, NULL );
473 // Inherit the scheduling priority
474 pthread_attr_init( &thread_attributes );
475 pthread_attr_setinheritsched( &thread_attributes, PTHREAD_INHERIT_SCHED );
477 // Create the read ahead
478 pthread_create( &this->ahead_thread, &thread_attributes, consumer_read_ahead_thread, this );
481 static void consumer_read_ahead_stop( mlt_consumer this )
483 // Make sure we're running
486 // Inform thread to stop
489 // Broadcast to the condition in case it's waiting
490 pthread_mutex_lock( &this->mutex );
491 pthread_cond_broadcast( &this->cond );
492 pthread_mutex_unlock( &this->mutex );
494 // Broadcast to the put condition in case it's waiting
495 pthread_mutex_lock( &this->put_mutex );
496 pthread_cond_broadcast( &this->put_cond );
497 pthread_mutex_unlock( &this->put_mutex );
500 pthread_join( this->ahead_thread, NULL );
503 pthread_mutex_destroy( &this->mutex );
505 // Destroy the condition
506 pthread_cond_destroy( &this->cond );
509 while ( mlt_deque_count( this->queue ) )
510 mlt_frame_close( mlt_deque_pop_back( this->queue ) );
513 mlt_deque_close( this->queue );
517 void mlt_consumer_purge( mlt_consumer this )
521 pthread_mutex_lock( &this->mutex );
522 while ( mlt_deque_count( this->queue ) )
523 mlt_frame_close( mlt_deque_pop_back( this->queue ) );
524 pthread_cond_broadcast( &this->cond );
525 pthread_mutex_unlock( &this->mutex );
529 mlt_frame mlt_consumer_rt_frame( mlt_consumer this )
532 mlt_frame frame = NULL;
534 // Get the properties
535 mlt_properties properties = mlt_consumer_properties( this );
537 // Check if the user has requested real time or not
538 if ( this->real_time )
542 // Is the read ahead running?
543 if ( this->ahead == 0 )
545 int buffer = mlt_properties_get_int( properties, "buffer" );
546 int prefill = mlt_properties_get_int( properties, "prefill" );
547 consumer_read_ahead_start( this );
549 size = prefill > 0 && prefill < buffer ? prefill : buffer;
552 // Get frame from queue
553 pthread_mutex_lock( &this->mutex );
554 while( this->ahead && mlt_deque_count( this->queue ) < size )
555 pthread_cond_wait( &this->cond, &this->mutex );
556 frame = mlt_deque_pop_front( this->queue );
557 pthread_cond_broadcast( &this->cond );
558 pthread_mutex_unlock( &this->mutex );
562 // Get the frame in non real time
563 frame = mlt_consumer_get_frame( this );
565 // This isn't true, but from the consumers perspective it is
567 mlt_properties_set_int( mlt_frame_properties( frame ), "rendered", 1 );
573 /** Callback for the implementation to indicate a stopped condition.
576 void mlt_consumer_stopped( mlt_consumer this )
578 mlt_properties_set_int( mlt_consumer_properties( this ), "running", 0 );
579 mlt_events_fire( mlt_consumer_properties( this ), "consumer-stopped", NULL );
582 /** Stop the consumer.
585 int mlt_consumer_stop( mlt_consumer this )
588 mlt_properties properties = mlt_consumer_properties( this );
591 if ( this->stop != NULL )
594 // Check if the user has requested real time or not and stop if necessary
595 if ( mlt_properties_get_int( properties, "real_time" ) )
596 consumer_read_ahead_stop( this );
599 pthread_mutex_lock( &this->put_mutex );
600 pthread_cond_broadcast( &this->put_cond );
601 pthread_mutex_unlock( &this->put_mutex );
603 // Kill the test card
604 mlt_properties_set_data( properties, "test_card_producer", NULL, 0, NULL, NULL );
606 // Check and run a post command
607 if ( mlt_properties_get( properties, "post" ) )
608 system( mlt_properties_get( properties, "post" ) );
610 if ( this->put != NULL )
612 mlt_frame_close( this->put );
619 /** Determine if the consumer is stopped.
622 int mlt_consumer_is_stopped( mlt_consumer this )
624 // Check if the consumer is stopped
625 if ( this->is_stopped != NULL )
626 return this->is_stopped( this );
631 /** Close the consumer.
634 void mlt_consumer_close( mlt_consumer this )
636 if ( this != NULL && mlt_properties_dec_ref( mlt_consumer_properties( this ) ) <= 0 )
638 // Get the childs close function
639 void ( *consumer_close )( ) = this->close;
641 // Make sure it only gets called once
643 this->parent.close = NULL;
645 // Destroy the push mutex and condition
646 pthread_cond_broadcast( &this->put_cond );
647 pthread_mutex_destroy( &this->put_mutex );
648 pthread_cond_destroy( &this->put_cond );
650 // Call the childs close if available
651 if ( consumer_close != NULL )
652 consumer_close( this );
654 mlt_service_close( &this->parent );