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 /** Public final methods
34 int mlt_consumer_init( mlt_consumer this, void *child )
37 memset( this, 0, sizeof( struct mlt_consumer_s ) );
39 error = mlt_service_init( &this->parent, this );
42 // Get the properties from the service
43 mlt_properties properties = mlt_service_properties( &this->parent );
45 // Get the normalisation preference
46 char *normalisation = mlt_environment( "MLT_NORMALISATION" );
48 // Deal with normalisation
49 if ( normalisation == NULL || strcmp( normalisation, "NTSC" ) )
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 );
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 );
68 // Default rescaler for all consumers
69 mlt_properties_set( properties, "rescale", "bilinear" );
71 // Default read ahead buffer size
72 mlt_properties_set_int( properties, "buffer", 25 );
74 // Default audio frequency and channels
75 mlt_properties_set_int( properties, "frequency", 48000 );
76 mlt_properties_set_int( properties, "channels", 2 );
78 // Default of all consumers is real time
79 mlt_properties_set_int( properties, "real_time", 1 );
81 // Hmm - default all consumers to yuv422 :-/
82 this->format = mlt_image_yuv422;
87 /** Create a new consumer.
90 mlt_consumer mlt_consumer_new( )
92 // Create the memory for the structure
93 mlt_consumer this = malloc( sizeof( struct mlt_consumer_s ) );
97 mlt_consumer_init( this, NULL );
103 /** Get the parent service object.
106 mlt_service mlt_consumer_service( mlt_consumer this )
108 return &this->parent;
111 /** Get the consumer properties.
114 mlt_properties mlt_consumer_properties( mlt_consumer this )
116 return mlt_service_properties( &this->parent );
119 /** Connect the consumer to the producer.
122 int mlt_consumer_connect( mlt_consumer this, mlt_service producer )
124 return mlt_service_connect_producer( &this->parent, producer, 0 );
127 /** Start the consumer.
130 int mlt_consumer_start( mlt_consumer this )
133 mlt_properties properties = mlt_consumer_properties( this );
135 // Determine if there's a test card producer
136 char *test_card = mlt_properties_get( properties, "test_card" );
139 if ( test_card != NULL )
141 if ( mlt_properties_get_data( properties, "test_card_producer", NULL ) == NULL )
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 );
147 // Do we have a producer
148 if ( producer != NULL )
150 // Test card should loop I guess...
151 mlt_properties_set( mlt_producer_properties( producer ), "eof", "loop" );
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 );
157 // Check and run an ante command
158 if ( mlt_properties_get( properties, "ante" ) )
159 system( mlt_properties_get( properties, "ante" ) );
164 // Allow the hash table to speed things up
165 mlt_properties_set_data( properties, "test_card_producer", NULL, 0, NULL, NULL );
168 // Set the real_time preference
169 this->real_time = mlt_properties_get_int( properties, "real_time" );
172 if ( this->start != NULL )
173 return this->start( this );
178 /** Protected method for consumer to get frames from connected service
181 mlt_frame mlt_consumer_get_frame( mlt_consumer this )
184 mlt_frame frame = NULL;
186 // Get the service assoicated to the consumer
187 mlt_service service = mlt_consumer_service( this );
190 if ( mlt_service_get_frame( service, &frame, 0 ) == 0 )
192 // Get the consumer properties
193 mlt_properties properties = mlt_consumer_properties( this );
195 // Get the frame properties
196 mlt_properties frame_properties = mlt_frame_properties( frame );
198 // Get the test card producer
199 mlt_producer test_card = mlt_properties_get_data( properties, "test_card_producer", NULL );
201 // Attach the test frame producer to it.
202 if ( test_card != NULL )
203 mlt_properties_set_data( frame_properties, "test_card_producer", test_card, 0, NULL, NULL );
205 // Attach the rescale property
206 mlt_properties_set( frame_properties, "rescale.interp", mlt_properties_get( properties, "rescale" ) );
208 // Aspect ratio and other jiggery pokery
209 mlt_properties_set_double( frame_properties, "consumer_aspect_ratio", mlt_properties_get_double( properties, "aspect_ratio" ) );
210 mlt_properties_set_int( frame_properties, "consumer_progressive", mlt_properties_get_int( properties, "progressive" ) );
211 mlt_properties_set_int( frame_properties, "consumer_deinterlace", mlt_properties_get_int( properties, "deinterlace" ) );
218 static inline long time_difference( struct timeval *time1 )
220 struct timeval time2;
221 time2.tv_sec = time1->tv_sec;
222 time2.tv_usec = time1->tv_usec;
223 gettimeofday( time1, NULL );
224 return time1->tv_sec * 1000000 + time1->tv_usec - time2.tv_sec * 1000000 - time2.tv_usec;
227 static void *consumer_read_ahead_thread( void *arg )
229 // The argument is the consumer
230 mlt_consumer this = arg;
232 // Get the properties of the consumer
233 mlt_properties properties = mlt_consumer_properties( this );
235 // Get the width and height
236 int width = mlt_properties_get_int( properties, "width" );
237 int height = mlt_properties_get_int( properties, "height" );
239 // Get the maximum size of the buffer
240 int buffer = mlt_properties_get_int( properties, "buffer" );
242 // General frame variable
243 mlt_frame frame = NULL;
244 uint8_t *image = NULL;
249 // Average time for get_frame and get_image
252 int64_t time_wait = 0;
253 int64_t time_frame = 0;
254 int64_t time_image = 0;
256 // Get the first frame
257 frame = mlt_consumer_get_frame( this );
259 // Get the image of the first frame
260 mlt_frame_get_image( frame, &image, &this->format, &width, &height, 0 );
261 mlt_properties_set_int( mlt_frame_properties( frame ), "rendered", 1 );
263 // Get the starting time (can ignore the times above)
264 gettimeofday( &ante, NULL );
266 // Continue to read ahead
267 while ( this->ahead )
269 // Put the current frame into the queue
270 pthread_mutex_lock( &this->mutex );
271 while( this->ahead && mlt_deque_count( this->queue ) >= buffer )
272 pthread_cond_wait( &this->cond, &this->mutex );
273 mlt_deque_push_back( this->queue, frame );
274 pthread_cond_broadcast( &this->cond );
275 pthread_mutex_unlock( &this->mutex );
276 time_wait += time_difference( &ante );
278 // Get the next frame
279 frame = mlt_consumer_get_frame( this );
280 time_frame += time_difference( &ante );
282 // Increment the count
286 if ( ( time_frame + time_image ) / count < ( 40000 - ( time_wait / count ) ) )
288 // Get the image, mark as rendered and time it
289 mlt_frame_get_image( frame, &image, &this->format, &width, &height, 0 );
290 mlt_properties_set_int( mlt_frame_properties( frame ), "rendered", 1 );
291 time_image += time_difference( &ante );
293 // Reset the skipped count
298 // Increment the number of sequentially skipped frames
301 // If we've reached an unacceptable level, reset everything
313 // Remove the last frame
314 mlt_frame_close( frame );
319 static void consumer_read_ahead_start( mlt_consumer this )
321 pthread_attr_t thread_attributes;
326 // Create the frame queue
327 this->queue = mlt_deque_init( );
330 pthread_mutex_init( &this->mutex, NULL );
332 // Create the condition
333 pthread_cond_init( &this->cond, NULL );
335 // Inherit the scheduling priority
336 pthread_attr_init( &thread_attributes );
337 pthread_attr_setinheritsched( &thread_attributes, PTHREAD_INHERIT_SCHED );
339 // Create the read ahead
340 pthread_create( &this->ahead_thread, &thread_attributes, consumer_read_ahead_thread, this );
344 static void consumer_read_ahead_stop( mlt_consumer this )
346 // Make sure we're running
349 // Inform thread to stop
352 // Broadcast to the condition in case it's waiting
353 pthread_mutex_lock( &this->mutex );
354 pthread_cond_broadcast( &this->cond );
355 pthread_mutex_unlock( &this->mutex );
358 pthread_join( this->ahead_thread, NULL );
361 pthread_mutex_destroy( &this->mutex );
363 // Destroy the condition
364 pthread_cond_destroy( &this->cond );
367 while ( mlt_deque_count( this->queue ) )
368 mlt_frame_close( mlt_deque_pop_back( this->queue ) );
372 mlt_frame mlt_consumer_rt_frame( mlt_consumer this )
375 mlt_frame frame = NULL;
377 // Get the properties
378 mlt_properties properties = mlt_consumer_properties( this );
380 // Check if the user has requested real time or not
381 if ( this->real_time )
385 // Is the read ahead running?
386 if ( this->ahead == 0 )
388 int buffer = mlt_properties_get_int( properties, "buffer" );
389 consumer_read_ahead_start( this );
394 // Get frame from queue
395 pthread_mutex_lock( &this->mutex );
396 while( this->ahead && mlt_deque_count( this->queue ) < size )
397 pthread_cond_wait( &this->cond, &this->mutex );
398 frame = mlt_deque_pop_front( this->queue );
399 pthread_cond_broadcast( &this->cond );
400 pthread_mutex_unlock( &this->mutex );
404 // Get the frame in non real time
405 frame = mlt_consumer_get_frame( this );
407 // This isn't true, but from the consumers perspective it is
408 mlt_properties_set_int( mlt_frame_properties( frame ), "rendered", 1 );
414 /** Stop the consumer.
417 int mlt_consumer_stop( mlt_consumer this )
420 mlt_properties properties = mlt_consumer_properties( this );
423 if ( this->stop != NULL )
426 // Check if the user has requested real time or not and stop if necessary
427 if ( mlt_properties_get_int( properties, "real_time" ) )
428 consumer_read_ahead_stop( this );
430 // Kill the test card
431 mlt_properties_set_data( properties, "test_card_producer", NULL, 0, NULL, NULL );
433 // Check and run a post command
434 if ( mlt_properties_get( properties, "post" ) )
435 system( mlt_properties_get( properties, "post" ) );
440 /** Determine if the consumer is stopped.
443 int mlt_consumer_is_stopped( mlt_consumer this )
445 // Check if the consumer is stopped
446 if ( this->is_stopped != NULL )
447 return this->is_stopped( this );
452 /** Close the consumer.
455 void mlt_consumer_close( mlt_consumer this )
457 // Get the childs close function
458 void ( *consumer_close )( ) = this->close;
460 // Make sure it only gets called once
463 // Call the childs close if available
464 if ( consumer_close != NULL )
465 consumer_close( this );
467 mlt_service_close( &this->parent );