]> git.sesse.net Git - mlt/blob - src/framework/mlt_consumer.c
Revert change to max consecutive dropped frames.
[mlt] / src / framework / mlt_consumer.c
1 /**
2  * \file mlt_consumer.c
3  * \brief abstraction for all consumer services
4  * \see mlt_consumer_s
5  *
6  * Copyright (C) 2003-2010 Ushodaya Enterprises Limited
7  * \author Charles Yates <charles.yates@pandora.be>
8  * \author Dan Dennedy <dan@dennedy.org>
9  *
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.
14  *
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.
19  *
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
23  */
24
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"
30 #include "mlt_log.h"
31
32 #include <stdio.h>
33 #include <string.h>
34 #include <stdlib.h>
35 #include <sys/time.h>
36
37 /** Define this if you want an automatic deinterlace (if necessary) when the
38  * consumer's producer is not running at normal speed.
39  */
40 #undef DEINTERLACE_ON_NOT_NORMAL_SPEED
41
42 /** This is not the ideal place for this, but it is needed by VDPAU as well.
43  */
44 pthread_mutex_t mlt_sdl_mutex = PTHREAD_MUTEX_INITIALIZER;
45
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 );
51
52 /** Initialize a consumer service.
53  *
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
60  */
61
62 int mlt_consumer_init( mlt_consumer self, void *child, mlt_profile profile )
63 {
64         int error = 0;
65         memset( self, 0, sizeof( struct mlt_consumer_s ) );
66         self->child = child;
67         error = mlt_service_init( &self->parent, self );
68         if ( error == 0 )
69         {
70                 // Get the properties from the service
71                 mlt_properties properties = MLT_SERVICE_PROPERTIES( &self->parent );
72
73                 // Apply profile to properties
74                 if ( profile == NULL )
75                 {
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 );
81                 }
82                 apply_profile_properties( self, profile, properties );
83
84                 // Default rescaler for all consumers
85                 mlt_properties_set( properties, "rescale", "bilinear" );
86
87                 // Default read ahead buffer size
88                 mlt_properties_set_int( properties, "buffer", 25 );
89
90                 // Default audio frequency and channels
91                 mlt_properties_set_int( properties, "frequency", 48000 );
92                 mlt_properties_set_int( properties, "channels", 2 );
93
94                 // Default of all consumers is real time
95                 mlt_properties_set_int( properties, "real_time", 1 );
96
97                 // Default to environment test card
98                 mlt_properties_set( properties, "test_card", mlt_environment( "MLT_TEST_CARD" ) );
99
100                 // Hmm - default all consumers to yuv422 :-/
101                 self->format = mlt_image_yuv422;
102
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 );
107
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 );
111
112                 // Create the push mutex and condition
113                 pthread_mutex_init( &self->put_mutex, NULL );
114                 pthread_cond_init( &self->put_cond, NULL );
115
116         }
117         return error;
118 }
119
120 /** Convert the profile into properties on the consumer.
121  *
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)
126  */
127
128 static void apply_profile_properties( mlt_consumer self, mlt_profile profile, mlt_properties properties )
129 {
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 );
145 }
146
147 /** The property-changed event listener
148  *
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
153  */
154
155 static void mlt_consumer_property_changed( mlt_properties owner, mlt_consumer self, char *name )
156 {
157         if ( !strcmp( name, "profile" ) )
158         {
159                 // Get the properies
160                 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
161
162                 // Get the current profile
163                 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
164
165                 // Load the new profile
166                 mlt_profile new_profile = mlt_profile_init( mlt_properties_get( properties, name ) );
167
168                 if ( new_profile )
169                 {
170                         // Copy the profile
171                         if ( profile != NULL )
172                         {
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 );
177                         }
178                         else
179                         {
180                                 profile = new_profile;
181                         }
182
183                         // Apply to properties
184                         apply_profile_properties( self, profile, properties );
185                 }
186         }
187         else if ( !strcmp( name, "frame_rate_num" ) )
188         {
189                 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
190                 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
191                 if ( profile )
192                 {
193                         profile->frame_rate_num = mlt_properties_get_int( properties, "frame_rate_num" );
194                         mlt_properties_set_double( properties, "fps", mlt_profile_fps( profile ) );
195                 }
196         }
197         else if ( !strcmp( name, "frame_rate_den" ) )
198         {
199                 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
200                 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
201                 if ( profile )
202                 {
203                         profile->frame_rate_den = mlt_properties_get_int( properties, "frame_rate_den" );
204                         mlt_properties_set_double( properties, "fps", mlt_profile_fps( profile ) );
205                 }
206         }
207         else if ( !strcmp( name, "width" ) )
208         {
209                 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
210                 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
211                 if ( profile )
212                         profile->width = mlt_properties_get_int( properties, "width" );
213         }
214         else if ( !strcmp( name, "height" ) )
215         {
216                 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
217                 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
218                 if ( profile )
219                         profile->height = mlt_properties_get_int( properties, "height" );
220         }
221         else if ( !strcmp( name, "progressive" ) )
222         {
223                 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
224                 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
225                 if ( profile )
226                         profile->progressive = mlt_properties_get_int( properties, "progressive" );
227         }
228         else if ( !strcmp( name, "sample_aspect_num" ) )
229         {
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" );
233                 if ( profile )
234                         mlt_properties_set_double( properties, "aspect_ratio", mlt_profile_sar( profile )  );
235         }
236         else if ( !strcmp( name, "sample_aspect_den" ) )
237         {
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" );
241                 if ( profile )
242                         mlt_properties_set_double( properties, "aspect_ratio", mlt_profile_sar( profile )  );
243         }
244         else if ( !strcmp( name, "display_aspect_num" ) )
245         {
246                 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
247                 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
248                 if ( profile )
249                 {
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 )  );
252                 }
253         }
254         else if ( !strcmp( name, "display_aspect_den" ) )
255         {
256                 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
257                 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
258                 if ( profile )
259                 {
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 )  );
262                 }
263         }
264         else if ( !strcmp( name, "colorspace" ) )
265         {
266                 mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
267                 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( self ) );
268                 if ( profile )
269                         profile->colorspace = mlt_properties_get_int( properties, "colorspace" );
270         }
271 }
272
273 /** The transmitter for the consumer-frame-show event
274  *
275  * Invokes the listener.
276  *
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
282  */
283
284 static void mlt_consumer_frame_show( mlt_listener listener, mlt_properties owner, mlt_service self, void **args )
285 {
286         if ( listener != NULL )
287                 listener( owner, self, ( mlt_frame )args[ 0 ] );
288 }
289
290 /** The transmitter for the consumer-frame-render event
291  *
292  * Invokes the listener.
293  *
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
299  */
300
301 static void mlt_consumer_frame_render( mlt_listener listener, mlt_properties owner, mlt_service self, void **args )
302 {
303         if ( listener != NULL )
304                 listener( owner, self, ( mlt_frame )args[ 0 ] );
305 }
306
307 /** A listener on the consumer-frame-show event
308  *
309  * Saves the position of the frame shown.
310  *
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
315  */
316
317 static void on_consumer_frame_show( mlt_properties owner, mlt_consumer consumer, mlt_frame frame )
318 {
319         if ( frame )
320                 consumer->position = mlt_frame_get_position( frame );
321 }
322
323 /** Create a new consumer.
324  *
325  * \public \memberof mlt_consumer_s
326  * \param profile a profile (optional, but recommended)
327  * \return a new consumer
328  */
329
330 mlt_consumer mlt_consumer_new( mlt_profile profile )
331 {
332         // Create the memory for the structure
333         mlt_consumer self = malloc( sizeof( struct mlt_consumer_s ) );
334
335         // Initialise it
336         if ( self != NULL )
337                 mlt_consumer_init( self, NULL, profile );
338
339         // Return it
340         return self;
341 }
342
343 /** Get the parent service object.
344  *
345  * \public \memberof mlt_consumer_s
346  * \param self a consumer
347  * \return the parent service class
348  * \see MLT_CONSUMER_SERVICE
349  */
350
351 mlt_service mlt_consumer_service( mlt_consumer self )
352 {
353         return self != NULL ? &self->parent : NULL;
354 }
355
356 /** Get the consumer properties.
357  *
358  * \public \memberof mlt_consumer_s
359  * \param self a consumer
360  * \return the consumer's properties list
361  * \see MLT_CONSUMER_PROPERTIES
362  */
363
364 mlt_properties mlt_consumer_properties( mlt_consumer self )
365 {
366         return self != NULL ? MLT_SERVICE_PROPERTIES( &self->parent ) : NULL;
367 }
368
369 /** Connect the consumer to the producer.
370  *
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
378  */
379
380 int mlt_consumer_connect( mlt_consumer self, mlt_service producer )
381 {
382         return mlt_service_connect_producer( &self->parent, producer, 0 );
383 }
384
385 /** Start the consumer.
386  *
387  * \public \memberof mlt_consumer_s
388  * \param self a consumer
389  * \return true if there was an error
390  */
391
392 int mlt_consumer_start( mlt_consumer self )
393 {
394         // Stop listening to the property-changed event
395         mlt_event_block( self->event_listener );
396
397         // Get the properies
398         mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
399
400         // Determine if there's a test card producer
401         char *test_card = mlt_properties_get( properties, "test_card" );
402
403         // Just to make sure nothing is hanging around...
404         self->put = NULL;
405         self->put_active = 1;
406
407         // Deal with it now.
408         if ( test_card != NULL )
409         {
410                 if ( mlt_properties_get_data( properties, "test_card_producer", NULL ) == NULL )
411                 {
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 );
415
416                         // Do we have a producer
417                         if ( producer != NULL )
418                         {
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 );
423
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 );
426                         }
427                 }
428         }
429         else
430         {
431                 // Allow the hash table to speed things up
432                 mlt_properties_set_data( properties, "test_card_producer", NULL, 0, NULL, NULL );
433         }
434
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 );
439
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" ) );
444
445         // Set the real_time preference
446         self->real_time = mlt_properties_get_int( properties, "real_time" );
447
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 );
451
452         // Start the service
453         if ( self->start != NULL )
454                 return self->start( self );
455
456         return 0;
457 }
458
459 /** An alternative method to feed frames into the consumer.
460  *
461  * Only valid if the consumer itself is not connected.
462  *
463  * \public \memberof mlt_consumer_s
464  * \param self a consumer
465  * \param frame a frame
466  * \return true (ignore self for now)
467  */
468
469 int mlt_consumer_put_frame( mlt_consumer self, mlt_frame frame )
470 {
471         int error = 1;
472
473         // Get the service assoicated to the consumer
474         mlt_service service = MLT_CONSUMER_SERVICE( self );
475
476         if ( mlt_service_producer( service ) == NULL )
477         {
478                 struct timeval now;
479                 struct timespec tm;
480                 pthread_mutex_lock( &self->put_mutex );
481                 while ( self->put_active && self->put != NULL )
482                 {
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 );
487                 }
488                 if ( self->put_active && self->put == NULL )
489                         self->put = frame;
490                 else
491                         mlt_frame_close( frame );
492                 pthread_cond_broadcast( &self->put_cond );
493                 pthread_mutex_unlock( &self->put_mutex );
494         }
495         else
496         {
497                 mlt_frame_close( frame );
498         }
499
500         return error;
501 }
502
503 /** Protected method for consumer to get frames from connected service
504  *
505  * \public \memberof mlt_consumer_s
506  * \param self a consumer
507  * \return a frame
508  */
509
510 mlt_frame mlt_consumer_get_frame( mlt_consumer self )
511 {
512         // Frame to return
513         mlt_frame frame = NULL;
514
515         // Get the service assoicated to the consumer
516         mlt_service service = MLT_CONSUMER_SERVICE( self );
517
518         // Get the consumer properties
519         mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
520
521         // Get the frame
522         if ( mlt_service_producer( service ) == NULL && mlt_properties_get_int( properties, "put_mode" ) )
523         {
524                 struct timeval now;
525                 struct timespec tm;
526                 pthread_mutex_lock( &self->put_mutex );
527                 while ( self->put_active && self->put == NULL )
528                 {
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 );
533                 }
534                 frame = self->put;
535                 self->put = NULL;
536                 pthread_cond_broadcast( &self->put_cond );
537                 pthread_mutex_unlock( &self->put_mutex );
538                 if ( frame != NULL )
539                         mlt_service_apply_filters( service, frame, 0 );
540         }
541         else if ( mlt_service_producer( service ) != NULL )
542         {
543                 mlt_service_get_frame( service, &frame, 0 );
544         }
545         else
546         {
547                 frame = mlt_frame_init( service );
548         }
549
550         if ( frame != NULL )
551         {
552                 // Get the frame properties
553                 mlt_properties frame_properties = MLT_FRAME_PROPERTIES( frame );
554
555                 // Get the test card producer
556                 mlt_producer test_card = mlt_properties_get_data( properties, "test_card_producer", NULL );
557
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 );
561
562                 // Attach the rescale property
563                 mlt_properties_set( frame_properties, "rescale.interp", mlt_properties_get( properties, "rescale" ) );
564
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" ) );
569         }
570
571         // Return the frame
572         return frame;
573 }
574
575 /** Compute the time difference between now and a time value.
576  *
577  * \private \memberof mlt_consumer_s
578  * \param time1 a time value to be compared against now
579  * \return the difference in microseconds
580  */
581
582 static inline long time_difference( struct timeval *time1 )
583 {
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;
589 }
590
591 /** The thread procedure for asynchronously pulling frames through the service
592  * network connected to a consumer.
593  *
594  * \private \memberof mlt_consumer_s
595  * \param arg a consumer
596  */
597
598 static void *consumer_read_ahead_thread( void *arg )
599 {
600         // The argument is the consumer
601         mlt_consumer self = arg;
602
603         // Get the properties of the consumer
604         mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
605
606         // Get the width and height
607         int width = mlt_properties_get_int( properties, "width" );
608         int height = mlt_properties_get_int( properties, "height" );
609
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" );
614
615         // Get the audio settings
616         mlt_audio_format afmt = mlt_audio_s16;
617         int counter = 0;
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" );
621         int samples = 0;
622         void *audio = NULL;
623
624         // See if audio is turned off
625         int audio_off = mlt_properties_get_int( properties, "audio_off" );
626
627         // Get the maximum size of the buffer
628         int buffer = mlt_properties_get_int( properties, "buffer" ) + 1;
629
630         // General frame variable
631         mlt_frame frame = NULL;
632         uint8_t *image = NULL;
633
634         // Time structures
635         struct timeval ante;
636
637         // Average time for get_frame and get_image
638         int count = 1;
639         int skipped = 0;
640         int64_t time_wait = 0;
641         int64_t time_frame = 0;
642         int64_t time_process = 0;
643         int skip_next = 0;
644
645         if ( preview_off && preview_format != 0 )
646                 self->format = preview_format;
647
648         // Get the first frame
649         frame = mlt_consumer_get_frame( self );
650
651         if ( frame )
652         {
653                 // Get the image of the first frame
654                 if ( !video_off )
655                 {
656                         mlt_events_fire( MLT_CONSUMER_PROPERTIES( self ), "consumer-frame-render", frame, NULL );
657                         mlt_frame_get_image( frame, &image, &self->format, &width, &height, 0 );
658                 }
659
660                 if ( !audio_off )
661                 {
662                         samples = mlt_sample_calculator( fps, frequency, counter++ );
663                         mlt_frame_get_audio( frame, &audio, &afmt, &frequency, &channels, &samples );
664                 }
665
666                 // Mark as rendered
667                 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "rendered", 1 );
668         }
669
670         // Get the starting time (can ignore the times above)
671         gettimeofday( &ante, NULL );
672
673         // Continue to read ahead
674         while ( self->ahead )
675         {
676                 // Fetch width/height again
677                 width = mlt_properties_get_int( properties, "width" );
678                 height = mlt_properties_get_int( properties, "height" );
679
680                 // Put the current frame into the queue
681                 pthread_mutex_lock( &self->queue_mutex );
682                 while( self->ahead && mlt_deque_count( self->queue ) >= buffer )
683                         pthread_cond_wait( &self->queue_cond, &self->queue_mutex );
684                 mlt_deque_push_back( self->queue, frame );
685                 pthread_cond_broadcast( &self->queue_cond );
686                 pthread_mutex_unlock( &self->queue_mutex );
687
688                 time_wait += time_difference( &ante );
689
690                 // Get the next frame
691                 frame = mlt_consumer_get_frame( self );
692                 time_frame += time_difference( &ante );
693
694                 // If there's no frame, we're probably stopped...
695                 if ( frame == NULL )
696                         continue;
697
698                 // Increment the count
699                 count ++;
700
701                 // All non normal playback frames should be shown
702                 if ( mlt_properties_get_int( MLT_FRAME_PROPERTIES( frame ), "_speed" ) != 1 )
703                 {
704 #ifdef DEINTERLACE_ON_NOT_NORMAL_SPEED
705                         mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "consumer_deinterlace", 1 );
706 #endif
707                         skipped = 0;
708                         time_frame = 0;
709                         time_process = 0;
710                         time_wait = 0;
711                         count = 1;
712                         skip_next = 0;
713                 }
714
715                 // Get the image
716                 if ( !skip_next || self->real_time == -1 )
717                 {
718                         // Get the image, mark as rendered and time it
719                         if ( !video_off )
720                         {
721                                 mlt_events_fire( MLT_CONSUMER_PROPERTIES( self ), "consumer-frame-render", frame, NULL );
722                                 mlt_frame_get_image( frame, &image, &self->format, &width, &height, 0 );
723                         }
724                         mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "rendered", 1 );
725                 }
726                 else
727                 {
728                         // Increment the number of sequentially skipped frames
729                         skipped ++;
730                         skip_next = 0;
731
732                         // If we've reached an unacceptable level, reset everything
733                         if ( skipped > 5 )
734                         {
735                                 skipped = 0;
736                                 time_frame = 0;
737                                 time_process = 0;
738                                 time_wait = 0;
739                                 count = 1;
740                         }
741                 }
742
743                 // Always process audio
744                 if ( !audio_off )
745                 {
746                         samples = mlt_sample_calculator( fps, frequency, counter++ );
747                         mlt_frame_get_audio( frame, &audio, &afmt, &frequency, &channels, &samples );
748                 }
749
750                 // Increment the time take for self frame
751                 time_process += time_difference( &ante );
752
753                 // Determine if the next frame should be skipped
754                 if ( mlt_deque_count( self->queue ) <= 5 )
755                 {
756                         int frame_duration = mlt_properties_get_int( properties, "frame_duration" );
757                         if ( ( ( time_wait + time_frame + time_process ) / count ) > frame_duration )
758                                 skip_next = 1;
759                 }
760         }
761
762         // Remove the last frame
763         mlt_frame_close( frame );
764
765         return NULL;
766 }
767
768 /** Locate the first unprocessed frame in the queue.
769  *
770  * When playing with realtime behavior, we do not use the true head, but
771  * rather an adjusted process_head. The process_head is adjusted based on
772  * the rate of frame-dropping or recovery from frame-dropping. The idea is
773  * that as the level of frame-dropping increases to move the process_head
774  * closer to the tail because the frames are not completing processing prior
775  * to their playout! Then, as frames are not dropped the process_head moves
776  * back closer to the head of the queue so that worker threads can work 
777  * ahead of the playout point (queue head).
778  *
779  * \private \memberof mlt_consumer_s
780  * \param self a consumer
781  * \return an index into the queue
782  */
783
784 static inline int first_unprocessed_frame( mlt_consumer self )
785 {
786         int index = self->real_time <= 0 ? 0 : self->process_head;
787         while ( index < mlt_deque_count( self->queue ) && MLT_FRAME( mlt_deque_peek( self->queue, index ) )->is_processing )
788                 index++;
789         return index;
790 }
791
792 /** The worker thread procedure for parallel processing frames.
793  *
794  * \private \memberof mlt_consumer_s
795  * \param arg a consumer
796  */
797
798 static void *consumer_worker_thread( void *arg )
799 {
800         // The argument is the consumer
801         mlt_consumer self = arg;
802
803         // Get the properties of the consumer
804         mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
805
806         // Get the width and height
807         int width = mlt_properties_get_int( properties, "width" );
808         int height = mlt_properties_get_int( properties, "height" );
809         mlt_image_format format = self->format;
810
811         // See if video is turned off
812         int video_off = mlt_properties_get_int( properties, "video_off" );
813         int preview_off = mlt_properties_get_int( properties, "preview_off" );
814         int preview_format = mlt_properties_get_int( properties, "preview_format" );
815
816         // General frame variable
817         mlt_frame frame = NULL;
818         uint8_t *image = NULL;
819
820         if ( preview_off && preview_format != 0 )
821                 format = preview_format;
822
823         // Continue to read ahead
824         while ( self->ahead )
825         {
826                 // Get the next unprocessed frame from the work queue
827                 pthread_mutex_lock( &self->queue_mutex );
828                 int index = first_unprocessed_frame( self );
829                 while ( self->ahead && index >= mlt_deque_count( self->queue ) )
830                 {
831                         mlt_log_debug( MLT_CONSUMER_SERVICE(self), "waiting in worker index = %d queue count = %d\n",
832                                 index, mlt_deque_count( self->queue ) );
833                         pthread_cond_wait( &self->queue_cond, &self->queue_mutex );
834                         index = first_unprocessed_frame( self );
835                 }
836
837                 // Mark the frame for processing
838                 frame = mlt_deque_peek( self->queue, index );
839                 if ( frame )
840                 {
841                         mlt_log_debug( MLT_CONSUMER_SERVICE(self), "worker processing index = %d frame %d queue count = %d\n",
842                                 index, mlt_frame_get_position(frame), mlt_deque_count( self->queue ) );
843                         frame->is_processing = 1;
844                         mlt_properties_inc_ref( MLT_FRAME_PROPERTIES( frame ) );
845                 }
846                 pthread_mutex_unlock( &self->queue_mutex );
847
848                 // If there's no frame, we're probably stopped...
849                 if ( frame == NULL )
850                         continue;
851
852 #ifdef DEINTERLACE_ON_NOT_NORMAL_SPEED
853                 // All non normal playback frames should be shown
854                 if ( mlt_properties_get_int( MLT_FRAME_PROPERTIES( frame ), "_speed" ) != 1 )
855                         mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "consumer_deinterlace", 1 );
856 #endif
857
858                 // Get the image
859                 if ( !video_off )
860                 {
861                         // Fetch width/height again
862                         width = mlt_properties_get_int( properties, "width" );
863                         height = mlt_properties_get_int( properties, "height" );
864                         mlt_events_fire( MLT_CONSUMER_PROPERTIES( self ), "consumer-frame-render", frame, NULL );
865                         mlt_frame_get_image( frame, &image, &format, &width, &height, 0 );
866                 }
867                 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "rendered", 1 );
868                 mlt_frame_close( frame );
869
870                 // Tell a waiting thread (non-realtime main consumer thread) that we are done.
871                 pthread_mutex_lock( &self->done_mutex );
872                 pthread_cond_broadcast( &self->done_cond );
873                 pthread_mutex_unlock( &self->done_mutex );
874         }
875
876         return NULL;
877 }
878
879 /** Start the read/render thread.
880  *
881  * \private \memberof mlt_consumer_s
882  * \param self a consumer
883  */
884
885 static void consumer_read_ahead_start( mlt_consumer self )
886 {
887         // We're running now
888         self->ahead = 1;
889
890         // Create the frame queue
891         self->queue = mlt_deque_init( );
892
893         // Create the queue mutex
894         pthread_mutex_init( &self->queue_mutex, NULL );
895
896         // Create the condition
897         pthread_cond_init( &self->queue_cond, NULL );
898
899         // Create the read ahead
900         if ( mlt_properties_get( MLT_CONSUMER_PROPERTIES( self ), "priority" ) )
901         {
902                 struct sched_param priority;
903                 priority.sched_priority = mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( self ), "priority" );
904                 pthread_attr_t thread_attributes;
905                 pthread_attr_init( &thread_attributes );
906                 pthread_attr_setschedpolicy( &thread_attributes, SCHED_OTHER );
907                 pthread_attr_setschedparam( &thread_attributes, &priority );
908                 pthread_attr_setinheritsched( &thread_attributes, PTHREAD_EXPLICIT_SCHED );
909                 pthread_attr_setscope( &thread_attributes, PTHREAD_SCOPE_SYSTEM );
910                 if ( pthread_create( &self->ahead_thread, &thread_attributes, consumer_read_ahead_thread, self ) < 0 )
911                         pthread_create( &self->ahead_thread, NULL, consumer_read_ahead_thread, self );
912                 pthread_attr_destroy( &thread_attributes );
913         }
914         else
915         {
916                 pthread_create( &self->ahead_thread, NULL, consumer_read_ahead_thread, self );
917         }
918         self->started = 1;
919 }
920
921 /** Start the worker threads.
922  *
923  * \private \memberof mlt_consumer_s
924  * \param self a consumer
925  */
926
927 static void consumer_work_start( mlt_consumer self )
928 {
929         int n = abs( self->real_time );
930         pthread_t *thread = calloc( 1, sizeof( pthread_t ) * n );
931
932         // We're running now
933         self->ahead = 1;
934         
935         // These keep track of the accelleration of frame dropping or recovery.
936         self->consecutive_dropped = 0;
937         self->consecutive_rendered = 0;
938         
939         // This is the position in the queue from which to look for a frame to process.
940         // If we always start from the head, then we may likely not complete processing
941         // before the frame is played out.
942         self->process_head = 0;
943
944         // Create the queues
945         self->queue = mlt_deque_init();
946         self->worker_threads = mlt_deque_init();
947
948         // Create the mutexes
949         pthread_mutex_init( &self->queue_mutex, NULL );
950         pthread_mutex_init( &self->done_mutex, NULL );
951
952         // Create the conditions
953         pthread_cond_init( &self->queue_cond, NULL );
954         pthread_cond_init( &self->done_cond, NULL );
955
956         // Create the read ahead
957         if ( mlt_properties_get( MLT_CONSUMER_PROPERTIES( self ), "priority" ) )
958         {
959
960                 struct sched_param priority;
961                 pthread_attr_t thread_attributes;
962
963                 priority.sched_priority = mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( self ), "priority" );
964                 pthread_attr_init( &thread_attributes );
965                 pthread_attr_setschedpolicy( &thread_attributes, SCHED_OTHER );
966                 pthread_attr_setschedparam( &thread_attributes, &priority );
967                 pthread_attr_setinheritsched( &thread_attributes, PTHREAD_EXPLICIT_SCHED );
968                 pthread_attr_setscope( &thread_attributes, PTHREAD_SCOPE_SYSTEM );
969
970                 while ( n-- )
971                 {
972                         if ( pthread_create( thread, &thread_attributes, consumer_worker_thread, self ) < 0 )
973                                 if ( pthread_create( thread, NULL, consumer_worker_thread, self ) == 0 )
974                                         mlt_deque_push_back( self->worker_threads, thread );
975                         thread++;
976                 }
977                 pthread_attr_destroy( &thread_attributes );
978         }
979
980         else
981         {
982                 while ( n-- )
983                 {
984                         if ( pthread_create( thread, NULL, consumer_worker_thread, self ) == 0 )
985                                 mlt_deque_push_back( self->worker_threads, thread );
986                         thread++;
987                 }
988         }
989         self->started = 1;
990 }
991
992 /** Stop the read/render thread.
993  *
994  * \private \memberof mlt_consumer_s
995  * \param self a consumer
996  */
997
998 static void consumer_read_ahead_stop( mlt_consumer self )
999 {
1000         // Make sure we're running
1001         if ( self->started )
1002         {
1003                 // Inform thread to stop
1004                 self->ahead = 0;
1005
1006                 // Broadcast to the condition in case it's waiting
1007                 pthread_mutex_lock( &self->queue_mutex );
1008                 pthread_cond_broadcast( &self->queue_cond );
1009                 pthread_mutex_unlock( &self->queue_mutex );
1010
1011                 // Broadcast to the put condition in case it's waiting
1012                 pthread_mutex_lock( &self->put_mutex );
1013                 pthread_cond_broadcast( &self->put_cond );
1014                 pthread_mutex_unlock( &self->put_mutex );
1015
1016                 // Join the thread
1017                 pthread_join( self->ahead_thread, NULL );
1018                 self->started = 0;
1019
1020                 // Destroy the frame queue mutex
1021                 pthread_mutex_destroy( &self->queue_mutex );
1022
1023                 // Destroy the condition
1024                 pthread_cond_destroy( &self->queue_cond );
1025
1026                 // Wipe the queue
1027                 while ( mlt_deque_count( self->queue ) )
1028                         mlt_frame_close( mlt_deque_pop_back( self->queue ) );
1029
1030                 // Close the queue
1031                 mlt_deque_close( self->queue );
1032         }
1033 }
1034
1035 /** Stop the worker threads.
1036  *
1037  * \private \memberof mlt_consumer_s
1038  * \param self a consumer
1039  */
1040
1041 static void consumer_work_stop( mlt_consumer self )
1042 {
1043         // Make sure we're running
1044         if ( self->started )
1045         {
1046                 // Inform thread to stop
1047                 self->ahead = 0;
1048
1049                 // Broadcast to the queue condition in case it's waiting
1050                 pthread_mutex_lock( &self->queue_mutex );
1051                 pthread_cond_broadcast( &self->queue_cond );
1052                 pthread_mutex_unlock( &self->queue_mutex );
1053
1054                 // Broadcast to the put condition in case it's waiting
1055                 pthread_mutex_lock( &self->put_mutex );
1056                 pthread_cond_broadcast( &self->put_cond );
1057                 pthread_mutex_unlock( &self->put_mutex );
1058
1059                 // Broadcast to the done condition in case it's waiting
1060                 pthread_mutex_lock( &self->done_mutex );
1061                 pthread_cond_broadcast( &self->done_cond );
1062                 pthread_mutex_unlock( &self->done_mutex );
1063
1064                 // Join the threads
1065                 pthread_t *thread;
1066                 while ( ( thread = mlt_deque_pop_back( self->worker_threads ) ) )
1067                         pthread_join( *thread, NULL );
1068
1069                 // Deallocate the array of threads
1070                 if ( thread )
1071                         free( thread );
1072
1073                 // Indicate that worker threads no longer running
1074                 self->started = 0;
1075
1076                 // Destroy the mutexes
1077                 pthread_mutex_destroy( &self->queue_mutex );
1078                 pthread_mutex_destroy( &self->done_mutex );
1079
1080                 // Destroy the conditions
1081                 pthread_cond_destroy( &self->queue_cond );
1082                 pthread_cond_destroy( &self->done_cond );
1083
1084                 // Wipe the queues
1085                 while ( mlt_deque_count( self->queue ) )
1086                         mlt_frame_close( mlt_deque_pop_back( self->queue ) );
1087
1088                 // Close the queues
1089                 mlt_deque_close( self->queue );
1090                 mlt_deque_close( self->worker_threads );
1091         }
1092 }
1093
1094 /** Flush the read/render thread's buffer.
1095  *
1096  * \public \memberof mlt_consumer_s
1097  * \param self a consumer
1098  */
1099
1100 void mlt_consumer_purge( mlt_consumer self )
1101 {
1102         if ( self->ahead )
1103         {
1104                 pthread_mutex_lock( &self->queue_mutex );
1105                 while ( mlt_deque_count( self->queue ) )
1106                         mlt_frame_close( mlt_deque_pop_back( self->queue ) );
1107                 pthread_cond_broadcast( &self->queue_cond );
1108                 pthread_mutex_unlock( &self->queue_mutex );
1109         }
1110 }
1111
1112 /** Use multiple worker threads and a work queue.
1113  */
1114
1115 static mlt_frame worker_get_frame( mlt_consumer self, mlt_properties properties )
1116 {
1117         // Frame to return
1118         mlt_frame frame = NULL;
1119
1120         int size = abs( self->real_time );
1121         int buffer = mlt_properties_get_int( properties, "buffer" );
1122         // This is a heuristic to determine a suitable minimum buffer size for the number of threads.
1123         int headroom = 2 + size * size;
1124         buffer = buffer < headroom ? headroom : buffer;
1125
1126         // Start worker threads if not already started.
1127         if ( ! self->ahead )
1128         {
1129                 int prefill = mlt_properties_get_int( properties, "prefill" );
1130                 prefill = prefill > 0 && prefill < buffer ? prefill : buffer;
1131
1132                 consumer_work_start( self );
1133
1134                 // Fill the work queue.
1135                 int i = buffer;
1136                 while ( self->ahead && i-- )
1137                 {
1138                         frame = mlt_consumer_get_frame( self );
1139                         if ( frame )
1140                         {
1141                                 pthread_mutex_lock( &self->queue_mutex );
1142                                 mlt_deque_push_back( self->queue, frame );
1143                                 pthread_cond_signal( &self->queue_cond );
1144                                 pthread_mutex_unlock( &self->queue_mutex );
1145                         }
1146                 }
1147
1148                 // Wait for prefill
1149                 while ( self->ahead && first_unprocessed_frame( self ) < prefill )
1150                 {
1151                         pthread_mutex_lock( &self->done_mutex );
1152                         pthread_cond_wait( &self->done_cond, &self->done_mutex );
1153                         pthread_mutex_unlock( &self->done_mutex );
1154                 }
1155                 self->process_head = size;
1156         }
1157
1158 //      mlt_log_verbose( MLT_CONSUMER_SERVICE(self), "size %d done count %d work count %d process_head %d\n",
1159 //              size, first_unprocessed_frame( self ), mlt_deque_count( self->queue ), self->process_head );
1160
1161         // Feed the work queue
1162         while ( self->ahead && mlt_deque_count( self->queue ) < buffer )
1163         {
1164                 frame = mlt_consumer_get_frame( self );
1165                 if ( ! frame )
1166                         return frame;
1167                 pthread_mutex_lock( &self->queue_mutex );
1168                 mlt_deque_push_back( self->queue, frame );
1169                 pthread_cond_signal( &self->queue_cond );
1170                 pthread_mutex_unlock( &self->queue_mutex );
1171         }
1172
1173         // Wait if not realtime.
1174         while( self->ahead && self->real_time < 0 &&
1175                ! mlt_properties_get_int( MLT_FRAME_PROPERTIES( MLT_FRAME( mlt_deque_peek_front( self->queue ) ) ), "rendered" ) )
1176         {
1177                 pthread_mutex_lock( &self->done_mutex );
1178                 pthread_cond_wait( &self->done_cond, &self->done_mutex );
1179                 pthread_mutex_unlock( &self->done_mutex );
1180         }
1181         
1182         // Get the frame from the queue.
1183         pthread_mutex_lock( &self->queue_mutex );
1184         frame = mlt_deque_pop_front( self->queue );
1185         pthread_mutex_unlock( &self->queue_mutex );
1186
1187         // Adapt the worker process head to the runtime conditions.
1188         if ( self->real_time > 0 )
1189         {
1190                 if ( frame && mlt_properties_get_int( MLT_FRAME_PROPERTIES( frame ), "rendered" ) )
1191                 {
1192                         self->consecutive_dropped = 0;
1193                         if ( self->process_head > size && self->consecutive_rendered >= self->process_head )
1194                                 self->process_head--;
1195                         else
1196                                 self->consecutive_rendered++;
1197                 }
1198                 else
1199                 {
1200                         self->consecutive_rendered = 0;
1201                         if ( self->process_head < buffer - size && self->consecutive_dropped > size )
1202                                 self->process_head++;
1203                         else
1204                                 self->consecutive_dropped++;
1205                 }
1206 //              mlt_log_verbose( MLT_CONSUMER_SERVICE(self), "dropped %d rendered %d process_head %d\n",
1207 //                      self->consecutive_dropped, self->consecutive_rendered, self->process_head );
1208         }
1209         
1210         return frame;
1211 }
1212
1213 /** Get the next frame from the producer connected to a consumer.
1214  *
1215  * Typically, one uses this instead of \p mlt_consumer_get_frame to make
1216  * the asynchronous/real-time behavior configurable at runtime.
1217  * You should close the frame returned from this when you are done with it.
1218  *
1219  * \public \memberof mlt_consumer_s
1220  * \param self a consumer
1221  * \return a frame
1222  */
1223
1224 mlt_frame mlt_consumer_rt_frame( mlt_consumer self )
1225 {
1226         // Frame to return
1227         mlt_frame frame = NULL;
1228
1229         // Get the properties
1230         mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
1231
1232         // Check if the user has requested real time or not
1233         if ( self->real_time > 1 || self->real_time < -1 )
1234         {
1235                 // see above
1236                 return worker_get_frame( self, properties );
1237         }
1238         else if ( self->real_time == 1 || self->real_time == -1 )
1239         {
1240                 int size = 1;
1241
1242                 // Is the read ahead running?
1243                 if ( self->ahead == 0 )
1244                 {
1245                         int buffer = mlt_properties_get_int( properties, "buffer" );
1246                         int prefill = mlt_properties_get_int( properties, "prefill" );
1247                         consumer_read_ahead_start( self );
1248                         if ( buffer > 1 )
1249                                 size = prefill > 0 && prefill < buffer ? prefill : buffer;
1250                 }
1251
1252                 // Get frame from queue
1253                 pthread_mutex_lock( &self->queue_mutex );
1254                 while( self->ahead && mlt_deque_count( self->queue ) < size )
1255                         pthread_cond_wait( &self->queue_cond, &self->queue_mutex );
1256                 frame = mlt_deque_pop_front( self->queue );
1257                 pthread_cond_broadcast( &self->queue_cond );
1258                 pthread_mutex_unlock( &self->queue_mutex );
1259         }
1260         else // real_time == 0
1261         {
1262                 // Get the frame in non real time
1263                 frame = mlt_consumer_get_frame( self );
1264
1265                 // This isn't true, but from the consumers perspective it is
1266                 if ( frame != NULL )
1267                         mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "rendered", 1 );
1268         }
1269
1270         return frame;
1271 }
1272
1273 /** Callback for the implementation to indicate a stopped condition.
1274  *
1275  * \public \memberof mlt_consumer_s
1276  * \param self a consumer
1277  */
1278
1279 void mlt_consumer_stopped( mlt_consumer self )
1280 {
1281         mlt_properties_set_int( MLT_CONSUMER_PROPERTIES( self ), "running", 0 );
1282         mlt_events_fire( MLT_CONSUMER_PROPERTIES( self ), "consumer-stopped", NULL );
1283         mlt_event_unblock( self->event_listener );
1284 }
1285
1286 /** Stop the consumer.
1287  *
1288  * \public \memberof mlt_consumer_s
1289  * \param self a consumer
1290  * \return true if there was an error
1291  */
1292
1293 int mlt_consumer_stop( mlt_consumer self )
1294 {
1295         // Get the properies
1296         mlt_properties properties = MLT_CONSUMER_PROPERTIES( self );
1297
1298         // Just in case...
1299         mlt_log( MLT_CONSUMER_SERVICE( self ), MLT_LOG_DEBUG, "stopping put waiting\n" );
1300         pthread_mutex_lock( &self->put_mutex );
1301         self->put_active = 0;
1302         pthread_cond_broadcast( &self->put_cond );
1303         pthread_mutex_unlock( &self->put_mutex );
1304
1305         // Stop the consumer
1306         mlt_log( MLT_CONSUMER_SERVICE( self ), MLT_LOG_DEBUG, "stopping consumer\n" );
1307         
1308         // Cancel the read ahead threads
1309         self->ahead = 0;
1310         if ( self->started )
1311         {
1312                 // Unblock the consumer calling mlt_consumer_rt_frame
1313                 pthread_mutex_lock( &self->queue_mutex );
1314                 pthread_cond_broadcast( &self->queue_cond );
1315                 pthread_mutex_unlock( &self->queue_mutex );             
1316         }
1317         
1318         // Invoke the child callback
1319         if ( self->stop != NULL )
1320                 self->stop( self );
1321
1322         // Check if the user has requested real time or not and stop if necessary
1323         mlt_log( MLT_CONSUMER_SERVICE( self ), MLT_LOG_DEBUG, "stopping read_ahead\n" );
1324         if ( abs( self->real_time ) == 1 )
1325                 consumer_read_ahead_stop( self );
1326         else if ( abs( self->real_time ) > 1 )
1327                 consumer_work_stop( self );
1328
1329         // Kill the test card
1330         mlt_properties_set_data( properties, "test_card_producer", NULL, 0, NULL, NULL );
1331
1332         // Check and run a post command
1333         if ( mlt_properties_get( properties, "post" ) )
1334                 if (system( mlt_properties_get( properties, "post" ) ) == -1 )
1335                         mlt_log( MLT_CONSUMER_SERVICE( self ), MLT_LOG_ERROR, "system(%s) failed!\n", mlt_properties_get( properties, "post" ) );
1336
1337         mlt_log( MLT_CONSUMER_SERVICE( self ), MLT_LOG_DEBUG, "stopped\n" );
1338
1339         return 0;
1340 }
1341
1342 /** Determine if the consumer is stopped.
1343  *
1344  * \public \memberof mlt_consumer_s
1345  * \param self a consumer
1346  * \return true if the consumer is stopped
1347  */
1348
1349 int mlt_consumer_is_stopped( mlt_consumer self )
1350 {
1351         // Check if the consumer is stopped
1352         if ( self->is_stopped != NULL )
1353                 return self->is_stopped( self );
1354
1355         return 0;
1356 }
1357
1358 /** Close and destroy the consumer.
1359  *
1360  * \public \memberof mlt_consumer_s
1361  * \param self a consumer
1362  */
1363
1364 void mlt_consumer_close( mlt_consumer self )
1365 {
1366         if ( self != NULL && mlt_properties_dec_ref( MLT_CONSUMER_PROPERTIES( self ) ) <= 0 )
1367         {
1368                 // Get the childs close function
1369                 void ( *consumer_close )( ) = self->close;
1370
1371                 if ( consumer_close )
1372                 {
1373                         // Just in case...
1374                         //mlt_consumer_stop( self );
1375
1376                         self->close = NULL;
1377                         consumer_close( self );
1378                 }
1379                 else
1380                 {
1381                         // Make sure it only gets called once
1382                         self->parent.close = NULL;
1383
1384                         // Destroy the push mutex and condition
1385                         pthread_mutex_destroy( &self->put_mutex );
1386                         pthread_cond_destroy( &self->put_cond );
1387
1388                         mlt_service_close( &self->parent );
1389                 }
1390         }
1391 }
1392
1393 /** Get the position of the last frame shown.
1394  *
1395  * \public \memberof mlt_consumer_s
1396  * \param consumer a consumer
1397  * \return the position
1398  */
1399
1400 mlt_position mlt_consumer_position( mlt_consumer consumer )
1401 {
1402         return consumer->position;
1403 }
1404