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

   1 /*****************************************************************************
   2  * xcommon.c: Functions common to the X11 and XVideo plugins
   3  *****************************************************************************
   4  * Copyright (C) 1998-2001 VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Vincent Seguin <seguin@via.ecp.fr>
   8  *          Sam Hocevar <sam@zoy.org>
   9  *          David Kennedy <dkennedy@tinytoad.com>
  10  *          Gildas Bazin <gbazin@netcourrier.com>
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  25  *****************************************************************************/
  26
  27 /*****************************************************************************
  28  * Preamble
  29  *****************************************************************************/
  30 #include <errno.h>                                                 /* ENOMEM */
  31 #include <stdlib.h>                                                /* free() */
  32 #include <string.h>                                            /* strerror() */
  33
  34 #include <vlc/vlc.h>
  35 #include <vlc/intf.h>
  36 #include <vlc/vout.h>
  37 #include <vlc_keys.h>
  38
  39 #ifdef HAVE_MACHINE_PARAM_H
  40     /* BSD */
  41 #   include <machine/param.h>
  42 #   include <sys/types.h>                                  /* typedef ushort */
  43 #   include <sys/ipc.h>
  44 #endif
  45
  46 #ifndef WIN32
  47 #   include <netinet/in.h>                            /* BSD: struct in_addr */
  48 #endif
  49
  50 #ifdef HAVE_SYS_SHM_H
  51 #   include <sys/shm.h>                                /* shmget(), shmctl() */
  52 #endif
  53
  54 #include <X11/Xlib.h>
  55 #include <X11/Xmd.h>
  56 #include <X11/Xutil.h>
  57 #include <X11/keysym.h>
  58 #ifdef HAVE_SYS_SHM_H
  59 #   include <X11/extensions/XShm.h>
  60 #endif
  61 #ifdef DPMSINFO_IN_DPMS_H
  62 #   include <X11/extensions/dpms.h>
  63 #endif
  64
  65 #ifdef MODULE_NAME_IS_xvideo
  66 #   include <X11/extensions/Xv.h>
  67 #   include <X11/extensions/Xvlib.h>
  68 #endif
  69
  70 #ifdef MODULE_NAME_IS_glx
  71 #   include <GL/glx.h>
  72 #endif
  73
  74 #ifdef HAVE_XINERAMA
  75 #   include <X11/extensions/Xinerama.h>
  76 #endif
  77
  78 #include "xcommon.h"
  79
  80 /*****************************************************************************
  81  * Local prototypes
  82  *****************************************************************************/
  83 int  E_(Activate)   ( vlc_object_t * );
  84 void E_(Deactivate) ( vlc_object_t * );
  85
  86 static int  InitVideo      ( vout_thread_t * );
  87 static void EndVideo       ( vout_thread_t * );
  88 static void DisplayVideo   ( vout_thread_t *, picture_t * );
  89 static int  ManageVideo    ( vout_thread_t * );
  90 static int  Control        ( vout_thread_t *, int, va_list );
  91
  92 static int  InitDisplay    ( vout_thread_t * );
  93
  94 static int  CreateWindow   ( vout_thread_t *, x11_window_t * );
  95 static void DestroyWindow  ( vout_thread_t *, x11_window_t * );
  96
  97 static int  NewPicture     ( vout_thread_t *, picture_t * );
  98 static void FreePicture    ( vout_thread_t *, picture_t * );
  99
 100 static IMAGE_TYPE *CreateImage    ( vout_thread_t *,
 101                                     Display *, EXTRA_ARGS, int, int );
 102 #ifdef HAVE_SYS_SHM_H
 103 static IMAGE_TYPE *CreateShmImage ( vout_thread_t *,
 104                                     Display *, EXTRA_ARGS_SHM, int, int );
 105 #endif
 106
 107 static void ToggleFullScreen      ( vout_thread_t * );
 108
 109 static void EnableXScreenSaver    ( vout_thread_t * );
 110 static void DisableXScreenSaver   ( vout_thread_t * );
 111
 112 static void CreateCursor   ( vout_thread_t * );
 113 static void DestroyCursor  ( vout_thread_t * );
 114 static void ToggleCursor   ( vout_thread_t * );
 115
 116 #ifdef MODULE_NAME_IS_xvideo
 117 static int  XVideoGetPort    ( vout_thread_t *, vlc_fourcc_t, vlc_fourcc_t * );
 118 static void XVideoReleasePort( vout_thread_t *, int );
 119 #endif
 120
 121 #ifdef MODULE_NAME_IS_x11
 122 static void SetPalette     ( vout_thread_t *,
 123                              uint16_t *, uint16_t *, uint16_t * );
 124 #endif
 125
 126 static void TestNetWMSupport( vout_thread_t * );
 127 static int ConvertKey( int );
 128
 129 static int WindowOnTop( vout_thread_t *, vlc_bool_t );
 130
 131 /*****************************************************************************
 132  * Activate: allocate X11 video thread output method
 133  *****************************************************************************
 134  * This function allocate and initialize a X11 vout method. It uses some of the
 135  * vout properties to choose the window size, and change them according to the
 136  * actual properties of the display.
 137  *****************************************************************************/
 138 int E_(Activate) ( vlc_object_t *p_this )
 139 {
 140     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 141     char *        psz_display;
 142     vlc_value_t   val;
 143
 144 #ifdef MODULE_NAME_IS_xvideo
 145     char *       psz_chroma;
 146     vlc_fourcc_t i_chroma = 0;
 147     vlc_bool_t   b_chroma = 0;
 148 #endif
 149
 150     p_vout->pf_init = InitVideo;
 151     p_vout->pf_end = EndVideo;
 152     p_vout->pf_manage = ManageVideo;
 153     p_vout->pf_render = NULL;
 154     p_vout->pf_display = DisplayVideo;
 155     p_vout->pf_control = Control;
 156
 157     /* Allocate structure */
 158     p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
 159     if( p_vout->p_sys == NULL )
 160     {
 161         msg_Err( p_vout, "out of memory" );
 162         return VLC_ENOMEM;
 163     }
 164
 165     vlc_mutex_init( p_vout, &p_vout->p_sys->lock );
 166
 167     /* Open display, using the "display" config variable or the DISPLAY
 168      * environment variable */
 169     psz_display = config_GetPsz( p_vout, MODULE_STRING "-display" );
 170
 171     p_vout->p_sys->p_display = XOpenDisplay( psz_display );
 172
 173     if( p_vout->p_sys->p_display == NULL )                          /* error */
 174     {
 175         msg_Err( p_vout, "cannot open display %s",
 176                          XDisplayName( psz_display ) );
 177         free( p_vout->p_sys );
 178         if( psz_display ) free( psz_display );
 179         return VLC_EGENERIC;
 180     }
 181     if( psz_display ) free( psz_display );
 182
 183     /* Get a screen ID matching the XOpenDisplay return value */
 184     p_vout->p_sys->i_screen = DefaultScreen( p_vout->p_sys->p_display );
 185
 186 #ifdef MODULE_NAME_IS_xvideo
 187     psz_chroma = config_GetPsz( p_vout, "xvideo-chroma" );
 188     if( psz_chroma )
 189     {
 190         if( strlen( psz_chroma ) >= 4 )
 191         {
 192             /* Do not use direct assignment because we are not sure of the
 193              * alignment. */
 194             memcpy(&i_chroma, psz_chroma, 4);
 195             b_chroma = 1;
 196         }
 197
 198         free( psz_chroma );
 199     }
 200
 201     if( b_chroma )
 202     {
 203         msg_Dbg( p_vout, "forcing chroma 0x%.8x (%4.4s)",
 204                  i_chroma, (char*)&i_chroma );
 205     }
 206     else
 207     {
 208         i_chroma = p_vout->render.i_chroma;
 209     }
 210
 211     /* Check that we have access to an XVideo port providing this chroma */
 212     p_vout->p_sys->i_xvport = XVideoGetPort( p_vout, VLC2X11_FOURCC(i_chroma),
 213                                              &p_vout->output.i_chroma );
 214     if( p_vout->p_sys->i_xvport < 0 )
 215     {
 216         /* If a specific chroma format was requested, then we don't try to
 217          * be cleverer than the user. He knew pretty well what he wanted. */
 218         if( b_chroma )
 219         {
 220             XCloseDisplay( p_vout->p_sys->p_display );
 221             free( p_vout->p_sys );
 222             return VLC_EGENERIC;
 223         }
 224
 225         /* It failed, but it's not completely lost ! We try to open an
 226          * XVideo port for an YUY2 picture. We'll need to do an YUV
 227          * conversion, but at least it has got scaling. */
 228         p_vout->p_sys->i_xvport =
 229                         XVideoGetPort( p_vout, X11_FOURCC('Y','U','Y','2'),
 230                                                &p_vout->output.i_chroma );
 231         if( p_vout->p_sys->i_xvport < 0 )
 232         {
 233             /* It failed, but it's not completely lost ! We try to open an
 234              * XVideo port for a simple 16bpp RGB picture. We'll need to do
 235              * an YUV conversion, but at least it has got scaling. */
 236             p_vout->p_sys->i_xvport =
 237                             XVideoGetPort( p_vout, X11_FOURCC('R','V','1','6'),
 238                                                    &p_vout->output.i_chroma );
 239             if( p_vout->p_sys->i_xvport < 0 )
 240             {
 241                 XCloseDisplay( p_vout->p_sys->p_display );
 242                 free( p_vout->p_sys );
 243                 return VLC_EGENERIC;
 244             }
 245         }
 246     }
 247     p_vout->output.i_chroma = X112VLC_FOURCC(p_vout->output.i_chroma);
 248 #endif
 249
 250     /* Create blank cursor (for mouse cursor autohiding) */
 251     p_vout->p_sys->i_time_mouse_last_moved = mdate();
 252     p_vout->p_sys->b_mouse_pointer_visible = 1;
 253     CreateCursor( p_vout );
 254
 255     /* Set main window's size */
 256     p_vout->p_sys->original_window.i_width = p_vout->i_window_width;
 257     p_vout->p_sys->original_window.i_height = p_vout->i_window_height;
 258
 259     /* Spawn base window - this window will include the video output window,
 260      * but also command buttons, subtitles and other indicators */
 261     if( CreateWindow( p_vout, &p_vout->p_sys->original_window ) )
 262     {
 263         msg_Err( p_vout, "cannot create X11 window" );
 264         DestroyCursor( p_vout );
 265         XCloseDisplay( p_vout->p_sys->p_display );
 266         free( p_vout->p_sys );
 267         return VLC_EGENERIC;
 268     }
 269
 270     /* Open and initialize device. */
 271     if( InitDisplay( p_vout ) )
 272     {
 273         msg_Err( p_vout, "cannot initialize X11 display" );
 274         DestroyCursor( p_vout );
 275         DestroyWindow( p_vout, &p_vout->p_sys->original_window );
 276         XCloseDisplay( p_vout->p_sys->p_display );
 277         free( p_vout->p_sys );
 278         return VLC_EGENERIC;
 279     }
 280
 281     /* Disable screen saver */
 282     DisableXScreenSaver( p_vout );
 283
 284     /* Misc init */
 285     p_vout->p_sys->b_altfullscreen = 0;
 286     p_vout->p_sys->i_time_button_last_pressed = 0;
 287
 288     TestNetWMSupport( p_vout );
 289
 290     /* Variable to indicate if the window should be on top of others */
 291     /* Trigger a callback right now */
 292     var_Get( p_vout, "video-on-top", &val );
 293     var_Set( p_vout, "video-on-top", val );
 294
 295     return VLC_SUCCESS;
 296 }
 297
 298 /*****************************************************************************
 299  * Deactivate: destroy X11 video thread output method
 300  *****************************************************************************
 301  * Terminate an output method created by Open
 302  *****************************************************************************/
 303 void E_(Deactivate) ( vlc_object_t *p_this )
 304 {
 305     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 306
 307     /* If the fullscreen window is still open, close it */
 308     if( p_vout->b_fullscreen )
 309     {
 310         ToggleFullScreen( p_vout );
 311     }
 312
 313     /* Restore cursor if it was blanked */
 314     if( !p_vout->p_sys->b_mouse_pointer_visible )
 315     {
 316         ToggleCursor( p_vout );
 317     }
 318
 319 #ifdef MODULE_NAME_IS_x11
 320     /* Destroy colormap */
 321     if( XDefaultDepth(p_vout->p_sys->p_display, p_vout->p_sys->i_screen) == 8 )
 322     {
 323         XFreeColormap( p_vout->p_sys->p_display, p_vout->p_sys->colormap );
 324     }
 325 #elif defined(MODULE_NAME_IS_xvideo)
 326     XVideoReleasePort( p_vout, p_vout->p_sys->i_xvport );
 327 #endif
 328
 329     DestroyCursor( p_vout );
 330     EnableXScreenSaver( p_vout );
 331     DestroyWindow( p_vout, &p_vout->p_sys->original_window );
 332
 333     XCloseDisplay( p_vout->p_sys->p_display );
 334
 335     /* Destroy structure */
 336     vlc_mutex_destroy( &p_vout->p_sys->lock );
 337     free( p_vout->p_sys );
 338 }
 339
 340 /*****************************************************************************
 341  * InitVideo: initialize X11 video thread output method
 342  *****************************************************************************
 343  * This function create the XImages needed by the output thread. It is called
 344  * at the beginning of the thread, but also each time the window is resized.
 345  *****************************************************************************/
 346 static int InitVideo( vout_thread_t *p_vout )
 347 {
 348     int i_index;
 349     picture_t *p_pic;
 350
 351     I_OUTPUTPICTURES = 0;
 352
 353 #ifdef MODULE_NAME_IS_xvideo
 354     /* Initialize the output structure; we already found an XVideo port,
 355      * and the corresponding chroma we will be using. Since we can
 356      * arbitrary scale, stick to the coordinates and aspect. */
 357     p_vout->output.i_width  = p_vout->render.i_width;
 358     p_vout->output.i_height = p_vout->render.i_height;
 359     p_vout->output.i_aspect = p_vout->render.i_aspect;
 360
 361     switch( p_vout->output.i_chroma )
 362     {
 363         case VLC_FOURCC('R','V','1','5'):
 364             p_vout->output.i_rmask = 0x001f;
 365             p_vout->output.i_gmask = 0x07e0;
 366             p_vout->output.i_bmask = 0xf800;
 367             break;
 368         case VLC_FOURCC('R','V','1','6'):
 369             p_vout->output.i_rmask = 0x001f;
 370             p_vout->output.i_gmask = 0x03e0;
 371             p_vout->output.i_bmask = 0x7c00;
 372             break;
 373     }
 374
 375 #elif defined(MODULE_NAME_IS_x11)
 376     /* Initialize the output structure: RGB with square pixels, whatever
 377      * the input format is, since it's the only format we know */
 378     switch( p_vout->p_sys->i_screen_depth )
 379     {
 380         case 8: /* FIXME: set the palette */
 381             p_vout->output.i_chroma = VLC_FOURCC('R','G','B','2'); break;
 382         case 15:
 383             p_vout->output.i_chroma = VLC_FOURCC('R','V','1','5'); break;
 384         case 16:
 385             p_vout->output.i_chroma = VLC_FOURCC('R','V','1','6'); break;
 386         case 24:
 387             p_vout->output.i_chroma = VLC_FOURCC('R','V','2','4'); break;
 388         case 32:
 389             p_vout->output.i_chroma = VLC_FOURCC('R','V','3','2'); break;
 390         default:
 391             msg_Err( p_vout, "unknown screen depth %i",
 392                      p_vout->p_sys->i_screen_depth );
 393             return VLC_SUCCESS;
 394     }
 395
 396     vout_PlacePicture( p_vout, p_vout->p_sys->p_win->i_width,
 397                        p_vout->p_sys->p_win->i_height,
 398                        &i_index, &i_index,
 399                        &p_vout->output.i_width, &p_vout->output.i_height );
 400
 401     /* Assume we have square pixels */
 402     p_vout->output.i_aspect = p_vout->output.i_width
 403                                * VOUT_ASPECT_FACTOR / p_vout->output.i_height;
 404 #endif
 405
 406     /* Try to initialize up to MAX_DIRECTBUFFERS direct buffers */
 407     while( I_OUTPUTPICTURES < MAX_DIRECTBUFFERS )
 408     {
 409         p_pic = NULL;
 410
 411         /* Find an empty picture slot */
 412         for( i_index = 0 ; i_index < VOUT_MAX_PICTURES ; i_index++ )
 413         {
 414           if( p_vout->p_picture[ i_index ].i_status == FREE_PICTURE )
 415             {
 416                 p_pic = p_vout->p_picture + i_index;
 417                 break;
 418             }
 419         }
 420
 421         /* Allocate the picture */
 422         if( p_pic == NULL || NewPicture( p_vout, p_pic ) )
 423         {
 424             break;
 425         }
 426
 427         p_pic->i_status = DESTROYED_PICTURE;
 428         p_pic->i_type   = DIRECT_PICTURE;
 429
 430         PP_OUTPUTPICTURE[ I_OUTPUTPICTURES ] = p_pic;
 431
 432         I_OUTPUTPICTURES++;
 433     }
 434
 435     return VLC_SUCCESS;
 436 }
 437
 438 /*****************************************************************************
 439  * DisplayVideo: displays previously rendered output
 440  *****************************************************************************
 441  * This function sends the currently rendered image to X11 server.
 442  * (The Xv extension takes care of "double-buffering".)
 443  *****************************************************************************/
 444 static void DisplayVideo( vout_thread_t *p_vout, picture_t *p_pic )
 445 {
 446     int i_width, i_height, i_x, i_y;
 447
 448     vout_PlacePicture( p_vout, p_vout->p_sys->p_win->i_width,
 449                        p_vout->p_sys->p_win->i_height,
 450                        &i_x, &i_y, &i_width, &i_height );
 451
 452     vlc_mutex_lock( &p_vout->p_sys->lock );
 453
 454 #ifdef HAVE_SYS_SHM_H
 455     if( p_vout->p_sys->b_shm )
 456     {
 457         /* Display rendered image using shared memory extension */
 458 #   ifdef MODULE_NAME_IS_xvideo
 459         XvShmPutImage( p_vout->p_sys->p_display, p_vout->p_sys->i_xvport,
 460                        p_vout->p_sys->p_win->video_window,
 461                        p_vout->p_sys->p_win->gc, p_pic->p_sys->p_image,
 462                        0 /*src_x*/, 0 /*src_y*/,
 463                        p_vout->output.i_width, p_vout->output.i_height,
 464                        0 /*dest_x*/, 0 /*dest_y*/, i_width, i_height,
 465                        False /* Don't put True here or you'll waste your CPU */ );
 466 #   else
 467         XShmPutImage( p_vout->p_sys->p_display,
 468                       p_vout->p_sys->p_win->video_window,
 469                       p_vout->p_sys->p_win->gc, p_pic->p_sys->p_image,
 470                       0 /*src_x*/, 0 /*src_y*/, 0 /*dest_x*/, 0 /*dest_y*/,
 471                       p_vout->output.i_width, p_vout->output.i_height,
 472                       False /* Don't put True here ! */ );
 473 #   endif
 474     }
 475     else
 476 #endif /* HAVE_SYS_SHM_H */
 477     {
 478         /* Use standard XPutImage -- this is gonna be slow ! */
 479 #ifdef MODULE_NAME_IS_xvideo
 480         XvPutImage( p_vout->p_sys->p_display, p_vout->p_sys->i_xvport,
 481                     p_vout->p_sys->p_win->video_window,
 482                     p_vout->p_sys->p_win->gc, p_pic->p_sys->p_image,
 483                     0 /*src_x*/, 0 /*src_y*/,
 484                     p_vout->output.i_width, p_vout->output.i_height,
 485                     0 /*dest_x*/, 0 /*dest_y*/, i_width, i_height );
 486 #else
 487         XPutImage( p_vout->p_sys->p_display,
 488                    p_vout->p_sys->p_win->video_window,
 489                    p_vout->p_sys->p_win->gc, p_pic->p_sys->p_image,
 490                    0 /*src_x*/, 0 /*src_y*/, 0 /*dest_x*/, 0 /*dest_y*/,
 491                    p_vout->output.i_width, p_vout->output.i_height );
 492 #endif
 493     }
 494
 495     /* Make sure the command is sent now - do NOT use XFlush !*/
 496     XSync( p_vout->p_sys->p_display, False );
 497
 498     vlc_mutex_unlock( &p_vout->p_sys->lock );
 499 }
 500
 501 /*****************************************************************************
 502  * ManageVideo: handle X11 events
 503  *****************************************************************************
 504  * This function should be called regularly by video output thread. It manages
 505  * X11 events and allows window resizing. It returns a non null value on
 506  * error.
 507  *****************************************************************************/
 508 static int ManageVideo( vout_thread_t *p_vout )
 509 {
 510     XEvent      xevent;                                         /* X11 event */
 511     vlc_value_t val;
 512
 513     vlc_mutex_lock( &p_vout->p_sys->lock );
 514
 515     /* Handle events from the owner window */
 516     if( p_vout->p_sys->p_win->owner_window )
 517     {
 518         while( XCheckWindowEvent( p_vout->p_sys->p_display,
 519                                   p_vout->p_sys->p_win->owner_window,
 520                                   StructureNotifyMask, &xevent ) == True )
 521         {
 522             /* ConfigureNotify event: prepare  */
 523             if( xevent.type == ConfigureNotify )
 524             {
 525                 /* Update dimensions */
 526                 XResizeWindow( p_vout->p_sys->p_display,
 527                                p_vout->p_sys->p_win->base_window,
 528                                xevent.xconfigure.width,
 529                                xevent.xconfigure.height );
 530             }
 531         }
 532     }
 533
 534     /* Handle X11 events: ConfigureNotify events are parsed to know if the
 535      * output window's size changed, MapNotify and UnmapNotify to know if the
 536      * window is mapped (and if the display is useful), and ClientMessages
 537      * to intercept window destruction requests */
 538
 539     while( XCheckWindowEvent( p_vout->p_sys->p_display,
 540                               p_vout->p_sys->p_win->base_window,
 541                               StructureNotifyMask | KeyPressMask |
 542                               ButtonPressMask | ButtonReleaseMask |
 543                               PointerMotionMask | Button1MotionMask , &xevent )
 544            == True )
 545     {
 546         /* ConfigureNotify event: prepare  */
 547         if( xevent.type == ConfigureNotify )
 548         {
 549             if( (unsigned int)xevent.xconfigure.width
 550                    != p_vout->p_sys->p_win->i_width
 551               || (unsigned int)xevent.xconfigure.height
 552                     != p_vout->p_sys->p_win->i_height )
 553             {
 554                 /* Update dimensions */
 555                 p_vout->i_changes |= VOUT_SIZE_CHANGE;
 556                 p_vout->p_sys->p_win->i_width = xevent.xconfigure.width;
 557                 p_vout->p_sys->p_win->i_height = xevent.xconfigure.height;
 558             }
 559         }
 560         /* Keyboard event */
 561         else if( xevent.type == KeyPress )
 562         {
 563             unsigned int state = xevent.xkey.state;
 564             KeySym x_key_symbol;
 565             char i_key;                                   /* ISO Latin-1 key */
 566
 567             /* We may have keys like F1 trough F12, ESC ... */
 568             x_key_symbol = XKeycodeToKeysym( p_vout->p_sys->p_display,
 569                                              xevent.xkey.keycode, 0 );
 570             val.i_int = ConvertKey( (int)x_key_symbol );
 571
 572             xevent.xkey.state &= ~ShiftMask;
 573             xevent.xkey.state &= ~ControlMask;
 574             xevent.xkey.state &= ~Mod1Mask;
 575
 576             if( !val.i_int &&
 577                 XLookupString( &xevent.xkey, &i_key, 1, NULL, NULL ) )
 578             {
 579                 /* "Normal Keys"
 580                  * The reason why I use this instead of XK_0 is that
 581                  * with XLookupString, we don't have to care about
 582                  * keymaps. */
 583                 val.i_int = i_key;
 584             }
 585
 586             if( val.i_int )
 587             {
 588                 if( state & ShiftMask )
 589                 {
 590                     val.i_int |= KEY_MODIFIER_SHIFT;
 591                 }
 592                 if( state & ControlMask )
 593                 {
 594                     val.i_int |= KEY_MODIFIER_CTRL;
 595                 }
 596                 if( state & Mod1Mask )
 597                 {
 598                     val.i_int |= KEY_MODIFIER_ALT;
 599                 }
 600                 var_Set( p_vout->p_vlc, "key-pressed", val );
 601             }
 602         }
 603         /* Mouse click */
 604         else if( xevent.type == ButtonPress )
 605         {
 606             switch( ((XButtonEvent *)&xevent)->button )
 607             {
 608                 case Button1:
 609                     var_Get( p_vout, "mouse-button-down", &val );
 610                     val.i_int |= 1;
 611                     var_Set( p_vout, "mouse-button-down", val );
 612
 613                     /* detect double-clicks */
 614                     if( ( ((XButtonEvent *)&xevent)->time -
 615                           p_vout->p_sys->i_time_button_last_pressed ) < 300 )
 616                     {
 617                         p_vout->i_changes |= VOUT_FULLSCREEN_CHANGE;
 618                     }
 619
 620                     p_vout->p_sys->i_time_button_last_pressed =
 621                         ((XButtonEvent *)&xevent)->time;
 622                     break;
 623                 case Button2:
 624                     var_Get( p_vout, "mouse-button-down", &val );
 625                     val.i_int |= 2;
 626                     var_Set( p_vout, "mouse-button-down", val );
 627                     break;
 628
 629                 case Button3:
 630                     var_Get( p_vout, "mouse-button-down", &val );
 631                     val.i_int |= 4;
 632                     var_Set( p_vout, "mouse-button-down", val );
 633                     break;
 634
 635                 case Button4:
 636                     var_Get( p_vout, "mouse-button-down", &val );
 637                     val.i_int |= 8;
 638                     var_Set( p_vout, "mouse-button-down", val );
 639                     break;
 640
 641                 case Button5:
 642                     var_Get( p_vout, "mouse-button-down", &val );
 643                     val.i_int |= 16;
 644                     var_Set( p_vout, "mouse-button-down", val );
 645                     break;
 646             }
 647         }
 648         /* Mouse release */
 649         else if( xevent.type == ButtonRelease )
 650         {
 651             switch( ((XButtonEvent *)&xevent)->button )
 652             {
 653                 case Button1:
 654                     var_Get( p_vout, "mouse-button-down", &val );
 655                     val.i_int &= ~1;
 656                     var_Set( p_vout, "mouse-button-down", val );
 657
 658                     val.b_bool = VLC_TRUE;
 659                     var_Set( p_vout, "mouse-clicked", val );
 660                     break;
 661
 662                 case Button2:
 663                     {
 664                         playlist_t *p_playlist;
 665
 666                         var_Get( p_vout, "mouse-button-down", &val );
 667                         val.i_int &= ~2;
 668                         var_Set( p_vout, "mouse-button-down", val );
 669
 670                         p_playlist = vlc_object_find( p_vout,
 671                                                       VLC_OBJECT_PLAYLIST,
 672                                                       FIND_ANYWHERE );
 673                         if( p_playlist != NULL )
 674                         {
 675                             vlc_value_t val;
 676                             var_Get( p_playlist, "intf-show", &val );
 677                             val.b_bool = !val.b_bool;
 678                             var_Set( p_playlist, "intf-show", val );
 679                             vlc_object_release( p_playlist );
 680                         }
 681                     }
 682                     break;
 683
 684                 case Button3:
 685                     {
 686                         intf_thread_t *p_intf;
 687                         playlist_t *p_playlist;
 688
 689                         var_Get( p_vout, "mouse-button-down", &val );
 690                         val.i_int &= ~4;
 691                         var_Set( p_vout, "mouse-button-down", val );
 692                         p_intf = vlc_object_find( p_vout, VLC_OBJECT_INTF,
 693                                                           FIND_ANYWHERE );
 694                         if( p_intf )
 695                         {
 696                             p_intf->b_menu_change = 1;
 697                             vlc_object_release( p_intf );
 698                         }
 699
 700                         p_playlist = vlc_object_find( p_vout,
 701                                                       VLC_OBJECT_PLAYLIST,
 702                                                       FIND_ANYWHERE );
 703                         if( p_playlist != NULL )
 704                         {
 705                             vlc_value_t val; val.b_bool = VLC_TRUE;
 706                             var_Set( p_playlist, "intf-popupmenu", val );
 707                             vlc_object_release( p_playlist );
 708                         }
 709                     }
 710                     break;
 711
 712                 case Button4:
 713                     var_Get( p_vout, "mouse-button-down", &val );
 714                     val.i_int &= ~8;
 715                     var_Set( p_vout, "mouse-button-down", val );
 716                     break;
 717
 718                 case Button5:
 719                     var_Get( p_vout, "mouse-button-down", &val );
 720                     val.i_int &= ~16;
 721                     var_Set( p_vout, "mouse-button-down", val );
 722                     break;
 723
 724             }
 725         }
 726         /* Mouse move */
 727         else if( xevent.type == MotionNotify )
 728         {
 729             int i_width, i_height, i_x, i_y;
 730             vlc_value_t val;
 731
 732             /* somewhat different use for vout_PlacePicture:
 733              * here the values are needed to give to mouse coordinates
 734              * in the original picture space */
 735             vout_PlacePicture( p_vout, p_vout->p_sys->p_win->i_width,
 736                                p_vout->p_sys->p_win->i_height,
 737                                &i_x, &i_y, &i_width, &i_height );
 738
 739             val.i_int = ( xevent.xmotion.x - i_x )
 740                          * p_vout->render.i_width / i_width;
 741             var_Set( p_vout, "mouse-x", val );
 742             val.i_int = ( xevent.xmotion.y - i_y )
 743                          * p_vout->render.i_height / i_height;
 744             var_Set( p_vout, "mouse-y", val );
 745
 746             val.b_bool = VLC_TRUE;
 747             var_Set( p_vout, "mouse-moved", val );
 748
 749             p_vout->p_sys->i_time_mouse_last_moved = mdate();
 750             if( ! p_vout->p_sys->b_mouse_pointer_visible )
 751             {
 752                 ToggleCursor( p_vout );
 753             }
 754         }
 755         else if( xevent.type == ReparentNotify /* XXX: why do we get this? */
 756                   || xevent.type == MapNotify
 757                   || xevent.type == UnmapNotify )
 758         {
 759             /* Ignore these events */
 760         }
 761         else /* Other events */
 762         {
 763             msg_Warn( p_vout, "unhandled event %d received", xevent.type );
 764         }
 765     }
 766
 767     /* Handle events for video output sub-window */
 768     while( XCheckWindowEvent( p_vout->p_sys->p_display,
 769                               p_vout->p_sys->p_win->video_window,
 770                               ExposureMask, &xevent ) == True )
 771     {
 772         /* Window exposed (only handled if stream playback is paused) */
 773         if( xevent.type == Expose )
 774         {
 775             if( ((XExposeEvent *)&xevent)->count == 0 )
 776             {
 777                 /* (if this is the last a collection of expose events...) */
 778 #if 0
 779                 if( p_vout->p_vlc->p_input_bank->pp_input[0] != NULL )
 780                 {
 781                     if( PAUSE_S == p_vout->p_vlc->p_input_bank->pp_input[0]
 782                                                    ->stream.control.i_status )
 783                     {
 784                         /* XVideoDisplay( p_vout )*/;
 785                     }
 786                 }
 787 #endif
 788             }
 789         }
 790     }
 791
 792     /* ClientMessage event - only WM_PROTOCOLS with WM_DELETE_WINDOW data
 793      * are handled - according to the man pages, the format is always 32
 794      * in this case */
 795     while( XCheckTypedEvent( p_vout->p_sys->p_display,
 796                              ClientMessage, &xevent ) )
 797     {
 798         if( (xevent.xclient.message_type == p_vout->p_sys->p_win->wm_protocols)
 799                && ((Atom)xevent.xclient.data.l[0]
 800                      == p_vout->p_sys->p_win->wm_delete_window ) )
 801         {
 802             /* the user wants to close the window */
 803             playlist_t * p_playlist =
 804                 (playlist_t *)vlc_object_find( p_vout, VLC_OBJECT_PLAYLIST,
 805                                                FIND_ANYWHERE );
 806             if( p_playlist != NULL )
 807             {
 808                 playlist_Stop( p_playlist );
 809                 vlc_object_release( p_playlist );
 810             }
 811         }
 812     }
 813
 814     /*
 815      * Fullscreen Change
 816      */
 817     if ( p_vout->i_changes & VOUT_FULLSCREEN_CHANGE )
 818     {
 819         vlc_value_t val;
 820
 821         /* Update the object variable and trigger callback */
 822         val.b_bool = !p_vout->b_fullscreen;
 823         var_Set( p_vout, "fullscreen", val );
 824
 825         ToggleFullScreen( p_vout );
 826         p_vout->i_changes &= ~VOUT_FULLSCREEN_CHANGE;
 827     }
 828
 829     /*
 830      * Size change
 831      *
 832      * (Needs to be placed after VOUT_FULLSREEN_CHANGE because we can activate
 833      *  the size flag inside the fullscreen routine)
 834      */
 835     if( p_vout->i_changes & VOUT_SIZE_CHANGE )
 836     {
 837         int i_width, i_height, i_x, i_y;
 838
 839         p_vout->i_changes &= ~VOUT_SIZE_CHANGE;
 840
 841 #ifdef MODULE_NAME_IS_x11
 842         /* We need to signal the vout thread about the size change because it
 843          * is doing the rescaling */
 844         p_vout->i_changes |= VOUT_SIZE_CHANGE;
 845 #endif
 846
 847         vout_PlacePicture( p_vout, p_vout->p_sys->p_win->i_width,
 848                            p_vout->p_sys->p_win->i_height,
 849                            &i_x, &i_y, &i_width, &i_height );
 850
 851         XMoveResizeWindow( p_vout->p_sys->p_display,
 852                            p_vout->p_sys->p_win->video_window,
 853                            i_x, i_y, i_width, i_height );
 854     }
 855
 856     /* Autohide Cursour */
 857     if( mdate() - p_vout->p_sys->i_time_mouse_last_moved > 2000000 )
 858     {
 859         /* Hide the mouse automatically */
 860         if( p_vout->p_sys->b_mouse_pointer_visible )
 861         {
 862             ToggleCursor( p_vout );
 863         }
 864     }
 865
 866     vlc_mutex_unlock( &p_vout->p_sys->lock );
 867
 868     return 0;
 869 }
 870
 871 /*****************************************************************************
 872  * EndVideo: terminate X11 video thread output method
 873  *****************************************************************************
 874  * Destroy the X11 XImages created by Init. It is called at the end of
 875  * the thread, but also each time the window is resized.
 876  *****************************************************************************/
 877 static void EndVideo( vout_thread_t *p_vout )
 878 {
 879     int i_index;
 880
 881     /* Free the direct buffers we allocated */
 882     for( i_index = I_OUTPUTPICTURES ; i_index ; )
 883     {
 884         i_index--;
 885         FreePicture( p_vout, PP_OUTPUTPICTURE[ i_index ] );
 886     }
 887 }
 888
 889 /* following functions are local */
 890
 891 /*****************************************************************************
 892  * CreateWindow: open and set-up X11 main window
 893  *****************************************************************************/
 894 static int CreateWindow( vout_thread_t *p_vout, x11_window_t *p_win )
 895 {
 896     XSizeHints              xsize_hints;
 897     XSetWindowAttributes    xwindow_attributes;
 898     XGCValues               xgcvalues;
 899     XEvent                  xevent;
 900
 901     vlc_bool_t              b_expose = VLC_FALSE;
 902     vlc_bool_t              b_configure_notify = VLC_FALSE;
 903     vlc_bool_t              b_map_notify = VLC_FALSE;
 904
 905     /* Prepare window manager hints and properties */
 906     p_win->wm_protocols =
 907              XInternAtom( p_vout->p_sys->p_display, "WM_PROTOCOLS", True );
 908     p_win->wm_delete_window =
 909              XInternAtom( p_vout->p_sys->p_display, "WM_DELETE_WINDOW", True );
 910
 911     /* Never have a 0-pixel-wide window */
 912     xsize_hints.min_width = 2;
 913     xsize_hints.min_height = 1;
 914
 915     /* Prepare window attributes */
 916     xwindow_attributes.backing_store = Always;       /* save the hidden part */
 917     xwindow_attributes.background_pixel = BlackPixel(p_vout->p_sys->p_display,
 918                                                      p_vout->p_sys->i_screen);
 919     xwindow_attributes.event_mask = ExposureMask | StructureNotifyMask;
 920
 921     if( !p_vout->b_fullscreen )
 922     {
 923         p_win->owner_window =
 924             (Window)vout_RequestWindow( p_vout, &p_win->i_x, &p_win->i_y,
 925                                         &p_win->i_width, &p_win->i_height );
 926
 927         xsize_hints.base_width  = xsize_hints.width = p_win->i_width;
 928         xsize_hints.base_height = xsize_hints.height = p_win->i_height;
 929         xsize_hints.flags       = PSize | PMinSize;
 930
 931         if( p_win->i_x >=0 || p_win->i_y >= 0 )
 932         {
 933             xsize_hints.x = p_win->i_x;
 934             xsize_hints.y = p_win->i_y;
 935             xsize_hints.flags |= PPosition;
 936         }
 937     }
 938     else
 939     {
 940         /* Fullscreen window size and position */
 941         p_win->owner_window = 0;
 942         p_win->i_x = p_win->i_y = 0;
 943         p_win->i_width =
 944             DisplayWidth( p_vout->p_sys->p_display, p_vout->p_sys->i_screen );
 945         p_win->i_height =
 946             DisplayHeight( p_vout->p_sys->p_display, p_vout->p_sys->i_screen );
 947     }
 948
 949     if( !p_win->owner_window )
 950     {
 951         /* Create the window and set hints - the window must receive
 952          * ConfigureNotify events, and until it is displayed, Expose and
 953          * MapNotify events. */
 954
 955         p_win->base_window =
 956             XCreateWindow( p_vout->p_sys->p_display,
 957                            DefaultRootWindow( p_vout->p_sys->p_display ),
 958                            p_win->i_x, p_win->i_y,
 959                            p_win->i_width, p_win->i_height,
 960                            0,
 961                            0, InputOutput, 0,
 962                            CWBackingStore | CWBackPixel | CWEventMask,
 963                            &xwindow_attributes );
 964
 965         if( !p_vout->b_fullscreen )
 966         {
 967             /* Set window manager hints and properties: size hints, command,
 968              * window's name, and accepted protocols */
 969             XSetWMNormalHints( p_vout->p_sys->p_display,
 970                                p_win->base_window, &xsize_hints );
 971             XSetCommand( p_vout->p_sys->p_display, p_win->base_window,
 972                          p_vout->p_vlc->ppsz_argv, p_vout->p_vlc->i_argc );
 973
 974             XStoreName( p_vout->p_sys->p_display, p_win->base_window,
 975 #ifdef MODULE_NAME_IS_x11
 976                         VOUT_TITLE " (X11 output)"
 977 #elif defined(MODULE_NAME_IS_glx)
 978                         VOUT_TITLE " (GLX output)"
 979 #else
 980                         VOUT_TITLE " (XVideo output)"
 981 #endif
 982                       );
 983         }
 984     }
 985     else
 986     {
 987         Window dummy1;
 988         unsigned int dummy2, dummy3;
 989
 990         /* Select events we are interested in. */
 991         XSelectInput( p_vout->p_sys->p_display, p_win->owner_window,
 992                       StructureNotifyMask );
 993
 994         /* Get the parent window's geometry information */
 995         XGetGeometry( p_vout->p_sys->p_display, p_win->owner_window,
 996                       &dummy1, &dummy2, &dummy3,
 997                       &p_win->i_width,
 998                       &p_win->i_height,
 999                       &dummy2, &dummy3 );
1000
1001         /* We are already configured */
1002         b_configure_notify = VLC_TRUE;
1003
1004         /* From man XSelectInput: only one client at a time can select a
1005          * ButtonPress event, so we need to open a new window anyway. */
1006         p_win->base_window =
1007             XCreateWindow( p_vout->p_sys->p_display,
1008                            p_win->owner_window,
1009                            0, 0,
1010                            p_win->i_width, p_win->i_height,
1011                            0,
1012                            0, CopyFromParent, 0,
1013                            CWBackingStore | CWBackPixel | CWEventMask,
1014                            &xwindow_attributes );
1015     }
1016
1017     if( (p_win->wm_protocols == None)        /* use WM_DELETE_WINDOW */
1018         || (p_win->wm_delete_window == None)
1019         || !XSetWMProtocols( p_vout->p_sys->p_display, p_win->base_window,
1020                              &p_win->wm_delete_window, 1 ) )
1021     {
1022         /* WM_DELETE_WINDOW is not supported by window manager */
1023         msg_Warn( p_vout, "missing or bad window manager" );
1024     }
1025
1026     /* Creation of a graphic context that doesn't generate a GraphicsExpose
1027      * event when using functions like XCopyArea */
1028     xgcvalues.graphics_exposures = False;
1029     p_win->gc = XCreateGC( p_vout->p_sys->p_display,
1030                            p_win->base_window,
1031                            GCGraphicsExposures, &xgcvalues );
1032
1033     /* Send orders to server, and wait until window is displayed - three
1034      * events must be received: a MapNotify event, an Expose event allowing
1035      * drawing in the window, and a ConfigureNotify to get the window
1036      * dimensions. Once those events have been received, only
1037      * ConfigureNotify events need to be received. */
1038     XMapWindow( p_vout->p_sys->p_display, p_win->base_window );
1039     do
1040     {
1041         XNextEvent( p_vout->p_sys->p_display, &xevent);
1042         if( (xevent.type == Expose)
1043             && (xevent.xexpose.window == p_win->base_window) )
1044         {
1045             b_expose = VLC_TRUE;
1046         }
1047         else if( (xevent.type == MapNotify)
1048                  && (xevent.xmap.window == p_win->base_window) )
1049         {
1050             b_map_notify = VLC_TRUE;
1051         }
1052         else if( (xevent.type == ConfigureNotify)
1053                  && (xevent.xconfigure.window == p_win->base_window) )
1054         {
1055             b_configure_notify = VLC_TRUE;
1056             p_win->i_width = xevent.xconfigure.width;
1057             p_win->i_height = xevent.xconfigure.height;
1058         }
1059     } while( !( b_expose && b_configure_notify && b_map_notify ) );
1060
1061     XSelectInput( p_vout->p_sys->p_display, p_win->base_window,
1062                   StructureNotifyMask | KeyPressMask |
1063                   ButtonPressMask | ButtonReleaseMask |
1064                   PointerMotionMask );
1065
1066 #ifdef MODULE_NAME_IS_x11
1067     if( XDefaultDepth(p_vout->p_sys->p_display, p_vout->p_sys->i_screen) == 8 )
1068     {
1069         /* Allocate a new palette */
1070         p_vout->p_sys->colormap =
1071             XCreateColormap( p_vout->p_sys->p_display,
1072                              DefaultRootWindow( p_vout->p_sys->p_display ),
1073                              DefaultVisual( p_vout->p_sys->p_display,
1074                                             p_vout->p_sys->i_screen ),
1075                              AllocAll );
1076
1077         xwindow_attributes.colormap = p_vout->p_sys->colormap;
1078         XChangeWindowAttributes( p_vout->p_sys->p_display, p_win->base_window,
1079                                  CWColormap, &xwindow_attributes );
1080     }
1081 #endif
1082
1083     /* Create video output sub-window. */
1084     p_win->video_window =  XCreateSimpleWindow(
1085                                       p_vout->p_sys->p_display,
1086                                       p_win->base_window, 0, 0,
1087                                       p_win->i_width, p_win->i_height,
1088                                       0,
1089                                       BlackPixel( p_vout->p_sys->p_display,
1090                                                   p_vout->p_sys->i_screen ),
1091                                       WhitePixel( p_vout->p_sys->p_display,
1092                                                   p_vout->p_sys->i_screen ) );
1093
1094     XSetWindowBackground( p_vout->p_sys->p_display, p_win->video_window,
1095                           BlackPixel( p_vout->p_sys->p_display,
1096                                       p_vout->p_sys->i_screen ) );
1097
1098     XMapWindow( p_vout->p_sys->p_display, p_win->video_window );
1099     XSelectInput( p_vout->p_sys->p_display, p_win->video_window,
1100                   ExposureMask );
1101
1102     /* make sure the video window will be centered in the next ManageVideo() */
1103     p_vout->i_changes |= VOUT_SIZE_CHANGE;
1104
1105     /* If the cursor was formerly blank than blank it again */
1106     if( !p_vout->p_sys->b_mouse_pointer_visible )
1107     {
1108         ToggleCursor( p_vout );
1109         ToggleCursor( p_vout );
1110     }
1111
1112     /* Do NOT use XFlush here ! */
1113     XSync( p_vout->p_sys->p_display, False );
1114
1115     /* At this stage, the window is open, displayed, and ready to
1116      * receive data */
1117     p_vout->p_sys->p_win = p_win;
1118
1119     return VLC_SUCCESS;
1120 }
1121
1122 /*****************************************************************************
1123  * DestroyWindow: destroy the window
1124  *****************************************************************************
1125  *
1126  *****************************************************************************/
1127 static void DestroyWindow( vout_thread_t *p_vout, x11_window_t *p_win )
1128 {
1129     /* Do NOT use XFlush here ! */
1130     XSync( p_vout->p_sys->p_display, False );
1131
1132     if( p_win->video_window != None )
1133         XDestroyWindow( p_vout->p_sys->p_display, p_win->video_window );
1134
1135     XFreeGC( p_vout->p_sys->p_display, p_win->gc );
1136
1137     XUnmapWindow( p_vout->p_sys->p_display, p_win->base_window );
1138     XDestroyWindow( p_vout->p_sys->p_display, p_win->base_window );
1139
1140     if( p_win->owner_window )
1141         vout_ReleaseWindow( p_vout, (void *)p_win->owner_window );
1142 }
1143
1144 /*****************************************************************************
1145  * NewPicture: allocate a picture
1146  *****************************************************************************
1147  * Returns 0 on success, -1 otherwise
1148  *****************************************************************************/
1149 static int NewPicture( vout_thread_t *p_vout, picture_t *p_pic )
1150 {
1151 #ifndef MODULE_NAME_IS_glx
1152
1153 #ifdef MODULE_NAME_IS_xvideo
1154     int i_plane;
1155 #endif
1156
1157     /* We know the chroma, allocate a buffer which will be used
1158      * directly by the decoder */
1159     p_pic->p_sys = malloc( sizeof( picture_sys_t ) );
1160
1161     if( p_pic->p_sys == NULL )
1162     {
1163         return -1;
1164     }
1165
1166     /* Fill in picture_t fields */
1167     vout_InitPicture( VLC_OBJECT(p_vout), p_pic, p_vout->output.i_chroma,
1168                       p_vout->output.i_width, p_vout->output.i_height,
1169                       p_vout->output.i_aspect );
1170
1171 #ifdef HAVE_SYS_SHM_H
1172     if( p_vout->p_sys->b_shm )
1173     {
1174         /* Create image using XShm extension */
1175         p_pic->p_sys->p_image =
1176             CreateShmImage( p_vout, p_vout->p_sys->p_display,
1177 #   ifdef MODULE_NAME_IS_xvideo
1178                             p_vout->p_sys->i_xvport,
1179                             VLC2X11_FOURCC(p_vout->output.i_chroma),
1180 #   else
1181                             p_vout->p_sys->p_visual,
1182                             p_vout->p_sys->i_screen_depth,
1183 #   endif
1184                             &p_pic->p_sys->shminfo,
1185                             p_vout->output.i_width, p_vout->output.i_height );
1186     }
1187     else
1188 #endif /* HAVE_SYS_SHM_H */
1189     {
1190         /* Create image without XShm extension */
1191         p_pic->p_sys->p_image =
1192             CreateImage( p_vout, p_vout->p_sys->p_display,
1193 #ifdef MODULE_NAME_IS_xvideo
1194                          p_vout->p_sys->i_xvport,
1195                          VLC2X11_FOURCC(p_vout->output.i_chroma),
1196                          p_pic->format.i_bits_per_pixel,
1197 #else
1198                          p_vout->p_sys->p_visual,
1199                          p_vout->p_sys->i_screen_depth,
1200                          p_vout->p_sys->i_bytes_per_pixel,
1201 #endif
1202                          p_vout->output.i_width, p_vout->output.i_height );
1203     }
1204
1205     if( p_pic->p_sys->p_image == NULL )
1206     {
1207         free( p_pic->p_sys );
1208         return -1;
1209     }
1210
1211     switch( p_vout->output.i_chroma )
1212     {
1213 #ifdef MODULE_NAME_IS_xvideo
1214         case VLC_FOURCC('I','4','2','0'):
1215         case VLC_FOURCC('Y','V','1','2'):
1216         case VLC_FOURCC('Y','2','1','1'):
1217         case VLC_FOURCC('Y','U','Y','2'):
1218         case VLC_FOURCC('U','Y','V','Y'):
1219         case VLC_FOURCC('R','V','1','5'):
1220         case VLC_FOURCC('R','V','1','6'):
1221         case VLC_FOURCC('R','V','2','4'): /* Fixme: pixel pitch == 4 ? */
1222         case VLC_FOURCC('R','V','3','2'):
1223
1224             for( i_plane = 0; i_plane < p_pic->p_sys->p_image->num_planes;
1225                  i_plane++ )
1226             {
1227                 p_pic->p[i_plane].p_pixels = p_pic->p_sys->p_image->data
1228                     + p_pic->p_sys->p_image->offsets[i_plane];
1229                 p_pic->p[i_plane].i_pitch =
1230                     p_pic->p_sys->p_image->pitches[i_plane];
1231             }
1232             if( p_vout->output.i_chroma == VLC_FOURCC('Y','V','1','2') )
1233             {
1234                 /* U and V inverted compared to I420
1235                  * Fixme: this should be handled by the vout core */
1236                 p_pic->U_PIXELS = p_pic->p_sys->p_image->data
1237                     + p_pic->p_sys->p_image->offsets[2];
1238                 p_pic->V_PIXELS = p_pic->p_sys->p_image->data
1239                     + p_pic->p_sys->p_image->offsets[1];
1240             }
1241             break;
1242
1243 #else
1244         case VLC_FOURCC('R','G','B','2'):
1245         case VLC_FOURCC('R','V','1','6'):
1246         case VLC_FOURCC('R','V','1','5'):
1247         case VLC_FOURCC('R','V','2','4'):
1248         case VLC_FOURCC('R','V','3','2'):
1249
1250             p_pic->p->i_lines = p_pic->p_sys->p_image->height;
1251             p_pic->p->p_pixels = p_pic->p_sys->p_image->data
1252                                   + p_pic->p_sys->p_image->xoffset;
1253             p_pic->p->i_pitch = p_pic->p_sys->p_image->bytes_per_line;
1254
1255             /* p_pic->p->i_pixel_pitch = 4 for RV24 but this should be set
1256              * properly by vout_InitPicture() */
1257             p_pic->p->i_visible_pitch = p_pic->p->i_pixel_pitch
1258                                          * p_pic->p_sys->p_image->width;
1259             break;
1260 #endif
1261
1262         default:
1263             /* Unknown chroma, tell the guy to get lost */
1264             IMAGE_FREE( p_pic->p_sys->p_image );
1265             free( p_pic->p_sys );
1266             msg_Err( p_vout, "never heard of chroma 0x%.8x (%4.4s)",
1267                      p_vout->output.i_chroma, (char*)&p_vout->output.i_chroma );
1268             p_pic->i_planes = 0;
1269             return -1;
1270     }
1271
1272 #endif /* !MODULE_NAME_IS_glx */
1273
1274     return 0;
1275 }
1276
1277 /*****************************************************************************
1278  * FreePicture: destroy a picture allocated with NewPicture
1279  *****************************************************************************
1280  * Destroy XImage AND associated data. If using Shm, detach shared memory
1281  * segment from server and process, then free it. The XDestroyImage manpage
1282  * says that both the image structure _and_ the data pointed to by the
1283  * image structure are freed, so no need to free p_image->data.
1284  *****************************************************************************/
1285 static void FreePicture( vout_thread_t *p_vout, picture_t *p_pic )
1286 {
1287     /* The order of operations is correct */
1288 #ifdef HAVE_SYS_SHM_H
1289     if( p_vout->p_sys->b_shm )
1290     {
1291         XShmDetach( p_vout->p_sys->p_display, &p_pic->p_sys->shminfo );
1292         IMAGE_FREE( p_pic->p_sys->p_image );
1293
1294         shmctl( p_pic->p_sys->shminfo.shmid, IPC_RMID, 0 );
1295         if( shmdt( p_pic->p_sys->shminfo.shmaddr ) )
1296         {
1297             msg_Err( p_vout, "cannot detach shared memory (%s)",
1298                              strerror(errno) );
1299         }
1300     }
1301     else
1302 #endif
1303     {
1304         IMAGE_FREE( p_pic->p_sys->p_image );
1305     }
1306
1307     /* Do NOT use XFlush here ! */
1308     XSync( p_vout->p_sys->p_display, False );
1309
1310     free( p_pic->p_sys );
1311 }
1312
1313 /*****************************************************************************
1314  * ToggleFullScreen: Enable or disable full screen mode
1315  *****************************************************************************
1316  * This function will switch between fullscreen and window mode.
1317  *****************************************************************************/
1318 static void ToggleFullScreen ( vout_thread_t *p_vout )
1319 {
1320     Atom prop;
1321     XEvent xevent;
1322     mwmhints_t mwmhints;
1323     XSetWindowAttributes attributes;
1324
1325 #ifdef HAVE_XINERAMA
1326     int i_d1, i_d2;
1327 #endif
1328
1329     p_vout->b_fullscreen = !p_vout->b_fullscreen;
1330
1331     if( p_vout->b_fullscreen )
1332     {
1333         msg_Dbg( p_vout, "entering fullscreen mode" );
1334
1335         p_vout->p_sys->b_altfullscreen =
1336             config_GetInt( p_vout, MODULE_STRING "-altfullscreen" );
1337
1338         XUnmapWindow( p_vout->p_sys->p_display,
1339                       p_vout->p_sys->p_win->base_window );
1340
1341         p_vout->p_sys->p_win = &p_vout->p_sys->fullscreen_window;
1342
1343         CreateWindow( p_vout, p_vout->p_sys->p_win );
1344         XDestroyWindow( p_vout->p_sys->p_display,
1345                         p_vout->p_sys->fullscreen_window.video_window );
1346         XReparentWindow( p_vout->p_sys->p_display,
1347                          p_vout->p_sys->original_window.video_window,
1348                          p_vout->p_sys->fullscreen_window.base_window, 0, 0 );
1349         p_vout->p_sys->fullscreen_window.video_window =
1350             p_vout->p_sys->original_window.video_window;
1351
1352         /* To my knowledge there are two ways to create a borderless window.
1353          * There's the generic way which is to tell x to bypass the window
1354          * manager, but this creates problems with the focus of other
1355          * applications.
1356          * The other way is to use the motif property "_MOTIF_WM_HINTS" which
1357          * luckily seems to be supported by most window managers. */
1358         if( !p_vout->p_sys->b_altfullscreen )
1359         {
1360             mwmhints.flags = MWM_HINTS_DECORATIONS;
1361             mwmhints.decorations = False;
1362
1363             prop = XInternAtom( p_vout->p_sys->p_display, "_MOTIF_WM_HINTS",
1364                                 False );
1365             XChangeProperty( p_vout->p_sys->p_display,
1366                              p_vout->p_sys->p_win->base_window,
1367                              prop, prop, 32, PropModeReplace,
1368                              (unsigned char *)&mwmhints,
1369                              PROP_MWM_HINTS_ELEMENTS );
1370         }
1371         else
1372         {
1373             /* brute force way to remove decorations */
1374             attributes.override_redirect = True;
1375             XChangeWindowAttributes( p_vout->p_sys->p_display,
1376                                      p_vout->p_sys->p_win->base_window,
1377                                      CWOverrideRedirect,
1378                                      &attributes);
1379
1380             /* Make sure the change is effective */
1381             XReparentWindow( p_vout->p_sys->p_display,
1382                              p_vout->p_sys->p_win->base_window,
1383                              DefaultRootWindow( p_vout->p_sys->p_display ),
1384                              0, 0 );
1385         }
1386
1387         if( p_vout->p_sys->b_net_wm_state_fullscreen )
1388         {
1389             XClientMessageEvent event;
1390
1391             memset( &event, 0, sizeof( XClientMessageEvent ) );
1392
1393             event.type = ClientMessage;
1394             event.message_type = p_vout->p_sys->net_wm_state;
1395             event.display = p_vout->p_sys->p_display;
1396             event.window = p_vout->p_sys->p_win->base_window;
1397             event.format = 32;
1398             event.data.l[ 0 ] = 1; /* set property */
1399             event.data.l[ 1 ] = p_vout->p_sys->net_wm_state_fullscreen;
1400
1401             XSendEvent( p_vout->p_sys->p_display,
1402                         DefaultRootWindow( p_vout->p_sys->p_display ),
1403                         False, SubstructureRedirectMask,
1404                         (XEvent*)&event );
1405         }
1406
1407         /* Make sure the change is effective */
1408         XReparentWindow( p_vout->p_sys->p_display,
1409                          p_vout->p_sys->p_win->base_window,
1410                          DefaultRootWindow( p_vout->p_sys->p_display ),
1411                          0, 0 );
1412
1413 #ifdef HAVE_XINERAMA
1414         if( XineramaQueryExtension( p_vout->p_sys->p_display, &i_d1, &i_d2 ) &&
1415             XineramaIsActive( p_vout->p_sys->p_display ) )
1416         {
1417             XineramaScreenInfo *screens;   /* infos for xinerama */
1418             int i_num_screens;
1419
1420             msg_Dbg( p_vout, "using XFree Xinerama extension");
1421
1422 #define SCREEN p_vout->p_sys->p_win->i_screen
1423
1424             /* Get Information about Xinerama (num of screens) */
1425             screens = XineramaQueryScreens( p_vout->p_sys->p_display,
1426                                             &i_num_screens );
1427
1428             if( !SCREEN )
1429                 SCREEN = config_GetInt( p_vout,
1430                                         MODULE_STRING "-xineramascreen" );
1431
1432             /* just check that user has entered a good value */
1433             if( SCREEN >= i_num_screens || SCREEN < 0 )
1434             {
1435                 msg_Dbg( p_vout, "requested screen number invalid" );
1436                 SCREEN = 0;
1437             }
1438
1439             /* Get the X/Y upper left corner coordinate of the above screen */
1440             p_vout->p_sys->p_win->i_x = screens[SCREEN].x_org;
1441             p_vout->p_sys->p_win->i_y = screens[SCREEN].y_org;
1442
1443             /* Set the Height/width to the screen resolution */
1444             p_vout->p_sys->p_win->i_width = screens[SCREEN].width;
1445             p_vout->p_sys->p_win->i_height = screens[SCREEN].height;
1446
1447             XFree(screens);
1448
1449 #undef SCREEN
1450
1451         }
1452 #endif
1453
1454         XMoveResizeWindow( p_vout->p_sys->p_display,
1455                            p_vout->p_sys->p_win->base_window,
1456                            p_vout->p_sys->p_win->i_x,
1457                            p_vout->p_sys->p_win->i_y,
1458                            p_vout->p_sys->p_win->i_width,
1459                            p_vout->p_sys->p_win->i_height );
1460     }
1461     else
1462     {
1463         msg_Dbg( p_vout, "leaving fullscreen mode" );
1464
1465         XReparentWindow( p_vout->p_sys->p_display,
1466                          p_vout->p_sys->original_window.video_window,
1467                          p_vout->p_sys->original_window.base_window, 0, 0 );
1468
1469         p_vout->p_sys->fullscreen_window.video_window = None;
1470         DestroyWindow( p_vout, &p_vout->p_sys->fullscreen_window );
1471         p_vout->p_sys->p_win = &p_vout->p_sys->original_window;
1472
1473         XMapWindow( p_vout->p_sys->p_display,
1474                     p_vout->p_sys->p_win->base_window );
1475     }
1476
1477     /* Unfortunately, using XSync() here is not enough to ensure the
1478      * window has already been mapped because the XMapWindow() request
1479      * has not necessarily been sent directly to our window (remember,
1480      * the call is first redirected to the window manager) */
1481     do
1482     {
1483         XWindowEvent( p_vout->p_sys->p_display,
1484                       p_vout->p_sys->p_win->base_window,
1485                       StructureNotifyMask, &xevent );
1486     } while( xevent.type != MapNotify );
1487
1488     /* Be careful, this can generate a BadMatch error if the window is not
1489      * already mapped by the server (see above) */
1490     XSetInputFocus(p_vout->p_sys->p_display,
1491                    p_vout->p_sys->p_win->base_window,
1492                    RevertToParent,
1493                    CurrentTime);
1494
1495     /* signal that the size needs to be updated */
1496     p_vout->i_changes |= VOUT_SIZE_CHANGE;
1497 }
1498
1499 /*****************************************************************************
1500  * EnableXScreenSaver: enable screen saver
1501  *****************************************************************************
1502  * This function enables the screen saver on a display after it has been
1503  * disabled by XDisableScreenSaver.
1504  * FIXME: what happens if multiple vlc sessions are running at the same
1505  *        time ???
1506  *****************************************************************************/
1507 static void EnableXScreenSaver( vout_thread_t *p_vout )
1508 {
1509 #ifdef DPMSINFO_IN_DPMS_H
1510     int dummy;
1511 #endif
1512
1513     if( p_vout->p_sys->i_ss_timeout )
1514     {
1515         XSetScreenSaver( p_vout->p_sys->p_display, p_vout->p_sys->i_ss_timeout,
1516                          p_vout->p_sys->i_ss_interval,
1517                          p_vout->p_sys->i_ss_blanking,
1518                          p_vout->p_sys->i_ss_exposure );
1519     }
1520
1521     /* Restore DPMS settings */
1522 #ifdef DPMSINFO_IN_DPMS_H
1523     if( DPMSQueryExtension( p_vout->p_sys->p_display, &dummy, &dummy ) )
1524     {
1525         if( p_vout->p_sys->b_ss_dpms )
1526         {
1527             DPMSEnable( p_vout->p_sys->p_display );
1528         }
1529     }
1530 #endif
1531 }
1532
1533 /*****************************************************************************
1534  * DisableXScreenSaver: disable screen saver
1535  *****************************************************************************
1536  * See XEnableXScreenSaver
1537  *****************************************************************************/
1538 static void DisableXScreenSaver( vout_thread_t *p_vout )
1539 {
1540 #ifdef DPMSINFO_IN_DPMS_H
1541     int dummy;
1542 #endif
1543
1544     /* Save screen saver information */
1545     XGetScreenSaver( p_vout->p_sys->p_display, &p_vout->p_sys->i_ss_timeout,
1546                      &p_vout->p_sys->i_ss_interval,
1547                      &p_vout->p_sys->i_ss_blanking,
1548                      &p_vout->p_sys->i_ss_exposure );
1549
1550     /* Disable screen saver */
1551     if( p_vout->p_sys->i_ss_timeout )
1552     {
1553         XSetScreenSaver( p_vout->p_sys->p_display, 0,
1554                          p_vout->p_sys->i_ss_interval,
1555                          p_vout->p_sys->i_ss_blanking,
1556                          p_vout->p_sys->i_ss_exposure );
1557     }
1558
1559     /* Disable DPMS */
1560 #ifdef DPMSINFO_IN_DPMS_H
1561     if( DPMSQueryExtension( p_vout->p_sys->p_display, &dummy, &dummy ) )
1562     {
1563         CARD16 unused;
1564         /* Save DPMS current state */
1565         DPMSInfo( p_vout->p_sys->p_display, &unused,
1566                   &p_vout->p_sys->b_ss_dpms );
1567         DPMSDisable( p_vout->p_sys->p_display );
1568    }
1569 #endif
1570 }
1571
1572 /*****************************************************************************
1573  * CreateCursor: create a blank mouse pointer
1574  *****************************************************************************/
1575 static void CreateCursor( vout_thread_t *p_vout )
1576 {
1577     XColor cursor_color;
1578
1579     p_vout->p_sys->cursor_pixmap =
1580         XCreatePixmap( p_vout->p_sys->p_display,
1581                        DefaultRootWindow( p_vout->p_sys->p_display ),
1582                        1, 1, 1 );
1583
1584     XParseColor( p_vout->p_sys->p_display,
1585                  XCreateColormap( p_vout->p_sys->p_display,
1586                                   DefaultRootWindow(
1587                                                     p_vout->p_sys->p_display ),
1588                                   DefaultVisual(
1589                                                 p_vout->p_sys->p_display,
1590                                                 p_vout->p_sys->i_screen ),
1591                                   AllocNone ),
1592                  "black", &cursor_color );
1593
1594     p_vout->p_sys->blank_cursor =
1595         XCreatePixmapCursor( p_vout->p_sys->p_display,
1596                              p_vout->p_sys->cursor_pixmap,
1597                              p_vout->p_sys->cursor_pixmap,
1598                              &cursor_color, &cursor_color, 1, 1 );
1599 }
1600
1601 /*****************************************************************************
1602  * DestroyCursor: destroy the blank mouse pointer
1603  *****************************************************************************/
1604 static void DestroyCursor( vout_thread_t *p_vout )
1605 {
1606     XFreePixmap( p_vout->p_sys->p_display, p_vout->p_sys->cursor_pixmap );
1607 }
1608
1609 /*****************************************************************************
1610  * ToggleCursor: hide or show the mouse pointer
1611  *****************************************************************************
1612  * This function hides the X pointer if it is visible by setting the pointer
1613  * sprite to a blank one. To show it again, we disable the sprite.
1614  *****************************************************************************/
1615 static void ToggleCursor( vout_thread_t *p_vout )
1616 {
1617     if( p_vout->p_sys->b_mouse_pointer_visible )
1618     {
1619         XDefineCursor( p_vout->p_sys->p_display,
1620                        p_vout->p_sys->p_win->base_window,
1621                        p_vout->p_sys->blank_cursor );
1622         p_vout->p_sys->b_mouse_pointer_visible = 0;
1623     }
1624     else
1625     {
1626         XUndefineCursor( p_vout->p_sys->p_display,
1627                          p_vout->p_sys->p_win->base_window );
1628         p_vout->p_sys->b_mouse_pointer_visible = 1;
1629     }
1630 }
1631
1632 #ifdef MODULE_NAME_IS_xvideo
1633 /*****************************************************************************
1634  * XVideoGetPort: get YUV12 port
1635  *****************************************************************************/
1636 static int XVideoGetPort( vout_thread_t *p_vout,
1637                           vlc_fourcc_t i_chroma, vlc_fourcc_t *pi_newchroma )
1638 {
1639     XvAdaptorInfo *p_adaptor;
1640     unsigned int i;
1641     int i_adaptor, i_num_adaptors, i_requested_adaptor;
1642     int i_selected_port;
1643
1644     switch( XvQueryExtension( p_vout->p_sys->p_display, &i, &i, &i, &i, &i ) )
1645     {
1646         case Success:
1647             break;
1648
1649         case XvBadExtension:
1650             msg_Warn( p_vout, "XvBadExtension" );
1651             return -1;
1652
1653         case XvBadAlloc:
1654             msg_Warn( p_vout, "XvBadAlloc" );
1655             return -1;
1656
1657         default:
1658             msg_Warn( p_vout, "XvQueryExtension failed" );
1659             return -1;
1660     }
1661
1662     switch( XvQueryAdaptors( p_vout->p_sys->p_display,
1663                              DefaultRootWindow( p_vout->p_sys->p_display ),
1664                              &i_num_adaptors, &p_adaptor ) )
1665     {
1666         case Success:
1667             break;
1668
1669         case XvBadExtension:
1670             msg_Warn( p_vout, "XvBadExtension for XvQueryAdaptors" );
1671             return -1;
1672
1673         case XvBadAlloc:
1674             msg_Warn( p_vout, "XvBadAlloc for XvQueryAdaptors" );
1675             return -1;
1676
1677         default:
1678             msg_Warn( p_vout, "XvQueryAdaptors failed" );
1679             return -1;
1680     }
1681
1682     i_selected_port = -1;
1683     i_requested_adaptor = config_GetInt( p_vout, "xvideo-adaptor" );
1684
1685     for( i_adaptor = 0; i_adaptor < i_num_adaptors; ++i_adaptor )
1686     {
1687         XvImageFormatValues *p_formats;
1688         int i_format, i_num_formats;
1689         int i_port;
1690
1691         /* If we requested an adaptor and it's not this one, we aren't
1692          * interested */
1693         if( i_requested_adaptor != -1 && i_adaptor != i_requested_adaptor )
1694         {
1695             continue;
1696         }
1697
1698         /* If the adaptor doesn't have the required properties, skip it */
1699         if( !( p_adaptor[ i_adaptor ].type & XvInputMask ) ||
1700             !( p_adaptor[ i_adaptor ].type & XvImageMask ) )
1701         {
1702             continue;
1703         }
1704
1705         /* Check that adaptor supports our requested format... */
1706         p_formats = XvListImageFormats( p_vout->p_sys->p_display,
1707                                         p_adaptor[i_adaptor].base_id,
1708                                         &i_num_formats );
1709
1710         for( i_format = 0;
1711              i_format < i_num_formats && ( i_selected_port == -1 );
1712              i_format++ )
1713         {
1714             XvAttribute     *p_attr;
1715             int             i_attr, i_num_attributes;
1716
1717             /* If this is not the format we want, or at least a
1718              * similar one, forget it */
1719             if( !vout_ChromaCmp( p_formats[ i_format ].id, i_chroma ) )
1720             {
1721                 continue;
1722             }
1723
1724             /* Look for the first available port supporting this format */
1725             for( i_port = p_adaptor[i_adaptor].base_id;
1726                  ( i_port < (int)(p_adaptor[i_adaptor].base_id
1727                                    + p_adaptor[i_adaptor].num_ports) )
1728                    && ( i_selected_port == -1 );
1729                  i_port++ )
1730             {
1731                 if( XvGrabPort( p_vout->p_sys->p_display, i_port, CurrentTime )
1732                      == Success )
1733                 {
1734                     i_selected_port = i_port;
1735                     *pi_newchroma = p_formats[ i_format ].id;
1736                 }
1737             }
1738
1739             /* If no free port was found, forget it */
1740             if( i_selected_port == -1 )
1741             {
1742                 continue;
1743             }
1744
1745             /* If we found a port, print information about it */
1746             msg_Dbg( p_vout, "adaptor %i, port %i, format 0x%x (%4.4s) %s",
1747                      i_adaptor, i_selected_port, p_formats[ i_format ].id,
1748                      (char *)&p_formats[ i_format ].id,
1749                      ( p_formats[ i_format ].format == XvPacked ) ?
1750                          "packed" : "planar" );
1751
1752             /* Make sure XV_AUTOPAINT_COLORKEY is set */
1753             p_attr = XvQueryPortAttributes( p_vout->p_sys->p_display,
1754                                             i_selected_port,
1755                                             &i_num_attributes );
1756
1757             for( i_attr = 0; i_attr < i_num_attributes; i_attr++ )
1758             {
1759                 if( !strcmp( p_attr[i_attr].name, "XV_AUTOPAINT_COLORKEY" ) )
1760                 {
1761                     const Atom autopaint =
1762                         XInternAtom( p_vout->p_sys->p_display,
1763                                      "XV_AUTOPAINT_COLORKEY", False );
1764                     XvSetPortAttribute( p_vout->p_sys->p_display,
1765                                         i_selected_port, autopaint, 1 );
1766                     break;
1767                 }
1768             }
1769
1770             if( p_attr != NULL )
1771             {
1772                 XFree( p_attr );
1773             }
1774         }
1775
1776         if( p_formats != NULL )
1777         {
1778             XFree( p_formats );
1779         }
1780
1781     }
1782
1783     if( i_num_adaptors > 0 )
1784     {
1785         XvFreeAdaptorInfo( p_adaptor );
1786     }
1787
1788     if( i_selected_port == -1 )
1789     {
1790         int i_chroma_tmp = X112VLC_FOURCC( i_chroma );
1791         if( i_requested_adaptor == -1 )
1792         {
1793             msg_Warn( p_vout, "no free XVideo port found for format "
1794                       "0x%.8x (%4.4s)", i_chroma_tmp, (char*)&i_chroma_tmp );
1795         }
1796         else
1797         {
1798             msg_Warn( p_vout, "XVideo adaptor %i does not have a free "
1799                       "XVideo port for format 0x%.8x (%4.4s)",
1800                       i_requested_adaptor, i_chroma_tmp, (char*)&i_chroma_tmp );
1801         }
1802     }
1803
1804     return i_selected_port;
1805 }
1806
1807 /*****************************************************************************
1808  * XVideoReleasePort: release YUV12 port
1809  *****************************************************************************/
1810 static void XVideoReleasePort( vout_thread_t *p_vout, int i_port )
1811 {
1812     XvUngrabPort( p_vout->p_sys->p_display, i_port, CurrentTime );
1813 }
1814 #endif
1815
1816 /*****************************************************************************
1817  * InitDisplay: open and initialize X11 device
1818  *****************************************************************************
1819  * Create a window according to video output given size, and set other
1820  * properties according to the display properties.
1821  *****************************************************************************/
1822 static int InitDisplay( vout_thread_t *p_vout )
1823 {
1824 #ifdef MODULE_NAME_IS_x11
1825     XPixmapFormatValues *       p_formats;                 /* pixmap formats */
1826     XVisualInfo *               p_xvisual;            /* visuals information */
1827     XVisualInfo                 xvisual_template;         /* visual template */
1828     int                         i_count;                       /* array size */
1829 #endif
1830
1831 #ifdef HAVE_SYS_SHM_H
1832     p_vout->p_sys->b_shm = 0;
1833
1834     if( config_GetInt( p_vout, MODULE_STRING "-shm" ) )
1835     {
1836 #   ifdef SYS_DARWIN
1837         /* FIXME: As of 2001-03-16, XFree4 for MacOS X does not support Xshm */
1838 #   else
1839         p_vout->p_sys->b_shm =
1840                   ( XShmQueryExtension( p_vout->p_sys->p_display ) == True );
1841 #   endif
1842
1843         if( !p_vout->p_sys->b_shm )
1844         {
1845             msg_Warn( p_vout, "XShm video extension is unavailable" );
1846         }
1847     }
1848     else
1849     {
1850         msg_Dbg( p_vout, "disabling XShm video extension" );
1851     }
1852
1853 #else
1854     msg_Warn( p_vout, "XShm video extension is unavailable" );
1855
1856 #endif
1857
1858 #ifdef MODULE_NAME_IS_xvideo
1859     /* XXX The brightness and contrast values should be read from environment
1860      * XXX variables... */
1861 #if 0
1862     XVideoSetAttribute( p_vout, "XV_BRIGHTNESS", 0.5 );
1863     XVideoSetAttribute( p_vout, "XV_CONTRAST",   0.5 );
1864 #endif
1865 #endif
1866
1867 #ifdef MODULE_NAME_IS_x11
1868     /* Initialize structure */
1869     p_vout->p_sys->i_screen = DefaultScreen( p_vout->p_sys->p_display );
1870
1871     /* Get screen depth */
1872     p_vout->p_sys->i_screen_depth = XDefaultDepth( p_vout->p_sys->p_display,
1873                                                    p_vout->p_sys->i_screen );
1874     switch( p_vout->p_sys->i_screen_depth )
1875     {
1876     case 8:
1877         /*
1878          * Screen depth is 8bpp. Use PseudoColor visual with private colormap.
1879          */
1880         xvisual_template.screen =   p_vout->p_sys->i_screen;
1881         xvisual_template.class =    DirectColor;
1882         p_xvisual = XGetVisualInfo( p_vout->p_sys->p_display,
1883                                     VisualScreenMask | VisualClassMask,
1884                                     &xvisual_template, &i_count );
1885         if( p_xvisual == NULL )
1886         {
1887             msg_Err( p_vout, "no PseudoColor visual available" );
1888             return VLC_EGENERIC;
1889         }
1890         p_vout->p_sys->i_bytes_per_pixel = 1;
1891         p_vout->output.pf_setpalette = SetPalette;
1892         break;
1893     case 15:
1894     case 16:
1895     case 24:
1896     default:
1897         /*
1898          * Screen depth is higher than 8bpp. TrueColor visual is used.
1899          */
1900         xvisual_template.screen =   p_vout->p_sys->i_screen;
1901         xvisual_template.class =    TrueColor;
1902         p_xvisual = XGetVisualInfo( p_vout->p_sys->p_display,
1903                                     VisualScreenMask | VisualClassMask,
1904                                     &xvisual_template, &i_count );
1905         if( p_xvisual == NULL )
1906         {
1907             msg_Err( p_vout, "no TrueColor visual available" );
1908             return VLC_EGENERIC;
1909         }
1910
1911         p_vout->output.i_rmask = p_xvisual->red_mask;
1912         p_vout->output.i_gmask = p_xvisual->green_mask;
1913         p_vout->output.i_bmask = p_xvisual->blue_mask;
1914
1915         /* There is no difference yet between 3 and 4 Bpp. The only way
1916          * to find the actual number of bytes per pixel is to list supported
1917          * pixmap formats. */
1918         p_formats = XListPixmapFormats( p_vout->p_sys->p_display, &i_count );
1919         p_vout->p_sys->i_bytes_per_pixel = 0;
1920
1921         for( ; i_count-- ; p_formats++ )
1922         {
1923             /* Under XFree4.0, the list contains pixmap formats available
1924              * through all video depths ; so we have to check against current
1925              * depth. */
1926             if( p_formats->depth == (int)p_vout->p_sys->i_screen_depth )
1927             {
1928                 if( p_formats->bits_per_pixel / 8
1929                         > (int)p_vout->p_sys->i_bytes_per_pixel )
1930                 {
1931                     p_vout->p_sys->i_bytes_per_pixel =
1932                                                p_formats->bits_per_pixel / 8;
1933                 }
1934             }
1935         }
1936         break;
1937     }
1938     p_vout->p_sys->p_visual = p_xvisual->visual;
1939     XFree( p_xvisual );
1940 #endif
1941
1942     return VLC_SUCCESS;
1943 }
1944
1945 #ifdef HAVE_SYS_SHM_H
1946 /*****************************************************************************
1947  * CreateShmImage: create an XImage or XvImage using shared memory extension
1948  *****************************************************************************
1949  * Prepare an XImage or XvImage for display function.
1950  * The order of the operations respects the recommandations of the mit-shm
1951  * document by J.Corbet and K.Packard. Most of the parameters were copied from
1952  * there. See http://ftp.xfree86.org/pub/XFree86/4.0/doc/mit-shm.TXT
1953  *****************************************************************************/
1954 static IMAGE_TYPE * CreateShmImage( vout_thread_t *p_vout,
1955                                     Display* p_display, EXTRA_ARGS_SHM,
1956                                     int i_width, int i_height )
1957 {
1958     IMAGE_TYPE *p_image;
1959
1960     /* Create XImage / XvImage */
1961 #ifdef MODULE_NAME_IS_xvideo
1962     p_image = XvShmCreateImage( p_display, i_xvport, i_chroma, 0,
1963                                 i_width, i_height, p_shm );
1964 #else
1965     p_image = XShmCreateImage( p_display, p_visual, i_depth, ZPixmap, 0,
1966                                p_shm, i_width, i_height );
1967 #endif
1968     if( p_image == NULL )
1969     {
1970         msg_Err( p_vout, "image creation failed" );
1971         return NULL;
1972     }
1973
1974     /* Allocate shared memory segment - 0776 set the access permission
1975      * rights (like umask), they are not yet supported by all X servers */
1976     p_shm->shmid = shmget( IPC_PRIVATE, DATA_SIZE(p_image), IPC_CREAT | 0776 );
1977     if( p_shm->shmid < 0 )
1978     {
1979         msg_Err( p_vout, "cannot allocate shared image data (%s)",
1980                          strerror( errno ) );
1981         IMAGE_FREE( p_image );
1982         return NULL;
1983     }
1984
1985     /* Attach shared memory segment to process (read/write) */
1986     p_shm->shmaddr = p_image->data = shmat( p_shm->shmid, 0, 0 );
1987     if(! p_shm->shmaddr )
1988     {
1989         msg_Err( p_vout, "cannot attach shared memory (%s)",
1990                          strerror(errno));
1991         IMAGE_FREE( p_image );
1992         shmctl( p_shm->shmid, IPC_RMID, 0 );
1993         return NULL;
1994     }
1995
1996     /* Read-only data. We won't be using XShmGetImage */
1997     p_shm->readOnly = True;
1998
1999     /* Attach shared memory segment to X server */
2000     if( XShmAttach( p_display, p_shm ) == False )
2001     {
2002         msg_Err( p_vout, "cannot attach shared memory to X server" );
2003         IMAGE_FREE( p_image );
2004         shmctl( p_shm->shmid, IPC_RMID, 0 );
2005         shmdt( p_shm->shmaddr );
2006         return NULL;
2007     }
2008
2009     /* Send image to X server. This instruction is required, since having
2010      * built a Shm XImage and not using it causes an error on XCloseDisplay,
2011      * and remember NOT to use XFlush ! */
2012     XSync( p_display, False );
2013
2014 #if 0
2015     /* Mark the shm segment to be removed when there are no more
2016      * attachements, so it is automatic on process exit or after shmdt */
2017     shmctl( p_shm->shmid, IPC_RMID, 0 );
2018 #endif
2019
2020     return p_image;
2021 }
2022 #endif
2023
2024 /*****************************************************************************
2025  * CreateImage: create an XImage or XvImage
2026  *****************************************************************************
2027  * Create a simple image used as a buffer.
2028  *****************************************************************************/
2029 static IMAGE_TYPE * CreateImage( vout_thread_t *p_vout,
2030                                  Display *p_display, EXTRA_ARGS,
2031                                  int i_width, int i_height )
2032 {
2033     byte_t *    p_data;                           /* image data storage zone */
2034     IMAGE_TYPE *p_image;
2035 #ifdef MODULE_NAME_IS_x11
2036     int         i_quantum;                     /* XImage quantum (see below) */
2037     int         i_bytes_per_line;
2038 #endif
2039
2040     /* Allocate memory for image */
2041 #ifdef MODULE_NAME_IS_xvideo
2042     p_data = (byte_t *) malloc( i_width * i_height * i_bits_per_pixel / 8 );
2043 #elif defined(MODULE_NAME_IS_x11)
2044     i_bytes_per_line = i_width * i_bytes_per_pixel;
2045     p_data = (byte_t *) malloc( i_bytes_per_line * i_height );
2046 #endif
2047     if( !p_data )
2048     {
2049         msg_Err( p_vout, "out of memory" );
2050         return NULL;
2051     }
2052
2053 #ifdef MODULE_NAME_IS_x11
2054     /* Optimize the quantum of a scanline regarding its size - the quantum is
2055        a diviser of the number of bits between the start of two scanlines. */
2056     if( i_bytes_per_line & 0xf )
2057     {
2058         i_quantum = 0x8;
2059     }
2060     else if( i_bytes_per_line & 0x10 )
2061     {
2062         i_quantum = 0x10;
2063     }
2064     else
2065     {
2066         i_quantum = 0x20;
2067     }
2068 #endif
2069
2070     /* Create XImage. p_data will be automatically freed */
2071 #ifdef MODULE_NAME_IS_xvideo
2072     p_image = XvCreateImage( p_display, i_xvport, i_chroma,
2073                              p_data, i_width, i_height );
2074 #elif defined(MODULE_NAME_IS_x11)
2075     p_image = XCreateImage( p_display, p_visual, i_depth, ZPixmap, 0,
2076                             p_data, i_width, i_height, i_quantum, 0 );
2077 #endif
2078     if( p_image == NULL )
2079     {
2080         msg_Err( p_vout, "XCreateImage() failed" );
2081         free( p_data );
2082         return NULL;
2083     }
2084
2085     return p_image;
2086 }
2087
2088 #ifdef MODULE_NAME_IS_x11
2089 /*****************************************************************************
2090  * SetPalette: sets an 8 bpp palette
2091  *****************************************************************************
2092  * This function sets the palette given as an argument. It does not return
2093  * anything, but could later send information on which colors it was unable
2094  * to set.
2095  *****************************************************************************/
2096 static void SetPalette( vout_thread_t *p_vout,
2097                         uint16_t *red, uint16_t *green, uint16_t *blue )
2098 {
2099     int i;
2100     XColor p_colors[255];
2101
2102     /* allocate palette */
2103     for( i = 0; i < 255; i++ )
2104     {
2105         /* kludge: colors are indexed reversely because color 255 seems
2106          * to be reserved for black even if we try to set it to white */
2107         p_colors[ i ].pixel = 255 - i;
2108         p_colors[ i ].pad   = 0;
2109         p_colors[ i ].flags = DoRed | DoGreen | DoBlue;
2110         p_colors[ i ].red   = red[ 255 - i ];
2111         p_colors[ i ].blue  = blue[ 255 - i ];
2112         p_colors[ i ].green = green[ 255 - i ];
2113     }
2114
2115     XStoreColors( p_vout->p_sys->p_display,
2116                   p_vout->p_sys->colormap, p_colors, 255 );
2117 }
2118 #endif
2119
2120 /*****************************************************************************
2121  * Control: control facility for the vout
2122  *****************************************************************************/
2123 static int Control( vout_thread_t *p_vout, int i_query, va_list args )
2124 {
2125     double f_arg;
2126     vlc_bool_t b_arg;
2127
2128     switch( i_query )
2129     {
2130         case VOUT_SET_ZOOM:
2131             if( p_vout->p_sys->p_win->owner_window )
2132                 return vout_ControlWindow( p_vout,
2133                     (void *)p_vout->p_sys->p_win->owner_window, i_query, args);
2134
2135             f_arg = va_arg( args, double );
2136
2137             vlc_mutex_lock( &p_vout->p_sys->lock );
2138
2139             /* Update dimensions */
2140             /* FIXME: export InitWindowSize() from vout core */
2141             XResizeWindow( p_vout->p_sys->p_display,
2142                            p_vout->p_sys->p_win->base_window,
2143                            p_vout->i_window_width * f_arg,
2144                            p_vout->i_window_height * f_arg );
2145
2146             vlc_mutex_unlock( &p_vout->p_sys->lock );
2147             return VLC_SUCCESS;
2148
2149        case VOUT_CLOSE:
2150             vlc_mutex_lock( &p_vout->p_sys->lock );
2151             XUnmapWindow( p_vout->p_sys->p_display,
2152                           p_vout->p_sys->original_window.base_window );
2153             vlc_mutex_unlock( &p_vout->p_sys->lock );
2154             /* Fall through */
2155
2156        case VOUT_REPARENT:
2157             vlc_mutex_lock( &p_vout->p_sys->lock );
2158             XReparentWindow( p_vout->p_sys->p_display,
2159                              p_vout->p_sys->original_window.base_window,
2160                              DefaultRootWindow( p_vout->p_sys->p_display ),
2161                              0, 0 );
2162             XSync( p_vout->p_sys->p_display, False );
2163             p_vout->p_sys->original_window.owner_window = 0;
2164             vlc_mutex_unlock( &p_vout->p_sys->lock );
2165             return vout_vaControlDefault( p_vout, i_query, args );
2166
2167         case VOUT_SET_STAY_ON_TOP:
2168             if( p_vout->p_sys->p_win->owner_window )
2169                 return vout_ControlWindow( p_vout,
2170                     (void *)p_vout->p_sys->p_win->owner_window, i_query, args);
2171
2172             b_arg = va_arg( args, vlc_bool_t );
2173             vlc_mutex_lock( &p_vout->p_sys->lock );
2174             WindowOnTop( p_vout, b_arg );
2175             vlc_mutex_unlock( &p_vout->p_sys->lock );
2176             return VLC_SUCCESS;
2177
2178        default:
2179             return vout_vaControlDefault( p_vout, i_query, args );
2180     }
2181 }
2182
2183 /*****************************************************************************
2184  * TestNetWMSupport: tests for Extended Window Manager Hints support
2185  *****************************************************************************/
2186 static void TestNetWMSupport( vout_thread_t *p_vout )
2187 {
2188     int i_ret, i_format;
2189     unsigned long i, i_items, i_bytesafter;
2190     Atom net_wm_supported, *p_args = NULL;
2191
2192     p_vout->p_sys->b_net_wm_state_fullscreen = VLC_FALSE;
2193     p_vout->p_sys->b_net_wm_state_above = VLC_FALSE;
2194     p_vout->p_sys->b_net_wm_state_below = VLC_FALSE;
2195     p_vout->p_sys->b_net_wm_state_stays_on_top = VLC_FALSE;
2196
2197     net_wm_supported =
2198         XInternAtom( p_vout->p_sys->p_display, "_NET_SUPPORTED", False );
2199
2200     i_ret = XGetWindowProperty( p_vout->p_sys->p_display,
2201                                 DefaultRootWindow( p_vout->p_sys->p_display ),
2202                                 net_wm_supported,
2203                                 0, 16384, False, AnyPropertyType,
2204                                 &net_wm_supported,
2205                                 &i_format, &i_items, &i_bytesafter,
2206                                 (unsigned char **)(intptr_t)&p_args );
2207
2208     if( i_ret != Success || i_items == 0 ) return;
2209
2210     msg_Dbg( p_vout, "Window manager supports NetWM" );
2211
2212     p_vout->p_sys->net_wm_state =
2213         XInternAtom( p_vout->p_sys->p_display, "_NET_WM_STATE", False );
2214     p_vout->p_sys->net_wm_state_fullscreen =
2215         XInternAtom( p_vout->p_sys->p_display, "_NET_WM_STATE_FULLSCREEN",
2216                      False );
2217     p_vout->p_sys->net_wm_state_above =
2218         XInternAtom( p_vout->p_sys->p_display, "_NET_WM_STATE_ABOVE", False );
2219     p_vout->p_sys->net_wm_state_below =
2220         XInternAtom( p_vout->p_sys->p_display, "_NET_WM_STATE_BELOW", False );
2221     p_vout->p_sys->net_wm_state_stays_on_top =
2222         XInternAtom( p_vout->p_sys->p_display, "_NET_WM_STATE_STAYS_ON_TOP",
2223                      False );
2224
2225     for( i = 0; i < i_items; i++ )
2226     {
2227         if( p_args[i] == p_vout->p_sys->net_wm_state_fullscreen )
2228         {
2229             msg_Dbg( p_vout,
2230                      "Window manager supports _NET_WM_STATE_FULLSCREEN" );
2231             p_vout->p_sys->b_net_wm_state_fullscreen = VLC_TRUE;
2232         }
2233         else if( p_args[i] == p_vout->p_sys->net_wm_state_above )
2234         {
2235             msg_Dbg( p_vout, "Window manager supports _NET_WM_STATE_ABOVE" );
2236             p_vout->p_sys->b_net_wm_state_above = VLC_TRUE;
2237         }
2238         else if( p_args[i] == p_vout->p_sys->net_wm_state_below )
2239         {
2240             msg_Dbg( p_vout, "Window manager supports _NET_WM_STATE_BELOW" );
2241             p_vout->p_sys->b_net_wm_state_below = VLC_TRUE;
2242         }
2243         else if( p_args[i] == p_vout->p_sys->net_wm_state_stays_on_top )
2244         {
2245             msg_Dbg( p_vout,
2246                      "Window manager supports _NET_WM_STATE_STAYS_ON_TOP" );
2247             p_vout->p_sys->b_net_wm_state_stays_on_top = VLC_TRUE;
2248         }
2249     }
2250
2251     XFree( p_args );
2252 }
2253
2254 /*****************************************************************************
2255  * Key events handling
2256  *****************************************************************************/
2257 static struct
2258 {
2259     int i_x11key;
2260     int i_vlckey;
2261
2262 } x11keys_to_vlckeys[] =
2263 {
2264     { XK_F1, KEY_F1 }, { XK_F2, KEY_F2 }, { XK_F3, KEY_F3 }, { XK_F4, KEY_F4 },
2265     { XK_F5, KEY_F5 }, { XK_F6, KEY_F6 }, { XK_F7, KEY_F7 }, { XK_F8, KEY_F8 },
2266     { XK_F9, KEY_F9 }, { XK_F10, KEY_F10 }, { XK_F11, KEY_F11 },
2267     { XK_F12, KEY_F12 },
2268
2269     { XK_Return, KEY_ENTER },
2270     { XK_KP_Enter, KEY_ENTER },
2271     { XK_space, KEY_SPACE },
2272     { XK_Escape, KEY_ESC },
2273
2274     { XK_Menu, KEY_MENU },
2275     { XK_Left, KEY_LEFT },
2276     { XK_Right, KEY_RIGHT },
2277     { XK_Up, KEY_UP },
2278     { XK_Down, KEY_DOWN },
2279
2280     { XK_Home, KEY_HOME },
2281     { XK_End, KEY_END },
2282     { XK_Page_Up, KEY_PAGEUP },
2283     { XK_Page_Down, KEY_PAGEDOWN },
2284     { 0, 0 }
2285 };
2286
2287 static int ConvertKey( int i_key )
2288 {
2289     int i;
2290
2291     for( i = 0; x11keys_to_vlckeys[i].i_x11key != 0; i++ )
2292     {
2293         if( x11keys_to_vlckeys[i].i_x11key == i_key )
2294         {
2295             return x11keys_to_vlckeys[i].i_vlckey;
2296         }
2297     }
2298
2299     return 0;
2300 }
2301
2302 /*****************************************************************************
2303  * WindowOnTop: Switches the "always on top" state of the video window.
2304  *****************************************************************************/
2305 static int WindowOnTop( vout_thread_t *p_vout, vlc_bool_t b_on_top )
2306 {
2307     if( p_vout->p_sys->b_net_wm_state_stays_on_top )
2308     {
2309         XClientMessageEvent event;
2310
2311         memset( &event, 0, sizeof( XClientMessageEvent ) );
2312
2313         event.type = ClientMessage;
2314         event.message_type = p_vout->p_sys->net_wm_state;
2315         event.display = p_vout->p_sys->p_display;
2316         event.window = p_vout->p_sys->p_win->base_window;
2317         event.format = 32;
2318         event.data.l[ 0 ] = b_on_top; /* set property */
2319         event.data.l[ 1 ] = p_vout->p_sys->net_wm_state_stays_on_top;
2320
2321         XSendEvent( p_vout->p_sys->p_display,
2322                     DefaultRootWindow( p_vout->p_sys->p_display ),
2323                     False, SubstructureRedirectMask,
2324                     (XEvent*)&event );
2325     }
2326
2327     return VLC_SUCCESS;
2328 }