3 * Copyright (C) 2015 Matthew Waters <matthew@centricular.com>
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Library General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Library General Public License for more details.
15 * You should have received a copy of the GNU Library General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
18 * Boston, MA 02110-1301, USA.
27 #include <gst/video/video.h>
29 #include "gstqsgtexture.h"
31 #include <QtCore/QRunnable>
32 #include <QtGui/QGuiApplication>
33 #include <QtQuick/QQuickWindow>
34 #include <QtQuick/QSGSimpleTextureNode>
35 #include <qpa/qplatformnativeinterface.h>
37 #if GST_GL_HAVE_WINDOW_X11 && GST_GL_HAVE_PLATFORM_GLX && defined (HAVE_QT_X11)
39 #include <gst/gl/x11/gstgldisplay_x11.h>
40 #include <gst/gl/x11/gstglcontext_glx.h>
43 #if GST_GL_HAVE_WINDOW_WAYLAND && GST_GL_HAVE_PLATFORM_EGL && defined (HAVE_QT_WAYLAND)
44 #include <gst/gl/wayland/gstgldisplay_wayland.h>
47 #if GST_GL_HAVE_PLATFORM_EGL && defined (HAVE_QT_EGLFS)
48 #include <gst/gl/egl/gstgldisplay_egl.h>
49 #include <gst/gl/egl/gstglcontext_egl.h>
52 #if GST_GL_HAVE_WINDOW_COCOA && GST_GL_HAVE_PLATFORM_COCOA && defined (HAVE_QT_MAC)
53 #include <gst/gl/coaoa/gstgldisplay_cocoa.h>
57 * SECTION:gtkgstglwidget
58 * @short_description: a #GtkGLArea that renders GStreamer video #GstBuffers
59 * @see_also: #GtkGLArea, #GstBuffer
61 * #QtGLVideoItem is an #GtkWidget that renders GStreamer video buffers.
64 #define GST_CAT_DEFAULT qt_item_debug
65 GST_DEBUG_CATEGORY_STATIC (GST_CAT_DEFAULT);
67 #define GTK_GST_GL_WIDGET_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), \
68 GTK_TYPE_GST_GL_WIDGET, QtGLVideoItemPrivate))
70 #define DEFAULT_FORCE_ASPECT_RATIO TRUE
71 #define DEFAULT_PAR_N 0
72 #define DEFAULT_PAR_D 1
77 PROP_FORCE_ASPECT_RATIO,
78 PROP_PIXEL_ASPECT_RATIO,
81 struct _QtGLVideoItemPrivate
86 gboolean force_aspect_ratio;
98 GstGLDisplay *display;
99 QOpenGLContext *qt_context;
100 GstGLContext *other_context;
101 GstGLContext *context;
104 class InitializeSceneGraph : public QRunnable
107 InitializeSceneGraph(QtGLVideoItem *item);
111 QtGLVideoItem *item_;
114 InitializeSceneGraph::InitializeSceneGraph(QtGLVideoItem *item) :
119 void InitializeSceneGraph::run()
121 item_->onSceneGraphInitialized();
124 QtGLVideoItem::QtGLVideoItem()
126 QGuiApplication *app = static_cast<QGuiApplication *> (QCoreApplication::instance ());
127 static volatile gsize _debug;
129 g_assert (app != NULL);
131 if (g_once_init_enter (&_debug)) {
132 GST_DEBUG_CATEGORY_INIT (GST_CAT_DEFAULT, "qtglwidget", 0, "Qt GL Widget");
133 g_once_init_leave (&_debug, 1);
135 this->m_openGlContextInitialized = false;
136 this->setFlag (QQuickItem::ItemHasContents, true);
138 this->priv = g_new0 (QtGLVideoItemPrivate, 1);
140 this->priv->force_aspect_ratio = DEFAULT_FORCE_ASPECT_RATIO;
141 this->priv->par_n = DEFAULT_PAR_N;
142 this->priv->par_d = DEFAULT_PAR_D;
144 g_mutex_init (&this->priv->lock);
146 GST_INFO ("QGuiApplication::instance()->platformName() %s", app->platformName().toUtf8().data());
148 #if GST_GL_HAVE_WINDOW_X11 && defined (HAVE_QT_X11)
149 if (QString::fromUtf8 ("xcb") == app->platformName())
150 this->priv->display = (GstGLDisplay *)
151 gst_gl_display_x11_new_with_display (QX11Info::display ());
153 #if GST_GL_HAVE_WINDOW_WAYLAND && GST_GL_HAVE_PLATFORM_EGL && defined (HAVE_QT_WAYLAND)
154 if (QString::fromUtf8 ("wayland") == app->platformName()
155 || QString::fromUtf8 ("wayland-egl") == app->platformName()){
156 struct wl_display * wayland_display;
157 QPlatformNativeInterface *native =
158 QGuiApplication::platformNativeInterface();
159 wayland_display = (struct wl_display *)
160 native->nativeResourceForWindow("display", NULL);
161 this->priv->display = (GstGLDisplay *)
162 gst_gl_display_wayland_new_with_display (wayland_display);
165 #if GST_GL_HAVE_PLATFORM_EGL && GST_GL_HAVE_WINDOW_ANDROID
166 if (QString::fromUtf8 ("android") == app->platformName())
167 this->priv->display = (GstGLDisplay *) gst_gl_display_egl_new ();
168 #elif GST_GL_HAVE_PLATFORM_EGL && defined (HAVE_QT_EGLFS)
169 if (QString::fromUtf8("eglfs") == app->platformName())
170 this->priv->display = (GstGLDisplay *) gst_gl_display_egl_new ();
173 #if GST_GL_HAVE_WINDOW_COCOA && GST_GL_HAVE_PLATFORM_COCOA && defined (HAVE_QT_MAC)
174 if (QString::fromUtf8 ("cocoa") == app->platformName())
175 this->priv->display = (GstGLDisplay *) gst_gl_display_cocoa_new ();
177 #if GST_GL_HAVE_WINDOW_EAGL && GST_GL_HAVE_PLATFORM_EAGL && defined (HAVE_QT_IOS)
178 if (QString::fromUtf8 ("ios") == app->platformName())
179 this->priv->display = gst_gl_display_new ();
181 #if GST_GL_HAVE_WINDOW_WIN32 && GST_GL_HAVE_PLATFORM_WGL && defined (HAVE_QT_WIN32)
182 if (QString::fromUtf8 ("windows") == app->platformName())
183 this->priv->display = gst_gl_display_new ();
186 if (!this->priv->display)
187 this->priv->display = gst_gl_display_new ();
189 connect(this, SIGNAL(windowChanged(QQuickWindow*)), this,
190 SLOT(handleWindowChanged(QQuickWindow*)));
192 GST_DEBUG ("%p init Qt Video Item", this);
195 QtGLVideoItem::~QtGLVideoItem()
197 g_mutex_clear (&this->priv->lock);
198 if (this->priv->context)
199 gst_object_unref(this->priv->context);
200 if (this->priv->other_context)
201 gst_object_unref(this->priv->other_context);
207 QtGLVideoItem::setDAR(gint num, gint den)
209 this->priv->par_n = num;
210 this->priv->par_d = den;
214 QtGLVideoItem::getDAR(gint * num, gint * den)
217 *num = this->priv->par_n;
219 *den = this->priv->par_d;
223 QtGLVideoItem::setForceAspectRatio(bool force_aspect_ratio)
225 this->priv->force_aspect_ratio = !!force_aspect_ratio;
229 QtGLVideoItem::getForceAspectRatio()
231 return this->priv->force_aspect_ratio;
235 QtGLVideoItem::updatePaintNode(QSGNode * oldNode,
236 UpdatePaintNodeData * updatePaintNodeData)
238 if (!m_openGlContextInitialized) {
242 QSGSimpleTextureNode *texNode = static_cast<QSGSimpleTextureNode *> (oldNode);
243 GstVideoRectangle src, dst, result;
246 g_mutex_lock (&this->priv->lock);
247 gst_gl_context_activate (this->priv->other_context, TRUE);
249 GST_TRACE ("%p updatePaintNode", this);
251 if (!this->priv->caps) {
252 g_mutex_unlock (&this->priv->lock);
257 texNode = new QSGSimpleTextureNode ();
258 texNode->setOwnsTexture (true);
259 texNode->setTexture (new GstQSGTexture ());
262 tex = static_cast<GstQSGTexture *> (texNode->texture());
263 tex->setCaps (this->priv->caps);
264 tex->setBuffer (this->priv->buffer);
265 texNode->markDirty(QSGNode::DirtyMaterial);
267 if (this->priv->force_aspect_ratio) {
268 src.w = this->priv->display_width;
269 src.h = this->priv->display_height;
271 dst.x = boundingRect().x();
272 dst.y = boundingRect().y();
273 dst.w = boundingRect().width();
274 dst.h = boundingRect().height();
276 gst_video_sink_center_rect (src, dst, &result, TRUE);
278 result.x = boundingRect().x();
279 result.y = boundingRect().y();
280 result.w = boundingRect().width();
281 result.h = boundingRect().height();
284 texNode->setRect (QRectF (result.x, result.y, result.w, result.h));
286 gst_gl_context_activate (this->priv->other_context, FALSE);
287 g_mutex_unlock (&this->priv->lock);
293 _reset (QtGLVideoItem * qt_item)
295 gst_buffer_replace (&qt_item->priv->buffer, NULL);
297 gst_caps_replace (&qt_item->priv->caps, NULL);
299 qt_item->priv->negotiated = FALSE;
300 qt_item->priv->initted = FALSE;
304 qt_item_set_buffer (QtGLVideoItem * widget, GstBuffer * buffer)
306 g_return_if_fail (widget != NULL);
307 g_return_if_fail (widget->priv->negotiated);
309 g_mutex_lock (&widget->priv->lock);
311 gst_buffer_replace (&widget->priv->buffer, buffer);
313 QMetaObject::invokeMethod(widget, "update", Qt::QueuedConnection);
315 g_mutex_unlock (&widget->priv->lock);
319 QtGLVideoItem::onSceneGraphInitialized ()
321 GstGLPlatform platform = (GstGLPlatform) 0;
325 GST_DEBUG ("scene graph initialization with Qt GL context %p",
326 this->window()->openglContext ());
328 if (this->priv->qt_context == this->window()->openglContext ())
331 this->priv->qt_context = this->window()->openglContext ();
332 if (this->priv->qt_context == NULL) {
333 g_assert_not_reached ();
337 #if GST_GL_HAVE_WINDOW_X11 && defined (HAVE_QT_X11)
338 if (GST_IS_GL_DISPLAY_X11 (this->priv->display)) {
339 platform = GST_GL_PLATFORM_GLX;
342 #if GST_GL_HAVE_WINDOW_WAYLAND && defined (HAVE_QT_WAYLAND)
343 if (GST_IS_GL_DISPLAY_WAYLAND (this->priv->display)) {
344 platform = GST_GL_PLATFORM_EGL;
347 #if GST_GL_HAVE_PLATFORM_EGL && defined (HAVE_QT_EGLFS)
348 if (GST_IS_GL_DISPLAY_EGL (this->priv->display)) {
349 platform = GST_GL_PLATFORM_EGL;
352 if (platform == 0 && this->priv->display) {
353 #if GST_GL_HAVE_WINDOW_COCOA && GST_GL_HAVE_PLATFORM_COCOA && defined (HAVE_QT_MAC)
354 platform = GST_GL_PLATFORM_CGL;
355 #elif GST_GL_HAVE_WINDOW_EAGL && GST_GL_HAVE_PLATFORM_EAGL && defined (HAVE_QT_IOS)
356 platform = GST_GL_PLATFORM_EAGL;
357 #elif GST_GL_HAVE_WINDOW_WIN32 && GST_GL_HAVE_PLATFORM_WGL && defined (HAVE_QT_WIN32)
358 platform = GST_GL_PLATFORM_WGL;
360 GST_ERROR ("Unknown platform");
365 gl_api = gst_gl_context_get_current_gl_api (platform, NULL, NULL);
366 gl_handle = gst_gl_context_get_current_gl_context (platform);
368 this->priv->other_context =
369 gst_gl_context_new_wrapped (this->priv->display, gl_handle,
376 if (this->priv->other_context) {
377 GError *error = NULL;
379 gst_gl_context_activate (this->priv->other_context, TRUE);
380 if (!gst_gl_context_fill_info (this->priv->other_context, &error)) {
381 GST_ERROR ("%p failed to retrieve qt context info: %s", this, error->message);
382 g_object_unref (this->priv->other_context);
383 this->priv->other_context = NULL;
385 gst_gl_display_filter_gl_api (this->priv->display, gst_gl_context_get_gl_api (this->priv->other_context));
386 #if GST_GL_HAVE_WINDOW_WIN32 && GST_GL_HAVE_PLATFORM_WGL && defined (HAVE_QT_WIN32)
387 if (!wglGetProcAddress ("wglCreateContextAttribsARB")) {
391 /* If there's no wglCreateContextAttribsARB() support, then we would fallback to
392 * wglShareLists() which will fail with ERROR_BUSY (0xaa) if either of the GL
393 * contexts are current in any other thread.
395 * The workaround here is to temporarily disable Qt's GL context while we
398 this->priv->context = gst_gl_context_new (this->priv->display);
399 window = gst_gl_context_get_window (this->priv->context);
400 device = (HDC) gst_gl_window_get_display (window);
402 wglMakeCurrent (device, 0);
403 gst_object_unref (window);
404 if (!gst_gl_context_create (this->priv->context, this->priv->other_context, &error)) {
405 GST_ERROR ("%p failed to create shared GL context: %s", this, error->message);
406 g_object_unref (this->priv->context);
407 this->priv->context = NULL;
408 g_object_unref (this->priv->other_context);
409 this->priv->other_context = NULL;
410 wglMakeCurrent (device, (HGLRC) gl_handle);
413 wglMakeCurrent (device, (HGLRC) gl_handle);
416 gst_gl_context_activate (this->priv->other_context, FALSE);
417 m_openGlContextInitialized = true;
421 GST_DEBUG ("%p created wrapped GL context %" GST_PTR_FORMAT, this,
422 this->priv->other_context);
426 QtGLVideoItem::onSceneGraphInvalidated ()
428 GST_FIXME ("%p scene graph invalidated", this);
432 qt_item_init_winsys (QtGLVideoItem * widget)
434 GError *error = NULL;
436 g_return_val_if_fail (widget != NULL, FALSE);
438 g_mutex_lock (&widget->priv->lock);
440 if (widget->priv->display && widget->priv->qt_context
441 && widget->priv->other_context && widget->priv->context) {
442 /* already have the necessary state */
443 g_mutex_unlock (&widget->priv->lock);
447 if (!GST_IS_GL_DISPLAY (widget->priv->display)) {
448 GST_ERROR ("%p failed to retrieve display connection %" GST_PTR_FORMAT,
449 widget, widget->priv->display);
450 g_mutex_unlock (&widget->priv->lock);
454 if (!GST_IS_GL_CONTEXT (widget->priv->other_context)) {
455 GST_ERROR ("%p failed to retrieve wrapped context %" GST_PTR_FORMAT, widget,
456 widget->priv->other_context);
457 g_mutex_unlock (&widget->priv->lock);
461 widget->priv->context = gst_gl_context_new (widget->priv->display);
463 if (!widget->priv->context) {
464 g_mutex_unlock (&widget->priv->lock);
468 if (!gst_gl_context_create (widget->priv->context, widget->priv->other_context,
470 GST_ERROR ("%s", error->message);
471 g_mutex_unlock (&widget->priv->lock);
475 g_mutex_unlock (&widget->priv->lock);
480 QtGLVideoItem::handleWindowChanged(QQuickWindow *win)
483 if (win->isSceneGraphInitialized())
484 win->scheduleRenderJob(new InitializeSceneGraph(this), QQuickWindow::BeforeSynchronizingStage);
486 connect(win, SIGNAL(sceneGraphInitialized()), this, SLOT(onSceneGraphInitialized()), Qt::DirectConnection);
488 connect(win, SIGNAL(sceneGraphInvalidated()), this, SLOT(onSceneGraphInvalidated()), Qt::DirectConnection);
490 this->priv->qt_context = NULL;
495 _calculate_par (QtGLVideoItem * widget, GstVideoInfo * info)
500 gint display_par_n, display_par_d;
501 guint display_ratio_num, display_ratio_den;
503 width = GST_VIDEO_INFO_WIDTH (info);
504 height = GST_VIDEO_INFO_HEIGHT (info);
506 par_n = GST_VIDEO_INFO_PAR_N (info);
507 par_d = GST_VIDEO_INFO_PAR_D (info);
512 /* get display's PAR */
513 if (widget->priv->par_n != 0 && widget->priv->par_d != 0) {
514 display_par_n = widget->priv->par_n;
515 display_par_d = widget->priv->par_d;
521 ok = gst_video_calculate_display_ratio (&display_ratio_num,
522 &display_ratio_den, width, height, par_n, par_d, display_par_n,
528 GST_LOG ("PAR: %u/%u DAR:%u/%u", par_n, par_d, display_par_n, display_par_d);
530 if (height % display_ratio_den == 0) {
531 GST_DEBUG ("keeping video height");
532 widget->priv->display_width = (guint)
533 gst_util_uint64_scale_int (height, display_ratio_num,
535 widget->priv->display_height = height;
536 } else if (width % display_ratio_num == 0) {
537 GST_DEBUG ("keeping video width");
538 widget->priv->display_width = width;
539 widget->priv->display_height = (guint)
540 gst_util_uint64_scale_int (width, display_ratio_den, display_ratio_num);
542 GST_DEBUG ("approximating while keeping video height");
543 widget->priv->display_width = (guint)
544 gst_util_uint64_scale_int (height, display_ratio_num,
546 widget->priv->display_height = height;
548 GST_DEBUG ("scaling to %dx%d", widget->priv->display_width,
549 widget->priv->display_height);
555 qt_item_set_caps (QtGLVideoItem * widget, GstCaps * caps)
559 g_return_val_if_fail (widget != NULL, FALSE);
560 g_return_val_if_fail (GST_IS_CAPS (caps), FALSE);
561 g_return_val_if_fail (gst_caps_is_fixed (caps), FALSE);
563 if (widget->priv->caps && gst_caps_is_equal_fixed (widget->priv->caps, caps))
566 if (!gst_video_info_from_caps (&v_info, caps))
569 g_mutex_lock (&widget->priv->lock);
573 gst_caps_replace (&widget->priv->caps, caps);
575 if (!_calculate_par (widget, &v_info)) {
576 g_mutex_unlock (&widget->priv->lock);
580 widget->priv->v_info = v_info;
581 widget->priv->negotiated = TRUE;
583 g_mutex_unlock (&widget->priv->lock);
589 qt_item_get_qt_context (QtGLVideoItem * qt_item)
591 g_return_val_if_fail (qt_item != NULL, NULL);
593 if (!qt_item->priv->other_context)
596 return (GstGLContext *) gst_object_ref (qt_item->priv->other_context);
600 qt_item_get_context (QtGLVideoItem * qt_item)
602 g_return_val_if_fail (qt_item != NULL, NULL);
604 if (!qt_item->priv->context)
607 return (GstGLContext *) gst_object_ref (qt_item->priv->context);
611 qt_item_get_display (QtGLVideoItem * qt_item)
613 g_return_val_if_fail (qt_item != NULL, NULL);
615 if (!qt_item->priv->display)
618 return (GstGLDisplay *) gst_object_ref (qt_item->priv->display);