2 * consumer_sdl.c -- A Simple DirectMedia Layer consumer
3 * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
4 * Author: Dan Dennedy <dan@dennedy.org>
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.
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.
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.
21 #include "consumer_sdl.h"
22 #include <framework/mlt_frame.h>
23 #include <framework/mlt_deque.h>
29 #include <SDL/SDL_syswm.h>
33 # include "consumer_sdl_osx_hack.h"
34 # import <AppKit/NSApplication.h>
35 # import <Foundation/Foundation.h>
39 /** This classes definition.
42 typedef struct consumer_sdl_s *consumer_sdl;
46 struct mlt_consumer_s parent;
47 mlt_properties properties;
52 uint8_t audio_buffer[ 4096 * 10 ];
54 pthread_mutex_t audio_mutex;
55 pthread_cond_t audio_cond;
56 pthread_mutex_t video_mutex;
57 pthread_cond_t video_cond;
66 SDL_Surface *sdl_screen;
67 SDL_Overlay *sdl_overlay;
73 /** Forward references to static functions.
76 static int consumer_start( mlt_consumer parent );
77 static int consumer_stop( mlt_consumer parent );
78 static int consumer_is_stopped( mlt_consumer parent );
79 static void consumer_close( mlt_consumer parent );
80 static void *consumer_thread( void * );
81 static int consumer_get_dimensions( int *width, int *height );
82 static void consumer_sdl_event( mlt_listener listener, mlt_properties owner, mlt_service this, void **args );
84 /** This is what will be called by the factory - anything can be passed in
85 via the argument, but keep it simple.
88 mlt_consumer consumer_sdl_init( char *arg )
93 [NSApplication sharedApplication];
95 // Spawn a fake thread so that cocoa knows to be multithreaded
96 DummyThread *dummy = [[DummyThread alloc] init];
97 [NSThread detachNewThreadSelector:@selector(startThread:) toTarget:dummy withObject:nil];
100 // Create the consumer object
101 consumer_sdl this = calloc( sizeof( struct consumer_sdl_s ), 1 );
103 // If no malloc'd and consumer init ok
104 if ( this != NULL && mlt_consumer_init( &this->parent, this ) == 0 )
107 this->queue = mlt_deque_init( );
109 // Get the parent consumer object
110 mlt_consumer parent = &this->parent;
112 // We have stuff to clean up, so override the close method
113 parent->close = consumer_close;
115 // get a handle on properties
116 mlt_service service = MLT_CONSUMER_SERVICE( parent );
117 this->properties = MLT_SERVICE_PROPERTIES( service );
119 // Default display aspect ratio
120 double display_ratio = mlt_properties_get_double( this->properties, "display_ratio" );
122 // Set the default volume
123 mlt_properties_set_double( this->properties, "volume", 1.0 );
125 // This is the initialisation of the consumer
126 pthread_mutex_init( &this->audio_mutex, NULL );
127 pthread_cond_init( &this->audio_cond, NULL);
128 pthread_mutex_init( &this->video_mutex, NULL );
129 pthread_cond_init( &this->video_cond, NULL);
131 // Default scaler (for now we'll use nearest)
132 mlt_properties_set( this->properties, "rescale", "nearest" );
134 // Default buffer for low latency
135 mlt_properties_set_int( this->properties, "buffer", 1 );
137 // Default progressive true
138 mlt_properties_set_int( this->properties, "progressive", 0 );
140 // Default audio buffer
141 mlt_properties_set_int( this->properties, "audio_buffer", 512 );
143 // Ensure we don't join on a non-running object
146 // process actual param
147 if ( arg == NULL || sscanf( arg, "%dx%d", &this->width, &this->height ) != 2 )
149 this->width = mlt_properties_get_int( this->properties, "width" );
150 this->height = mlt_properties_get_int( this->properties, "height" );
153 // Default window size
154 this->window_width = ( double )this->height * display_ratio;
155 this->window_height = this->height;
158 this->sdl_flags = SDL_HWSURFACE | SDL_ASYNCBLIT | SDL_HWACCEL | SDL_RESIZABLE | SDL_DOUBLEBUF;
160 // Allow thread to be started/stopped
161 parent->start = consumer_start;
162 parent->stop = consumer_stop;
163 parent->is_stopped = consumer_is_stopped;
165 // Register specific events
166 mlt_events_register( this->properties, "consumer-sdl-event", ( mlt_transmitter )consumer_sdl_event );
168 // Return the consumer produced
172 // malloc or consumer init failed
179 static void consumer_sdl_event( mlt_listener listener, mlt_properties owner, mlt_service this, void **args )
181 if ( listener != NULL )
182 listener( owner, this, ( SDL_Event * )args[ 0 ] );
185 int consumer_start( mlt_consumer parent )
187 consumer_sdl this = parent->child;
189 if ( !this->running )
191 consumer_stop( parent );
196 // Allow the user to force resizing to window size
197 if ( mlt_properties_get_int( this->properties, "resize" ) )
199 mlt_properties_set_int( this->properties, "width", this->width );
200 mlt_properties_set_int( this->properties, "height", this->height );
204 this->width = mlt_properties_get_int( this->properties, "width" );
205 this->height = mlt_properties_get_int( this->properties, "height" );
208 pthread_create( &this->thread, NULL, consumer_thread, this );
214 int consumer_stop( mlt_consumer parent )
216 // Get the actual object
217 consumer_sdl this = parent->child;
219 if ( this->joined == 0 )
221 // Kill the thread and clean up
224 pthread_join( this->thread, NULL );
230 int consumer_is_stopped( mlt_consumer parent )
232 consumer_sdl this = parent->child;
233 return !this->running;
236 static int sdl_lock_display( )
238 SDL_Surface *screen = SDL_GetVideoSurface( );
239 return screen != NULL && ( !SDL_MUSTLOCK( screen ) || SDL_LockSurface( screen ) >= 0 );
242 static void sdl_unlock_display( )
244 SDL_Surface *screen = SDL_GetVideoSurface( );
245 if ( screen != NULL && SDL_MUSTLOCK( screen ) )
246 SDL_UnlockSurface( screen );
249 static void sdl_fill_audio( void *udata, uint8_t *stream, int len )
251 consumer_sdl this = udata;
254 double volume = mlt_properties_get_double( this->properties, "volume" );
256 pthread_mutex_lock( &this->audio_mutex );
258 // Block until audio received
259 while ( this->running && len > this->audio_avail )
260 pthread_cond_wait( &this->audio_cond, &this->audio_mutex );
262 if ( this->audio_avail >= len )
264 // Place in the audio buffer
265 memcpy( stream, this->audio_buffer, len );
267 // Remove len from the audio available
268 this->audio_avail -= len;
270 // Remove the samples
271 memmove( this->audio_buffer, this->audio_buffer + len, this->audio_avail );
275 // Just to be safe, wipe the stream first
276 memset( stream, 0, len );
278 // Copy what we have into the stream
279 memcpy( stream, this->audio_buffer, this->audio_avail );
282 SDL_MixAudio( stream, stream, len, ( int )( ( double )SDL_MIX_MAXVOLUME * volume ) );
285 this->audio_avail = 0;
288 // We're definitely playing now
291 pthread_cond_broadcast( &this->audio_cond );
292 pthread_mutex_unlock( &this->audio_mutex );
295 static int consumer_play_audio( consumer_sdl this, mlt_frame frame, int init_audio, int *duration )
297 // Get the properties of this consumer
298 mlt_properties properties = this->properties;
299 mlt_audio_format afmt = mlt_audio_pcm;
301 // Set the preferred params of the test card signal
302 int channels = mlt_properties_get_int( properties, "channels" );
303 int frequency = mlt_properties_get_int( properties, "frequency" );
304 static int counter = 0;
306 int samples = mlt_sample_calculator( mlt_properties_get_double( this->properties, "fps" ), frequency, counter++ );
311 mlt_frame_get_audio( frame, &pcm, &afmt, &frequency, &channels, &samples );
312 *duration = ( ( samples * 1000 ) / frequency );
314 if ( mlt_properties_get_int( properties, "audio_off" ) )
321 if ( init_audio == 1 )
323 SDL_AudioSpec request;
326 int audio_buffer = mlt_properties_get_int( properties, "audio_buffer" );
328 // specify audio format
329 memset( &request, 0, sizeof( SDL_AudioSpec ) );
331 request.freq = frequency;
332 request.format = AUDIO_S16;
333 request.channels = channels;
334 request.samples = audio_buffer;
335 request.callback = sdl_fill_audio;
336 request.userdata = (void *)this;
337 if ( SDL_OpenAudio( &request, &got ) != 0 )
339 fprintf( stderr, "SDL failed to open audio: %s\n", SDL_GetError() );
342 else if ( got.size != 0 )
349 if ( init_audio == 0 )
351 mlt_properties properties = MLT_FRAME_PROPERTIES( frame );
352 bytes = ( samples * channels * 2 );
353 pthread_mutex_lock( &this->audio_mutex );
354 while ( this->running && bytes > ( sizeof( this->audio_buffer) - this->audio_avail ) )
355 pthread_cond_wait( &this->audio_cond, &this->audio_mutex );
358 if ( mlt_properties_get_double( properties, "_speed" ) == 1 )
359 memcpy( &this->audio_buffer[ this->audio_avail ], pcm, bytes );
361 memset( &this->audio_buffer[ this->audio_avail ], 0, bytes );
362 this->audio_avail += bytes;
364 pthread_cond_broadcast( &this->audio_cond );
365 pthread_mutex_unlock( &this->audio_mutex );
375 static int consumer_play_video( consumer_sdl this, mlt_frame frame )
377 // Get the properties of this consumer
378 mlt_properties properties = this->properties;
380 mlt_image_format vfmt = mlt_image_yuv422;
381 int width = this->width, height = this->height;
385 if ( this->running && mlt_properties_get_int( properties, "video_off" ) == 0 )
387 // Get the image, width and height
388 mlt_events_fire( properties, "consumer-frame-show", frame, NULL );
389 mlt_frame_get_image( frame, &image, &vfmt, &width, &height, 0 );
392 if ( this->sdl_screen != NULL )
396 changed = consumer_get_dimensions( &this->window_width, &this->window_height );
398 while ( SDL_PollEvent( &event ) )
400 mlt_events_fire( this->properties, "consumer-sdl-event", &event, NULL );
404 case SDL_VIDEORESIZE:
405 this->window_width = event.resize.w;
406 this->window_height = event.resize.h;
414 mlt_producer producer = mlt_properties_get_data( properties, "transport_producer", NULL );
415 char keyboard[ 2 ] = " ";
416 void (*callback)( mlt_producer, char * ) = mlt_properties_get_data( properties, "transport_callback", NULL );
417 if ( callback != NULL && producer != NULL && event.key.keysym.unicode < 0x80 && event.key.keysym.unicode > 0 )
419 keyboard[ 0 ] = ( char )event.key.keysym.unicode;
420 callback( producer, keyboard );
428 if ( width != this->width || height != this->height )
430 if ( this->sdl_overlay != NULL )
431 SDL_FreeYUVOverlay( this->sdl_overlay );
432 this->sdl_overlay = NULL;
435 if ( this->running && ( this->sdl_screen == NULL || changed ) )
437 // Force an overlay recreation
438 if ( this->sdl_overlay != NULL )
439 SDL_FreeYUVOverlay( this->sdl_overlay );
440 this->sdl_overlay = NULL;
442 // open SDL window with video overlay, if possible
444 this->sdl_screen = SDL_SetVideoMode( this->window_width, this->window_height, this->bpp, this->sdl_flags );
445 sdl_unlock_display();
446 if ( consumer_get_dimensions( &this->window_width, &this->window_height ) )
447 this->sdl_screen = SDL_SetVideoMode( this->window_width, this->window_height, this->bpp, this->sdl_flags );
448 //SDL_Flip( this->sdl_screen );
449 mlt_properties_set_int( properties, "changed", 0 );
451 else if ( mlt_properties_get_int( properties, "changed" ) )
454 this->sdl_screen = SDL_SetVideoMode( this->window_width, this->window_height, this->bpp, this->sdl_flags );
455 SDL_SetClipRect( this->sdl_screen, &this->rect );
456 sdl_unlock_display();
457 mlt_properties_set_int( properties, "changed", 0 );
462 // Determine window's new display aspect ratio
463 double this_aspect = ( double )this->window_width / this->window_height;
465 // Get the display aspect ratio
466 double display_ratio = mlt_properties_get_double( properties, "display_ratio" );
468 // Determine frame's display aspect ratio
469 double frame_aspect = mlt_frame_get_aspect_ratio( frame ) * width / height;
471 // Store the width and height received
473 this->height = height;
475 // If using hardware scaler
476 if ( mlt_properties_get( properties, "rescale" ) != NULL &&
477 !strcmp( mlt_properties_get( properties, "rescale" ), "none" ) )
479 // Use hardware scaler to normalise display aspect ratio
480 this->rect.w = frame_aspect / this_aspect * this->window_width;
481 this->rect.h = this->window_height;
482 if ( this->rect.w > this->window_width )
484 this->rect.w = this->window_width;
485 this->rect.h = this_aspect / frame_aspect * this->window_height;
488 // Special case optimisation to negate odd effect of sample aspect ratio
489 // not corresponding exactly with image resolution.
490 else if ( (int)( this_aspect * 1000 ) == (int)( display_ratio * 1000 ) )
492 this->rect.w = this->window_width;
493 this->rect.h = this->window_height;
495 // Use hardware scaler to normalise sample aspect ratio
496 else if ( this->window_height * display_ratio > this->window_width )
498 this->rect.w = this->window_width;
499 this->rect.h = this->window_width / display_ratio;
503 this->rect.w = this->window_height * display_ratio;
504 this->rect.h = this->window_height;
507 this->rect.x = ( this->window_width - this->rect.w ) / 2;
508 this->rect.y = ( this->window_height - this->rect.h ) / 2;
510 mlt_properties_set_int( this->properties, "rect_x", this->rect.x );
511 mlt_properties_set_int( this->properties, "rect_y", this->rect.y );
512 mlt_properties_set_int( this->properties, "rect_w", this->rect.w );
513 mlt_properties_set_int( this->properties, "rect_h", this->rect.h );
515 SDL_SetClipRect( this->sdl_screen, &this->rect );
518 if ( this->running && this->sdl_screen != NULL && this->sdl_overlay == NULL )
520 SDL_SetClipRect( this->sdl_screen, &this->rect );
521 SDL_Flip( this->sdl_screen );
523 this->sdl_overlay = SDL_CreateYUVOverlay( width, height, SDL_YUY2_OVERLAY, this->sdl_screen );
524 sdl_unlock_display();
527 if ( this->running && this->sdl_screen != NULL && this->sdl_overlay != NULL )
529 this->buffer = this->sdl_overlay->pixels[ 0 ];
531 if ( SDL_LockYUVOverlay( this->sdl_overlay ) >= 0 )
534 memcpy( this->buffer, image, width * height * 2 );
535 SDL_UnlockYUVOverlay( this->sdl_overlay );
536 SDL_DisplayYUVOverlay( this->sdl_overlay, &this->sdl_screen->clip_rect );
538 sdl_unlock_display();
545 static void *video_thread( void *arg )
548 consumer_sdl this = arg;
551 NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
554 // Obtain time of thread start
559 mlt_frame next = NULL;
560 mlt_properties properties = NULL;
563 // Get real time flag
564 int real_time = mlt_properties_get_int( this->properties, "real_time" );
566 // Get the current time
567 gettimeofday( &now, NULL );
569 // Determine start time
570 start = ( int64_t )now.tv_sec * 1000000 + now.tv_usec;
572 while ( this->running )
574 // Pop the next frame
575 pthread_mutex_lock( &this->video_mutex );
576 next = mlt_deque_pop_front( this->queue );
577 while ( next == NULL && this->running )
579 pthread_cond_wait( &this->video_cond, &this->video_mutex );
580 next = mlt_deque_pop_front( this->queue );
582 pthread_mutex_unlock( &this->video_mutex );
584 if ( !this->running || next == NULL ) break;
586 // Get the properties
587 properties = MLT_FRAME_PROPERTIES( next );
589 // Get the speed of the frame
590 speed = mlt_properties_get_double( properties, "_speed" );
592 // Get the current time
593 gettimeofday( &now, NULL );
595 // Get the elapsed time
596 elapsed = ( ( int64_t )now.tv_sec * 1000000 + now.tv_usec ) - start;
598 // See if we have to delay the display of the current frame
599 if ( mlt_properties_get_int( properties, "rendered" ) == 1 && this->running )
601 // Obtain the scheduled playout time
602 mlt_position scheduled = mlt_properties_get_position( properties, "playtime" );
604 // Determine the difference between the elapsed time and the scheduled playout time
605 mlt_position difference = scheduled - elapsed;
607 // Smooth playback a bit
608 if ( real_time && ( difference > 20000 && speed == 1.0 ) )
610 tm.tv_sec = difference / 1000000;
611 tm.tv_nsec = ( difference % 1000000 ) * 500;
612 nanosleep( &tm, NULL );
615 // Show current frame if not too old
616 if ( !real_time || ( difference > -10000 || speed != 1.0 || mlt_deque_count( this->queue ) < 2 ) )
617 consumer_play_video( this, next );
619 // If the queue is empty, recalculate start to allow build up again
620 if ( real_time && ( mlt_deque_count( this->queue ) == 0 && speed == 1.0 ) )
622 gettimeofday( &now, NULL );
623 start = ( ( int64_t )now.tv_sec * 1000000 + now.tv_usec ) - scheduled + 20000;
627 // This frame can now be closed
628 mlt_frame_close( next );
633 mlt_frame_close( next );
635 mlt_consumer_stopped( &this->parent );
644 /** Threaded wrapper for pipe.
647 static void *consumer_thread( void *arg )
650 consumer_sdl this = arg;
653 NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
657 mlt_consumer consumer = &this->parent;
662 // internal intialization
665 mlt_frame frame = NULL;
666 mlt_properties properties = NULL;
668 int64_t playtime = 0;
669 struct timespec tm = { 0, 100000 };
671 this->bpp = mlt_properties_get_int( this->properties, "bpp" );
673 if ( mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( consumer ), "sdl_started" ) == 0 )
675 if ( SDL_Init( SDL_INIT_VIDEO | SDL_INIT_NOPARACHUTE ) < 0 )
677 fprintf( stderr, "Failed to initialize SDL: %s\n", SDL_GetError() );
681 SDL_EnableKeyRepeat( SDL_DEFAULT_REPEAT_DELAY, SDL_DEFAULT_REPEAT_INTERVAL );
682 SDL_EnableUNICODE( 1 );
686 if ( SDL_GetVideoSurface( ) != NULL )
688 this->sdl_screen = SDL_GetVideoSurface( );
689 consumer_get_dimensions( &this->window_width, &this->window_height );
690 mlt_properties_set_int( this->properties, "changed", 0 );
694 if ( !mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( consumer ), "audio_off" ) )
695 SDL_InitSubSystem( SDL_INIT_AUDIO );
697 // Loop until told not to
698 while( this->running )
700 // Get a frame from the attached producer
701 frame = mlt_consumer_rt_frame( consumer );
703 // Ensure that we have a frame
706 // Get the frame properties
707 properties = MLT_FRAME_PROPERTIES( frame );
710 init_audio = consumer_play_audio( this, frame, init_audio, &duration );
712 // Determine the start time now
713 if ( this->playing && init_video )
715 // Create the video thread
716 pthread_create( &thread, NULL, video_thread, this );
718 // Video doesn't need to be initialised any more
722 // Set playtime for this frame
723 mlt_properties_set_position( properties, "playtime", playtime );
725 while ( this->running && mlt_deque_count( this->queue ) > 15 )
726 nanosleep( &tm, NULL );
728 // Push this frame to the back of the queue
729 pthread_mutex_lock( &this->video_mutex );
730 mlt_deque_push_back( this->queue, frame );
731 pthread_cond_broadcast( &this->video_cond );
732 pthread_mutex_unlock( &this->video_mutex );
734 // Calculate the next playtime
735 playtime += ( duration * 1000 );
739 // Kill the video thread
740 if ( init_video == 0 )
742 pthread_mutex_lock( &this->video_mutex );
743 pthread_cond_broadcast( &this->video_cond );
744 pthread_mutex_unlock( &this->video_mutex );
745 pthread_join( thread, NULL );
749 if ( this->sdl_overlay != NULL )
750 SDL_FreeYUVOverlay( this->sdl_overlay );
752 if ( !mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( consumer ), "audio_off" ) )
753 SDL_QuitSubSystem( SDL_INIT_AUDIO );
755 //if ( mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( consumer ), "sdl_started" ) == 0 )
758 while( mlt_deque_count( this->queue ) )
759 mlt_frame_close( mlt_deque_pop_back( this->queue ) );
761 this->sdl_screen = NULL;
762 this->sdl_overlay = NULL;
763 this->audio_avail = 0;
772 static int consumer_get_dimensions( int *width, int *height )
776 // SDL windows manager structure
779 // Specify the SDL Version
780 SDL_VERSION( &wm.version );
786 // Get the wm structure
787 if ( SDL_GetWMInfo( &wm ) == 1 )
789 // Check that we have the X11 wm
790 if ( wm.subsystem == SDL_SYSWM_X11 )
792 // Get the SDL window
793 Window window = wm.info.x11.window;
795 // Get the display session
796 Display *display = wm.info.x11.display;
798 // Get the window attributes
799 XWindowAttributes attr;
800 XGetWindowAttributes( display, window, &attr );
802 // Determine whether window has changed
803 changed = *width != attr.width || *height != attr.height;
805 // Return width and height
807 *height = attr.height;
812 // Unlock the display
818 /** Callback to allow override of the close method.
821 static void consumer_close( mlt_consumer parent )
823 // Get the actual object
824 consumer_sdl this = parent->child;
827 ///mlt_consumer_stop( parent );
829 // Now clean up the rest
830 mlt_consumer_close( parent );
833 mlt_deque_close( this->queue );
836 pthread_mutex_destroy( &this->audio_mutex );
837 pthread_cond_destroy( &this->audio_cond );
839 // Finally clean up this