Prevent potential divide-by-zero errors in sdl_still consumer.
[melted] / src / modules / sdl / consumer_sdl_still.c
1 /*
2 * consumer_sdl_still.c -- A Simple DirectMedia Layer consumer
3 * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
4 * Author: Charles Yates
5 *
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.
10 *
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.
15 *
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
19 */
20
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 <stdio.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include <pthread.h>
30 #include <SDL/SDL.h>
31 #include <SDL/SDL_syswm.h>
32 #include <sys/time.h>
33
34 /** This classes definition.
35 */
36
37 typedef struct consumer_sdl_s *consumer_sdl;
38
39 struct consumer_sdl_s
40 {
41 struct mlt_consumer_s parent;
42 mlt_properties properties;
43 pthread_t thread;
44 int joined;
45 int running;
46 int window_width;
47 int window_height;
48 int width;
49 int height;
50 int playing;
51 int sdl_flags;
52 SDL_Surface *sdl_screen;
53 SDL_Rect rect;
54 uint8_t *buffer;
55 int last_position;
56 mlt_producer last_producer;
57 int filtered;
58 };
59
60 /** Forward references to static functions.
61 */
62
63 static int consumer_start( mlt_consumer parent );
64 static int consumer_stop( mlt_consumer parent );
65 static int consumer_is_stopped( mlt_consumer parent );
66 static void consumer_close( mlt_consumer parent );
67 static void *consumer_thread( void * );
68 static int consumer_get_dimensions( int *width, int *height );
69 static void consumer_sdl_event( mlt_listener listener, mlt_properties owner, mlt_service this, void **args );
70
71 /** This is what will be called by the factory - anything can be passed in
72 via the argument, but keep it simple.
73 */
74
75 mlt_consumer consumer_sdl_still_init( mlt_profile profile, mlt_service_type type, const char *id, char *arg )
76 {
77 // Create the consumer object
78 consumer_sdl this = calloc( sizeof( struct consumer_sdl_s ), 1 );
79
80 // If no malloc'd and consumer init ok
81 if ( this != NULL && mlt_consumer_init( &this->parent, this, profile ) == 0 )
82 {
83 // Get the parent consumer object
84 mlt_consumer parent = &this->parent;
85
86 // get a handle on properties
87 mlt_service service = MLT_CONSUMER_SERVICE( parent );
88 this->properties = MLT_SERVICE_PROPERTIES( service );
89
90 // We have stuff to clean up, so override the close method
91 parent->close = consumer_close;
92
93 // Default scaler (for now we'll use nearest)
94 mlt_properties_set( this->properties, "rescale", "nearest" );
95
96 // We're always going to run this in non-realtime mode
97 mlt_properties_set( this->properties, "real_time", "0" );
98
99 // Default progressive true
100 mlt_properties_set_int( this->properties, "progressive", 1 );
101
102 // Ensure we don't join on a non-running object
103 this->joined = 1;
104
105 // process actual param
106 if ( arg == NULL || sscanf( arg, "%dx%d", &this->width, &this->height ) != 2 )
107 {
108 this->width = mlt_properties_get_int( this->properties, "width" );
109 this->height = mlt_properties_get_int( this->properties, "height" );
110 }
111 else
112 {
113 mlt_properties_set_int( this->properties, "width", this->width );
114 mlt_properties_set_int( this->properties, "height", this->height );
115 }
116
117 // Set the sdl flags
118 this->sdl_flags = SDL_HWSURFACE | SDL_ASYNCBLIT | SDL_HWACCEL | SDL_RESIZABLE | SDL_DOUBLEBUF;
119
120 // Allow thread to be started/stopped
121 parent->start = consumer_start;
122 parent->stop = consumer_stop;
123 parent->is_stopped = consumer_is_stopped;
124
125 // Register specific events
126 mlt_events_register( this->properties, "consumer-sdl-event", ( mlt_transmitter )consumer_sdl_event );
127
128 // Return the consumer produced
129 return parent;
130 }
131
132 // malloc or consumer init failed
133 free( this );
134
135 // Indicate failure
136 return NULL;
137 }
138
139 static void consumer_sdl_event( mlt_listener listener, mlt_properties owner, mlt_service this, void **args )
140 {
141 if ( listener != NULL )
142 listener( owner, this, ( SDL_Event * )args[ 0 ] );
143 }
144
145 static int consumer_start( mlt_consumer parent )
146 {
147 consumer_sdl this = parent->child;
148
149 if ( !this->running )
150 {
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" );
153
154 // Attach a colour space converter
155 if ( !this->filtered )
156 {
157 mlt_profile profile = mlt_service_profile( MLT_CONSUMER_SERVICE( parent ) );
158 mlt_filter filter = mlt_factory_filter( profile, "avcolour_space", NULL );
159 mlt_properties_set_int( MLT_FILTER_PROPERTIES( filter ), "forced", mlt_image_yuv422 );
160 mlt_service_attach( MLT_CONSUMER_SERVICE( parent ), filter );
161 mlt_filter_close( filter );
162 this->filtered = 1;
163 }
164
165 consumer_stop( parent );
166
167 this->last_position = -1;
168 this->running = 1;
169 this->joined = 0;
170
171 // Allow the user to force resizing to window size
172 this->width = mlt_properties_get_int( this->properties, "width" );
173 this->height = mlt_properties_get_int( this->properties, "height" );
174
175 // Default window size
176 double display_ratio = mlt_properties_get_double( this->properties, "display_ratio" );
177 this->window_width = ( double )this->height * display_ratio;
178 this->window_height = this->height;
179
180 if ( sdl_started == 0 && preview_off == 0 )
181 {
182 if ( SDL_Init( SDL_INIT_VIDEO | SDL_INIT_NOPARACHUTE ) < 0 )
183 {
184 fprintf( stderr, "Failed to initialize SDL: %s\n", SDL_GetError() );
185 return -1;
186 }
187
188 SDL_EnableKeyRepeat( SDL_DEFAULT_REPEAT_DELAY, SDL_DEFAULT_REPEAT_INTERVAL );
189 SDL_EnableUNICODE( 1 );
190 }
191 else if ( preview_off == 0 )
192 {
193 if ( SDL_GetVideoSurface( ) != NULL )
194 {
195 this->sdl_screen = SDL_GetVideoSurface( );
196 }
197 }
198
199 if ( this->sdl_screen == NULL && preview_off == 0 )
200 this->sdl_screen = SDL_SetVideoMode( this->window_width, this->window_height, 0, this->sdl_flags );
201
202 pthread_create( &this->thread, NULL, consumer_thread, this );
203 }
204
205 return 0;
206 }
207
208 static int consumer_stop( mlt_consumer parent )
209 {
210 // Get the actual object
211 consumer_sdl this = parent->child;
212
213 if ( this->joined == 0 )
214 {
215 int preview_off = mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( parent ), "preview_off" );
216 int sdl_started = mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( parent ), "sdl_started" );
217
218 // Kill the thread and clean up
219 this->running = 0;
220
221 pthread_join( this->thread, NULL );
222 this->joined = 1;
223
224 if ( sdl_started == 0 && preview_off == 0 )
225 SDL_Quit( );
226
227 this->sdl_screen = NULL;
228 }
229
230 return 0;
231 }
232
233 static int consumer_is_stopped( mlt_consumer parent )
234 {
235 consumer_sdl this = parent->child;
236 return !this->running;
237 }
238
239 static int sdl_lock_display( )
240 {
241 SDL_Surface *screen = SDL_GetVideoSurface( );
242 return screen != NULL && ( !SDL_MUSTLOCK( screen ) || SDL_LockSurface( screen ) >= 0 );
243 }
244
245 static void sdl_unlock_display( )
246 {
247 SDL_Surface *screen = SDL_GetVideoSurface( );
248 if ( screen != NULL && SDL_MUSTLOCK( screen ) )
249 SDL_UnlockSurface( screen );
250 }
251
252 static inline void display_1( SDL_Surface *screen, SDL_Rect rect, uint8_t *image, int width, int height )
253 {
254 // Generate the affine transform scaling values
255 if ( rect.w == 0 || rect.h == 0 ) return;
256 int scale_width = ( width << 16 ) / rect.w;
257 int scale_height = ( height << 16 ) / rect.h;
258 int stride = width * 3;
259 int x, y, row_index;
260 uint8_t *q, *row;
261
262 // Constants defined for clarity and optimisation
263 int scanlength = screen->pitch;
264 uint8_t *start = ( uint8_t * )screen->pixels + rect.y * scanlength + rect.x;
265 uint8_t *p;
266
267 // Iterate through the screen using a very basic scaling algorithm
268 for ( y = 0; y < rect.h; y ++ )
269 {
270 p = start;
271 row_index = ( 32768 + scale_height * y ) >> 16;
272 row = image + stride * row_index;
273 for ( x = 0; x < rect.w; x ++ )
274 {
275 q = row + ( ( ( 32768 + scale_width * x ) >> 16 ) * 3 );
276 *p ++ = SDL_MapRGB( screen->format, *q, *( q + 1 ), *( q + 2 ) );
277 }
278 start += scanlength;
279 }
280 }
281
282 static inline void display_2( SDL_Surface *screen, SDL_Rect rect, uint8_t *image, int width, int height )
283 {
284 // Generate the affine transform scaling values
285 if ( rect.w == 0 || rect.h == 0 ) return;
286 int scale_width = ( width << 16 ) / rect.w;
287 int scale_height = ( height << 16 ) / rect.h;
288 int stride = width * 3;
289 int x, y, row_index;
290 uint8_t *q, *row;
291
292 // Constants defined for clarity and optimisation
293 int scanlength = screen->pitch / 2;
294 uint16_t *start = ( uint16_t * )screen->pixels + rect.y * scanlength + rect.x;
295 uint16_t *p;
296
297 // Iterate through the screen using a very basic scaling algorithm
298 for ( y = 0; y < rect.h; y ++ )
299 {
300 p = start;
301 row_index = ( 32768 + scale_height * y ) >> 16;
302 row = image + stride * row_index;
303 for ( x = 0; x < rect.w; x ++ )
304 {
305 q = row + ( ( ( 32768 + scale_width * x ) >> 16 ) * 3 );
306 *p ++ = SDL_MapRGB( screen->format, *q, *( q + 1 ), *( q + 2 ) );
307 }
308 start += scanlength;
309 }
310 }
311
312 static inline void display_3( SDL_Surface *screen, SDL_Rect rect, uint8_t *image, int width, int height )
313 {
314 // Generate the affine transform scaling values
315 if ( rect.w == 0 || rect.h == 0 ) return;
316 int scale_width = ( width << 16 ) / rect.w;
317 int scale_height = ( height << 16 ) / rect.h;
318 int stride = width * 3;
319 int x, y, row_index;
320 uint8_t *q, *row;
321
322 // Constants defined for clarity and optimisation
323 int scanlength = screen->pitch;
324 uint8_t *start = ( uint8_t * )screen->pixels + rect.y * scanlength + rect.x;
325 uint8_t *p;
326 uint32_t pixel;
327
328 // Iterate through the screen using a very basic scaling algorithm
329 for ( y = 0; y < rect.h; y ++ )
330 {
331 p = start;
332 row_index = ( 32768 + scale_height * y ) >> 16;
333 row = image + stride * row_index;
334 for ( x = 0; x < rect.w; x ++ )
335 {
336 q = row + ( ( ( 32768 + scale_width * x ) >> 16 ) * 3 );
337 pixel = SDL_MapRGB( screen->format, *q, *( q + 1 ), *( q + 2 ) );
338 *p ++ = (pixel & 0xFF0000) >> 16;
339 *p ++ = (pixel & 0x00FF00) >> 8;
340 *p ++ = (pixel & 0x0000FF);
341 }
342 start += scanlength;
343 }
344 }
345
346 static inline void display_4( SDL_Surface *screen, SDL_Rect rect, uint8_t *image, int width, int height )
347 {
348 // Generate the affine transform scaling values
349 if ( rect.w == 0 || rect.h == 0 ) return;
350 int scale_width = ( width << 16 ) / rect.w;
351 int scale_height = ( height << 16 ) / rect.h;
352 int stride = width * 3;
353 int x, y, row_index;
354 uint8_t *q, *row;
355
356 // Constants defined for clarity and optimisation
357 int scanlength = screen->pitch / 4;
358 uint32_t *start = ( uint32_t * )screen->pixels + rect.y * scanlength + rect.x;
359 uint32_t *p;
360
361 // Iterate through the screen using a very basic scaling algorithm
362 for ( y = 0; y < rect.h; y ++ )
363 {
364 p = start;
365 row_index = ( 32768 + scale_height * y ) >> 16;
366 row = image + stride * row_index;
367 for ( x = 0; x < rect.w; x ++ )
368 {
369 q = row + ( ( ( 32768 + scale_width * x ) >> 16 ) * 3 );
370 *p ++ = SDL_MapRGB( screen->format, *q, *( q + 1 ), *( q + 2 ) );
371 }
372 start += scanlength;
373 }
374 }
375
376 static int consumer_play_video( consumer_sdl this, mlt_frame frame )
377 {
378 // Get the properties of this consumer
379 mlt_properties properties = this->properties;
380
381 mlt_image_format vfmt = mlt_image_rgb24;
382 int height = this->height;
383 int width = this->width;
384 uint8_t *image = NULL;
385 int changed = 0;
386 double display_ratio = mlt_properties_get_double( this->properties, "display_ratio" );
387
388 void ( *lock )( void ) = mlt_properties_get_data( properties, "app_lock", NULL );
389 void ( *unlock )( void ) = mlt_properties_get_data( properties, "app_unlock", NULL );
390
391 if ( lock != NULL ) lock( );
392
393 sdl_lock_display();
394
395 // Handle events
396 if ( this->sdl_screen != NULL )
397 {
398 SDL_Event event;
399
400 changed = consumer_get_dimensions( &this->window_width, &this->window_height );
401
402 while ( SDL_PollEvent( &event ) )
403 {
404 mlt_events_fire( this->properties, "consumer-sdl-event", &event, NULL );
405
406 switch( event.type )
407 {
408 case SDL_VIDEORESIZE:
409 this->window_width = event.resize.w;
410 this->window_height = event.resize.h;
411 changed = 1;
412 break;
413 case SDL_QUIT:
414 this->running = 0;
415 break;
416 case SDL_KEYDOWN:
417 {
418 mlt_producer producer = mlt_properties_get_data( properties, "transport_producer", NULL );
419 char keyboard[ 2 ] = " ";
420 void (*callback)( mlt_producer, char * ) = mlt_properties_get_data( properties, "transport_callback", NULL );
421 if ( callback != NULL && producer != NULL && event.key.keysym.unicode < 0x80 && event.key.keysym.unicode > 0 )
422 {
423 keyboard[ 0 ] = ( char )event.key.keysym.unicode;
424 callback( producer, keyboard );
425 }
426 }
427 break;
428 }
429 }
430 }
431
432 if ( this->sdl_screen == NULL || changed )
433 {
434 // open SDL window
435 this->sdl_screen = SDL_SetVideoMode( this->window_width, this->window_height, 0, this->sdl_flags );
436 if ( consumer_get_dimensions( &this->window_width, &this->window_height ) )
437 this->sdl_screen = SDL_SetVideoMode( this->window_width, this->window_height, 0, this->sdl_flags );
438 uint32_t color = mlt_properties_get_int( this->properties, "window_background" );
439 SDL_FillRect( this->sdl_screen, NULL, color >> 8 );
440 changed = 1;
441 }
442 else
443 {
444 changed = 1;
445 }
446
447 if ( changed == 0 &&
448 this->last_position == mlt_frame_get_position( frame ) &&
449 this->last_producer == mlt_properties_get_data( MLT_FRAME_PROPERTIES( frame ), "_producer", NULL ) )
450 {
451 sdl_unlock_display( );
452 if ( unlock != NULL ) unlock( );
453 return 0;
454 }
455
456 // Update last frame shown info
457 this->last_position = mlt_frame_get_position( frame );
458 this->last_producer = mlt_properties_get_data( MLT_FRAME_PROPERTIES( frame ), "_producer", NULL );
459
460 // Get the image, width and height
461 mlt_frame_get_image( frame, &image, &vfmt, &width, &height, 0 );
462 mlt_events_fire( properties, "consumer-frame-show", frame, NULL );
463
464 if ( image != NULL )
465 {
466 char *rescale = mlt_properties_get( properties, "rescale" );
467 if ( rescale != NULL && strcmp( rescale, "none" ) )
468 {
469 double this_aspect = display_ratio / ( ( double )this->window_width / ( double )this->window_height );
470 this->rect.w = this_aspect * this->window_width;
471 this->rect.h = this->window_height;
472 if ( this->rect.w > this->window_width )
473 {
474 this->rect.w = this->window_width;
475 this->rect.h = ( 1.0 / this_aspect ) * this->window_height;
476 }
477 }
478 else
479 {
480 double frame_aspect = mlt_frame_get_aspect_ratio( frame ) * width / height;
481 this->rect.w = frame_aspect * this->window_height;
482 this->rect.h = this->window_height;
483 if ( this->rect.w > this->window_width )
484 {
485 this->rect.w = this->window_width;
486 this->rect.h = ( 1.0 / frame_aspect ) * this->window_width;
487 }
488 }
489
490 this->rect.x = ( this->window_width - this->rect.w ) / 2;
491 this->rect.y = ( this->window_height - this->rect.h ) / 2;
492
493 mlt_properties_set_int( this->properties, "rect_x", this->rect.x );
494 mlt_properties_set_int( this->properties, "rect_y", this->rect.y );
495 mlt_properties_set_int( this->properties, "rect_w", this->rect.w );
496 mlt_properties_set_int( this->properties, "rect_h", this->rect.h );
497 }
498
499 if ( !mlt_consumer_is_stopped( &this->parent ) && SDL_GetVideoSurface( ) != NULL && this->sdl_screen != NULL && this->sdl_screen->pixels != NULL )
500 {
501 switch( this->sdl_screen->format->BytesPerPixel )
502 {
503 case 1:
504 display_1( this->sdl_screen, this->rect, image, width, height );
505 break;
506 case 2:
507 display_2( this->sdl_screen, this->rect, image, width, height );
508 break;
509 case 3:
510 display_3( this->sdl_screen, this->rect, image, width, height );
511 break;
512 case 4:
513 display_4( this->sdl_screen, this->rect, image, width, height );
514 break;
515 default:
516 fprintf( stderr, "Unsupported video depth %d\n", this->sdl_screen->format->BytesPerPixel );
517 break;
518 }
519
520 // Flip it into sight
521 SDL_Flip( this->sdl_screen );
522 }
523
524 sdl_unlock_display();
525
526 if ( unlock != NULL ) unlock( );
527
528 return 1;
529 }
530
531 /** Threaded wrapper for pipe.
532 */
533
534 static void *consumer_thread( void *arg )
535 {
536 // Identify the arg
537 consumer_sdl this = arg;
538
539 // Get the consumer
540 mlt_consumer consumer = &this->parent;
541 mlt_properties properties = MLT_CONSUMER_PROPERTIES( consumer );
542
543 // internal intialization
544 mlt_frame frame = NULL;
545 mlt_image_format vfmt = mlt_image_rgb24a;
546 int height = this->height;
547 int width = this->width;
548 uint8_t *image = NULL;
549
550 // Allow the hosting app to provide the preview
551 int preview_off = mlt_properties_get_int( properties, "preview_off" );
552 mlt_image_format preview_format = mlt_properties_get_int( properties, "preview_format" );
553
554 // Check if a specific colour space has been requested
555 if ( preview_off && preview_format != mlt_image_none )
556 vfmt = preview_format;
557
558 // Loop until told not to
559 while( this->running )
560 {
561 // Get a frame from the attached producer
562 frame = mlt_consumer_rt_frame( consumer );
563
564 // Ensure that we have a frame
565 if ( this->running && frame != NULL )
566 {
567 if ( preview_off == 0 )
568 {
569 consumer_play_video( this, frame );
570 }
571 else
572 {
573 mlt_frame_get_image( frame, &image, &vfmt, &width, &height, 0 );
574 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "format", vfmt );
575 mlt_events_fire( properties, "consumer-frame-show", frame, NULL );
576 }
577 mlt_frame_close( frame );
578 }
579 else
580 {
581 if ( frame ) mlt_frame_close( frame );
582 this->running = 0;
583 }
584 }
585
586 return NULL;
587 }
588
589 static int consumer_get_dimensions( int *width, int *height )
590 {
591 int changed = 0;
592
593 // SDL windows manager structure
594 SDL_SysWMinfo wm;
595
596 // Specify the SDL Version
597 SDL_VERSION( &wm.version );
598
599 // Get the wm structure
600 if ( SDL_GetWMInfo( &wm ) == 1 )
601 {
602 #ifndef __DARWIN__
603 // Check that we have the X11 wm
604 if ( wm.subsystem == SDL_SYSWM_X11 )
605 {
606 // Get the SDL window
607 Window window = wm.info.x11.window;
608
609 // Get the display session
610 Display *display = wm.info.x11.display;
611
612 // Get the window attributes
613 XWindowAttributes attr;
614 XGetWindowAttributes( display, window, &attr );
615
616 // Determine whether window has changed
617 changed = *width != attr.width || *height != attr.height;
618
619 // Return width and height
620 *width = attr.width;
621 *height = attr.height;
622 }
623 #endif
624 }
625
626 return changed;
627 }
628
629 /** Callback to allow override of the close method.
630 */
631
632 static void consumer_close( mlt_consumer parent )
633 {
634 // Get the actual object
635 consumer_sdl this = parent->child;
636
637 // Stop the consumer
638 mlt_consumer_stop( parent );
639
640 // Now clean up the rest
641 mlt_consumer_close( parent );
642
643 // Finally clean up this
644 free( this );
645 }