# -*- coding: utf-8 -*- # Copyright (c) 2015, Vispy Development Team. # Distributed under the (new) BSD License. See LICENSE.txt for more info. """ Base code for the Qt backends. Note that this is *not* (anymore) a backend by itself! One has to explicitly use either PySide, PyQt4 or PyQt5. Note that the automatic backend selection prefers a GUI toolkit that is already imported. The _pyside, _pyqt4 and _pyqt5 modules will import * from this module, and also keep a ref to the module object. Note that if two of the backends are used, this module is actually reloaded. This is a sorts of poor mans "subclassing" to get a working version for both backends using the same code. Note that it is strongly discouraged to use the PySide/PyQt4/PyQt5 backends simultaneously. It is known to cause unpredictable behavior and segfaults. """ from __future__ import division from time import sleep, time import os import sys import atexit import ctypes from ...util import logger from ..base import (BaseApplicationBackend, BaseCanvasBackend, BaseTimerBackend) from ...util import keys from ...ext.six import text_type from ... import config from . import qt_lib USE_EGL = config['gl_backend'].lower().startswith('es') # Get platform IS_LINUX = IS_OSX = IS_WIN = IS_RPI = False if sys.platform.startswith('linux'): if os.uname()[4].startswith('arm'): IS_RPI = True else: IS_LINUX = True elif sys.platform.startswith('darwin'): IS_OSX = True elif sys.platform.startswith('win'): IS_WIN = True # -------------------------------------------------------------------- init --- def _check_imports(lib): # Make sure no conflicting libraries have been imported. libs = ['PyQt4', 'PyQt5', 'PySide'] libs.remove(lib) for lib2 in libs: lib2 += '.QtCore' if lib2 in sys.modules: raise RuntimeError("Refusing to import %s because %s is already " "imported." % (lib, lib2)) # Get what qt lib to try. This tells us wheter this module is imported # via _pyside or _pyqt4 or _pyqt5 QGLWidget = object if qt_lib == 'pyqt4': _check_imports('PyQt4') if not USE_EGL: from PyQt4.QtOpenGL import QGLWidget, QGLFormat from PyQt4 import QtGui, QtCore QWidget, QApplication = QtGui.QWidget, QtGui.QApplication # Compat elif qt_lib == 'pyqt5': _check_imports('PyQt5') if not USE_EGL: from PyQt5.QtOpenGL import QGLWidget, QGLFormat from PyQt5 import QtGui, QtCore, QtWidgets QWidget, QApplication = QtWidgets.QWidget, QtWidgets.QApplication # Compat elif qt_lib == 'pyside': _check_imports('PySide') if not USE_EGL: from PySide.QtOpenGL import QGLWidget, QGLFormat from PySide import QtGui, QtCore QWidget, QApplication = QtGui.QWidget, QtGui.QApplication # Compat elif qt_lib: raise RuntimeError("Invalid value for qt_lib %r." % qt_lib) else: raise RuntimeError("Module backends._qt should not be imported directly.") # todo: add support for distinguishing left and right shift/ctrl/alt keys. # Linux scan codes: (left, right) # Shift 50, 62 # Ctrl 37, 105 # Alt 64, 108 KEYMAP = { QtCore.Qt.Key_Shift: keys.SHIFT, QtCore.Qt.Key_Control: keys.CONTROL, QtCore.Qt.Key_Alt: keys.ALT, QtCore.Qt.Key_AltGr: keys.ALT, QtCore.Qt.Key_Meta: keys.META, QtCore.Qt.Key_Left: keys.LEFT, QtCore.Qt.Key_Up: keys.UP, QtCore.Qt.Key_Right: keys.RIGHT, QtCore.Qt.Key_Down: keys.DOWN, QtCore.Qt.Key_PageUp: keys.PAGEUP, QtCore.Qt.Key_PageDown: keys.PAGEDOWN, QtCore.Qt.Key_Insert: keys.INSERT, QtCore.Qt.Key_Delete: keys.DELETE, QtCore.Qt.Key_Home: keys.HOME, QtCore.Qt.Key_End: keys.END, QtCore.Qt.Key_Escape: keys.ESCAPE, QtCore.Qt.Key_Backspace: keys.BACKSPACE, QtCore.Qt.Key_F1: keys.F1, QtCore.Qt.Key_F2: keys.F2, QtCore.Qt.Key_F3: keys.F3, QtCore.Qt.Key_F4: keys.F4, QtCore.Qt.Key_F5: keys.F5, QtCore.Qt.Key_F6: keys.F6, QtCore.Qt.Key_F7: keys.F7, QtCore.Qt.Key_F8: keys.F8, QtCore.Qt.Key_F9: keys.F9, QtCore.Qt.Key_F10: keys.F10, QtCore.Qt.Key_F11: keys.F11, QtCore.Qt.Key_F12: keys.F12, QtCore.Qt.Key_Space: keys.SPACE, QtCore.Qt.Key_Enter: keys.ENTER, QtCore.Qt.Key_Return: keys.ENTER, QtCore.Qt.Key_Tab: keys.TAB, } BUTTONMAP = {0: 0, 1: 1, 2: 2, 4: 3, 8: 4, 16: 5} # Properly log Qt messages # Also, ignore spam about tablet input def message_handler(msg_type, msg): if msg == ("QCocoaView handleTabletEvent: This tablet device is " "unknown (received no proximity event for it). Discarding " "event."): return else: logger.warning(msg) try: QtCore.qInstallMsgHandler(message_handler) except AttributeError: QtCore.qInstallMessageHandler(message_handler) # PyQt5 # -------------------------------------------------------------- capability --- capability = dict( # things that can be set by the backend title=True, size=True, position=True, show=True, vsync=True, resizable=True, decorate=True, fullscreen=True, context=True, multi_window=True, scroll=True, parent=True, always_on_top=True, ) # ------------------------------------------------------- set_configuration --- def _set_config(c): """Set the OpenGL configuration""" glformat = QGLFormat() glformat.setRedBufferSize(c['red_size']) glformat.setGreenBufferSize(c['green_size']) glformat.setBlueBufferSize(c['blue_size']) glformat.setAlphaBufferSize(c['alpha_size']) glformat.setAccum(False) glformat.setRgba(True) glformat.setDoubleBuffer(True if c['double_buffer'] else False) glformat.setDepth(True if c['depth_size'] else False) glformat.setDepthBufferSize(c['depth_size'] if c['depth_size'] else 0) glformat.setStencil(True if c['stencil_size'] else False) glformat.setStencilBufferSize(c['stencil_size'] if c['stencil_size'] else 0) glformat.setSampleBuffers(True if c['samples'] else False) glformat.setSamples(c['samples'] if c['samples'] else 0) glformat.setStereo(c['stereo']) return glformat # ------------------------------------------------------------- application --- class ApplicationBackend(BaseApplicationBackend): def __init__(self): BaseApplicationBackend.__init__(self) def _vispy_get_backend_name(self): name = QtCore.__name__.split('.')[0] return name def _vispy_process_events(self): app = self._vispy_get_native_app() app.flush() app.processEvents() def _vispy_run(self): app = self._vispy_get_native_app() if hasattr(app, '_in_event_loop') and app._in_event_loop: pass # Already in event loop else: return app.exec_() def _vispy_quit(self): return self._vispy_get_native_app().quit() def _vispy_get_native_app(self): # Get native app in save way. Taken from guisupport.py app = QApplication.instance() if app is None: app = QApplication(['']) # Store so it won't be deleted, but not on a vispy object, # or an application may produce error when closed. QtGui._qApp = app # Return return app # ------------------------------------------------------------------ canvas --- class QtBaseCanvasBackend(BaseCanvasBackend): """Base functionality of Qt backend. No OpenGL Stuff.""" # args are for BaseCanvasBackend, kwargs are for us. def __init__(self, *args, **kwargs): BaseCanvasBackend.__init__(self, *args) # Maybe to ensure that exactly all arguments are passed? p = self._process_backend_kwargs(kwargs) self._initialized = False # Init in desktop GL or EGL way self._init_specific(p, kwargs) assert self._initialized self.setMouseTracking(True) self._vispy_set_title(p.title) self._vispy_set_size(*p.size) if p.fullscreen is not False: if p.fullscreen is not True: logger.warning('Cannot specify monitor number for Qt ' 'fullscreen, using default') self._fullscreen = True else: self._fullscreen = False if not p.resizable: self.setFixedSize(self.size()) if p.position is not None: self._vispy_set_position(*p.position) if p.show: self._vispy_set_visible(True) # Qt supports OS double-click events, so we set this here to # avoid double events self._double_click_supported = True def _vispy_warmup(self): etime = time() + 0.25 while time() < etime: sleep(0.01) self._vispy_canvas.set_current() self._vispy_canvas.app.process_events() def _vispy_set_title(self, title): # Set the window title. Has no effect for widgets if self._vispy_canvas is None: return self.setWindowTitle(title) def _vispy_set_size(self, w, h): # Set size of the widget or window self.resize(w, h) def _vispy_set_position(self, x, y): # Set location of the widget or window. May have no effect for widgets self.move(x, y) def _vispy_set_visible(self, visible): # Show or hide the window or widget if visible: if self._fullscreen: self.showFullScreen() else: self.showNormal() else: self.hide() def _vispy_set_fullscreen(self, fullscreen): self._fullscreen = bool(fullscreen) self._vispy_set_visible(True) def _vispy_get_fullscreen(self): return self._fullscreen def _vispy_update(self): if self._vispy_canvas is None: return # Invoke a redraw self.update() def _vispy_get_position(self): g = self.geometry() return g.x(), g.y() def _vispy_get_size(self): g = self.geometry() return g.width(), g.height() def sizeHint(self): return self.size() def mousePressEvent(self, ev): if self._vispy_canvas is None: return self._vispy_mouse_press( native=ev, pos=(ev.pos().x(), ev.pos().y()), button=BUTTONMAP.get(ev.button(), 0), modifiers=self._modifiers(ev), ) def mouseReleaseEvent(self, ev): if self._vispy_canvas is None: return self._vispy_mouse_release( native=ev, pos=(ev.pos().x(), ev.pos().y()), button=BUTTONMAP[ev.button()], modifiers=self._modifiers(ev), ) def mouseDoubleClickEvent(self, ev): if self._vispy_canvas is None: return self._vispy_mouse_double_click( native=ev, pos=(ev.pos().x(), ev.pos().y()), button=BUTTONMAP.get(ev.button(), 0), modifiers=self._modifiers(ev), ) def mouseMoveEvent(self, ev): if self._vispy_canvas is None: return self._vispy_mouse_move( native=ev, pos=(ev.pos().x(), ev.pos().y()), modifiers=self._modifiers(ev), ) def wheelEvent(self, ev): if self._vispy_canvas is None: return # Get scrolling deltax, deltay = 0.0, 0.0 if hasattr(ev, 'orientation'): if ev.orientation == QtCore.Qt.Horizontal: deltax = ev.delta() / 120.0 else: deltay = ev.delta() / 120.0 else: # PyQt5 delta = ev.angleDelta() deltax, deltay = delta.x() / 120.0, delta.y() / 120.0 # Emit event self._vispy_canvas.events.mouse_wheel( native=ev, delta=(deltax, deltay), pos=(ev.pos().x(), ev.pos().y()), modifiers=self._modifiers(ev), ) def keyPressEvent(self, ev): self._keyEvent(self._vispy_canvas.events.key_press, ev) def keyReleaseEvent(self, ev): self._keyEvent(self._vispy_canvas.events.key_release, ev) def _keyEvent(self, func, ev): # evaluates the keycode of qt, and transform to vispy key. key = int(ev.key()) if key in KEYMAP: key = KEYMAP[key] elif key >= 32 and key <= 127: key = keys.Key(chr(key)) else: key = None mod = self._modifiers(ev) func(native=ev, key=key, text=text_type(ev.text()), modifiers=mod) def _modifiers(self, event): # Convert the QT modifier state into a tuple of active modifier keys. mod = () qtmod = event.modifiers() for q, v in ([QtCore.Qt.ShiftModifier, keys.SHIFT], [QtCore.Qt.ControlModifier, keys.CONTROL], [QtCore.Qt.AltModifier, keys.ALT], [QtCore.Qt.MetaModifier, keys.META]): if q & qtmod: mod += (v,) return mod _EGL_DISPLAY = None egl = None # todo: Make work on Windows # todo: Make work without readpixels on Linux? # todo: Make work on OSX? # todo: Make work on Raspberry Pi! class CanvasBackendEgl(QtBaseCanvasBackend, QWidget): def _init_specific(self, p, kwargs): # Initialize egl. Note that we only import egl if needed. global _EGL_DISPLAY global egl if egl is None: from ...ext import egl as _egl egl = _egl # Use MESA driver on Linux if IS_LINUX and not IS_RPI: os.environ['EGL_SOFTWARE'] = 'true' # Create and init display _EGL_DISPLAY = egl.eglGetDisplay() CanvasBackendEgl._EGL_VERSION = egl.eglInitialize(_EGL_DISPLAY) atexit.register(egl.eglTerminate, _EGL_DISPLAY) # Deal with context p.context.shared.add_ref('qt-egl', self) if p.context.shared.ref is self: self._native_config = c = egl.eglChooseConfig(_EGL_DISPLAY)[0] self._native_context = egl.eglCreateContext(_EGL_DISPLAY, c, None) else: self._native_config = p.context.shared.ref._native_config self._native_context = p.context.shared.ref._native_context # Init widget if p.always_on_top or not p.decorate: hint = 0 hint |= 0 if p.decorate else QtCore.Qt.FramelessWindowHint hint |= QtCore.Qt.WindowStaysOnTopHint if p.always_on_top else 0 else: hint = QtCore.Qt.Widget # can also be a window type QWidget.__init__(self, p.parent, hint) if 0: # IS_LINUX or IS_RPI: self.setAutoFillBackground(False) self.setAttribute(QtCore.Qt.WA_NoSystemBackground, True) self.setAttribute(QtCore.Qt.WA_OpaquePaintEvent, True) elif IS_WIN: self.setAttribute(QtCore.Qt.WA_PaintOnScreen, True) self.setAutoFillBackground(False) # Init surface w = self.get_window_id() self._surface = egl.eglCreateWindowSurface(_EGL_DISPLAY, c, w) self.initializeGL() self._initialized = True def get_window_id(self): """ Get the window id of a PySide Widget. Might also work for PyQt4. """ # Get Qt win id winid = self.winId() # On Linux this is it if IS_RPI: nw = (ctypes.c_int * 3)(winid, self.width(), self.height()) return ctypes.pointer(nw) elif IS_LINUX: return int(winid) # Is int on PySide, but sip.voidptr on PyQt # Get window id from stupid capsule thingy # http://translate.google.com/translate?hl=en&sl=zh-CN&u=http://www.cnb #logs.com/Shiren-Y/archive/2011/04/06/2007288.html&prev=/search%3Fq%3Dp # yside%2Bdirectx%26client%3Dfirefox-a%26hs%3DIsJ%26rls%3Dorg.mozilla:n #l:official%26channel%3Dfflb%26biw%3D1366%26bih%3D614 # Prepare ctypes.pythonapi.PyCapsule_GetName.restype = ctypes.c_char_p ctypes.pythonapi.PyCapsule_GetName.argtypes = [ctypes.py_object] ctypes.pythonapi.PyCapsule_GetPointer.restype = ctypes.c_void_p ctypes.pythonapi.PyCapsule_GetPointer.argtypes = [ctypes.py_object, ctypes.c_char_p] # Extract handle from capsule thingy name = ctypes.pythonapi.PyCapsule_GetName(winid) handle = ctypes.pythonapi.PyCapsule_GetPointer(winid, name) return handle def _vispy_close(self): # Destroy EGL surface if self._surface is not None: egl.eglDestroySurface(_EGL_DISPLAY, self._surface) self._surface = None # Force the window or widget to shut down self.close() def _vispy_set_current(self): egl.eglMakeCurrent(_EGL_DISPLAY, self._surface, self._surface, self._native_context) def _vispy_swap_buffers(self): egl.eglSwapBuffers(_EGL_DISPLAY, self._surface) def initializeGL(self): self._vispy_canvas.set_current() self._vispy_canvas.events.initialize() def resizeEvent(self, event): w, h = event.size().width(), event.size().height() self._vispy_canvas.events.resize(size=(w, h)) def paintEvent(self, event): self._vispy_canvas.events.draw(region=None) if IS_LINUX or IS_RPI: # Arg, cannot get GL to draw to the widget, so we take a # screenshot and draw that for now ... # Further, QImage keeps a ref to the data that we pass, so # we need to use a static buffer to prevent memory leakage from vispy import gloo import numpy as np if not hasattr(self, '_gl_buffer'): self._gl_buffer = np.ones((3000 * 3000 * 4), np.uint8) * 255 # Take screenshot and turn into RGB QImage im = gloo.read_pixels() sze = im.shape[0] * im.shape[1] self._gl_buffer[0:0+sze*4:4] = im[:, :, 2].ravel() self._gl_buffer[1:0+sze*4:4] = im[:, :, 1].ravel() self._gl_buffer[2:2+sze*4:4] = im[:, :, 0].ravel() img = QtGui.QImage(self._gl_buffer, im.shape[1], im.shape[0], QtGui.QImage.Format_RGB32) # Paint the image painter = QtGui.QPainter() painter.begin(self) rect = QtCore.QRect(0, 0, self.width(), self.height()) painter.drawImage(rect, img) painter.end() def paintEngine(self): if IS_LINUX and not IS_RPI: # For now we are drawing a screenshot return QWidget.paintEngine(self) else: return None # Disable Qt's native drawing system class CanvasBackendDesktop(QtBaseCanvasBackend, QGLWidget): def _init_specific(self, p, kwargs): # Deal with config glformat = _set_config(p.context.config) glformat.setSwapInterval(1 if p.vsync else 0) # Deal with context widget = kwargs.pop('shareWidget', None) or self p.context.shared.add_ref('qt', widget) if p.context.shared.ref is widget: if widget is self: widget = None # QGLWidget does not accept self ;) else: widget = p.context.shared.ref if 'shareWidget' in kwargs: raise RuntimeError('Cannot use vispy to share context and ' 'use built-in shareWidget.') # first arg can be glformat, or a gl context if p.always_on_top or not p.decorate: hint = 0 hint |= 0 if p.decorate else QtCore.Qt.FramelessWindowHint hint |= QtCore.Qt.WindowStaysOnTopHint if p.always_on_top else 0 else: hint = QtCore.Qt.Widget # can also be a window type QGLWidget.__init__(self, glformat, p.parent, widget, hint) self._initialized = True if not self.isValid(): raise RuntimeError('context could not be created') self.setAutoBufferSwap(False) # to make consistent with other backends self.setFocusPolicy(QtCore.Qt.WheelFocus) def _vispy_close(self): # Force the window or widget to shut down self.close() self.doneCurrent() self.context().reset() def _vispy_set_current(self): if self._vispy_canvas is None: return # todo: can we get rid of this now? if self.isValid(): self.makeCurrent() def _vispy_swap_buffers(self): # Swap front and back buffer if self._vispy_canvas is None: return self.swapBuffers() def initializeGL(self): if self._vispy_canvas is None: return self._vispy_canvas.events.initialize() def resizeGL(self, w, h): if self._vispy_canvas is None: return self._vispy_canvas.events.resize(size=(w, h)) def paintGL(self): if self._vispy_canvas is None: return # (0, 0, self.width(), self.height())) self._vispy_canvas.set_current() self._vispy_canvas.events.draw(region=None) # Select CanvasBackend if USE_EGL: CanvasBackend = CanvasBackendEgl else: CanvasBackend = CanvasBackendDesktop # ------------------------------------------------------------------- timer --- class TimerBackend(BaseTimerBackend, QtCore.QTimer): def __init__(self, vispy_timer): # Make sure there is an app app = ApplicationBackend() app._vispy_get_native_app() # Init BaseTimerBackend.__init__(self, vispy_timer) QtCore.QTimer.__init__(self) self.timeout.connect(self._vispy_timeout) def _vispy_start(self, interval): self.start(interval * 1000.) def _vispy_stop(self): self.stop() def _vispy_timeout(self): self._vispy_timer._timeout()