3 * @brief X C Bindings window provider module for VLC media player
5 /*****************************************************************************
6 * Copyright © 2009 Rémi Denis-Courmont
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2.0
11 * of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 ****************************************************************************/
30 #include <unistd.h> /* gethostname() */
31 #include <limits.h> /* HOST_NAME_MAX */
34 #include <xcb/xcb_aux.h>
35 typedef xcb_atom_t Atom;
36 #include <X11/Xatom.h> /* XA_WM_NAME */
38 #include <vlc_common.h>
39 #include <vlc_plugin.h>
40 #include <vlc_window.h>
44 #define DISPLAY_TEXT N_("X11 display")
45 #define DISPLAY_LONGTEXT N_( \
46 "X11 hardware display to use. By default VLC will " \
47 "use the value of the DISPLAY environment variable.")
49 static int Open (vlc_object_t *);
50 static void Close (vlc_object_t *);
56 set_shortname (N_("XCB window"))
57 set_description (N_("(Experimental) XCB video window"))
58 set_category (CAT_VIDEO)
59 set_subcategory (SUBCAT_VIDEO_VOUT)
60 set_capability ("xwindow", 10)
61 set_callbacks (Open, Close)
63 add_string ("x11-display", NULL, NULL,
64 DISPLAY_TEXT, DISPLAY_LONGTEXT, true)
67 static int Control (vout_window_t *, int, va_list ap);
68 static void *Thread (void *);
70 struct vout_window_sys_t
72 xcb_connection_t *conn;
78 void set_ascii_prop (xcb_connection_t *conn, xcb_window_t window,
79 xcb_atom_t atom, const char *value)
81 xcb_change_property (conn, XCB_PROP_MODE_REPLACE, window, atom,
82 XA_STRING, 8, strlen (value), value);
86 void set_hostname_prop (xcb_connection_t *conn, xcb_window_t window)
88 char hostname[HOST_NAME_MAX];
90 if (gethostname (hostname, sizeof (hostname)) == 0)
92 hostname[sizeof (hostname) - 1] = '\0';
93 set_ascii_prop (conn, window, XA_WM_CLIENT_MACHINE, hostname);
99 * Create an X11 window.
101 static int Open (vlc_object_t *obj)
103 vout_window_t *wnd = (vout_window_t *)obj;
104 vout_window_sys_t *p_sys = malloc (sizeof (*p_sys));
105 xcb_generic_error_t *err;
106 xcb_void_cookie_t ck;
112 char *display = var_CreateGetNonEmptyString (wnd, "x11-display");
115 xcb_connection_t *conn = xcb_connect (display, &snum);
117 if (xcb_connection_has_error (conn) /*== NULL*/)
121 xcb_screen_t *scr = xcb_aux_get_screen (conn, snum);
122 const uint32_t mask = XCB_CW_BACK_PIXEL | XCB_CW_EVENT_MASK;
123 uint32_t values[2] = {
124 /* XCB_CW_BACK_PIXEL */
126 /* XCB_CW_EVENT_MASK */
127 XCB_EVENT_MASK_KEY_PRESS,
130 xcb_window_t window = xcb_generate_id (conn);
131 ck = xcb_create_window_checked (conn, scr->root_depth, window, scr->root,
132 0, 0, wnd->width, wnd->height, 0,
133 XCB_WINDOW_CLASS_INPUT_OUTPUT,
134 scr->root_visual, mask, values);
135 err = xcb_request_check (conn, ck);
138 msg_Err (wnd, "creating window: X11 error %d", err->error_code);
143 * No cut&paste nor drag&drop, only Window Manager communication. */
144 /* Plain ASCII localization of VLC for ICCCM window name */
145 set_ascii_prop (conn, window, XA_WM_NAME,
146 pgettext ("ASCII VLC media player", "VLC media player"));
147 set_ascii_prop (conn, window, XA_WM_ICON_NAME,
148 pgettext ("ASCII VLC", "VLC"));
149 xcb_change_property (conn, XCB_PROP_MODE_REPLACE, window, XA_WM_CLASS,
150 XA_STRING, 8, 8, "vlc\0Vlc");
151 set_hostname_prop (conn, window);
153 wnd->handle.xid = window;
155 wnd->control = Control;
158 p_sys->keys = CreateKeyHandler (obj, conn);
160 if ((p_sys->keys != NULL)
161 && vlc_clone (&p_sys->thread, Thread, wnd, VLC_THREAD_PRIORITY_LOW))
162 DestroyKeyHandler (p_sys->keys);
164 /* Make sure the window is ready */
165 xcb_map_window (conn, window);
171 xcb_disconnect (conn);
178 * Destroys the X11 window.
180 static void Close (vlc_object_t *obj)
182 vout_window_t *wnd = (vout_window_t *)obj;
183 vout_window_sys_t *p_sys = wnd->p_sys;
184 xcb_connection_t *conn = p_sys->conn;
185 xcb_window_t window = wnd->handle.xid;
189 vlc_cancel (p_sys->thread);
190 vlc_join (p_sys->thread, NULL);
191 DestroyKeyHandler (p_sys->keys);
193 xcb_unmap_window (conn, window);
194 xcb_destroy_window (conn, window);
195 xcb_disconnect (conn);
200 static void *Thread (void *data)
202 vout_window_t *wnd = data;
203 vout_window_sys_t *p_sys = wnd->p_sys;
204 xcb_connection_t *conn = p_sys->conn;
206 int fd = xcb_get_file_descriptor (conn);
212 xcb_generic_event_t *ev;
213 struct pollfd ufd = { .fd = fd, .events = POLLIN, };
217 int canc = vlc_savecancel ();
218 while ((ev = xcb_poll_for_event (conn)) != NULL)
220 if (ProcessKeyEvent (p_sys->keys, ev) == 0)
222 msg_Dbg (wnd, "unhandled event: %"PRIu8, ev->response_type);
225 vlc_restorecancel (canc);
227 if (xcb_connection_has_error (conn))
229 msg_Err (wnd, "X server failure");
236 #include <vlc_vout.h>
238 static int Control (vout_window_t *wnd, int cmd, va_list ap)
240 vout_window_sys_t *p_sys = wnd->p_sys;
241 xcb_connection_t *conn = p_sys->conn;
247 unsigned width = va_arg (ap, unsigned);
248 unsigned height = va_arg (ap, unsigned);
249 const uint32_t values[] = { width, height, };
251 xcb_configure_window (conn, wnd->handle.xid,
252 XCB_CONFIG_WINDOW_WIDTH |
253 XCB_CONFIG_WINDOW_HEIGHT, values);
259 msg_Err (wnd, "request %d not implemented", cmd);