git.sesse.net Git - mlt/blob - 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                 // Inherit the scheduling priority
 180                 pthread_attr_init( &thread_attributes );
 181                 pthread_attr_setinheritsched( &thread_attributes, PTHREAD_INHERIT_SCHED );
 182
 183                 pthread_create( &this->thread, &thread_attributes, consumer_thread, this );
 184         }
 185
 186         return 0;
 187 }
 188
 189 static int consumer_stop( mlt_consumer parent )
 190 {
 191         // Get the actual object
 192         consumer_sdl this = parent->child;
 193
 194         if ( this->joined == 0 )
 195         {
 196                 // Kill the thread and clean up
 197                 this->running = 0;
 198
 199                 pthread_join( this->thread, NULL );
 200                 this->joined = 1;
 201         }
 202
 203         return 0;
 204 }
 205
 206 static int consumer_is_stopped( mlt_consumer parent )
 207 {
 208         consumer_sdl this = parent->child;
 209         return !this->running;
 210 }
 211
 212 static int sdl_lock_display( )
 213 {
 214         SDL_Surface *screen = SDL_GetVideoSurface( );
 215         return screen != NULL && ( !SDL_MUSTLOCK( screen ) || SDL_LockSurface( screen ) >= 0 );
 216 }
 217
 218 static void sdl_unlock_display( )
 219 {
 220         SDL_Surface *screen = SDL_GetVideoSurface( );
 221         if ( screen != NULL && SDL_MUSTLOCK( screen ) )
 222                 SDL_UnlockSurface( screen );
 223 }
 224
 225 static int consumer_play_video( consumer_sdl this, mlt_frame frame )
 226 {
 227         // Get the properties of this consumer
 228         mlt_properties properties = this->properties;
 229
 230         mlt_image_format vfmt = mlt_image_rgb24;
 231         int width = this->width, height = this->height;
 232         uint8_t *image;
 233         int changed = 0;
 234
 235         void ( *lock )( void ) = mlt_properties_get_data( properties, "app_lock", NULL );
 236         void ( *unlock )( void ) = mlt_properties_get_data( properties, "app_unlock", NULL );
 237
 238         if ( lock != NULL ) lock( );
 239
 240         sdl_lock_display();
 241
 242         // Handle events
 243         if ( this->sdl_screen != NULL )
 244         {
 245                 SDL_Event event;
 246
 247                 changed = consumer_get_dimensions( &this->window_width, &this->window_height );
 248
 249                 while ( SDL_PollEvent( &event ) )
 250                 {
 251                         mlt_events_fire( this->properties, "consumer-sdl-event", &event, NULL );
 252
 253                         switch( event.type )
 254                         {
 255                                 case SDL_VIDEORESIZE:
 256                                         this->window_width = event.resize.w;
 257                                         this->window_height = event.resize.h;
 258                                         changed = 1;
 259                                         break;
 260                                 case SDL_QUIT:
 261                                         this->running = 0;
 262                                         break;
 263                                 case SDL_KEYDOWN:
 264                                         {
 265                                                 mlt_producer producer = mlt_properties_get_data( properties, "transport_producer", NULL );
 266                                                 char keyboard[ 2 ] = " ";
 267                                                 void (*callback)( mlt_producer, char * ) = mlt_properties_get_data( properties, "transport_callback", NULL );
 268                                                 if ( callback != NULL && producer != NULL && event.key.keysym.unicode < 0x80 && event.key.keysym.unicode > 0 )
 269                                                 {
 270                                                         keyboard[ 0 ] = ( char )event.key.keysym.unicode;
 271                                                         callback( producer, keyboard );
 272                                                 }
 273                                         }
 274                                         break;
 275                         }
 276                 }
 277         }
 278
 279         if ( width != this->width || height != this->height ||
 280                  ( ( int )( this->last_frame_aspect * 1000 ) != ( int )( mlt_frame_get_aspect_ratio( frame ) * 1000 ) &&
 281                  ( mlt_frame_get_aspect_ratio( frame ) != 1.0 || this->last_frame_aspect == 0.0 ) ) )
 282
 283         {
 284                 this->width = width;
 285                 this->height = height;
 286                 this->last_frame_aspect = mlt_frame_get_aspect_ratio( frame );
 287                 changed = 1;
 288         }
 289
 290         if ( this->sdl_screen == NULL || changed || mlt_properties_get_int( properties, "changed" ) == 2 )
 291         {
 292                 // open SDL window
 293                 this->sdl_screen = SDL_SetVideoMode( this->window_width, this->window_height, 16, this->sdl_flags );
 294                 consumer_get_dimensions( &this->window_width, &this->window_height );
 295                 changed = 1;
 296                 mlt_properties_set_int( properties, "changed", 0 );
 297
 298                 // Determine frame's display aspect ratio
 299                 float frame_aspect = mlt_frame_get_aspect_ratio( frame ) * this->width / this->height;
 300
 301                 // Determine window's new display aspect ratio
 302                 float this_aspect = ( float )this->window_width / this->window_height;
 303
 304                 // If using hardware scaler
 305                 if ( mlt_properties_get( properties, "rescale" ) != NULL &&
 306                         !strcmp( mlt_properties_get( properties, "rescale" ), "none" ) )
 307                 {
 308                         // Special case optimisation to negate odd effect of sample aspect ratio
 309                         // not corresponding exactly with image resolution.
 310                         if ( ( (int)( this_aspect * 1000 ) == (int)( this->display_aspect * 1000 ) ) &&
 311                                  ( (int)( mlt_frame_get_aspect_ratio( frame ) * 1000 ) == (int)( this->aspect_ratio * 1000 ) ) )
 312                         {
 313                                 this->rect.w = this->window_width;
 314                                 this->rect.h = this->window_height;
 315                         }
 316                         else
 317                         {
 318                                 // Use hardware scaler to normalise display aspect ratio
 319                                 this->rect.w = frame_aspect / this_aspect * this->window_width;
 320                                 this->rect.h = this->window_height;
 321                                 if ( this->rect.w > this->window_width )
 322                                 {
 323                                         this->rect.w = this->window_width;
 324                                         this->rect.h = this_aspect / frame_aspect * this->window_height;
 325                                 }
 326                         }
 327                 }
 328                 // Special case optimisation to negate odd effect of sample aspect ratio
 329                 // not corresponding exactly with image resolution.
 330                 else if ( (int)( this_aspect * 1000 ) == (int)( this->display_aspect * 1000 ) )
 331                 {
 332                         this->rect.w = this->window_width;
 333                         this->rect.h = this->window_height;
 334                 }
 335                 // Use hardware scaler to normalise sample aspect ratio
 336                 else if ( this->window_height * this->display_aspect > this->window_width )
 337                 {
 338                         this->rect.w = this->window_width;
 339                         this->rect.h = this->window_width / this->display_aspect;
 340                 }
 341                 else
 342                 {
 343                         this->rect.w = this->window_height * this->display_aspect;
 344                         this->rect.h = this->window_height;
 345                 }
 346
 347                 this->rect.x = ( this->window_width - this->rect.w ) / 2;
 348                 this->rect.y = ( this->window_height - this->rect.h ) / 2;
 349
 350                 mlt_properties_set_int( this->properties, "rect_x", this->rect.x );
 351                 mlt_properties_set_int( this->properties, "rect_y", this->rect.y );
 352                 mlt_properties_set_int( this->properties, "rect_w", this->rect.w );
 353                 mlt_properties_set_int( this->properties, "rect_h", this->rect.h );
 354         }
 355         else
 356         {
 357                 changed = mlt_properties_get_int( properties, "changed" );
 358                 mlt_properties_set_int( properties, "changed", 0 );
 359         }
 360
 361         if ( changed == 0 &&
 362                  this->last_position == mlt_frame_get_position( frame ) &&
 363                  this->last_producer == mlt_properties_get_data( mlt_frame_properties( frame ), "_producer", NULL ) )
 364         {
 365                 sdl_unlock_display( );
 366                 if ( unlock != NULL )
 367                         unlock( );
 368                 return 0;
 369         }
 370
 371         // Update last frame shown info
 372         this->last_position = mlt_frame_get_position( frame );
 373         this->last_producer = mlt_properties_get_data( mlt_frame_properties( frame ), "_producer", NULL );
 374
 375         // Get the image, width and height
 376         mlt_events_fire( properties, "consumer-frame-show", frame, NULL );
 377         mlt_frame_get_image( frame, &image, &vfmt, &width, &height, 0 );
 378
 379         if ( this->sdl_screen != NULL )
 380         {
 381                 // Calculate the scan length
 382                 int scanlength = this->sdl_screen->pitch / 2;
 383
 384                 // Obtain the clip rect from the screen
 385                 SDL_Rect rect = this->rect;
 386
 387                 // Generate the affine transform scaling values
 388                 int scale_width = ( width << 16 ) / rect.w;
 389                 int scale_height = ( height << 16 ) / rect.h;
 390
 391                 // Constants defined for clarity and optimisation
 392                 int stride = width * 3;
 393                 uint16_t *start = ( uint16_t * )this->sdl_screen->pixels + rect.y * scanlength + rect.x;
 394
 395                 int x, y, row_index;
 396                 uint16_t *p;
 397                 uint8_t *q, *row;
 398
 399                 // Iterate through the screen using a very basic scaling algorithm
 400                 for ( y = 0; y < rect.h && this->last_position != -1; y ++ )
 401                 {
 402                         // Obtain the pointer to the current screen row
 403                         p = start;
 404
 405                         // Calculate the row_index
 406                         row_index = ( scale_height * y ) >> 16;
 407
 408                         // Calculate the pointer for the y offset (positioned on B instead of R)
 409                         row = image + stride * row_index;
 410
 411                         // Iterate through the screen width
 412                         for ( x = 0; x < rect.w; x ++ )
 413                         {
 414                                 // Obtain the pixel pointer
 415                                 q = row + ( ( ( scale_width * x ) >> 16 ) * 3 );
 416
 417                                 // Map the BGR colour from the frame to the SDL format
 418                                 *p ++ = SDL_MapRGB( this->sdl_screen->format, *q, *( q + 1 ), *( q + 2 ) );
 419                         }
 420
 421                         // Move to the next row
 422                         start += scanlength;
 423                 }
 424
 425                 // Flip it into sight
 426                 SDL_Flip( this->sdl_screen );
 427         }
 428
 429         sdl_unlock_display();
 430
 431         if ( unlock != NULL ) unlock( );
 432
 433         return 0;
 434 }
 435
 436 /** Threaded wrapper for pipe.
 437 */
 438
 439 static void *consumer_thread( void *arg )
 440 {
 441         // Identify the arg
 442         consumer_sdl this = arg;
 443
 444         // Get the consumer
 445         mlt_consumer consumer = &this->parent;
 446
 447         // internal intialization
 448         mlt_frame frame = NULL;
 449         struct timespec tm = { 0, 1000 };
 450
 451         if ( mlt_properties_get_int( mlt_consumer_properties( consumer ), "sdl_started" ) == 0 )
 452         {
 453                 if ( SDL_Init( SDL_INIT_VIDEO | SDL_INIT_NOPARACHUTE ) < 0 )
 454                 {
 455                         fprintf( stderr, "Failed to initialize SDL: %s\n", SDL_GetError() );
 456                         return NULL;
 457                 }
 458
 459                 SDL_EnableKeyRepeat( SDL_DEFAULT_REPEAT_DELAY, SDL_DEFAULT_REPEAT_INTERVAL );
 460                 SDL_EnableUNICODE( 1 );
 461         }
 462         else
 463         {
 464                 mlt_properties_set_int( mlt_consumer_properties( consumer ), "changed", 2 );
 465                 if ( SDL_GetVideoSurface( ) != NULL )
 466                         consumer_get_dimensions( &this->window_width, &this->window_height );
 467         }
 468
 469         // Loop until told not to
 470         while( this->running )
 471         {
 472                 // Get a frame from the attached producer
 473                 frame = mlt_consumer_rt_frame( consumer );
 474
 475                 // Ensure that we have a frame
 476                 if ( frame != NULL )
 477                 {
 478                         consumer_play_video( this, frame );
 479                         mlt_frame_close( frame );
 480                         nanosleep( &tm, NULL );
 481                 }
 482         }
 483
 484         if ( mlt_properties_get_int( mlt_consumer_properties( consumer ), "sdl_started" ) == 0 )
 485                 SDL_Quit( );
 486
 487         this->sdl_screen = NULL;
 488
 489         return NULL;
 490 }
 491
 492 static int consumer_get_dimensions( int *width, int *height )
 493 {
 494         int changed = 0;
 495
 496         // SDL windows manager structure
 497         SDL_SysWMinfo wm;
 498
 499         // Specify the SDL Version
 500         SDL_VERSION( &wm.version );
 501
 502         // Get the wm structure
 503         if ( SDL_GetWMInfo( &wm ) == 1 )
 504         {
 505                 // Check that we have the X11 wm
 506                 if ( wm.subsystem == SDL_SYSWM_X11 )
 507                 {
 508                         // Get the SDL window
 509                         Window window = wm.info.x11.window;
 510
 511                         // Get the display session
 512                         Display *display = wm.info.x11.display;
 513
 514                         // Get the window attributes
 515                         XWindowAttributes attr;
 516                         XGetWindowAttributes( display, window, &attr );
 517
 518                         // Determine whether window has changed
 519                         changed = *width != attr.width || *height != attr.height;
 520
 521                         // Return width and height
 522                         *width = attr.width;
 523                         *height = attr.height;
 524                 }
 525         }
 526
 527         return changed;
 528 }
 529
 530 /** Callback to allow override of the close method.
 531 */
 532
 533 static void consumer_close( mlt_consumer parent )
 534 {
 535         // Get the actual object
 536         consumer_sdl this = parent->child;
 537
 538         // Stop the consumer
 539         mlt_consumer_stop( parent );
 540
 541         // Now clean up the rest
 542         mlt_consumer_close( parent );
 543
 544         // Finally clean up this
 545         free( this );
 546 }