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 // Default to environment test card
82 mlt_properties_set( properties
, "test_card", mlt_environment( "MLT_TEST_CARD" ) );
84 // Hmm - default all consumers to yuv422 :-/
85 this->format
= mlt_image_yuv422
;
90 /** Create a new consumer.
93 mlt_consumer
mlt_consumer_new( )
95 // Create the memory for the structure
96 mlt_consumer
this = malloc( sizeof( struct mlt_consumer_s
) );
100 mlt_consumer_init( this, NULL
);
106 /** Get the parent service object.
109 mlt_service
mlt_consumer_service( mlt_consumer
this )
111 return &this->parent
;
114 /** Get the consumer properties.
117 mlt_properties
mlt_consumer_properties( mlt_consumer
this )
119 return mlt_service_properties( &this->parent
);
122 /** Connect the consumer to the producer.
125 int mlt_consumer_connect( mlt_consumer
this, mlt_service producer
)
127 return mlt_service_connect_producer( &this->parent
, producer
, 0 );
130 /** Start the consumer.
133 int mlt_consumer_start( mlt_consumer
this )
136 mlt_properties properties
= mlt_consumer_properties( this );
138 // Determine if there's a test card producer
139 char *test_card
= mlt_properties_get( properties
, "test_card" );
142 if ( test_card
!= NULL
)
144 if ( mlt_properties_get_data( properties
, "test_card_producer", NULL
) == NULL
)
146 // Create a test card producer
147 // TODO: do we want to use fezzik here?
148 mlt_producer producer
= mlt_factory_producer( "fezzik", test_card
);
150 // Do we have a producer
151 if ( producer
!= NULL
)
153 // Test card should loop I guess...
154 mlt_properties_set( mlt_producer_properties( producer
), "eof", "loop" );
156 // Set the test card on the consumer
157 mlt_properties_set_data( properties
, "test_card_producer", producer
, 0, ( mlt_destructor
)mlt_producer_close
, NULL
);
160 // Check and run an ante command
161 if ( mlt_properties_get( properties
, "ante" ) )
162 system( mlt_properties_get( properties
, "ante" ) );
167 // Allow the hash table to speed things up
168 mlt_properties_set_data( properties
, "test_card_producer", NULL
, 0, NULL
, NULL
);
171 // Set the real_time preference
172 this->real_time
= mlt_properties_get_int( properties
, "real_time" );
175 if ( this->start
!= NULL
)
176 return this->start( this );
181 /** Protected method for consumer to get frames from connected service
184 mlt_frame
mlt_consumer_get_frame( mlt_consumer
this )
187 mlt_frame frame
= NULL
;
189 // Get the service assoicated to the consumer
190 mlt_service service
= mlt_consumer_service( this );
193 if ( mlt_service_get_frame( service
, &frame
, 0 ) == 0 )
195 // Get the consumer properties
196 mlt_properties properties
= mlt_consumer_properties( this );
198 // Get the frame properties
199 mlt_properties frame_properties
= mlt_frame_properties( frame
);
201 // Get the test card producer
202 mlt_producer test_card
= mlt_properties_get_data( properties
, "test_card_producer", NULL
);
204 // Attach the test frame producer to it.
205 if ( test_card
!= NULL
)
206 mlt_properties_set_data( frame_properties
, "test_card_producer", test_card
, 0, NULL
, NULL
);
208 // Attach the rescale property
209 mlt_properties_set( frame_properties
, "rescale.interp", mlt_properties_get( properties
, "rescale" ) );
211 // Aspect ratio and other jiggery pokery
212 mlt_properties_set_double( frame_properties
, "consumer_aspect_ratio", mlt_properties_get_double( properties
, "aspect_ratio" ) );
213 mlt_properties_set_int( frame_properties
, "consumer_progressive", mlt_properties_get_int( properties
, "progressive" ) );
214 mlt_properties_set_int( frame_properties
, "consumer_deinterlace", mlt_properties_get_int( properties
, "deinterlace" ) );
221 static inline long time_difference( struct timeval
*time1
)
223 struct timeval time2
;
224 time2
.tv_sec
= time1
->tv_sec
;
225 time2
.tv_usec
= time1
->tv_usec
;
226 gettimeofday( time1
, NULL
);
227 return time1
->tv_sec
* 1000000 + time1
->tv_usec
- time2
.tv_sec
* 1000000 - time2
.tv_usec
;
230 static void *consumer_read_ahead_thread( void *arg
)
232 // The argument is the consumer
233 mlt_consumer
this = arg
;
235 // Get the properties of the consumer
236 mlt_properties properties
= mlt_consumer_properties( this );
238 // Get the width and height
239 int width
= mlt_properties_get_int( properties
, "width" );
240 int height
= mlt_properties_get_int( properties
, "height" );
242 // Get the maximum size of the buffer
243 int buffer
= mlt_properties_get_int( properties
, "buffer" );
245 // General frame variable
246 mlt_frame frame
= NULL
;
247 uint8_t *image
= NULL
;
252 // Average time for get_frame and get_image
255 int64_t time_wait
= 0;
256 int64_t time_frame
= 0;
257 int64_t time_image
= 0;
259 // Get the first frame
260 frame
= mlt_consumer_get_frame( this );
262 // Get the image of the first frame
263 mlt_frame_get_image( frame
, &image
, &this->format
, &width
, &height
, 0 );
264 mlt_properties_set_int( mlt_frame_properties( frame
), "rendered", 1 );
266 // Get the starting time (can ignore the times above)
267 gettimeofday( &ante
, NULL
);
269 // Continue to read ahead
270 while ( this->ahead
)
272 // Put the current frame into the queue
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
);
281 // Get the next frame
282 frame
= mlt_consumer_get_frame( this );
283 time_frame
+= time_difference( &ante
);
285 // Increment the count
289 if ( ( time_frame
+ time_image
) / count
< ( 40000 - ( time_wait
/ count
) ) )
291 // Get the image, mark as rendered and time it
292 mlt_frame_get_image( frame
, &image
, &this->format
, &width
, &height
, 0 );
293 mlt_properties_set_int( mlt_frame_properties( frame
), "rendered", 1 );
294 time_image
+= time_difference( &ante
);
296 // Reset the skipped count
301 // Increment the number of sequentially skipped frames
304 // If we've reached an unacceptable level, reset everything
316 // Remove the last frame
317 mlt_frame_close( frame
);
322 static void consumer_read_ahead_start( mlt_consumer
this )
324 pthread_attr_t thread_attributes
;
329 // Create the frame queue
330 this->queue
= mlt_deque_init( );
333 pthread_mutex_init( &this->mutex
, NULL
);
335 // Create the condition
336 pthread_cond_init( &this->cond
, NULL
);
338 // Inherit the scheduling priority
339 pthread_attr_init( &thread_attributes
);
340 pthread_attr_setinheritsched( &thread_attributes
, PTHREAD_INHERIT_SCHED
);
342 // Create the read ahead
343 pthread_create( &this->ahead_thread
, &thread_attributes
, consumer_read_ahead_thread
, this );
347 static void consumer_read_ahead_stop( mlt_consumer
this )
349 // Make sure we're running
352 // Inform thread to stop
355 // Broadcast to the condition in case it's waiting
356 pthread_mutex_lock( &this->mutex
);
357 pthread_cond_broadcast( &this->cond
);
358 pthread_mutex_unlock( &this->mutex
);
361 pthread_join( this->ahead_thread
, NULL
);
364 pthread_mutex_destroy( &this->mutex
);
366 // Destroy the condition
367 pthread_cond_destroy( &this->cond
);
370 while ( mlt_deque_count( this->queue
) )
371 mlt_frame_close( mlt_deque_pop_back( this->queue
) );
375 mlt_frame
mlt_consumer_rt_frame( mlt_consumer
this )
378 mlt_frame frame
= NULL
;
380 // Get the properties
381 mlt_properties properties
= mlt_consumer_properties( this );
383 // Check if the user has requested real time or not
384 if ( this->real_time
)
388 // Is the read ahead running?
389 if ( this->ahead
== 0 )
391 int buffer
= mlt_properties_get_int( properties
, "buffer" );
392 consumer_read_ahead_start( this );
397 // Get frame from queue
398 pthread_mutex_lock( &this->mutex
);
399 while( this->ahead
&& mlt_deque_count( this->queue
) < size
)
400 pthread_cond_wait( &this->cond
, &this->mutex
);
401 frame
= mlt_deque_pop_front( this->queue
);
402 pthread_cond_broadcast( &this->cond
);
403 pthread_mutex_unlock( &this->mutex
);
407 // Get the frame in non real time
408 frame
= mlt_consumer_get_frame( this );
410 // This isn't true, but from the consumers perspective it is
411 mlt_properties_set_int( mlt_frame_properties( frame
), "rendered", 1 );
417 /** Stop the consumer.
420 int mlt_consumer_stop( mlt_consumer
this )
423 mlt_properties properties
= mlt_consumer_properties( this );
426 if ( this->stop
!= NULL
)
429 // Check if the user has requested real time or not and stop if necessary
430 if ( mlt_properties_get_int( properties
, "real_time" ) )
431 consumer_read_ahead_stop( this );
433 // Kill the test card
434 mlt_properties_set_data( properties
, "test_card_producer", NULL
, 0, NULL
, NULL
);
436 // Check and run a post command
437 if ( mlt_properties_get( properties
, "post" ) )
438 system( mlt_properties_get( properties
, "post" ) );
443 /** Determine if the consumer is stopped.
446 int mlt_consumer_is_stopped( mlt_consumer
this )
448 // Check if the consumer is stopped
449 if ( this->is_stopped
!= NULL
)
450 return this->is_stopped( this );
455 /** Close the consumer.
458 void mlt_consumer_close( mlt_consumer
this )
460 // Get the childs close function
461 void ( *consumer_close
)( ) = this->close
;
463 // Make sure it only gets called once
466 // Call the childs close if available
467 if ( consumer_close
!= NULL
)
468 consumer_close( this );
470 mlt_service_close( &this->parent
);