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