]> git.sesse.net Git - mlt/blob - src/modules/sdl/consumer_sdl_still.c
Attempt at an aspect ratio clean up
[mlt] / 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 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.
10  *
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.
15  *
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.
19  */
20
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>
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         float aspect_ratio;
49         float display_aspect;
50         double last_frame_aspect;
51         int width;
52         int height;
53         int playing;
54         int sdl_flags;
55         SDL_Surface *sdl_screen;
56         SDL_Rect rect;
57         uint8_t *buffer;
58         int last_position;
59         mlt_producer last_producer;
60 };
61
62 /** Forward references to static functions.
63 */
64
65 static int consumer_start( mlt_consumer parent );
66 static int consumer_stop( mlt_consumer parent );
67 static int consumer_is_stopped( mlt_consumer parent );
68 static void consumer_close( mlt_consumer parent );
69 static void *consumer_thread( void * );
70 static int consumer_get_dimensions( int *width, int *height );
71 static void consumer_sdl_event( mlt_listener listener, mlt_properties owner, mlt_service this, void **args );
72
73 /** This is what will be called by the factory - anything can be passed in
74         via the argument, but keep it simple.
75 */
76
77 mlt_consumer consumer_sdl_still_init( char *arg )
78 {
79         // Create the consumer object
80         consumer_sdl this = calloc( sizeof( struct consumer_sdl_s ), 1 );
81
82         // If no malloc'd and consumer init ok
83         if ( this != NULL && mlt_consumer_init( &this->parent, this ) == 0 )
84         {
85                 // Get the parent consumer object
86                 mlt_consumer parent = &this->parent;
87
88                 // Attach a colour space converter
89                 mlt_filter filter = mlt_factory_filter( "avcolour_space", NULL );
90                 mlt_properties_set_int( mlt_filter_properties( filter ), "forced", mlt_image_yuv422 );
91                 mlt_service_attach( mlt_consumer_service( &this->parent ), filter );
92                 mlt_filter_close( filter );
93
94                 // We have stuff to clean up, so override the close method
95                 parent->close = consumer_close;
96
97                 // get a handle on properties
98                 mlt_service service = mlt_consumer_service( parent );
99                 this->properties = mlt_service_properties( service );
100
101                 // Default scaler (for now we'll use nearest)
102                 mlt_properties_set( this->properties, "rescale", "nearest" );
103
104                 // We're always going to run this in non-realtime mode
105                 mlt_properties_set( this->properties, "real_time", "0" );
106
107                 // Default progressive true
108                 mlt_properties_set_int( this->properties, "progressive", 1 );
109
110                 // Get sample aspect ratio
111                 this->aspect_ratio = mlt_properties_get_double( this->properties, "aspect_ratio" );
112
113                 // Ensure we don't join on a non-running object
114                 this->joined = 1;
115                 
116                 // Default display aspect ratio
117                 this->display_aspect = 4.0 / 3.0;
118                 
119                 // process actual param
120                 if ( arg == NULL || sscanf( arg, "%dx%d", &this->width, &this->height ) != 2 )
121                 {
122                         this->width = mlt_properties_get_int( this->properties, "width" );
123                         this->height = mlt_properties_get_int( this->properties, "height" );
124                 }
125
126                 // Default window size
127                 this->window_width = ( float )this->height * this->display_aspect;
128                 this->window_height = this->height;
129
130                 // Set the sdl flags
131                 this->sdl_flags = SDL_HWSURFACE | SDL_ASYNCBLIT | SDL_HWACCEL | SDL_RESIZABLE | SDL_DOUBLEBUF;
132
133                 // Allow thread to be started/stopped
134                 parent->start = consumer_start;
135                 parent->stop = consumer_stop;
136                 parent->is_stopped = consumer_is_stopped;
137
138                 // Register specific events
139                 mlt_events_register( this->properties, "consumer-sdl-event", ( mlt_transmitter )consumer_sdl_event );
140
141                 // Return the consumer produced
142                 return parent;
143         }
144
145         // malloc or consumer init failed
146         free( this );
147
148         // Indicate failure
149         return NULL;
150 }
151
152 static void consumer_sdl_event( mlt_listener listener, mlt_properties owner, mlt_service this, void **args )
153 {
154         if ( listener != NULL )
155                 listener( owner, this, ( SDL_Event * )args[ 0 ] );
156 }
157
158 static int consumer_start( mlt_consumer parent )
159 {
160         consumer_sdl this = parent->child;
161
162         if ( !this->running )
163         {
164                 pthread_attr_t thread_attributes;
165                 
166                 consumer_stop( parent );
167
168                 this->last_position = -1;
169                 this->running = 1;
170                 this->joined = 0;
171
172                 // Allow the user to force resizing to window size
173                 if ( mlt_properties_get_int( this->properties, "resize" ) )
174                 {
175                         mlt_properties_set_int( this->properties, "width", this->width );
176                         mlt_properties_set_int( this->properties, "height", this->height );
177                 }
178
179                 //this->width = this->height * this->display_aspect;
180
181                 // Inherit the scheduling priority
182                 pthread_attr_init( &thread_attributes );
183                 pthread_attr_setinheritsched( &thread_attributes, PTHREAD_INHERIT_SCHED );
184
185                 pthread_create( &this->thread, &thread_attributes, consumer_thread, this );
186         }
187
188         return 0;
189 }
190
191 static int consumer_stop( mlt_consumer parent )
192 {
193         // Get the actual object
194         consumer_sdl this = parent->child;
195
196         if ( this->joined == 0 )
197         {
198                 // Kill the thread and clean up
199                 this->running = 0;
200
201                 pthread_join( this->thread, NULL );
202                 this->joined = 1;
203         }
204
205         return 0;
206 }
207
208 static int consumer_is_stopped( mlt_consumer parent )
209 {
210         consumer_sdl this = parent->child;
211         return !this->running;
212 }
213
214 static int sdl_lock_display( )
215 {
216         SDL_Surface *screen = SDL_GetVideoSurface( );
217         return screen != NULL && ( !SDL_MUSTLOCK( screen ) || SDL_LockSurface( screen ) >= 0 );
218 }
219
220 static void sdl_unlock_display( )
221 {
222         SDL_Surface *screen = SDL_GetVideoSurface( );
223         if ( screen != NULL && SDL_MUSTLOCK( screen ) )
224                 SDL_UnlockSurface( screen );
225 }
226
227 static int consumer_play_video( consumer_sdl this, mlt_frame frame )
228 {
229         // Get the properties of this consumer
230         mlt_properties properties = this->properties;
231
232         mlt_image_format vfmt = mlt_image_rgb24;
233         int height = this->height;
234         int width = this->width;
235         uint8_t *image = NULL;
236         int changed = 0;
237
238         void ( *lock )( void ) = mlt_properties_get_data( properties, "app_lock", NULL );
239         void ( *unlock )( void ) = mlt_properties_get_data( properties, "app_unlock", NULL );
240
241         if ( lock != NULL ) lock( );
242
243         sdl_lock_display();
244         
245         // Handle events
246         if ( this->sdl_screen != NULL )
247         {
248                 SDL_Event event;
249
250                 changed = consumer_get_dimensions( &this->window_width, &this->window_height );
251
252                 while ( SDL_PollEvent( &event ) )
253                 {
254                         mlt_events_fire( this->properties, "consumer-sdl-event", &event, NULL );
255
256                         switch( event.type )
257                         {
258                                 case SDL_VIDEORESIZE:
259                                         this->window_width = event.resize.w;
260                                         this->window_height = event.resize.h;
261                                         changed = 1;
262                                         break;
263                                 case SDL_QUIT:
264                                         this->running = 0;
265                                         break;
266                                 case SDL_KEYDOWN:
267                                         {
268                                                 mlt_producer producer = mlt_properties_get_data( properties, "transport_producer", NULL );
269                                                 char keyboard[ 2 ] = " ";
270                                                 void (*callback)( mlt_producer, char * ) = mlt_properties_get_data( properties, "transport_callback", NULL );
271                                                 if ( callback != NULL && producer != NULL && event.key.keysym.unicode < 0x80 && event.key.keysym.unicode > 0 )
272                                                 {
273                                                         keyboard[ 0 ] = ( char )event.key.keysym.unicode;
274                                                         callback( producer, keyboard );
275                                                 }
276                                         }
277                                         break;
278                         }
279                 }
280         }
281
282         if ( ( ( int )( this->last_frame_aspect * 1000 ) != ( int )( mlt_frame_get_aspect_ratio( frame ) * 1000 ) &&
283                  ( mlt_frame_get_aspect_ratio( frame ) != 1.0 || this->last_frame_aspect == 0.0 ) ) )
284         {
285                 this->last_frame_aspect = mlt_frame_get_aspect_ratio( frame );
286                 changed = 1;
287         }
288
289         if ( this->sdl_screen == NULL || changed || mlt_properties_get_int( properties, "changed" ) == 2 )
290         {
291                 // open SDL window 
292                 this->sdl_screen = SDL_SetVideoMode( this->window_width, this->window_height, 16, this->sdl_flags );
293                 if ( consumer_get_dimensions( &this->window_width, &this->window_height ) )
294                         this->sdl_screen = SDL_SetVideoMode( this->window_width, this->window_height, 16, this->sdl_flags );
295
296                 changed = 1;
297                 mlt_properties_set_int( properties, "changed", 0 );
298
299                 // May as well use the mlt rescaler...
300                 //if ( mlt_properties_get( properties, "rescale" ) != NULL && !strcmp( mlt_properties_get( properties, "rescale" ), "none" ) )
301                         //mlt_properties_set( properties, "rescale", "nearest" );
302
303                 // Determine window's new display aspect ratio
304                 float this_aspect = this->display_aspect / ( ( float )this->window_width / ( float )this->window_height );
305
306                 this->rect.w = this_aspect * this->window_width;
307                 this->rect.h = this->window_height;
308                 if ( this->rect.w > this->window_width )
309                 {
310                         this->rect.w = this->window_width;
311                         this->rect.h = ( 1.0 / this_aspect ) * this->window_height;
312                 }
313
314                 this->rect.x = ( this->window_width - this->rect.w ) / 2;
315                 this->rect.y = ( this->window_height - this->rect.h ) / 2;
316
317                 mlt_properties_set_int( this->properties, "rect_x", this->rect.x );
318                 mlt_properties_set_int( this->properties, "rect_y", this->rect.y );
319                 mlt_properties_set_int( this->properties, "rect_w", this->rect.w );
320                 mlt_properties_set_int( this->properties, "rect_h", this->rect.h );
321         }
322         else
323         {
324                 changed = mlt_properties_get_int( properties, "changed" ) | mlt_properties_get_int( mlt_frame_properties( frame ), "refresh" );
325                 mlt_properties_set_int( properties, "changed", 0 );
326         }
327                 
328         if ( changed == 0 &&
329                  this->last_position == mlt_frame_get_position( frame ) &&
330                  this->last_producer == mlt_properties_get_data( mlt_frame_properties( frame ), "_producer", NULL ) )
331         {
332                 sdl_unlock_display( );
333                 if ( unlock != NULL )
334                         unlock( );
335                 return 0;
336         }
337
338         // Update last frame shown info
339         this->last_position = mlt_frame_get_position( frame );
340         this->last_producer = mlt_properties_get_data( mlt_frame_properties( frame ), "_producer", NULL );
341
342         // Get the image, width and height
343         if ( image == NULL )
344         {
345                 mlt_events_fire( properties, "consumer-frame-show", frame, NULL );
346
347                 // I would like to provide upstream scaling here, but this is incorrect
348                 // Something? (or everything?) is too sensitive to aspect ratio
349                 //width = this->rect.w;
350                 //height = this->rect.h;
351                 //mlt_properties_set( mlt_frame_properties( frame ), "distort", "true" );
352                 //mlt_properties_set_int( mlt_frame_properties( frame ), "normalised_width", width );
353                 //mlt_properties_set_int( mlt_frame_properties( frame ), "normalised_height", height );
354
355                 mlt_frame_get_image( frame, &image, &vfmt, &width, &height, 0 );
356         }
357
358         if ( this->sdl_screen != NULL )
359         {
360                 // Calculate the scan length
361                 int scanlength = this->sdl_screen->pitch / 2;
362
363                 // Obtain the clip rect from the screen
364                 SDL_Rect rect = this->rect;
365
366                 // Generate the affine transform scaling values
367                 int scale_width = ( width << 16 ) / rect.w;
368                 int scale_height = ( height << 16 ) / rect.h;
369
370                 // Constants defined for clarity and optimisation
371                 int stride = width * 3;
372                 uint16_t *start = ( uint16_t * )this->sdl_screen->pixels + rect.y * scanlength + rect.x;
373
374                 int x, y, row_index;
375                 uint16_t *p;
376                 uint8_t *q, *row;
377
378                 // Iterate through the screen using a very basic scaling algorithm
379                 for ( y = 0; y < rect.h && this->last_position != -1; y ++ )
380                 {
381                         // Obtain the pointer to the current screen row
382                         p = start;
383
384                         // Calculate the row_index
385                         row_index = ( scale_height * y ) >> 16;
386
387                         // Calculate the pointer for the y offset (positioned on B instead of R)
388                         row = image + stride * row_index;
389
390                         // Iterate through the screen width
391                         for ( x = 0; x < rect.w; x ++ )
392                         {
393                                 // Obtain the pixel pointer
394                                 q = row + ( ( ( scale_width * x ) >> 16 ) * 3 );
395
396                                 // Map the BGR colour from the frame to the SDL format
397                                 *p ++ = SDL_MapRGB( this->sdl_screen->format, *q, *( q + 1 ), *( q + 2 ) );
398                         }
399
400                         // Move to the next row
401                         start += scanlength;
402                 }
403
404                 // Flip it into sight
405                 SDL_Flip( this->sdl_screen );
406         }
407
408         sdl_unlock_display();
409
410         if ( unlock != NULL ) unlock( );
411
412         return 0;
413 }
414
415 /** Threaded wrapper for pipe.
416 */
417
418 static void *consumer_thread( void *arg )
419 {
420         // Identify the arg
421         consumer_sdl this = arg;
422
423         // Get the consumer
424         mlt_consumer consumer = &this->parent;
425
426         // internal intialization
427         mlt_frame frame = NULL;
428         struct timespec tm = { 0, 1000 };
429
430         if ( mlt_properties_get_int( mlt_consumer_properties( consumer ), "sdl_started" ) == 0 )
431         {
432                 if ( SDL_Init( SDL_INIT_VIDEO | SDL_INIT_NOPARACHUTE ) < 0 )
433                 {
434                         fprintf( stderr, "Failed to initialize SDL: %s\n", SDL_GetError() );
435                         return NULL;
436                 }
437
438                 SDL_EnableKeyRepeat( SDL_DEFAULT_REPEAT_DELAY, SDL_DEFAULT_REPEAT_INTERVAL );
439                 SDL_EnableUNICODE( 1 );
440         }
441         else
442         {
443                 mlt_properties_set_int( mlt_consumer_properties( consumer ), "changed", 2 );
444                 if ( SDL_GetVideoSurface( ) != NULL )
445                         consumer_get_dimensions( &this->window_width, &this->window_height );
446         }
447
448         // Loop until told not to
449         while( this->running )
450         {
451                 // Get a frame from the attached producer
452                 frame = mlt_consumer_rt_frame( consumer );
453
454                 // Ensure that we have a frame
455                 if ( frame != NULL )
456                 {
457                         consumer_play_video( this, frame );
458                         mlt_frame_close( frame );
459                         nanosleep( &tm, NULL );
460                 }
461         }
462
463         if ( mlt_properties_get_int( mlt_consumer_properties( consumer ), "sdl_started" ) == 0 )
464                 SDL_Quit( );
465
466         this->sdl_screen = NULL;
467
468         return NULL;
469 }
470
471 static int consumer_get_dimensions( int *width, int *height )
472 {
473         int changed = 0;
474
475         // SDL windows manager structure
476         SDL_SysWMinfo wm;
477
478         // Specify the SDL Version
479         SDL_VERSION( &wm.version );
480
481         // Get the wm structure
482         if ( SDL_GetWMInfo( &wm ) == 1 )
483         {
484                 // Check that we have the X11 wm
485                 if ( wm.subsystem == SDL_SYSWM_X11 ) 
486                 {
487                         // Get the SDL window
488                         Window window = wm.info.x11.window;
489
490                         // Get the display session
491                         Display *display = wm.info.x11.display;
492
493                         // Get the window attributes
494                         XWindowAttributes attr;
495                         XGetWindowAttributes( display, window, &attr );
496
497                         // Determine whether window has changed
498                         changed = *width != attr.width || *height != attr.height;
499
500                         // Return width and height
501                         *width = attr.width;
502                         *height = attr.height;
503                 }
504         }
505
506         return changed;
507 }
508
509 /** Callback to allow override of the close method.
510 */
511
512 static void consumer_close( mlt_consumer parent )
513 {
514         // Get the actual object
515         consumer_sdl this = parent->child;
516
517         // Stop the consumer
518         mlt_consumer_stop( parent );
519
520         // Now clean up the rest
521         mlt_consumer_close( parent );
522
523         // Finally clean up this
524         free( this );
525 }