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>
24 #include <framework/mlt_factory.h>
25 #include <framework/mlt_filter.h>
31 #include <SDL/SDL_syswm.h>
34 /** This classes definition.
37 typedef struct consumer_sdl_s *consumer_sdl;
41 struct mlt_consumer_s parent;
42 mlt_properties properties;
47 uint8_t audio_buffer[ 4096 * 10 ];
49 pthread_mutex_t audio_mutex;
50 pthread_cond_t audio_cond;
51 pthread_mutex_t video_mutex;
52 pthread_cond_t video_cond;
61 SDL_Surface *sdl_screen;
62 SDL_Overlay *sdl_overlay;
69 /** Forward references to static functions.
72 static int consumer_start( mlt_consumer parent );
73 static int consumer_stop( mlt_consumer parent );
74 static int consumer_is_stopped( mlt_consumer parent );
75 static void consumer_close( mlt_consumer parent );
76 static void *consumer_thread( void * );
77 static int consumer_get_dimensions( int *width, int *height );
78 static void consumer_sdl_event( mlt_listener listener, mlt_properties owner, mlt_service this, void **args );
80 /** This is what will be called by the factory - anything can be passed in
81 via the argument, but keep it simple.
84 mlt_consumer consumer_sdl_init( char *arg )
86 // Create the consumer object
87 consumer_sdl this = calloc( sizeof( struct consumer_sdl_s ), 1 );
89 // If no malloc'd and consumer init ok
90 if ( this != NULL && mlt_consumer_init( &this->parent, this ) == 0 )
93 this->queue = mlt_deque_init( );
95 // Get the parent consumer object
96 mlt_consumer parent = &this->parent;
98 // We have stuff to clean up, so override the close method
99 parent->close = consumer_close;
101 // get a handle on properties
102 mlt_service service = MLT_CONSUMER_SERVICE( parent );
103 this->properties = MLT_SERVICE_PROPERTIES( service );
105 // Default display aspect ratio
106 double display_ratio = mlt_properties_get_double( this->properties, "display_ratio" );
108 // Set the default volume
109 mlt_properties_set_double( this->properties, "volume", 1.0 );
111 // This is the initialisation of the consumer
112 pthread_mutex_init( &this->audio_mutex, NULL );
113 pthread_cond_init( &this->audio_cond, NULL);
114 pthread_mutex_init( &this->video_mutex, NULL );
115 pthread_cond_init( &this->video_cond, NULL);
117 // Default scaler (for now we'll use nearest)
118 mlt_properties_set( this->properties, "rescale", "nearest" );
120 // Default buffer for low latency
121 mlt_properties_set_int( this->properties, "buffer", 1 );
123 // Default progressive true
124 mlt_properties_set_int( this->properties, "progressive", 0 );
126 // Default audio buffer
127 mlt_properties_set_int( this->properties, "audio_buffer", 512 );
129 // Ensure we don't join on a non-running object
132 // process actual param
133 if ( arg == NULL || sscanf( arg, "%dx%d", &this->width, &this->height ) != 2 )
135 this->width = mlt_properties_get_int( this->properties, "width" );
136 this->height = mlt_properties_get_int( this->properties, "height" );
139 // Default window size
140 this->window_width = ( double )this->height * display_ratio;
141 this->window_height = this->height;
144 this->sdl_flags = SDL_HWSURFACE | SDL_ASYNCBLIT | SDL_HWACCEL | SDL_RESIZABLE | SDL_DOUBLEBUF;
146 // Allow thread to be started/stopped
147 parent->start = consumer_start;
148 parent->stop = consumer_stop;
149 parent->is_stopped = consumer_is_stopped;
151 // Register specific events
152 mlt_events_register( this->properties, "consumer-sdl-event", ( mlt_transmitter )consumer_sdl_event );
154 // Return the consumer produced
158 // malloc or consumer init failed
165 static void consumer_sdl_event( mlt_listener listener, mlt_properties owner, mlt_service this, void **args )
167 if ( listener != NULL )
168 listener( owner, this, ( SDL_Event * )args[ 0 ] );
171 int consumer_start( mlt_consumer parent )
173 consumer_sdl this = parent->child;
175 if ( !this->running )
177 int video_off = mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( parent ), "video_off" );
178 int preview_off = mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( parent ), "preview_off" );
179 int display_off = video_off | preview_off;
180 int audio_off = mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( parent ), "audio_off" );
181 int sdl_started = mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( parent ), "sdl_started" );
183 consumer_stop( parent );
188 this->width = mlt_properties_get_int( this->properties, "width" );
189 this->height = mlt_properties_get_int( this->properties, "height" );
191 this->bpp = mlt_properties_get_int( this->properties, "bpp" );
193 // Attach a colour space converter
194 if ( preview_off && !this->filtered )
196 mlt_filter filter = mlt_factory_filter( "avcolour_space", NULL );
197 mlt_properties_set_int( MLT_FILTER_PROPERTIES( filter ), "forced", mlt_image_yuv422 );
198 mlt_service_attach( MLT_CONSUMER_SERVICE( parent ), filter );
199 mlt_filter_close( filter );
203 if ( sdl_started == 0 && display_off == 0 )
205 if ( SDL_Init( SDL_INIT_VIDEO | SDL_INIT_NOPARACHUTE ) < 0 )
207 fprintf( stderr, "Failed to initialize SDL: %s\n", SDL_GetError() );
211 SDL_EnableKeyRepeat( SDL_DEFAULT_REPEAT_DELAY, SDL_DEFAULT_REPEAT_INTERVAL );
212 SDL_EnableUNICODE( 1 );
214 else if ( display_off == 0 )
216 this->sdl_screen = SDL_GetVideoSurface( );
219 if ( audio_off == 0 )
220 SDL_InitSubSystem( SDL_INIT_AUDIO );
222 if ( this->sdl_screen == NULL && display_off == 0 )
223 this->sdl_screen = SDL_SetVideoMode( this->window_width, this->window_height, 0, this->sdl_flags );
225 pthread_create( &this->thread, NULL, consumer_thread, this );
231 int consumer_stop( mlt_consumer parent )
233 // Get the actual object
234 consumer_sdl this = parent->child;
236 if ( this->joined == 0 )
238 // Kill the thread and clean up
241 pthread_join( this->thread, NULL );
244 if ( this->sdl_overlay != NULL )
245 SDL_FreeYUVOverlay( this->sdl_overlay );
246 this->sdl_overlay = NULL;
248 if ( !mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( parent ), "audio_off" ) )
250 pthread_mutex_lock( &this->audio_mutex );
251 pthread_cond_broadcast( &this->audio_cond );
252 pthread_mutex_unlock( &this->audio_mutex );
253 SDL_QuitSubSystem( SDL_INIT_AUDIO );
256 if ( mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( parent ), "sdl_started" ) == 0 )
259 this->sdl_screen = NULL;
265 int consumer_is_stopped( mlt_consumer parent )
267 consumer_sdl this = parent->child;
268 return !this->running;
271 static int sdl_lock_display( )
273 SDL_Surface *screen = SDL_GetVideoSurface( );
274 return screen != NULL && ( !SDL_MUSTLOCK( screen ) || SDL_LockSurface( screen ) >= 0 );
277 static void sdl_unlock_display( )
279 SDL_Surface *screen = SDL_GetVideoSurface( );
280 if ( screen != NULL && SDL_MUSTLOCK( screen ) )
281 SDL_UnlockSurface( screen );
284 static void sdl_fill_audio( void *udata, uint8_t *stream, int len )
286 consumer_sdl this = udata;
289 double volume = mlt_properties_get_double( this->properties, "volume" );
291 pthread_mutex_lock( &this->audio_mutex );
293 // Block until audio received
294 while ( this->running && len > this->audio_avail )
295 pthread_cond_wait( &this->audio_cond, &this->audio_mutex );
297 if ( this->audio_avail >= len )
299 // Place in the audio buffer
301 SDL_MixAudio( stream, this->audio_buffer, len, ( int )( ( float )SDL_MIX_MAXVOLUME * volume ) );
303 memcpy( stream, this->audio_buffer, len );
305 // Remove len from the audio available
306 this->audio_avail -= len;
308 // Remove the samples
309 memmove( this->audio_buffer, this->audio_buffer + len, this->audio_avail );
313 // Just to be safe, wipe the stream first
314 memset( stream, 0, len );
317 SDL_MixAudio( stream, this->audio_buffer, len, ( int )( ( float )SDL_MIX_MAXVOLUME * volume ) );
320 this->audio_avail = 0;
323 // We're definitely playing now
326 pthread_cond_broadcast( &this->audio_cond );
327 pthread_mutex_unlock( &this->audio_mutex );
330 static int consumer_play_audio( consumer_sdl this, mlt_frame frame, int init_audio, int *duration )
332 // Get the properties of this consumer
333 mlt_properties properties = this->properties;
334 mlt_audio_format afmt = mlt_audio_pcm;
336 // Set the preferred params of the test card signal
337 int channels = mlt_properties_get_int( properties, "channels" );
338 int frequency = mlt_properties_get_int( properties, "frequency" );
339 static int counter = 0;
341 int samples = mlt_sample_calculator( mlt_properties_get_double( this->properties, "fps" ), frequency, counter++ );
346 mlt_frame_get_audio( frame, &pcm, &afmt, &frequency, &channels, &samples );
347 *duration = ( ( samples * 1000 ) / frequency );
349 if ( mlt_properties_get_int( properties, "audio_off" ) )
356 if ( init_audio == 1 )
358 SDL_AudioSpec request;
361 int audio_buffer = mlt_properties_get_int( properties, "audio_buffer" );
363 // specify audio format
364 memset( &request, 0, sizeof( SDL_AudioSpec ) );
366 request.freq = frequency;
367 request.format = AUDIO_S16SYS;
368 request.channels = channels;
369 request.samples = audio_buffer;
370 request.callback = sdl_fill_audio;
371 request.userdata = (void *)this;
372 if ( SDL_OpenAudio( &request, &got ) != 0 )
374 fprintf( stderr, "SDL failed to open audio: %s\n", SDL_GetError() );
377 else if ( got.size != 0 )
384 if ( init_audio == 0 )
386 mlt_properties properties = MLT_FRAME_PROPERTIES( frame );
387 bytes = ( samples * channels * 2 );
388 pthread_mutex_lock( &this->audio_mutex );
389 while ( this->running && bytes > ( sizeof( this->audio_buffer) - this->audio_avail ) )
390 pthread_cond_wait( &this->audio_cond, &this->audio_mutex );
393 if ( mlt_properties_get_double( properties, "_speed" ) == 1 )
394 memcpy( &this->audio_buffer[ this->audio_avail ], pcm, bytes );
396 memset( &this->audio_buffer[ this->audio_avail ], 0, bytes );
397 this->audio_avail += bytes;
399 pthread_cond_broadcast( &this->audio_cond );
400 pthread_mutex_unlock( &this->audio_mutex );
410 static int consumer_play_video( consumer_sdl this, mlt_frame frame )
412 // Get the properties of this consumer
413 mlt_properties properties = this->properties;
415 mlt_image_format vfmt = mlt_image_yuv422;
416 int width = this->width, height = this->height;
420 int video_off = mlt_properties_get_int( properties, "video_off" );
421 int preview_off = mlt_properties_get_int( properties, "preview_off" );
422 mlt_image_format preview_format = mlt_properties_get_int( properties, "preview_format" );
423 int display_off = video_off | preview_off;
425 if ( this->running && display_off == 0 )
427 // Get the image, width and height
428 mlt_frame_get_image( frame, &image, &vfmt, &width, &height, 0 );
429 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "format", vfmt );
430 mlt_events_fire( properties, "consumer-frame-show", frame, NULL );
433 if ( this->sdl_screen != NULL )
438 changed = consumer_get_dimensions( &this->window_width, &this->window_height );
439 sdl_unlock_display( );
441 while ( SDL_PollEvent( &event ) )
443 mlt_events_fire( this->properties, "consumer-sdl-event", &event, NULL );
447 case SDL_VIDEORESIZE:
448 this->window_width = event.resize.w;
449 this->window_height = event.resize.h;
457 mlt_producer producer = mlt_properties_get_data( properties, "transport_producer", NULL );
458 char keyboard[ 2 ] = " ";
459 void (*callback)( mlt_producer, char * ) = mlt_properties_get_data( properties, "transport_callback", NULL );
460 if ( callback != NULL && producer != NULL && event.key.keysym.unicode < 0x80 && event.key.keysym.unicode > 0 )
462 keyboard[ 0 ] = ( char )event.key.keysym.unicode;
463 callback( producer, keyboard );
473 if ( width != this->width || height != this->height )
475 if ( this->sdl_overlay != NULL )
476 SDL_FreeYUVOverlay( this->sdl_overlay );
477 this->sdl_overlay = NULL;
480 if ( this->running && ( this->sdl_screen == NULL || changed ) )
482 // Force an overlay recreation
483 if ( this->sdl_overlay != NULL )
484 SDL_FreeYUVOverlay( this->sdl_overlay );
485 this->sdl_overlay = NULL;
487 // open SDL window with video overlay, if possible
488 this->sdl_screen = SDL_SetVideoMode( this->window_width, this->window_height, this->bpp, this->sdl_flags );
489 if ( consumer_get_dimensions( &this->window_width, &this->window_height ) )
490 this->sdl_screen = SDL_SetVideoMode( this->window_width, this->window_height, this->bpp, this->sdl_flags );
495 // Determine window's new display aspect ratio
496 double this_aspect = ( double )this->window_width / this->window_height;
498 // Get the display aspect ratio
499 double display_ratio = mlt_properties_get_double( properties, "display_ratio" );
501 // Determine frame's display aspect ratio
502 double frame_aspect = mlt_frame_get_aspect_ratio( frame ) * width / height;
504 // Store the width and height received
506 this->height = height;
508 // If using hardware scaler
509 if ( mlt_properties_get( properties, "rescale" ) != NULL &&
510 !strcmp( mlt_properties_get( properties, "rescale" ), "none" ) )
512 // Use hardware scaler to normalise display aspect ratio
513 this->rect.w = frame_aspect / this_aspect * this->window_width;
514 this->rect.h = this->window_height;
515 if ( this->rect.w > this->window_width )
517 this->rect.w = this->window_width;
518 this->rect.h = this_aspect / frame_aspect * this->window_height;
521 // Special case optimisation to negate odd effect of sample aspect ratio
522 // not corresponding exactly with image resolution.
523 else if ( (int)( this_aspect * 1000 ) == (int)( display_ratio * 1000 ) )
525 this->rect.w = this->window_width;
526 this->rect.h = this->window_height;
528 // Use hardware scaler to normalise sample aspect ratio
529 else if ( this->window_height * display_ratio > this->window_width )
531 this->rect.w = this->window_width;
532 this->rect.h = this->window_width / display_ratio;
536 this->rect.w = this->window_height * display_ratio;
537 this->rect.h = this->window_height;
540 this->rect.x = ( this->window_width - this->rect.w ) / 2;
541 this->rect.y = ( this->window_height - this->rect.h ) / 2;
542 this->rect.x -= this->rect.x % 2;
544 mlt_properties_set_int( this->properties, "rect_x", this->rect.x );
545 mlt_properties_set_int( this->properties, "rect_y", this->rect.y );
546 mlt_properties_set_int( this->properties, "rect_w", this->rect.w );
547 mlt_properties_set_int( this->properties, "rect_h", this->rect.h );
549 SDL_SetClipRect( this->sdl_screen, &this->rect );
552 if ( this->running && this->sdl_screen != NULL && this->sdl_overlay == NULL )
554 SDL_SetClipRect( this->sdl_screen, &this->rect );
555 this->sdl_overlay = SDL_CreateYUVOverlay( width, height, SDL_YUY2_OVERLAY, this->sdl_screen );
558 if ( this->running && this->sdl_screen != NULL && this->sdl_overlay != NULL )
560 this->buffer = this->sdl_overlay->pixels[ 0 ];
561 if ( SDL_LockYUVOverlay( this->sdl_overlay ) >= 0 )
564 memcpy( this->buffer, image, width * height * 2 );
565 SDL_UnlockYUVOverlay( this->sdl_overlay );
566 SDL_DisplayYUVOverlay( this->sdl_overlay, &this->sdl_screen->clip_rect );
570 sdl_unlock_display();
572 else if ( this->running )
574 vfmt = preview_format == mlt_image_none ? mlt_image_rgb24a : preview_format;
576 mlt_frame_get_image( frame, &image, &vfmt, &width, &height, 0 );
577 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "format", vfmt );
578 mlt_events_fire( properties, "consumer-frame-show", frame, NULL );
584 static void *video_thread( void *arg )
587 consumer_sdl this = arg;
589 // Obtain time of thread start
594 mlt_frame next = NULL;
595 mlt_properties properties = NULL;
598 // Get real time flag
599 int real_time = mlt_properties_get_int( this->properties, "real_time" );
601 // Get the current time
602 gettimeofday( &now, NULL );
604 // Determine start time
605 start = ( int64_t )now.tv_sec * 1000000 + now.tv_usec;
607 while ( this->running )
609 // Pop the next frame
610 pthread_mutex_lock( &this->video_mutex );
611 next = mlt_deque_pop_front( this->queue );
612 while ( next == NULL && this->running )
614 pthread_cond_wait( &this->video_cond, &this->video_mutex );
615 next = mlt_deque_pop_front( this->queue );
617 pthread_mutex_unlock( &this->video_mutex );
619 if ( !this->running || next == NULL ) break;
621 // Get the properties
622 properties = MLT_FRAME_PROPERTIES( next );
624 // Get the speed of the frame
625 speed = mlt_properties_get_double( properties, "_speed" );
627 // Get the current time
628 gettimeofday( &now, NULL );
630 // Get the elapsed time
631 elapsed = ( ( int64_t )now.tv_sec * 1000000 + now.tv_usec ) - start;
633 // See if we have to delay the display of the current frame
634 if ( mlt_properties_get_int( properties, "rendered" ) == 1 && this->running )
636 // Obtain the scheduled playout time
637 int64_t scheduled = mlt_properties_get_int( properties, "playtime" );
639 // Determine the difference between the elapsed time and the scheduled playout time
640 int64_t difference = scheduled - elapsed;
642 // Smooth playback a bit
643 if ( real_time && ( difference > 20000 && speed == 1.0 ) )
645 tm.tv_sec = difference / 1000000;
646 tm.tv_nsec = ( difference % 1000000 ) * 500;
647 nanosleep( &tm, NULL );
650 // Show current frame if not too old
651 if ( !real_time || ( difference > -10000 || speed != 1.0 || mlt_deque_count( this->queue ) < 2 ) )
652 consumer_play_video( this, next );
654 // If the queue is empty, recalculate start to allow build up again
655 if ( real_time && ( mlt_deque_count( this->queue ) == 0 && speed == 1.0 ) )
657 gettimeofday( &now, NULL );
658 start = ( ( int64_t )now.tv_sec * 1000000 + now.tv_usec ) - scheduled + 20000;
662 // This frame can now be closed
663 mlt_frame_close( next );
668 mlt_frame_close( next );
670 mlt_consumer_stopped( &this->parent );
675 /** Threaded wrapper for pipe.
678 static void *consumer_thread( void *arg )
681 consumer_sdl this = arg;
684 mlt_consumer consumer = &this->parent;
686 // Convenience functionality
687 int terminate_on_pause = mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( consumer ), "terminate_on_pause" );
693 // internal intialization
696 mlt_frame frame = NULL;
697 mlt_properties properties = NULL;
699 int64_t playtime = 0;
700 struct timespec tm = { 0, 100000 };
702 // Loop until told not to
703 while( !terminated && this->running )
705 // Get a frame from the attached producer
706 frame = mlt_consumer_rt_frame( consumer );
708 // Check for termination
709 if ( terminate_on_pause && frame != NULL )
710 terminated = mlt_properties_get_double( MLT_FRAME_PROPERTIES( frame ), "_speed" ) == 0.0;
712 // Ensure that we have a frame
715 // Get the frame properties
716 properties = MLT_FRAME_PROPERTIES( frame );
719 init_audio = consumer_play_audio( this, frame, init_audio, &duration );
721 // Determine the start time now
722 if ( this->playing && init_video )
724 // Create the video thread
725 pthread_create( &thread, NULL, video_thread, this );
727 // Video doesn't need to be initialised any more
731 // Set playtime for this frame
732 mlt_properties_set_int( properties, "playtime", playtime );
734 while ( this->running && mlt_deque_count( this->queue ) > 15 )
735 nanosleep( &tm, NULL );
737 // Push this frame to the back of the queue
738 pthread_mutex_lock( &this->video_mutex );
739 mlt_deque_push_back( this->queue, frame );
740 pthread_cond_broadcast( &this->video_cond );
741 pthread_mutex_unlock( &this->video_mutex );
743 // Calculate the next playtime
744 playtime += ( duration * 1000 );
750 // Kill the video thread
751 if ( init_video == 0 )
753 pthread_mutex_lock( &this->video_mutex );
754 pthread_cond_broadcast( &this->video_cond );
755 pthread_mutex_unlock( &this->video_mutex );
756 pthread_join( thread, NULL );
759 while( mlt_deque_count( this->queue ) )
760 mlt_frame_close( mlt_deque_pop_back( this->queue ) );
762 this->sdl_screen = NULL;
763 this->audio_avail = 0;
768 static int consumer_get_dimensions( int *width, int *height )
772 // SDL windows manager structure
775 // Specify the SDL Version
776 SDL_VERSION( &wm.version );
779 //sdl_lock_display();
782 // Get the wm structure
783 if ( SDL_GetWMInfo( &wm ) == 1 )
785 // Check that we have the X11 wm
786 if ( wm.subsystem == SDL_SYSWM_X11 )
788 // Get the SDL window
789 Window window = wm.info.x11.window;
791 // Get the display session
792 Display *display = wm.info.x11.display;
794 // Get the window attributes
795 XWindowAttributes attr;
796 XGetWindowAttributes( display, window, &attr );
798 // Determine whether window has changed
799 changed = *width != attr.width || *height != attr.height;
801 // Return width and height
803 *height = attr.height;
808 // Unlock the display
809 //sdl_unlock_display();
814 /** Callback to allow override of the close method.
817 static void consumer_close( mlt_consumer parent )
819 // Get the actual object
820 consumer_sdl this = parent->child;
823 ///mlt_consumer_stop( parent );
825 // Now clean up the rest
826 mlt_consumer_close( parent );
829 mlt_deque_close( this->queue );
832 pthread_mutex_destroy( &this->audio_mutex );
833 pthread_cond_destroy( &this->audio_cond );
835 // Finally clean up this