docs: document --quvi-format
[mplayer.git] / libvo / x11_common.h
blob57353e418e95a499ab4e1838cbdf0e6446a2cde2
1 /*
2 * This file is part of MPlayer.
4 * MPlayer is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * MPlayer is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with MPlayer; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19 #ifndef MPLAYER_X11_COMMON_H
20 #define MPLAYER_X11_COMMON_H
22 #include <stdint.h>
23 #include <stdbool.h>
24 #include <X11/Xlib.h>
25 #include <X11/Xutil.h>
27 #include "config.h"
29 struct vo;
31 struct vo_x11_state {
32 Display *display;
33 Window window;
34 Window rootwin;
35 int screen;
36 int display_is_local;
37 int depthonscreen;
39 XIM xim;
40 XIC xic;
42 GC vo_gc;
44 struct xv_ck_info_s {
45 int method; ///< CK_METHOD_* constants
46 int source; ///< CK_SRC_* constants
47 } xv_ck_info;
48 unsigned long xv_colorkey;
49 unsigned int xv_port;
51 int wm_type;
52 int fs_type;
53 int window_state;
54 int fs_flip;
56 GC f_gc;
57 XSizeHints vo_hint;
58 unsigned int mouse_timer;
59 int mouse_waiting_hide;
60 int orig_layer;
61 int old_gravity;
62 int vo_old_x;
63 int vo_old_y;
64 int vo_old_width;
65 int vo_old_height;
67 /* Keep track of original video width/height to determine when to
68 * resize window when reconfiguring. Resize window when video size
69 * changes, but don't force window size changes as long as video size
70 * stays the same (even if that size is different from the current
71 * window size after the user modified the latter). */
72 int last_video_width;
73 int last_video_height;
74 /* Video size changed during fullscreen when we couldn't tell the new
75 * size to the window manager. Must set window size when turning
76 * fullscreen off. */
77 bool size_changed_during_fs;
79 unsigned int olddecor;
80 unsigned int oldfuncs;
81 XComposeStatus compose_status;
83 Atom XA_NET_SUPPORTED;
84 Atom XA_NET_WM_STATE;
85 Atom XA_NET_WM_STATE_FULLSCREEN;
86 Atom XA_NET_WM_STATE_ABOVE;
87 Atom XA_NET_WM_STATE_STAYS_ON_TOP;
88 Atom XA_NET_WM_STATE_BELOW;
89 Atom XA_NET_WM_PID;
90 Atom XA_NET_WM_NAME;
91 Atom XA_NET_WM_ICON_NAME;
92 Atom XA_WIN_PROTOCOLS;
93 Atom XA_WIN_LAYER;
94 Atom XA_WIN_HINTS;
95 Atom XAWM_PROTOCOLS;
96 Atom XAWM_DELETE_WINDOW;
97 Atom XAUTF8_STRING;
98 Atom XA_NET_WM_CM;
101 #define vo_wm_LAYER 1
102 #define vo_wm_FULLSCREEN 2
103 #define vo_wm_STAYS_ON_TOP 4
104 #define vo_wm_ABOVE 8
105 #define vo_wm_BELOW 16
106 #define vo_wm_NETWM (vo_wm_FULLSCREEN | vo_wm_STAYS_ON_TOP | vo_wm_ABOVE | vo_wm_BELOW)
108 /* EWMH state actions, see
109 http://freedesktop.org/Standards/wm-spec/index.html#id2768769 */
110 #define _NET_WM_STATE_REMOVE 0 /* remove/unset property */
111 #define _NET_WM_STATE_ADD 1 /* add/set property */
112 #define _NET_WM_STATE_TOGGLE 2 /* toggle property */
114 extern int metacity_hack;
116 extern char** vo_fstype_list;
118 extern char *mDisplayName;
120 struct vo_x11_state *vo_x11_init_state(void);
121 int vo_init(struct vo *vo);
122 void vo_uninit(struct vo_x11_state *x11);
123 void vo_x11_decoration(struct vo *vo, int d );
124 void vo_x11_classhint(struct vo *vo, Window window, const char *name);
125 void vo_x11_sizehint(struct vo *vo, int x, int y, int width, int height, int max);
126 int vo_x11_check_events(struct vo *vo);
127 void vo_x11_selectinput_witherr(Display *display, Window w, long event_mask);
128 void vo_x11_fullscreen(struct vo *vo);
129 int vo_x11_update_geometry(struct vo *vo, bool update_pos);
130 void vo_x11_setlayer(struct vo *vo, Window vo_window, int layer);
131 void vo_x11_uninit(struct vo *vo);
132 Colormap vo_x11_create_colormap(struct vo *vo, XVisualInfo *vinfo);
133 uint32_t vo_x11_set_equalizer(struct vo *vo, const char *name, int value);
134 uint32_t vo_x11_get_equalizer(const char *name, int *value);
135 bool vo_x11_screen_is_composited(struct vo *vo);
136 void fstype_help(void);
137 void vo_x11_create_vo_window(struct vo *vo, XVisualInfo *vis,
138 int x, int y, unsigned int width, unsigned int height, int flags,
139 Colormap col_map, const char *classname);
140 void vo_x11_clearwindow_part(struct vo *vo, Window vo_window,
141 int img_width, int img_height);
142 void vo_x11_clearwindow(struct vo *vo, Window vo_window);
143 void vo_x11_ontop(struct vo *vo);
144 void vo_x11_border(struct vo *vo);
145 void vo_x11_ewmh_fullscreen(struct vo_x11_state *x11, int action);
148 int vo_xv_set_eq(struct vo *vo, uint32_t xv_port, const char *name, int value);
149 int vo_xv_get_eq(struct vo *vo, uint32_t xv_port, const char *name, int *value);
151 int vo_xv_enable_vsync(struct vo *vo);
153 void vo_xv_get_max_img_dim(struct vo *vo, uint32_t * width, uint32_t * height);
155 /*** colorkey handling ***/
157 #define CK_METHOD_NONE 0 ///< no colorkey drawing
158 #define CK_METHOD_BACKGROUND 1 ///< set colorkey as window background
159 #define CK_METHOD_AUTOPAINT 2 ///< let xv draw the colorkey
160 #define CK_METHOD_MANUALFILL 3 ///< manually draw the colorkey
161 #define CK_SRC_USE 0 ///< use specified / default colorkey
162 #define CK_SRC_SET 1 ///< use and set specified / default colorkey
163 #define CK_SRC_CUR 2 ///< use current colorkey ( get it from xv )
165 int vo_xv_init_colorkey(struct vo *vo);
166 void vo_xv_draw_colorkey(struct vo *vo, int32_t x, int32_t y, int32_t w, int32_t h);
167 void xv_setup_colorkeyhandling(struct vo *vo, const char *ck_method_str, const char *ck_str);
169 /*** test functions for common suboptions ***/
170 int xv_test_ck( void * arg );
171 int xv_test_ckm( void * arg );
173 #ifdef CONFIG_XF86VM
174 void vo_vm_switch(struct vo *vo);
175 void vo_vm_close(struct vo *vo);
176 double vo_vm_get_fps(struct vo *vo);
177 #endif
179 void update_xinerama_info(struct vo *vo);
181 int vo_find_depth_from_visuals(Display *dpy, int screen, Visual **visual_return);
182 void xscreensaver_heartbeat(struct vo_x11_state *x11);
184 // Old VOs use incompatible function calls, translate them to new
185 // prototypes
186 #ifdef IS_OLD_VO
187 #define vo_x11_create_vo_window(vis, x, y, width, height, flags, col_map, classname, title) \
188 vo_x11_create_vo_window(global_vo, vis, x, y, width, height, flags, col_map, classname)
189 #define vo_x11_fullscreen() vo_x11_fullscreen(global_vo)
190 #define vo_x11_update_geometry() vo_x11_update_geometry(global_vo, 1)
191 #define vo_x11_ontop() vo_x11_ontop(global_vo)
192 #define vo_init() vo_init(global_vo)
193 #define vo_x11_ewmh_fullscreen(action) vo_x11_ewmh_fullscreen(global_vo->x11->display, action)
194 #define update_xinerama_info() update_xinerama_info(global_vo)
195 #define vo_x11_uninit() vo_x11_uninit(global_vo)
196 #define vo_x11_check_events(display) vo_x11_check_events(global_vo)
197 #define vo_x11_sizehint(...) vo_x11_sizehint(global_vo, __VA_ARGS__)
198 #define vo_vm_switch() vo_vm_switch(global_vo)
199 #define vo_x11_create_colormap(vinfo) vo_x11_create_colormap(global_vo, vinfo)
200 #define vo_x11_set_equalizer(...) vo_x11_set_equalizer(global_vo, __VA_ARGS__)
201 #define vo_xv_set_eq(...) vo_xv_set_eq(global_vo, __VA_ARGS__)
202 #define vo_xv_get_eq(...) vo_xv_get_eq(global_vo, __VA_ARGS__)
203 #define vo_xv_enable_vsync() vo_xv_enable_vsync(global_vo)
204 #define vo_xv_get_max_img_dim(...) vo_xv_get_max_img_dim(global_vo, __VA_ARGS__)
205 #define vo_xv_init_colorkey() vo_xv_init_colorkey(global_vo)
206 #define vo_xv_draw_colorkey(...) vo_xv_draw_colorkey(global_vo, __VA_ARGS__)
207 #define vo_x11_clearwindow_part(display, ...) vo_x11_clearwindow_part(global_vo, __VA_ARGS__)
208 #define vo_vm_close() vo_vm_close(global_vo)
209 #define vo_x11_clearwindow(display, window) vo_x11_clearwindow(global_vo, window)
210 #define vo_x11_classhint(display, window, name) vo_x11_classhint(global_vo, window, name)
211 #define vo_x11_setlayer(display, window, layer) vo_x11_setlayer(global_vo, window, layer)
212 #define xv_setup_colorkeyhandling(a, b) xv_setup_colorkeyhandling(global_vo, a, b)
213 #define vo_x11_border() vo_x11_border(global_vo)
215 #define mDisplay global_vo->x11->display
216 #define vo_depthonscreen global_vo->x11->depthonscreen
217 #define vo_window global_vo->x11->window
218 #define xv_ck_info global_vo->x11->xv_ck_info
219 #define xv_colorkey global_vo->x11->xv_colorkey
220 #define xv_port global_vo->x11->xv_port
221 #define vo_gc global_vo->x11->vo_gc
222 #define mRootWin global_vo->x11->rootwin
223 #define mScreen global_vo->x11->screen
224 #define mLocalDisplay global_vo->x11->display_is_local
225 #endif
227 #endif /* MPLAYER_X11_COMMON_H */