2 * consumer_sdl_audio.c -- A Simple DirectMedia Layer audio-only consumer
3 * Copyright (C) 2009-2012 Ushodaya Enterprises Limited
4 * Author: Dan Dennedy <dan@dennedy.org>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library 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 GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 #include <framework/mlt_consumer.h>
22 #include <framework/mlt_frame.h>
23 #include <framework/mlt_deque.h>
24 #include <framework/mlt_factory.h>
25 #include <framework/mlt_filter.h>
26 #include <framework/mlt_log.h>
34 extern pthread_mutex_t mlt_sdl_mutex;
36 /** This classes definition.
39 typedef struct consumer_sdl_s *consumer_sdl;
43 struct mlt_consumer_s parent;
44 mlt_properties properties;
49 uint8_t audio_buffer[ 4096 * 10 ];
51 pthread_mutex_t audio_mutex;
52 pthread_cond_t audio_cond;
53 pthread_mutex_t video_mutex;
54 pthread_cond_t video_cond;
57 pthread_cond_t refresh_cond;
58 pthread_mutex_t refresh_mutex;
62 /** Forward references to static functions.
65 static int consumer_start( mlt_consumer parent );
66 static int consumer_stop( mlt_consumer parent );
67 static int consumer_is_stopped( mlt_consumer parent );
68 static void consumer_close( mlt_consumer parent );
69 static void *consumer_thread( void * );
70 static void consumer_refresh_cb( mlt_consumer sdl, mlt_consumer self, char *name );
72 /** This is what will be called by the factory - anything can be passed in
73 via the argument, but keep it simple.
76 mlt_consumer consumer_sdl_audio_init( mlt_profile profile, mlt_service_type type, const char *id, char *arg )
78 // Create the consumer object
79 consumer_sdl self = calloc( 1, sizeof( struct consumer_sdl_s ) );
81 // If no malloc'd and consumer init ok
82 if ( self != NULL && mlt_consumer_init( &self->parent, self, profile ) == 0 )
85 self->queue = mlt_deque_init( );
87 // Get the parent consumer object
88 mlt_consumer parent = &self->parent;
90 // We have stuff to clean up, so override the close method
91 parent->close = consumer_close;
93 // get a handle on properties
94 mlt_service service = MLT_CONSUMER_SERVICE( parent );
95 self->properties = MLT_SERVICE_PROPERTIES( service );
97 // Set the default volume
98 mlt_properties_set_double( self->properties, "volume", 1.0 );
100 // This is the initialisation of the consumer
101 pthread_mutex_init( &self->audio_mutex, NULL );
102 pthread_cond_init( &self->audio_cond, NULL);
103 pthread_mutex_init( &self->video_mutex, NULL );
104 pthread_cond_init( &self->video_cond, NULL);
106 // Default scaler (for now we'll use nearest)
107 mlt_properties_set( self->properties, "rescale", "nearest" );
108 mlt_properties_set( self->properties, "deinterlace_method", "onefield" );
109 mlt_properties_set_int( self->properties, "top_field_first", -1 );
111 // Default buffer for low latency
112 mlt_properties_set_int( self->properties, "buffer", 1 );
114 // Default audio buffer
115 mlt_properties_set_int( self->properties, "audio_buffer", 2048 );
117 // Ensure we don't join on a non-running object
120 // Allow thread to be started/stopped
121 parent->start = consumer_start;
122 parent->stop = consumer_stop;
123 parent->is_stopped = consumer_is_stopped;
125 // Initialize the refresh handler
126 pthread_cond_init( &self->refresh_cond, NULL );
127 pthread_mutex_init( &self->refresh_mutex, NULL );
128 mlt_events_listen( MLT_CONSUMER_PROPERTIES( parent ), self, "property-changed", ( mlt_listener )consumer_refresh_cb );
130 // Return the consumer produced
134 // malloc or consumer init failed
141 static void consumer_refresh_cb( mlt_consumer sdl, mlt_consumer parent, char *name )
143 if ( !strcmp( name, "refresh" ) )
145 consumer_sdl self = parent->child;
146 pthread_mutex_lock( &self->refresh_mutex );
147 if ( self->refresh_count < 2 )
148 self->refresh_count = self->refresh_count <= 0 ? 1 : self->refresh_count + 1;
149 pthread_cond_broadcast( &self->refresh_cond );
150 pthread_mutex_unlock( &self->refresh_mutex );
154 int consumer_start( mlt_consumer parent )
156 consumer_sdl self = parent->child;
158 if ( !self->running )
160 consumer_stop( parent );
162 pthread_mutex_lock( &mlt_sdl_mutex );
163 int ret = SDL_Init( SDL_INIT_AUDIO | SDL_INIT_NOPARACHUTE );
164 pthread_mutex_unlock( &mlt_sdl_mutex );
167 mlt_log_error( MLT_CONSUMER_SERVICE(parent), "Failed to initialize SDL: %s\n", SDL_GetError() );
173 pthread_create( &self->thread, NULL, consumer_thread, self );
179 int consumer_stop( mlt_consumer parent )
181 // Get the actual object
182 consumer_sdl self = parent->child;
184 if ( self->running && !self->joined )
186 // Kill the thread and clean up
190 // Unlatch the consumer thread
191 pthread_mutex_lock( &self->refresh_mutex );
192 pthread_cond_broadcast( &self->refresh_cond );
193 pthread_mutex_unlock( &self->refresh_mutex );
195 // Cleanup the main thread
199 pthread_join( self->thread, NULL );
201 // Unlatch the video thread
202 pthread_mutex_lock( &self->video_mutex );
203 pthread_cond_broadcast( &self->video_cond );
204 pthread_mutex_unlock( &self->video_mutex );
206 // Unlatch the audio callback
207 pthread_mutex_lock( &self->audio_mutex );
208 pthread_cond_broadcast( &self->audio_cond );
209 pthread_mutex_unlock( &self->audio_mutex );
211 SDL_QuitSubSystem( SDL_INIT_AUDIO );
217 int consumer_is_stopped( mlt_consumer parent )
219 consumer_sdl self = parent->child;
220 return !self->running;
223 static void sdl_fill_audio( void *udata, uint8_t *stream, int len )
225 consumer_sdl self = udata;
228 double volume = mlt_properties_get_double( self->properties, "volume" );
230 pthread_mutex_lock( &self->audio_mutex );
232 // Block until audio received
234 while ( self->running && len > self->audio_avail )
235 pthread_cond_wait( &self->audio_cond, &self->audio_mutex );
238 if ( self->audio_avail >= len )
240 // Place in the audio buffer
242 SDL_MixAudio( stream, self->audio_buffer, len, ( int )( ( float )SDL_MIX_MAXVOLUME * volume ) );
244 memcpy( stream, self->audio_buffer, len );
246 // Remove len from the audio available
247 self->audio_avail -= len;
249 // Remove the samples
250 memmove( self->audio_buffer, self->audio_buffer + len, self->audio_avail );
254 // Just to be safe, wipe the stream first
255 memset( stream, 0, len );
258 SDL_MixAudio( stream, self->audio_buffer, self->audio_avail,
259 ( int )( ( float )SDL_MIX_MAXVOLUME * volume ) );
262 self->audio_avail = 0;
265 // We're definitely playing now
268 pthread_cond_broadcast( &self->audio_cond );
269 pthread_mutex_unlock( &self->audio_mutex );
272 static int consumer_play_audio( consumer_sdl self, mlt_frame frame, int init_audio, int *duration )
274 // Get the properties of this consumer
275 mlt_properties properties = self->properties;
276 mlt_audio_format afmt = mlt_audio_s16;
278 // Set the preferred params of the test card signal
279 int channels = mlt_properties_get_int( properties, "channels" );
280 int frequency = mlt_properties_get_int( properties, "frequency" );
281 int scrub = mlt_properties_get_int( properties, "scrub_audio" );
282 static int counter = 0;
284 int samples = mlt_sample_calculator( mlt_properties_get_double( self->properties, "fps" ), frequency, counter++ );
289 mlt_frame_get_audio( frame, (void**) &pcm, &afmt, &frequency, &channels, &samples );
290 *duration = ( ( samples * 1000 ) / frequency );
292 if ( mlt_properties_get_int( properties, "audio_off" ) )
299 if ( init_audio == 1 )
301 SDL_AudioSpec request;
304 int audio_buffer = mlt_properties_get_int( properties, "audio_buffer" );
306 // specify audio format
307 memset( &request, 0, sizeof( SDL_AudioSpec ) );
309 request.freq = frequency;
310 request.format = AUDIO_S16SYS;
311 request.channels = channels;
312 request.samples = audio_buffer;
313 request.callback = sdl_fill_audio;
314 request.userdata = (void *)self;
315 if ( SDL_OpenAudio( &request, &got ) != 0 )
317 mlt_log_error( MLT_CONSUMER_SERVICE( self ), "SDL failed to open audio: %s\n", SDL_GetError() );
320 else if ( got.size != 0 )
327 if ( init_audio == 0 )
329 mlt_properties properties = MLT_FRAME_PROPERTIES( frame );
330 bytes = ( samples * channels * 2 );
331 pthread_mutex_lock( &self->audio_mutex );
332 while ( self->running && bytes > ( sizeof( self->audio_buffer) - self->audio_avail ) )
333 pthread_cond_wait( &self->audio_cond, &self->audio_mutex );
336 if ( scrub || mlt_properties_get_double( properties, "_speed" ) == 1 )
337 memcpy( &self->audio_buffer[ self->audio_avail ], pcm, bytes );
339 memset( &self->audio_buffer[ self->audio_avail ], 0, bytes );
340 self->audio_avail += bytes;
342 pthread_cond_broadcast( &self->audio_cond );
343 pthread_mutex_unlock( &self->audio_mutex );
353 static int consumer_play_video( consumer_sdl self, mlt_frame frame )
355 // Get the properties of this consumer
356 mlt_properties properties = self->properties;
357 if ( self->running && !mlt_consumer_is_stopped( &self->parent ) )
358 mlt_events_fire( properties, "consumer-frame-show", frame, NULL );
363 static void *video_thread( void *arg )
366 consumer_sdl self = arg;
368 // Obtain time of thread start
373 mlt_frame next = NULL;
374 mlt_properties properties = NULL;
377 // Get real time flag
378 int real_time = mlt_properties_get_int( self->properties, "real_time" );
380 // Get the current time
381 gettimeofday( &now, NULL );
383 // Determine start time
384 start = ( int64_t )now.tv_sec * 1000000 + now.tv_usec;
386 while ( self->running )
388 // Pop the next frame
389 pthread_mutex_lock( &self->video_mutex );
390 next = mlt_deque_pop_front( self->queue );
391 while ( next == NULL && self->running )
393 pthread_cond_wait( &self->video_cond, &self->video_mutex );
394 next = mlt_deque_pop_front( self->queue );
396 pthread_mutex_unlock( &self->video_mutex );
398 if ( !self->running || next == NULL ) break;
400 // Get the properties
401 properties = MLT_FRAME_PROPERTIES( next );
403 // Get the speed of the frame
404 speed = mlt_properties_get_double( properties, "_speed" );
406 // Get the current time
407 gettimeofday( &now, NULL );
409 // Get the elapsed time
410 elapsed = ( ( int64_t )now.tv_sec * 1000000 + now.tv_usec ) - start;
412 // See if we have to delay the display of the current frame
413 if ( mlt_properties_get_int( properties, "rendered" ) == 1 && self->running )
415 // Obtain the scheduled playout time
416 int64_t scheduled = mlt_properties_get_int( properties, "playtime" );
418 // Determine the difference between the elapsed time and the scheduled playout time
419 int64_t difference = scheduled - elapsed;
421 // Smooth playback a bit
422 if ( real_time && ( difference > 20000 && speed == 1.0 ) )
424 tm.tv_sec = difference / 1000000;
425 tm.tv_nsec = ( difference % 1000000 ) * 500;
426 nanosleep( &tm, NULL );
429 // Show current frame if not too old
430 if ( !real_time || ( difference > -10000 || speed != 1.0 || mlt_deque_count( self->queue ) < 2 ) )
431 consumer_play_video( self, next );
433 // If the queue is empty, recalculate start to allow build up again
434 if ( real_time && ( mlt_deque_count( self->queue ) == 0 && speed == 1.0 ) )
436 gettimeofday( &now, NULL );
437 start = ( ( int64_t )now.tv_sec * 1000000 + now.tv_usec ) - scheduled + 20000;
441 // This frame can now be closed
442 mlt_frame_close( next );
447 mlt_frame_close( next );
449 mlt_consumer_stopped( &self->parent );
454 /** Threaded wrapper for pipe.
457 static void *consumer_thread( void *arg )
460 consumer_sdl self = arg;
463 mlt_consumer consumer = &self->parent;
465 // Get the properties
466 mlt_properties consumer_props = MLT_CONSUMER_PROPERTIES( consumer );
471 // internal intialization
474 mlt_frame frame = NULL;
475 mlt_properties properties = NULL;
477 int64_t playtime = 0;
478 struct timespec tm = { 0, 100000 };
479 // int last_position = -1;
481 pthread_mutex_lock( &self->refresh_mutex );
482 self->refresh_count = 0;
483 pthread_mutex_unlock( &self->refresh_mutex );
485 // Loop until told not to
486 while( self->running )
488 // Get a frame from the attached producer
489 frame = mlt_consumer_rt_frame( consumer );
491 // Ensure that we have a frame
494 // Get the frame properties
495 properties = MLT_FRAME_PROPERTIES( frame );
497 // Get the speed of the frame
498 double speed = mlt_properties_get_double( properties, "_speed" );
500 // Get refresh request for the current frame
501 int refresh = mlt_properties_get_int( consumer_props, "refresh" );
504 mlt_events_block( consumer_props, consumer_props );
505 mlt_properties_set_int( consumer_props, "refresh", 0 );
506 mlt_events_unblock( consumer_props, consumer_props );
509 init_audio = consumer_play_audio( self, frame, init_audio, &duration );
511 // Determine the start time now
512 if ( self->playing && init_video )
514 // Create the video thread
515 pthread_create( &thread, NULL, video_thread, self );
517 // Video doesn't need to be initialised any more
521 // Set playtime for this frame
522 mlt_properties_set_int( properties, "playtime", playtime );
524 while ( self->running && speed != 0 && mlt_deque_count( self->queue ) > 15 )
525 nanosleep( &tm, NULL );
527 // Push this frame to the back of the queue
528 if ( self->running && speed )
530 pthread_mutex_lock( &self->video_mutex );
531 mlt_deque_push_back( self->queue, frame );
532 pthread_cond_broadcast( &self->video_cond );
533 pthread_mutex_unlock( &self->video_mutex );
535 // Calculate the next playtime
536 playtime += ( duration * 1000 );
538 else if ( self->running )
540 pthread_mutex_lock( &self->refresh_mutex );
541 if ( ( refresh == 0 && self->refresh_count <= 0 ) || self->refresh_count > 1 )
543 consumer_play_video( self, frame );
544 pthread_cond_wait( &self->refresh_cond, &self->refresh_mutex );
546 mlt_frame_close( frame );
547 self->refresh_count --;
548 pthread_mutex_unlock( &self->refresh_mutex );
552 mlt_frame_close( frame );
556 // Optimisation to reduce latency
557 if ( frame && speed == 1.0 )
559 // TODO: disabled due to misbehavior on parallel-consumer
560 // if ( last_position != -1 && last_position + 1 != mlt_frame_get_position( frame ) )
561 // mlt_consumer_purge( consumer );
562 // last_position = mlt_frame_get_position( frame );
566 mlt_consumer_purge( consumer );
567 // last_position = -1;
572 // Kill the video thread
573 if ( init_video == 0 )
575 pthread_mutex_lock( &self->video_mutex );
576 pthread_cond_broadcast( &self->video_cond );
577 pthread_mutex_unlock( &self->video_mutex );
578 pthread_join( thread, NULL );
581 while( mlt_deque_count( self->queue ) )
582 mlt_frame_close( mlt_deque_pop_back( self->queue ) );
584 self->audio_avail = 0;
589 /** Callback to allow override of the close method.
592 static void consumer_close( mlt_consumer parent )
594 // Get the actual object
595 consumer_sdl self = parent->child;
598 mlt_consumer_stop( parent );
600 // Now clean up the rest
601 mlt_consumer_close( parent );
604 mlt_deque_close( self->queue );
607 pthread_mutex_destroy( &self->audio_mutex );
608 pthread_cond_destroy( &self->audio_cond );
609 pthread_mutex_destroy( &self->video_mutex );
610 pthread_cond_destroy( &self->video_cond );
611 pthread_mutex_destroy( &self->refresh_mutex );
612 pthread_cond_destroy( &self->refresh_cond );
614 // Finally clean up this