3 * \brief abstraction for all consumer services
6 * Copyright (C) 2003-2009 Ushodaya Enterprises Limited
7 * \author Charles Yates <charles.yates@pandora.be>
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 #include "mlt_consumer.h"
25 #include "mlt_factory.h"
26 #include "mlt_producer.h"
27 #include "mlt_frame.h"
28 #include "mlt_profile.h"
36 /** Define this if you want an automatic deinterlace (if necessary) when the
37 * consumer's producer is not running at normal speed.
39 #undef DEINTERLACE_ON_NOT_NORMAL_SPEED
41 /** This is not the ideal place for this, but it is needed by VDPAU as well.
43 pthread_mutex_t mlt_sdl_mutex = PTHREAD_MUTEX_INITIALIZER;
45 static void mlt_consumer_frame_render( mlt_listener listener, mlt_properties owner, mlt_service this, void **args );
46 static void mlt_consumer_frame_show( mlt_listener listener, mlt_properties owner, mlt_service this, void **args );
47 static void mlt_consumer_property_changed( mlt_properties owner, mlt_consumer this, char *name );
48 static void apply_profile_properties( mlt_consumer this, mlt_profile profile, mlt_properties properties );
49 static void on_consumer_frame_show( mlt_properties owner, mlt_consumer this, mlt_frame frame );
51 /** Initialize a consumer service.
53 * \public \memberof mlt_consumer_s
54 * \param this the consumer to initialize
55 * \param child a pointer to the object for the subclass
56 * \param profile the \p mlt_profile_s to use (optional but recommended,
57 * uses the environment variable MLT if this is NULL)
58 * \return true if there was an error
61 int mlt_consumer_init( mlt_consumer this, void *child, mlt_profile profile )
64 memset( this, 0, sizeof( struct mlt_consumer_s ) );
66 error = mlt_service_init( &this->parent, this );
69 // Get the properties from the service
70 mlt_properties properties = MLT_SERVICE_PROPERTIES( &this->parent );
72 // Apply profile to properties
73 if ( profile == NULL )
75 // Normally the application creates the profile and controls its lifetime
76 // This is the fallback exception handling
77 profile = mlt_profile_init( NULL );
78 mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
79 mlt_properties_set_data( properties, "_profile", profile, 0, (mlt_destructor)mlt_profile_close, NULL );
81 apply_profile_properties( this, profile, properties );
83 // Default rescaler for all consumers
84 mlt_properties_set( properties, "rescale", "bilinear" );
86 // Default read ahead buffer size
87 mlt_properties_set_int( properties, "buffer", 25 );
89 // Default audio frequency and channels
90 mlt_properties_set_int( properties, "frequency", 48000 );
91 mlt_properties_set_int( properties, "channels", 2 );
93 // Default of all consumers is real time
94 mlt_properties_set_int( properties, "real_time", 1 );
96 // Default to environment test card
97 mlt_properties_set( properties, "test_card", mlt_environment( "MLT_TEST_CARD" ) );
99 // Hmm - default all consumers to yuv422 :-/
100 this->format = mlt_image_yuv422;
102 mlt_events_register( properties, "consumer-frame-show", ( mlt_transmitter )mlt_consumer_frame_show );
103 mlt_events_register( properties, "consumer-frame-render", ( mlt_transmitter )mlt_consumer_frame_render );
104 mlt_events_register( properties, "consumer-stopped", NULL );
105 mlt_events_listen( properties, this, "consumer-frame-show", ( mlt_listener )on_consumer_frame_show );
107 // Register a property-changed listener to handle the profile property -
108 // subsequent properties can override the profile
109 this->event_listener = mlt_events_listen( properties, this, "property-changed", ( mlt_listener )mlt_consumer_property_changed );
111 // Create the push mutex and condition
112 pthread_mutex_init( &this->put_mutex, NULL );
113 pthread_cond_init( &this->put_cond, NULL );
119 /** Convert the profile into properties on the consumer.
121 * \private \memberof mlt_consumer_s
122 * \param this a consumer
123 * \param profile a profile
124 * \param properties a properties list (typically, the consumer's)
127 static void apply_profile_properties( mlt_consumer this, mlt_profile profile, mlt_properties properties )
129 mlt_event_block( this->event_listener );
130 mlt_properties_set_double( properties, "fps", mlt_profile_fps( profile ) );
131 mlt_properties_set_int( properties, "frame_rate_num", profile->frame_rate_num );
132 mlt_properties_set_int( properties, "frame_rate_den", profile->frame_rate_den );
133 mlt_properties_set_int( properties, "width", profile->width );
134 mlt_properties_set_int( properties, "height", profile->height );
135 mlt_properties_set_int( properties, "progressive", profile->progressive );
136 mlt_properties_set_double( properties, "aspect_ratio", mlt_profile_sar( profile ) );
137 mlt_properties_set_int( properties, "sample_aspect_num", profile->sample_aspect_num );
138 mlt_properties_set_int( properties, "sample_aspect_den", profile->sample_aspect_den );
139 mlt_properties_set_double( properties, "display_ratio", mlt_profile_dar( profile ) );
140 mlt_properties_set_int( properties, "display_aspect_num", profile->display_aspect_num );
141 mlt_properties_set_int( properties, "display_aspect_num", profile->display_aspect_num );
142 mlt_properties_set_int( properties, "colorspace", profile->colorspace );
143 mlt_event_unblock( this->event_listener );
146 /** The property-changed event listener
148 * \private \memberof mlt_consumer_s
149 * \param owner the events object
150 * \param this the consumer
151 * \param name the name of the property that changed
154 static void mlt_consumer_property_changed( mlt_properties owner, mlt_consumer this, char *name )
156 if ( !strcmp( name, "profile" ) )
159 mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
161 // Get the current profile
162 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( this ) );
164 // Load the new profile
165 mlt_profile new_profile = mlt_profile_init( mlt_properties_get( properties, name ) );
170 if ( profile != NULL )
172 free( profile->description );
173 memcpy( profile, new_profile, sizeof( struct mlt_profile_s ) );
174 profile->description = strdup( new_profile->description );
175 mlt_profile_close( new_profile );
179 profile = new_profile;
182 // Apply to properties
183 apply_profile_properties( this, profile, properties );
186 else if ( !strcmp( name, "frame_rate_num" ) )
188 mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
189 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( this ) );
192 profile->frame_rate_num = mlt_properties_get_int( properties, "frame_rate_num" );
193 mlt_properties_set_double( properties, "fps", mlt_profile_fps( profile ) );
196 else if ( !strcmp( name, "frame_rate_den" ) )
198 mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
199 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( this ) );
202 profile->frame_rate_den = mlt_properties_get_int( properties, "frame_rate_den" );
203 mlt_properties_set_double( properties, "fps", mlt_profile_fps( profile ) );
206 else if ( !strcmp( name, "width" ) )
208 mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
209 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( this ) );
211 profile->width = mlt_properties_get_int( properties, "width" );
213 else if ( !strcmp( name, "height" ) )
215 mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
216 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( this ) );
218 profile->height = mlt_properties_get_int( properties, "height" );
220 else if ( !strcmp( name, "progressive" ) )
222 mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
223 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( this ) );
225 profile->progressive = mlt_properties_get_int( properties, "progressive" );
227 else if ( !strcmp( name, "sample_aspect_num" ) )
229 mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
230 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( this ) );
231 profile->sample_aspect_num = mlt_properties_get_int( properties, "sample_aspect_num" );
233 mlt_properties_set_double( properties, "aspect_ratio", mlt_profile_sar( profile ) );
235 else if ( !strcmp( name, "sample_aspect_den" ) )
237 mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
238 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( this ) );
239 profile->sample_aspect_den = mlt_properties_get_int( properties, "sample_aspect_den" );
241 mlt_properties_set_double( properties, "aspect_ratio", mlt_profile_sar( profile ) );
243 else if ( !strcmp( name, "display_aspect_num" ) )
245 mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
246 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( this ) );
249 profile->display_aspect_num = mlt_properties_get_int( properties, "display_aspect_num" );
250 mlt_properties_set_double( properties, "display_ratio", mlt_profile_dar( profile ) );
253 else if ( !strcmp( name, "display_aspect_den" ) )
255 mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
256 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( this ) );
259 profile->display_aspect_den = mlt_properties_get_int( properties, "display_aspect_den" );
260 mlt_properties_set_double( properties, "display_ratio", mlt_profile_dar( profile ) );
263 else if ( !strcmp( name, "colorspace" ) )
265 mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
266 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( this ) );
268 profile->colorspace = mlt_properties_get_int( properties, "colorspace" );
272 /** The transmitter for the consumer-frame-show event
274 * Invokes the listener.
276 * \private \memberof mlt_consumer_s
277 * \param listener a function pointer that will be invoked
278 * \param owner the events object that will be passed to \p listener
279 * \param this a service that will be passed to \p listener
280 * \param args an array of pointers - the first entry is passed as a string to \p listener
283 static void mlt_consumer_frame_show( mlt_listener listener, mlt_properties owner, mlt_service this, void **args )
285 if ( listener != NULL )
286 listener( owner, this, ( mlt_frame )args[ 0 ] );
289 /** The transmitter for the consumer-frame-render event
291 * Invokes the listener.
293 * \private \memberof mlt_consumer_s
294 * \param listener a function pointer that will be invoked
295 * \param owner the events object that will be passed to \p listener
296 * \param this a service that will be passed to \p listener
297 * \param args an array of pointers - the first entry is passed as a string to \p listener
300 static void mlt_consumer_frame_render( mlt_listener listener, mlt_properties owner, mlt_service this, void **args )
302 if ( listener != NULL )
303 listener( owner, this, ( mlt_frame )args[ 0 ] );
306 /** A listener on the consumer-frame-show event
308 * Saves the position of the frame shown.
310 * \private \memberof mlt_consumer_s
311 * \param owner the events object
312 * \param consumer the consumer on which this event occurred
313 * \param frame the frame that was shown
316 static void on_consumer_frame_show( mlt_properties owner, mlt_consumer consumer, mlt_frame frame )
319 consumer->position = mlt_frame_get_position( frame );
322 /** Create a new consumer.
324 * \public \memberof mlt_consumer_s
325 * \param profile a profile (optional, but recommended)
326 * \return a new consumer
329 mlt_consumer mlt_consumer_new( mlt_profile profile )
331 // Create the memory for the structure
332 mlt_consumer this = malloc( sizeof( struct mlt_consumer_s ) );
336 mlt_consumer_init( this, NULL, profile );
342 /** Get the parent service object.
344 * \public \memberof mlt_consumer_s
345 * \param this a consumer
346 * \return the parent service class
347 * \see MLT_CONSUMER_SERVICE
350 mlt_service mlt_consumer_service( mlt_consumer this )
352 return this != NULL ? &this->parent : NULL;
355 /** Get the consumer properties.
357 * \public \memberof mlt_consumer_s
358 * \param this a consumer
359 * \return the consumer's properties list
360 * \see MLT_CONSUMER_PROPERTIES
363 mlt_properties mlt_consumer_properties( mlt_consumer this )
365 return this != NULL ? MLT_SERVICE_PROPERTIES( &this->parent ) : NULL;
368 /** Connect the consumer to the producer.
370 * \public \memberof mlt_consumer_s
371 * \param this a consumer
372 * \param producer a producer
373 * \return > 0 warning, == 0 success, < 0 serious error,
374 * 1 = this service does not accept input,
375 * 2 = the producer is invalid,
376 * 3 = the producer is already registered with this consumer
379 int mlt_consumer_connect( mlt_consumer this, mlt_service producer )
381 return mlt_service_connect_producer( &this->parent, producer, 0 );
384 /** Start the consumer.
386 * \public \memberof mlt_consumer_s
387 * \param this a consumer
388 * \return true if there was an error
391 int mlt_consumer_start( mlt_consumer this )
393 // Stop listening to the property-changed event
394 mlt_event_block( this->event_listener );
397 mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
399 // Determine if there's a test card producer
400 char *test_card = mlt_properties_get( properties, "test_card" );
402 // Just to make sure nothing is hanging around...
403 mlt_frame_close( this->put );
405 this->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( this ) );
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( this ), MLT_LOG_ERROR, "system(%s) failed!\n", mlt_properties_get( properties, "ante" ) );
445 // Set the real_time preference
446 this->real_time = mlt_properties_get_int( properties, "real_time" );
448 // For worker threads implementation, buffer must be at least # threads
449 if ( abs( this->real_time ) > 1 && mlt_properties_get_int( properties, "buffer" ) <= abs( this->real_time ) )
450 mlt_properties_set_int( properties, "buffer", abs( this->real_time ) + 1 );
453 if ( this->start != NULL )
454 return this->start( this );
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 this a consumer
465 * \param frame a frame
466 * \return true (ignore this for now)
469 int mlt_consumer_put_frame( mlt_consumer this, mlt_frame frame )
473 // Get the service assoicated to the consumer
474 mlt_service service = MLT_CONSUMER_SERVICE( this );
476 if ( mlt_service_producer( service ) == NULL )
480 pthread_mutex_lock( &this->put_mutex );
481 while ( this->put_active && this->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( &this->put_cond, &this->put_mutex, &tm );
488 if ( this->put_active && this->put == NULL )
491 mlt_frame_close( frame );
492 pthread_cond_broadcast( &this->put_cond );
493 pthread_mutex_unlock( &this->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 this a consumer
510 mlt_frame mlt_consumer_get_frame( mlt_consumer this )
513 mlt_frame frame = NULL;
515 // Get the service assoicated to the consumer
516 mlt_service service = MLT_CONSUMER_SERVICE( this );
518 // Get the consumer properties
519 mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
522 if ( mlt_service_producer( service ) == NULL && mlt_properties_get_int( properties, "put_mode" ) )
526 pthread_mutex_lock( &this->put_mutex );
527 while ( this->put_active && this->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( &this->put_cond, &this->put_mutex, &tm );
536 pthread_cond_broadcast( &this->put_cond );
537 pthread_mutex_unlock( &this->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 this = arg;
603 // Get the properties of the consumer
604 mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
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 this->format = preview_format;
648 // Get the first frame
649 frame = mlt_consumer_get_frame( this );
651 // Get the image of the first frame
654 mlt_events_fire( MLT_CONSUMER_PROPERTIES( this ), "consumer-frame-render", frame, NULL );
655 mlt_frame_get_image( frame, &image, &this->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 ( this->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( &this->frame_queue_mutex );
679 while( this->ahead && mlt_deque_count( this->frame_queue ) >= buffer )
680 pthread_cond_wait( &this->frame_queue_cond, &this->frame_queue_mutex );
681 mlt_deque_push_back( this->frame_queue, frame );
682 pthread_cond_broadcast( &this->frame_queue_cond );
683 pthread_mutex_unlock( &this->frame_queue_mutex );
685 time_wait += time_difference( &ante );
687 // Get the next frame
688 frame = mlt_consumer_get_frame( this );
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 || this->real_time == -1 )
715 // Get the image, mark as rendered and time it
718 mlt_events_fire( MLT_CONSUMER_PROPERTIES( this ), "consumer-frame-render", frame, NULL );
719 mlt_frame_get_image( frame, &image, &this->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
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 this frame
748 time_process += time_difference( &ante );
750 // Determine if the next frame should be skipped
751 if ( mlt_deque_count( this->frame_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 static int compare_frame_position( mlt_frame a, mlt_frame b )
767 return mlt_frame_get_position( a ) - mlt_frame_get_position( b );
770 /** The worker thread procedure for parallel processing frames.
772 * \private \memberof mlt_consumer_s
773 * \param arg a consumer
776 static void *consumer_worker_thread( void *arg )
778 // The argument is the consumer
779 mlt_consumer this = arg;
781 // Get the properties of the consumer
782 mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
784 // Get the width and height
785 int width = mlt_properties_get_int( properties, "width" );
786 int height = mlt_properties_get_int( properties, "height" );
787 mlt_image_format format = this->format;
789 // See if video is turned off
790 int video_off = mlt_properties_get_int( properties, "video_off" );
791 int preview_off = mlt_properties_get_int( properties, "preview_off" );
792 int preview_format = mlt_properties_get_int( properties, "preview_format" );
794 // Get the audio settings
795 mlt_audio_format afmt = mlt_audio_s16;
797 double fps = mlt_properties_get_double( properties, "fps" );
798 int channels = mlt_properties_get_int( properties, "channels" );
799 int frequency = mlt_properties_get_int( properties, "frequency" );
803 // See if audio is turned off
804 int audio_off = mlt_properties_get_int( properties, "audio_off" );
806 // General frame variable
807 mlt_frame frame = NULL;
808 uint8_t *image = NULL;
810 if ( preview_off && preview_format != 0 )
811 format = preview_format;
813 // Get the first frame from the work queue
814 pthread_mutex_lock( &this->frame_queue_mutex );
815 while( this->ahead && mlt_deque_count( this->frame_queue ) <= 0 )
816 pthread_cond_wait( &this->frame_queue_cond, &this->frame_queue_mutex );
817 frame = mlt_deque_pop_front( this->frame_queue );
818 pthread_cond_signal( &this->frame_queue_cond );
819 pthread_mutex_unlock( &this->frame_queue_mutex );
821 // Get the image of the first frame
824 mlt_events_fire( MLT_CONSUMER_PROPERTIES( this ), "consumer-frame-render", frame, NULL );
825 mlt_frame_get_image( frame, &image, &format, &width, &height, 0 );
830 samples = mlt_sample_calculator( fps, frequency, counter++ );
831 mlt_frame_get_audio( frame, &audio, &afmt, &frequency, &channels, &samples );
835 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "rendered", 1 );
837 // Continue to read ahead
838 while ( this->ahead )
840 // Fetch width/height again
841 width = mlt_properties_get_int( properties, "width" );
842 height = mlt_properties_get_int( properties, "height" );
844 // Put the processed frame into the done queue
847 pthread_mutex_lock( &this->done_queue_mutex );
848 mlt_deque_insert( this->done_queue, frame, ( mlt_deque_compare ) compare_frame_position );
849 pthread_cond_signal( &this->done_queue_cond );
850 pthread_mutex_unlock( &this->done_queue_mutex );
853 // Get the next frame from the work queue
854 pthread_mutex_lock( &this->frame_queue_mutex );
855 while( this->ahead && mlt_deque_count( this->frame_queue ) <= 0 )
856 pthread_cond_wait( &this->frame_queue_cond, &this->frame_queue_mutex );
857 frame = mlt_deque_pop_front( this->frame_queue );
858 pthread_cond_signal( &this->frame_queue_cond );
859 pthread_mutex_unlock( &this->frame_queue_mutex );
861 // If there's no frame, we're probably stopped...
865 // All non normal playback frames should be shown
866 if ( mlt_properties_get_int( MLT_FRAME_PROPERTIES( frame ), "_speed" ) != 1 )
868 #ifdef DEINTERLACE_ON_NOT_NORMAL_SPEED
869 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "consumer_deinterlace", 1 );
876 mlt_events_fire( MLT_CONSUMER_PROPERTIES( this ), "consumer-frame-render", frame, NULL );
877 mlt_frame_get_image( frame, &image, &format, &width, &height, 0 );
879 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "rendered", 1 );
881 // Always process audio
884 samples = mlt_sample_calculator( fps, frequency, counter++ );
885 mlt_frame_get_audio( frame, &audio, &afmt, &frequency, &channels, &samples );
889 // Remove the last frame
890 mlt_frame_close( frame );
895 /** Start the read/render thread.
897 * \private \memberof mlt_consumer_s
898 * \param this a consumer
901 static void consumer_read_ahead_start( mlt_consumer this )
906 // Create the frame queue
907 this->frame_queue = mlt_deque_init( );
909 // Create the frame_queue mutex
910 pthread_mutex_init( &this->frame_queue_mutex, NULL );
912 // Create the condition
913 pthread_cond_init( &this->frame_queue_cond, NULL );
915 // Create the read ahead
916 if ( mlt_properties_get( MLT_CONSUMER_PROPERTIES( this ), "priority" ) )
918 struct sched_param priority;
919 priority.sched_priority = mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( this ), "priority" );
920 pthread_attr_t thread_attributes;
921 pthread_attr_init( &thread_attributes );
922 pthread_attr_setschedpolicy( &thread_attributes, SCHED_OTHER );
923 pthread_attr_setschedparam( &thread_attributes, &priority );
924 pthread_attr_setinheritsched( &thread_attributes, PTHREAD_EXPLICIT_SCHED );
925 pthread_attr_setscope( &thread_attributes, PTHREAD_SCOPE_SYSTEM );
926 if ( pthread_create( &this->ahead_thread, &thread_attributes, consumer_read_ahead_thread, this ) < 0 )
927 pthread_create( &this->ahead_thread, NULL, consumer_read_ahead_thread, this );
928 pthread_attr_destroy( &thread_attributes );
932 pthread_create( &this->ahead_thread, NULL, consumer_read_ahead_thread, this );
936 /** Start the worker threads.
938 * \private \memberof mlt_consumer_s
939 * \param this a consumer
942 static void consumer_work_start( mlt_consumer this )
944 int n = abs( this->real_time );
951 this->frame_queue = mlt_deque_init();
952 this->done_queue = mlt_deque_init();
953 this->worker_threads = mlt_deque_init();
955 // Create the mutexes
956 pthread_mutex_init( &this->frame_queue_mutex, NULL );
957 pthread_mutex_init( &this->done_queue_mutex, NULL );
959 // Create the conditions
960 pthread_cond_init( &this->frame_queue_cond, NULL );
961 pthread_cond_init( &this->done_queue_cond, NULL );
963 // Create the read ahead
964 if ( mlt_properties_get( MLT_CONSUMER_PROPERTIES( this ), "priority" ) )
967 struct sched_param priority;
968 pthread_attr_t thread_attributes;
970 priority.sched_priority = mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( this ), "priority" );
971 pthread_attr_init( &thread_attributes );
972 pthread_attr_setschedpolicy( &thread_attributes, SCHED_OTHER );
973 pthread_attr_setschedparam( &thread_attributes, &priority );
974 pthread_attr_setinheritsched( &thread_attributes, PTHREAD_EXPLICIT_SCHED );
975 pthread_attr_setscope( &thread_attributes, PTHREAD_SCOPE_SYSTEM );
979 if ( pthread_create( &thread, &thread_attributes, consumer_read_ahead_thread, this ) < 0 )
980 if ( pthread_create( &thread, NULL, consumer_read_ahead_thread, this ) == 0 )
981 mlt_deque_push_back( this->worker_threads, (void*) thread );
983 pthread_attr_destroy( &thread_attributes );
990 if ( pthread_create( &thread, NULL, consumer_worker_thread, this ) == 0 )
991 mlt_deque_push_back( this->worker_threads, (void*) thread );
996 /** Stop the read/render thread.
998 * \private \memberof mlt_consumer_s
999 * \param this a consumer
1002 static void consumer_read_ahead_stop( mlt_consumer this )
1004 // Make sure we're running
1007 // Inform thread to stop
1010 // Broadcast to the condition in case it's waiting
1011 pthread_mutex_lock( &this->frame_queue_mutex );
1012 pthread_cond_broadcast( &this->frame_queue_cond );
1013 pthread_mutex_unlock( &this->frame_queue_mutex );
1015 // Broadcast to the put condition in case it's waiting
1016 pthread_mutex_lock( &this->put_mutex );
1017 pthread_cond_broadcast( &this->put_cond );
1018 pthread_mutex_unlock( &this->put_mutex );
1021 pthread_join( this->ahead_thread, NULL );
1023 // Destroy the frame queue mutex
1024 pthread_mutex_destroy( &this->frame_queue_mutex );
1026 // Destroy the condition
1027 pthread_cond_destroy( &this->frame_queue_cond );
1030 while ( mlt_deque_count( this->frame_queue ) )
1031 mlt_frame_close( mlt_deque_pop_back( this->frame_queue ) );
1034 mlt_deque_close( this->frame_queue );
1038 /** Stop the worker threads.
1040 * \private \memberof mlt_consumer_s
1041 * \param this a consumer
1044 static void consumer_work_stop( mlt_consumer this )
1046 // Make sure we're running
1049 // Inform thread to stop
1052 // Broadcast to the frame_queue condition in case it's waiting
1053 pthread_mutex_lock( &this->frame_queue_mutex );
1054 pthread_cond_broadcast( &this->frame_queue_cond );
1055 pthread_mutex_unlock( &this->frame_queue_mutex );
1057 // Broadcast to the done_queue condition in case it's waiting
1058 pthread_mutex_lock( &this->done_queue_mutex );
1059 pthread_cond_broadcast( &this->done_queue_cond );
1060 pthread_mutex_unlock( &this->done_queue_mutex );
1062 // Broadcast to the put condition in case it's waiting
1063 pthread_mutex_lock( &this->put_mutex );
1064 pthread_cond_broadcast( &this->put_cond );
1065 pthread_mutex_unlock( &this->put_mutex );
1069 while ( ( thread = (pthread_t) mlt_deque_pop_front( this->worker_threads ) ) )
1070 pthread_join( thread, NULL );
1072 // Destroy the mutexes
1073 pthread_mutex_destroy( &this->frame_queue_mutex );
1074 pthread_mutex_destroy( &this->done_queue_mutex );
1076 // Destroy the conditions
1077 pthread_cond_destroy( &this->frame_queue_cond );
1078 pthread_cond_destroy( &this->done_queue_cond );
1081 while ( mlt_deque_count( this->frame_queue ) )
1082 mlt_frame_close( mlt_deque_pop_back( this->frame_queue ) );
1083 while ( mlt_deque_count( this->done_queue ) )
1084 mlt_frame_close( mlt_deque_pop_back( this->done_queue ) );
1087 mlt_deque_close( this->frame_queue );
1088 mlt_deque_close( this->done_queue );
1089 mlt_deque_close( this->worker_threads );
1093 /** Flush the read/render thread's buffer.
1095 * \public \memberof mlt_consumer_s
1096 * \param this a consumer
1099 void mlt_consumer_purge( mlt_consumer this )
1103 pthread_mutex_lock( &this->frame_queue_mutex );
1104 while ( mlt_deque_count( this->frame_queue ) )
1105 mlt_frame_close( mlt_deque_pop_back( this->frame_queue ) );
1106 pthread_cond_broadcast( &this->frame_queue_cond );
1107 pthread_mutex_unlock( &this->frame_queue_mutex );
1109 if ( this->done_queue )
1111 pthread_mutex_lock( &this->done_queue_mutex );
1112 while ( mlt_deque_count( this->done_queue ) )
1113 mlt_frame_close( mlt_deque_pop_back( this->done_queue ) );
1114 pthread_cond_broadcast( &this->done_queue_cond );
1115 pthread_mutex_unlock( &this->done_queue_mutex );
1120 /** Get the next frame from the producer connected to a consumer.
1122 * Typically, one uses this instead of \p mlt_consumer_get_frame to make
1123 * the asynchronous/real-time behavior configurable at runtime.
1124 * You should close the frame returned from this when you are done with it.
1126 * \public \memberof mlt_consumer_s
1127 * \param this a consumer
1131 mlt_frame mlt_consumer_rt_frame( mlt_consumer this )
1134 mlt_frame frame = NULL;
1136 // Get the properties
1137 mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
1139 // Check if the user has requested real time or not
1140 if ( this->real_time == 1 || this->real_time == -1 )
1144 // Is the read ahead running?
1145 if ( this->ahead == 0 )
1147 int buffer = mlt_properties_get_int( properties, "buffer" );
1148 int prefill = mlt_properties_get_int( properties, "prefill" );
1149 consumer_read_ahead_start( this );
1151 size = prefill > 0 && prefill < buffer ? prefill : buffer;
1154 // Get frame from queue
1155 pthread_mutex_lock( &this->frame_queue_mutex );
1156 while( this->ahead && mlt_deque_count( this->frame_queue ) < size )
1157 pthread_cond_wait( &this->frame_queue_cond, &this->frame_queue_mutex );
1158 frame = mlt_deque_pop_front( this->frame_queue );
1159 pthread_cond_broadcast( &this->frame_queue_cond );
1160 pthread_mutex_unlock( &this->frame_queue_mutex );
1162 else if ( this->real_time > 1 || this->real_time < -1 )
1164 // Use multiple worker threads and a work queue
1165 int size = abs( this->real_time );
1166 int buffer = mlt_properties_get_int( properties, "buffer" );
1167 buffer = buffer < size ? size : buffer;
1169 // Start worker threads if not already
1170 if ( ! this->ahead )
1172 int prefill = mlt_properties_get_int( properties, "prefill" );
1173 prefill = prefill > 0 && prefill < buffer ? prefill : buffer;
1175 consumer_work_start( this );
1177 // Fill the work queue
1181 frame = mlt_consumer_get_frame( this );
1184 pthread_mutex_lock( &this->frame_queue_mutex );
1185 mlt_deque_push_back( this->frame_queue, frame );
1186 pthread_cond_signal( &this->frame_queue_cond );
1187 pthread_mutex_unlock( &this->frame_queue_mutex );
1192 pthread_mutex_lock( &this->done_queue_mutex );
1193 while( this->ahead && mlt_deque_count( this->done_queue ) < prefill )
1194 pthread_cond_wait( &this->done_queue_cond, &this->done_queue_mutex );
1195 pthread_mutex_unlock( &this->done_queue_mutex );
1198 // Try to get frame from the done queue
1199 mlt_log_debug( MLT_CONSUMER_SERVICE(this), "size %d done count %d work count %d\n",
1200 size, mlt_deque_count( this->done_queue ), mlt_deque_count( this->frame_queue ) );
1201 if ( this->real_time > 0 && size == this->real_time && mlt_deque_count( this->done_queue ) <= size )
1203 // Non-realtime and no ready frames
1204 frame = mlt_consumer_get_frame( this );
1208 // Wait for work queue space
1209 pthread_mutex_lock( &this->frame_queue_mutex );
1210 while( this->ahead && mlt_deque_count( this->frame_queue ) >= buffer )
1211 pthread_cond_wait( &this->frame_queue_cond, &this->frame_queue_mutex );
1212 pthread_mutex_unlock( &this->frame_queue_mutex );
1214 // Feed the work queue
1215 frame = mlt_consumer_get_frame( this );
1218 pthread_mutex_lock( &this->frame_queue_mutex );
1219 mlt_deque_push_back( this->frame_queue, frame );
1220 pthread_cond_signal( &this->frame_queue_cond );
1221 pthread_mutex_unlock( &this->frame_queue_mutex );
1224 // Get the frame from the done queue
1225 pthread_mutex_lock( &this->done_queue_mutex );
1226 while( this->ahead && mlt_deque_count( this->done_queue ) <= size )
1227 pthread_cond_wait( &this->done_queue_cond, &this->done_queue_mutex );
1228 frame = mlt_deque_pop_front( this->done_queue );
1229 pthread_mutex_unlock( &this->done_queue_mutex );
1234 // Get the frame in non real time
1235 frame = mlt_consumer_get_frame( this );
1237 // This isn't true, but from the consumers perspective it is
1238 if ( frame != NULL )
1239 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "rendered", 1 );
1245 /** Callback for the implementation to indicate a stopped condition.
1247 * \public \memberof mlt_consumer_s
1248 * \param this a consumer
1251 void mlt_consumer_stopped( mlt_consumer this )
1253 mlt_properties_set_int( MLT_CONSUMER_PROPERTIES( this ), "running", 0 );
1254 mlt_events_fire( MLT_CONSUMER_PROPERTIES( this ), "consumer-stopped", NULL );
1255 mlt_event_unblock( this->event_listener );
1258 /** Stop the consumer.
1260 * \public \memberof mlt_consumer_s
1261 * \param this a consumer
1262 * \return true if there was an error
1265 int mlt_consumer_stop( mlt_consumer this )
1267 // Get the properies
1268 mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
1271 mlt_log( MLT_CONSUMER_SERVICE( this ), MLT_LOG_DEBUG, "stopping put waiting\n" );
1272 pthread_mutex_lock( &this->put_mutex );
1273 this->put_active = 0;
1274 pthread_cond_broadcast( &this->put_cond );
1275 pthread_mutex_unlock( &this->put_mutex );
1277 // Stop the consumer
1278 mlt_log( MLT_CONSUMER_SERVICE( this ), MLT_LOG_DEBUG, "stopping consumer\n" );
1279 if ( this->stop != NULL )
1282 // Check if the user has requested real time or not and stop if necessary
1283 mlt_log( MLT_CONSUMER_SERVICE( this ), MLT_LOG_DEBUG, "stopping read_ahead\n" );
1284 if ( abs( this->real_time ) == 1 )
1285 consumer_read_ahead_stop( this );
1286 else if ( abs( this->real_time ) > 1 )
1287 consumer_work_stop( this );
1289 // Kill the test card
1290 mlt_properties_set_data( properties, "test_card_producer", NULL, 0, NULL, NULL );
1292 // Check and run a post command
1293 if ( mlt_properties_get( properties, "post" ) )
1294 if (system( mlt_properties_get( properties, "post" ) ) == -1 )
1295 mlt_log( MLT_CONSUMER_SERVICE( this ), MLT_LOG_ERROR, "system(%s) failed!\n", mlt_properties_get( properties, "post" ) );
1297 mlt_log( MLT_CONSUMER_SERVICE( this ), MLT_LOG_DEBUG, "stopped\n" );
1302 /** Determine if the consumer is stopped.
1304 * \public \memberof mlt_consumer_s
1305 * \param this a consumer
1306 * \return true if the consumer is stopped
1309 int mlt_consumer_is_stopped( mlt_consumer this )
1311 // Check if the consumer is stopped
1312 if ( this->is_stopped != NULL )
1313 return this->is_stopped( this );
1318 /** Close and destroy the consumer.
1320 * \public \memberof mlt_consumer_s
1321 * \param this a consumer
1324 void mlt_consumer_close( mlt_consumer this )
1326 if ( this != NULL && mlt_properties_dec_ref( MLT_CONSUMER_PROPERTIES( this ) ) <= 0 )
1328 // Get the childs close function
1329 void ( *consumer_close )( ) = this->close;
1331 if ( consumer_close )
1334 //mlt_consumer_stop( this );
1337 consumer_close( this );
1341 // Make sure it only gets called once
1342 this->parent.close = NULL;
1344 // Destroy the push mutex and condition
1345 pthread_mutex_destroy( &this->put_mutex );
1346 pthread_cond_destroy( &this->put_cond );
1348 mlt_service_close( &this->parent );
1353 /** Get the position of the last frame shown.
1355 * \public \memberof mlt_consumer_s
1356 * \param consumer a consumer
1357 * \return the position
1360 mlt_position mlt_consumer_position( mlt_consumer consumer )
1362 return consumer->position;