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", 128.0 / 117.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", 72.0 / 79.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 );
95 static void mlt_consumer_frame_show( mlt_listener listener, mlt_properties owner, mlt_service this, void **args )
97 if ( listener != NULL )
98 listener( owner, this, ( mlt_frame )args[ 0 ] );
101 /** Create a new consumer.
104 mlt_consumer mlt_consumer_new( )
106 // Create the memory for the structure
107 mlt_consumer this = malloc( sizeof( struct mlt_consumer_s ) );
111 mlt_consumer_init( this, NULL );
117 /** Get the parent service object.
120 mlt_service mlt_consumer_service( mlt_consumer this )
122 return this != NULL ? &this->parent : NULL;
125 /** Get the consumer properties.
128 mlt_properties mlt_consumer_properties( mlt_consumer this )
130 return this != NULL ? mlt_service_properties( &this->parent ) : NULL;
133 /** Connect the consumer to the producer.
136 int mlt_consumer_connect( mlt_consumer this, mlt_service producer )
138 return mlt_service_connect_producer( &this->parent, producer, 0 );
141 /** Start the consumer.
144 int mlt_consumer_start( mlt_consumer this )
147 mlt_properties properties = mlt_consumer_properties( this );
149 // Determine if there's a test card producer
150 char *test_card = mlt_properties_get( properties, "test_card" );
153 if ( test_card != NULL )
155 if ( mlt_properties_get_data( properties, "test_card_producer", NULL ) == NULL )
157 // Create a test card producer
158 mlt_producer producer = mlt_factory_producer( NULL, test_card );
160 // Do we have a producer
161 if ( producer != NULL )
163 // Test card should loop I guess...
164 mlt_properties_set( mlt_producer_properties( producer ), "eof", "loop" );
166 // Set the test card on the consumer
167 mlt_properties_set_data( properties, "test_card_producer", producer, 0, ( mlt_destructor )mlt_producer_close, NULL );
173 // Allow the hash table to speed things up
174 mlt_properties_set_data( properties, "test_card_producer", NULL, 0, NULL, NULL );
177 // Check and run an ante command
178 if ( mlt_properties_get( properties, "ante" ) )
179 system( mlt_properties_get( properties, "ante" ) );
181 // Set the real_time preference
182 this->real_time = mlt_properties_get_int( properties, "real_time" );
185 if ( this->start != NULL )
186 return this->start( this );
191 /** Protected method for consumer to get frames from connected service
194 mlt_frame mlt_consumer_get_frame( mlt_consumer this )
197 mlt_frame frame = NULL;
199 // Get the service assoicated to the consumer
200 mlt_service service = mlt_consumer_service( this );
203 if ( mlt_service_get_frame( service, &frame, 0 ) == 0 )
205 // Get the consumer properties
206 mlt_properties properties = mlt_consumer_properties( this );
208 // Get the frame properties
209 mlt_properties frame_properties = mlt_frame_properties( frame );
211 // Get the test card producer
212 mlt_producer test_card = mlt_properties_get_data( properties, "test_card_producer", NULL );
214 // Attach the test frame producer to it.
215 if ( test_card != NULL )
216 mlt_properties_set_data( frame_properties, "test_card_producer", test_card, 0, NULL, NULL );
218 // Attach the rescale property
219 mlt_properties_set( frame_properties, "rescale.interp", mlt_properties_get( properties, "rescale" ) );
221 // Aspect ratio and other jiggery pokery
222 mlt_properties_set_double( frame_properties, "consumer_aspect_ratio", mlt_properties_get_double( properties, "aspect_ratio" ) );
223 mlt_properties_set_int( frame_properties, "consumer_progressive", mlt_properties_get_int( properties, "progressive" ) );
224 mlt_properties_set_int( frame_properties, "consumer_deinterlace", mlt_properties_get_int( properties, "deinterlace" ) );
231 static inline long time_difference( struct timeval *time1 )
233 struct timeval time2;
234 time2.tv_sec = time1->tv_sec;
235 time2.tv_usec = time1->tv_usec;
236 gettimeofday( time1, NULL );
237 return time1->tv_sec * 1000000 + time1->tv_usec - time2.tv_sec * 1000000 - time2.tv_usec;
240 static void *consumer_read_ahead_thread( void *arg )
242 // The argument is the consumer
243 mlt_consumer this = arg;
245 // Get the properties of the consumer
246 mlt_properties properties = mlt_consumer_properties( this );
248 // Get the width and height
249 int width = mlt_properties_get_int( properties, "width" );
250 int height = mlt_properties_get_int( properties, "height" );
252 // See if video is turned off
253 int video_off = mlt_properties_get_int( properties, "video_off" );
255 // Get the audio settings
256 mlt_audio_format afmt = mlt_audio_pcm;
258 double fps = mlt_properties_get_double( properties, "fps" );
259 int channels = mlt_properties_get_int( properties, "channels" );
260 int frequency = mlt_properties_get_int( properties, "frequency" );
264 // See if audio is turned off
265 int audio_off = mlt_properties_get_int( properties, "audio_off" );
267 // Get the maximum size of the buffer
268 int buffer = mlt_properties_get_int( properties, "buffer" ) + 1;
270 // General frame variable
271 mlt_frame frame = NULL;
272 uint8_t *image = NULL;
277 // Average time for get_frame and get_image
280 int64_t time_wait = 0;
281 int64_t time_frame = 0;
282 int64_t time_process = 0;
285 // Get the first frame
286 frame = mlt_consumer_get_frame( this );
288 // Get the image of the first frame
290 mlt_frame_get_image( frame, &image, &this->format, &width, &height, 0 );
294 samples = mlt_sample_calculator( fps, frequency, counter++ );
295 mlt_frame_get_audio( frame, &pcm, &afmt, &frequency, &channels, &samples );
296 frame->get_audio = NULL;
299 mlt_properties_set_int( mlt_frame_properties( frame ), "rendered", 1 );
301 // Get the starting time (can ignore the times above)
302 gettimeofday( &ante, NULL );
304 // Continue to read ahead
305 while ( this->ahead )
307 // Put the current frame into the queue
308 pthread_mutex_lock( &this->mutex );
309 while( this->ahead && mlt_deque_count( this->queue ) >= buffer )
310 pthread_cond_wait( &this->cond, &this->mutex );
311 mlt_deque_push_back( this->queue, frame );
312 pthread_cond_broadcast( &this->cond );
313 pthread_mutex_unlock( &this->mutex );
314 time_wait += time_difference( &ante );
316 // Get the next frame
317 frame = mlt_consumer_get_frame( this );
318 time_frame += time_difference( &ante );
320 // Increment the count
323 // All non normal playback frames should be shown
324 if ( mlt_properties_get_int( mlt_frame_properties( frame ), "_speed" ) != 1 )
337 // Get the image, mark as rendered and time it
339 mlt_frame_get_image( frame, &image, &this->format, &width, &height, 0 );
340 mlt_properties_set_int( mlt_frame_properties( frame ), "rendered", 1 );
344 // Increment the number of sequentially skipped frames
348 // If we've reached an unacceptable level, reset everything
359 // Always process audio
362 samples = mlt_sample_calculator( fps, frequency, counter++ );
363 mlt_frame_get_audio( frame, &pcm, &afmt, &frequency, &channels, &samples );
364 frame->get_audio = NULL;
367 // Increment the time take for this frame
368 time_process += time_difference( &ante );
370 // Determine if the next frame should be skipped
371 if ( mlt_deque_count( this->queue ) <= 5 && ( ( time_wait + time_frame + time_process ) / count ) > 40000 )
375 // Remove the last frame
376 mlt_frame_close( frame );
381 static void consumer_read_ahead_start( mlt_consumer this )
383 pthread_attr_t thread_attributes;
388 // Create the frame queue
389 this->queue = mlt_deque_init( );
392 pthread_mutex_init( &this->mutex, NULL );
394 // Create the condition
395 pthread_cond_init( &this->cond, NULL );
397 // Inherit the scheduling priority
398 pthread_attr_init( &thread_attributes );
399 pthread_attr_setinheritsched( &thread_attributes, PTHREAD_INHERIT_SCHED );
401 // Create the read ahead
402 pthread_create( &this->ahead_thread, &thread_attributes, consumer_read_ahead_thread, this );
405 static void consumer_read_ahead_stop( mlt_consumer this )
407 // Make sure we're running
410 // Inform thread to stop
413 // Broadcast to the condition in case it's waiting
414 pthread_mutex_lock( &this->mutex );
415 pthread_cond_broadcast( &this->cond );
416 pthread_mutex_unlock( &this->mutex );
419 pthread_join( this->ahead_thread, NULL );
422 pthread_mutex_destroy( &this->mutex );
424 // Destroy the condition
425 pthread_cond_destroy( &this->cond );
428 while ( mlt_deque_count( this->queue ) )
429 mlt_frame_close( mlt_deque_pop_back( this->queue ) );
432 mlt_deque_close( this->queue );
436 void mlt_consumer_purge( mlt_consumer this )
440 pthread_mutex_lock( &this->mutex );
441 while ( mlt_deque_count( this->queue ) )
442 mlt_frame_close( mlt_deque_pop_back( this->queue ) );
443 pthread_cond_broadcast( &this->cond );
444 pthread_mutex_unlock( &this->mutex );
448 mlt_frame mlt_consumer_rt_frame( mlt_consumer this )
451 mlt_frame frame = NULL;
453 // Get the properties
454 mlt_properties properties = mlt_consumer_properties( this );
456 // Check if the user has requested real time or not
457 if ( this->real_time )
461 // Is the read ahead running?
462 if ( this->ahead == 0 )
464 int buffer = mlt_properties_get_int( properties, "buffer" );
465 int prefill = mlt_properties_get_int( properties, "prefill" );
466 consumer_read_ahead_start( this );
468 size = prefill > 0 && prefill < buffer ? prefill : buffer;
471 // Get frame from queue
472 pthread_mutex_lock( &this->mutex );
473 while( this->ahead && mlt_deque_count( this->queue ) < size )
474 pthread_cond_wait( &this->cond, &this->mutex );
475 frame = mlt_deque_pop_front( this->queue );
476 pthread_cond_broadcast( &this->cond );
477 pthread_mutex_unlock( &this->mutex );
481 // Get the frame in non real time
482 frame = mlt_consumer_get_frame( this );
484 // This isn't true, but from the consumers perspective it is
485 mlt_properties_set_int( mlt_frame_properties( frame ), "rendered", 1 );
491 /** Callback for the implementation to indicate a stopped condition.
494 void mlt_consumer_stopped( mlt_consumer this )
496 mlt_properties_set_int( mlt_consumer_properties( this ), "running", 0 );
497 mlt_events_fire( mlt_consumer_properties( this ), "consumer-stopped", NULL );
500 /** Stop the consumer.
503 int mlt_consumer_stop( mlt_consumer this )
506 mlt_properties properties = mlt_consumer_properties( this );
509 if ( this->stop != NULL )
512 // Check if the user has requested real time or not and stop if necessary
513 if ( mlt_properties_get_int( properties, "real_time" ) )
514 consumer_read_ahead_stop( this );
516 // Kill the test card
517 mlt_properties_set_data( properties, "test_card_producer", NULL, 0, NULL, NULL );
519 // Check and run a post command
520 if ( mlt_properties_get( properties, "post" ) )
521 system( mlt_properties_get( properties, "post" ) );
526 /** Determine if the consumer is stopped.
529 int mlt_consumer_is_stopped( mlt_consumer this )
531 // Check if the consumer is stopped
532 if ( this->is_stopped != NULL )
533 return this->is_stopped( this );
538 /** Close the consumer.
541 void mlt_consumer_close( mlt_consumer this )
543 if ( this != NULL && mlt_properties_dec_ref( mlt_consumer_properties( this ) ) <= 0 )
545 // Get the childs close function
546 void ( *consumer_close )( ) = this->close;
548 // Make sure it only gets called once
550 this->parent.close = NULL;
552 // Call the childs close if available
553 if ( consumer_close != NULL )
554 consumer_close( this );
556 mlt_service_close( &this->parent );