git.sesse.net Git - vlc/blob - modules/video_output/sdl.c

   1 /*****************************************************************************
   2  * sdl.c: SDL video output display method
   3  *****************************************************************************
   4  * Copyright (C) 1998-2001 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Samuel Hocevar <sam@zoy.org>
   8  *          Pierre Baillet <oct@zoy.org>
   9  *          Arnaud de Bossoreille de Ribou <bozo@via.ecp.fr>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  24  *****************************************************************************/
  25
  26 /*****************************************************************************
  27  * Preamble
  28  *****************************************************************************/
  29 #include <errno.h>                                                 /* ENOMEM */
  30
  31 #ifdef HAVE_CONFIG_H
  32 # include "config.h"
  33 #endif
  34
  35 #include <vlc_common.h>
  36 #include <vlc_plugin.h>
  37 #include <vlc_interface.h>
  38 #include <vlc_playlist.h>
  39 #include <vlc_vout.h>
  40 #include <vlc_keys.h>
  41 //#include <vlc_aout.h>
  42
  43 #include <sys/types.h>
  44 #ifndef WIN32
  45 #   include <netinet/in.h>                            /* BSD: struct in_addr */
  46 #endif
  47
  48 #include SDL_INCLUDE_FILE
  49
  50 /* SDL is not able to crop overlays - so use only 1 direct buffer */
  51 #define SDL_MAX_DIRECTBUFFERS 1
  52 #define SDL_DEFAULT_BPP 16
  53
  54 /*****************************************************************************
  55  * vout_sys_t: video output SDL method descriptor
  56  *****************************************************************************
  57  * This structure is part of the video output thread descriptor.
  58  * It describes the SDL specific properties of an output thread.
  59  *****************************************************************************/
  60 struct vout_sys_t
  61 {
  62     SDL_Surface *   p_display;                             /* display device */
  63
  64     int i_width;
  65     int i_height;
  66
  67 #if SDL_VERSION_ATLEAST(1,2,10)
  68     unsigned int i_desktop_width;
  69     unsigned int i_desktop_height;
  70 #endif
  71
  72     /* For YUV output */
  73     SDL_Overlay * p_overlay;   /* An overlay we keep to grab the XVideo port */
  74
  75     /* For RGB output */
  76     int i_surfaces;
  77
  78     bool  b_cursor;
  79     bool  b_cursor_autohidden;
  80     mtime_t     i_lastmoved;
  81     mtime_t     i_mouse_hide_timeout;
  82     mtime_t     i_lastpressed;                        /* to track dbl-clicks */
  83 };
  84
  85 /*****************************************************************************
  86  * picture_sys_t: direct buffer method descriptor
  87  *****************************************************************************
  88  * This structure is part of the picture descriptor, it describes the
  89  * SDL specific properties of a direct buffer.
  90  *****************************************************************************/
  91 struct picture_sys_t
  92 {
  93     SDL_Overlay *p_overlay;
  94 };
  95
  96 /*****************************************************************************
  97  * Local prototypes
  98  *****************************************************************************/
  99 static int  Open      ( vlc_object_t * );
 100 static void Close     ( vlc_object_t * );
 101 static int  Init      ( vout_thread_t * );
 102 static void End       ( vout_thread_t * );
 103 static int  Manage    ( vout_thread_t * );
 104 static void Display   ( vout_thread_t *, picture_t * );
 105
 106 static int  OpenDisplay     ( vout_thread_t * );
 107 static void CloseDisplay    ( vout_thread_t * );
 108 static int  NewPicture      ( vout_thread_t *, picture_t * );
 109 static void SetPalette      ( vout_thread_t *,
 110                               uint16_t *, uint16_t *, uint16_t * );
 111
 112 static int ConvertKey( SDLKey );
 113
 114
 115 #define CHROMA_TEXT N_("SDL chroma format")
 116 #define CHROMA_LONGTEXT N_( \
 117     "Force the SDL renderer to use a specific chroma format instead of " \
 118     "trying to improve performances by using the most efficient one.")
 119
 120 /*****************************************************************************
 121  * Module descriptor
 122  *****************************************************************************/
 123 vlc_module_begin();
 124     set_shortname( "SDL" );
 125     set_category( CAT_VIDEO );
 126     set_subcategory( SUBCAT_VIDEO_VOUT );
 127     set_description( N_("Simple DirectMedia Layer video output") );
 128     set_capability( "video output", 60 );
 129     add_shortcut( "sdl" );
 130     add_string( "sdl-chroma", NULL, NULL, CHROMA_TEXT, CHROMA_LONGTEXT, true );
 131     set_callbacks( Open, Close );
 132 #if defined( __i386__ ) || defined( __x86_64__ )
 133     /* On i386, SDL is linked against svgalib */
 134     linked_with_a_crap_library_which_uses_atexit();
 135 #endif
 136 vlc_module_end();
 137
 138 /*****************************************************************************
 139  * OpenVideo: allocate SDL video thread output method
 140  *****************************************************************************
 141  * This function allocate and initialize a SDL vout method. It uses some of the
 142  * vout properties to choose the correct mode, and change them according to the
 143  * mode actually used.
 144  *****************************************************************************/
 145 static int Open ( vlc_object_t *p_this )
 146 {
 147     vout_thread_t * p_vout = (vout_thread_t *)p_this;
 148     /* XXX: check for conflicts with the SDL audio output */
 149     vlc_mutex_t *lock = var_AcquireMutex( "sdl" );
 150
 151 #ifdef HAVE_SETENV
 152     char *psz_method;
 153 #endif
 154
 155     if( lock == NULL )
 156         return VLC_ENOMEM;
 157
 158     p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
 159     if( p_vout->p_sys == NULL )
 160     {
 161         vlc_mutex_unlock( lock );
 162         return VLC_ENOMEM;
 163     }
 164
 165     memset( p_vout->p_sys, 0, sizeof( vout_sys_t ) );
 166
 167     /* Check if SDL video module has been initialized */
 168     if( SDL_WasInit( SDL_INIT_VIDEO ) != 0 )
 169     {
 170         vlc_mutex_unlock( lock );
 171         free( p_vout->p_sys );
 172         return VLC_EGENERIC;
 173     }
 174
 175     /* Allocate structure */
 176     p_vout->pf_init = Init;
 177     p_vout->pf_end = End;
 178     p_vout->pf_manage = Manage;
 179     p_vout->pf_render = NULL;
 180     p_vout->pf_display = Display;
 181     p_vout->pf_control = NULL;
 182
 183 #ifdef HAVE_SETENV
 184     psz_method = config_GetPsz( p_vout, "vout" );
 185     if( psz_method )
 186     {
 187         while( *psz_method && *psz_method != ':' )
 188         {
 189             psz_method++;
 190         }
 191
 192         if( *psz_method )
 193         {
 194             setenv( "SDL_VIDEODRIVER", psz_method + 1, 1 );
 195         }
 196     }
 197 #endif
 198
 199     /* Initialize library */
 200     if( SDL_Init( SDL_INIT_VIDEO
 201 #ifndef WIN32
 202     /* Win32 SDL implementation doesn't support SDL_INIT_EVENTTHREAD yet*/
 203                 | SDL_INIT_EVENTTHREAD
 204 #endif
 205 #ifndef NDEBUG
 206     /* In debug mode you may want vlc to dump a core instead of staying
 207      * stuck */
 208                 | SDL_INIT_NOPARACHUTE
 209 #endif
 210                 ) < 0 )
 211     {
 212         msg_Err( p_vout, "cannot initialize SDL (%s)", SDL_GetError() );
 213         free( p_vout->p_sys );
 214         vlc_mutex_unlock( lock );
 215         return VLC_EGENERIC;
 216     }
 217
 218     vlc_mutex_unlock( lock );
 219
 220     /* Translate keys into unicode */
 221     SDL_EnableUNICODE(1);
 222
 223     /* Get the desktop resolution */
 224 #if SDL_VERSION_ATLEAST(1,2,10)
 225     /* FIXME: SDL has a problem with virtual desktop */
 226     p_vout->p_sys->i_desktop_width = SDL_GetVideoInfo()->current_w;
 227     p_vout->p_sys->i_desktop_height = SDL_GetVideoInfo()->current_h;
 228 #endif
 229
 230     /* Create the cursor */
 231     p_vout->p_sys->b_cursor = 1;
 232     p_vout->p_sys->b_cursor_autohidden = 0;
 233     p_vout->p_sys->i_lastmoved = p_vout->p_sys->i_lastpressed = mdate();
 234     p_vout->p_sys->i_mouse_hide_timeout =
 235         var_GetInteger(p_vout, "mouse-hide-timeout") * 1000;
 236
 237     if( OpenDisplay( p_vout ) )
 238     {
 239         msg_Err( p_vout, "cannot set up SDL (%s)", SDL_GetError() );
 240         SDL_QuitSubSystem( SDL_INIT_VIDEO );
 241         free( p_vout->p_sys );
 242         return VLC_EGENERIC;
 243     }
 244
 245     return VLC_SUCCESS;
 246 }
 247
 248 /*****************************************************************************
 249  * Init: initialize SDL video thread output method
 250  *****************************************************************************
 251  * This function initialize the SDL display device.
 252  *****************************************************************************/
 253 static int Init( vout_thread_t *p_vout )
 254 {
 255     int i_index;
 256     picture_t *p_pic;
 257
 258     p_vout->p_sys->i_surfaces = 0;
 259
 260     I_OUTPUTPICTURES = 0;
 261
 262     /* Initialize the output structure */
 263     if( p_vout->p_sys->p_overlay == NULL )
 264     {
 265         /* All we have is an RGB image with square pixels */
 266         p_vout->output.i_width  = p_vout->p_sys->i_width;
 267         p_vout->output.i_height = p_vout->p_sys->i_height;
 268         p_vout->output.i_aspect = p_vout->output.i_width
 269                                    * VOUT_ASPECT_FACTOR
 270                                    / p_vout->output.i_height;
 271     }
 272     else
 273     {
 274         /* We may need to convert the chroma, but at least we keep the
 275          * aspect ratio */
 276         p_vout->output.i_width  = p_vout->render.i_width;
 277         p_vout->output.i_height = p_vout->render.i_height;
 278         p_vout->output.i_aspect = p_vout->render.i_aspect;
 279     }
 280
 281     /* Try to initialize SDL_MAX_DIRECTBUFFERS direct buffers */
 282     while( I_OUTPUTPICTURES < SDL_MAX_DIRECTBUFFERS )
 283     {
 284         p_pic = NULL;
 285
 286         /* Find an empty picture slot */
 287         for( i_index = 0 ; i_index < VOUT_MAX_PICTURES ; i_index++ )
 288         {
 289             if( p_vout->p_picture[ i_index ].i_status == FREE_PICTURE )
 290             {
 291                 p_pic = p_vout->p_picture + i_index;
 292                 break;
 293             }
 294         }
 295
 296         /* Allocate the picture if we found one */
 297         if( p_pic == NULL || NewPicture( p_vout, p_pic ) )
 298         {
 299             break;
 300         }
 301
 302         p_pic->i_status = DESTROYED_PICTURE;
 303         p_pic->i_type   = DIRECT_PICTURE;
 304
 305         PP_OUTPUTPICTURE[ I_OUTPUTPICTURES ] = p_pic;
 306
 307         I_OUTPUTPICTURES++;
 308     }
 309
 310     return VLC_SUCCESS;
 311 }
 312
 313 /*****************************************************************************
 314  * End: terminate Sys video thread output method
 315  *****************************************************************************
 316  * Terminate an output method created by OpenVideo
 317  *****************************************************************************/
 318 static void End( vout_thread_t *p_vout )
 319 {
 320     int i_index;
 321
 322     /* Free the output buffers we allocated */
 323     for( i_index = I_OUTPUTPICTURES ; i_index ; )
 324     {
 325         i_index--;
 326         if( p_vout->p_sys->p_overlay == NULL )
 327         {
 328             /* RGB picture */
 329         }
 330         else
 331         {
 332             SDL_UnlockYUVOverlay(
 333                     PP_OUTPUTPICTURE[ i_index ]->p_sys->p_overlay );
 334             SDL_FreeYUVOverlay(
 335                     PP_OUTPUTPICTURE[ i_index ]->p_sys->p_overlay );
 336         }
 337         free( PP_OUTPUTPICTURE[ i_index ]->p_sys );
 338     }
 339 }
 340
 341 /*****************************************************************************
 342  * CloseVideo: destroy Sys video thread output method
 343  *****************************************************************************
 344  * Terminate an output method created by vout_SDLCreate
 345  *****************************************************************************/
 346 static void Close ( vlc_object_t *p_this )
 347 {
 348     vout_thread_t * p_vout = (vout_thread_t *)p_this;
 349
 350     CloseDisplay( p_vout );
 351     SDL_QuitSubSystem( SDL_INIT_VIDEO );
 352
 353     free( p_vout->p_sys );
 354 }
 355
 356 /*****************************************************************************
 357  * Manage: handle Sys events
 358  *****************************************************************************
 359  * This function should be called regularly by video output thread. It returns
 360  * a non null value if an error occurred.
 361  *****************************************************************************/
 362 static int Manage( vout_thread_t *p_vout )
 363 {
 364     SDL_Event event;                                            /* SDL event */
 365     vlc_value_t val;
 366     unsigned int i_width, i_height, i_x, i_y;
 367
 368     /* Process events */
 369     while( SDL_PollEvent( &event ) )
 370     {
 371         switch( event.type )
 372         {
 373         /* Resizing of window */
 374         case SDL_VIDEORESIZE:
 375             p_vout->i_changes |= VOUT_SIZE_CHANGE;
 376             p_vout->i_window_width = p_vout->p_sys->i_width = event.resize.w;
 377             p_vout->i_window_height = p_vout->p_sys->i_height = event.resize.h;
 378             break;
 379
 380         /* Mouse move */
 381         case SDL_MOUSEMOTION:
 382             vout_PlacePicture( p_vout, p_vout->p_sys->i_width,
 383                                p_vout->p_sys->i_height,
 384                                &i_x, &i_y, &i_width, &i_height );
 385
 386             /* Compute the x coordinate and check if the value is
 387                in [0,p_vout->fmt_in.i_visible_width] */
 388             val.i_int = ( event.motion.x - i_x ) *
 389                         p_vout->fmt_in.i_visible_width / i_width +
 390                         p_vout->fmt_in.i_x_offset;
 391
 392             if( (int)(event.motion.x - i_x) < 0 )
 393                 val.i_int = 0;
 394             else if( (unsigned int)val.i_int > p_vout->fmt_in.i_visible_width )
 395                 val.i_int = p_vout->fmt_in.i_visible_width;
 396
 397             var_Set( p_vout, "mouse-x", val );
 398
 399             /* compute the y coordinate and check if the value is
 400                in [0,p_vout->fmt_in.i_visible_height] */
 401             val.i_int = ( event.motion.y - i_y ) *
 402                         p_vout->fmt_in.i_visible_height / i_height +
 403                         p_vout->fmt_in.i_y_offset;
 404
 405             if( (int)(event.motion.y - i_y) < 0 )
 406                 val.i_int = 0;
 407             else if( (unsigned int)val.i_int > p_vout->fmt_in.i_visible_height )
 408                 val.i_int = p_vout->fmt_in.i_visible_height;
 409
 410             var_Set( p_vout, "mouse-y", val );
 411
 412             val.b_bool = true;
 413             var_Set( p_vout, "mouse-moved", val );
 414
 415             if( p_vout->p_sys->b_cursor )
 416             {
 417                 if( p_vout->p_sys->b_cursor_autohidden )
 418                 {
 419                     p_vout->p_sys->b_cursor_autohidden = 0;
 420                     SDL_ShowCursor( 1 );
 421                 }
 422                 else
 423                 {
 424                     p_vout->p_sys->i_lastmoved = mdate();
 425                 }
 426             }
 427             break;
 428
 429         /* Mouse button released */
 430         case SDL_MOUSEBUTTONUP:
 431             switch( event.button.button )
 432             {
 433             case SDL_BUTTON_LEFT:
 434                 {
 435                     var_Get( p_vout, "mouse-button-down", &val );
 436                     val.i_int &= ~1;
 437                     var_Set( p_vout, "mouse-button-down", val );
 438
 439                     val.b_bool = true;
 440                     var_Set( p_vout, "mouse-clicked", val );
 441
 442                     val.b_bool = false;
 443                     var_Set( p_vout->p_libvlc, "intf-popupmenu", val );
 444                 }
 445                 break;
 446
 447             case SDL_BUTTON_MIDDLE:
 448                 {
 449                     var_Get( p_vout, "mouse-button-down", &val );
 450                     val.i_int &= ~2;
 451                     var_Set( p_vout, "mouse-button-down", val );
 452
 453                     vlc_value_t val;
 454                     var_Get( p_vout->p_libvlc, "intf-show", &val );
 455                     val.b_bool = !val.b_bool;
 456                     var_Set( p_vout->p_libvlc, "intf-show", val );
 457                 }
 458                 break;
 459
 460             case SDL_BUTTON_RIGHT:
 461                 {
 462                     intf_thread_t *p_intf;
 463
 464                     var_Get( p_vout, "mouse-button-down", &val );
 465                     val.i_int &= ~4;
 466                     var_Set( p_vout, "mous-button-down", val );
 467                     p_intf = vlc_object_find( p_vout, VLC_OBJECT_INTF,
 468                                                       FIND_ANYWHERE );
 469                     if( p_intf )
 470                     {
 471                         p_intf->b_menu_change = 1;
 472                         vlc_object_release( p_intf );
 473                     }
 474
 475                     val.b_bool = true;
 476                     var_Set( p_vout->p_libvlc, "intf-popupmenu", val );
 477                 }
 478                 break;
 479             }
 480             break;
 481
 482         /* Mouse button pressed */
 483         case SDL_MOUSEBUTTONDOWN:
 484             switch( event.button.button )
 485             {
 486             case SDL_BUTTON_LEFT:
 487                 var_Get( p_vout, "mouse-button-down", &val );
 488                 val.i_int |= 1;
 489                 var_Set( p_vout, "mouse-button-down", val );
 490
 491                 /* detect double-clicks */
 492                 if( ( mdate() - p_vout->p_sys->i_lastpressed ) < 300000 )
 493                     p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
 494
 495                 p_vout->p_sys->i_lastpressed = mdate();
 496                 break;
 497
 498             case SDL_BUTTON_MIDDLE:
 499                 var_Get( p_vout, "mouse-button-down", &val );
 500                 val.i_int |= 2;
 501                 var_Set( p_vout, "mouse-button-down", val );
 502                 break;
 503
 504             case SDL_BUTTON_RIGHT:
 505                 var_Get( p_vout, "mouse-button-down", &val );
 506                 val.i_int |= 4;
 507                 var_Set( p_vout, "mouse-button-down", val );
 508                 break;
 509             }
 510             break;
 511
 512         /* Quit event (close the window) */
 513         case SDL_QUIT:
 514             {
 515 #if 0
 516                 playlist_t *p_playlist = pl_Yield( p_vout );
 517                 if( p_playlist != NULL )
 518                 {
 519                     playlist_Stop( p_playlist );
 520                     pl_Release( p_vout );
 521                 }
 522 #else
 523 #warning FIXME FIXME ?
 524 #endif
 525             }
 526             break;
 527
 528         /* Key pressed */
 529         case SDL_KEYDOWN:
 530             /* convert the key if possible */
 531             val.i_int = ConvertKey( event.key.keysym.sym );
 532
 533             if( !val.i_int )
 534             {
 535                 /* Find the right caracter */
 536                 if( ( event.key.keysym.unicode & 0xff80 ) == 0 )
 537                 {
 538                     val.i_int = event.key.keysym.unicode & 0x7f;
 539                     /* FIXME: find a better solution than this
 540                               hack to find the right caracter */
 541                     if( val.i_int >= 1 && val.i_int <= 26 )
 542                         val.i_int += 96;
 543                     else if( val.i_int >= 65 && val.i_int <= 90 )
 544                         val.i_int += 32;
 545                 }
 546             }
 547
 548             if( val.i_int )
 549             {
 550                 if( ( event.key.keysym.mod & KMOD_SHIFT ) )
 551                 {
 552                     val.i_int |= KEY_MODIFIER_SHIFT;
 553                 }
 554                 if( ( event.key.keysym.mod & KMOD_CTRL ) )
 555                 {
 556                     val.i_int |= KEY_MODIFIER_CTRL;
 557                 }
 558                 if( ( event.key.keysym.mod & KMOD_ALT ) )
 559                 {
 560                     val.i_int |= KEY_MODIFIER_ALT;
 561                 }
 562                 var_Set( p_vout->p_libvlc, "key-pressed", val );
 563             }
 564
 565         default:
 566             break;
 567         }
 568     }
 569
 570     /* Fullscreen change */
 571     if( p_vout->i_changes & VOUT_FULLSCREEN_CHANGE )
 572     {
 573         vlc_value_t val_fs;
 574
 575         /* Update the object variable and trigger callback */
 576         val_fs.b_bool = !p_vout->b_fullscreen;
 577         p_vout->b_fullscreen = !p_vout->b_fullscreen;
 578         var_Set( p_vout, "fullscreen", val_fs );
 579
 580         /*TODO: add the "always on top" code here !*/
 581
 582         p_vout->p_sys->b_cursor_autohidden = 0;
 583         SDL_ShowCursor( p_vout->p_sys->b_cursor &&
 584                         ! p_vout->p_sys->b_cursor_autohidden );
 585
 586         p_vout->i_changes &= ~VOUT_FULLSCREEN_CHANGE;
 587         p_vout->i_changes |= VOUT_SIZE_CHANGE;
 588     }
 589
 590     /* Crop or Aspect Ratio Changes */
 591     if( p_vout->i_changes & VOUT_CROP_CHANGE ||
 592         p_vout->i_changes & VOUT_ASPECT_CHANGE )
 593     {
 594         p_vout->i_changes &= ~VOUT_CROP_CHANGE;
 595         p_vout->i_changes &= ~VOUT_ASPECT_CHANGE;
 596
 597         p_vout->fmt_out.i_x_offset = p_vout->fmt_in.i_x_offset;
 598         p_vout->fmt_out.i_y_offset = p_vout->fmt_in.i_y_offset;
 599         p_vout->fmt_out.i_visible_width = p_vout->fmt_in.i_visible_width;
 600         p_vout->fmt_out.i_visible_height = p_vout->fmt_in.i_visible_height;
 601         p_vout->fmt_out.i_aspect = p_vout->fmt_in.i_aspect;
 602         p_vout->fmt_out.i_sar_num = p_vout->fmt_in.i_sar_num;
 603         p_vout->fmt_out.i_sar_den = p_vout->fmt_in.i_sar_den;
 604         p_vout->output.i_aspect = p_vout->fmt_in.i_aspect;
 605
 606         p_vout->i_changes |= VOUT_SIZE_CHANGE;
 607     }
 608
 609     /* Size change */
 610     if( p_vout->i_changes & VOUT_SIZE_CHANGE )
 611     {
 612         msg_Dbg( p_vout, "video display resized (%dx%d)",
 613                  p_vout->p_sys->i_width, p_vout->p_sys->i_height );
 614
 615         CloseDisplay( p_vout );
 616         OpenDisplay( p_vout );
 617
 618         /* We don't need to signal the vout thread about the size change if
 619          * we can handle rescaling ourselves */
 620         if( p_vout->p_sys->p_overlay != NULL )
 621             p_vout->i_changes &= ~VOUT_SIZE_CHANGE;
 622     }
 623
 624     /* Pointer change */
 625     if( ! p_vout->p_sys->b_cursor_autohidden &&
 626         ( mdate() - p_vout->p_sys->i_lastmoved >
 627             p_vout->p_sys->i_mouse_hide_timeout ) )
 628     {
 629         /* Hide the mouse automatically */
 630         p_vout->p_sys->b_cursor_autohidden = 1;
 631         SDL_ShowCursor( 0 );
 632     }
 633
 634     return VLC_SUCCESS;
 635 }
 636
 637 /*****************************************************************************
 638  * Key events handling
 639  *****************************************************************************/
 640 static struct
 641 {
 642     SDLKey sdl_key;
 643     int i_vlckey;
 644 } sdlkeys_to_vlckeys[] =
 645 {
 646     { SDLK_F1,  KEY_F1 },
 647     { SDLK_F2,  KEY_F2 },
 648     { SDLK_F3,  KEY_F3 },
 649     { SDLK_F4,  KEY_F4 },
 650     { SDLK_F5,  KEY_F5 },
 651     { SDLK_F6,  KEY_F6 },
 652     { SDLK_F7,  KEY_F7 },
 653     { SDLK_F8,  KEY_F8 },
 654     { SDLK_F9,  KEY_F9 },
 655     { SDLK_F10, KEY_F10 },
 656     { SDLK_F11, KEY_F11 },
 657     { SDLK_F12, KEY_F12 },
 658
 659     { SDLK_RETURN, KEY_ENTER },
 660     { SDLK_KP_ENTER, KEY_ENTER },
 661     { SDLK_SPACE, KEY_SPACE },
 662     { SDLK_ESCAPE, KEY_ESC },
 663
 664     { SDLK_MENU, KEY_MENU },
 665     { SDLK_LEFT, KEY_LEFT },
 666     { SDLK_RIGHT, KEY_RIGHT },
 667     { SDLK_UP, KEY_UP },
 668     { SDLK_DOWN, KEY_DOWN },
 669
 670     { SDLK_HOME, KEY_HOME },
 671     { SDLK_END, KEY_END },
 672     { SDLK_PAGEUP, KEY_PAGEUP },
 673     { SDLK_PAGEDOWN,  KEY_PAGEDOWN },
 674
 675     { SDLK_INSERT, KEY_INSERT },
 676     { SDLK_DELETE, KEY_DELETE },
 677     /*TODO: find a equivalent for SDL
 678     { , KEY_MEDIA_NEXT_TRACK }
 679     { , KEY_MEDIA_PREV_TRACK }
 680     { , KEY_VOLUME_MUTE }
 681     { , KEY_VOLUME_DOWN }
 682     { , KEY_VOLUME_UP }
 683     { , KEY_MEDIA_PLAY_PAUSE }
 684     { , KEY_MEDIA_PLAY_PAUSE }*/
 685
 686     { 0, 0 }
 687 };
 688
 689 static int ConvertKey( SDLKey sdl_key )
 690 {
 691     int i;
 692     for( i=0; sdlkeys_to_vlckeys[i].sdl_key != 0; i++ )
 693     {
 694         if( sdlkeys_to_vlckeys[i].sdl_key == sdl_key )
 695         {
 696             return sdlkeys_to_vlckeys[i].i_vlckey;
 697         }
 698     }
 699     return 0;
 700 }
 701
 702
 703 /*****************************************************************************
 704  * Display: displays previously rendered output
 705  *****************************************************************************
 706  * This function sends the currently rendered image to the display.
 707  *****************************************************************************/
 708 static void Display( vout_thread_t *p_vout, picture_t *p_pic )
 709 {
 710     unsigned int x, y, w, h;
 711     SDL_Rect disp;
 712
 713     vout_PlacePicture( p_vout, p_vout->p_sys->i_width, p_vout->p_sys->i_height,
 714                        &x, &y, &w, &h );
 715     disp.x = x;
 716     disp.y = y;
 717     disp.w = w;
 718     disp.h = h;
 719
 720     if( p_vout->p_sys->p_overlay == NULL )
 721     {
 722         /* RGB picture */
 723         SDL_Flip( p_vout->p_sys->p_display );
 724     }
 725     else
 726     {
 727         /* Overlay picture */
 728         SDL_UnlockYUVOverlay( p_pic->p_sys->p_overlay);
 729         SDL_DisplayYUVOverlay( p_pic->p_sys->p_overlay , &disp );
 730         SDL_LockYUVOverlay( p_pic->p_sys->p_overlay);
 731     }
 732 }
 733
 734 /* following functions are local */
 735
 736 /*****************************************************************************
 737  * OpenDisplay: open and initialize SDL device
 738  *****************************************************************************
 739  * Open and initialize display according to preferences specified in the vout
 740  * thread fields.
 741  *****************************************************************************/
 742 static int OpenDisplay( vout_thread_t *p_vout )
 743 {
 744     uint32_t i_flags;
 745     int i_bpp;
 746
 747     /* SDL fucked up fourcc definitions on bigendian machines */
 748     uint32_t i_sdl_chroma;
 749     char *psz_chroma = NULL;
 750     uint32_t i_chroma = 0;
 751
 752     bool b_overlay = config_GetInt( p_vout, "overlay" );
 753
 754     /* Set main window's size */
 755 #if SDL_VERSION_ATLEAST(1,2,10)
 756     p_vout->p_sys->i_width = p_vout->b_fullscreen ? p_vout->p_sys->i_desktop_width :
 757                                                     p_vout->i_window_width;
 758     p_vout->p_sys->i_height = p_vout->b_fullscreen ? p_vout->p_sys->i_desktop_height :
 759                                                      p_vout->i_window_height;
 760 #else
 761     p_vout->p_sys->i_width = p_vout->b_fullscreen ? p_vout->output.i_width :
 762                                                     p_vout->i_window_width;
 763     p_vout->p_sys->i_height = p_vout->b_fullscreen ? p_vout->output.i_height :
 764                                                      p_vout->i_window_height;
 765 #endif
 766
 767     /* Initialize flags and cursor */
 768     i_flags = SDL_ANYFORMAT | SDL_HWPALETTE | SDL_HWSURFACE | SDL_DOUBLEBUF;
 769     i_flags |= p_vout->b_fullscreen ? SDL_FULLSCREEN : SDL_RESIZABLE;
 770
 771     i_bpp = SDL_VideoModeOK( p_vout->p_sys->i_width, p_vout->p_sys->i_height,
 772                              SDL_DEFAULT_BPP, i_flags );
 773     if( i_bpp == 0 )
 774     {
 775         msg_Err( p_vout, "no video mode available" );
 776         return VLC_EGENERIC;
 777     }
 778
 779     p_vout->p_sys->p_display = SDL_SetVideoMode( p_vout->p_sys->i_width,
 780                                                  p_vout->p_sys->i_height,
 781                                                  i_bpp, i_flags );
 782
 783     if( p_vout->p_sys->p_display == NULL )
 784     {
 785         msg_Err( p_vout, "cannot set video mode" );
 786         return VLC_EGENERIC;
 787     }
 788
 789     SDL_LockSurface( p_vout->p_sys->p_display );
 790
 791     if( ( psz_chroma = config_GetPsz( p_vout, "sdl-chroma" ) ) )
 792     {
 793         if( strlen( psz_chroma ) >= 4 )
 794         {
 795             memcpy(&i_chroma, psz_chroma, 4);
 796             msg_Dbg( p_vout, "Forcing chroma to 0x%.8x (%4.4s)", i_chroma, (char*)&i_chroma );
 797         }
 798         else
 799         {
 800             free( psz_chroma );
 801             psz_chroma = NULL;
 802         }
 803     }
 804
 805     if( b_overlay )
 806     {
 807         /* Choose the chroma we will try first. */
 808         do
 809         {
 810             if( !psz_chroma ) i_chroma = 0;
 811             switch( i_chroma ? i_chroma : p_vout->render.i_chroma )
 812             {
 813                 case VLC_FOURCC('Y','U','Y','2'):
 814                 case VLC_FOURCC('Y','U','N','V'):
 815                     p_vout->output.i_chroma = VLC_FOURCC('Y','U','Y','2');
 816                     i_sdl_chroma = SDL_YUY2_OVERLAY;
 817                     break;
 818                 case VLC_FOURCC('U','Y','V','Y'):
 819                 case VLC_FOURCC('U','Y','N','V'):
 820                 case VLC_FOURCC('Y','4','2','2'):
 821                     p_vout->output.i_chroma = VLC_FOURCC('U','Y','V','Y');
 822                     i_sdl_chroma = SDL_UYVY_OVERLAY;
 823                     break;
 824                 case VLC_FOURCC('Y','V','Y','U'):
 825                     p_vout->output.i_chroma = VLC_FOURCC('Y','V','Y','U');
 826                     i_sdl_chroma = SDL_YVYU_OVERLAY;
 827                     break;
 828                 case VLC_FOURCC('Y','V','1','2'):
 829                 case VLC_FOURCC('I','4','2','0'):
 830                 case VLC_FOURCC('I','Y','U','V'):
 831                 default:
 832                     p_vout->output.i_chroma = VLC_FOURCC('Y','V','1','2');
 833                     i_sdl_chroma = SDL_YV12_OVERLAY;
 834                     break;
 835             }
 836             free( psz_chroma ); psz_chroma = NULL;
 837
 838             p_vout->p_sys->p_overlay =
 839                 SDL_CreateYUVOverlay( 32, 32, i_sdl_chroma,
 840                                       p_vout->p_sys->p_display );
 841             /* FIXME: if the first overlay we find is software, don't stop,
 842              * because we may find a hardware one later ... */
 843         }
 844         while( i_chroma && !p_vout->p_sys->p_overlay );
 845
 846
 847         /* If this best choice failed, fall back to other chromas */
 848         if( p_vout->p_sys->p_overlay == NULL )
 849         {
 850             p_vout->output.i_chroma = VLC_FOURCC('I','Y','U','V');
 851             p_vout->p_sys->p_overlay =
 852                 SDL_CreateYUVOverlay( 32, 32, SDL_IYUV_OVERLAY,
 853                                       p_vout->p_sys->p_display );
 854         }
 855
 856         if( p_vout->p_sys->p_overlay == NULL )
 857         {
 858             p_vout->output.i_chroma = VLC_FOURCC('Y','V','1','2');
 859             p_vout->p_sys->p_overlay =
 860                 SDL_CreateYUVOverlay( 32, 32, SDL_YV12_OVERLAY,
 861                                       p_vout->p_sys->p_display );
 862         }
 863
 864         if( p_vout->p_sys->p_overlay == NULL )
 865         {
 866             p_vout->output.i_chroma = VLC_FOURCC('Y','U','Y','2');
 867             p_vout->p_sys->p_overlay =
 868                 SDL_CreateYUVOverlay( 32, 32, SDL_YUY2_OVERLAY,
 869                                       p_vout->p_sys->p_display );
 870         }
 871     }
 872
 873     if( p_vout->p_sys->p_overlay == NULL )
 874     {
 875         if( b_overlay )
 876             msg_Warn( p_vout, "no SDL overlay for 0x%.8x (%4.4s)",
 877                       p_vout->render.i_chroma,
 878                       (char*)&p_vout->render.i_chroma );
 879         else
 880             msg_Warn( p_vout, "SDL overlay disabled by the user" );
 881
 882         switch( p_vout->p_sys->p_display->format->BitsPerPixel )
 883         {
 884             case 8:
 885                 p_vout->output.i_chroma = VLC_FOURCC('R','G','B','2');
 886                 p_vout->output.pf_setpalette = SetPalette;
 887                 break;
 888             case 15:
 889                 p_vout->output.i_chroma = VLC_FOURCC('R','V','1','5');
 890                 break;
 891             case 16:
 892                 p_vout->output.i_chroma = VLC_FOURCC('R','V','1','6');
 893                 break;
 894             case 24:
 895                 p_vout->output.i_chroma = VLC_FOURCC('R','V','2','4');
 896                 break;
 897             case 32:
 898                 p_vout->output.i_chroma = VLC_FOURCC('R','V','3','2');
 899                 break;
 900             default:
 901                 msg_Err( p_vout, "unknown screen depth %i",
 902                          p_vout->p_sys->p_display->format->BitsPerPixel );
 903                 SDL_UnlockSurface( p_vout->p_sys->p_display );
 904                 SDL_FreeSurface( p_vout->p_sys->p_display );
 905                 return VLC_EGENERIC;
 906         }
 907
 908         p_vout->output.i_rmask = p_vout->p_sys->p_display->format->Rmask;
 909         p_vout->output.i_gmask = p_vout->p_sys->p_display->format->Gmask;
 910         p_vout->output.i_bmask = p_vout->p_sys->p_display->format->Bmask;
 911
 912         SDL_WM_SetCaption( VOUT_TITLE " (software RGB SDL output)",
 913                            VOUT_TITLE " (software RGB SDL output)" );
 914     }
 915     else
 916     {
 917         if( p_vout->p_sys->p_overlay->hw_overlay )
 918         {
 919             SDL_WM_SetCaption( VOUT_TITLE " (hardware YUV SDL output)",
 920                                VOUT_TITLE " (hardware YUV SDL output)" );
 921         }
 922         else
 923         {
 924             SDL_WM_SetCaption( VOUT_TITLE " (software YUV SDL output)",
 925                                VOUT_TITLE " (software YUV SDL output)" );
 926         }
 927     }
 928
 929     SDL_EventState( SDL_KEYUP, SDL_IGNORE );               /* ignore keys up */
 930
 931     return VLC_SUCCESS;
 932 }
 933
 934 /*****************************************************************************
 935  * CloseDisplay: close and reset SDL device
 936  *****************************************************************************
 937  * This function returns all resources allocated by OpenDisplay and restore
 938  * the original state of the device.
 939  *****************************************************************************/
 940 static void CloseDisplay( vout_thread_t *p_vout )
 941 {
 942     SDL_FreeYUVOverlay( p_vout->p_sys->p_overlay );
 943     SDL_UnlockSurface ( p_vout->p_sys->p_display );
 944     SDL_FreeSurface( p_vout->p_sys->p_display );
 945 }
 946
 947 /*****************************************************************************
 948  * NewPicture: allocate a picture
 949  *****************************************************************************
 950  * Returns 0 on success, -1 otherwise
 951  *****************************************************************************/
 952 static int NewPicture( vout_thread_t *p_vout, picture_t *p_pic )
 953 {
 954     int i_width  = p_vout->output.i_width;
 955     int i_height = p_vout->output.i_height;
 956
 957     if( p_vout->p_sys->p_overlay == NULL )
 958     {
 959         /* RGB picture */
 960         if( p_vout->p_sys->i_surfaces )
 961         {
 962             /* We already allocated this surface, return */
 963             return VLC_EGENERIC;
 964         }
 965
 966         p_pic->p_sys = malloc( sizeof( picture_sys_t ) );
 967
 968         if( p_pic->p_sys == NULL )
 969         {
 970             return VLC_ENOMEM;
 971         }
 972
 973         switch( p_vout->p_sys->p_display->format->BitsPerPixel )
 974         {
 975             case 8:
 976                 p_pic->p->i_pixel_pitch = 1;
 977                 break;
 978             case 15:
 979             case 16:
 980                 p_pic->p->i_pixel_pitch = 2;
 981                 break;
 982             case 24:
 983             case 32:
 984                 p_pic->p->i_pixel_pitch = 4;
 985                 break;
 986             default:
 987                 return VLC_EGENERIC;
 988         }
 989
 990         p_pic->p->p_pixels = p_vout->p_sys->p_display->pixels;
 991         p_pic->p->i_lines = p_vout->p_sys->p_display->h;
 992         p_pic->p->i_visible_lines = p_vout->p_sys->p_display->h;
 993         p_pic->p->i_pitch = p_vout->p_sys->p_display->pitch;
 994         p_pic->p->i_visible_pitch =
 995             p_pic->p->i_pixel_pitch * p_vout->p_sys->p_display->w;
 996
 997         p_vout->p_sys->i_surfaces++;
 998
 999         p_pic->i_planes = 1;
1000     }
1001     else
1002     {
1003         p_pic->p_sys = malloc( sizeof( picture_sys_t ) );
1004
1005         if( p_pic->p_sys == NULL )
1006         {
1007             return VLC_ENOMEM;
1008         }
1009
1010         p_pic->p_sys->p_overlay =
1011             SDL_CreateYUVOverlay( i_width, i_height,
1012                                   p_vout->output.i_chroma,
1013                                   p_vout->p_sys->p_display );
1014
1015         if( p_pic->p_sys->p_overlay == NULL )
1016         {
1017             free( p_pic->p_sys );
1018             return VLC_EGENERIC;
1019         }
1020
1021         SDL_LockYUVOverlay( p_pic->p_sys->p_overlay );
1022
1023         p_pic->Y_PIXELS = p_pic->p_sys->p_overlay->pixels[0];
1024         p_pic->p[Y_PLANE].i_lines = p_pic->p_sys->p_overlay->h;
1025         p_pic->p[Y_PLANE].i_visible_lines = p_pic->p_sys->p_overlay->h;
1026         p_pic->p[Y_PLANE].i_pitch = p_pic->p_sys->p_overlay->pitches[0];
1027
1028         switch( p_vout->output.i_chroma )
1029         {
1030         case SDL_YV12_OVERLAY:
1031             p_pic->p[Y_PLANE].i_pixel_pitch = 1;
1032             p_pic->p[Y_PLANE].i_visible_pitch = p_pic->p_sys->p_overlay->w;
1033
1034             p_pic->U_PIXELS = p_pic->p_sys->p_overlay->pixels[2];
1035             p_pic->p[U_PLANE].i_lines = p_pic->p_sys->p_overlay->h / 2;
1036             p_pic->p[U_PLANE].i_visible_lines = p_pic->p_sys->p_overlay->h / 2;
1037             p_pic->p[U_PLANE].i_pitch = p_pic->p_sys->p_overlay->pitches[2];
1038             p_pic->p[U_PLANE].i_pixel_pitch = 1;
1039             p_pic->p[U_PLANE].i_visible_pitch = p_pic->p_sys->p_overlay->w / 2;
1040
1041             p_pic->V_PIXELS = p_pic->p_sys->p_overlay->pixels[1];
1042             p_pic->p[V_PLANE].i_lines = p_pic->p_sys->p_overlay->h / 2;
1043             p_pic->p[V_PLANE].i_visible_lines = p_pic->p_sys->p_overlay->h / 2;
1044             p_pic->p[V_PLANE].i_pitch = p_pic->p_sys->p_overlay->pitches[1];
1045             p_pic->p[V_PLANE].i_pixel_pitch = 1;
1046             p_pic->p[V_PLANE].i_visible_pitch = p_pic->p_sys->p_overlay->w / 2;
1047
1048             p_pic->i_planes = 3;
1049             break;
1050
1051         case SDL_IYUV_OVERLAY:
1052             p_pic->p[Y_PLANE].i_pixel_pitch = 1;
1053             p_pic->p[Y_PLANE].i_visible_pitch = p_pic->p_sys->p_overlay->w;
1054
1055             p_pic->U_PIXELS = p_pic->p_sys->p_overlay->pixels[1];
1056             p_pic->p[U_PLANE].i_lines = p_pic->p_sys->p_overlay->h / 2;
1057             p_pic->p[U_PLANE].i_visible_lines = p_pic->p_sys->p_overlay->h / 2;
1058             p_pic->p[U_PLANE].i_pitch = p_pic->p_sys->p_overlay->pitches[1];
1059             p_pic->p[U_PLANE].i_pixel_pitch = 1;
1060             p_pic->p[U_PLANE].i_visible_pitch = p_pic->p_sys->p_overlay->w / 2;
1061
1062             p_pic->V_PIXELS = p_pic->p_sys->p_overlay->pixels[2];
1063             p_pic->p[V_PLANE].i_lines = p_pic->p_sys->p_overlay->h / 2;
1064             p_pic->p[V_PLANE].i_visible_lines = p_pic->p_sys->p_overlay->h / 2;
1065             p_pic->p[V_PLANE].i_pitch = p_pic->p_sys->p_overlay->pitches[2];
1066             p_pic->p[V_PLANE].i_pixel_pitch = 1;
1067             p_pic->p[V_PLANE].i_visible_pitch = p_pic->p_sys->p_overlay->w / 2;
1068
1069             p_pic->i_planes = 3;
1070             break;
1071
1072         default:
1073             p_pic->p[Y_PLANE].i_pixel_pitch = 2;
1074             p_pic->p[U_PLANE].i_visible_pitch = p_pic->p_sys->p_overlay->w * 2;
1075
1076             p_pic->i_planes = 1;
1077             break;
1078         }
1079     }
1080
1081     return VLC_SUCCESS;
1082 }
1083
1084 /*****************************************************************************
1085  * SetPalette: sets an 8 bpp palette
1086  *****************************************************************************/
1087 static void SetPalette( vout_thread_t *p_vout,
1088                         uint16_t *red, uint16_t *green, uint16_t *blue )
1089 {
1090     SDL_Color colors[256];
1091     int i;
1092
1093     /* Fill colors with color information */
1094     for( i = 0; i < 256; i++ )
1095     {
1096         colors[ i ].r = red[ i ] >> 8;
1097         colors[ i ].g = green[ i ] >> 8;
1098         colors[ i ].b = blue[ i ] >> 8;
1099     }
1100
1101     /* Set palette */
1102     if( SDL_SetColors( p_vout->p_sys->p_display, colors, 0, 256 ) == 0 )
1103     {
1104         msg_Err( p_vout, "failed to set palette" );
1105     }
1106 }
1107