2 * consumer_sdl_still.c -- A Simple DirectMedia Layer consumer
3 * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
4 * Author: Charles Yates
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;
50 double last_frame_aspect;
55 SDL_Surface *sdl_screen;
59 mlt_producer last_producer;
63 /** Forward references to static functions.
66 static int consumer_start( mlt_consumer parent );
67 static int consumer_stop( mlt_consumer parent );
68 static int consumer_is_stopped( mlt_consumer parent );
69 static void consumer_close( mlt_consumer parent );
70 static void *consumer_thread( void * );
71 static int consumer_get_dimensions( int *width, int *height );
72 static void consumer_sdl_event( mlt_listener listener, mlt_properties owner, mlt_service this, void **args );
74 /** This is what will be called by the factory - anything can be passed in
75 via the argument, but keep it simple.
78 mlt_consumer consumer_sdl_still_init( char *arg )
80 // Create the consumer object
81 consumer_sdl this = calloc( sizeof( struct consumer_sdl_s ), 1 );
83 // If no malloc'd and consumer init ok
84 if ( this != NULL && mlt_consumer_init( &this->parent, this ) == 0 )
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 // Default scaler (for now we'll use nearest)
97 mlt_properties_set( this->properties, "rescale", "nearest" );
99 // We're always going to run this in non-realtime mode
100 mlt_properties_set( this->properties, "real_time", "0" );
102 // Default progressive true
103 mlt_properties_set_int( this->properties, "progressive", 1 );
105 // Get sample aspect ratio
106 this->aspect_ratio = mlt_properties_get_double( this->properties, "aspect_ratio" );
108 // Ensure we don't join on a non-running object
111 // Default display aspect ratio
112 this->display_aspect = 4.0 / 3.0;
114 // process actual param
115 if ( arg == NULL || sscanf( arg, "%dx%d", &this->width, &this->height ) != 2 )
117 this->width = mlt_properties_get_int( this->properties, "width" );
118 this->height = mlt_properties_get_int( this->properties, "height" );
121 // Default window size
122 this->window_width = ( float )this->height * this->display_aspect;
123 this->window_height = this->height;
126 //this->sdl_flags = SDL_HWSURFACE | SDL_ASYNCBLIT | SDL_HWACCEL | SDL_RESIZABLE | SDL_DOUBLEBUF;
127 // Experimental settings
128 this->sdl_flags = SDL_RESIZABLE | SDL_DOUBLEBUF;
130 // Allow thread to be started/stopped
131 parent->start = consumer_start;
132 parent->stop = consumer_stop;
133 parent->is_stopped = consumer_is_stopped;
135 // Register specific events
136 mlt_events_register( this->properties, "consumer-sdl-event", ( mlt_transmitter )consumer_sdl_event );
138 // Return the consumer produced
142 // malloc or consumer init failed
149 static void consumer_sdl_event( mlt_listener listener, mlt_properties owner, mlt_service this, void **args )
151 if ( listener != NULL )
152 listener( owner, this, ( SDL_Event * )args[ 0 ] );
155 static int consumer_start( mlt_consumer parent )
157 consumer_sdl this = parent->child;
159 if ( !this->running )
161 pthread_attr_t thread_attributes;
163 // Attach a colour space converter
164 if ( !this->filtered )
166 mlt_filter filter = mlt_factory_filter( "avcolour_space", NULL );
167 mlt_properties_set_int( MLT_FILTER_PROPERTIES( filter ), "forced", mlt_image_yuv422 );
168 mlt_service_attach( MLT_CONSUMER_SERVICE( parent ), filter );
169 mlt_filter_close( filter );
173 consumer_stop( parent );
175 this->last_position = -1;
179 // Allow the user to force resizing to window size
180 if ( mlt_properties_get_int( this->properties, "resize" ) )
182 mlt_properties_set_int( this->properties, "width", this->width );
183 mlt_properties_set_int( this->properties, "height", this->height );
186 //this->width = this->height * this->display_aspect;
188 // Inherit the scheduling priority
189 pthread_attr_init( &thread_attributes );
190 pthread_attr_setinheritsched( &thread_attributes, PTHREAD_INHERIT_SCHED );
192 pthread_create( &this->thread, &thread_attributes, consumer_thread, this );
198 static int consumer_stop( mlt_consumer parent )
200 // Get the actual object
201 consumer_sdl this = parent->child;
203 if ( this->joined == 0 )
205 // Kill the thread and clean up
208 pthread_join( this->thread, NULL );
215 static int consumer_is_stopped( mlt_consumer parent )
217 consumer_sdl this = parent->child;
218 return !this->running;
221 static int sdl_lock_display( )
223 SDL_Surface *screen = SDL_GetVideoSurface( );
224 return screen != NULL && ( !SDL_MUSTLOCK( screen ) || SDL_LockSurface( screen ) >= 0 );
227 static void sdl_unlock_display( )
229 SDL_Surface *screen = SDL_GetVideoSurface( );
230 if ( screen != NULL && SDL_MUSTLOCK( screen ) )
231 SDL_UnlockSurface( screen );
234 static inline void display_1( SDL_Surface *screen, SDL_Rect rect, uint8_t *image, int width, int height )
236 // Generate the affine transform scaling values
237 int scale_width = ( width << 16 ) / rect.w;
238 int scale_height = ( height << 16 ) / rect.h;
239 int stride = width * 3;
243 // Constants defined for clarity and optimisation
244 int scanlength = screen->pitch;
245 uint8_t *start = ( uint8_t * )screen->pixels + rect.y * scanlength + rect.x;
248 // Iterate through the screen using a very basic scaling algorithm
249 for ( y = 0; y < rect.h; y ++ )
252 row_index = ( scale_height * y ) >> 16;
253 row = image + stride * row_index;
254 for ( x = 0; x < rect.w; x ++ )
256 q = row + ( ( ( scale_width * x ) >> 16 ) * 3 );
257 *p ++ = SDL_MapRGB( screen->format, *q, *( q + 1 ), *( q + 2 ) );
263 static inline void display_2( SDL_Surface *screen, SDL_Rect rect, uint8_t *image, int width, int height )
265 // Generate the affine transform scaling values
266 int scale_width = ( width << 16 ) / rect.w;
267 int scale_height = ( height << 16 ) / rect.h;
268 int stride = width * 3;
272 // Constants defined for clarity and optimisation
273 int scanlength = screen->pitch / 2;
274 uint16_t *start = ( uint16_t * )screen->pixels + rect.y * scanlength + rect.x;
277 // Iterate through the screen using a very basic scaling algorithm
278 for ( y = 0; y < rect.h; y ++ )
281 row_index = ( scale_height * y ) >> 16;
282 row = image + stride * row_index;
283 for ( x = 0; x < rect.w; x ++ )
285 q = row + ( ( ( scale_width * x ) >> 16 ) * 3 );
286 *p ++ = SDL_MapRGB( screen->format, *q, *( q + 1 ), *( q + 2 ) );
292 static inline void display_3( SDL_Surface *screen, SDL_Rect rect, uint8_t *image, int width, int height )
294 // Generate the affine transform scaling values
295 int scale_width = ( width << 16 ) / rect.w;
296 int scale_height = ( height << 16 ) / rect.h;
297 int stride = width * 3;
301 // Constants defined for clarity and optimisation
302 int scanlength = screen->pitch;
303 uint8_t *start = ( uint8_t * )screen->pixels + rect.y * scanlength + rect.x;
307 // Iterate through the screen using a very basic scaling algorithm
308 for ( y = 0; y < rect.h; y ++ )
311 row_index = ( scale_height * y ) >> 16;
312 row = image + stride * row_index;
313 for ( x = 0; x < rect.w; x ++ )
315 q = row + ( ( ( scale_width * x ) >> 16 ) * 3 );
316 pixel = SDL_MapRGB( screen->format, *q, *( q + 1 ), *( q + 2 ) );
317 *p ++ = (pixel & 0xFF0000) >> 16;
318 *p ++ = (pixel & 0x00FF00) >> 8;
319 *p ++ = (pixel & 0x0000FF);
325 static inline void display_4( SDL_Surface *screen, SDL_Rect rect, uint8_t *image, int width, int height )
327 // Generate the affine transform scaling values
328 int scale_width = ( width << 16 ) / rect.w;
329 int scale_height = ( height << 16 ) / rect.h;
330 int stride = width * 3;
334 // Constants defined for clarity and optimisation
335 int scanlength = screen->pitch / 4;
336 uint32_t *start = ( uint32_t * )screen->pixels + rect.y * scanlength + rect.x;
339 // Iterate through the screen using a very basic scaling algorithm
340 for ( y = 0; y < rect.h; y ++ )
343 row_index = ( scale_height * y ) >> 16;
344 row = image + stride * row_index;
345 for ( x = 0; x < rect.w; x ++ )
347 q = row + ( ( ( scale_width * x ) >> 16 ) * 3 );
348 *p ++ = SDL_MapRGB( screen->format, *q, *( q + 1 ), *( q + 2 ) );
354 static int consumer_play_video( consumer_sdl this, mlt_frame frame )
356 // Get the properties of this consumer
357 mlt_properties properties = this->properties;
359 mlt_image_format vfmt = mlt_image_rgb24;
360 int height = this->height;
361 int width = this->width;
362 uint8_t *image = NULL;
365 void ( *lock )( void ) = mlt_properties_get_data( properties, "app_lock", NULL );
366 void ( *unlock )( void ) = mlt_properties_get_data( properties, "app_unlock", NULL );
368 if ( lock != NULL ) lock( );
373 if ( this->sdl_screen != NULL )
377 changed = consumer_get_dimensions( &this->window_width, &this->window_height );
379 while ( SDL_PollEvent( &event ) )
381 mlt_events_fire( this->properties, "consumer-sdl-event", &event, NULL );
385 case SDL_VIDEORESIZE:
386 this->window_width = event.resize.w;
387 this->window_height = event.resize.h;
395 mlt_producer producer = mlt_properties_get_data( properties, "transport_producer", NULL );
396 char keyboard[ 2 ] = " ";
397 void (*callback)( mlt_producer, char * ) = mlt_properties_get_data( properties, "transport_callback", NULL );
398 if ( callback != NULL && producer != NULL && event.key.keysym.unicode < 0x80 && event.key.keysym.unicode > 0 )
400 keyboard[ 0 ] = ( char )event.key.keysym.unicode;
401 callback( producer, keyboard );
409 if ( this->sdl_screen == NULL || changed || mlt_properties_get_int( properties, "changed" ) == 2 )
412 this->sdl_screen = SDL_SetVideoMode( this->window_width, this->window_height, 0, this->sdl_flags );
413 if ( consumer_get_dimensions( &this->window_width, &this->window_height ) )
414 this->sdl_screen = SDL_SetVideoMode( this->window_width, this->window_height, 0, this->sdl_flags );
417 mlt_properties_set_int( properties, "changed", 0 );
421 changed = mlt_properties_get_int( properties, "changed" ) | mlt_properties_get_int( MLT_FRAME_PROPERTIES( frame ), "refresh" );
422 mlt_properties_set_int( properties, "changed", 0 );
427 this->last_position == mlt_frame_get_position( frame ) &&
428 this->last_producer == mlt_properties_get_data( MLT_FRAME_PROPERTIES( frame ), "_producer", NULL ) )
430 sdl_unlock_display( );
431 if ( unlock != NULL )
436 // Update last frame shown info
437 this->last_position = mlt_frame_get_position( frame );
438 this->last_producer = mlt_properties_get_data( MLT_FRAME_PROPERTIES( frame ), "_producer", NULL );
440 // Get the image, width and height
443 mlt_events_fire( properties, "consumer-frame-show", frame, NULL );
445 // I would like to provide upstream scaling here, but this is incorrect
446 // Something? (or everything?) is too sensitive to aspect ratio
447 //width = this->rect.w;
448 //height = this->rect.h;
449 //mlt_properties_set( MLT_FRAME_PROPERTIES( frame ), "distort", "true" );
450 //mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "normalised_width", width );
451 //mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "normalised_height", height );
453 mlt_frame_get_image( frame, &image, &vfmt, &width, &height, 0 );
458 char *rescale = mlt_properties_get( properties, "rescale" );
459 if ( rescale != NULL && strcmp( rescale, "none" ) )
461 float this_aspect = this->display_aspect / ( ( float )this->window_width / ( float )this->window_height );
462 this->rect.w = this_aspect * this->window_width;
463 this->rect.h = this->window_height;
464 if ( this->rect.w > this->window_width )
466 this->rect.w = this->window_width;
467 this->rect.h = ( 1.0 / this_aspect ) * this->window_height;
472 float frame_aspect = mlt_frame_get_aspect_ratio( frame ) * width / height;
473 this->rect.w = frame_aspect * this->window_height;
474 this->rect.h = this->window_height;
475 if ( this->rect.w > this->window_width )
477 this->rect.w = this->window_width;
478 this->rect.h = ( 1.0 / frame_aspect ) * this->window_width;
482 this->rect.x = ( this->window_width - this->rect.w ) / 2;
483 this->rect.y = ( this->window_height - this->rect.h ) / 2;
485 mlt_properties_set_int( this->properties, "rect_x", this->rect.x );
486 mlt_properties_set_int( this->properties, "rect_y", this->rect.y );
487 mlt_properties_set_int( this->properties, "rect_w", this->rect.w );
488 mlt_properties_set_int( this->properties, "rect_h", this->rect.h );
491 if ( !mlt_consumer_is_stopped( &this->parent ) && SDL_GetVideoSurface( ) != NULL && this->sdl_screen != NULL && this->sdl_screen->pixels != NULL )
493 memset( this->sdl_screen->pixels, 0, this->window_width * this->window_height * this->sdl_screen->format->BytesPerPixel );
495 switch( this->sdl_screen->format->BytesPerPixel )
498 display_1( this->sdl_screen, this->rect, image, width, height );
501 display_2( this->sdl_screen, this->rect, image, width, height );
504 display_3( this->sdl_screen, this->rect, image, width, height );
507 display_4( this->sdl_screen, this->rect, image, width, height );
510 fprintf( stderr, "Unsupported video depth %d\n", this->sdl_screen->format->BytesPerPixel );
514 // Flip it into sight
515 SDL_Flip( this->sdl_screen );
518 sdl_unlock_display();
520 if ( unlock != NULL ) unlock( );
525 /** Threaded wrapper for pipe.
528 static void *consumer_thread( void *arg )
531 consumer_sdl this = arg;
534 mlt_consumer consumer = &this->parent;
536 // internal intialization
537 mlt_frame frame = NULL;
538 struct timespec tm = { 0, 10000000 };
540 if ( mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( consumer ), "sdl_started" ) == 0 )
542 if ( SDL_Init( SDL_INIT_VIDEO | SDL_INIT_NOPARACHUTE ) < 0 )
544 fprintf( stderr, "Failed to initialize SDL: %s\n", SDL_GetError() );
548 SDL_EnableKeyRepeat( SDL_DEFAULT_REPEAT_DELAY, SDL_DEFAULT_REPEAT_INTERVAL );
549 SDL_EnableUNICODE( 1 );
553 mlt_properties_set_int( MLT_CONSUMER_PROPERTIES( consumer ), "changed", 2 );
554 if ( SDL_GetVideoSurface( ) != NULL )
556 this->sdl_screen = SDL_GetVideoSurface( );
557 consumer_get_dimensions( &this->window_width, &this->window_height );
558 mlt_properties_set_int( MLT_CONSUMER_PROPERTIES( consumer ), "changed", 0 );
562 // Loop until told not to
563 while( this->running )
565 // Get a frame from the attached producer
566 frame = mlt_consumer_rt_frame( consumer );
568 // Ensure that we have a frame
571 if ( consumer_play_video( this, frame ) == 0 )
572 nanosleep( &tm, NULL );
573 mlt_frame_close( frame );
577 if ( mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( consumer ), "sdl_started" ) == 0 )
580 this->sdl_screen = NULL;
585 static int consumer_get_dimensions( int *width, int *height )
589 // SDL windows manager structure
592 // Specify the SDL Version
593 SDL_VERSION( &wm.version );
595 // Get the wm structure
596 if ( SDL_GetWMInfo( &wm ) == 1 )
598 // Check that we have the X11 wm
599 if ( wm.subsystem == SDL_SYSWM_X11 )
601 // Get the SDL window
602 Window window = wm.info.x11.window;
604 // Get the display session
605 Display *display = wm.info.x11.display;
607 // Get the window attributes
608 XWindowAttributes attr;
609 XGetWindowAttributes( display, window, &attr );
611 // Determine whether window has changed
612 changed = *width != attr.width || *height != attr.height;
614 // Return width and height
616 *height = attr.height;
623 /** Callback to allow override of the close method.
626 static void consumer_close( mlt_consumer parent )
628 // Get the actual object
629 consumer_sdl this = parent->child;
632 mlt_consumer_stop( parent );
634 // Now clean up the rest
635 mlt_consumer_close( parent );
637 // Finally clean up this