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>
32 /** This classes definition.
35 typedef struct consumer_sdl_s *consumer_sdl;
39 struct mlt_consumer_s parent;
40 mlt_properties properties;
44 uint8_t audio_buffer[ 4096 * 19 ];
46 pthread_mutex_t audio_mutex;
47 pthread_cond_t audio_cond;
56 SDL_Surface *sdl_screen;
57 SDL_Overlay *sdl_overlay;
61 /** Forward references to static functions.
64 static int consumer_start( mlt_consumer parent );
65 static int consumer_stop( mlt_consumer parent );
66 static int consumer_is_stopped( mlt_consumer parent );
67 static void consumer_close( mlt_consumer parent );
68 static void *consumer_thread( void * );
69 static int consumer_get_dimensions( int *width, int *height );
71 /** This is what will be called by the factory - anything can be passed in
72 via the argument, but keep it simple.
75 mlt_consumer consumer_sdl_init( char *arg )
77 // Create the consumer object
78 consumer_sdl this = calloc( sizeof( struct consumer_sdl_s ), 1 );
80 // If no malloc'd and consumer init ok
81 if ( this != NULL && mlt_consumer_init( &this->parent, this ) == 0 )
84 this->queue = mlt_deque_init( );
86 // Get the parent consumer object
87 mlt_consumer parent = &this->parent;
89 // We have stuff to clean up, so override the close method
90 parent->close = consumer_close;
92 // get a handle on properties
93 mlt_service service = mlt_consumer_service( parent );
94 this->properties = mlt_service_properties( service );
96 // Set the default volume
97 mlt_properties_set_double( this->properties, "volume", 1.0 );
99 // This is the initialisation of the consumer
100 pthread_mutex_init( &this->audio_mutex, NULL );
101 pthread_cond_init( &this->audio_cond, NULL);
103 // Default scaler (for now we'll use nearest)
104 mlt_properties_set( this->properties, "rescale", "nearest" );
106 // Default buffer for low latency
107 mlt_properties_set_int( this->properties, "buffer", 1 );
109 // Default progressive true
110 mlt_properties_set_int( this->properties, "progressive", 0 );
112 // Get sample aspect ratio
113 this->aspect_ratio = mlt_properties_get_double( this->properties, "aspect_ratio" );
115 // Default display aspect ratio
116 this->display_aspect = 4.0 / 3.0;
118 // process actual param
119 if ( arg == NULL || sscanf( arg, "%dx%d", &this->width, &this->height ) != 2 )
121 this->width = mlt_properties_get_int( this->properties, "width" );
122 this->height = mlt_properties_get_int( this->properties, "height" );
124 // Default window size
125 this->window_width = ( float )this->height * this->display_aspect + 0.5;
126 this->window_height = this->height;
130 if ( (int)( ( float )this->width / this->height * 1000 ) !=
131 (int)( this->display_aspect * 1000 ) )
134 this->display_aspect = ( float )this->width / this->height;
135 this->aspect_ratio = 1.0;
136 mlt_properties_set_double( this->properties, "aspect_ratio", this->aspect_ratio );
140 this->window_width = this->width;
141 this->window_height = this->height;
145 this->sdl_flags = SDL_HWSURFACE | SDL_ASYNCBLIT | SDL_HWACCEL | SDL_RESIZABLE;
147 // Allow thread to be started/stopped
148 parent->start = consumer_start;
149 parent->stop = consumer_stop;
150 parent->is_stopped = consumer_is_stopped;
152 // Return the consumer produced
156 // malloc or consumer init failed
163 int consumer_start( mlt_consumer parent )
165 consumer_sdl this = parent->child;
167 if ( !this->running )
169 pthread_attr_t thread_attributes;
173 // Allow the user to force resizing to window size
174 if ( mlt_properties_get_int( this->properties, "resize" ) )
176 mlt_properties_set_int( this->properties, "width", this->width );
177 mlt_properties_set_int( this->properties, "height", this->height );
180 // Inherit the scheduling priority
181 pthread_attr_init( &thread_attributes );
182 pthread_attr_setinheritsched( &thread_attributes, PTHREAD_INHERIT_SCHED );
184 pthread_create( &this->thread, &thread_attributes, consumer_thread, this );
190 int consumer_stop( mlt_consumer parent )
192 // Get the actual object
193 consumer_sdl this = parent->child;
197 // Kill the thread and clean up
200 pthread_mutex_lock( &this->audio_mutex );
201 pthread_cond_broadcast( &this->audio_cond );
202 pthread_mutex_unlock( &this->audio_mutex );
204 pthread_join( this->thread, NULL );
210 int consumer_is_stopped( mlt_consumer parent )
212 consumer_sdl this = parent->child;
213 return !this->running;
216 static int sdl_lock_display( )
218 SDL_Surface *screen = SDL_GetVideoSurface( );
219 return screen != NULL && ( !SDL_MUSTLOCK( screen ) || SDL_LockSurface( screen ) >= 0 );
222 static void sdl_unlock_display( )
224 SDL_Surface *screen = SDL_GetVideoSurface( );
225 if ( screen != NULL && SDL_MUSTLOCK( screen ) )
226 SDL_UnlockSurface( screen );
229 static void sdl_fill_audio( void *udata, uint8_t *stream, int len )
231 consumer_sdl this = udata;
234 float volume = mlt_properties_get_double( this->properties, "volume" );
236 pthread_mutex_lock( &this->audio_mutex );
238 // Block until audio received
239 while ( this->running && len > this->audio_avail )
240 pthread_cond_wait( &this->audio_cond, &this->audio_mutex );
242 if ( this->audio_avail >= len )
244 // Place in the audio buffer
245 SDL_MixAudio( stream, this->audio_buffer, len, ( int )( ( float )SDL_MIX_MAXVOLUME * volume ) );
247 // Remove len from the audio available
248 this->audio_avail -= len;
250 // Remove the samples
251 memmove( this->audio_buffer, this->audio_buffer + len, this->audio_avail );
255 // Just to be safe, wipe the stream first
256 memset( stream, 0, len );
258 // Copy what we have into the stream
259 memcpy( stream, this->audio_buffer, this->audio_avail );
262 SDL_MixAudio( stream, stream, len, ( int )( ( float )SDL_MIX_MAXVOLUME * volume ) );
265 this->audio_avail = 0;
268 // We're definitely playing now
271 pthread_cond_broadcast( &this->audio_cond );
272 pthread_mutex_unlock( &this->audio_mutex );
275 static int consumer_play_audio( consumer_sdl this, mlt_frame frame, int init_audio, int *duration )
277 // Get the properties of this consumer
278 mlt_properties properties = this->properties;
279 mlt_audio_format afmt = mlt_audio_pcm;
281 // Set the preferred params of the test card signal
282 int channels = mlt_properties_get_int( properties, "channels" );
283 int frequency = mlt_properties_get_int( properties, "frequency" );
284 static int counter = 0;
286 int samples = mlt_sample_calculator( mlt_properties_get_double( this->properties, "fps" ), frequency, counter++ );
291 mlt_frame_get_audio( frame, &pcm, &afmt, &frequency, &channels, &samples );
292 *duration = ( ( samples * 1000 ) / frequency );
294 if ( mlt_properties_get_int( properties, "audio_off" ) )
301 if ( init_audio == 1 )
303 SDL_AudioSpec request;
306 // specify audio format
307 memset( &request, 0, sizeof( SDL_AudioSpec ) );
309 request.freq = frequency;
310 request.format = AUDIO_S16;
311 request.channels = channels;
312 request.samples = 1024;
313 request.callback = sdl_fill_audio;
314 request.userdata = (void *)this;
315 if ( SDL_OpenAudio( &request, &got ) != 0 )
317 fprintf( stderr, "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( &this->audio_mutex );
332 while ( bytes > ( sizeof( this->audio_buffer) - this->audio_avail ) )
333 pthread_cond_wait( &this->audio_cond, &this->audio_mutex );
334 if ( mlt_properties_get_double( properties, "_speed" ) == 1 )
335 memcpy( &this->audio_buffer[ this->audio_avail ], pcm, bytes );
337 memset( &this->audio_buffer[ this->audio_avail ], 0, bytes );
338 this->audio_avail += bytes;
339 pthread_cond_broadcast( &this->audio_cond );
340 pthread_mutex_unlock( &this->audio_mutex );
350 static int consumer_play_video( consumer_sdl this, mlt_frame frame )
352 // Get the properties of this consumer
353 mlt_properties properties = this->properties;
355 mlt_image_format vfmt = mlt_image_yuv422;
356 int width = this->width, height = this->height;
360 if ( mlt_properties_get_int( properties, "video_off" ) == 0 )
362 // Get the image, width and height
363 mlt_frame_get_image( frame, &image, &vfmt, &width, &height, 0 );
366 if ( this->sdl_screen != NULL )
370 changed = consumer_get_dimensions( &this->window_width, &this->window_height );
372 while ( SDL_PollEvent( &event ) )
376 case SDL_VIDEORESIZE:
377 this->window_width = event.resize.w;
378 this->window_height = event.resize.h;
386 mlt_producer producer = mlt_properties_get_data( properties, "transport_producer", NULL );
387 char keyboard[ 2 ] = " ";
388 void (*callback)( mlt_producer, char * ) = mlt_properties_get_data( properties, "transport_callback", NULL );
389 if ( callback != NULL && producer != NULL && event.key.keysym.unicode < 0x80 && event.key.keysym.unicode > 0 )
391 keyboard[ 0 ] = ( char )event.key.keysym.unicode;
392 callback( producer, keyboard );
400 if ( width != this->width || height != this->height )
403 this->height = height;
407 if ( this->sdl_screen == NULL || changed )
411 // Determine frame's display aspect ratio
412 float frame_aspect = mlt_frame_get_aspect_ratio( frame ) * this->width / this->height;
414 // Determine window's new display aspect ratio
415 float this_aspect = ( float )this->window_width / this->window_height;
417 // If using hardware scaler
418 if ( mlt_properties_get( properties, "rescale" ) != NULL &&
419 !strcmp( mlt_properties_get( properties, "rescale" ), "none" ) )
421 // Special case optimisation to negate odd effect of sample aspect ratio
422 // not corresponding exactly with image resolution.
423 if ( ( (int)( this_aspect * 1000 ) == (int)( this->display_aspect * 1000 ) ) &&
424 ( (int)( mlt_frame_get_aspect_ratio( frame ) * 1000 ) == (int)( this->aspect_ratio * 1000 ) ) )
426 rect.w = this->window_width;
427 rect.h = this->window_height;
431 // Use hardware scaler to normalise display aspect ratio
432 rect.w = frame_aspect / this_aspect * this->window_width + 0.5;
433 rect.h = this->window_height;
434 if ( rect.w > this->window_width )
436 rect.w = this->window_width;
437 rect.h = this_aspect / frame_aspect * this->window_height + 0.5;
441 // Special case optimisation to negate odd effect of sample aspect ratio
442 // not corresponding exactly with image resolution.
443 else if ( (int)( this_aspect * 1000 ) == (int)( this->display_aspect * 1000 ) )
445 rect.w = this->window_width;
446 rect.h = this->window_height;
448 // Use hardware scaler to normalise sample aspect ratio
449 else if ( this->window_height * frame_aspect > this->window_width )
451 rect.w = this->window_width;
452 rect.h = this->window_width / frame_aspect + 0.5;
456 rect.w = this->window_height * frame_aspect + 0.5;
457 rect.h = this->window_height;
460 rect.x = ( this->window_width - rect.w ) / 2;
461 rect.y = ( this->window_height - rect.h ) / 2;
463 // Force an overlay recreation
464 if ( this->sdl_overlay != NULL )
465 SDL_FreeYUVOverlay( this->sdl_overlay );
467 // open SDL window with video overlay, if possible
468 this->sdl_screen = SDL_SetVideoMode( this->window_width, this->window_height, 0, this->sdl_flags );
470 if ( this->sdl_screen != NULL )
472 SDL_SetClipRect( this->sdl_screen, &rect );
474 this->sdl_overlay = SDL_CreateYUVOverlay( this->width, this->height, SDL_YUY2_OVERLAY, this->sdl_screen );
475 sdl_unlock_display();
479 if ( this->sdl_screen != NULL && this->sdl_overlay != NULL )
481 this->buffer = this->sdl_overlay->pixels[ 0 ];
482 if ( SDL_LockYUVOverlay( this->sdl_overlay ) >= 0 )
485 memcpy( this->buffer, image, width * height * 2 );
486 SDL_UnlockYUVOverlay( this->sdl_overlay );
487 SDL_DisplayYUVOverlay( this->sdl_overlay, &this->sdl_screen->clip_rect );
495 /** Threaded wrapper for pipe.
498 static void *consumer_thread( void *arg )
501 consumer_sdl this = arg;
504 mlt_consumer consumer = &this->parent;
506 // internal intialization
509 // Obtain time of thread start
514 int64_t playtime = 0;
516 mlt_frame next = NULL;
517 mlt_frame frame = NULL;
518 mlt_properties properties = NULL;
520 if ( SDL_Init( SDL_INIT_VIDEO | SDL_INIT_AUDIO | SDL_INIT_NOPARACHUTE ) < 0 )
522 fprintf( stderr, "Failed to initialize SDL: %s\n", SDL_GetError() );
526 SDL_EnableKeyRepeat( SDL_DEFAULT_REPEAT_DELAY, SDL_DEFAULT_REPEAT_INTERVAL );
527 SDL_EnableUNICODE( 1 );
529 // Loop until told not to
530 while( this->running )
532 // Get a frame from the attached producer
533 frame = mlt_consumer_rt_frame( consumer );
535 // Ensure that we have a frame
538 // Get the frame properties
539 properties = mlt_frame_properties( frame );
542 init_audio = consumer_play_audio( this, frame, init_audio, &duration );
544 // Determine the start time now
545 if ( this->playing && start == 0 )
547 // Get the current time
548 gettimeofday( &now, NULL );
550 // Determine start time
551 start = ( int64_t )now.tv_sec * 1000000 + now.tv_usec;
554 // Set playtime for this frame
555 mlt_properties_set_position( properties, "playtime", playtime );
557 // Push this frame to the back of the queue
558 mlt_deque_push_back( this->queue, frame );
560 // Calculate the next playtime
561 playtime += ( duration * 1000 );
564 // Pop the next frame
565 next = mlt_deque_pop_front( this->queue );
567 while ( next != NULL && this->playing )
569 // Get the properties
570 properties = mlt_frame_properties( next );
572 // Get the current time
573 gettimeofday( &now, NULL );
575 // Get the elapsed time
576 elapsed = ( ( int64_t )now.tv_sec * 1000000 + now.tv_usec ) - start;
578 // See if we have to delay the display of the current frame
579 if ( mlt_properties_get_int( properties, "rendered" ) == 1 )
581 // Obtain the scheduled playout time
582 mlt_position scheduled = mlt_properties_get_position( properties, "playtime" );
584 // Determine the difference between the elapsed time and the scheduled playout time
585 mlt_position difference = scheduled - elapsed;
587 // If the frame is quite some way in the future, go get another
588 if ( difference > 80000 && mlt_deque_count( this->queue ) < 6 )
591 // Smooth playback a bit
592 if ( difference > 20000 && mlt_properties_get_double( properties, "_speed" ) == 1.0 )
594 tm.tv_sec = difference / 1000000;
595 tm.tv_nsec = ( difference % 1000000 ) * 1000;
596 nanosleep( &tm, NULL );
599 // Show current frame if not too old
600 if ( difference > -10000 || mlt_properties_get_double( properties, "_speed" ) != 1.0 )
601 consumer_play_video( this, next );
603 start = start - difference;
606 // This is an unrendered frame - just close it
607 mlt_frame_close( next );
609 // Pop the next frame
610 next = mlt_deque_pop_front( this->queue );
614 mlt_deque_push_front( this->queue, next );
618 if ( init_audio == 0 )
620 if ( this->sdl_overlay != NULL )
621 SDL_FreeYUVOverlay( this->sdl_overlay );
624 while( mlt_deque_count( this->queue ) )
625 mlt_frame_close( mlt_deque_pop_back( this->queue ) );
627 this->sdl_screen = NULL;
628 this->sdl_overlay = NULL;
629 this->audio_avail = 0;
634 static int consumer_get_dimensions( int *width, int *height )
638 // SDL windows manager structure
641 // Specify the SDL Version
642 SDL_VERSION( &wm.version );
644 // Get the wm structure
645 if ( SDL_GetWMInfo( &wm ) == 1 )
647 // Check that we have the X11 wm
648 if ( wm.subsystem == SDL_SYSWM_X11 )
650 // Get the SDL window
651 Window window = wm.info.x11.window;
653 // Get the display session
654 Display *display = wm.info.x11.display;
656 // Get the window attributes
657 XWindowAttributes attr;
658 XGetWindowAttributes( display, window, &attr );
660 // Determine whether window has changed
661 changed = *width != attr.width || *height != attr.height;
663 // Return width and height
665 *height = attr.height;
672 /** Callback to allow override of the close method.
675 static void consumer_close( mlt_consumer parent )
677 // Get the actual object
678 consumer_sdl this = parent->child;
681 mlt_consumer_stop( parent );
684 mlt_deque_close( this->queue );
687 pthread_mutex_destroy( &this->audio_mutex );
688 pthread_cond_destroy( &this->audio_cond );
690 // Now clean up the rest
691 mlt_consumer_close( parent );
693 // Finally clean up this