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