equalizer.c: compile fix for old compilers (thx sam)
[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                     break;
636
637                 case Button5:
638                     var_Get( p_vout, "mouse-button-down", &val );
639                     val.i_int |= 16;
640                     var_Set( p_vout, "mouse-button-down", val );
641                     break;
642             }
643         }
644         /* Mouse release */
645         else if( xevent.type == ButtonRelease )
646         {
647             switch( ((XButtonEvent *)&xevent)->button )
648             {
649                 case Button1:
650                     var_Get( p_vout, "mouse-button-down", &val );
651                     val.i_int &= ~1;
652                     var_Set( p_vout, "mouse-button-down", val );
653
654                     val.b_bool = VLC_TRUE;
655                     var_Set( p_vout, "mouse-clicked", val );
656                     break;
657
658                 case Button2:
659                     {
660                         playlist_t *p_playlist;
661
662                         var_Get( p_vout, "mouse-button-down", &val );
663                         val.i_int &= ~2;
664                         var_Set( p_vout, "mouse-button-down", val );
665
666                         p_playlist = vlc_object_find( p_vout,
667                                                       VLC_OBJECT_PLAYLIST,
668                                                       FIND_ANYWHERE );
669                         if( p_playlist != NULL )
670                         {
671                             vlc_value_t val;
672                             var_Get( p_playlist, "intf-show", &val );
673                             val.b_bool = !val.b_bool;
674                             var_Set( p_playlist, "intf-show", val );
675                             vlc_object_release( p_playlist );
676                         }
677                     }
678                     break;
679
680                 case Button3:
681                     {
682                         intf_thread_t *p_intf;
683                         playlist_t *p_playlist;
684
685                         var_Get( p_vout, "mouse-button-down", &val );
686                         val.i_int &= ~4;
687                         var_Set( p_vout, "mouse-button-down", val );
688                         p_intf = vlc_object_find( p_vout, VLC_OBJECT_INTF,
689                                                           FIND_ANYWHERE );
690                         if( p_intf )
691                         {
692                             p_intf->b_menu_change = 1;
693                             vlc_object_release( p_intf );
694                         }
695
696                         p_playlist = vlc_object_find( p_vout,
697                                                       VLC_OBJECT_PLAYLIST,
698                                                       FIND_ANYWHERE );
699                         if( p_playlist != NULL )
700                         {
701                             vlc_value_t val; val.b_bool = VLC_TRUE;
702                             var_Set( p_playlist, "intf-popupmenu", val );
703                             vlc_object_release( p_playlist );
704                         }
705                     }
706                     break;
707
708                 case Button4:
709                     var_Get( p_vout, "mouse-button-down", &val );
710                     val.i_int &= ~8;
711                     var_Set( p_vout, "mouse-button-down", val );
712                     break;
713
714                 case Button5:
715                     var_Get( p_vout, "mouse-button-down", &val );
716                     val.i_int &= ~16;
717                     var_Set( p_vout, "mouse-button-down", val );
718                     break;
719
720             }
721         }
722         /* Mouse move */
723         else if( xevent.type == MotionNotify )
724         {
725             int i_width, i_height, i_x, i_y;
726             vlc_value_t val;
727
728             /* somewhat different use for vout_PlacePicture:
729              * here the values are needed to give to mouse coordinates
730              * in the original picture space */
731             vout_PlacePicture( p_vout, p_vout->p_sys->p_win->i_width,
732                                p_vout->p_sys->p_win->i_height,
733                                &i_x, &i_y, &i_width, &i_height );
734
735             val.i_int = ( xevent.xmotion.x - i_x )
736                          * p_vout->render.i_width / i_width;
737             var_Set( p_vout, "mouse-x", val );
738             val.i_int = ( xevent.xmotion.y - i_y )
739                          * p_vout->render.i_height / i_height;
740             var_Set( p_vout, "mouse-y", val );
741
742             val.b_bool = VLC_TRUE;
743             var_Set( p_vout, "mouse-moved", val );
744
745             p_vout->p_sys->i_time_mouse_last_moved = mdate();
746             if( ! p_vout->p_sys->b_mouse_pointer_visible )
747             {
748                 ToggleCursor( p_vout );
749             }
750         }
751         else if( xevent.type == ReparentNotify /* XXX: why do we get this? */
752                   || xevent.type == MapNotify
753                   || xevent.type == UnmapNotify )
754         {
755             /* Ignore these events */
756         }
757         else /* Other events */
758         {
759             msg_Warn( p_vout, "unhandled event %d received", xevent.type );
760         }
761     }
762
763     /* Handle events for video output sub-window */
764     while( XCheckWindowEvent( p_vout->p_sys->p_display,
765                               p_vout->p_sys->p_win->video_window,
766                               ExposureMask, &xevent ) == True )
767     {
768         /* Window exposed (only handled if stream playback is paused) */
769         if( xevent.type == Expose )
770         {
771             if( ((XExposeEvent *)&xevent)->count == 0 )
772             {
773                 /* (if this is the last a collection of expose events...) */
774 #if 0
775                 if( p_vout->p_vlc->p_input_bank->pp_input[0] != NULL )
776                 {
777                     if( PAUSE_S == p_vout->p_vlc->p_input_bank->pp_input[0]
778                                                    ->stream.control.i_status )
779                     {
780                         /* XVideoDisplay( p_vout )*/;
781                     }
782                 }
783 #endif
784             }
785         }
786     }
787
788     /* ClientMessage event - only WM_PROTOCOLS with WM_DELETE_WINDOW data
789      * are handled - according to the man pages, the format is always 32
790      * in this case */
791     while( XCheckTypedEvent( p_vout->p_sys->p_display,
792                              ClientMessage, &xevent ) )
793     {
794         if( (xevent.xclient.message_type == p_vout->p_sys->p_win->wm_protocols)
795                && ((Atom)xevent.xclient.data.l[0]
796                      == p_vout->p_sys->p_win->wm_delete_window ) )
797         {
798             /* the user wants to close the window */
799             playlist_t * p_playlist =
800                 (playlist_t *)vlc_object_find( p_vout, VLC_OBJECT_PLAYLIST,
801                                                FIND_ANYWHERE );
802             if( p_playlist != NULL )
803             {
804                 playlist_Stop( p_playlist );
805                 vlc_object_release( p_playlist );
806             }
807         }
808     }
809
810     /*
811      * Fullscreen Change
812      */
813     if ( p_vout->i_changes & VOUT_FULLSCREEN_CHANGE )
814     {
815         vlc_value_t val;
816
817         /* Update the object variable and trigger callback */
818         val.b_bool = !p_vout->b_fullscreen;
819         var_Set( p_vout, "fullscreen", val );
820
821         ToggleFullScreen( p_vout );
822         p_vout->i_changes &= ~VOUT_FULLSCREEN_CHANGE;
823     }
824
825     /*
826      * Size change
827      *
828      * (Needs to be placed after VOUT_FULLSREEN_CHANGE because we can activate
829      *  the size flag inside the fullscreen routine)
830      */
831     if( p_vout->i_changes & VOUT_SIZE_CHANGE )
832     {
833         int i_width, i_height, i_x, i_y;
834
835         p_vout->i_changes &= ~VOUT_SIZE_CHANGE;
836
837 #ifdef MODULE_NAME_IS_x11
838         /* We need to signal the vout thread about the size change because it
839          * is doing the rescaling */
840         p_vout->i_changes |= VOUT_SIZE_CHANGE;
841 #endif
842
843         vout_PlacePicture( p_vout, p_vout->p_sys->p_win->i_width,
844                            p_vout->p_sys->p_win->i_height,
845                            &i_x, &i_y, &i_width, &i_height );
846
847         XMoveResizeWindow( p_vout->p_sys->p_display,
848                            p_vout->p_sys->p_win->video_window,
849                            i_x, i_y, i_width, i_height );
850     }
851
852     /* Autohide Cursour */
853     if( mdate() - p_vout->p_sys->i_time_mouse_last_moved > 2000000 )
854     {
855         /* Hide the mouse automatically */
856         if( p_vout->p_sys->b_mouse_pointer_visible )
857         {
858             ToggleCursor( p_vout );
859         }
860     }
861
862     vlc_mutex_unlock( &p_vout->p_sys->lock );
863
864     return 0;
865 }
866
867 /*****************************************************************************
868  * EndVideo: terminate X11 video thread output method
869  *****************************************************************************
870  * Destroy the X11 XImages created by Init. It is called at the end of
871  * the thread, but also each time the window is resized.
872  *****************************************************************************/
873 static void EndVideo( vout_thread_t *p_vout )
874 {
875     int i_index;
876
877     /* Free the direct buffers we allocated */
878     for( i_index = I_OUTPUTPICTURES ; i_index ; )
879     {
880         i_index--;
881         FreePicture( p_vout, PP_OUTPUTPICTURE[ i_index ] );
882     }
883 }
884
885 /* following functions are local */
886
887 /*****************************************************************************
888  * CreateWindow: open and set-up X11 main window
889  *****************************************************************************/
890 static int CreateWindow( vout_thread_t *p_vout, x11_window_t *p_win )
891 {
892     XSizeHints              xsize_hints;
893     XSetWindowAttributes    xwindow_attributes;
894     XGCValues               xgcvalues;
895     XEvent                  xevent;
896
897     vlc_bool_t              b_expose = VLC_FALSE;
898     vlc_bool_t              b_configure_notify = VLC_FALSE;
899     vlc_bool_t              b_map_notify = VLC_FALSE;
900
901     /* Prepare window manager hints and properties */
902     p_win->wm_protocols =
903              XInternAtom( p_vout->p_sys->p_display, "WM_PROTOCOLS", True );
904     p_win->wm_delete_window =
905              XInternAtom( p_vout->p_sys->p_display, "WM_DELETE_WINDOW", True );
906
907     /* Never have a 0-pixel-wide window */
908     xsize_hints.min_width = 2;
909     xsize_hints.min_height = 1;
910
911     /* Prepare window attributes */
912     xwindow_attributes.backing_store = Always;       /* save the hidden part */
913     xwindow_attributes.background_pixel = BlackPixel(p_vout->p_sys->p_display,
914                                                      p_vout->p_sys->i_screen);
915     xwindow_attributes.event_mask = ExposureMask | StructureNotifyMask;
916
917     if( !p_vout->b_fullscreen )
918     {
919         p_win->owner_window =
920             (Window)vout_RequestWindow( p_vout, &p_win->i_x, &p_win->i_y,
921                                         &p_win->i_width, &p_win->i_height );
922
923         xsize_hints.base_width  = xsize_hints.width = p_win->i_width;
924         xsize_hints.base_height = xsize_hints.height = p_win->i_height;
925         xsize_hints.flags       = PSize | PMinSize;
926
927         if( p_win->i_x >=0 || p_win->i_y >= 0 )
928         {
929             xsize_hints.x = p_win->i_x;
930             xsize_hints.y = p_win->i_y;
931             xsize_hints.flags |= PPosition;
932         }
933     }
934     else
935     {
936         /* Fullscreen window size and position */
937         p_win->owner_window = 0;
938         p_win->i_x = p_win->i_y = 0;
939         p_win->i_width =
940             DisplayWidth( p_vout->p_sys->p_display, p_vout->p_sys->i_screen );
941         p_win->i_height =
942             DisplayHeight( p_vout->p_sys->p_display, p_vout->p_sys->i_screen );
943     }
944
945     if( !p_win->owner_window )
946     {
947         /* Create the window and set hints - the window must receive
948          * ConfigureNotify events, and until it is displayed, Expose and
949          * MapNotify events. */
950
951         p_win->base_window =
952             XCreateWindow( p_vout->p_sys->p_display,
953                            DefaultRootWindow( p_vout->p_sys->p_display ),
954                            p_win->i_x, p_win->i_y,
955                            p_win->i_width, p_win->i_height,
956                            0,
957                            0, InputOutput, 0,
958                            CWBackingStore | CWBackPixel | CWEventMask,
959                            &xwindow_attributes );
960
961         if( !p_vout->b_fullscreen )
962         {
963             /* Set window manager hints and properties: size hints, command,
964              * window's name, and accepted protocols */
965             XSetWMNormalHints( p_vout->p_sys->p_display,
966                                p_win->base_window, &xsize_hints );
967             XSetCommand( p_vout->p_sys->p_display, p_win->base_window,
968                          p_vout->p_vlc->ppsz_argv, p_vout->p_vlc->i_argc );
969
970             XStoreName( p_vout->p_sys->p_display, p_win->base_window,
971 #ifdef MODULE_NAME_IS_x11
972                         VOUT_TITLE " (X11 output)"
973 #else
974                         VOUT_TITLE " (XVideo output)"
975 #endif
976                       );
977         }
978     }
979     else
980     {
981         Window dummy1;
982         unsigned int dummy2, dummy3;
983
984         /* Select events we are interested in. */
985         XSelectInput( p_vout->p_sys->p_display, p_win->owner_window,
986                       StructureNotifyMask );
987
988         /* Get the parent window's geometry information */
989         XGetGeometry( p_vout->p_sys->p_display, p_win->owner_window,
990                       &dummy1, &dummy2, &dummy3,
991                       &p_win->i_width,
992                       &p_win->i_height,
993                       &dummy2, &dummy3 );
994
995         /* We are already configured */
996         b_configure_notify = VLC_TRUE;
997
998         /* From man XSelectInput: only one client at a time can select a
999          * ButtonPress event, so we need to open a new window anyway. */
1000         p_win->base_window =
1001             XCreateWindow( p_vout->p_sys->p_display,
1002                            p_win->owner_window,
1003                            0, 0,
1004                            p_win->i_width, p_win->i_height,
1005                            0,
1006                            0, CopyFromParent, 0,
1007                            CWBackingStore | CWBackPixel | CWEventMask,
1008                            &xwindow_attributes );
1009     }
1010
1011     if( (p_win->wm_protocols == None)        /* use WM_DELETE_WINDOW */
1012         || (p_win->wm_delete_window == None)
1013         || !XSetWMProtocols( p_vout->p_sys->p_display, p_win->base_window,
1014                              &p_win->wm_delete_window, 1 ) )
1015     {
1016         /* WM_DELETE_WINDOW is not supported by window manager */
1017         msg_Warn( p_vout, "missing or bad window manager" );
1018     }
1019
1020     /* Creation of a graphic context that doesn't generate a GraphicsExpose
1021      * event when using functions like XCopyArea */
1022     xgcvalues.graphics_exposures = False;
1023     p_win->gc = XCreateGC( p_vout->p_sys->p_display,
1024                            p_win->base_window,
1025                            GCGraphicsExposures, &xgcvalues );
1026
1027     /* Send orders to server, and wait until window is displayed - three
1028      * events must be received: a MapNotify event, an Expose event allowing
1029      * drawing in the window, and a ConfigureNotify to get the window
1030      * dimensions. Once those events have been received, only
1031      * ConfigureNotify events need to be received. */
1032     XMapWindow( p_vout->p_sys->p_display, p_win->base_window );
1033     do
1034     {
1035         XNextEvent( p_vout->p_sys->p_display, &xevent);
1036         if( (xevent.type == Expose)
1037             && (xevent.xexpose.window == p_win->base_window) )
1038         {
1039             b_expose = VLC_TRUE;
1040         }
1041         else if( (xevent.type == MapNotify)
1042                  && (xevent.xmap.window == p_win->base_window) )
1043         {
1044             b_map_notify = VLC_TRUE;
1045         }
1046         else if( (xevent.type == ConfigureNotify)
1047                  && (xevent.xconfigure.window == p_win->base_window) )
1048         {
1049             b_configure_notify = VLC_TRUE;
1050             p_win->i_width = xevent.xconfigure.width;
1051             p_win->i_height = xevent.xconfigure.height;
1052         }
1053     } while( !( b_expose && b_configure_notify && b_map_notify ) );
1054
1055     XSelectInput( p_vout->p_sys->p_display, p_win->base_window,
1056                   StructureNotifyMask | KeyPressMask |
1057                   ButtonPressMask | ButtonReleaseMask |
1058                   PointerMotionMask );
1059
1060 #ifdef MODULE_NAME_IS_x11
1061     if( XDefaultDepth(p_vout->p_sys->p_display, p_vout->p_sys->i_screen) == 8 )
1062     {
1063         /* Allocate a new palette */
1064         p_vout->p_sys->colormap =
1065             XCreateColormap( p_vout->p_sys->p_display,
1066                              DefaultRootWindow( p_vout->p_sys->p_display ),
1067                              DefaultVisual( p_vout->p_sys->p_display,
1068                                             p_vout->p_sys->i_screen ),
1069                              AllocAll );
1070
1071         xwindow_attributes.colormap = p_vout->p_sys->colormap;
1072         XChangeWindowAttributes( p_vout->p_sys->p_display, p_win->base_window,
1073                                  CWColormap, &xwindow_attributes );
1074     }
1075 #endif
1076
1077     /* Create video output sub-window. */
1078     p_win->video_window =  XCreateSimpleWindow(
1079                                       p_vout->p_sys->p_display,
1080                                       p_win->base_window, 0, 0,
1081                                       p_win->i_width, p_win->i_height,
1082                                       0,
1083                                       BlackPixel( p_vout->p_sys->p_display,
1084                                                   p_vout->p_sys->i_screen ),
1085                                       WhitePixel( p_vout->p_sys->p_display,
1086                                                   p_vout->p_sys->i_screen ) );
1087
1088     XSetWindowBackground( p_vout->p_sys->p_display, p_win->video_window,
1089                           BlackPixel( p_vout->p_sys->p_display,
1090                                       p_vout->p_sys->i_screen ) );
1091
1092     XMapWindow( p_vout->p_sys->p_display, p_win->video_window );
1093     XSelectInput( p_vout->p_sys->p_display, p_win->video_window,
1094                   ExposureMask );
1095
1096     /* make sure the video window will be centered in the next ManageVideo() */
1097     p_vout->i_changes |= VOUT_SIZE_CHANGE;
1098
1099     /* If the cursor was formerly blank than blank it again */
1100     if( !p_vout->p_sys->b_mouse_pointer_visible )
1101     {
1102         ToggleCursor( p_vout );
1103         ToggleCursor( p_vout );
1104     }
1105
1106     /* Do NOT use XFlush here ! */
1107     XSync( p_vout->p_sys->p_display, False );
1108
1109     /* At this stage, the window is open, displayed, and ready to
1110      * receive data */
1111     p_vout->p_sys->p_win = p_win;
1112
1113     return VLC_SUCCESS;
1114 }
1115
1116 /*****************************************************************************
1117  * DestroyWindow: destroy the window
1118  *****************************************************************************
1119  *
1120  *****************************************************************************/
1121 static void DestroyWindow( vout_thread_t *p_vout, x11_window_t *p_win )
1122 {
1123     /* Do NOT use XFlush here ! */
1124     XSync( p_vout->p_sys->p_display, False );
1125
1126     XDestroyWindow( p_vout->p_sys->p_display, p_win->video_window );
1127     XFreeGC( p_vout->p_sys->p_display, p_win->gc );
1128
1129     XUnmapWindow( p_vout->p_sys->p_display, p_win->base_window );
1130     XDestroyWindow( p_vout->p_sys->p_display, p_win->base_window );
1131
1132     if( p_win->owner_window )
1133         vout_ReleaseWindow( p_vout, (void *)p_win->owner_window );
1134 }
1135
1136 /*****************************************************************************
1137  * NewPicture: allocate a picture
1138  *****************************************************************************
1139  * Returns 0 on success, -1 otherwise
1140  *****************************************************************************/
1141 static int NewPicture( vout_thread_t *p_vout, picture_t *p_pic )
1142 {
1143 #ifdef MODULE_NAME_IS_xvideo
1144     int i_plane;
1145 #endif
1146
1147     /* We know the chroma, allocate a buffer which will be used
1148      * directly by the decoder */
1149     p_pic->p_sys = malloc( sizeof( picture_sys_t ) );
1150
1151     if( p_pic->p_sys == NULL )
1152     {
1153         return -1;
1154     }
1155
1156     /* Fill in picture_t fields */
1157     vout_InitPicture( VLC_OBJECT(p_vout), p_pic, p_vout->output.i_chroma,
1158                       p_vout->output.i_width, p_vout->output.i_height,
1159                       p_vout->output.i_aspect );
1160
1161 #ifdef HAVE_SYS_SHM_H
1162     if( p_vout->p_sys->b_shm )
1163     {
1164         /* Create image using XShm extension */
1165         p_pic->p_sys->p_image =
1166             CreateShmImage( p_vout, p_vout->p_sys->p_display,
1167 #   ifdef MODULE_NAME_IS_xvideo
1168                             p_vout->p_sys->i_xvport, 
1169                             VLC2X11_FOURCC(p_vout->output.i_chroma),
1170 #   else
1171                             p_vout->p_sys->p_visual,
1172                             p_vout->p_sys->i_screen_depth,
1173 #   endif
1174                             &p_pic->p_sys->shminfo,
1175                             p_vout->output.i_width, p_vout->output.i_height );
1176     }
1177     else
1178 #endif /* HAVE_SYS_SHM_H */
1179     {
1180         /* Create image without XShm extension */
1181         p_pic->p_sys->p_image =
1182             CreateImage( p_vout, p_vout->p_sys->p_display,
1183 #ifdef MODULE_NAME_IS_xvideo
1184                          p_vout->p_sys->i_xvport, 
1185                          VLC2X11_FOURCC(p_vout->output.i_chroma),
1186                          p_pic->format.i_bits_per_pixel,
1187 #else
1188                          p_vout->p_sys->p_visual,
1189                          p_vout->p_sys->i_screen_depth,
1190                          p_vout->p_sys->i_bytes_per_pixel,
1191 #endif
1192                          p_vout->output.i_width, p_vout->output.i_height );
1193     }
1194
1195     if( p_pic->p_sys->p_image == NULL )
1196     {
1197         free( p_pic->p_sys );
1198         return -1;
1199     }
1200
1201     switch( p_vout->output.i_chroma )
1202     {
1203 #ifdef MODULE_NAME_IS_xvideo
1204         case VLC_FOURCC('I','4','2','0'):
1205         case VLC_FOURCC('Y','V','1','2'):
1206         case VLC_FOURCC('Y','2','1','1'):
1207         case VLC_FOURCC('Y','U','Y','2'):
1208         case VLC_FOURCC('U','Y','V','Y'):
1209         case VLC_FOURCC('R','V','1','5'):
1210         case VLC_FOURCC('R','V','1','6'):
1211         case VLC_FOURCC('R','V','2','4'): /* Fixme: pixel pitch == 4 ? */
1212         case VLC_FOURCC('R','V','3','2'):
1213
1214             for( i_plane = 0; i_plane < p_pic->p_sys->p_image->num_planes;
1215                  i_plane++ )
1216             {
1217                 p_pic->p[i_plane].p_pixels = p_pic->p_sys->p_image->data
1218                     + p_pic->p_sys->p_image->offsets[i_plane];
1219                 p_pic->p[i_plane].i_pitch =
1220                     p_pic->p_sys->p_image->pitches[i_plane];
1221             }
1222             if( p_vout->output.i_chroma == VLC_FOURCC('Y','V','1','2') )
1223             {
1224                 /* U and V inverted compared to I420
1225                  * Fixme: this should be handled by the vout core */
1226                 p_pic->U_PIXELS = p_pic->p_sys->p_image->data
1227                     + p_pic->p_sys->p_image->offsets[2];
1228                 p_pic->V_PIXELS = p_pic->p_sys->p_image->data
1229                     + p_pic->p_sys->p_image->offsets[1];
1230             }
1231             break;
1232
1233 #else
1234         case VLC_FOURCC('R','G','B','2'):
1235         case VLC_FOURCC('R','V','1','6'):
1236         case VLC_FOURCC('R','V','1','5'):
1237         case VLC_FOURCC('R','V','2','4'):
1238         case VLC_FOURCC('R','V','3','2'):
1239
1240             p_pic->p->i_lines = p_pic->p_sys->p_image->height;
1241             p_pic->p->p_pixels = p_pic->p_sys->p_image->data
1242                                   + p_pic->p_sys->p_image->xoffset;
1243             p_pic->p->i_pitch = p_pic->p_sys->p_image->bytes_per_line;
1244
1245             /* p_pic->p->i_pixel_pitch = 4 for RV24 but this should be set
1246              * properly by vout_InitPicture() */
1247             p_pic->p->i_visible_pitch = p_pic->p->i_pixel_pitch
1248                                          * p_pic->p_sys->p_image->width;
1249             break;
1250 #endif
1251
1252         default:
1253             /* Unknown chroma, tell the guy to get lost */
1254             IMAGE_FREE( p_pic->p_sys->p_image );
1255             free( p_pic->p_sys );
1256             msg_Err( p_vout, "never heard of chroma 0x%.8x (%4.4s)",
1257                      p_vout->output.i_chroma, (char*)&p_vout->output.i_chroma );
1258             p_pic->i_planes = 0;
1259             return -1;
1260     }
1261
1262     return 0;
1263 }
1264
1265 /*****************************************************************************
1266  * FreePicture: destroy a picture allocated with NewPicture
1267  *****************************************************************************
1268  * Destroy XImage AND associated data. If using Shm, detach shared memory
1269  * segment from server and process, then free it. The XDestroyImage manpage
1270  * says that both the image structure _and_ the data pointed to by the
1271  * image structure are freed, so no need to free p_image->data.
1272  *****************************************************************************/
1273 static void FreePicture( vout_thread_t *p_vout, picture_t *p_pic )
1274 {
1275     /* The order of operations is correct */
1276 #ifdef HAVE_SYS_SHM_H
1277     if( p_vout->p_sys->b_shm )
1278     {
1279         XShmDetach( p_vout->p_sys->p_display, &p_pic->p_sys->shminfo );
1280         IMAGE_FREE( p_pic->p_sys->p_image );
1281
1282         shmctl( p_pic->p_sys->shminfo.shmid, IPC_RMID, 0 );
1283         if( shmdt( p_pic->p_sys->shminfo.shmaddr ) )
1284         {
1285             msg_Err( p_vout, "cannot detach shared memory (%s)",
1286                              strerror(errno) );
1287         }
1288     }
1289     else
1290 #endif
1291     {
1292         IMAGE_FREE( p_pic->p_sys->p_image );
1293     }
1294
1295     /* Do NOT use XFlush here ! */
1296     XSync( p_vout->p_sys->p_display, False );
1297
1298     free( p_pic->p_sys );
1299 }
1300
1301 /*****************************************************************************
1302  * ToggleFullScreen: Enable or disable full screen mode
1303  *****************************************************************************
1304  * This function will switch between fullscreen and window mode.
1305  *****************************************************************************/
1306 static void ToggleFullScreen ( vout_thread_t *p_vout )
1307 {
1308     Atom prop;
1309     XEvent xevent;
1310     mwmhints_t mwmhints;
1311     XSetWindowAttributes attributes;
1312
1313 #ifdef HAVE_XINERAMA
1314     int i_d1, i_d2;
1315 #endif
1316
1317     p_vout->b_fullscreen = !p_vout->b_fullscreen;
1318
1319     if( p_vout->b_fullscreen )
1320     {
1321         msg_Dbg( p_vout, "entering fullscreen mode" );
1322
1323         p_vout->p_sys->b_altfullscreen =
1324             config_GetInt( p_vout, MODULE_STRING "-altfullscreen" );
1325
1326         XUnmapWindow( p_vout->p_sys->p_display,
1327                       p_vout->p_sys->p_win->base_window);
1328
1329         p_vout->p_sys->p_win = &p_vout->p_sys->fullscreen_window;
1330
1331         CreateWindow( p_vout, p_vout->p_sys->p_win );
1332
1333         /* To my knowledge there are two ways to create a borderless window.
1334          * There's the generic way which is to tell x to bypass the window
1335          * manager, but this creates problems with the focus of other
1336          * applications.
1337          * The other way is to use the motif property "_MOTIF_WM_HINTS" which
1338          * luckily seems to be supported by most window managers. */
1339         if( !p_vout->p_sys->b_altfullscreen )
1340         {
1341             mwmhints.flags = MWM_HINTS_DECORATIONS;
1342             mwmhints.decorations = False;
1343
1344             prop = XInternAtom( p_vout->p_sys->p_display, "_MOTIF_WM_HINTS",
1345                                 False );
1346             XChangeProperty( p_vout->p_sys->p_display,
1347                              p_vout->p_sys->p_win->base_window,
1348                              prop, prop, 32, PropModeReplace,
1349                              (unsigned char *)&mwmhints,
1350                              PROP_MWM_HINTS_ELEMENTS );
1351         }
1352         else
1353         {
1354             /* brute force way to remove decorations */
1355             attributes.override_redirect = True;
1356             XChangeWindowAttributes( p_vout->p_sys->p_display,
1357                                      p_vout->p_sys->p_win->base_window,
1358                                      CWOverrideRedirect,
1359                                      &attributes);
1360
1361             /* Make sure the change is effective */
1362             XReparentWindow( p_vout->p_sys->p_display,
1363                              p_vout->p_sys->p_win->base_window,
1364                              DefaultRootWindow( p_vout->p_sys->p_display ),
1365                              0, 0 );
1366         }
1367
1368         if( p_vout->p_sys->b_net_wm_state_fullscreen )
1369         {
1370             XClientMessageEvent event;
1371
1372             memset( &event, 0, sizeof( XClientMessageEvent ) );
1373
1374             event.type = ClientMessage;
1375             event.message_type = p_vout->p_sys->net_wm_state;
1376             event.display = p_vout->p_sys->p_display;
1377             event.window = p_vout->p_sys->p_win->base_window;
1378             event.format = 32;
1379             event.data.l[ 0 ] = 1; /* set property */
1380             event.data.l[ 1 ] = p_vout->p_sys->net_wm_state_fullscreen;
1381
1382             XSendEvent( p_vout->p_sys->p_display,
1383                         DefaultRootWindow( p_vout->p_sys->p_display ),
1384                         False, SubstructureRedirectMask,
1385                         (XEvent*)&event );
1386         }
1387
1388         /* Make sure the change is effective */
1389         XReparentWindow( p_vout->p_sys->p_display,
1390                          p_vout->p_sys->p_win->base_window,
1391                          DefaultRootWindow( p_vout->p_sys->p_display ),
1392                          0, 0 );
1393
1394 #ifdef HAVE_XINERAMA
1395         if( XineramaQueryExtension( p_vout->p_sys->p_display, &i_d1, &i_d2 ) &&
1396             XineramaIsActive( p_vout->p_sys->p_display ) )
1397         {
1398             XineramaScreenInfo *screens;   /* infos for xinerama */
1399             int i_num_screens;
1400
1401             msg_Dbg( p_vout, "using XFree Xinerama extension");
1402
1403 #define SCREEN p_vout->p_sys->p_win->i_screen
1404
1405             /* Get Information about Xinerama (num of screens) */
1406             screens = XineramaQueryScreens( p_vout->p_sys->p_display,
1407                                             &i_num_screens );
1408
1409             if( !SCREEN )
1410                 SCREEN = config_GetInt( p_vout,
1411                                         MODULE_STRING "-xineramascreen" );
1412
1413             /* just check that user has entered a good value */
1414             if( SCREEN >= i_num_screens || SCREEN < 0 )
1415             {
1416                 msg_Dbg( p_vout, "requested screen number invalid" );
1417                 SCREEN = 0;
1418             }
1419
1420             /* Get the X/Y upper left corner coordinate of the above screen */
1421             p_vout->p_sys->p_win->i_x = screens[SCREEN].x_org;
1422             p_vout->p_sys->p_win->i_y = screens[SCREEN].y_org;
1423
1424             /* Set the Height/width to the screen resolution */
1425             p_vout->p_sys->p_win->i_width = screens[SCREEN].width;
1426             p_vout->p_sys->p_win->i_height = screens[SCREEN].height;
1427
1428             XFree(screens);
1429
1430 #undef SCREEN
1431
1432         }
1433 #endif
1434
1435         XMoveResizeWindow( p_vout->p_sys->p_display,
1436                            p_vout->p_sys->p_win->base_window,
1437                            p_vout->p_sys->p_win->i_x,
1438                            p_vout->p_sys->p_win->i_y,
1439                            p_vout->p_sys->p_win->i_width,
1440                            p_vout->p_sys->p_win->i_height );
1441     }
1442     else
1443     {
1444         msg_Dbg( p_vout, "leaving fullscreen mode" );
1445         DestroyWindow( p_vout, &p_vout->p_sys->fullscreen_window );
1446         p_vout->p_sys->p_win = &p_vout->p_sys->original_window;
1447
1448         XMapWindow( p_vout->p_sys->p_display,
1449                     p_vout->p_sys->p_win->base_window);
1450     }
1451
1452     /* Unfortunately, using XSync() here is not enough to ensure the
1453      * window has already been mapped because the XMapWindow() request
1454      * has not necessarily been sent directly to our window (remember,
1455      * the call is first redirected to the window manager) */
1456     do
1457     {
1458         XWindowEvent( p_vout->p_sys->p_display,
1459                       p_vout->p_sys->p_win->base_window,
1460                       StructureNotifyMask, &xevent );
1461     } while( xevent.type != MapNotify );
1462
1463     /* Be careful, this can generate a BadMatch error if the window is not
1464      * already mapped by the server (see above) */
1465     XSetInputFocus(p_vout->p_sys->p_display,
1466                    p_vout->p_sys->p_win->base_window,
1467                    RevertToParent,
1468                    CurrentTime);
1469
1470     /* signal that the size needs to be updated */
1471     p_vout->i_changes |= VOUT_SIZE_CHANGE;
1472 }
1473
1474 /*****************************************************************************
1475  * EnableXScreenSaver: enable screen saver
1476  *****************************************************************************
1477  * This function enables the screen saver on a display after it has been
1478  * disabled by XDisableScreenSaver.
1479  * FIXME: what happens if multiple vlc sessions are running at the same
1480  *        time ???
1481  *****************************************************************************/
1482 static void EnableXScreenSaver( vout_thread_t *p_vout )
1483 {
1484 #ifdef DPMSINFO_IN_DPMS_H
1485     int dummy;
1486 #endif
1487
1488     if( p_vout->p_sys->i_ss_timeout )
1489     {
1490         XSetScreenSaver( p_vout->p_sys->p_display, p_vout->p_sys->i_ss_timeout,
1491                          p_vout->p_sys->i_ss_interval,
1492                          p_vout->p_sys->i_ss_blanking,
1493                          p_vout->p_sys->i_ss_exposure );
1494     }
1495
1496     /* Restore DPMS settings */
1497 #ifdef DPMSINFO_IN_DPMS_H
1498     if( DPMSQueryExtension( p_vout->p_sys->p_display, &dummy, &dummy ) )
1499     {
1500         if( p_vout->p_sys->b_ss_dpms )
1501         {
1502             DPMSEnable( p_vout->p_sys->p_display );
1503         }
1504     }
1505 #endif
1506 }
1507
1508 /*****************************************************************************
1509  * DisableXScreenSaver: disable screen saver
1510  *****************************************************************************
1511  * See XEnableXScreenSaver
1512  *****************************************************************************/
1513 static void DisableXScreenSaver( vout_thread_t *p_vout )
1514 {
1515 #ifdef DPMSINFO_IN_DPMS_H
1516     int dummy;
1517 #endif
1518
1519     /* Save screen saver information */
1520     XGetScreenSaver( p_vout->p_sys->p_display, &p_vout->p_sys->i_ss_timeout,
1521                      &p_vout->p_sys->i_ss_interval,
1522                      &p_vout->p_sys->i_ss_blanking,
1523                      &p_vout->p_sys->i_ss_exposure );
1524
1525     /* Disable screen saver */
1526     if( p_vout->p_sys->i_ss_timeout )
1527     {
1528         XSetScreenSaver( p_vout->p_sys->p_display, 0,
1529                          p_vout->p_sys->i_ss_interval,
1530                          p_vout->p_sys->i_ss_blanking,
1531                          p_vout->p_sys->i_ss_exposure );
1532     }
1533
1534     /* Disable DPMS */
1535 #ifdef DPMSINFO_IN_DPMS_H
1536     if( DPMSQueryExtension( p_vout->p_sys->p_display, &dummy, &dummy ) )
1537     {
1538         CARD16 unused;
1539         /* Save DPMS current state */
1540         DPMSInfo( p_vout->p_sys->p_display, &unused,
1541                   &p_vout->p_sys->b_ss_dpms );
1542         DPMSDisable( p_vout->p_sys->p_display );
1543    }
1544 #endif
1545 }
1546
1547 /*****************************************************************************
1548  * CreateCursor: create a blank mouse pointer
1549  *****************************************************************************/
1550 static void CreateCursor( vout_thread_t *p_vout )
1551 {
1552     XColor cursor_color;
1553
1554     p_vout->p_sys->cursor_pixmap =
1555         XCreatePixmap( p_vout->p_sys->p_display,
1556                        DefaultRootWindow( p_vout->p_sys->p_display ),
1557                        1, 1, 1 );
1558
1559     XParseColor( p_vout->p_sys->p_display,
1560                  XCreateColormap( p_vout->p_sys->p_display,
1561                                   DefaultRootWindow(
1562                                                     p_vout->p_sys->p_display ),
1563                                   DefaultVisual(
1564                                                 p_vout->p_sys->p_display,
1565                                                 p_vout->p_sys->i_screen ),
1566                                   AllocNone ),
1567                  "black", &cursor_color );
1568
1569     p_vout->p_sys->blank_cursor =
1570         XCreatePixmapCursor( p_vout->p_sys->p_display,
1571                              p_vout->p_sys->cursor_pixmap,
1572                              p_vout->p_sys->cursor_pixmap,
1573                              &cursor_color, &cursor_color, 1, 1 );
1574 }
1575
1576 /*****************************************************************************
1577  * DestroyCursor: destroy the blank mouse pointer
1578  *****************************************************************************/
1579 static void DestroyCursor( vout_thread_t *p_vout )
1580 {
1581     XFreePixmap( p_vout->p_sys->p_display, p_vout->p_sys->cursor_pixmap );
1582 }
1583
1584 /*****************************************************************************
1585  * ToggleCursor: hide or show the mouse pointer
1586  *****************************************************************************
1587  * This function hides the X pointer if it is visible by setting the pointer
1588  * sprite to a blank one. To show it again, we disable the sprite.
1589  *****************************************************************************/
1590 static void ToggleCursor( vout_thread_t *p_vout )
1591 {
1592     if( p_vout->p_sys->b_mouse_pointer_visible )
1593     {
1594         XDefineCursor( p_vout->p_sys->p_display,
1595                        p_vout->p_sys->p_win->base_window,
1596                        p_vout->p_sys->blank_cursor );
1597         p_vout->p_sys->b_mouse_pointer_visible = 0;
1598     }
1599     else
1600     {
1601         XUndefineCursor( p_vout->p_sys->p_display,
1602                          p_vout->p_sys->p_win->base_window );
1603         p_vout->p_sys->b_mouse_pointer_visible = 1;
1604     }
1605 }
1606
1607 #ifdef MODULE_NAME_IS_xvideo
1608 /*****************************************************************************
1609  * XVideoGetPort: get YUV12 port
1610  *****************************************************************************/
1611 static int XVideoGetPort( vout_thread_t *p_vout,
1612                           vlc_fourcc_t i_chroma, vlc_fourcc_t *pi_newchroma )
1613 {
1614     XvAdaptorInfo *p_adaptor;
1615     unsigned int i;
1616     int i_adaptor, i_num_adaptors, i_requested_adaptor;
1617     int i_selected_port;
1618
1619     switch( XvQueryExtension( p_vout->p_sys->p_display, &i, &i, &i, &i, &i ) )
1620     {
1621         case Success:
1622             break;
1623
1624         case XvBadExtension:
1625             msg_Warn( p_vout, "XvBadExtension" );
1626             return -1;
1627
1628         case XvBadAlloc:
1629             msg_Warn( p_vout, "XvBadAlloc" );
1630             return -1;
1631
1632         default:
1633             msg_Warn( p_vout, "XvQueryExtension failed" );
1634             return -1;
1635     }
1636
1637     switch( XvQueryAdaptors( p_vout->p_sys->p_display,
1638                              DefaultRootWindow( p_vout->p_sys->p_display ),
1639                              &i_num_adaptors, &p_adaptor ) )
1640     {
1641         case Success:
1642             break;
1643
1644         case XvBadExtension:
1645             msg_Warn( p_vout, "XvBadExtension for XvQueryAdaptors" );
1646             return -1;
1647
1648         case XvBadAlloc:
1649             msg_Warn( p_vout, "XvBadAlloc for XvQueryAdaptors" );
1650             return -1;
1651
1652         default:
1653             msg_Warn( p_vout, "XvQueryAdaptors failed" );
1654             return -1;
1655     }
1656
1657     i_selected_port = -1;
1658     i_requested_adaptor = config_GetInt( p_vout, "xvideo-adaptor" );
1659
1660     for( i_adaptor = 0; i_adaptor < i_num_adaptors; ++i_adaptor )
1661     {
1662         XvImageFormatValues *p_formats;
1663         int i_format, i_num_formats;
1664         int i_port;
1665
1666         /* If we requested an adaptor and it's not this one, we aren't
1667          * interested */
1668         if( i_requested_adaptor != -1 && i_adaptor != i_requested_adaptor )
1669         {
1670             continue;
1671         }
1672
1673         /* If the adaptor doesn't have the required properties, skip it */
1674         if( !( p_adaptor[ i_adaptor ].type & XvInputMask ) ||
1675             !( p_adaptor[ i_adaptor ].type & XvImageMask ) )
1676         {
1677             continue;
1678         }
1679
1680         /* Check that adaptor supports our requested format... */
1681         p_formats = XvListImageFormats( p_vout->p_sys->p_display,
1682                                         p_adaptor[i_adaptor].base_id,
1683                                         &i_num_formats );
1684
1685         for( i_format = 0;
1686              i_format < i_num_formats && ( i_selected_port == -1 );
1687              i_format++ )
1688         {
1689             XvAttribute     *p_attr;
1690             int             i_attr, i_num_attributes;
1691
1692             /* If this is not the format we want, or at least a
1693              * similar one, forget it */
1694             if( !vout_ChromaCmp( p_formats[ i_format ].id, i_chroma ) )
1695             {
1696                 continue;
1697             }
1698
1699             /* Look for the first available port supporting this format */
1700             for( i_port = p_adaptor[i_adaptor].base_id;
1701                  ( i_port < (int)(p_adaptor[i_adaptor].base_id
1702                                    + p_adaptor[i_adaptor].num_ports) )
1703                    && ( i_selected_port == -1 );
1704                  i_port++ )
1705             {
1706                 if( XvGrabPort( p_vout->p_sys->p_display, i_port, CurrentTime )
1707                      == Success )
1708                 {
1709                     i_selected_port = i_port;
1710                     *pi_newchroma = p_formats[ i_format ].id;
1711                 }
1712             }
1713
1714             /* If no free port was found, forget it */
1715             if( i_selected_port == -1 )
1716             {
1717                 continue;
1718             }
1719
1720             /* If we found a port, print information about it */
1721             msg_Dbg( p_vout, "adaptor %i, port %i, format 0x%x (%4.4s) %s",
1722                      i_adaptor, i_selected_port, p_formats[ i_format ].id,
1723                      (char *)&p_formats[ i_format ].id,
1724                      ( p_formats[ i_format ].format == XvPacked ) ?
1725                          "packed" : "planar" );
1726
1727             /* Make sure XV_AUTOPAINT_COLORKEY is set */
1728             p_attr = XvQueryPortAttributes( p_vout->p_sys->p_display,
1729                                             i_selected_port,
1730                                             &i_num_attributes );
1731
1732             for( i_attr = 0; i_attr < i_num_attributes; i_attr++ )
1733             {
1734                 if( !strcmp( p_attr[i_attr].name, "XV_AUTOPAINT_COLORKEY" ) )
1735                 {
1736                     const Atom autopaint =
1737                         XInternAtom( p_vout->p_sys->p_display,
1738                                      "XV_AUTOPAINT_COLORKEY", False );
1739                     XvSetPortAttribute( p_vout->p_sys->p_display,
1740                                         i_selected_port, autopaint, 1 );
1741                     break;
1742                 }
1743             }
1744
1745             if( p_attr != NULL )
1746             {
1747                 XFree( p_attr );
1748             }
1749         }
1750
1751         if( p_formats != NULL )
1752         {
1753             XFree( p_formats );
1754         }
1755
1756     }
1757
1758     if( i_num_adaptors > 0 )
1759     {
1760         XvFreeAdaptorInfo( p_adaptor );
1761     }
1762
1763     if( i_selected_port == -1 )
1764     {
1765         int i_chroma_tmp = X112VLC_FOURCC( i_chroma );
1766         if( i_requested_adaptor == -1 )
1767         {
1768             msg_Warn( p_vout, "no free XVideo port found for format "
1769                       "0x%.8x (%4.4s)", i_chroma_tmp, (char*)&i_chroma_tmp );
1770         }
1771         else
1772         {
1773             msg_Warn( p_vout, "XVideo adaptor %i does not have a free "
1774                       "XVideo port for format 0x%.8x (%4.4s)",
1775                       i_requested_adaptor, i_chroma_tmp, (char*)&i_chroma_tmp );
1776         }
1777     }
1778
1779     return i_selected_port;
1780 }
1781
1782 /*****************************************************************************
1783  * XVideoReleasePort: release YUV12 port
1784  *****************************************************************************/
1785 static void XVideoReleasePort( vout_thread_t *p_vout, int i_port )
1786 {
1787     XvUngrabPort( p_vout->p_sys->p_display, i_port, CurrentTime );
1788 }
1789 #endif
1790
1791 /*****************************************************************************
1792  * InitDisplay: open and initialize X11 device
1793  *****************************************************************************
1794  * Create a window according to video output given size, and set other
1795  * properties according to the display properties.
1796  *****************************************************************************/
1797 static int InitDisplay( vout_thread_t *p_vout )
1798 {
1799 #ifdef MODULE_NAME_IS_x11
1800     XPixmapFormatValues *       p_formats;                 /* pixmap formats */
1801     XVisualInfo *               p_xvisual;            /* visuals information */
1802     XVisualInfo                 xvisual_template;         /* visual template */
1803     int                         i_count;                       /* array size */
1804 #endif
1805
1806 #ifdef HAVE_SYS_SHM_H
1807     p_vout->p_sys->b_shm = 0;
1808
1809     if( config_GetInt( p_vout, MODULE_STRING "-shm" ) )
1810     {
1811 #   ifdef SYS_DARWIN
1812         /* FIXME: As of 2001-03-16, XFree4 for MacOS X does not support Xshm */
1813 #   else
1814         p_vout->p_sys->b_shm =
1815                   ( XShmQueryExtension( p_vout->p_sys->p_display ) == True );
1816 #   endif
1817
1818         if( !p_vout->p_sys->b_shm )
1819         {
1820             msg_Warn( p_vout, "XShm video extension is unavailable" );
1821         }
1822     }
1823     else
1824     {
1825         msg_Dbg( p_vout, "disabling XShm video extension" );
1826     }
1827
1828 #else
1829     msg_Warn( p_vout, "XShm video extension is unavailable" );
1830
1831 #endif
1832
1833 #ifdef MODULE_NAME_IS_xvideo
1834     /* XXX The brightness and contrast values should be read from environment
1835      * XXX variables... */
1836 #if 0
1837     XVideoSetAttribute( p_vout, "XV_BRIGHTNESS", 0.5 );
1838     XVideoSetAttribute( p_vout, "XV_CONTRAST",   0.5 );
1839 #endif
1840 #endif
1841
1842 #ifdef MODULE_NAME_IS_x11
1843     /* Initialize structure */
1844     p_vout->p_sys->i_screen = DefaultScreen( p_vout->p_sys->p_display );
1845
1846     /* Get screen depth */
1847     p_vout->p_sys->i_screen_depth = XDefaultDepth( p_vout->p_sys->p_display,
1848                                                    p_vout->p_sys->i_screen );
1849     switch( p_vout->p_sys->i_screen_depth )
1850     {
1851     case 8:
1852         /*
1853          * Screen depth is 8bpp. Use PseudoColor visual with private colormap.
1854          */
1855         xvisual_template.screen =   p_vout->p_sys->i_screen;
1856         xvisual_template.class =    DirectColor;
1857         p_xvisual = XGetVisualInfo( p_vout->p_sys->p_display,
1858                                     VisualScreenMask | VisualClassMask,
1859                                     &xvisual_template, &i_count );
1860         if( p_xvisual == NULL )
1861         {
1862             msg_Err( p_vout, "no PseudoColor visual available" );
1863             return VLC_EGENERIC;
1864         }
1865         p_vout->p_sys->i_bytes_per_pixel = 1;
1866         p_vout->output.pf_setpalette = SetPalette;
1867         break;
1868     case 15:
1869     case 16:
1870     case 24:
1871     default:
1872         /*
1873          * Screen depth is higher than 8bpp. TrueColor visual is used.
1874          */
1875         xvisual_template.screen =   p_vout->p_sys->i_screen;
1876         xvisual_template.class =    TrueColor;
1877         p_xvisual = XGetVisualInfo( p_vout->p_sys->p_display,
1878                                     VisualScreenMask | VisualClassMask,
1879                                     &xvisual_template, &i_count );
1880         if( p_xvisual == NULL )
1881         {
1882             msg_Err( p_vout, "no TrueColor visual available" );
1883             return VLC_EGENERIC;
1884         }
1885
1886         p_vout->output.i_rmask = p_xvisual->red_mask;
1887         p_vout->output.i_gmask = p_xvisual->green_mask;
1888         p_vout->output.i_bmask = p_xvisual->blue_mask;
1889
1890         /* There is no difference yet between 3 and 4 Bpp. The only way
1891          * to find the actual number of bytes per pixel is to list supported
1892          * pixmap formats. */
1893         p_formats = XListPixmapFormats( p_vout->p_sys->p_display, &i_count );
1894         p_vout->p_sys->i_bytes_per_pixel = 0;
1895
1896         for( ; i_count-- ; p_formats++ )
1897         {
1898             /* Under XFree4.0, the list contains pixmap formats available
1899              * through all video depths ; so we have to check against current
1900              * depth. */
1901             if( p_formats->depth == (int)p_vout->p_sys->i_screen_depth )
1902             {
1903                 if( p_formats->bits_per_pixel / 8
1904                         > (int)p_vout->p_sys->i_bytes_per_pixel )
1905                 {
1906                     p_vout->p_sys->i_bytes_per_pixel =
1907                                                p_formats->bits_per_pixel / 8;
1908                 }
1909             }
1910         }
1911         break;
1912     }
1913     p_vout->p_sys->p_visual = p_xvisual->visual;
1914     XFree( p_xvisual );
1915 #endif
1916
1917     return VLC_SUCCESS;
1918 }
1919
1920 #ifdef HAVE_SYS_SHM_H
1921 /*****************************************************************************
1922  * CreateShmImage: create an XImage or XvImage using shared memory extension
1923  *****************************************************************************
1924  * Prepare an XImage or XvImage for display function.
1925  * The order of the operations respects the recommandations of the mit-shm
1926  * document by J.Corbet and K.Packard. Most of the parameters were copied from
1927  * there. See http://ftp.xfree86.org/pub/XFree86/4.0/doc/mit-shm.TXT
1928  *****************************************************************************/
1929 static IMAGE_TYPE * CreateShmImage( vout_thread_t *p_vout,
1930                                     Display* p_display, EXTRA_ARGS_SHM,
1931                                     int i_width, int i_height )
1932 {
1933     IMAGE_TYPE *p_image;
1934
1935     /* Create XImage / XvImage */
1936 #ifdef MODULE_NAME_IS_xvideo
1937     p_image = XvShmCreateImage( p_display, i_xvport, i_chroma, 0,
1938                                 i_width, i_height, p_shm );
1939 #else
1940     p_image = XShmCreateImage( p_display, p_visual, i_depth, ZPixmap, 0,
1941                                p_shm, i_width, i_height );
1942 #endif
1943     if( p_image == NULL )
1944     {
1945         msg_Err( p_vout, "image creation failed" );
1946         return NULL;
1947     }
1948
1949     /* Allocate shared memory segment - 0776 set the access permission
1950      * rights (like umask), they are not yet supported by all X servers */
1951     p_shm->shmid = shmget( IPC_PRIVATE, DATA_SIZE(p_image), IPC_CREAT | 0776 );
1952     if( p_shm->shmid < 0 )
1953     {
1954         msg_Err( p_vout, "cannot allocate shared image data (%s)",
1955                          strerror( errno ) );
1956         IMAGE_FREE( p_image );
1957         return NULL;
1958     }
1959
1960     /* Attach shared memory segment to process (read/write) */
1961     p_shm->shmaddr = p_image->data = shmat( p_shm->shmid, 0, 0 );
1962     if(! p_shm->shmaddr )
1963     {
1964         msg_Err( p_vout, "cannot attach shared memory (%s)",
1965                          strerror(errno));
1966         IMAGE_FREE( p_image );
1967         shmctl( p_shm->shmid, IPC_RMID, 0 );
1968         return NULL;
1969     }
1970
1971     /* Read-only data. We won't be using XShmGetImage */
1972     p_shm->readOnly = True;
1973
1974     /* Attach shared memory segment to X server */
1975     if( XShmAttach( p_display, p_shm ) == False )
1976     {
1977         msg_Err( p_vout, "cannot attach shared memory to X server" );
1978         IMAGE_FREE( p_image );
1979         shmctl( p_shm->shmid, IPC_RMID, 0 );
1980         shmdt( p_shm->shmaddr );
1981         return NULL;
1982     }
1983
1984     /* Send image to X server. This instruction is required, since having
1985      * built a Shm XImage and not using it causes an error on XCloseDisplay,
1986      * and remember NOT to use XFlush ! */
1987     XSync( p_display, False );
1988
1989 #if 0
1990     /* Mark the shm segment to be removed when there are no more
1991      * attachements, so it is automatic on process exit or after shmdt */
1992     shmctl( p_shm->shmid, IPC_RMID, 0 );
1993 #endif
1994
1995     return p_image;
1996 }
1997 #endif
1998
1999 /*****************************************************************************
2000  * CreateImage: create an XImage or XvImage
2001  *****************************************************************************
2002  * Create a simple image used as a buffer.
2003  *****************************************************************************/
2004 static IMAGE_TYPE * CreateImage( vout_thread_t *p_vout,
2005                                  Display *p_display, EXTRA_ARGS,
2006                                  int i_width, int i_height )
2007 {
2008     byte_t *    p_data;                           /* image data storage zone */
2009     IMAGE_TYPE *p_image;
2010 #ifdef MODULE_NAME_IS_x11
2011     int         i_quantum;                     /* XImage quantum (see below) */
2012     int         i_bytes_per_line;
2013 #endif
2014
2015     /* Allocate memory for image */
2016 #ifdef MODULE_NAME_IS_xvideo
2017     p_data = (byte_t *) malloc( i_width * i_height * i_bits_per_pixel / 8 );
2018 #else
2019     i_bytes_per_line = i_width * i_bytes_per_pixel;
2020     p_data = (byte_t *) malloc( i_bytes_per_line * i_height );
2021 #endif
2022     if( !p_data )
2023     {
2024         msg_Err( p_vout, "out of memory" );
2025         return NULL;
2026     }
2027
2028 #ifdef MODULE_NAME_IS_x11
2029     /* Optimize the quantum of a scanline regarding its size - the quantum is
2030        a diviser of the number of bits between the start of two scanlines. */
2031     if( i_bytes_per_line & 0xf )
2032     {
2033         i_quantum = 0x8;
2034     }
2035     else if( i_bytes_per_line & 0x10 )
2036     {
2037         i_quantum = 0x10;
2038     }
2039     else
2040     {
2041         i_quantum = 0x20;
2042     }
2043 #endif
2044
2045     /* Create XImage. p_data will be automatically freed */
2046 #ifdef MODULE_NAME_IS_xvideo
2047     p_image = XvCreateImage( p_display, i_xvport, i_chroma,
2048                              p_data, i_width, i_height );
2049 #else
2050     p_image = XCreateImage( p_display, p_visual, i_depth, ZPixmap, 0,
2051                             p_data, i_width, i_height, i_quantum, 0 );
2052 #endif
2053     if( p_image == NULL )
2054     {
2055         msg_Err( p_vout, "XCreateImage() failed" );
2056         free( p_data );
2057         return NULL;
2058     }
2059
2060     return p_image;
2061 }
2062
2063 #ifdef MODULE_NAME_IS_x11
2064 /*****************************************************************************
2065  * SetPalette: sets an 8 bpp palette
2066  *****************************************************************************
2067  * This function sets the palette given as an argument. It does not return
2068  * anything, but could later send information on which colors it was unable
2069  * to set.
2070  *****************************************************************************/
2071 static void SetPalette( vout_thread_t *p_vout,
2072                         uint16_t *red, uint16_t *green, uint16_t *blue )
2073 {
2074     int i;
2075     XColor p_colors[255];
2076
2077     /* allocate palette */
2078     for( i = 0; i < 255; i++ )
2079     {
2080         /* kludge: colors are indexed reversely because color 255 seems
2081          * to be reserved for black even if we try to set it to white */
2082         p_colors[ i ].pixel = 255 - i;
2083         p_colors[ i ].pad   = 0;
2084         p_colors[ i ].flags = DoRed | DoGreen | DoBlue;
2085         p_colors[ i ].red   = red[ 255 - i ];
2086         p_colors[ i ].blue  = blue[ 255 - i ];
2087         p_colors[ i ].green = green[ 255 - i ];
2088     }
2089
2090     XStoreColors( p_vout->p_sys->p_display,
2091                   p_vout->p_sys->colormap, p_colors, 255 );
2092 }
2093 #endif
2094
2095 /*****************************************************************************
2096  * Control: control facility for the vout
2097  *****************************************************************************/
2098 static int Control( vout_thread_t *p_vout, int i_query, va_list args )
2099 {
2100     double f_arg;
2101     vlc_bool_t b_arg;
2102
2103     switch( i_query )
2104     {
2105         case VOUT_SET_ZOOM:
2106             if( p_vout->p_sys->p_win->owner_window )
2107                 return vout_ControlWindow( p_vout,
2108                     (void *)p_vout->p_sys->p_win->owner_window, i_query, args);
2109
2110             f_arg = va_arg( args, double );
2111
2112             vlc_mutex_lock( &p_vout->p_sys->lock );
2113
2114             /* Update dimensions */
2115             /* FIXME: export InitWindowSize() from vout core */
2116             XResizeWindow( p_vout->p_sys->p_display,
2117                            p_vout->p_sys->p_win->base_window,
2118                            p_vout->i_window_width * f_arg,
2119                            p_vout->i_window_height * f_arg );
2120
2121             vlc_mutex_unlock( &p_vout->p_sys->lock );
2122             return VLC_SUCCESS;
2123
2124        case VOUT_CLOSE:
2125             vlc_mutex_lock( &p_vout->p_sys->lock );
2126             XUnmapWindow( p_vout->p_sys->p_display,
2127                           p_vout->p_sys->p_win->base_window );
2128             vlc_mutex_unlock( &p_vout->p_sys->lock );
2129             /* Fall through */
2130
2131        case VOUT_REPARENT:
2132             vlc_mutex_lock( &p_vout->p_sys->lock );
2133             XReparentWindow( p_vout->p_sys->p_display,
2134                              p_vout->p_sys->p_win->base_window,
2135                              DefaultRootWindow( p_vout->p_sys->p_display ),
2136                              0, 0 );
2137             XSync( p_vout->p_sys->p_display, False );
2138             p_vout->p_sys->p_win->owner_window = 0;
2139             vlc_mutex_unlock( &p_vout->p_sys->lock );
2140             return vout_vaControlDefault( p_vout, i_query, args );
2141
2142         case VOUT_SET_STAY_ON_TOP:
2143             if( p_vout->p_sys->p_win->owner_window )
2144                 return vout_ControlWindow( p_vout,
2145                     (void *)p_vout->p_sys->p_win->owner_window, i_query, args);
2146
2147             b_arg = va_arg( args, vlc_bool_t );
2148             vlc_mutex_lock( &p_vout->p_sys->lock );
2149             WindowOnTop( p_vout, b_arg );
2150             vlc_mutex_unlock( &p_vout->p_sys->lock );
2151             return VLC_SUCCESS;
2152
2153        default:
2154             return vout_vaControlDefault( p_vout, i_query, args );
2155     }
2156 }
2157
2158 /*****************************************************************************
2159  * TestNetWMSupport: tests for Extended Window Manager Hints support
2160  *****************************************************************************/
2161 static void TestNetWMSupport( vout_thread_t *p_vout )
2162 {
2163     int i_ret, i_format;
2164     unsigned long i, i_items, i_bytesafter;
2165     Atom net_wm_supported, *p_args = NULL;
2166
2167     p_vout->p_sys->b_net_wm_state_fullscreen = VLC_FALSE;
2168     p_vout->p_sys->b_net_wm_state_above = VLC_FALSE;
2169     p_vout->p_sys->b_net_wm_state_below = VLC_FALSE;
2170     p_vout->p_sys->b_net_wm_state_stays_on_top = VLC_FALSE;
2171
2172     net_wm_supported =
2173         XInternAtom( p_vout->p_sys->p_display, "_NET_SUPPORTED", False );
2174
2175     i_ret = XGetWindowProperty( p_vout->p_sys->p_display,
2176                                 DefaultRootWindow( p_vout->p_sys->p_display ),
2177                                 net_wm_supported,
2178                                 0, 16384, False, AnyPropertyType,
2179                                 &net_wm_supported,
2180                                 &i_format, &i_items, &i_bytesafter,
2181                                 (unsigned char **)(intptr_t)&p_args );
2182
2183     if( i_ret != Success || i_items == 0 ) return;
2184
2185     msg_Dbg( p_vout, "Window manager supports NetWM" );
2186
2187     p_vout->p_sys->net_wm_state =
2188         XInternAtom( p_vout->p_sys->p_display, "_NET_WM_STATE", False );
2189     p_vout->p_sys->net_wm_state_fullscreen =
2190         XInternAtom( p_vout->p_sys->p_display, "_NET_WM_STATE_FULLSCREEN",
2191                      False );
2192     p_vout->p_sys->net_wm_state_above =
2193         XInternAtom( p_vout->p_sys->p_display, "_NET_WM_STATE_ABOVE", False );
2194     p_vout->p_sys->net_wm_state_below =
2195         XInternAtom( p_vout->p_sys->p_display, "_NET_WM_STATE_BELOW", False );
2196     p_vout->p_sys->net_wm_state_stays_on_top =
2197         XInternAtom( p_vout->p_sys->p_display, "_NET_WM_STATE_STAYS_ON_TOP",
2198                      False );
2199
2200     for( i = 0; i < i_items; i++ )
2201     {
2202         if( p_args[i] == p_vout->p_sys->net_wm_state_fullscreen )
2203         {
2204             msg_Dbg( p_vout,
2205                      "Window manager supports _NET_WM_STATE_FULLSCREEN" );
2206             p_vout->p_sys->b_net_wm_state_fullscreen = VLC_TRUE;
2207         }
2208         else if( p_args[i] == p_vout->p_sys->net_wm_state_above )
2209         {
2210             msg_Dbg( p_vout, "Window manager supports _NET_WM_STATE_ABOVE" );
2211             p_vout->p_sys->b_net_wm_state_above = VLC_TRUE;
2212         }
2213         else if( p_args[i] == p_vout->p_sys->net_wm_state_below )
2214         {
2215             msg_Dbg( p_vout, "Window manager supports _NET_WM_STATE_BELOW" );
2216             p_vout->p_sys->b_net_wm_state_below = VLC_TRUE;
2217         }
2218         else if( p_args[i] == p_vout->p_sys->net_wm_state_stays_on_top )
2219         {
2220             msg_Dbg( p_vout,
2221                      "Window manager supports _NET_WM_STATE_STAYS_ON_TOP" );
2222             p_vout->p_sys->b_net_wm_state_stays_on_top = VLC_TRUE;
2223         }
2224     }
2225
2226     XFree( p_args );
2227 }
2228
2229 /*****************************************************************************
2230  * Key events handling
2231  *****************************************************************************/
2232 static struct
2233 {
2234     int i_x11key;
2235     int i_vlckey;
2236
2237 } x11keys_to_vlckeys[] =
2238 {
2239     { XK_F1, KEY_F1 }, { XK_F2, KEY_F2 }, { XK_F3, KEY_F3 }, { XK_F4, KEY_F4 },
2240     { XK_F5, KEY_F5 }, { XK_F6, KEY_F6 }, { XK_F7, KEY_F7 }, { XK_F8, KEY_F8 },
2241     { XK_F9, KEY_F9 }, { XK_F10, KEY_F10 }, { XK_F11, KEY_F11 },
2242     { XK_F12, KEY_F12 },
2243
2244     { XK_Return, KEY_ENTER },
2245     { XK_KP_Enter, KEY_ENTER },
2246     { XK_space, KEY_SPACE },
2247     { XK_Escape, KEY_ESC },
2248
2249     { XK_Menu, KEY_MENU },
2250     { XK_Left, KEY_LEFT },
2251     { XK_Right, KEY_RIGHT },
2252     { XK_Up, KEY_UP },
2253     { XK_Down, KEY_DOWN },
2254
2255     { XK_Home, KEY_HOME },
2256     { XK_End, KEY_END },
2257     { XK_Page_Up, KEY_PAGEUP },
2258     { XK_Page_Down, KEY_PAGEDOWN },
2259     { 0, 0 }
2260 };
2261
2262 static int ConvertKey( int i_key )
2263 {
2264     int i;
2265
2266     for( i = 0; x11keys_to_vlckeys[i].i_x11key != 0; i++ )
2267     {
2268         if( x11keys_to_vlckeys[i].i_x11key == i_key )
2269         {
2270             return x11keys_to_vlckeys[i].i_vlckey;
2271         }
2272     }
2273
2274     return 0;
2275 }
2276
2277 /*****************************************************************************
2278  * WindowOnTop: Switches the "always on top" state of the video window.
2279  *****************************************************************************/
2280 static int WindowOnTop( vout_thread_t *p_vout, vlc_bool_t b_on_top )
2281 {
2282     if( p_vout->p_sys->b_net_wm_state_stays_on_top )
2283     {
2284         XClientMessageEvent event;
2285
2286         memset( &event, 0, sizeof( XClientMessageEvent ) );
2287
2288         event.type = ClientMessage;
2289         event.message_type = p_vout->p_sys->net_wm_state;
2290         event.display = p_vout->p_sys->p_display;
2291         event.window = p_vout->p_sys->p_win->base_window;
2292         event.format = 32;
2293         event.data.l[ 0 ] = b_on_top; /* set property */
2294         event.data.l[ 1 ] = p_vout->p_sys->net_wm_state_stays_on_top;
2295
2296         XSendEvent( p_vout->p_sys->p_display,
2297                     DefaultRootWindow( p_vout->p_sys->p_display ),
2298                     False, SubstructureRedirectMask,
2299                     (XEvent*)&event );
2300     }
2301
2302     return VLC_SUCCESS;
2303 }