3 * \brief abstraction for all consumer services
6 * Copyright (C) 2003-2010 Ushodaya Enterprises Limited
7 * \author Charles Yates <charles.yates@pandora.be>
8 * \author Dan Dennedy <dan@dennedy.org>
10 * This library is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Lesser General Public
12 * License as published by the Free Software Foundation; either
13 * version 2.1 of the License, or (at your option) any later version.
15 * This library is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with this library; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 #include "mlt_consumer.h"
26 #include "mlt_factory.h"
27 #include "mlt_producer.h"
28 #include "mlt_frame.h"
29 #include "mlt_profile.h"
37 /** Define this if you want an automatic deinterlace (if necessary) when the
38 * consumer's producer is not running at normal speed.
40 #undef DEINTERLACE_ON_NOT_NORMAL_SPEED
42 /** This is not the ideal place for this, but it is needed by VDPAU as well.
44 pthread_mutex_t mlt_sdl_mutex = PTHREAD_MUTEX_INITIALIZER;
46 static void mlt_consumer_frame_render( mlt_listener listener, mlt_properties owner, mlt_service self, void **args );
47 static void mlt_consumer_frame_show( mlt_listener listener, mlt_properties owner, mlt_service self, void **args );
48 static void mlt_consumer_property_changed( mlt_properties owner, mlt_consumer self, char *name );
49 static void apply_profile_properties( mlt_consumer self, mlt_profile profile, mlt_properties properties );
50 static void on_consumer_frame_show( mlt_properties owner, mlt_consumer self, mlt_frame frame );
52 /** Initialize a consumer service.
54 * \public \memberof mlt_consumer_s
55 * \param self the consumer to initialize
56 * \param child a pointer to the object for the subclass
57 * \param profile the \p mlt_profile_s to use (optional but recommended,
58 * uses the environment variable MLT if self is NULL)
59 * \return true if there was an error
62 int mlt_consumer_init( mlt_consumer self, void *child, mlt_profile profile )
65 memset( self, 0, sizeof( struct mlt_consumer_s ) );
67 error = mlt_service_init( &self->parent, self );
70 // Get the properties from the service
71 mlt_properties properties = MLT_SERVICE_PROPERTIES( &self->parent );
73 // Apply profile to properties
74 if ( profile == NULL )
76 // Normally the application creates the profile and controls its lifetime
77 // This is the fallback exception handling
78 profile = mlt_profile_init( NULL );
79 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
80 mlt_properties_set_data( properties, "_profile", profile, 0, (mlt_destructor)mlt_profile_close, NULL );
82 apply_profile_properties( self, profile, properties );
84 // Default rescaler for all consumers
85 mlt_properties_set( properties, "rescale", "bilinear" );
87 // Default read ahead buffer size
88 mlt_properties_set_int( properties, "buffer", 25 );
90 // Default audio frequency and channels
91 mlt_properties_set_int( properties, "frequency", 48000 );
92 mlt_properties_set_int( properties, "channels", 2 );
94 // Default of all consumers is real time
95 mlt_properties_set_int( properties, "real_time", 1 );
97 // Default to environment test card
98 mlt_properties_set( properties, "test_card", mlt_environment( "MLT_TEST_CARD" ) );
100 // Hmm - default all consumers to yuv422 :-/
101 self->format = mlt_image_yuv422;
103 mlt_events_register( properties, "consumer-frame-show", ( mlt_transmitter )mlt_consumer_frame_show );
104 mlt_events_register( properties, "consumer-frame-render", ( mlt_transmitter )mlt_consumer_frame_render );
105 mlt_events_register( properties, "consumer-stopped", NULL );
106 mlt_events_listen( properties, self, "consumer-frame-show", ( mlt_listener )on_consumer_frame_show );
108 // Register a property-changed listener to handle the profile property -
109 // subsequent properties can override the profile
110 self->event_listener = mlt_events_listen( properties, self, "property-changed", ( mlt_listener )mlt_consumer_property_changed );
112 // Create the push mutex and condition
113 pthread_mutex_init( &self->put_mutex, NULL );
114 pthread_cond_init( &self->put_cond, NULL );
120 /** Convert the profile into properties on the consumer.
122 * \private \memberof mlt_consumer_s
123 * \param self a consumer
124 * \param profile a profile
125 * \param properties a properties list (typically, the consumer's)
128 static void apply_profile_properties( mlt_consumer self, mlt_profile profile, mlt_properties properties )
130 mlt_event_block( self->event_listener );
131 mlt_properties_set_double( properties, "fps", mlt_profile_fps( profile ) );
132 mlt_properties_set_int( properties, "frame_rate_num", profile->frame_rate_num );
133 mlt_properties_set_int( properties, "frame_rate_den", profile->frame_rate_den );
134 mlt_properties_set_int( properties, "width", profile->width );
135 mlt_properties_set_int( properties, "height", profile->height );
136 mlt_properties_set_int( properties, "progressive", profile->progressive );
137 mlt_properties_set_double( properties, "aspect_ratio", mlt_profile_sar( profile ) );
138 mlt_properties_set_int( properties, "sample_aspect_num", profile->sample_aspect_num );
139 mlt_properties_set_int( properties, "sample_aspect_den", profile->sample_aspect_den );
140 mlt_properties_set_double( properties, "display_ratio", mlt_profile_dar( profile ) );
141 mlt_properties_set_int( properties, "display_aspect_num", profile->display_aspect_num );
142 mlt_properties_set_int( properties, "display_aspect_num", profile->display_aspect_num );
143 mlt_properties_set_int( properties, "colorspace", profile->colorspace );
144 mlt_event_unblock( self->event_listener );
147 /** The property-changed event listener
149 * \private \memberof mlt_consumer_s
150 * \param owner the events object
151 * \param self the consumer
152 * \param name the name of the property that changed
155 static void mlt_consumer_property_changed( mlt_properties owner, mlt_consumer self, char *name )
157 if ( !strcmp( name, "profile" ) )
160 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
162 // Get the current profile
163 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
165 // Load the new profile
166 mlt_profile new_profile = mlt_profile_init( mlt_properties_get( properties, name ) );
171 if ( profile != NULL )
173 free( profile->description );
174 memcpy( profile, new_profile, sizeof( struct mlt_profile_s ) );
175 profile->description = strdup( new_profile->description );
176 mlt_profile_close( new_profile );
180 profile = new_profile;
183 // Apply to properties
184 apply_profile_properties( self, profile, properties );
187 else if ( !strcmp( name, "frame_rate_num" ) )
189 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
190 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
193 profile->frame_rate_num = mlt_properties_get_int( properties, "frame_rate_num" );
194 mlt_properties_set_double( properties, "fps", mlt_profile_fps( profile ) );
197 else if ( !strcmp( name, "frame_rate_den" ) )
199 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
200 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
203 profile->frame_rate_den = mlt_properties_get_int( properties, "frame_rate_den" );
204 mlt_properties_set_double( properties, "fps", mlt_profile_fps( profile ) );
207 else if ( !strcmp( name, "width" ) )
209 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
210 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
212 profile->width = mlt_properties_get_int( properties, "width" );
214 else if ( !strcmp( name, "height" ) )
216 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
217 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
219 profile->height = mlt_properties_get_int( properties, "height" );
221 else if ( !strcmp( name, "progressive" ) )
223 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
224 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
226 profile->progressive = mlt_properties_get_int( properties, "progressive" );
228 else if ( !strcmp( name, "sample_aspect_num" ) )
230 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
231 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
232 profile->sample_aspect_num = mlt_properties_get_int( properties, "sample_aspect_num" );
234 mlt_properties_set_double( properties, "aspect_ratio", mlt_profile_sar( profile ) );
236 else if ( !strcmp( name, "sample_aspect_den" ) )
238 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
239 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
240 profile->sample_aspect_den = mlt_properties_get_int( properties, "sample_aspect_den" );
242 mlt_properties_set_double( properties, "aspect_ratio", mlt_profile_sar( profile ) );
244 else if ( !strcmp( name, "display_aspect_num" ) )
246 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
247 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
250 profile->display_aspect_num = mlt_properties_get_int( properties, "display_aspect_num" );
251 mlt_properties_set_double( properties, "display_ratio", mlt_profile_dar( profile ) );
254 else if ( !strcmp( name, "display_aspect_den" ) )
256 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
257 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
260 profile->display_aspect_den = mlt_properties_get_int( properties, "display_aspect_den" );
261 mlt_properties_set_double( properties, "display_ratio", mlt_profile_dar( profile ) );
264 else if ( !strcmp( name, "colorspace" ) )
266 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
267 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
269 profile->colorspace = mlt_properties_get_int( properties, "colorspace" );
273 /** The transmitter for the consumer-frame-show event
275 * Invokes the listener.
277 * \private \memberof mlt_consumer_s
278 * \param listener a function pointer that will be invoked
279 * \param owner the events object that will be passed to \p listener
280 * \param self a service that will be passed to \p listener
281 * \param args an array of pointers - the first entry is passed as a string to \p listener
284 static void mlt_consumer_frame_show( mlt_listener listener, mlt_properties owner, mlt_service self, void **args )
286 if ( listener != NULL )
287 listener( owner, self, ( mlt_frame )args[ 0 ] );
290 /** The transmitter for the consumer-frame-render event
292 * Invokes the listener.
294 * \private \memberof mlt_consumer_s
295 * \param listener a function pointer that will be invoked
296 * \param owner the events object that will be passed to \p listener
297 * \param self a service that will be passed to \p listener
298 * \param args an array of pointers - the first entry is passed as a string to \p listener
301 static void mlt_consumer_frame_render( mlt_listener listener, mlt_properties owner, mlt_service self, void **args )
303 if ( listener != NULL )
304 listener( owner, self, ( mlt_frame )args[ 0 ] );
307 /** A listener on the consumer-frame-show event
309 * Saves the position of the frame shown.
311 * \private \memberof mlt_consumer_s
312 * \param owner the events object
313 * \param consumer the consumer on which this event occurred
314 * \param frame the frame that was shown
317 static void on_consumer_frame_show( mlt_properties owner, mlt_consumer consumer, mlt_frame frame )
320 consumer->position = mlt_frame_get_position( frame );
323 /** Create a new consumer.
325 * \public \memberof mlt_consumer_s
326 * \param profile a profile (optional, but recommended)
327 * \return a new consumer
330 mlt_consumer mlt_consumer_new( mlt_profile profile )
332 // Create the memory for the structure
333 mlt_consumer self = malloc( sizeof( struct mlt_consumer_s ) );
337 mlt_consumer_init( self, NULL, profile );
343 /** Get the parent service object.
345 * \public \memberof mlt_consumer_s
346 * \param self a consumer
347 * \return the parent service class
348 * \see MLT_CONSUMER_SERVICE
351 mlt_service mlt_consumer_service( mlt_consumer self )
353 return self != NULL ? &self->parent : NULL;
356 /** Get the consumer properties.
358 * \public \memberof mlt_consumer_s
359 * \param self a consumer
360 * \return the consumer's properties list
361 * \see MLT_CONSUMER_PROPERTIES
364 mlt_properties mlt_consumer_properties( mlt_consumer self )
366 return self != NULL ? MLT_SERVICE_PROPERTIES( &self->parent ) : NULL;
369 /** Connect the consumer to the producer.
371 * \public \memberof mlt_consumer_s
372 * \param self a consumer
373 * \param producer a producer
374 * \return > 0 warning, == 0 success, < 0 serious error,
375 * 1 = this service does not accept input,
376 * 2 = the producer is invalid,
377 * 3 = the producer is already registered with this consumer
380 int mlt_consumer_connect( mlt_consumer self, mlt_service producer )
382 return mlt_service_connect_producer( &self->parent, producer, 0 );
385 /** Start the consumer.
387 * \public \memberof mlt_consumer_s
388 * \param self a consumer
389 * \return true if there was an error
392 int mlt_consumer_start( mlt_consumer self )
394 // Stop listening to the property-changed event
395 mlt_event_block( self->event_listener );
398 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
400 // Determine if there's a test card producer
401 char *test_card = mlt_properties_get( properties, "test_card" );
403 // Just to make sure nothing is hanging around...
405 self->put_active = 1;
408 if ( test_card != NULL )
410 if ( mlt_properties_get_data( properties, "test_card_producer", NULL ) == NULL )
412 // Create a test card producer
413 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
414 mlt_producer producer = mlt_factory_producer( profile, NULL, test_card );
416 // Do we have a producer
417 if ( producer != NULL )
419 // Test card should loop I guess...
420 mlt_properties_set( MLT_PRODUCER_PROPERTIES( producer ), "eof", "loop" );
421 //mlt_producer_set_speed( producer, 0 );
422 //mlt_producer_set_in_and_out( producer, 0, 0 );
424 // Set the test card on the consumer
425 mlt_properties_set_data( properties, "test_card_producer", producer, 0, ( mlt_destructor )mlt_producer_close, NULL );
431 // Allow the hash table to speed things up
432 mlt_properties_set_data( properties, "test_card_producer", NULL, 0, NULL, NULL );
435 // Set the frame duration in microseconds for the frame-dropping heuristic
436 int frame_duration = 1000000 / mlt_properties_get_int( properties, "frame_rate_num" ) *
437 mlt_properties_get_int( properties, "frame_rate_den" );
438 mlt_properties_set_int( properties, "frame_duration", frame_duration );
440 // Check and run an ante command
441 if ( mlt_properties_get( properties, "ante" ) )
442 if ( system( mlt_properties_get( properties, "ante" ) ) == -1 )
443 mlt_log( MLT_CONSUMER_SERVICE( self ), MLT_LOG_ERROR, "system(%s) failed!\n", mlt_properties_get( properties, "ante" ) );
445 // Set the real_time preference
446 self->real_time = mlt_properties_get_int( properties, "real_time" );
448 // For worker threads implementation, buffer must be at least # threads
449 if ( abs( self->real_time ) > 1 && mlt_properties_get_int( properties, "buffer" ) <= abs( self->real_time ) )
450 mlt_properties_set_int( properties, "buffer", abs( self->real_time ) + 1 );
453 if ( self->start != NULL )
454 return self->start( self );
459 /** An alternative method to feed frames into the consumer.
461 * Only valid if the consumer itself is not connected.
463 * \public \memberof mlt_consumer_s
464 * \param self a consumer
465 * \param frame a frame
466 * \return true (ignore self for now)
469 int mlt_consumer_put_frame( mlt_consumer self, mlt_frame frame )
473 // Get the service assoicated to the consumer
474 mlt_service service = MLT_CONSUMER_SERVICE( self );
476 if ( mlt_service_producer( service ) == NULL )
480 pthread_mutex_lock( &self->put_mutex );
481 while ( self->put_active && self->put != NULL )
483 gettimeofday( &now, NULL );
484 tm.tv_sec = now.tv_sec + 1;
485 tm.tv_nsec = now.tv_usec * 1000;
486 pthread_cond_timedwait( &self->put_cond, &self->put_mutex, &tm );
488 if ( self->put_active && self->put == NULL )
491 mlt_frame_close( frame );
492 pthread_cond_broadcast( &self->put_cond );
493 pthread_mutex_unlock( &self->put_mutex );
497 mlt_frame_close( frame );
503 /** Protected method for consumer to get frames from connected service
505 * \public \memberof mlt_consumer_s
506 * \param self a consumer
510 mlt_frame mlt_consumer_get_frame( mlt_consumer self )
513 mlt_frame frame = NULL;
515 // Get the service assoicated to the consumer
516 mlt_service service = MLT_CONSUMER_SERVICE( self );
518 // Get the consumer properties
519 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
522 if ( mlt_service_producer( service ) == NULL && mlt_properties_get_int( properties, "put_mode" ) )
526 pthread_mutex_lock( &self->put_mutex );
527 while ( self->put_active && self->put == NULL )
529 gettimeofday( &now, NULL );
530 tm.tv_sec = now.tv_sec + 1;
531 tm.tv_nsec = now.tv_usec * 1000;
532 pthread_cond_timedwait( &self->put_cond, &self->put_mutex, &tm );
536 pthread_cond_broadcast( &self->put_cond );
537 pthread_mutex_unlock( &self->put_mutex );
539 mlt_service_apply_filters( service, frame, 0 );
541 else if ( mlt_service_producer( service ) != NULL )
543 mlt_service_get_frame( service, &frame, 0 );
547 frame = mlt_frame_init( service );
552 // Get the frame properties
553 mlt_properties frame_properties = MLT_FRAME_PROPERTIES( frame );
555 // Get the test card producer
556 mlt_producer test_card = mlt_properties_get_data( properties, "test_card_producer", NULL );
558 // Attach the test frame producer to it.
559 if ( test_card != NULL )
560 mlt_properties_set_data( frame_properties, "test_card_producer", test_card, 0, NULL, NULL );
562 // Attach the rescale property
563 mlt_properties_set( frame_properties, "rescale.interp", mlt_properties_get( properties, "rescale" ) );
565 // Aspect ratio and other jiggery pokery
566 mlt_properties_set_double( frame_properties, "consumer_aspect_ratio", mlt_properties_get_double( properties, "aspect_ratio" ) );
567 mlt_properties_set_int( frame_properties, "consumer_deinterlace", mlt_properties_get_int( properties, "progressive" ) | mlt_properties_get_int( properties, "deinterlace" ) );
568 mlt_properties_set( frame_properties, "deinterlace_method", mlt_properties_get( properties, "deinterlace_method" ) );
575 /** Compute the time difference between now and a time value.
577 * \private \memberof mlt_consumer_s
578 * \param time1 a time value to be compared against now
579 * \return the difference in microseconds
582 static inline long time_difference( struct timeval *time1 )
584 struct timeval time2;
585 time2.tv_sec = time1->tv_sec;
586 time2.tv_usec = time1->tv_usec;
587 gettimeofday( time1, NULL );
588 return time1->tv_sec * 1000000 + time1->tv_usec - time2.tv_sec * 1000000 - time2.tv_usec;
591 /** The thread procedure for asynchronously pulling frames through the service
592 * network connected to a consumer.
594 * \private \memberof mlt_consumer_s
595 * \param arg a consumer
598 static void *consumer_read_ahead_thread( void *arg )
600 // The argument is the consumer
601 mlt_consumer self = arg;
603 // Get the properties of the consumer
604 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
606 // Get the width and height
607 int width = mlt_properties_get_int( properties, "width" );
608 int height = mlt_properties_get_int( properties, "height" );
610 // See if video is turned off
611 int video_off = mlt_properties_get_int( properties, "video_off" );
612 int preview_off = mlt_properties_get_int( properties, "preview_off" );
613 int preview_format = mlt_properties_get_int( properties, "preview_format" );
615 // Get the audio settings
616 mlt_audio_format afmt = mlt_audio_s16;
618 double fps = mlt_properties_get_double( properties, "fps" );
619 int channels = mlt_properties_get_int( properties, "channels" );
620 int frequency = mlt_properties_get_int( properties, "frequency" );
624 // See if audio is turned off
625 int audio_off = mlt_properties_get_int( properties, "audio_off" );
627 // Get the maximum size of the buffer
628 int buffer = mlt_properties_get_int( properties, "buffer" ) + 1;
630 // General frame variable
631 mlt_frame frame = NULL;
632 uint8_t *image = NULL;
637 // Average time for get_frame and get_image
640 int64_t time_wait = 0;
641 int64_t time_frame = 0;
642 int64_t time_process = 0;
645 if ( preview_off && preview_format != 0 )
646 self->format = preview_format;
648 // Get the first frame
649 frame = mlt_consumer_get_frame( self );
651 // Get the image of the first frame
654 mlt_events_fire( MLT_CONSUMER_PROPERTIES( self ), "consumer-frame-render", frame, NULL );
655 mlt_frame_get_image( frame, &image, &self->format, &width, &height, 0 );
660 samples = mlt_sample_calculator( fps, frequency, counter++ );
661 mlt_frame_get_audio( frame, &audio, &afmt, &frequency, &channels, &samples );
665 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "rendered", 1 );
667 // Get the starting time (can ignore the times above)
668 gettimeofday( &ante, NULL );
670 // Continue to read ahead
671 while ( self->ahead )
673 // Fetch width/height again
674 width = mlt_properties_get_int( properties, "width" );
675 height = mlt_properties_get_int( properties, "height" );
677 // Put the current frame into the queue
678 pthread_mutex_lock( &self->queue_mutex );
679 while( self->ahead && mlt_deque_count( self->queue ) >= buffer )
680 pthread_cond_wait( &self->queue_cond, &self->queue_mutex );
681 mlt_deque_push_back( self->queue, frame );
682 pthread_cond_broadcast( &self->queue_cond );
683 pthread_mutex_unlock( &self->queue_mutex );
685 time_wait += time_difference( &ante );
687 // Get the next frame
688 frame = mlt_consumer_get_frame( self );
689 time_frame += time_difference( &ante );
691 // If there's no frame, we're probably stopped...
695 // Increment the count
698 // All non normal playback frames should be shown
699 if ( mlt_properties_get_int( MLT_FRAME_PROPERTIES( frame ), "_speed" ) != 1 )
701 #ifdef DEINTERLACE_ON_NOT_NORMAL_SPEED
702 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "consumer_deinterlace", 1 );
713 if ( !skip_next || self->real_time == -1 )
715 // Get the image, mark as rendered and time it
718 mlt_events_fire( MLT_CONSUMER_PROPERTIES( self ), "consumer-frame-render", frame, NULL );
719 mlt_frame_get_image( frame, &image, &self->format, &width, &height, 0 );
721 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "rendered", 1 );
725 // Increment the number of sequentially skipped frames
729 // If we've reached an unacceptable level, reset everything
730 if ( skipped > fps * 2 )
740 // Always process audio
743 samples = mlt_sample_calculator( fps, frequency, counter++ );
744 mlt_frame_get_audio( frame, &audio, &afmt, &frequency, &channels, &samples );
747 // Increment the time take for self frame
748 time_process += time_difference( &ante );
750 // Determine if the next frame should be skipped
751 if ( mlt_deque_count( self->queue ) <= 5 )
753 int frame_duration = mlt_properties_get_int( properties, "frame_duration" );
754 if ( ( ( time_wait + time_frame + time_process ) / count ) > frame_duration )
759 // Remove the last frame
760 mlt_frame_close( frame );
765 /** Locate the first unprocessed frame in the queue.
767 * When playing with realtime behavior, we do not use the true head, but
768 * rather an adjusted process_head. The process_head is adjusted based on
769 * the rate of frame-dropping or recovery from frame-dropping. The idea is
770 * that as the level of frame-dropping increases to move the process_head
771 * closer to the tail because the frames are not completing processing prior
772 * to their playout! Then, as frames are not dropped the process_head moves
773 * back closer to the head of the queue so that worker threads can work
774 * ahead of the playout point (queue head).
776 * \private \memberof mlt_consumer_s
777 * \param self a consumer
778 * \return an index into the queue
781 static inline int first_unprocessed_frame( mlt_consumer self )
783 int index = self->real_time <= 0 ? 0 : self->process_head;
784 while ( index < mlt_deque_count( self->queue ) && MLT_FRAME( mlt_deque_peek( self->queue, index ) )->is_processing )
789 /** The worker thread procedure for parallel processing frames.
791 * \private \memberof mlt_consumer_s
792 * \param arg a consumer
795 static void *consumer_worker_thread( void *arg )
797 // The argument is the consumer
798 mlt_consumer self = arg;
800 // Get the properties of the consumer
801 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
803 // Get the width and height
804 int width = mlt_properties_get_int( properties, "width" );
805 int height = mlt_properties_get_int( properties, "height" );
806 mlt_image_format format = self->format;
808 // See if video is turned off
809 int video_off = mlt_properties_get_int( properties, "video_off" );
810 int preview_off = mlt_properties_get_int( properties, "preview_off" );
811 int preview_format = mlt_properties_get_int( properties, "preview_format" );
813 // General frame variable
814 mlt_frame frame = NULL;
815 uint8_t *image = NULL;
817 if ( preview_off && preview_format != 0 )
818 format = preview_format;
820 // Continue to read ahead
821 while ( self->ahead )
823 // Get the next unprocessed frame from the work queue
824 pthread_mutex_lock( &self->queue_mutex );
825 int index = first_unprocessed_frame( self );
826 while ( self->ahead && index >= mlt_deque_count( self->queue ) )
828 mlt_log_debug( MLT_CONSUMER_SERVICE(self), "waiting in worker index = %d queue count = %d\n",
829 index, mlt_deque_count( self->queue ) );
830 pthread_cond_wait( &self->queue_cond, &self->queue_mutex );
831 index = first_unprocessed_frame( self );
834 // Mark the frame for processing
835 frame = mlt_deque_peek( self->queue, index );
838 mlt_log_debug( MLT_CONSUMER_SERVICE(self), "worker processing index = %d frame %d queue count = %d\n",
839 index, mlt_frame_get_position(frame), mlt_deque_count( self->queue ) );
840 frame->is_processing = 1;
841 mlt_properties_inc_ref( MLT_FRAME_PROPERTIES( frame ) );
843 pthread_mutex_unlock( &self->queue_mutex );
845 // If there's no frame, we're probably stopped...
849 #ifdef DEINTERLACE_ON_NOT_NORMAL_SPEED
850 // All non normal playback frames should be shown
851 if ( mlt_properties_get_int( MLT_FRAME_PROPERTIES( frame ), "_speed" ) != 1 )
852 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "consumer_deinterlace", 1 );
858 // Fetch width/height again
859 width = mlt_properties_get_int( properties, "width" );
860 height = mlt_properties_get_int( properties, "height" );
861 mlt_events_fire( MLT_CONSUMER_PROPERTIES( self ), "consumer-frame-render", frame, NULL );
862 mlt_frame_get_image( frame, &image, &format, &width, &height, 0 );
864 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "rendered", 1 );
865 mlt_frame_close( frame );
867 // Tell a waiting thread (non-realtime main consumer thread) that we are done.
868 pthread_mutex_lock( &self->done_mutex );
869 pthread_cond_broadcast( &self->done_cond );
870 pthread_mutex_unlock( &self->done_mutex );
876 /** Start the read/render thread.
878 * \private \memberof mlt_consumer_s
879 * \param self a consumer
882 static void consumer_read_ahead_start( mlt_consumer self )
887 // Create the frame queue
888 self->queue = mlt_deque_init( );
890 // Create the queue mutex
891 pthread_mutex_init( &self->queue_mutex, NULL );
893 // Create the condition
894 pthread_cond_init( &self->queue_cond, NULL );
896 // Create the read ahead
897 if ( mlt_properties_get( MLT_CONSUMER_PROPERTIES( self ), "priority" ) )
899 struct sched_param priority;
900 priority.sched_priority = mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( self ), "priority" );
901 pthread_attr_t thread_attributes;
902 pthread_attr_init( &thread_attributes );
903 pthread_attr_setschedpolicy( &thread_attributes, SCHED_OTHER );
904 pthread_attr_setschedparam( &thread_attributes, &priority );
905 pthread_attr_setinheritsched( &thread_attributes, PTHREAD_EXPLICIT_SCHED );
906 pthread_attr_setscope( &thread_attributes, PTHREAD_SCOPE_SYSTEM );
907 if ( pthread_create( &self->ahead_thread, &thread_attributes, consumer_read_ahead_thread, self ) < 0 )
908 pthread_create( &self->ahead_thread, NULL, consumer_read_ahead_thread, self );
909 pthread_attr_destroy( &thread_attributes );
913 pthread_create( &self->ahead_thread, NULL, consumer_read_ahead_thread, self );
918 /** Start the worker threads.
920 * \private \memberof mlt_consumer_s
921 * \param self a consumer
924 static void consumer_work_start( mlt_consumer self )
926 int n = abs( self->real_time );
927 pthread_t *thread = calloc( 1, sizeof( pthread_t ) * n );
932 // These keep track of the accelleration of frame dropping or recovery.
933 self->consecutive_dropped = 0;
934 self->consecutive_rendered = 0;
936 // This is the position in the queue from which to look for a frame to process.
937 // If we always start from the head, then we may likely not complete processing
938 // before the frame is played out.
939 self->process_head = 0;
942 self->queue = mlt_deque_init();
943 self->worker_threads = mlt_deque_init();
945 // Create the mutexes
946 pthread_mutex_init( &self->queue_mutex, NULL );
947 pthread_mutex_init( &self->done_mutex, NULL );
949 // Create the conditions
950 pthread_cond_init( &self->queue_cond, NULL );
951 pthread_cond_init( &self->done_cond, NULL );
953 // Create the read ahead
954 if ( mlt_properties_get( MLT_CONSUMER_PROPERTIES( self ), "priority" ) )
957 struct sched_param priority;
958 pthread_attr_t thread_attributes;
960 priority.sched_priority = mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( self ), "priority" );
961 pthread_attr_init( &thread_attributes );
962 pthread_attr_setschedpolicy( &thread_attributes, SCHED_OTHER );
963 pthread_attr_setschedparam( &thread_attributes, &priority );
964 pthread_attr_setinheritsched( &thread_attributes, PTHREAD_EXPLICIT_SCHED );
965 pthread_attr_setscope( &thread_attributes, PTHREAD_SCOPE_SYSTEM );
969 if ( pthread_create( thread, &thread_attributes, consumer_worker_thread, self ) < 0 )
970 if ( pthread_create( thread, NULL, consumer_worker_thread, self ) == 0 )
971 mlt_deque_push_back( self->worker_threads, thread );
974 pthread_attr_destroy( &thread_attributes );
981 if ( pthread_create( thread, NULL, consumer_worker_thread, self ) == 0 )
982 mlt_deque_push_back( self->worker_threads, thread );
989 /** Stop the read/render thread.
991 * \private \memberof mlt_consumer_s
992 * \param self a consumer
995 static void consumer_read_ahead_stop( mlt_consumer self )
997 // Make sure we're running
1000 // Inform thread to stop
1003 // Broadcast to the condition in case it's waiting
1004 pthread_mutex_lock( &self->queue_mutex );
1005 pthread_cond_broadcast( &self->queue_cond );
1006 pthread_mutex_unlock( &self->queue_mutex );
1008 // Broadcast to the put condition in case it's waiting
1009 pthread_mutex_lock( &self->put_mutex );
1010 pthread_cond_broadcast( &self->put_cond );
1011 pthread_mutex_unlock( &self->put_mutex );
1014 pthread_join( self->ahead_thread, NULL );
1017 // Destroy the frame queue mutex
1018 pthread_mutex_destroy( &self->queue_mutex );
1020 // Destroy the condition
1021 pthread_cond_destroy( &self->queue_cond );
1024 while ( mlt_deque_count( self->queue ) )
1025 mlt_frame_close( mlt_deque_pop_back( self->queue ) );
1028 mlt_deque_close( self->queue );
1032 /** Stop the worker threads.
1034 * \private \memberof mlt_consumer_s
1035 * \param self a consumer
1038 static void consumer_work_stop( mlt_consumer self )
1040 // Make sure we're running
1041 if ( self->started )
1043 // Inform thread to stop
1046 // Broadcast to the queue condition in case it's waiting
1047 pthread_mutex_lock( &self->queue_mutex );
1048 pthread_cond_broadcast( &self->queue_cond );
1049 pthread_mutex_unlock( &self->queue_mutex );
1051 // Broadcast to the put condition in case it's waiting
1052 pthread_mutex_lock( &self->put_mutex );
1053 pthread_cond_broadcast( &self->put_cond );
1054 pthread_mutex_unlock( &self->put_mutex );
1056 // Broadcast to the done condition in case it's waiting
1057 pthread_mutex_lock( &self->done_mutex );
1058 pthread_cond_broadcast( &self->done_cond );
1059 pthread_mutex_unlock( &self->done_mutex );
1063 while ( ( thread = mlt_deque_pop_back( self->worker_threads ) ) )
1064 pthread_join( *thread, NULL );
1066 // Deallocate the array of threads
1070 // Indicate that worker threads no longer running
1073 // Destroy the mutexes
1074 pthread_mutex_destroy( &self->queue_mutex );
1075 pthread_mutex_destroy( &self->done_mutex );
1077 // Destroy the conditions
1078 pthread_cond_destroy( &self->queue_cond );
1079 pthread_cond_destroy( &self->done_cond );
1082 while ( mlt_deque_count( self->queue ) )
1083 mlt_frame_close( mlt_deque_pop_back( self->queue ) );
1086 mlt_deque_close( self->queue );
1087 mlt_deque_close( self->worker_threads );
1091 /** Flush the read/render thread's buffer.
1093 * \public \memberof mlt_consumer_s
1094 * \param self a consumer
1097 void mlt_consumer_purge( mlt_consumer self )
1101 pthread_mutex_lock( &self->queue_mutex );
1102 while ( mlt_deque_count( self->queue ) )
1103 mlt_frame_close( mlt_deque_pop_back( self->queue ) );
1104 pthread_cond_broadcast( &self->queue_cond );
1105 pthread_mutex_unlock( &self->queue_mutex );
1109 /** Use multiple worker threads and a work queue.
1112 static mlt_frame worker_get_frame( mlt_consumer self, mlt_properties properties )
1115 mlt_frame frame = NULL;
1117 int size = abs( self->real_time );
1118 int buffer = mlt_properties_get_int( properties, "buffer" );
1119 // This is a heuristic to determine a suitable minimum buffer size for the number of threads.
1120 int headroom = 2 + size * size;
1121 buffer = buffer < headroom ? headroom : buffer;
1123 // Start worker threads if not already started.
1124 if ( ! self->ahead )
1126 int prefill = mlt_properties_get_int( properties, "prefill" );
1127 prefill = prefill > 0 && prefill < buffer ? prefill : buffer;
1129 consumer_work_start( self );
1131 // Fill the work queue.
1133 while ( self->ahead && i-- )
1135 frame = mlt_consumer_get_frame( self );
1138 pthread_mutex_lock( &self->queue_mutex );
1139 mlt_deque_push_back( self->queue, frame );
1140 pthread_cond_signal( &self->queue_cond );
1141 pthread_mutex_unlock( &self->queue_mutex );
1146 while ( self->ahead && first_unprocessed_frame( self ) < prefill )
1148 pthread_mutex_lock( &self->done_mutex );
1149 pthread_cond_wait( &self->done_cond, &self->done_mutex );
1150 pthread_mutex_unlock( &self->done_mutex );
1152 self->process_head = size;
1155 // mlt_log_verbose( MLT_CONSUMER_SERVICE(self), "size %d done count %d work count %d process_head %d\n",
1156 // size, first_unprocessed_frame( self ), mlt_deque_count( self->queue ), self->process_head );
1158 // Feed the work queue
1159 while ( self->ahead && mlt_deque_count( self->queue ) < buffer )
1161 frame = mlt_consumer_get_frame( self );
1164 pthread_mutex_lock( &self->queue_mutex );
1165 mlt_deque_push_back( self->queue, frame );
1166 pthread_cond_signal( &self->queue_cond );
1167 pthread_mutex_unlock( &self->queue_mutex );
1170 // Wait if not realtime.
1171 while( self->ahead && self->real_time < 0 &&
1172 ! mlt_properties_get_int( MLT_FRAME_PROPERTIES( MLT_FRAME( mlt_deque_peek_front( self->queue ) ) ), "rendered" ) )
1174 pthread_mutex_lock( &self->done_mutex );
1175 pthread_cond_wait( &self->done_cond, &self->done_mutex );
1176 pthread_mutex_unlock( &self->done_mutex );
1179 // Get the frame from the queue.
1180 pthread_mutex_lock( &self->queue_mutex );
1181 frame = mlt_deque_pop_front( self->queue );
1182 pthread_mutex_unlock( &self->queue_mutex );
1184 // Adapt the worker process head to the runtime conditions.
1185 if ( self->real_time > 0 )
1187 if ( mlt_properties_get_int( MLT_FRAME_PROPERTIES( frame ), "rendered" ) )
1189 self->consecutive_dropped = 0;
1190 if ( self->process_head > size && self->consecutive_rendered >= self->process_head )
1191 self->process_head--;
1193 self->consecutive_rendered++;
1197 self->consecutive_rendered = 0;
1198 if ( self->process_head < buffer - size && self->consecutive_dropped > size )
1199 self->process_head++;
1201 self->consecutive_dropped++;
1203 // mlt_log_verbose( MLT_CONSUMER_SERVICE(self), "dropped %d rendered %d process_head %d\n",
1204 // self->consecutive_dropped, self->consecutive_rendered, self->process_head );
1210 /** Get the next frame from the producer connected to a consumer.
1212 * Typically, one uses this instead of \p mlt_consumer_get_frame to make
1213 * the asynchronous/real-time behavior configurable at runtime.
1214 * You should close the frame returned from this when you are done with it.
1216 * \public \memberof mlt_consumer_s
1217 * \param self a consumer
1221 mlt_frame mlt_consumer_rt_frame( mlt_consumer self )
1224 mlt_frame frame = NULL;
1226 // Get the properties
1227 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
1229 // Check if the user has requested real time or not
1230 if ( self->real_time > 1 || self->real_time < -1 )
1233 return worker_get_frame( self, properties );
1235 else if ( self->real_time == 1 || self->real_time == -1 )
1239 // Is the read ahead running?
1240 if ( self->ahead == 0 )
1242 int buffer = mlt_properties_get_int( properties, "buffer" );
1243 int prefill = mlt_properties_get_int( properties, "prefill" );
1244 consumer_read_ahead_start( self );
1246 size = prefill > 0 && prefill < buffer ? prefill : buffer;
1249 // Get frame from queue
1250 pthread_mutex_lock( &self->queue_mutex );
1251 while( self->ahead && mlt_deque_count( self->queue ) < size )
1252 pthread_cond_wait( &self->queue_cond, &self->queue_mutex );
1253 frame = mlt_deque_pop_front( self->queue );
1254 pthread_cond_broadcast( &self->queue_cond );
1255 pthread_mutex_unlock( &self->queue_mutex );
1257 else // real_time == 0
1259 // Get the frame in non real time
1260 frame = mlt_consumer_get_frame( self );
1262 // This isn't true, but from the consumers perspective it is
1263 if ( frame != NULL )
1264 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "rendered", 1 );
1270 /** Callback for the implementation to indicate a stopped condition.
1272 * \public \memberof mlt_consumer_s
1273 * \param self a consumer
1276 void mlt_consumer_stopped( mlt_consumer self )
1278 mlt_properties_set_int( MLT_CONSUMER_PROPERTIES( self ), "running", 0 );
1279 mlt_events_fire( MLT_CONSUMER_PROPERTIES( self ), "consumer-stopped", NULL );
1280 mlt_event_unblock( self->event_listener );
1283 /** Stop the consumer.
1285 * \public \memberof mlt_consumer_s
1286 * \param self a consumer
1287 * \return true if there was an error
1290 int mlt_consumer_stop( mlt_consumer self )
1292 // Get the properies
1293 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
1296 mlt_log( MLT_CONSUMER_SERVICE( self ), MLT_LOG_DEBUG, "stopping put waiting\n" );
1297 pthread_mutex_lock( &self->put_mutex );
1298 self->put_active = 0;
1299 pthread_cond_broadcast( &self->put_cond );
1300 pthread_mutex_unlock( &self->put_mutex );
1302 // Stop the consumer
1303 mlt_log( MLT_CONSUMER_SERVICE( self ), MLT_LOG_DEBUG, "stopping consumer\n" );
1305 // Cancel the read ahead threads
1307 if ( self->started )
1309 // Unblock the consumer calling mlt_consumer_rt_frame
1310 pthread_mutex_lock( &self->queue_mutex );
1311 pthread_cond_broadcast( &self->queue_cond );
1312 pthread_mutex_unlock( &self->queue_mutex );
1315 // Invoke the child callback
1316 if ( self->stop != NULL )
1319 // Check if the user has requested real time or not and stop if necessary
1320 mlt_log( MLT_CONSUMER_SERVICE( self ), MLT_LOG_DEBUG, "stopping read_ahead\n" );
1321 if ( abs( self->real_time ) == 1 )
1322 consumer_read_ahead_stop( self );
1323 else if ( abs( self->real_time ) > 1 )
1324 consumer_work_stop( self );
1326 // Kill the test card
1327 mlt_properties_set_data( properties, "test_card_producer", NULL, 0, NULL, NULL );
1329 // Check and run a post command
1330 if ( mlt_properties_get( properties, "post" ) )
1331 if (system( mlt_properties_get( properties, "post" ) ) == -1 )
1332 mlt_log( MLT_CONSUMER_SERVICE( self ), MLT_LOG_ERROR, "system(%s) failed!\n", mlt_properties_get( properties, "post" ) );
1334 mlt_log( MLT_CONSUMER_SERVICE( self ), MLT_LOG_DEBUG, "stopped\n" );
1339 /** Determine if the consumer is stopped.
1341 * \public \memberof mlt_consumer_s
1342 * \param self a consumer
1343 * \return true if the consumer is stopped
1346 int mlt_consumer_is_stopped( mlt_consumer self )
1348 // Check if the consumer is stopped
1349 if ( self->is_stopped != NULL )
1350 return self->is_stopped( self );
1355 /** Close and destroy the consumer.
1357 * \public \memberof mlt_consumer_s
1358 * \param self a consumer
1361 void mlt_consumer_close( mlt_consumer self )
1363 if ( self != NULL && mlt_properties_dec_ref( MLT_CONSUMER_PROPERTIES( self ) ) <= 0 )
1365 // Get the childs close function
1366 void ( *consumer_close )( ) = self->close;
1368 if ( consumer_close )
1371 //mlt_consumer_stop( self );
1374 consumer_close( self );
1378 // Make sure it only gets called once
1379 self->parent.close = NULL;
1381 // Destroy the push mutex and condition
1382 pthread_mutex_destroy( &self->put_mutex );
1383 pthread_cond_destroy( &self->put_cond );
1385 mlt_service_close( &self->parent );
1390 /** Get the position of the last frame shown.
1392 * \public \memberof mlt_consumer_s
1393 * \param consumer a consumer
1394 * \return the position
1397 mlt_position mlt_consumer_position( mlt_consumer consumer )
1399 return consumer->position;