99e60dde2cbf945ba4e2d3edfab199f799eed28b
[vlc.git] / modules / video_output / x11 / xcommon.h
1 /*****************************************************************************
2  * xcommon.h: Defines common to the X11 and XVideo plugins
3  *****************************************************************************
4  * Copyright (C) 1998-2001 VideoLAN
5  * $Id: xcommon.h,v 1.2 2002/08/08 00:35:11 sam Exp $
6  *
7  * Authors: Vincent Seguin <seguin@via.ecp.fr>
8  *          Samuel 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  * Defines
29  *****************************************************************************/
30 #ifdef MODULE_NAME_IS_xvideo
31 #   define IMAGE_TYPE     XvImage
32 #   define EXTRA_ARGS     int i_xvport, int i_chroma
33 #   define EXTRA_ARGS_SHM int i_xvport, int i_chroma, XShmSegmentInfo *p_shm
34 #   define DATA_SIZE(p)   (p)->data_size
35 #   define IMAGE_FREE     XFree      /* There is nothing like XvDestroyImage */
36 #else
37 #   define IMAGE_TYPE     XImage
38 #   define EXTRA_ARGS     Visual *p_visual, int i_depth, int i_bytes_per_pixel
39 #   define EXTRA_ARGS_SHM Visual *p_visual, int i_depth, XShmSegmentInfo *p_shm
40 #   define DATA_SIZE(p)   ((p)->bytes_per_line * (p)->height)
41 #   define IMAGE_FREE     XDestroyImage
42 #endif
43
44 /*****************************************************************************
45  * x11_window_t: X11 window descriptor
46  *****************************************************************************
47  * This structure contains all the data necessary to describe an X11 window.
48  *****************************************************************************/
49 typedef struct x11_window_t
50 {
51     Window              base_window;                          /* base window */
52     Window              video_window;     /* sub-window for displaying video */
53     GC                  gc;              /* graphic context instance handler */
54     int                 i_width;                     /* width of main window */
55     int                 i_height;                   /* height of main window */
56     Atom                wm_protocols;
57     Atom                wm_delete_window;
58
59 } x11_window_t;
60
61 /*****************************************************************************
62  * vout_sys_t: video output method descriptor
63  *****************************************************************************
64  * This structure is part of the video output thread descriptor.
65  * It describes the X11 and XVideo specific properties of an output thread.
66  *****************************************************************************/
67 struct vout_sys_t
68 {
69     /* Internal settings and properties */
70     Display *           p_display;                        /* display pointer */
71
72     Visual *            p_visual;                          /* visual pointer */
73     int                 i_screen;                           /* screen number */
74
75     /* Our current window */
76     x11_window_t *      p_win;
77
78     /* Our two windows */
79     x11_window_t        original_window;
80     x11_window_t        fullscreen_window;
81
82     /* X11 generic properties */
83     vlc_bool_t          b_altfullscreen;          /* which fullscreen method */
84     vlc_bool_t          b_createwindow;  /* are we the base window's owner ? */
85 #ifdef HAVE_SYS_SHM_H
86     vlc_bool_t          b_shm;               /* shared memory extension flag */
87 #endif
88
89 #ifdef MODULE_NAME_IS_xvideo
90     int                 i_xvport;
91 #else
92     Colormap            colormap;               /* colormap used (8bpp only) */
93
94     int                 i_screen_depth;
95     int                 i_bytes_per_pixel;
96     int                 i_bytes_per_line;
97 #endif
98
99     /* Screen saver properties */
100     int                 i_ss_timeout;                             /* timeout */
101     int                 i_ss_interval;           /* interval between changes */
102     int                 i_ss_blanking;                      /* blanking mode */
103     int                 i_ss_exposure;                      /* exposure mode */
104 #ifdef DPMSINFO_IN_DPMS_H
105     BOOL                b_ss_dpms;                              /* DPMS mode */
106 #endif
107
108     /* Mouse pointer properties */
109     vlc_bool_t          b_mouse_pointer_visible;
110     mtime_t             i_time_mouse_last_moved; /* used to auto-hide pointer*/
111     Cursor              blank_cursor;                   /* the hidden cursor */
112     mtime_t             i_time_button_last_pressed;   /* to track dbl-clicks */
113     Pixmap              cursor_pixmap;
114 };
115
116 /*****************************************************************************
117  * picture_sys_t: direct buffer method descriptor
118  *****************************************************************************
119  * This structure is part of the picture descriptor, it describes the
120  * XVideo specific properties of a direct buffer.
121  *****************************************************************************/
122 struct picture_sys_t
123 {
124     IMAGE_TYPE *        p_image;
125
126 #ifdef HAVE_SYS_SHM_H
127     XShmSegmentInfo     shminfo;       /* shared memory zone information */
128 #endif
129 };
130
131 /*****************************************************************************
132  * mwmhints_t: window manager hints
133  *****************************************************************************
134  * Fullscreen needs to be able to hide the wm decorations so we provide
135  * this structure to make it easier.
136  *****************************************************************************/
137 #define MWM_HINTS_DECORATIONS   (1L << 1)
138 #define PROP_MWM_HINTS_ELEMENTS 5
139 typedef struct mwmhints_t
140 {
141     u32 flags;
142     u32 functions;
143     u32 decorations;
144     s32 input_mode;
145     u32 status;
146 } mwmhints_t;
147
148 /*****************************************************************************
149  * Chroma defines
150  *****************************************************************************/
151 #ifdef MODULE_NAME_IS_xvideo
152 #   define MAX_DIRECTBUFFERS 10
153 #else
154 #   define MAX_DIRECTBUFFERS 2
155 #endif
156