]> git.sesse.net Git - mlt/blob - src/framework/mlt_consumer.c
SMP/HT fixes
[mlt] / src / framework / mlt_consumer.c
1 /*
2  * mlt_consumer.c -- abstraction for all consumer services
3  * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
4  * Author: Charles Yates <charles.yates@pandora.be>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19  */
20
21 #include "config.h"
22 #include "mlt_consumer.h"
23 #include "mlt_factory.h"
24 #include "mlt_producer.h"
25 #include "mlt_frame.h"
26 #include <stdio.h>
27 #include <string.h>
28 #include <stdlib.h>
29 #include <sys/time.h>
30
31 static void mlt_consumer_frame_show( mlt_listener listener, mlt_properties owner, mlt_service this, void **args );
32
33 /** Public final methods
34 */
35
36 int mlt_consumer_init( mlt_consumer this, void *child )
37 {
38         int error = 0;
39         memset( this, 0, sizeof( struct mlt_consumer_s ) );
40         this->child = child;
41         error = mlt_service_init( &this->parent, this );
42         if ( error == 0 )
43         {
44                 // Get the properties from the service
45                 mlt_properties properties = MLT_SERVICE_PROPERTIES( &this->parent );
46
47                 // Get the normalisation preference
48                 char *normalisation = mlt_environment( "MLT_NORMALISATION" );
49
50                 // Deal with normalisation
51                 if ( normalisation == NULL || strcmp( normalisation, "NTSC" ) )
52                 {
53                         mlt_properties_set( properties, "normalisation", "PAL" );
54                         mlt_properties_set_double( properties, "fps", 25.0 );
55                         mlt_properties_set_int( properties, "width", 720 );
56                         mlt_properties_set_int( properties, "height", 576 );
57                         mlt_properties_set_int( properties, "progressive", 0 );
58                         mlt_properties_set_double( properties, "aspect_ratio", 59.0 / 54.0 );
59                 }
60                 else
61                 {
62                         mlt_properties_set( properties, "normalisation", "NTSC" );
63                         mlt_properties_set_double( properties, "fps", 30000.0 / 1001.0 );
64                         mlt_properties_set_int( properties, "width", 720 );
65                         mlt_properties_set_int( properties, "height", 480 );
66                         mlt_properties_set_int( properties, "progressive", 0 );
67                         mlt_properties_set_double( properties, "aspect_ratio", 10.0 / 11.0 );
68                 }
69
70                 // Default rescaler for all consumers
71                 mlt_properties_set( properties, "rescale", "bilinear" );
72
73                 // Default read ahead buffer size
74                 mlt_properties_set_int( properties, "buffer", 25 );
75
76                 // Default audio frequency and channels
77                 mlt_properties_set_int( properties, "frequency", 48000 );
78                 mlt_properties_set_int( properties, "channels", 2 );
79
80                 // Default of all consumers is real time
81                 mlt_properties_set_int( properties, "real_time", 1 );
82
83                 // Default to environment test card
84                 mlt_properties_set( properties, "test_card", mlt_environment( "MLT_TEST_CARD" ) );
85
86                 // Hmm - default all consumers to yuv422 :-/
87                 this->format = mlt_image_yuv422;
88
89                 mlt_events_register( properties, "consumer-frame-show", ( mlt_transmitter )mlt_consumer_frame_show );
90                 mlt_events_register( properties, "consumer-stopped", NULL );
91
92                 // Create the push mutex and condition
93                 pthread_mutex_init( &this->put_mutex, NULL );
94                 pthread_cond_init( &this->put_cond, NULL );
95
96         }
97         return error;
98 }
99
100 static void mlt_consumer_frame_show( mlt_listener listener, mlt_properties owner, mlt_service this, void **args )
101 {
102         if ( listener != NULL )
103                 listener( owner, this, ( mlt_frame )args[ 0 ] );
104 }
105
106 /** Create a new consumer.
107 */
108
109 mlt_consumer mlt_consumer_new( )
110 {
111         // Create the memory for the structure
112         mlt_consumer this = malloc( sizeof( struct mlt_consumer_s ) );
113
114         // Initialise it
115         if ( this != NULL )
116                 mlt_consumer_init( this, NULL );
117
118         // Return it
119         return this;
120 }
121
122 /** Get the parent service object.
123 */
124
125 mlt_service mlt_consumer_service( mlt_consumer this )
126 {
127         return this != NULL ? &this->parent : NULL;
128 }
129
130 /** Get the consumer properties.
131 */
132
133 mlt_properties mlt_consumer_properties( mlt_consumer this )
134 {
135         return this != NULL ? MLT_SERVICE_PROPERTIES( &this->parent ) : NULL;
136 }
137
138 /** Connect the consumer to the producer.
139 */
140
141 int mlt_consumer_connect( mlt_consumer this, mlt_service producer )
142 {
143         return mlt_service_connect_producer( &this->parent, producer, 0 );
144 }
145
146 /** Start the consumer.
147 */
148
149 int mlt_consumer_start( mlt_consumer this )
150 {
151         // Get the properies
152         mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
153
154         // Determine if there's a test card producer
155         char *test_card = mlt_properties_get( properties, "test_card" );
156
157         // Just to make sure nothing is hanging around...
158         mlt_frame_close( this->put );
159         this->put = NULL;
160         this->put_active = 1;
161
162         // Deal with it now.
163         if ( test_card != NULL )
164         {
165                 if ( mlt_properties_get_data( properties, "test_card_producer", NULL ) == NULL )
166                 {
167                         // Create a test card producer
168                         mlt_producer producer = mlt_factory_producer( NULL, test_card );
169
170                         // Do we have a producer
171                         if ( producer != NULL )
172                         {
173                                 // Test card should loop I guess...
174                                 mlt_properties_set( MLT_PRODUCER_PROPERTIES( producer ), "eof", "pause" );
175                                 mlt_producer_set_speed( producer, 0 );
176                                 mlt_producer_set_in_and_out( producer, 0, 0 );
177
178                                 // Set the test card on the consumer
179                                 mlt_properties_set_data( properties, "test_card_producer", producer, 0, ( mlt_destructor )mlt_producer_close, NULL );
180                         }
181                 }
182         }
183         else
184         {
185                 // Allow the hash table to speed things up
186                 mlt_properties_set_data( properties, "test_card_producer", NULL, 0, NULL, NULL );
187         }
188
189         // Check and run an ante command
190         if ( mlt_properties_get( properties, "ante" ) )
191                 system( mlt_properties_get( properties, "ante" ) );
192
193         // Set the real_time preference
194         this->real_time = mlt_properties_get_int( properties, "real_time" );
195
196         // Start the service
197         if ( this->start != NULL )
198                 return this->start( this );
199
200         return 0;
201 }
202
203 /** An alternative method to feed frames into the consumer - only valid if
204         the consumer itself is not connected.
205 */
206
207 int mlt_consumer_put_frame( mlt_consumer this, mlt_frame frame )
208 {
209         int error = 1;
210
211         // Get the service assoicated to the consumer
212         mlt_service service = MLT_CONSUMER_SERVICE( this );
213
214         if ( mlt_service_producer( service ) == NULL )
215         {
216                 struct timeval now;
217                 struct timespec tm;
218                 pthread_mutex_lock( &this->put_mutex );
219                 while ( this->put_active && this->put != NULL )
220                 {
221                         gettimeofday( &now, NULL );
222                         tm.tv_sec = now.tv_sec + 1;
223                         tm.tv_nsec = now.tv_usec * 1000;
224                         pthread_cond_timedwait( &this->put_cond, &this->put_mutex, &tm );
225                 }
226                 if ( this->put_active && this->put == NULL )
227                         this->put = frame;
228                 else
229                         mlt_frame_close( frame );
230                 pthread_cond_broadcast( &this->put_cond );
231                 pthread_mutex_unlock( &this->put_mutex );
232         }
233         else
234         {
235                 mlt_frame_close( frame );
236         }
237
238         return error;
239 }
240
241 /** Protected method for consumer to get frames from connected service
242 */
243
244 mlt_frame mlt_consumer_get_frame( mlt_consumer this )
245 {
246         // Frame to return
247         mlt_frame frame = NULL;
248
249         // Get the service assoicated to the consumer
250         mlt_service service = MLT_CONSUMER_SERVICE( this );
251
252         // Get the consumer properties
253         mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
254
255         // Get the frame
256         if ( mlt_service_producer( service ) == NULL && mlt_properties_get_int( properties, "put_mode" ) )
257         {
258                 struct timeval now;
259                 struct timespec tm;
260                 pthread_mutex_lock( &this->put_mutex );
261                 while ( this->put_active && this->put == NULL )
262                 {
263                         gettimeofday( &now, NULL );
264                         tm.tv_sec = now.tv_sec + 1;
265                         tm.tv_nsec = now.tv_usec * 1000;
266                         pthread_cond_timedwait( &this->put_cond, &this->put_mutex, &tm );
267                 }
268                 frame = this->put;
269                 this->put = NULL;
270                 pthread_cond_broadcast( &this->put_cond );
271                 pthread_mutex_unlock( &this->put_mutex );
272                 if ( frame != NULL )
273                         mlt_service_apply_filters( service, frame, 0 );
274         }
275         else if ( mlt_service_producer( service ) != NULL )
276         {
277                 mlt_service_get_frame( service, &frame, 0 );
278         }
279
280         if ( frame != NULL )
281         {
282                 // Get the frame properties
283                 mlt_properties frame_properties = MLT_FRAME_PROPERTIES( frame );
284
285                 // Get the test card producer
286                 mlt_producer test_card = mlt_properties_get_data( properties, "test_card_producer", NULL );
287
288                 // Attach the test frame producer to it.
289                 if ( test_card != NULL )
290                         mlt_properties_set_data( frame_properties, "test_card_producer", test_card, 0, NULL, NULL );
291
292                 // Attach the rescale property
293                 mlt_properties_set( frame_properties, "rescale.interp", mlt_properties_get( properties, "rescale" ) );
294
295                 // Aspect ratio and other jiggery pokery
296                 mlt_properties_set_double( frame_properties, "consumer_aspect_ratio", mlt_properties_get_double( properties, "aspect_ratio" ) );
297                 mlt_properties_set_int( frame_properties, "consumer_deinterlace", mlt_properties_get_int( properties, "progressive" ) | mlt_properties_get_int( properties, "deinterlace" ) );
298         }
299
300         // Return the frame
301         return frame;
302 }
303
304 static inline long time_difference( struct timeval *time1 )
305 {
306         struct timeval time2;
307         time2.tv_sec = time1->tv_sec;
308         time2.tv_usec = time1->tv_usec;
309         gettimeofday( time1, NULL );
310         return time1->tv_sec * 1000000 + time1->tv_usec - time2.tv_sec * 1000000 - time2.tv_usec;
311 }
312
313 static void *consumer_read_ahead_thread( void *arg )
314 {
315         // The argument is the consumer
316         mlt_consumer this = arg;
317
318         // Get the properties of the consumer
319         mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
320
321         // Get the width and height
322         int width = mlt_properties_get_int( properties, "width" );
323         int height = mlt_properties_get_int( properties, "height" );
324
325         // See if video is turned off
326         int video_off = mlt_properties_get_int( properties, "video_off" );
327
328         // Get the audio settings
329         mlt_audio_format afmt = mlt_audio_pcm;
330         int counter = 0;
331         double fps = mlt_properties_get_double( properties, "fps" );
332         int channels = mlt_properties_get_int( properties, "channels" );
333         int frequency = mlt_properties_get_int( properties, "frequency" );
334         int samples = 0;
335         int16_t *pcm = NULL;
336
337         // See if audio is turned off
338         int audio_off = mlt_properties_get_int( properties, "audio_off" );
339
340         // Get the maximum size of the buffer
341         int buffer = mlt_properties_get_int( properties, "buffer" ) + 1;
342
343         // General frame variable
344         mlt_frame frame = NULL;
345         uint8_t *image = NULL;
346
347         // Time structures
348         struct timeval ante;
349
350         // Average time for get_frame and get_image
351         int count = 1;
352         int skipped = 0;
353         int64_t time_wait = 0;
354         int64_t time_frame = 0;
355         int64_t time_process = 0;
356         int skip_next = 0;
357         mlt_service lock_object = NULL;
358
359         // Get the first frame
360         frame = mlt_consumer_get_frame( this );
361
362         // Get the lock object
363         lock_object = mlt_properties_get_data( MLT_FRAME_PROPERTIES( frame ), "consumer_lock_service", NULL );
364
365         // Lock it
366         if ( lock_object ) mlt_service_lock( lock_object );
367
368         // Get the image of the first frame
369         if ( !video_off )
370                 mlt_frame_get_image( frame, &image, &this->format, &width, &height, 0 );
371
372         if ( !audio_off )
373         {
374                 samples = mlt_sample_calculator( fps, frequency, counter++ );
375                 mlt_frame_get_audio( frame, &pcm, &afmt, &frequency, &channels, &samples );
376         }
377
378         // Unlock the lock object
379         if ( lock_object ) mlt_service_unlock( lock_object );
380
381         // Mark as rendered
382         mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "rendered", 1 );
383
384         // Get the starting time (can ignore the times above)
385         gettimeofday( &ante, NULL );
386
387         // Continue to read ahead
388         while ( this->ahead )
389         {
390                 // Put the current frame into the queue
391                 pthread_mutex_lock( &this->mutex );
392                 while( this->ahead && mlt_deque_count( this->queue ) >= buffer )
393                         pthread_cond_wait( &this->cond, &this->mutex );
394                 mlt_deque_push_back( this->queue, frame );
395                 pthread_cond_broadcast( &this->cond );
396                 pthread_mutex_unlock( &this->mutex );
397
398                 time_wait += time_difference( &ante );
399
400                 // Get the next frame
401                 frame = mlt_consumer_get_frame( this );
402                 time_frame += time_difference( &ante );
403
404                 // If there's no frame, we're probably stopped...
405                 if ( frame == NULL )
406                         continue;
407
408                 // Attempt to fetch the lock object
409                 lock_object = mlt_properties_get_data( MLT_FRAME_PROPERTIES( frame ), "consumer_lock_service", NULL );
410
411                 // Increment the count
412                 count ++;
413
414                 // Lock if there's a lock object
415                 if ( lock_object ) mlt_service_lock( lock_object );
416
417                 // All non normal playback frames should be shown
418                 if ( mlt_properties_get_int( MLT_FRAME_PROPERTIES( frame ), "_speed" ) != 1 )
419                 {
420                         skipped = 0;
421                         time_frame = 0;
422                         time_process = 0;
423                         time_wait = 0;
424                         count = 1;
425                         skip_next = 0;
426                 }
427
428                 // Get the image
429                 if ( !skip_next )
430                 {
431                         // Get the image, mark as rendered and time it
432                         if ( !video_off )
433                                 mlt_frame_get_image( frame, &image, &this->format, &width, &height, 0 );
434                         mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "rendered", 1 );
435                 }
436                 else
437                 {
438                         // Increment the number of sequentially skipped frames
439                         skipped ++;
440                         skip_next = 0;
441
442                         // If we've reached an unacceptable level, reset everything
443                         if ( skipped > 5 )
444                         {
445                                 skipped = 0;
446                                 time_frame = 0;
447                                 time_process = 0;
448                                 time_wait = 0;
449                                 count = 1;
450                         }
451                 }
452
453                 // Always process audio
454                 if ( !audio_off )
455                 {
456                         samples = mlt_sample_calculator( fps, frequency, counter++ );
457                         mlt_frame_get_audio( frame, &pcm, &afmt, &frequency, &channels, &samples );
458                 }
459
460                 // Increment the time take for this frame
461                 time_process += time_difference( &ante );
462
463                 // Determine if the next frame should be skipped
464                 if ( mlt_deque_count( this->queue ) <= 5 && ( ( time_wait + time_frame + time_process ) / count ) > 40000 )
465                         skip_next = 1;
466
467                 // Unlock if there's a lock object
468                 if ( lock_object ) mlt_service_unlock( lock_object );
469         }
470
471         // Remove the last frame
472         mlt_frame_close( frame );
473
474         return NULL;
475 }
476
477 static void consumer_read_ahead_start( mlt_consumer this )
478 {
479         pthread_attr_t thread_attributes;
480         
481         // We're running now
482         this->ahead = 1;
483
484         // Create the frame queue
485         this->queue = mlt_deque_init( );
486
487         // Create the mutex
488         pthread_mutex_init( &this->mutex, NULL );
489
490         // Create the condition
491         pthread_cond_init( &this->cond, NULL );
492
493         // Inherit the scheduling priority
494         pthread_attr_init( &thread_attributes );
495         pthread_attr_setinheritsched( &thread_attributes, PTHREAD_INHERIT_SCHED );
496         
497         // Create the read ahead 
498         pthread_create( &this->ahead_thread, &thread_attributes, consumer_read_ahead_thread, this );
499 }
500
501 static void consumer_read_ahead_stop( mlt_consumer this )
502 {
503         // Make sure we're running
504         if ( this->ahead )
505         {
506                 // Inform thread to stop
507                 this->ahead = 0;
508
509                 // Broadcast to the condition in case it's waiting
510                 pthread_mutex_lock( &this->mutex );
511                 pthread_cond_broadcast( &this->cond );
512                 pthread_mutex_unlock( &this->mutex );
513
514                 // Broadcast to the put condition in case it's waiting
515                 pthread_mutex_lock( &this->put_mutex );
516                 pthread_cond_broadcast( &this->put_cond );
517                 pthread_mutex_unlock( &this->put_mutex );
518
519                 // Join the thread
520                 pthread_join( this->ahead_thread, NULL );
521
522                 // Destroy the mutex
523                 pthread_mutex_destroy( &this->mutex );
524
525                 // Destroy the condition
526                 pthread_cond_destroy( &this->cond );
527
528                 // Wipe the queue
529                 while ( mlt_deque_count( this->queue ) )
530                         mlt_frame_close( mlt_deque_pop_back( this->queue ) );
531
532                 // Close the queue
533                 mlt_deque_close( this->queue );
534         }
535 }
536
537 void mlt_consumer_purge( mlt_consumer this )
538 {
539         if ( this->ahead )
540         {
541                 pthread_mutex_lock( &this->mutex );
542                 while ( mlt_deque_count( this->queue ) )
543                         mlt_frame_close( mlt_deque_pop_back( this->queue ) );
544                 pthread_cond_broadcast( &this->cond );
545                 pthread_mutex_unlock( &this->mutex );
546         }
547 }
548
549 mlt_frame mlt_consumer_rt_frame( mlt_consumer this )
550 {
551         // Frame to return
552         mlt_frame frame = NULL;
553
554         // Get the properties
555         mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
556
557         // Check if the user has requested real time or not
558         if ( this->real_time )
559         {
560                 int size = 1;
561
562                 // Is the read ahead running?
563                 if ( this->ahead == 0 )
564                 {
565                         int buffer = mlt_properties_get_int( properties, "buffer" );
566                         int prefill = mlt_properties_get_int( properties, "prefill" );
567                         consumer_read_ahead_start( this );
568                         if ( buffer > 1 )
569                                 size = prefill > 0 && prefill < buffer ? prefill : buffer;
570                 }
571         
572                 // Get frame from queue
573                 pthread_mutex_lock( &this->mutex );
574                 while( this->ahead && mlt_deque_count( this->queue ) < size )
575                         pthread_cond_wait( &this->cond, &this->mutex );
576                 frame = mlt_deque_pop_front( this->queue );
577                 pthread_cond_broadcast( &this->cond );
578                 pthread_mutex_unlock( &this->mutex );
579         }
580         else
581         {
582                 // Get the frame in non real time
583                 frame = mlt_consumer_get_frame( this );
584
585                 // This isn't true, but from the consumers perspective it is
586                 if ( frame != NULL )
587                         mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "rendered", 1 );
588         }
589
590         return frame;
591 }
592
593 /** Callback for the implementation to indicate a stopped condition.
594 */
595
596 void mlt_consumer_stopped( mlt_consumer this )
597 {
598         mlt_properties_set_int( MLT_CONSUMER_PROPERTIES( this ), "running", 0 );
599         mlt_events_fire( MLT_CONSUMER_PROPERTIES( this ), "consumer-stopped", NULL );
600 }
601
602 /** Stop the consumer.
603 */
604
605 int mlt_consumer_stop( mlt_consumer this )
606 {
607         // Get the properies
608         mlt_properties properties = MLT_CONSUMER_PROPERTIES( this );
609         char *debug = mlt_properties_get( MLT_CONSUMER_PROPERTIES( this ), "debug" );
610
611         // Just in case...
612         if ( debug ) fprintf( stderr, "%s: stopping put waiting\n", debug );
613         pthread_mutex_lock( &this->put_mutex );
614         this->put_active = 0;
615         pthread_cond_broadcast( &this->put_cond );
616         pthread_mutex_unlock( &this->put_mutex );
617
618         // Stop the consumer
619         if ( debug ) fprintf( stderr, "%s: stopping consumer\n", debug );
620         if ( this->stop != NULL )
621                 this->stop( this );
622
623         // Check if the user has requested real time or not and stop if necessary
624         if ( debug ) fprintf( stderr, "%s: stopping read_ahead\n", debug );
625         if ( mlt_properties_get_int( properties, "real_time" ) )
626                 consumer_read_ahead_stop( this );
627
628         // Kill the test card
629         mlt_properties_set_data( properties, "test_card_producer", NULL, 0, NULL, NULL );
630
631         // Check and run a post command
632         if ( mlt_properties_get( properties, "post" ) )
633                 system( mlt_properties_get( properties, "post" ) );
634
635         if ( debug ) fprintf( stderr, "%s: stopped\n", debug );
636
637         return 0;
638 }
639
640 /** Determine if the consumer is stopped.
641 */
642
643 int mlt_consumer_is_stopped( mlt_consumer this )
644 {
645         // Check if the consumer is stopped
646         if ( this->is_stopped != NULL )
647                 return this->is_stopped( this );
648
649         return 0;
650 }
651
652 /** Close the consumer.
653 */
654
655 void mlt_consumer_close( mlt_consumer this )
656 {
657         if ( this != NULL && mlt_properties_dec_ref( MLT_CONSUMER_PROPERTIES( this ) ) <= 0 )
658         {
659                 // Get the childs close function
660                 void ( *consumer_close )( ) = this->close;
661
662                 if ( consumer_close )
663                 {
664                         // Just in case...
665                         //mlt_consumer_stop( this );
666
667                         this->close = NULL;
668                         consumer_close( this );
669                 }
670                 else
671                 {
672                         // Make sure it only gets called once
673                         this->parent.close = NULL;
674
675                         // Destroy the push mutex and condition
676                         pthread_mutex_destroy( &this->put_mutex );
677                         pthread_cond_destroy( &this->put_cond );
678
679                         mlt_service_close( &this->parent );
680                 }
681         }
682 }