/******************************************************************** KWin - the KDE window manager This file is part of the KDE project. Copyright (C) 2013 Martin Gräßlin This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . *********************************************************************/ #define WL_EGL_PLATFORM 1 #include "egl_wayland_backend.h" // kwin #include "options.h" // kwin libs #include // KDE #include // xcb #include // system #include #include namespace KWin { namespace Wayland { /** * Callback for announcing global objects in the registry **/ static void registryHandleGlobal(void *data, struct wl_registry *registry, uint32_t name, const char *interface, uint32_t version) { Q_UNUSED(version) WaylandBackend *d = reinterpret_cast(data); if (strcmp(interface, "wl_compositor") == 0) { d->setCompositor(reinterpret_cast(wl_registry_bind(registry, name, &wl_compositor_interface, 1))); } else if (strcmp(interface, "wl_shell") == 0) { d->setShell(reinterpret_cast(wl_registry_bind(registry, name, &wl_shell_interface, 1))); } else if (strcmp(interface, "wl_seat") == 0) { d->createSeat(name); } kDebug(1212) << "Wayland Interface: " << interface; } /** * Callback for removal of global objects in the registry **/ static void registryHandleGlobalRemove(void *data, struct wl_registry *registry, uint32_t name) { Q_UNUSED(data) Q_UNUSED(registry) Q_UNUSED(name) // TODO: implement me } /** * Call back for ping from Wayland Shell. **/ static void handlePing(void *data, struct wl_shell_surface *shellSurface, uint32_t serial) { Q_UNUSED(data) wl_shell_surface_pong(shellSurface, serial); } /** * Callback for a configure request for a shell surface **/ static void handleConfigure(void *data, struct wl_shell_surface *shellSurface, uint32_t edges, int32_t width, int32_t height) { Q_UNUSED(shellSurface) Q_UNUSED(edges) WaylandBackend *display = reinterpret_cast(data); wl_egl_window_resize(display->overlay(), width, height, 0, 0); // TODO: this information should probably go into Screens } /** * Callback for popups - not needed, we don't have popups **/ static void handlePopupDone(void *data, struct wl_shell_surface *shellSurface) { Q_UNUSED(data) Q_UNUSED(shellSurface) } static void seatHandleCapabilities(void *data, wl_seat *seat, uint32_t capabilities) { WaylandSeat *s = reinterpret_cast(data); if (seat != s->seat()) { return; } s->changed(capabilities); } static void pointerHandleEnter(void *data, wl_pointer *pointer, uint32_t serial, wl_surface *surface, wl_fixed_t sx, wl_fixed_t sy) { Q_UNUSED(data) Q_UNUSED(pointer) Q_UNUSED(serial) Q_UNUSED(surface) Q_UNUSED(sx) Q_UNUSED(sy) } static void pointerHandleLeave(void *data, wl_pointer *pointer, uint32_t serial, wl_surface *surface) { Q_UNUSED(data) Q_UNUSED(pointer) Q_UNUSED(serial) Q_UNUSED(surface) } static void pointerHandleMotion(void *data, wl_pointer *pointer, uint32_t time, wl_fixed_t sx, wl_fixed_t sy) { Q_UNUSED(data) Q_UNUSED(pointer) Q_UNUSED(time) xcb_test_fake_input(connection(), XCB_MOTION_NOTIFY, 0, XCB_TIME_CURRENT_TIME, XCB_WINDOW_NONE, wl_fixed_to_int(sx), wl_fixed_to_int(sy), 0); } static void pointerHandleButton(void *data, wl_pointer *pointer, uint32_t serial, uint32_t time, uint32_t button, uint32_t state) { Q_UNUSED(data) Q_UNUSED(pointer) Q_UNUSED(serial) Q_UNUSED(time) uint8_t type = XCB_BUTTON_PRESS; if (state == WL_POINTER_BUTTON_STATE_RELEASED) { type = XCB_BUTTON_RELEASE; } // TODO: there must be a better way for mapping uint8_t xButton = 0; switch (button) { case BTN_LEFT: xButton = XCB_BUTTON_INDEX_1; break; case BTN_RIGHT: xButton = XCB_BUTTON_INDEX_3; break; case BTN_MIDDLE: xButton = XCB_BUTTON_INDEX_2; break; default: // TODO: add more buttons return; } xcb_test_fake_input(connection(), type, xButton, XCB_TIME_CURRENT_TIME, XCB_WINDOW_NONE, 0, 0, 0); } static void pointerHandleAxis(void *data, wl_pointer *pointer, uint32_t time, uint32_t axis, wl_fixed_t value) { Q_UNUSED(data) Q_UNUSED(pointer) Q_UNUSED(time) Q_UNUSED(axis) Q_UNUSED(value) // TODO: implement mouse wheel support } static void keyboardHandleKeymap(void *data, wl_keyboard *keyboard, uint32_t format, int fd, uint32_t size) { Q_UNUSED(data) Q_UNUSED(keyboard) Q_UNUSED(format) Q_UNUSED(fd) Q_UNUSED(size) } static void keyboardHandleEnter(void *data, wl_keyboard *keyboard, uint32_t serial, wl_surface *surface, wl_array *keys) { Q_UNUSED(data) Q_UNUSED(keyboard) Q_UNUSED(serial) Q_UNUSED(surface) Q_UNUSED(keys) } static void keyboardHandleLeave(void *data, wl_keyboard *keyboard, uint32_t serial, wl_surface *surface) { Q_UNUSED(data) Q_UNUSED(keyboard) Q_UNUSED(serial) Q_UNUSED(surface) } static void keyboardHandleKey(void *data, wl_keyboard *keyboard, uint32_t serial, uint32_t time, uint32_t key, uint32_t state) { Q_UNUSED(data) Q_UNUSED(keyboard) Q_UNUSED(serial) Q_UNUSED(time) uint8_t type = XCB_KEY_PRESS; if (state == WL_KEYBOARD_KEY_STATE_RELEASED) { type = XCB_KEY_RELEASE; } xcb_test_fake_input(connection(), type, key + 8 /*magic*/, XCB_TIME_CURRENT_TIME, XCB_WINDOW_NONE, 0, 0, 0); } static void keyboardHandleModifiers(void *data, wl_keyboard *keyboard, uint32_t serial, uint32_t modsDepressed, uint32_t modsLatched, uint32_t modsLocked, uint32_t group) { Q_UNUSED(data) Q_UNUSED(keyboard) Q_UNUSED(serial) Q_UNUSED(modsDepressed) Q_UNUSED(modsLatched) Q_UNUSED(modsLocked) Q_UNUSED(group) } // handlers static const struct wl_registry_listener s_registryListener = { registryHandleGlobal, registryHandleGlobalRemove }; static const struct wl_shell_surface_listener s_shellSurfaceListener = { handlePing, handleConfigure, handlePopupDone }; static const struct wl_pointer_listener s_pointerListener = { pointerHandleEnter, pointerHandleLeave, pointerHandleMotion, pointerHandleButton, pointerHandleAxis }; static const struct wl_keyboard_listener s_keyboardListener = { keyboardHandleKeymap, keyboardHandleEnter, keyboardHandleLeave, keyboardHandleKey, keyboardHandleModifiers, }; static const struct wl_seat_listener s_seatListener = { seatHandleCapabilities }; WaylandSeat::WaylandSeat(wl_seat *seat) : m_seat(seat) , m_pointer(NULL) , m_keyboard(NULL) { if (m_seat) { wl_seat_add_listener(m_seat, &s_seatListener, this); } } WaylandSeat::~WaylandSeat() { destroyPointer(); destroyKeyboard(); if (m_seat) { wl_seat_destroy(m_seat); } } void WaylandSeat::destroyPointer() { if (m_pointer) { wl_pointer_destroy(m_pointer); m_pointer = NULL; } } void WaylandSeat::destroyKeyboard() { if (m_keyboard) { wl_keyboard_destroy(m_keyboard); m_keyboard = NULL; } } void WaylandSeat::changed(uint32_t capabilities) { if ((capabilities & WL_SEAT_CAPABILITY_POINTER) && !m_pointer) { m_pointer = wl_seat_get_pointer(m_seat); wl_pointer_add_listener(m_pointer, &s_pointerListener, this); } else if (!(capabilities & WL_SEAT_CAPABILITY_POINTER)) { destroyPointer(); } if ((capabilities & WL_SEAT_CAPABILITY_KEYBOARD)) { m_keyboard = wl_seat_get_keyboard(m_seat); wl_keyboard_add_listener(m_keyboard, &s_keyboardListener, this); } else if (!(capabilities & WL_SEAT_CAPABILITY_KEYBOARD)) { destroyKeyboard(); } } WaylandBackend::WaylandBackend() : m_display(wl_display_connect(NULL)) , m_registry(wl_display_get_registry(m_display)) , m_compositor(NULL) , m_shell(NULL) , m_surface(NULL) , m_overlay(NULL) , m_shellSurface(NULL) , m_seat() { kDebug(1212) << "Created Wayland display"; // setup the registry wl_registry_add_listener(m_registry, &s_registryListener, this); wl_display_dispatch(m_display); } WaylandBackend::~WaylandBackend() { if (m_overlay) { wl_egl_window_destroy(m_overlay); } if (m_shellSurface) { wl_shell_surface_destroy(m_shellSurface); } if (m_surface) { wl_surface_destroy(m_surface); } if (m_shell) { wl_shell_destroy(m_shell); } if (m_compositor) { wl_compositor_destroy(m_compositor); } if (m_registry) { wl_registry_destroy(m_registry); } if (m_display) { wl_display_flush(m_display); wl_display_disconnect(m_display); } kDebug(1212) << "Destroyed Wayland display"; } void WaylandBackend::createSeat(uint32_t name) { wl_seat *seat = reinterpret_cast(wl_registry_bind(m_registry, name, &wl_seat_interface, 1)); m_seat.reset(new WaylandSeat(seat)); } bool WaylandBackend::createSurface() { m_surface = wl_compositor_create_surface(m_compositor); if (!m_surface) { kError(1212) << "Creating Wayland Surface failed"; return false; } // map the surface as fullscreen m_shellSurface = wl_shell_get_shell_surface(m_shell, m_surface); wl_shell_surface_add_listener(m_shellSurface, &s_shellSurfaceListener, this); // TODO: do something better than displayWidth/displayHeight m_overlay = wl_egl_window_create(m_surface, displayWidth(), displayHeight()); if (!m_overlay) { kError(1212) << "Creating Wayland Egl window failed"; return false; } wl_region *region = wl_compositor_create_region(m_compositor); wl_region_add(region, 0, 0, displayWidth(), displayHeight()); wl_surface_set_opaque_region(m_surface, region); wl_region_destroy(region); // wl_shell_surface_set_fullscreen(m_shellSurface, WL_SHELL_SURFACE_FULLSCREEN_METHOD_DEFAULT, 0, NULL); wl_shell_surface_set_toplevel(m_shellSurface); handleConfigure(this, m_shellSurface, 0, displayWidth(), displayHeight()); return true; } } EglWaylandBackend::EglWaylandBackend() : OpenGLBackend() , m_context(EGL_NO_CONTEXT) , m_wayland(new Wayland::WaylandBackend) { kDebug(1212) << "Connected to Wayland display?" << (m_wayland->display() ? "yes" : "no" ); if (!m_wayland->display()) { setFailed("Could not connect to Wayland compositor"); return; } initializeEgl(); init(); // Egl is always direct rendering setIsDirectRendering(true); } EglWaylandBackend::~EglWaylandBackend() { cleanupGL(); eglMakeCurrent(m_display, EGL_NO_SURFACE, EGL_NO_SURFACE, EGL_NO_CONTEXT); eglDestroyContext(m_display, m_context); eglDestroySurface(m_display, m_surface); eglTerminate(m_display); eglReleaseThread(); } bool EglWaylandBackend::initializeEgl() { m_display = eglGetDisplay(m_wayland->display()); if (m_display == EGL_NO_DISPLAY) return false; EGLint major, minor; if (eglInitialize(m_display, &major, &minor) == EGL_FALSE) return false; EGLint error = eglGetError(); if (error != EGL_SUCCESS) { kWarning(1212) << "Error during eglInitialize " << error; return false; } kDebug(1212) << "Egl Initialize succeeded"; #ifdef KWIN_HAVE_OPENGLES eglBindAPI(EGL_OPENGL_ES_API); #else if (eglBindAPI(EGL_OPENGL_API) == EGL_FALSE) { kError(1212) << "bind OpenGL API failed"; return false; } #endif kDebug(1212) << "EGL version: " << major << "." << minor; return true; } void EglWaylandBackend::init() { if (!initRenderingContext()) { setFailed("Could not initialize rendering context"); return; } initEGL(); GLPlatform *glPlatform = GLPlatform::instance(); glPlatform->detect(EglPlatformInterface); glPlatform->printResults(); initGL(EglPlatformInterface); } bool EglWaylandBackend::initRenderingContext() { initBufferConfigs(); #ifdef KWIN_HAVE_OPENGLES const EGLint context_attribs[] = { EGL_CONTEXT_CLIENT_VERSION, 2, EGL_NONE }; m_context = eglCreateContext(m_display, m_config, EGL_NO_CONTEXT, context_attribs); #else const EGLint context_attribs_31_core[] = { EGL_CONTEXT_MAJOR_VERSION_KHR, 3, EGL_CONTEXT_MINOR_VERSION_KHR, 1, EGL_CONTEXT_FLAGS_KHR, EGL_CONTEXT_OPENGL_FORWARD_COMPATIBLE_BIT_KHR, EGL_NONE }; const EGLint context_attribs_legacy[] = { EGL_NONE }; const QByteArray eglExtensions = eglQueryString(m_display, EGL_EXTENSIONS); const QList extensions = eglExtensions.split(' '); // Try to create a 3.1 core context if (options->glCoreProfile() && extensions.contains("EGL_KHR_create_context")) m_context = eglCreateContext(m_display, m_config, EGL_NO_CONTEXT, context_attribs_31_core); if (m_context == EGL_NO_CONTEXT) m_context = eglCreateContext(m_display, m_config, EGL_NO_CONTEXT, context_attribs_legacy); #endif if (m_context == EGL_NO_CONTEXT) { kError(1212) << "Create Context failed"; return false; } if (!m_wayland->createSurface()) { return false; } m_surface = eglCreateWindowSurface(m_display, m_config, m_wayland->overlay(), NULL); if (m_surface == EGL_NO_SURFACE) { kError(1212) << "Create Window Surface failed"; return false; } return makeContextCurrent(); } bool EglWaylandBackend::makeContextCurrent() { if (eglMakeCurrent(m_display, m_surface, m_surface, m_context) == EGL_FALSE) { kError(1212) << "Make Context Current failed"; return false; } EGLint error = eglGetError(); if (error != EGL_SUCCESS) { kWarning(1212) << "Error occurred while creating context " << error; return false; } return true; } bool EglWaylandBackend::initBufferConfigs() { const EGLint config_attribs[] = { EGL_SURFACE_TYPE, EGL_WINDOW_BIT, EGL_RED_SIZE, 1, EGL_GREEN_SIZE, 1, EGL_BLUE_SIZE, 1, EGL_ALPHA_SIZE, 0, #ifdef KWIN_HAVE_OPENGLES EGL_RENDERABLE_TYPE, EGL_OPENGL_ES2_BIT, #else EGL_RENDERABLE_TYPE, EGL_OPENGL_BIT, #endif EGL_CONFIG_CAVEAT, EGL_NONE, EGL_NONE, }; EGLint count; EGLConfig configs[1024]; if (eglChooseConfig(m_display, config_attribs, configs, 1, &count) == EGL_FALSE) { kError(1212) << "choose config failed"; return false; } if (count != 1) { kError(1212) << "choose config did not return a config" << count; return false; } m_config = configs[0]; return true; } void EglWaylandBackend::present() { setLastDamage(QRegion()); wl_display_dispatch_pending(m_wayland->display()); wl_display_flush(m_wayland->display()); eglSwapBuffers(m_display, m_surface); eglWaitGL(); } void EglWaylandBackend::screenGeometryChanged(const QSize &size) { Q_UNUSED(size) // no backend specific code needed // TODO: base implementation in OpenGLBackend } SceneOpenGL::TexturePrivate *EglWaylandBackend::createBackendTexture(SceneOpenGL::Texture *texture) { return new EglWaylandTexture(texture, this); } void EglWaylandBackend::prepareRenderingFrame() { if (!lastDamage().isEmpty()) present(); eglWaitNative(EGL_CORE_NATIVE_ENGINE); startRenderTimer(); } void EglWaylandBackend::endRenderingFrame(const QRegion &damage) { setLastDamage(damage); glFlush(); } Shm *EglWaylandBackend::shm() { if (m_shm.isNull()) { m_shm.reset(new Shm); } return m_shm.data(); } /************************************************ * EglTexture ************************************************/ EglWaylandTexture::EglWaylandTexture(KWin::SceneOpenGL::Texture *texture, KWin::EglWaylandBackend *backend) : SceneOpenGL::TexturePrivate() , q(texture) , m_backend(backend) , m_referencedPixmap(XCB_PIXMAP_NONE) { m_target = GL_TEXTURE_2D; } EglWaylandTexture::~EglWaylandTexture() { } OpenGLBackend *EglWaylandTexture::backend() { return m_backend; } void EglWaylandTexture::findTarget() { if (m_target != GL_TEXTURE_2D) { m_target = GL_TEXTURE_2D; } } bool EglWaylandTexture::loadTexture(const Pixmap &pix, const QSize &size, int depth) { // HACK: egl wayland platform doesn't support texture from X11 pixmap through the KHR_image_pixmap // extension. To circumvent this problem we copy the pixmap content into a SHM image and from there // to the OpenGL texture. This is a temporary solution. In future we won't need to get the content // from X11 pixmaps. That's what we have XWayland for to get the content into a nice Wayland buffer. Q_UNUSED(depth) if (pix == XCB_PIXMAP_NONE) return false; m_referencedPixmap = pix; Shm *shm = m_backend->shm(); if (!shm->isValid()) { return false; } xcb_shm_get_image_cookie_t cookie = xcb_shm_get_image_unchecked(connection(), pix, 0, 0, size.width(), size.height(), ~0, XCB_IMAGE_FORMAT_Z_PIXMAP, shm->segment(), 0); glGenTextures(1, &m_texture); q->setWrapMode(GL_CLAMP_TO_EDGE); q->setFilter(GL_LINEAR); q->bind(); ScopedCPointer image(xcb_shm_get_image_reply(connection(), cookie, NULL)); if (image.isNull()) { return false; } // TODO: other formats #ifndef KWIN_HAVE_OPENGLES glTexImage2D(m_target, 0, GL_RGBA8, size.width(), size.height(), 0, GL_BGRA, GL_UNSIGNED_BYTE, shm->buffer()); #endif q->unbind(); checkGLError("load texture"); q->setYInverted(true); m_size = size; updateMatrix(); return true; } bool EglWaylandTexture::update(const QRegion &damage) { if (m_referencedPixmap == XCB_PIXMAP_NONE) { return false; } Shm *shm = m_backend->shm(); if (!shm->isValid()) { return false; } // TODO: optimize by only updating the damaged areas const QRect &damagedRect = damage.boundingRect(); xcb_shm_get_image_cookie_t cookie = xcb_shm_get_image_unchecked(connection(), m_referencedPixmap, damagedRect.x(), damagedRect.y(), damagedRect.width(), damagedRect.height(), ~0, XCB_IMAGE_FORMAT_Z_PIXMAP, shm->segment(), 0); q->bind(); ScopedCPointer image(xcb_shm_get_image_reply(connection(), cookie, NULL)); if (image.isNull()) { return false; } // TODO: other formats #ifndef KWIN_HAVE_OPENGLES glTexSubImage2D(m_target, 0, damagedRect.x(), damagedRect.y(), damagedRect.width(), damagedRect.height(), GL_BGRA, GL_UNSIGNED_BYTE, shm->buffer()); #endif q->unbind(); checkGLError("update texture"); return true; } Shm::Shm() : m_shmId(-1) , m_buffer(NULL) , m_segment(XCB_NONE) , m_valid(false) { m_valid = init(); } Shm::~Shm() { if (m_valid) { xcb_shm_detach(connection(), m_segment); shmdt(m_buffer); } } bool Shm::init() { const xcb_query_extension_reply_t *ext = xcb_get_extension_data(connection(), &xcb_shm_id); if (!ext || !ext->present) { kDebug(1212) << "SHM extension not available"; return false; } ScopedCPointer version(xcb_shm_query_version_reply(connection(), xcb_shm_query_version_unchecked(connection()), NULL)); if (version.isNull()) { kDebug(1212) << "Failed to get SHM extension version information"; return false; } const int MAXSIZE = 4096 * 2048 * 4; // TODO check there are not larger windows m_shmId = shmget(IPC_PRIVATE, MAXSIZE, IPC_CREAT | 0600); if (m_shmId < 0) { kDebug(1212) << "Failed to allocate SHM segment"; return false; } m_buffer = shmat(m_shmId, NULL, 0 /*read/write*/); if (-1 == reinterpret_cast(m_buffer)) { kDebug(1212) << "Failed to attach SHM segment"; shmctl(m_shmId, IPC_RMID, NULL); return false; } shmctl(m_shmId, IPC_RMID, NULL); m_segment = xcb_generate_id(connection()); const xcb_void_cookie_t cookie = xcb_shm_attach_checked(connection(), m_segment, m_shmId, false); ScopedCPointer error(xcb_request_check(connection(), cookie)); if (!error.isNull()) { kDebug(1212) << "xcb_shm_attach error: " << error->error_code; shmdt(m_buffer); return false; } return true; } } // namespace