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 this->width = mlt_properties_get_int( this->properties, "width" );
197 this->height = mlt_properties_get_int( this->properties, "height" );
199 pthread_create( &this->thread, NULL, consumer_thread, this );
205 int consumer_stop( mlt_consumer parent )
207 // Get the actual object
208 consumer_sdl this = parent->child;
210 if ( this->joined == 0 )
212 // Kill the thread and clean up
215 pthread_join( this->thread, NULL );
221 int consumer_is_stopped( mlt_consumer parent )
223 consumer_sdl this = parent->child;
224 return !this->running;
227 static int sdl_lock_display( )
229 SDL_Surface *screen = SDL_GetVideoSurface( );
230 return screen != NULL && ( !SDL_MUSTLOCK( screen ) || SDL_LockSurface( screen ) >= 0 );
233 static void sdl_unlock_display( )
235 SDL_Surface *screen = SDL_GetVideoSurface( );
236 if ( screen != NULL && SDL_MUSTLOCK( screen ) )
237 SDL_UnlockSurface( screen );
240 static void sdl_fill_audio( void *udata, uint8_t *stream, int len )
242 consumer_sdl this = udata;
245 double volume = mlt_properties_get_double( this->properties, "volume" );
247 pthread_mutex_lock( &this->audio_mutex );
249 // Block until audio received
250 while ( this->running && len > this->audio_avail )
251 pthread_cond_wait( &this->audio_cond, &this->audio_mutex );
253 if ( this->audio_avail >= len )
255 // Place in the audio buffer
257 SDL_MixAudio( stream, this->audio_buffer, len, ( int )( ( float )SDL_MIX_MAXVOLUME * volume ) );
259 memcpy( stream, this->audio_buffer, len );
261 // Remove len from the audio available
262 this->audio_avail -= len;
264 // Remove the samples
265 memmove( this->audio_buffer, this->audio_buffer + len, this->audio_avail );
269 // Just to be safe, wipe the stream first
270 memset( stream, 0, len );
272 // Copy what we have into the stream
273 memcpy( stream, this->audio_buffer, this->audio_avail );
276 SDL_MixAudio( stream, this->audio_buffer, len, ( int )( ( float )SDL_MIX_MAXVOLUME * volume ) );
279 this->audio_avail = 0;
282 // We're definitely playing now
285 pthread_cond_broadcast( &this->audio_cond );
286 pthread_mutex_unlock( &this->audio_mutex );
289 static int consumer_play_audio( consumer_sdl this, mlt_frame frame, int init_audio, int *duration )
291 // Get the properties of this consumer
292 mlt_properties properties = this->properties;
293 mlt_audio_format afmt = mlt_audio_pcm;
295 // Set the preferred params of the test card signal
296 int channels = mlt_properties_get_int( properties, "channels" );
297 int frequency = mlt_properties_get_int( properties, "frequency" );
298 static int counter = 0;
300 int samples = mlt_sample_calculator( mlt_properties_get_double( this->properties, "fps" ), frequency, counter++ );
305 mlt_frame_get_audio( frame, &pcm, &afmt, &frequency, &channels, &samples );
306 *duration = ( ( samples * 1000 ) / frequency );
308 if ( mlt_properties_get_int( properties, "audio_off" ) )
315 if ( init_audio == 1 )
317 SDL_AudioSpec request;
320 int audio_buffer = mlt_properties_get_int( properties, "audio_buffer" );
322 // specify audio format
323 memset( &request, 0, sizeof( SDL_AudioSpec ) );
325 request.freq = frequency;
326 request.format = AUDIO_S16;
327 request.channels = channels;
328 request.samples = audio_buffer;
329 request.callback = sdl_fill_audio;
330 request.userdata = (void *)this;
331 if ( SDL_OpenAudio( &request, &got ) != 0 )
333 fprintf( stderr, "SDL failed to open audio: %s\n", SDL_GetError() );
336 else if ( got.size != 0 )
343 if ( init_audio == 0 )
345 mlt_properties properties = MLT_FRAME_PROPERTIES( frame );
346 bytes = ( samples * channels * 2 );
347 pthread_mutex_lock( &this->audio_mutex );
348 while ( this->running && bytes > ( sizeof( this->audio_buffer) - this->audio_avail ) )
349 pthread_cond_wait( &this->audio_cond, &this->audio_mutex );
352 if ( mlt_properties_get_double( properties, "_speed" ) == 1 )
353 memcpy( &this->audio_buffer[ this->audio_avail ], pcm, bytes );
355 memset( &this->audio_buffer[ this->audio_avail ], 0, bytes );
356 this->audio_avail += bytes;
358 pthread_cond_broadcast( &this->audio_cond );
359 pthread_mutex_unlock( &this->audio_mutex );
369 static int consumer_play_video( consumer_sdl this, mlt_frame frame )
371 // Get the properties of this consumer
372 mlt_properties properties = this->properties;
374 mlt_image_format vfmt = mlt_image_yuv422;
375 int width = this->width, height = this->height;
379 if ( this->running && mlt_properties_get_int( properties, "video_off" ) == 0 )
381 // Get the image, width and height
382 mlt_events_fire( properties, "consumer-frame-show", frame, NULL );
383 mlt_frame_get_image( frame, &image, &vfmt, &width, &height, 0 );
386 if ( this->sdl_screen != NULL )
390 changed = consumer_get_dimensions( &this->window_width, &this->window_height );
392 while ( SDL_PollEvent( &event ) )
394 mlt_events_fire( this->properties, "consumer-sdl-event", &event, NULL );
398 case SDL_VIDEORESIZE:
399 this->window_width = event.resize.w;
400 this->window_height = event.resize.h;
408 mlt_producer producer = mlt_properties_get_data( properties, "transport_producer", NULL );
409 char keyboard[ 2 ] = " ";
410 void (*callback)( mlt_producer, char * ) = mlt_properties_get_data( properties, "transport_callback", NULL );
411 if ( callback != NULL && producer != NULL && event.key.keysym.unicode < 0x80 && event.key.keysym.unicode > 0 )
413 keyboard[ 0 ] = ( char )event.key.keysym.unicode;
414 callback( producer, keyboard );
422 if ( width != this->width || height != this->height )
424 if ( this->sdl_overlay != NULL )
425 SDL_FreeYUVOverlay( this->sdl_overlay );
426 this->sdl_overlay = NULL;
429 if ( this->running && ( this->sdl_screen == NULL || changed ) )
431 // Force an overlay recreation
432 if ( this->sdl_overlay != NULL )
433 SDL_FreeYUVOverlay( this->sdl_overlay );
434 this->sdl_overlay = NULL;
436 // open SDL window with video overlay, if possible
438 this->sdl_screen = SDL_SetVideoMode( this->window_width, this->window_height, this->bpp, this->sdl_flags );
439 sdl_unlock_display();
440 if ( consumer_get_dimensions( &this->window_width, &this->window_height ) )
441 this->sdl_screen = SDL_SetVideoMode( this->window_width, this->window_height, this->bpp, this->sdl_flags );
442 //SDL_Flip( this->sdl_screen );
443 mlt_properties_set_int( properties, "changed", 0 );
445 else if ( mlt_properties_get_int( properties, "changed" ) )
448 this->sdl_screen = SDL_SetVideoMode( this->window_width, this->window_height, this->bpp, this->sdl_flags );
449 SDL_SetClipRect( this->sdl_screen, &this->rect );
450 sdl_unlock_display();
451 mlt_properties_set_int( properties, "changed", 0 );
456 // Determine window's new display aspect ratio
457 double this_aspect = ( double )this->window_width / this->window_height;
459 // Get the display aspect ratio
460 double display_ratio = mlt_properties_get_double( properties, "display_ratio" );
462 // Determine frame's display aspect ratio
463 double frame_aspect = mlt_frame_get_aspect_ratio( frame ) * width / height;
465 // Store the width and height received
467 this->height = height;
469 // If using hardware scaler
470 if ( mlt_properties_get( properties, "rescale" ) != NULL &&
471 !strcmp( mlt_properties_get( properties, "rescale" ), "none" ) )
473 // Use hardware scaler to normalise display aspect ratio
474 this->rect.w = frame_aspect / this_aspect * this->window_width;
475 this->rect.h = this->window_height;
476 if ( this->rect.w > this->window_width )
478 this->rect.w = this->window_width;
479 this->rect.h = this_aspect / frame_aspect * this->window_height;
482 // Special case optimisation to negate odd effect of sample aspect ratio
483 // not corresponding exactly with image resolution.
484 else if ( (int)( this_aspect * 1000 ) == (int)( display_ratio * 1000 ) )
486 this->rect.w = this->window_width;
487 this->rect.h = this->window_height;
489 // Use hardware scaler to normalise sample aspect ratio
490 else if ( this->window_height * display_ratio > this->window_width )
492 this->rect.w = this->window_width;
493 this->rect.h = this->window_width / display_ratio;
497 this->rect.w = this->window_height * display_ratio;
498 this->rect.h = this->window_height;
501 this->rect.x = ( this->window_width - this->rect.w ) / 2;
502 this->rect.y = ( this->window_height - this->rect.h ) / 2;
504 mlt_properties_set_int( this->properties, "rect_x", this->rect.x );
505 mlt_properties_set_int( this->properties, "rect_y", this->rect.y );
506 mlt_properties_set_int( this->properties, "rect_w", this->rect.w );
507 mlt_properties_set_int( this->properties, "rect_h", this->rect.h );
509 SDL_SetClipRect( this->sdl_screen, &this->rect );
512 if ( this->running && this->sdl_screen != NULL && this->sdl_overlay == NULL )
514 SDL_SetClipRect( this->sdl_screen, &this->rect );
515 SDL_Flip( this->sdl_screen );
517 this->sdl_overlay = SDL_CreateYUVOverlay( width, height, SDL_YUY2_OVERLAY, this->sdl_screen );
518 sdl_unlock_display();
521 if ( this->running && this->sdl_screen != NULL && this->sdl_overlay != NULL )
523 this->buffer = this->sdl_overlay->pixels[ 0 ];
525 if ( SDL_LockYUVOverlay( this->sdl_overlay ) >= 0 )
528 memcpy( this->buffer, image, width * height * 2 );
529 SDL_UnlockYUVOverlay( this->sdl_overlay );
530 SDL_DisplayYUVOverlay( this->sdl_overlay, &this->sdl_screen->clip_rect );
532 sdl_unlock_display();
539 static void *video_thread( void *arg )
542 consumer_sdl this = arg;
545 NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
548 // Obtain time of thread start
553 mlt_frame next = NULL;
554 mlt_properties properties = NULL;
557 // Get real time flag
558 int real_time = mlt_properties_get_int( this->properties, "real_time" );
560 // Get the current time
561 gettimeofday( &now, NULL );
563 // Determine start time
564 start = ( int64_t )now.tv_sec * 1000000 + now.tv_usec;
566 while ( this->running )
568 // Pop the next frame
569 pthread_mutex_lock( &this->video_mutex );
570 next = mlt_deque_pop_front( this->queue );
571 while ( next == NULL && this->running )
573 pthread_cond_wait( &this->video_cond, &this->video_mutex );
574 next = mlt_deque_pop_front( this->queue );
576 pthread_mutex_unlock( &this->video_mutex );
578 if ( !this->running || next == NULL ) break;
580 // Get the properties
581 properties = MLT_FRAME_PROPERTIES( next );
583 // Get the speed of the frame
584 speed = mlt_properties_get_double( properties, "_speed" );
586 // Get the current time
587 gettimeofday( &now, NULL );
589 // Get the elapsed time
590 elapsed = ( ( int64_t )now.tv_sec * 1000000 + now.tv_usec ) - start;
592 // See if we have to delay the display of the current frame
593 if ( mlt_properties_get_int( properties, "rendered" ) == 1 && this->running )
595 // Obtain the scheduled playout time
596 int64_t scheduled = mlt_properties_get_int( properties, "playtime" );
598 // Determine the difference between the elapsed time and the scheduled playout time
599 int64_t difference = scheduled - elapsed;
601 // Smooth playback a bit
602 if ( real_time && ( difference > 20000 && speed == 1.0 ) )
604 tm.tv_sec = difference / 1000000;
605 tm.tv_nsec = ( difference % 1000000 ) * 500;
606 nanosleep( &tm, NULL );
609 // Show current frame if not too old
610 if ( !real_time || ( difference > -10000 || speed != 1.0 || mlt_deque_count( this->queue ) < 2 ) )
611 consumer_play_video( this, next );
613 // If the queue is empty, recalculate start to allow build up again
614 if ( real_time && ( mlt_deque_count( this->queue ) == 0 && speed == 1.0 ) )
616 gettimeofday( &now, NULL );
617 start = ( ( int64_t )now.tv_sec * 1000000 + now.tv_usec ) - scheduled + 20000;
621 // This frame can now be closed
622 mlt_frame_close( next );
627 mlt_frame_close( next );
629 mlt_consumer_stopped( &this->parent );
638 /** Threaded wrapper for pipe.
641 static void *consumer_thread( void *arg )
644 consumer_sdl this = arg;
647 NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
651 mlt_consumer consumer = &this->parent;
656 // internal intialization
659 mlt_frame frame = NULL;
660 mlt_properties properties = NULL;
662 int64_t playtime = 0;
663 struct timespec tm = { 0, 100000 };
665 this->bpp = mlt_properties_get_int( this->properties, "bpp" );
667 if ( mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( consumer ), "sdl_started" ) == 0 )
669 if ( SDL_Init( SDL_INIT_VIDEO | SDL_INIT_NOPARACHUTE ) < 0 )
671 fprintf( stderr, "Failed to initialize SDL: %s\n", SDL_GetError() );
675 SDL_EnableKeyRepeat( SDL_DEFAULT_REPEAT_DELAY, SDL_DEFAULT_REPEAT_INTERVAL );
676 SDL_EnableUNICODE( 1 );
680 if ( SDL_GetVideoSurface( ) != NULL )
682 this->sdl_screen = SDL_GetVideoSurface( );
683 consumer_get_dimensions( &this->window_width, &this->window_height );
684 mlt_properties_set_int( this->properties, "changed", 0 );
688 if ( !mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( consumer ), "audio_off" ) )
689 SDL_InitSubSystem( SDL_INIT_AUDIO );
691 // Loop until told not to
692 while( this->running )
694 // Get a frame from the attached producer
695 frame = mlt_consumer_rt_frame( consumer );
697 // Ensure that we have a frame
700 // Get the frame properties
701 properties = MLT_FRAME_PROPERTIES( frame );
704 init_audio = consumer_play_audio( this, frame, init_audio, &duration );
706 // Determine the start time now
707 if ( this->playing && init_video )
709 // Create the video thread
710 pthread_create( &thread, NULL, video_thread, this );
712 // Video doesn't need to be initialised any more
716 // Set playtime for this frame
717 mlt_properties_set_int( properties, "playtime", playtime );
719 while ( this->running && mlt_deque_count( this->queue ) > 15 )
720 nanosleep( &tm, NULL );
722 // Push this frame to the back of the queue
723 pthread_mutex_lock( &this->video_mutex );
724 mlt_deque_push_back( this->queue, frame );
725 pthread_cond_broadcast( &this->video_cond );
726 pthread_mutex_unlock( &this->video_mutex );
728 // Calculate the next playtime
729 playtime += ( duration * 1000 );
733 // Kill the video thread
734 if ( init_video == 0 )
736 pthread_mutex_lock( &this->video_mutex );
737 pthread_cond_broadcast( &this->video_cond );
738 pthread_mutex_unlock( &this->video_mutex );
739 pthread_join( thread, NULL );
743 if ( this->sdl_overlay != NULL )
744 SDL_FreeYUVOverlay( this->sdl_overlay );
746 if ( !mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( consumer ), "audio_off" ) )
747 SDL_QuitSubSystem( SDL_INIT_AUDIO );
749 //if ( mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( consumer ), "sdl_started" ) == 0 )
752 while( mlt_deque_count( this->queue ) )
753 mlt_frame_close( mlt_deque_pop_back( this->queue ) );
755 this->sdl_screen = NULL;
756 this->sdl_overlay = NULL;
757 this->audio_avail = 0;
766 static int consumer_get_dimensions( int *width, int *height )
770 // SDL windows manager structure
773 // Specify the SDL Version
774 SDL_VERSION( &wm.version );
780 // Get the wm structure
781 if ( SDL_GetWMInfo( &wm ) == 1 )
783 // Check that we have the X11 wm
784 if ( wm.subsystem == SDL_SYSWM_X11 )
786 // Get the SDL window
787 Window window = wm.info.x11.window;
789 // Get the display session
790 Display *display = wm.info.x11.display;
792 // Get the window attributes
793 XWindowAttributes attr;
794 XGetWindowAttributes( display, window, &attr );
796 // Determine whether window has changed
797 changed = *width != attr.width || *height != attr.height;
799 // Return width and height
801 *height = attr.height;
806 // Unlock the display
812 /** Callback to allow override of the close method.
815 static void consumer_close( mlt_consumer parent )
817 // Get the actual object
818 consumer_sdl this = parent->child;
821 ///mlt_consumer_stop( parent );
823 // Now clean up the rest
824 mlt_consumer_close( parent );
827 mlt_deque_close( this->queue );
830 pthread_mutex_destroy( &this->audio_mutex );
831 pthread_cond_destroy( &this->audio_cond );
833 // Finally clean up this