Remove unused property
[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 the VideoLAN team
5  * $Id$
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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25  *****************************************************************************/
26
27 /*****************************************************************************
28  * Defines
29  *****************************************************************************/
30 #if defined(MODULE_NAME_IS_xvideo) || defined(MODULE_NAME_IS_xvmc)
31 #   define IMAGE_TYPE     XvImage
32 #   define EXTRA_ARGS     int i_xvport, int i_chroma, int i_bits_per_pixel
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 #define X11_FOURCC( a, b, c, d ) \
45         ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
46            | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
47 #define VLC2X11_FOURCC( i ) \
48         X11_FOURCC( ((char *)&i)[0], ((char *)&i)[1], ((char *)&i)[2], \
49                     ((char *)&i)[3] )
50 #define X112VLC_FOURCC( i ) \
51         VLC_FOURCC( i & 0xff, (i >> 8) & 0xff, (i >> 16) & 0xff, \
52                     (i >> 24) & 0xff )
53
54 #ifdef HAVE_OSSO
55 #include <libosso.h>
56 #endif
57
58 struct vout_window_t;
59
60 /*****************************************************************************
61  * x11_window_t: X11 window descriptor
62  *****************************************************************************
63  * This structure contains all the data necessary to describe an X11 window.
64  *****************************************************************************/
65 typedef struct x11_window_t
66 {
67     struct vout_window_t*owner_window;               /* owner window (if any) */
68     Window              base_window;                          /* base window */
69     Window              video_window;     /* sub-window for displaying video */
70     GC                  gc;              /* graphic context instance handler */
71
72     unsigned int        i_width;                             /* window width */
73     unsigned int        i_height;                           /* window height */
74     int                 i_x;                          /* window x coordinate */
75     int                 i_y;                          /* window y coordinate */
76
77     Atom                wm_protocols;
78     Atom                wm_delete_window;
79 } x11_window_t;
80
81 /*****************************************************************************
82  * Xxmc defines
83  *****************************************************************************/
84
85 #ifdef MODULE_NAME_IS_xvmc
86
87 typedef struct
88 {         /* CLUT == Color LookUp Table */
89     uint8_t cb;
90     uint8_t cr;
91     uint8_t y;
92     uint8_t foo;
93 } clut_t;
94
95 #define XX44_PALETTE_SIZE 32
96 #define OVL_PALETTE_SIZE 256
97 #define XVMC_MAX_SURFACES 16
98 #define XVMC_MAX_SUBPICTURES 4
99 #define FOURCC_IA44 0x34344149
100 #define FOURCC_AI44 0x34344941
101
102 typedef struct
103 {
104     unsigned size;
105     unsigned max_used;
106     uint32_t cluts[XX44_PALETTE_SIZE];
107     /* cache palette entries for both colors and clip_colors */
108     int lookup_cache[OVL_PALETTE_SIZE*2];
109 } xx44_palette_t;
110
111 /*
112  * Functions to handle the vlc-specific palette.
113  */
114
115 void clear_xx44_palette( xx44_palette_t *p );
116
117 /*
118  * Convert the xine-specific palette to something useful.
119  */
120
121 void xx44_to_xvmc_palette( const xx44_palette_t *p,unsigned char *xvmc_palette,
122              unsigned first_xx44_entry, unsigned num_xx44_entries,
123              unsigned num_xvmc_components, char *xvmc_components );
124
125 typedef struct
126 {
127     vlc_macroblocks_t   vlc_mc;
128     XvMCBlockArray      blocks;            /* pointer to memory for dct block array  */
129     int                 num_blocks;
130     XvMCMacroBlock      *macroblockptr;     /* pointer to current macro block         */
131     XvMCMacroBlock      *macroblockbaseptr; /* pointer to base MacroBlock in MB array */
132     XvMCMacroBlockArray macro_blocks;      /* pointer to memory for macroblock array */
133     int                 slices;
134 } xvmc_macroblocks_t;
135
136 typedef struct
137 {
138     unsigned int        mpeg_flags;
139     unsigned int        accel_flags;
140     unsigned int        max_width;
141     unsigned int        max_height;
142     unsigned int        sub_max_width;
143     unsigned int        sub_max_height;
144     int                 type_id;
145     XvImageFormatValues subPicType;
146     int                 flags;
147 } xvmc_capabilities_t;
148
149 typedef struct xvmc_surface_handler_s
150 {
151     XvMCSurface         surfaces[XVMC_MAX_SURFACES];
152     int                 surfInUse[XVMC_MAX_SURFACES];
153     int                 surfValid[XVMC_MAX_SURFACES];
154     XvMCSubpicture      subpictures[XVMC_MAX_SUBPICTURES];
155     int                 subInUse[XVMC_MAX_SUBPICTURES];
156     int                 subValid[XVMC_MAX_SUBPICTURES];
157     pthread_mutex_t     mutex;
158 } xvmc_surface_handler_t;
159
160 typedef struct context_lock_s
161 {
162     pthread_mutex_t     mutex;
163     pthread_cond_t      cond;
164     int                 num_readers;
165 } context_lock_t;
166
167 #define XVMCLOCKDISPLAY(display) XLockDisplay(display);
168 #define XVMCUNLOCKDISPLAY(display) XUnlockDisplay(display);
169
170 void xvmc_context_reader_unlock( context_lock_t *c );
171 void xvmc_context_reader_lock( context_lock_t *c );
172 void xvmc_context_writer_lock( context_lock_t *c );
173 void xvmc_context_writer_unlock( context_lock_t *c );
174 void free_context_lock( context_lock_t *c );
175 void xxmc_dispose_context( vout_thread_t *p_vout );
176
177 int xxmc_xvmc_surface_valid( vout_thread_t *p_vout, XvMCSurface *surf );
178 void xxmc_xvmc_free_surface( vout_thread_t *p_vout, XvMCSurface *surf );
179
180 void xvmc_vld_slice( picture_t *picture );
181 void xvmc_vld_frame( picture_t *picture );
182
183 void xxmc_do_update_frame( picture_t *picture, uint32_t width, uint32_t height,
184         double ratio, int format, int flags);
185
186 int checkXvMCCap( vout_thread_t *p_vout);
187
188 XvMCSubpicture *xxmc_xvmc_alloc_subpicture( vout_thread_t *p_vout,
189         XvMCContext *context, unsigned short width, unsigned short height,
190         int xvimage_id );
191
192 void xxmc_xvmc_free_subpicture( vout_thread_t *p_vout, XvMCSubpicture *sub );
193 void blend_xx44( uint8_t *dst_img, subpicture_t *sub_img, int dst_width,
194         int dst_height, int dst_pitch, xx44_palette_t *palette,int ia44);
195
196 #endif /* XvMC defines */
197
198 /*****************************************************************************
199  * vout_sys_t: video output method descriptor
200  *****************************************************************************
201  * This structure is part of the video output thread descriptor.
202  * It describes the X11 and XVideo specific properties of an output thread.
203  *****************************************************************************/
204 struct vout_sys_t
205 {
206     /* Internal settings and properties */
207     Display *           p_display;                        /* display pointer */
208
209     Visual *            p_visual;                          /* visual pointer */
210     int                 i_screen;                           /* screen number */
211
212     /* Our window */
213     x11_window_t        window;
214
215     /* key and mouse event handling */
216     int                 i_vout_event;  /* 1(Fullsupport), 2(FullscreenOnly), 3(none) */
217
218     /* X11 generic properties */
219 #ifdef HAVE_SYS_SHM_H
220     int                 i_shm_opcode;      /* shared memory extension opcode */
221 #endif
222
223 #if defined(MODULE_NAME_IS_xvideo) || defined(MODULE_NAME_IS_xvmc)
224     int                 i_xvport;
225     bool          b_paint_colourkey;
226     int                 i_colourkey;
227 #else
228     Colormap            colormap;               /* colormap used (8bpp only) */
229
230     unsigned int        i_screen_depth;
231     unsigned int        i_bytes_per_pixel;
232     unsigned int        i_bytes_per_line;
233 #endif
234
235     /* Screen saver properties */
236     int                 i_ss_timeout;                             /* timeout */
237     int                 i_ss_interval;           /* interval between changes */
238     int                 i_ss_blanking;                      /* blanking mode */
239     int                 i_ss_exposure;                      /* exposure mode */
240 #ifdef DPMSINFO_IN_DPMS_H
241     BOOL                b_ss_dpms;                              /* DPMS mode */
242 #endif
243
244     /* Mouse pointer properties */
245     bool          b_mouse_pointer_visible;
246     mtime_t             i_time_mouse_last_moved; /* used to auto-hide pointer*/
247     mtime_t             i_mouse_hide_timeout;      /* after time hide cursor */
248     Cursor              blank_cursor;                   /* the hidden cursor */
249     mtime_t             i_time_button_last_pressed;   /* to track dbl-clicks */
250     Pixmap              cursor_pixmap;
251
252 #ifdef MODULE_NAME_IS_glx
253     /* GLX properties */
254     int                 b_glx13;
255     GLXContext          gwctx;
256     GLXWindow           gwnd;
257 #endif
258
259 #ifdef MODULE_NAME_IS_xvmc
260     /* XvMC related stuff here */
261     xvmc_macroblocks_t  macroblocks;
262     xvmc_capabilities_t *xvmc_cap;
263     unsigned int        xvmc_num_cap;
264     unsigned int        xvmc_max_subpic_x;
265     unsigned int        xvmc_max_subpic_y;
266     int                 xvmc_eventbase;
267     int                 xvmc_errbase;
268     int                 hwSubpictures;
269     XvMCSubpicture      *old_subpic;
270     XvMCSubpicture      *new_subpic;
271     xx44_palette_t      palette;
272     int                 first_overlay;
273     float               cpu_saver;
274     int                 cpu_save_enabled;
275     int                 reverse_nvidia_palette;
276     int                 context_flags;
277
278     /*
279      * These variables are protected by the context lock:
280      */
281     unsigned            xvmc_cur_cap;
282     int                 xvmc_backend_subpic;
283     XvMCContext         context;
284     int                 contextActive;
285     xvmc_surface_handler_t xvmc_surf_handler;
286     unsigned            xvmc_mpeg;
287     unsigned            xvmc_accel;
288     unsigned            last_accel_request;
289     unsigned            xvmc_width;
290     unsigned            xvmc_height;
291     int                 have_xvmc_autopaint;
292     int                 xvmc_xoverlay_type;
293     int                 unsigned_intra;
294
295     /*
296      * Only creation and destruction of the below.
297      */
298     char                *xvmc_palette;
299     XvImage             *subImage;
300     XShmSegmentInfo     subShmInfo;
301
302     /*
303      * The mutex below is needed since XlockDisplay wasn't really enough
304      * to protect the XvMC Calls.
305      */
306     context_lock_t      xvmc_lock;
307     subpicture_t *      p_last_subtitle_save;
308     int                 xvmc_deinterlace_method;
309     int                 xvmc_crop_style;
310     mtime_t             last_date;
311
312     //alphablend_t       alphablend_extra_data;
313 #endif
314
315 #ifdef HAVE_XSP
316     int                 i_hw_scale;
317 #endif
318
319 #ifdef HAVE_OSSO
320     osso_context_t      *p_octx;
321     int                 i_backlight_on_counter;
322 #endif
323 };
324
325 /*****************************************************************************
326  * picture_sys_t: direct buffer method descriptor
327  *****************************************************************************
328  * This structure is part of the picture descriptor, it describes the
329  * XVideo specific properties of a direct buffer.
330  *****************************************************************************/
331 struct picture_sys_t
332 {
333     IMAGE_TYPE *        p_image;
334
335 #ifdef HAVE_SYS_SHM_H
336     XShmSegmentInfo     shminfo;       /* shared memory zone information */
337 #endif
338
339 #ifdef MODULE_NAME_IS_xvmc
340     XvMCSurface         *xvmc_surf;
341     vlc_xxmc_t           xxmc_data;
342     int                  last_sw_format;
343     vout_thread_t        *p_vout;
344     int                  nb_display;
345 #endif
346 };
347
348 /*****************************************************************************
349  * mwmhints_t: window manager hints
350  *****************************************************************************
351  * Fullscreen needs to be able to hide the wm decorations so we provide
352  * this structure to make it easier.
353  *****************************************************************************/
354 #define MWM_HINTS_DECORATIONS   (1L << 1)
355 #define PROP_MWM_HINTS_ELEMENTS 5
356
357 typedef struct mwmhints_t
358 {
359     unsigned long flags;
360     unsigned long functions;
361     unsigned long decorations;
362     signed   long input_mode;
363     unsigned long status;
364 } mwmhints_t;
365
366 /*****************************************************************************
367  * Chroma defines
368  *****************************************************************************/
369 #ifdef MODULE_NAME_IS_xvideo
370 #   define MAX_DIRECTBUFFERS (VOUT_MAX_PICTURES)
371 #elif defined(MODULE_NAME_IS_xvmc)
372 #   define MAX_DIRECTBUFFERS (VOUT_MAX_PICTURES+2)
373 #else
374 #   define MAX_DIRECTBUFFERS 2
375 #endif
376
377 #ifndef MODULE_NAME_IS_glx
378 static IMAGE_TYPE *CreateImage    ( vout_thread_t *,
379                                     Display *, EXTRA_ARGS, int, int );
380 #ifdef HAVE_SYS_SHM_H
381 IMAGE_TYPE *CreateShmImage ( vout_thread_t *,
382                                     Display *, EXTRA_ARGS_SHM, int, int );
383 #endif
384 #endif
385