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 static vlc_mutex_t sdl_lock = VLC_STATIC_MUTEX;
 139
 140 /*****************************************************************************
 141  * OpenVideo: allocate SDL video thread output method
 142  *****************************************************************************
 143  * This function allocate and initialize a SDL vout method. It uses some of the
 144  * vout properties to choose the correct mode, and change them according to the
 145  * mode actually used.
 146  *****************************************************************************/
 147 static int Open ( vlc_object_t *p_this )
 148 {
 149     vout_thread_t * p_vout = (vout_thread_t *)p_this;
 150     /* XXX: check for conflicts with the SDL audio output */
 151     vlc_mutex_lock( &sdl_lock );
 152
 153 #ifdef HAVE_SETENV
 154     char *psz_method;
 155 #endif
 156
 157     p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
 158     if( p_vout->p_sys == NULL )
 159     {
 160         vlc_mutex_unlock( &sdl_lock );
 161         return VLC_ENOMEM;
 162     }
 163
 164     memset( p_vout->p_sys, 0, sizeof( vout_sys_t ) );
 165
 166     /* Check if SDL video module has been initialized */
 167     if( SDL_WasInit( SDL_INIT_VIDEO ) != 0 )
 168     {
 169         vlc_mutex_unlock( &sdl_lock );
 170         free( p_vout->p_sys );
 171         return VLC_EGENERIC;
 172     }
 173
 174     /* Allocate structure */
 175     p_vout->pf_init = Init;
 176     p_vout->pf_end = End;
 177     p_vout->pf_manage = Manage;
 178     p_vout->pf_render = NULL;
 179     p_vout->pf_display = Display;
 180     p_vout->pf_control = NULL;
 181
 182 #ifdef HAVE_SETENV
 183     char* psz = psz_method = config_GetPsz( p_vout, "vout" );
 184     if( psz_method )
 185     {
 186         while( *psz_method && *psz_method != ':' )
 187         {
 188             psz_method++;
 189         }
 190
 191         if( *psz_method )
 192         {
 193             setenv( "SDL_VIDEODRIVER", psz_method + 1, 1 );
 194         }
 195     }
 196     free( psz );
 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( &sdl_lock );
 215         return VLC_EGENERIC;
 216     }
 217
 218     vlc_mutex_unlock( &sdl_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                     var_Get( p_vout, "mouse-button-down", &val );
 463                     val.i_int &= ~4;
 464                     var_Set( p_vout, "mouse-button-down", val );
 465
 466                     val.b_bool = true;
 467                     var_Set( p_vout->p_libvlc, "intf-popupmenu", val );
 468                 }
 469                 break;
 470             }
 471             break;
 472
 473         /* Mouse button pressed */
 474         case SDL_MOUSEBUTTONDOWN:
 475             switch( event.button.button )
 476             {
 477             case SDL_BUTTON_LEFT:
 478                 var_Get( p_vout, "mouse-button-down", &val );
 479                 val.i_int |= 1;
 480                 var_Set( p_vout, "mouse-button-down", val );
 481
 482                 /* detect double-clicks */
 483                 if( ( mdate() - p_vout->p_sys->i_lastpressed ) < 300000 )
 484                     p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
 485
 486                 p_vout->p_sys->i_lastpressed = mdate();
 487                 break;
 488
 489             case SDL_BUTTON_MIDDLE:
 490                 var_Get( p_vout, "mouse-button-down", &val );
 491                 val.i_int |= 2;
 492                 var_Set( p_vout, "mouse-button-down", val );
 493                 break;
 494
 495             case SDL_BUTTON_RIGHT:
 496                 var_Get( p_vout, "mouse-button-down", &val );
 497                 val.i_int |= 4;
 498                 var_Set( p_vout, "mouse-button-down", val );
 499                 break;
 500             }
 501             break;
 502
 503         /* Quit event (close the window) */
 504         case SDL_QUIT:
 505             {
 506 #if 0
 507                 playlist_t *p_playlist = pl_Hold( p_vout );
 508                 if( p_playlist != NULL )
 509                 {
 510                     playlist_Stop( p_playlist );
 511                     pl_Release( p_vout );
 512                 }
 513 #else
 514 #warning FIXME FIXME ?
 515 #endif
 516             }
 517             break;
 518
 519         /* Key pressed */
 520         case SDL_KEYDOWN:
 521             /* convert the key if possible */
 522             val.i_int = ConvertKey( event.key.keysym.sym );
 523
 524             if( !val.i_int )
 525             {
 526                 /* Find the right caracter */
 527                 if( ( event.key.keysym.unicode & 0xff80 ) == 0 )
 528                 {
 529                     val.i_int = event.key.keysym.unicode & 0x7f;
 530                     /* FIXME: find a better solution than this
 531                               hack to find the right caracter */
 532                     if( val.i_int >= 1 && val.i_int <= 26 )
 533                         val.i_int += 96;
 534                     else if( val.i_int >= 65 && val.i_int <= 90 )
 535                         val.i_int += 32;
 536                 }
 537             }
 538
 539             if( val.i_int )
 540             {
 541                 if( ( event.key.keysym.mod & KMOD_SHIFT ) )
 542                 {
 543                     val.i_int |= KEY_MODIFIER_SHIFT;
 544                 }
 545                 if( ( event.key.keysym.mod & KMOD_CTRL ) )
 546                 {
 547                     val.i_int |= KEY_MODIFIER_CTRL;
 548                 }
 549                 if( ( event.key.keysym.mod & KMOD_ALT ) )
 550                 {
 551                     val.i_int |= KEY_MODIFIER_ALT;
 552                 }
 553                 var_Set( p_vout->p_libvlc, "key-pressed", val );
 554             }
 555
 556         default:
 557             break;
 558         }
 559     }
 560
 561     /* Fullscreen change */
 562     if( p_vout->i_changes & VOUT_FULLSCREEN_CHANGE )
 563     {
 564         vlc_value_t val_fs;
 565
 566         /* Update the object variable and trigger callback */
 567         val_fs.b_bool = !p_vout->b_fullscreen;
 568         p_vout->b_fullscreen = !p_vout->b_fullscreen;
 569         var_Set( p_vout, "fullscreen", val_fs );
 570
 571         /*TODO: add the "always on top" code here !*/
 572
 573         p_vout->p_sys->b_cursor_autohidden = 0;
 574         SDL_ShowCursor( p_vout->p_sys->b_cursor &&
 575                         ! p_vout->p_sys->b_cursor_autohidden );
 576
 577         p_vout->i_changes &= ~VOUT_FULLSCREEN_CHANGE;
 578         p_vout->i_changes |= VOUT_SIZE_CHANGE;
 579     }
 580
 581     /* Crop or Aspect Ratio Changes */
 582     if( p_vout->i_changes & VOUT_CROP_CHANGE ||
 583         p_vout->i_changes & VOUT_ASPECT_CHANGE )
 584     {
 585         p_vout->i_changes &= ~VOUT_CROP_CHANGE;
 586         p_vout->i_changes &= ~VOUT_ASPECT_CHANGE;
 587
 588         p_vout->fmt_out.i_x_offset = p_vout->fmt_in.i_x_offset;
 589         p_vout->fmt_out.i_y_offset = p_vout->fmt_in.i_y_offset;
 590         p_vout->fmt_out.i_visible_width = p_vout->fmt_in.i_visible_width;
 591         p_vout->fmt_out.i_visible_height = p_vout->fmt_in.i_visible_height;
 592         p_vout->fmt_out.i_aspect = p_vout->fmt_in.i_aspect;
 593         p_vout->fmt_out.i_sar_num = p_vout->fmt_in.i_sar_num;
 594         p_vout->fmt_out.i_sar_den = p_vout->fmt_in.i_sar_den;
 595         p_vout->output.i_aspect = p_vout->fmt_in.i_aspect;
 596
 597         p_vout->i_changes |= VOUT_SIZE_CHANGE;
 598     }
 599
 600     /* Size change */
 601     if( p_vout->i_changes & VOUT_SIZE_CHANGE )
 602     {
 603         msg_Dbg( p_vout, "video display resized (%dx%d)",
 604                  p_vout->p_sys->i_width, p_vout->p_sys->i_height );
 605
 606         CloseDisplay( p_vout );
 607         OpenDisplay( p_vout );
 608
 609         /* We don't need to signal the vout thread about the size change if
 610          * we can handle rescaling ourselves */
 611         if( p_vout->p_sys->p_overlay != NULL )
 612             p_vout->i_changes &= ~VOUT_SIZE_CHANGE;
 613     }
 614
 615     /* Pointer change */
 616     if( ! p_vout->p_sys->b_cursor_autohidden &&
 617         ( mdate() - p_vout->p_sys->i_lastmoved >
 618             p_vout->p_sys->i_mouse_hide_timeout ) )
 619     {
 620         /* Hide the mouse automatically */
 621         p_vout->p_sys->b_cursor_autohidden = 1;
 622         SDL_ShowCursor( 0 );
 623     }
 624
 625     return VLC_SUCCESS;
 626 }
 627
 628 /*****************************************************************************
 629  * Key events handling
 630  *****************************************************************************/
 631 static const struct
 632 {
 633     SDLKey sdl_key;
 634     int i_vlckey;
 635 } sdlkeys_to_vlckeys[] =
 636 {
 637     { SDLK_F1,  KEY_F1 },
 638     { SDLK_F2,  KEY_F2 },
 639     { SDLK_F3,  KEY_F3 },
 640     { SDLK_F4,  KEY_F4 },
 641     { SDLK_F5,  KEY_F5 },
 642     { SDLK_F6,  KEY_F6 },
 643     { SDLK_F7,  KEY_F7 },
 644     { SDLK_F8,  KEY_F8 },
 645     { SDLK_F9,  KEY_F9 },
 646     { SDLK_F10, KEY_F10 },
 647     { SDLK_F11, KEY_F11 },
 648     { SDLK_F12, KEY_F12 },
 649
 650     { SDLK_RETURN, KEY_ENTER },
 651     { SDLK_KP_ENTER, KEY_ENTER },
 652     { SDLK_SPACE, KEY_SPACE },
 653     { SDLK_ESCAPE, KEY_ESC },
 654
 655     { SDLK_MENU, KEY_MENU },
 656     { SDLK_LEFT, KEY_LEFT },
 657     { SDLK_RIGHT, KEY_RIGHT },
 658     { SDLK_UP, KEY_UP },
 659     { SDLK_DOWN, KEY_DOWN },
 660
 661     { SDLK_HOME, KEY_HOME },
 662     { SDLK_END, KEY_END },
 663     { SDLK_PAGEUP, KEY_PAGEUP },
 664     { SDLK_PAGEDOWN,  KEY_PAGEDOWN },
 665
 666     { SDLK_INSERT, KEY_INSERT },
 667     { SDLK_DELETE, KEY_DELETE },
 668     /*TODO: find a equivalent for SDL
 669     { , KEY_MEDIA_NEXT_TRACK }
 670     { , KEY_MEDIA_PREV_TRACK }
 671     { , KEY_VOLUME_MUTE }
 672     { , KEY_VOLUME_DOWN }
 673     { , KEY_VOLUME_UP }
 674     { , KEY_MEDIA_PLAY_PAUSE }
 675     { , KEY_MEDIA_PLAY_PAUSE }*/
 676
 677     { 0, 0 }
 678 };
 679
 680 static int ConvertKey( SDLKey sdl_key )
 681 {
 682     int i;
 683     for( i=0; sdlkeys_to_vlckeys[i].sdl_key != 0; i++ )
 684     {
 685         if( sdlkeys_to_vlckeys[i].sdl_key == sdl_key )
 686         {
 687             return sdlkeys_to_vlckeys[i].i_vlckey;
 688         }
 689     }
 690     return 0;
 691 }
 692
 693
 694 /*****************************************************************************
 695  * Display: displays previously rendered output
 696  *****************************************************************************
 697  * This function sends the currently rendered image to the display.
 698  *****************************************************************************/
 699 static void Display( vout_thread_t *p_vout, picture_t *p_pic )
 700 {
 701     unsigned int x, y, w, h;
 702     SDL_Rect disp;
 703
 704     vout_PlacePicture( p_vout, p_vout->p_sys->i_width, p_vout->p_sys->i_height,
 705                        &x, &y, &w, &h );
 706     disp.x = x;
 707     disp.y = y;
 708     disp.w = w;
 709     disp.h = h;
 710
 711     if( p_vout->p_sys->p_overlay == NULL )
 712     {
 713         /* RGB picture */
 714         SDL_Flip( p_vout->p_sys->p_display );
 715     }
 716     else
 717     {
 718         /* Overlay picture */
 719         SDL_UnlockYUVOverlay( p_pic->p_sys->p_overlay);
 720         SDL_DisplayYUVOverlay( p_pic->p_sys->p_overlay , &disp );
 721         SDL_LockYUVOverlay( p_pic->p_sys->p_overlay);
 722     }
 723 }
 724
 725 /* following functions are local */
 726
 727 /*****************************************************************************
 728  * OpenDisplay: open and initialize SDL device
 729  *****************************************************************************
 730  * Open and initialize display according to preferences specified in the vout
 731  * thread fields.
 732  *****************************************************************************/
 733 static int OpenDisplay( vout_thread_t *p_vout )
 734 {
 735     uint32_t i_flags;
 736     int i_bpp;
 737
 738     /* SDL fucked up fourcc definitions on bigendian machines */
 739     uint32_t i_sdl_chroma;
 740     char *psz_chroma = NULL;
 741     uint32_t i_chroma = 0;
 742
 743     bool b_overlay = config_GetInt( p_vout, "overlay" );
 744
 745     /* Set main window's size */
 746 #if SDL_VERSION_ATLEAST(1,2,10)
 747     p_vout->p_sys->i_width = p_vout->b_fullscreen ? p_vout->p_sys->i_desktop_width :
 748                                                     p_vout->i_window_width;
 749     p_vout->p_sys->i_height = p_vout->b_fullscreen ? p_vout->p_sys->i_desktop_height :
 750                                                      p_vout->i_window_height;
 751 #else
 752     p_vout->p_sys->i_width = p_vout->b_fullscreen ? p_vout->output.i_width :
 753                                                     p_vout->i_window_width;
 754     p_vout->p_sys->i_height = p_vout->b_fullscreen ? p_vout->output.i_height :
 755                                                      p_vout->i_window_height;
 756 #endif
 757
 758     /* Initialize flags and cursor */
 759     i_flags = SDL_ANYFORMAT | SDL_HWPALETTE | SDL_HWSURFACE | SDL_DOUBLEBUF;
 760     i_flags |= p_vout->b_fullscreen ? SDL_FULLSCREEN : SDL_RESIZABLE;
 761
 762     i_bpp = SDL_VideoModeOK( p_vout->p_sys->i_width, p_vout->p_sys->i_height,
 763                              SDL_DEFAULT_BPP, i_flags );
 764     if( i_bpp == 0 )
 765     {
 766         msg_Err( p_vout, "no video mode available" );
 767         return VLC_EGENERIC;
 768     }
 769
 770     p_vout->p_sys->p_display = SDL_SetVideoMode( p_vout->p_sys->i_width,
 771                                                  p_vout->p_sys->i_height,
 772                                                  i_bpp, i_flags );
 773
 774     if( p_vout->p_sys->p_display == NULL )
 775     {
 776         msg_Err( p_vout, "cannot set video mode" );
 777         return VLC_EGENERIC;
 778     }
 779
 780     SDL_LockSurface( p_vout->p_sys->p_display );
 781
 782     if( ( psz_chroma = config_GetPsz( p_vout, "sdl-chroma" ) ) )
 783     {
 784         if( strlen( psz_chroma ) >= 4 )
 785         {
 786             memcpy(&i_chroma, psz_chroma, 4);
 787             msg_Dbg( p_vout, "Forcing chroma to 0x%.8x (%4.4s)", i_chroma, (char*)&i_chroma );
 788         }
 789         else
 790         {
 791             free( psz_chroma );
 792             psz_chroma = NULL;
 793         }
 794     }
 795
 796     if( b_overlay )
 797     {
 798         /* Choose the chroma we will try first. */
 799         do
 800         {
 801             if( !psz_chroma ) i_chroma = 0;
 802             switch( i_chroma ? i_chroma : p_vout->render.i_chroma )
 803             {
 804                 case VLC_FOURCC('Y','U','Y','2'):
 805                 case VLC_FOURCC('Y','U','N','V'):
 806                     p_vout->output.i_chroma = VLC_FOURCC('Y','U','Y','2');
 807                     i_sdl_chroma = SDL_YUY2_OVERLAY;
 808                     break;
 809                 case VLC_FOURCC('U','Y','V','Y'):
 810                 case VLC_FOURCC('U','Y','N','V'):
 811                 case VLC_FOURCC('Y','4','2','2'):
 812                     p_vout->output.i_chroma = VLC_FOURCC('U','Y','V','Y');
 813                     i_sdl_chroma = SDL_UYVY_OVERLAY;
 814                     break;
 815                 case VLC_FOURCC('Y','V','Y','U'):
 816                     p_vout->output.i_chroma = VLC_FOURCC('Y','V','Y','U');
 817                     i_sdl_chroma = SDL_YVYU_OVERLAY;
 818                     break;
 819                 case VLC_FOURCC('Y','V','1','2'):
 820                 case VLC_FOURCC('I','4','2','0'):
 821                 case VLC_FOURCC('I','Y','U','V'):
 822                 default:
 823                     p_vout->output.i_chroma = VLC_FOURCC('Y','V','1','2');
 824                     i_sdl_chroma = SDL_YV12_OVERLAY;
 825                     break;
 826             }
 827             free( psz_chroma ); psz_chroma = NULL;
 828
 829             p_vout->p_sys->p_overlay =
 830                 SDL_CreateYUVOverlay( 32, 32, i_sdl_chroma,
 831                                       p_vout->p_sys->p_display );
 832             /* FIXME: if the first overlay we find is software, don't stop,
 833              * because we may find a hardware one later ... */
 834         }
 835         while( i_chroma && !p_vout->p_sys->p_overlay );
 836
 837
 838         /* If this best choice failed, fall back to other chromas */
 839         if( p_vout->p_sys->p_overlay == NULL )
 840         {
 841             p_vout->output.i_chroma = VLC_FOURCC('I','Y','U','V');
 842             p_vout->p_sys->p_overlay =
 843                 SDL_CreateYUVOverlay( 32, 32, SDL_IYUV_OVERLAY,
 844                                       p_vout->p_sys->p_display );
 845         }
 846
 847         if( p_vout->p_sys->p_overlay == NULL )
 848         {
 849             p_vout->output.i_chroma = VLC_FOURCC('Y','V','1','2');
 850             p_vout->p_sys->p_overlay =
 851                 SDL_CreateYUVOverlay( 32, 32, SDL_YV12_OVERLAY,
 852                                       p_vout->p_sys->p_display );
 853         }
 854
 855         if( p_vout->p_sys->p_overlay == NULL )
 856         {
 857             p_vout->output.i_chroma = VLC_FOURCC('Y','U','Y','2');
 858             p_vout->p_sys->p_overlay =
 859                 SDL_CreateYUVOverlay( 32, 32, SDL_YUY2_OVERLAY,
 860                                       p_vout->p_sys->p_display );
 861         }
 862     }
 863
 864     if( p_vout->p_sys->p_overlay == NULL )
 865     {
 866         if( b_overlay )
 867             msg_Warn( p_vout, "no SDL overlay for 0x%.8x (%4.4s)",
 868                       p_vout->render.i_chroma,
 869                       (char*)&p_vout->render.i_chroma );
 870         else
 871             msg_Warn( p_vout, "SDL overlay disabled by the user" );
 872
 873         switch( p_vout->p_sys->p_display->format->BitsPerPixel )
 874         {
 875             case 8:
 876                 p_vout->output.i_chroma = VLC_FOURCC('R','G','B','2');
 877                 p_vout->output.pf_setpalette = SetPalette;
 878                 break;
 879             case 15:
 880                 p_vout->output.i_chroma = VLC_FOURCC('R','V','1','5');
 881                 break;
 882             case 16:
 883                 p_vout->output.i_chroma = VLC_FOURCC('R','V','1','6');
 884                 break;
 885             case 24:
 886                 p_vout->output.i_chroma = VLC_FOURCC('R','V','2','4');
 887                 break;
 888             case 32:
 889                 p_vout->output.i_chroma = VLC_FOURCC('R','V','3','2');
 890                 break;
 891             default:
 892                 msg_Err( p_vout, "unknown screen depth %i",
 893                          p_vout->p_sys->p_display->format->BitsPerPixel );
 894                 SDL_UnlockSurface( p_vout->p_sys->p_display );
 895                 SDL_FreeSurface( p_vout->p_sys->p_display );
 896                 return VLC_EGENERIC;
 897         }
 898
 899         p_vout->output.i_rmask = p_vout->p_sys->p_display->format->Rmask;
 900         p_vout->output.i_gmask = p_vout->p_sys->p_display->format->Gmask;
 901         p_vout->output.i_bmask = p_vout->p_sys->p_display->format->Bmask;
 902
 903         SDL_WM_SetCaption( VOUT_TITLE " (software RGB SDL output)",
 904                            VOUT_TITLE " (software RGB SDL output)" );
 905     }
 906     else
 907     {
 908         if( p_vout->p_sys->p_overlay->hw_overlay )
 909         {
 910             SDL_WM_SetCaption( VOUT_TITLE " (hardware YUV SDL output)",
 911                                VOUT_TITLE " (hardware YUV SDL output)" );
 912         }
 913         else
 914         {
 915             SDL_WM_SetCaption( VOUT_TITLE " (software YUV SDL output)",
 916                                VOUT_TITLE " (software YUV SDL output)" );
 917         }
 918     }
 919
 920     SDL_EventState( SDL_KEYUP, SDL_IGNORE );               /* ignore keys up */
 921
 922     return VLC_SUCCESS;
 923 }
 924
 925 /*****************************************************************************
 926  * CloseDisplay: close and reset SDL device
 927  *****************************************************************************
 928  * This function returns all resources allocated by OpenDisplay and restore
 929  * the original state of the device.
 930  *****************************************************************************/
 931 static void CloseDisplay( vout_thread_t *p_vout )
 932 {
 933     SDL_FreeYUVOverlay( p_vout->p_sys->p_overlay );
 934     SDL_UnlockSurface ( p_vout->p_sys->p_display );
 935     SDL_FreeSurface( p_vout->p_sys->p_display );
 936 }
 937
 938 /*****************************************************************************
 939  * NewPicture: allocate a picture
 940  *****************************************************************************
 941  * Returns 0 on success, -1 otherwise
 942  *****************************************************************************/
 943 static int NewPicture( vout_thread_t *p_vout, picture_t *p_pic )
 944 {
 945     int i_width  = p_vout->output.i_width;
 946     int i_height = p_vout->output.i_height;
 947
 948     if( p_vout->p_sys->p_overlay == NULL )
 949     {
 950         /* RGB picture */
 951         if( p_vout->p_sys->i_surfaces )
 952         {
 953             /* We already allocated this surface, return */
 954             return VLC_EGENERIC;
 955         }
 956
 957         p_pic->p_sys = malloc( sizeof( picture_sys_t ) );
 958
 959         if( p_pic->p_sys == NULL )
 960         {
 961             return VLC_ENOMEM;
 962         }
 963
 964         switch( p_vout->p_sys->p_display->format->BitsPerPixel )
 965         {
 966             case 8:
 967                 p_pic->p->i_pixel_pitch = 1;
 968                 break;
 969             case 15:
 970             case 16:
 971                 p_pic->p->i_pixel_pitch = 2;
 972                 break;
 973             case 24:
 974             case 32:
 975                 p_pic->p->i_pixel_pitch = 4;
 976                 break;
 977             default:
 978                 return VLC_EGENERIC;
 979         }
 980
 981         p_pic->p->p_pixels = p_vout->p_sys->p_display->pixels;
 982         p_pic->p->i_lines = p_vout->p_sys->p_display->h;
 983         p_pic->p->i_visible_lines = p_vout->p_sys->p_display->h;
 984         p_pic->p->i_pitch = p_vout->p_sys->p_display->pitch;
 985         p_pic->p->i_visible_pitch =
 986             p_pic->p->i_pixel_pitch * p_vout->p_sys->p_display->w;
 987
 988         p_vout->p_sys->i_surfaces++;
 989
 990         p_pic->i_planes = 1;
 991     }
 992     else
 993     {
 994         p_pic->p_sys = malloc( sizeof( picture_sys_t ) );
 995
 996         if( p_pic->p_sys == NULL )
 997         {
 998             return VLC_ENOMEM;
 999         }
1000
1001         p_pic->p_sys->p_overlay =
1002             SDL_CreateYUVOverlay( i_width, i_height,
1003                                   p_vout->output.i_chroma,
1004                                   p_vout->p_sys->p_display );
1005
1006         if( p_pic->p_sys->p_overlay == NULL )
1007         {
1008             free( p_pic->p_sys );
1009             return VLC_EGENERIC;
1010         }
1011
1012         SDL_LockYUVOverlay( p_pic->p_sys->p_overlay );
1013
1014         p_pic->Y_PIXELS = p_pic->p_sys->p_overlay->pixels[0];
1015         p_pic->p[Y_PLANE].i_lines = p_pic->p_sys->p_overlay->h;
1016         p_pic->p[Y_PLANE].i_visible_lines = p_pic->p_sys->p_overlay->h;
1017         p_pic->p[Y_PLANE].i_pitch = p_pic->p_sys->p_overlay->pitches[0];
1018
1019         switch( p_vout->output.i_chroma )
1020         {
1021         case SDL_YV12_OVERLAY:
1022             p_pic->p[Y_PLANE].i_pixel_pitch = 1;
1023             p_pic->p[Y_PLANE].i_visible_pitch = p_pic->p_sys->p_overlay->w;
1024
1025             p_pic->U_PIXELS = p_pic->p_sys->p_overlay->pixels[2];
1026             p_pic->p[U_PLANE].i_lines = p_pic->p_sys->p_overlay->h / 2;
1027             p_pic->p[U_PLANE].i_visible_lines = p_pic->p_sys->p_overlay->h / 2;
1028             p_pic->p[U_PLANE].i_pitch = p_pic->p_sys->p_overlay->pitches[2];
1029             p_pic->p[U_PLANE].i_pixel_pitch = 1;
1030             p_pic->p[U_PLANE].i_visible_pitch = p_pic->p_sys->p_overlay->w / 2;
1031
1032             p_pic->V_PIXELS = p_pic->p_sys->p_overlay->pixels[1];
1033             p_pic->p[V_PLANE].i_lines = p_pic->p_sys->p_overlay->h / 2;
1034             p_pic->p[V_PLANE].i_visible_lines = p_pic->p_sys->p_overlay->h / 2;
1035             p_pic->p[V_PLANE].i_pitch = p_pic->p_sys->p_overlay->pitches[1];
1036             p_pic->p[V_PLANE].i_pixel_pitch = 1;
1037             p_pic->p[V_PLANE].i_visible_pitch = p_pic->p_sys->p_overlay->w / 2;
1038
1039             p_pic->i_planes = 3;
1040             break;
1041
1042         case SDL_IYUV_OVERLAY:
1043             p_pic->p[Y_PLANE].i_pixel_pitch = 1;
1044             p_pic->p[Y_PLANE].i_visible_pitch = p_pic->p_sys->p_overlay->w;
1045
1046             p_pic->U_PIXELS = p_pic->p_sys->p_overlay->pixels[1];
1047             p_pic->p[U_PLANE].i_lines = p_pic->p_sys->p_overlay->h / 2;
1048             p_pic->p[U_PLANE].i_visible_lines = p_pic->p_sys->p_overlay->h / 2;
1049             p_pic->p[U_PLANE].i_pitch = p_pic->p_sys->p_overlay->pitches[1];
1050             p_pic->p[U_PLANE].i_pixel_pitch = 1;
1051             p_pic->p[U_PLANE].i_visible_pitch = p_pic->p_sys->p_overlay->w / 2;
1052
1053             p_pic->V_PIXELS = p_pic->p_sys->p_overlay->pixels[2];
1054             p_pic->p[V_PLANE].i_lines = p_pic->p_sys->p_overlay->h / 2;
1055             p_pic->p[V_PLANE].i_visible_lines = p_pic->p_sys->p_overlay->h / 2;
1056             p_pic->p[V_PLANE].i_pitch = p_pic->p_sys->p_overlay->pitches[2];
1057             p_pic->p[V_PLANE].i_pixel_pitch = 1;
1058             p_pic->p[V_PLANE].i_visible_pitch = p_pic->p_sys->p_overlay->w / 2;
1059
1060             p_pic->i_planes = 3;
1061             break;
1062
1063         default:
1064             p_pic->p[Y_PLANE].i_pixel_pitch = 2;
1065             p_pic->p[U_PLANE].i_visible_pitch = p_pic->p_sys->p_overlay->w * 2;
1066
1067             p_pic->i_planes = 1;
1068             break;
1069         }
1070     }
1071
1072     return VLC_SUCCESS;
1073 }
1074
1075 /*****************************************************************************
1076  * SetPalette: sets an 8 bpp palette
1077  *****************************************************************************/
1078 static void SetPalette( vout_thread_t *p_vout,
1079                         uint16_t *red, uint16_t *green, uint16_t *blue )
1080 {
1081     SDL_Color colors[256];
1082     int i;
1083
1084     /* Fill colors with color information */
1085     for( i = 0; i < 256; i++ )
1086     {
1087         colors[ i ].r = red[ i ] >> 8;
1088         colors[ i ].g = green[ i ] >> 8;
1089         colors[ i ].b = blue[ i ] >> 8;
1090     }
1091
1092     /* Set palette */
1093     if( SDL_SetColors( p_vout->p_sys->p_display, colors, 0, 256 ) == 0 )
1094     {
1095         msg_Err( p_vout, "failed to set palette" );
1096     }
1097 }
1098