2 * consumer_sdl_still.c -- A Simple DirectMedia Layer consumer
3 * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
4 * Author: Charles Yates
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>
26 #include <framework/mlt_log.h>
32 #include <SDL/SDL_syswm.h>
34 #include "consumer_sdl_osx.h"
36 extern pthread_mutex_t mlt_sdl_mutex;
38 /** This classes definition.
41 typedef struct consumer_sdl_s *consumer_sdl;
45 struct mlt_consumer_s parent;
46 mlt_properties properties;
56 SDL_Surface *sdl_screen;
60 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( mlt_profile profile, mlt_service_type type, const char *id, 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, profile ) == 0 )
86 // Get the parent consumer object
87 mlt_consumer parent = &this->parent;
89 // get a handle on properties
90 mlt_service service = MLT_CONSUMER_SERVICE( parent );
91 this->properties = MLT_SERVICE_PROPERTIES( service );
93 // We have stuff to clean up, so override the close method
94 parent->close = consumer_close;
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 // Ensure we don't join on a non-running object
105 // process actual param
106 if ( arg == NULL || sscanf( arg, "%dx%d", &this->width, &this->height ) != 2 )
108 this->width = mlt_properties_get_int( this->properties, "width" );
109 this->height = mlt_properties_get_int( this->properties, "height" );
113 mlt_properties_set_int( this->properties, "width", this->width );
114 mlt_properties_set_int( this->properties, "height", this->height );
118 this->sdl_flags = SDL_HWSURFACE | SDL_ASYNCBLIT | SDL_HWACCEL | SDL_RESIZABLE | SDL_DOUBLEBUF;
120 // Allow thread to be started/stopped
121 parent->start = consumer_start;
122 parent->stop = consumer_stop;
123 parent->is_stopped = consumer_is_stopped;
125 // Register specific events
126 mlt_events_register( this->properties, "consumer-sdl-event", ( mlt_transmitter )consumer_sdl_event );
128 // Return the consumer produced
132 // malloc or consumer init failed
139 static void consumer_sdl_event( mlt_listener listener, mlt_properties owner, mlt_service this, void **args )
141 if ( listener != NULL )
142 listener( owner, this, ( SDL_Event * )args[ 0 ] );
145 static int consumer_start( mlt_consumer parent )
147 consumer_sdl this = parent->child;
149 if ( !this->running )
151 int preview_off = mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( parent ), "preview_off" );
152 int sdl_started = mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( parent ), "sdl_started" );
154 consumer_stop( parent );
156 this->last_position = -1;
160 // Allow the user to force resizing to window size
161 this->width = mlt_properties_get_int( this->properties, "width" );
162 this->height = mlt_properties_get_int( this->properties, "height" );
164 // Default window size
165 double display_ratio = mlt_properties_get_double( this->properties, "display_ratio" );
166 this->window_width = ( double )this->height * display_ratio;
167 this->window_height = this->height;
169 if ( sdl_started == 0 && preview_off == 0 )
171 if ( SDL_Init( SDL_INIT_VIDEO | SDL_INIT_NOPARACHUTE ) < 0 )
173 fprintf( stderr, "Failed to initialize SDL: %s\n", SDL_GetError() );
177 SDL_EnableKeyRepeat( SDL_DEFAULT_REPEAT_DELAY, SDL_DEFAULT_REPEAT_INTERVAL );
178 SDL_EnableUNICODE( 1 );
180 else if ( preview_off == 0 )
182 if ( SDL_GetVideoSurface( ) != NULL )
184 this->sdl_screen = SDL_GetVideoSurface( );
188 if ( this->sdl_screen == NULL && preview_off == 0 )
190 pthread_mutex_lock( &mlt_sdl_mutex );
191 this->sdl_screen = SDL_SetVideoMode( this->window_width, this->window_height, 0, this->sdl_flags );
192 pthread_mutex_unlock( &mlt_sdl_mutex );
195 pthread_create( &this->thread, NULL, consumer_thread, this );
201 static int consumer_stop( mlt_consumer parent )
203 // Get the actual object
204 consumer_sdl this = parent->child;
206 if ( this->joined == 0 )
208 int preview_off = mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( parent ), "preview_off" );
209 int sdl_started = mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( parent ), "sdl_started" );
211 // Kill the thread and clean up
214 pthread_join( this->thread, NULL );
217 if ( sdl_started == 0 && preview_off == 0 )
219 pthread_mutex_lock( &mlt_sdl_mutex );
221 pthread_mutex_unlock( &mlt_sdl_mutex );
224 this->sdl_screen = NULL;
230 static int consumer_is_stopped( mlt_consumer parent )
232 consumer_sdl this = parent->child;
233 return !this->running;
236 static int sdl_lock_display( )
238 pthread_mutex_lock( &mlt_sdl_mutex );
239 SDL_Surface *screen = SDL_GetVideoSurface( );
240 int result = screen != NULL && ( !SDL_MUSTLOCK( screen ) || SDL_LockSurface( screen ) >= 0 );
241 pthread_mutex_unlock( &mlt_sdl_mutex );
245 static void sdl_unlock_display( )
247 pthread_mutex_lock( &mlt_sdl_mutex );
248 SDL_Surface *screen = SDL_GetVideoSurface( );
249 if ( screen != NULL && SDL_MUSTLOCK( screen ) )
250 SDL_UnlockSurface( screen );
251 pthread_mutex_unlock( &mlt_sdl_mutex );
254 static inline void display_1( SDL_Surface *screen, SDL_Rect rect, uint8_t *image, int width, int height )
256 // Generate the affine transform scaling values
257 if ( rect.w == 0 || rect.h == 0 ) return;
258 int scale_width = ( width << 16 ) / rect.w;
259 int scale_height = ( height << 16 ) / rect.h;
260 int stride = width * 3;
264 // Constants defined for clarity and optimisation
265 int scanlength = screen->pitch;
266 uint8_t *start = ( uint8_t * )screen->pixels + rect.y * scanlength + rect.x;
269 // Iterate through the screen using a very basic scaling algorithm
270 for ( y = 0; y < rect.h; y ++ )
273 row_index = ( 32768 + scale_height * y ) >> 16;
274 row = image + stride * row_index;
275 for ( x = 0; x < rect.w; x ++ )
277 q = row + ( ( ( 32768 + scale_width * x ) >> 16 ) * 3 );
278 *p ++ = SDL_MapRGB( screen->format, *q, *( q + 1 ), *( q + 2 ) );
284 static inline void display_2( SDL_Surface *screen, SDL_Rect rect, uint8_t *image, int width, int height )
286 // Generate the affine transform scaling values
287 if ( rect.w == 0 || rect.h == 0 ) return;
288 int scale_width = ( width << 16 ) / rect.w;
289 int scale_height = ( height << 16 ) / rect.h;
290 int stride = width * 3;
294 // Constants defined for clarity and optimisation
295 int scanlength = screen->pitch / 2;
296 uint16_t *start = ( uint16_t * )screen->pixels + rect.y * scanlength + rect.x;
299 // Iterate through the screen using a very basic scaling algorithm
300 for ( y = 0; y < rect.h; y ++ )
303 row_index = ( 32768 + scale_height * y ) >> 16;
304 row = image + stride * row_index;
305 for ( x = 0; x < rect.w; x ++ )
307 q = row + ( ( ( 32768 + scale_width * x ) >> 16 ) * 3 );
308 *p ++ = SDL_MapRGB( screen->format, *q, *( q + 1 ), *( q + 2 ) );
314 static inline void display_3( SDL_Surface *screen, SDL_Rect rect, uint8_t *image, int width, int height )
316 // Generate the affine transform scaling values
317 if ( rect.w == 0 || rect.h == 0 ) return;
318 int scale_width = ( width << 16 ) / rect.w;
319 int scale_height = ( height << 16 ) / rect.h;
320 int stride = width * 3;
324 // Constants defined for clarity and optimisation
325 int scanlength = screen->pitch;
326 uint8_t *start = ( uint8_t * )screen->pixels + rect.y * scanlength + rect.x;
330 // Iterate through the screen using a very basic scaling algorithm
331 for ( y = 0; y < rect.h; y ++ )
334 row_index = ( 32768 + scale_height * y ) >> 16;
335 row = image + stride * row_index;
336 for ( x = 0; x < rect.w; x ++ )
338 q = row + ( ( ( 32768 + scale_width * x ) >> 16 ) * 3 );
339 pixel = SDL_MapRGB( screen->format, *q, *( q + 1 ), *( q + 2 ) );
340 *p ++ = (pixel & 0xFF0000) >> 16;
341 *p ++ = (pixel & 0x00FF00) >> 8;
342 *p ++ = (pixel & 0x0000FF);
348 static inline void display_4( SDL_Surface *screen, SDL_Rect rect, uint8_t *image, int width, int height )
350 // Generate the affine transform scaling values
351 if ( rect.w == 0 || rect.h == 0 ) return;
352 int scale_width = ( width << 16 ) / rect.w;
353 int scale_height = ( height << 16 ) / rect.h;
354 int stride = width * 3;
358 // Constants defined for clarity and optimisation
359 int scanlength = screen->pitch / 4;
360 uint32_t *start = ( uint32_t * )screen->pixels + rect.y * scanlength + rect.x;
363 // Iterate through the screen using a very basic scaling algorithm
364 for ( y = 0; y < rect.h; y ++ )
367 row_index = ( 32768 + scale_height * y ) >> 16;
368 row = image + stride * row_index;
369 for ( x = 0; x < rect.w; x ++ )
371 q = row + ( ( ( 32768 + scale_width * x ) >> 16 ) * 3 );
372 *p ++ = SDL_MapRGB( screen->format, *q, *( q + 1 ), *( q + 2 ) );
378 static int consumer_play_video( consumer_sdl this, mlt_frame frame )
380 // Get the properties of this consumer
381 mlt_properties properties = this->properties;
383 mlt_image_format vfmt = mlt_image_rgb24;
384 int height = this->height;
385 int width = this->width;
386 uint8_t *image = NULL;
388 double display_ratio = mlt_properties_get_double( this->properties, "display_ratio" );
390 void ( *lock )( void ) = mlt_properties_get_data( properties, "app_lock", NULL );
391 void ( *unlock )( void ) = mlt_properties_get_data( properties, "app_unlock", NULL );
393 if ( lock != NULL ) lock( );
394 void *pool = mlt_cocoa_autorelease_init();
398 if ( this->sdl_screen != NULL )
402 pthread_mutex_lock( &mlt_sdl_mutex );
403 changed = consumer_get_dimensions( &this->window_width, &this->window_height );
404 pthread_mutex_unlock( &mlt_sdl_mutex );
406 while ( SDL_PollEvent( &event ) )
408 mlt_events_fire( this->properties, "consumer-sdl-event", &event, NULL );
412 case SDL_VIDEORESIZE:
413 this->window_width = event.resize.w;
414 this->window_height = event.resize.h;
422 mlt_producer producer = mlt_properties_get_data( properties, "transport_producer", NULL );
423 char keyboard[ 2 ] = " ";
424 void (*callback)( mlt_producer, char * ) = mlt_properties_get_data( properties, "transport_callback", NULL );
425 if ( callback != NULL && producer != NULL && event.key.keysym.unicode < 0x80 && event.key.keysym.unicode > 0 )
427 keyboard[ 0 ] = ( char )event.key.keysym.unicode;
428 callback( producer, keyboard );
436 if ( this->sdl_screen == NULL || changed )
439 pthread_mutex_lock( &mlt_sdl_mutex );
440 this->sdl_screen = SDL_SetVideoMode( this->window_width, this->window_height, 0, this->sdl_flags );
441 if ( consumer_get_dimensions( &this->window_width, &this->window_height ) )
442 this->sdl_screen = SDL_SetVideoMode( this->window_width, this->window_height, 0, this->sdl_flags );
443 pthread_mutex_unlock( &mlt_sdl_mutex );
445 uint32_t color = mlt_properties_get_int( this->properties, "window_background" );
446 SDL_FillRect( this->sdl_screen, NULL, color >> 8 );
451 this->last_position == mlt_frame_get_position( frame ) &&
452 this->last_producer == mlt_frame_get_original_producer( frame ) &&
453 !mlt_properties_get_int( MLT_FRAME_PROPERTIES( frame ), "refresh" ) )
455 sdl_unlock_display( );
456 mlt_cocoa_autorelease_close( pool );
457 if ( unlock != NULL ) unlock( );
458 struct timespec tm = { 0, 100000 };
459 nanosleep( &tm, NULL );
463 // Update last frame shown info
464 this->last_position = mlt_frame_get_position( frame );
465 this->last_producer = mlt_frame_get_original_producer( frame );
467 // Get the image, width and height
468 mlt_frame_get_image( frame, &image, &vfmt, &width, &height, 0 );
469 mlt_events_fire( properties, "consumer-frame-show", frame, NULL );
473 char *rescale = mlt_properties_get( properties, "rescale" );
474 if ( rescale != NULL && strcmp( rescale, "none" ) )
476 double this_aspect = display_ratio / ( ( double )this->window_width / ( double )this->window_height );
477 this->rect.w = this_aspect * this->window_width;
478 this->rect.h = this->window_height;
479 if ( this->rect.w > this->window_width )
481 this->rect.w = this->window_width;
482 this->rect.h = ( 1.0 / this_aspect ) * this->window_height;
487 double frame_aspect = mlt_frame_get_aspect_ratio( frame ) * width / height;
488 this->rect.w = frame_aspect * this->window_height;
489 this->rect.h = this->window_height;
490 if ( this->rect.w > this->window_width )
492 this->rect.w = this->window_width;
493 this->rect.h = ( 1.0 / frame_aspect ) * this->window_width;
497 this->rect.x = ( this->window_width - this->rect.w ) / 2;
498 this->rect.y = ( this->window_height - this->rect.h ) / 2;
500 mlt_properties_set_int( this->properties, "rect_x", this->rect.x );
501 mlt_properties_set_int( this->properties, "rect_y", this->rect.y );
502 mlt_properties_set_int( this->properties, "rect_w", this->rect.w );
503 mlt_properties_set_int( this->properties, "rect_h", this->rect.h );
506 if ( !mlt_consumer_is_stopped( &this->parent ) && SDL_GetVideoSurface( ) != NULL && this->sdl_screen != NULL && this->sdl_screen->pixels != NULL )
508 switch( this->sdl_screen->format->BytesPerPixel )
511 display_1( this->sdl_screen, this->rect, image, width, height );
514 display_2( this->sdl_screen, this->rect, image, width, height );
517 display_3( this->sdl_screen, this->rect, image, width, height );
520 display_4( this->sdl_screen, this->rect, image, width, height );
523 fprintf( stderr, "Unsupported video depth %d\n", this->sdl_screen->format->BytesPerPixel );
527 // Flip it into sight
528 pthread_mutex_lock( &mlt_sdl_mutex );
529 SDL_Flip( this->sdl_screen );
530 pthread_mutex_unlock( &mlt_sdl_mutex );
533 sdl_unlock_display();
534 mlt_cocoa_autorelease_close( pool );
535 if ( unlock != NULL ) unlock( );
540 /** Threaded wrapper for pipe.
543 static void *consumer_thread( void *arg )
546 consumer_sdl this = arg;
549 mlt_consumer consumer = &this->parent;
550 mlt_properties properties = MLT_CONSUMER_PROPERTIES( consumer );
551 mlt_frame frame = NULL;
553 // Allow the hosting app to provide the preview
554 int preview_off = mlt_properties_get_int( properties, "preview_off" );
556 // Loop until told not to
557 while( this->running )
559 // Get a frame from the attached producer
560 frame = mlt_consumer_rt_frame( consumer );
562 // Ensure that we have a frame
563 if ( this->running && frame != NULL )
565 if ( preview_off == 0 )
567 consumer_play_video( this, frame );
571 mlt_image_format vfmt = mlt_image_rgb24a;
572 int height = this->height;
573 int width = this->width;
574 uint8_t *image = NULL;
575 mlt_image_format preview_format = mlt_properties_get_int( properties, "preview_format" );
577 // Check if a specific colour space has been requested
578 if ( preview_off && preview_format != mlt_image_none )
579 vfmt = preview_format;
581 mlt_frame_get_image( frame, &image, &vfmt, &width, &height, 0 );
582 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "format", vfmt );
583 mlt_events_fire( properties, "consumer-frame-show", frame, NULL );
585 mlt_frame_close( frame );
589 if ( frame ) mlt_frame_close( frame );
597 static int consumer_get_dimensions( int *width, int *height )
601 // SDL windows manager structure
604 // Specify the SDL Version
605 SDL_VERSION( &wm.version );
607 // Get the wm structure
608 if ( SDL_GetWMInfo( &wm ) == 1 )
611 // Check that we have the X11 wm
612 if ( wm.subsystem == SDL_SYSWM_X11 )
614 // Get the SDL window
615 Window window = wm.info.x11.window;
617 // Get the display session
618 Display *display = wm.info.x11.display;
620 // Get the window attributes
621 XWindowAttributes attr;
622 XGetWindowAttributes( display, window, &attr );
624 // Determine whether window has changed
625 changed = *width != attr.width || *height != attr.height;
627 // Return width and height
629 *height = attr.height;
637 /** Callback to allow override of the close method.
640 static void consumer_close( mlt_consumer parent )
642 // Get the actual object
643 consumer_sdl this = parent->child;
646 mlt_consumer_stop( parent );
648 // Now clean up the rest
649 mlt_consumer_close( parent );
651 // Finally clean up this