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 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>
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( mlt_profile profile, mlt_service_type type, const char *id, 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, profile ) == 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 // Set the default volume
106 mlt_properties_set_double( this->properties, "volume", 1.0 );
108 // This is the initialisation of the consumer
109 pthread_mutex_init( &this->audio_mutex, NULL );
110 pthread_cond_init( &this->audio_cond, NULL);
111 pthread_mutex_init( &this->video_mutex, NULL );
112 pthread_cond_init( &this->video_cond, NULL);
114 // Default scaler (for now we'll use nearest)
115 mlt_properties_set( this->properties, "rescale", "nearest" );
117 // Default buffer for low latency
118 mlt_properties_set_int( this->properties, "buffer", 1 );
120 // Default progressive true
121 mlt_properties_set_int( this->properties, "progressive", 0 );
123 // Default audio buffer
124 mlt_properties_set_int( this->properties, "audio_buffer", 512 );
126 // Ensure we don't join on a non-running object
129 // process actual param
130 if ( arg == NULL || sscanf( arg, "%dx%d", &this->width, &this->height ) != 2 )
132 this->width = mlt_properties_get_int( this->properties, "width" );
133 this->height = mlt_properties_get_int( this->properties, "height" );
137 this->sdl_flags = SDL_HWSURFACE | SDL_ASYNCBLIT | SDL_HWACCEL | SDL_RESIZABLE | SDL_DOUBLEBUF;
139 // Allow thread to be started/stopped
140 parent->start = consumer_start;
141 parent->stop = consumer_stop;
142 parent->is_stopped = consumer_is_stopped;
144 // Register specific events
145 mlt_events_register( this->properties, "consumer-sdl-event", ( mlt_transmitter )consumer_sdl_event );
147 // Return the consumer produced
151 // malloc or consumer init failed
158 static void consumer_sdl_event( mlt_listener listener, mlt_properties owner, mlt_service this, void **args )
160 if ( listener != NULL )
161 listener( owner, this, ( SDL_Event * )args[ 0 ] );
164 int consumer_start( mlt_consumer parent )
166 consumer_sdl this = parent->child;
168 if ( !this->running )
170 int video_off = mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( parent ), "video_off" );
171 int preview_off = mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( parent ), "preview_off" );
172 int display_off = video_off | preview_off;
173 int audio_off = mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( parent ), "audio_off" );
174 int sdl_started = mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( parent ), "sdl_started" );
176 consumer_stop( parent );
181 if ( mlt_properties_get_int( this->properties, "width" ) > 0 )
182 this->width = mlt_properties_get_int( this->properties, "width" );
183 if ( mlt_properties_get_int( this->properties, "height" ) > 0 )
184 this->height = mlt_properties_get_int( this->properties, "height" );
186 this->bpp = mlt_properties_get_int( this->properties, "bpp" );
188 // Attach a colour space converter
189 if ( preview_off && !this->filtered )
191 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( parent ) );
192 mlt_filter filter = mlt_factory_filter( profile, "avcolour_space", NULL );
193 mlt_properties_set_int( MLT_FILTER_PROPERTIES( filter ), "forced", mlt_image_yuv422 );
194 mlt_service_attach( MLT_CONSUMER_SERVICE( parent ), filter );
195 mlt_filter_close( filter );
199 if ( sdl_started == 0 && display_off == 0 )
201 if ( SDL_Init( SDL_INIT_VIDEO | SDL_INIT_NOPARACHUTE ) < 0 )
203 fprintf( stderr, "Failed to initialize SDL: %s\n", SDL_GetError() );
207 SDL_EnableKeyRepeat( SDL_DEFAULT_REPEAT_DELAY, SDL_DEFAULT_REPEAT_INTERVAL );
208 SDL_EnableUNICODE( 1 );
210 else if ( display_off == 0 )
212 this->sdl_screen = SDL_GetVideoSurface( );
215 if ( audio_off == 0 )
216 SDL_InitSubSystem( SDL_INIT_AUDIO );
218 // Default window size
219 double display_ratio = mlt_properties_get_double( this->properties, "display_ratio" );
220 this->window_width = ( double )this->height * display_ratio;
221 this->window_height = this->height;
223 if ( this->sdl_screen == NULL && display_off == 0 )
225 if ( mlt_properties_get_int( this->properties, "fullscreen" ) )
227 const SDL_VideoInfo *vi = SDL_GetVideoInfo();
228 this->window_width = vi->current_w;
229 this->window_height = vi->current_h;
230 this->sdl_flags |= SDL_FULLSCREEN;
231 SDL_ShowCursor( SDL_DISABLE );
233 this->sdl_screen = SDL_SetVideoMode( this->window_width, this->window_height, 0, this->sdl_flags );
236 pthread_create( &this->thread, NULL, consumer_thread, this );
242 int consumer_stop( mlt_consumer parent )
244 // Get the actual object
245 consumer_sdl this = parent->child;
247 if ( this->joined == 0 )
249 // Kill the thread and clean up
252 pthread_join( this->thread, NULL );
255 if ( this->sdl_overlay != NULL )
256 SDL_FreeYUVOverlay( this->sdl_overlay );
257 this->sdl_overlay = NULL;
259 if ( !mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( parent ), "audio_off" ) )
261 pthread_mutex_lock( &this->audio_mutex );
262 pthread_cond_broadcast( &this->audio_cond );
263 pthread_mutex_unlock( &this->audio_mutex );
264 SDL_QuitSubSystem( SDL_INIT_AUDIO );
267 if ( mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( parent ), "sdl_started" ) == 0 )
270 this->sdl_screen = NULL;
276 int consumer_is_stopped( mlt_consumer parent )
278 consumer_sdl this = parent->child;
279 return !this->running;
282 static int sdl_lock_display( )
284 SDL_Surface *screen = SDL_GetVideoSurface( );
285 return screen != NULL && ( !SDL_MUSTLOCK( screen ) || SDL_LockSurface( screen ) >= 0 );
288 static void sdl_unlock_display( )
290 SDL_Surface *screen = SDL_GetVideoSurface( );
291 if ( screen != NULL && SDL_MUSTLOCK( screen ) )
292 SDL_UnlockSurface( screen );
295 static void sdl_fill_audio( void *udata, uint8_t *stream, int len )
297 consumer_sdl this = udata;
300 double volume = mlt_properties_get_double( this->properties, "volume" );
302 pthread_mutex_lock( &this->audio_mutex );
304 // Block until audio received
305 while ( this->running && len > this->audio_avail )
306 pthread_cond_wait( &this->audio_cond, &this->audio_mutex );
308 if ( this->audio_avail >= len )
310 // Place in the audio buffer
312 SDL_MixAudio( stream, this->audio_buffer, len, ( int )( ( float )SDL_MIX_MAXVOLUME * volume ) );
314 memcpy( stream, this->audio_buffer, len );
316 // Remove len from the audio available
317 this->audio_avail -= len;
319 // Remove the samples
320 memmove( this->audio_buffer, this->audio_buffer + len, this->audio_avail );
324 // Just to be safe, wipe the stream first
325 memset( stream, 0, len );
328 SDL_MixAudio( stream, this->audio_buffer, len, ( int )( ( float )SDL_MIX_MAXVOLUME * volume ) );
331 this->audio_avail = 0;
334 // We're definitely playing now
337 pthread_cond_broadcast( &this->audio_cond );
338 pthread_mutex_unlock( &this->audio_mutex );
341 static int consumer_play_audio( consumer_sdl this, mlt_frame frame, int init_audio, int *duration )
343 // Get the properties of this consumer
344 mlt_properties properties = this->properties;
345 mlt_audio_format afmt = mlt_audio_pcm;
347 // Set the preferred params of the test card signal
348 int channels = mlt_properties_get_int( properties, "channels" );
349 int frequency = mlt_properties_get_int( properties, "frequency" );
350 static int counter = 0;
352 int samples = mlt_sample_calculator( mlt_properties_get_double( this->properties, "fps" ), frequency, counter++ );
357 mlt_frame_get_audio( frame, &pcm, &afmt, &frequency, &channels, &samples );
358 *duration = ( ( samples * 1000 ) / frequency );
360 if ( mlt_properties_get_int( properties, "audio_off" ) )
367 if ( init_audio == 1 )
369 SDL_AudioSpec request;
372 int audio_buffer = mlt_properties_get_int( properties, "audio_buffer" );
374 // specify audio format
375 memset( &request, 0, sizeof( SDL_AudioSpec ) );
377 request.freq = frequency;
378 request.format = AUDIO_S16SYS;
379 request.channels = channels;
380 request.samples = audio_buffer;
381 request.callback = sdl_fill_audio;
382 request.userdata = (void *)this;
383 if ( SDL_OpenAudio( &request, &got ) != 0 )
385 fprintf( stderr, "SDL failed to open audio: %s\n", SDL_GetError() );
388 else if ( got.size != 0 )
395 if ( init_audio == 0 )
397 mlt_properties properties = MLT_FRAME_PROPERTIES( frame );
398 bytes = ( samples * channels * 2 );
399 pthread_mutex_lock( &this->audio_mutex );
400 while ( this->running && bytes > ( sizeof( this->audio_buffer) - this->audio_avail ) )
401 pthread_cond_wait( &this->audio_cond, &this->audio_mutex );
404 if ( mlt_properties_get_double( properties, "_speed" ) == 1 )
405 memcpy( &this->audio_buffer[ this->audio_avail ], pcm, bytes );
407 memset( &this->audio_buffer[ this->audio_avail ], 0, bytes );
408 this->audio_avail += bytes;
410 pthread_cond_broadcast( &this->audio_cond );
411 pthread_mutex_unlock( &this->audio_mutex );
421 static int consumer_play_video( consumer_sdl this, mlt_frame frame )
423 // Get the properties of this consumer
424 mlt_properties properties = this->properties;
426 mlt_image_format vfmt = mlt_image_yuv422;
427 int width = this->width, height = this->height;
431 int video_off = mlt_properties_get_int( properties, "video_off" );
432 int preview_off = mlt_properties_get_int( properties, "preview_off" );
433 mlt_image_format preview_format = mlt_properties_get_int( properties, "preview_format" );
434 int display_off = video_off | preview_off;
436 if ( this->running && display_off == 0 )
438 // Get the image, width and height
439 mlt_frame_get_image( frame, &image, &vfmt, &width, &height, 0 );
440 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "format", vfmt );
441 mlt_events_fire( properties, "consumer-frame-show", frame, NULL );
444 if ( this->sdl_screen != NULL )
449 changed = consumer_get_dimensions( &this->window_width, &this->window_height );
450 sdl_unlock_display( );
452 while ( SDL_PollEvent( &event ) )
454 mlt_events_fire( this->properties, "consumer-sdl-event", &event, NULL );
458 case SDL_VIDEORESIZE:
459 this->window_width = event.resize.w;
460 this->window_height = event.resize.h;
468 mlt_producer producer = mlt_properties_get_data( properties, "transport_producer", NULL );
469 char keyboard[ 2 ] = " ";
470 void (*callback)( mlt_producer, char * ) = mlt_properties_get_data( properties, "transport_callback", NULL );
471 if ( callback != NULL && producer != NULL && event.key.keysym.unicode < 0x80 && event.key.keysym.unicode > 0 )
473 keyboard[ 0 ] = ( char )event.key.keysym.unicode;
474 callback( producer, keyboard );
484 if ( width != this->width || height != this->height )
486 if ( this->sdl_overlay != NULL )
487 SDL_FreeYUVOverlay( this->sdl_overlay );
488 this->sdl_overlay = NULL;
491 if ( this->running && ( this->sdl_screen == NULL || changed ) )
493 // Force an overlay recreation
494 if ( this->sdl_overlay != NULL )
495 SDL_FreeYUVOverlay( this->sdl_overlay );
496 this->sdl_overlay = NULL;
498 // open SDL window with video overlay, if possible
499 this->sdl_screen = SDL_SetVideoMode( this->window_width, this->window_height, this->bpp, this->sdl_flags );
500 if ( consumer_get_dimensions( &this->window_width, &this->window_height ) )
501 this->sdl_screen = SDL_SetVideoMode( this->window_width, this->window_height, this->bpp, this->sdl_flags );
506 // Determine window's new display aspect ratio
507 double this_aspect = ( double )this->window_width / this->window_height;
509 // Get the display aspect ratio
510 double display_ratio = mlt_properties_get_double( properties, "display_ratio" );
512 // Determine frame's display aspect ratio
513 double frame_aspect = mlt_frame_get_aspect_ratio( frame ) * width / height;
515 // Store the width and height received
517 this->height = height;
519 // If using hardware scaler
520 if ( mlt_properties_get( properties, "rescale" ) != NULL &&
521 !strcmp( mlt_properties_get( properties, "rescale" ), "none" ) )
523 // Use hardware scaler to normalise display aspect ratio
524 this->rect.w = frame_aspect / this_aspect * this->window_width;
525 this->rect.h = this->window_height;
526 if ( this->rect.w > this->window_width )
528 this->rect.w = this->window_width;
529 this->rect.h = this_aspect / frame_aspect * this->window_height;
532 // Special case optimisation to negate odd effect of sample aspect ratio
533 // not corresponding exactly with image resolution.
534 else if ( (int)( this_aspect * 1000 ) == (int)( display_ratio * 1000 ) )
536 this->rect.w = this->window_width;
537 this->rect.h = this->window_height;
539 // Use hardware scaler to normalise sample aspect ratio
540 else if ( this->window_height * display_ratio > this->window_width )
542 this->rect.w = this->window_width;
543 this->rect.h = this->window_width / display_ratio;
547 this->rect.w = this->window_height * display_ratio;
548 this->rect.h = this->window_height;
551 this->rect.x = ( this->window_width - this->rect.w ) / 2;
552 this->rect.y = ( this->window_height - this->rect.h ) / 2;
553 this->rect.x -= this->rect.x % 2;
555 mlt_properties_set_int( this->properties, "rect_x", this->rect.x );
556 mlt_properties_set_int( this->properties, "rect_y", this->rect.y );
557 mlt_properties_set_int( this->properties, "rect_w", this->rect.w );
558 mlt_properties_set_int( this->properties, "rect_h", this->rect.h );
560 SDL_SetClipRect( this->sdl_screen, &this->rect );
563 if ( this->running && this->sdl_screen != NULL && this->sdl_overlay == NULL )
565 SDL_SetClipRect( this->sdl_screen, &this->rect );
566 this->sdl_overlay = SDL_CreateYUVOverlay( width, height, SDL_YUY2_OVERLAY, this->sdl_screen );
569 if ( this->running && this->sdl_screen != NULL && this->sdl_overlay != NULL )
571 this->buffer = this->sdl_overlay->pixels[ 0 ];
572 if ( SDL_LockYUVOverlay( this->sdl_overlay ) >= 0 )
575 memcpy( this->buffer, image, width * height * 2 );
576 SDL_UnlockYUVOverlay( this->sdl_overlay );
577 SDL_DisplayYUVOverlay( this->sdl_overlay, &this->sdl_screen->clip_rect );
581 sdl_unlock_display();
583 else if ( this->running )
585 vfmt = preview_format == mlt_image_none ? mlt_image_rgb24a : preview_format;
587 mlt_frame_get_image( frame, &image, &vfmt, &width, &height, 0 );
588 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "format", vfmt );
589 mlt_events_fire( properties, "consumer-frame-show", frame, NULL );
595 static void *video_thread( void *arg )
598 consumer_sdl this = arg;
600 // Obtain time of thread start
605 mlt_frame next = NULL;
606 mlt_properties properties = NULL;
609 // Get real time flag
610 int real_time = mlt_properties_get_int( this->properties, "real_time" );
612 // Get the current time
613 gettimeofday( &now, NULL );
615 // Determine start time
616 start = ( int64_t )now.tv_sec * 1000000 + now.tv_usec;
618 while ( this->running )
620 // Pop the next frame
621 pthread_mutex_lock( &this->video_mutex );
622 next = mlt_deque_pop_front( this->queue );
623 while ( next == NULL && this->running )
625 pthread_cond_wait( &this->video_cond, &this->video_mutex );
626 next = mlt_deque_pop_front( this->queue );
628 pthread_mutex_unlock( &this->video_mutex );
630 if ( !this->running || next == NULL ) break;
632 // Get the properties
633 properties = MLT_FRAME_PROPERTIES( next );
635 // Get the speed of the frame
636 speed = mlt_properties_get_double( properties, "_speed" );
638 // Get the current time
639 gettimeofday( &now, NULL );
641 // Get the elapsed time
642 elapsed = ( ( int64_t )now.tv_sec * 1000000 + now.tv_usec ) - start;
644 // See if we have to delay the display of the current frame
645 if ( mlt_properties_get_int( properties, "rendered" ) == 1 && this->running )
647 // Obtain the scheduled playout time
648 int64_t scheduled = mlt_properties_get_int( properties, "playtime" );
650 // Determine the difference between the elapsed time and the scheduled playout time
651 int64_t difference = scheduled - elapsed;
653 // Smooth playback a bit
654 if ( real_time && ( difference > 20000 && speed == 1.0 ) )
656 tm.tv_sec = difference / 1000000;
657 tm.tv_nsec = ( difference % 1000000 ) * 500;
658 nanosleep( &tm, NULL );
661 // Show current frame if not too old
662 if ( !real_time || ( difference > -10000 || speed != 1.0 || mlt_deque_count( this->queue ) < 2 ) )
663 consumer_play_video( this, next );
665 // If the queue is empty, recalculate start to allow build up again
666 if ( real_time && ( mlt_deque_count( this->queue ) == 0 && speed == 1.0 ) )
668 gettimeofday( &now, NULL );
669 start = ( ( int64_t )now.tv_sec * 1000000 + now.tv_usec ) - scheduled + 20000;
673 // This frame can now be closed
674 mlt_frame_close( next );
679 mlt_frame_close( next );
681 mlt_consumer_stopped( &this->parent );
686 /** Threaded wrapper for pipe.
689 static void *consumer_thread( void *arg )
692 consumer_sdl this = arg;
695 mlt_consumer consumer = &this->parent;
697 // Convenience functionality
698 int terminate_on_pause = mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( consumer ), "terminate_on_pause" );
704 // internal intialization
707 mlt_frame frame = NULL;
708 mlt_properties properties = NULL;
710 int64_t playtime = 0;
711 struct timespec tm = { 0, 100000 };
713 // Loop until told not to
714 while( !terminated && this->running )
716 // Get a frame from the attached producer
717 frame = mlt_consumer_rt_frame( consumer );
719 // Check for termination
720 if ( terminate_on_pause && frame != NULL )
721 terminated = mlt_properties_get_double( MLT_FRAME_PROPERTIES( frame ), "_speed" ) == 0.0;
723 // Ensure that we have a frame
726 // Get the frame properties
727 properties = MLT_FRAME_PROPERTIES( frame );
730 init_audio = consumer_play_audio( this, frame, init_audio, &duration );
732 // Determine the start time now
733 if ( this->playing && init_video )
735 // Create the video thread
736 pthread_create( &thread, NULL, video_thread, this );
738 // Video doesn't need to be initialised any more
742 // Set playtime for this frame
743 mlt_properties_set_int( properties, "playtime", playtime );
745 while ( this->running && mlt_deque_count( this->queue ) > 15 )
746 nanosleep( &tm, NULL );
748 // Push this frame to the back of the queue
749 pthread_mutex_lock( &this->video_mutex );
750 mlt_deque_push_back( this->queue, frame );
751 pthread_cond_broadcast( &this->video_cond );
752 pthread_mutex_unlock( &this->video_mutex );
754 // Calculate the next playtime
755 playtime += ( duration * 1000 );
761 // Kill the video thread
762 if ( init_video == 0 )
764 pthread_mutex_lock( &this->video_mutex );
765 pthread_cond_broadcast( &this->video_cond );
766 pthread_mutex_unlock( &this->video_mutex );
767 pthread_join( thread, NULL );
770 while( mlt_deque_count( this->queue ) )
771 mlt_frame_close( mlt_deque_pop_back( this->queue ) );
773 this->sdl_screen = NULL;
774 this->audio_avail = 0;
779 static int consumer_get_dimensions( int *width, int *height )
783 // SDL windows manager structure
786 // Specify the SDL Version
787 SDL_VERSION( &wm.version );
790 //sdl_lock_display();
793 // Get the wm structure
794 if ( SDL_GetWMInfo( &wm ) == 1 )
796 // Check that we have the X11 wm
797 if ( wm.subsystem == SDL_SYSWM_X11 )
799 // Get the SDL window
800 Window window = wm.info.x11.window;
802 // Get the display session
803 Display *display = wm.info.x11.display;
805 // Get the window attributes
806 XWindowAttributes attr;
807 XGetWindowAttributes( display, window, &attr );
809 // Determine whether window has changed
810 changed = *width != attr.width || *height != attr.height;
812 // Return width and height
814 *height = attr.height;
819 // Unlock the display
820 //sdl_unlock_display();
825 /** Callback to allow override of the close method.
828 static void consumer_close( mlt_consumer parent )
830 // Get the actual object
831 consumer_sdl this = parent->child;
834 ///mlt_consumer_stop( parent );
836 // Now clean up the rest
837 mlt_consumer_close( parent );
840 mlt_deque_close( this->queue );
843 pthread_mutex_destroy( &this->audio_mutex );
844 pthread_cond_destroy( &this->audio_cond );
846 // Finally clean up this