ext/gtk/gtkgstglwidget.c

   1 /*
   2  * GStreamer
   3  * Copyright (C) 2015 Matthew Waters <matthew@centricular.com>
   4  *
   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.
   9  *
  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.
  14  *
  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.
  19  */
  20
  21 #ifdef HAVE_CONFIG_H
  22 #include "config.h"
  23 #endif
  24
  25 #include <stdio.h>
  26
  27 #include "gtkgstglwidget.h"
  28 #include "gstgtkutils.h"
  29 #include <gst/gl/gstglfuncs.h>
  30 #include <gst/video/video.h>
  31
  32 #if GST_GL_HAVE_WINDOW_X11 && GST_GL_HAVE_PLATFORM_GLX && defined (GDK_WINDOWING_X11)
  33 #include <gdk/gdkx.h>
  34 #include <gst/gl/x11/gstgldisplay_x11.h>
  35 #endif
  36
  37 #if GST_GL_HAVE_WINDOW_WAYLAND && GST_GL_HAVE_PLATFORM_EGL && defined (GDK_WINDOWING_WAYLAND)
  38 #include <gdk/gdkwayland.h>
  39 #include <gst/gl/wayland/gstgldisplay_wayland.h>
  40 #endif
  41
  42 /**
  43  * SECTION:gtkgstglwidget
  44  * @title: GtkGstGlWidget
  45  * @short_description: a #GtkGLArea that renders GStreamer video #GstBuffers
  46  * @see_also: #GtkGLArea, #GstBuffer
  47  *
  48  * #GtkGstGLWidget is an #GtkWidget that renders GStreamer video buffers.
  49  */
  50
  51 #define GST_CAT_DEFAULT gtk_gst_gl_widget_debug
  52 GST_DEBUG_CATEGORY_STATIC (GST_CAT_DEFAULT);
  53
  54 struct _GtkGstGLWidgetPrivate
  55 {
  56   gboolean initted;
  57   GstGLDisplay *display;
  58   GdkGLContext *gdk_context;
  59   GstGLContext *other_context;
  60   GstGLContext *context;
  61   GstGLUpload *upload;
  62   GstGLShader *shader;
  63   GLuint vao;
  64   GLuint vertex_buffer;
  65   GLint attr_position;
  66   GLint attr_texture;
  67   GLuint current_tex;
  68   GstGLOverlayCompositor *overlay_compositor;
  69 };
  70
  71 static const GLfloat vertices[] = {
  72   1.0f, 1.0f, 0.0f, 1.0f, 0.0f,
  73   -1.0f, 1.0f, 0.0f, 0.0f, 0.0f,
  74   -1.0f, -1.0f, 0.0f, 0.0f, 1.0f,
  75   1.0f, -1.0f, 0.0f, 1.0f, 1.0f
  76 };
  77
  78 G_DEFINE_TYPE_WITH_CODE (GtkGstGLWidget, gtk_gst_gl_widget, GTK_TYPE_GL_AREA,
  79     G_ADD_PRIVATE (GtkGstGLWidget)
  80     GST_DEBUG_CATEGORY_INIT (GST_CAT_DEFAULT, "gtkgstglwidget", 0,
  81         "Gtk Gst GL Widget"););
  82
  83 static void
  84 gtk_gst_gl_widget_bind_buffer (GtkGstGLWidget * gst_widget)
  85 {
  86   GtkGstGLWidgetPrivate *priv = gst_widget->priv;
  87   const GstGLFuncs *gl = priv->context->gl_vtable;
  88
  89   gl->BindBuffer (GL_ARRAY_BUFFER, priv->vertex_buffer);
  90
  91   /* Load the vertex position */
  92   gl->VertexAttribPointer (priv->attr_position, 3, GL_FLOAT, GL_FALSE,
  93       5 * sizeof (GLfloat), (void *) 0);
  94
  95   /* Load the texture coordinate */
  96   gl->VertexAttribPointer (priv->attr_texture, 2, GL_FLOAT, GL_FALSE,
  97       5 * sizeof (GLfloat), (void *) (3 * sizeof (GLfloat)));
  98
  99   gl->EnableVertexAttribArray (priv->attr_position);
 100   gl->EnableVertexAttribArray (priv->attr_texture);
 101 }
 102
 103 static void
 104 gtk_gst_gl_widget_unbind_buffer (GtkGstGLWidget * gst_widget)
 105 {
 106   GtkGstGLWidgetPrivate *priv = gst_widget->priv;
 107   const GstGLFuncs *gl = priv->context->gl_vtable;
 108
 109   gl->BindBuffer (GL_ARRAY_BUFFER, 0);
 110
 111   gl->DisableVertexAttribArray (priv->attr_position);
 112   gl->DisableVertexAttribArray (priv->attr_texture);
 113 }
 114
 115 static void
 116 gtk_gst_gl_widget_init_redisplay (GtkGstGLWidget * gst_widget)
 117 {
 118   GtkGstGLWidgetPrivate *priv = gst_widget->priv;
 119   const GstGLFuncs *gl = priv->context->gl_vtable;
 120   GError *error = NULL;
 121
 122   gst_gl_insert_debug_marker (priv->other_context, "initializing redisplay");
 123   if (!(priv->shader = gst_gl_shader_new_default (priv->context, &error))) {
 124     GST_ERROR ("Failed to initialize shader: %s", error->message);
 125     return;
 126   }
 127
 128   priv->attr_position =
 129       gst_gl_shader_get_attribute_location (priv->shader, "a_position");
 130   priv->attr_texture =
 131       gst_gl_shader_get_attribute_location (priv->shader, "a_texcoord");
 132
 133   if (gl->GenVertexArrays) {
 134     gl->GenVertexArrays (1, &priv->vao);
 135     gl->BindVertexArray (priv->vao);
 136   }
 137
 138   gl->GenBuffers (1, &priv->vertex_buffer);
 139   gl->BindBuffer (GL_ARRAY_BUFFER, priv->vertex_buffer);
 140   gl->BufferData (GL_ARRAY_BUFFER, 4 * 5 * sizeof (GLfloat), vertices,
 141       GL_STATIC_DRAW);
 142
 143   if (gl->GenVertexArrays) {
 144     gtk_gst_gl_widget_bind_buffer (gst_widget);
 145     gl->BindVertexArray (0);
 146   }
 147
 148   gl->BindBuffer (GL_ARRAY_BUFFER, 0);
 149
 150   priv->overlay_compositor =
 151       gst_gl_overlay_compositor_new (priv->other_context);
 152
 153   priv->initted = TRUE;
 154 }
 155
 156 static void
 157 _redraw_texture (GtkGstGLWidget * gst_widget, guint tex)
 158 {
 159   GtkGstGLWidgetPrivate *priv = gst_widget->priv;
 160   const GstGLFuncs *gl = priv->context->gl_vtable;
 161   const GLushort indices[] = { 0, 1, 2, 0, 2, 3 };
 162
 163   if (gst_widget->base.force_aspect_ratio) {
 164     GstVideoRectangle src, dst, result;
 165     gint widget_width, widget_height, widget_scale;
 166
 167     gl->ClearColor (0.0, 0.0, 0.0, 0.0);
 168     gl->Clear (GL_COLOR_BUFFER_BIT);
 169
 170     widget_scale = gtk_widget_get_scale_factor ((GtkWidget *) gst_widget);
 171     widget_width = gtk_widget_get_allocated_width ((GtkWidget *) gst_widget);
 172     widget_height = gtk_widget_get_allocated_height ((GtkWidget *) gst_widget);
 173
 174     src.x = 0;
 175     src.y = 0;
 176     src.w = gst_widget->base.display_width;
 177     src.h = gst_widget->base.display_height;
 178
 179     dst.x = 0;
 180     dst.y = 0;
 181     dst.w = widget_width * widget_scale;
 182     dst.h = widget_height * widget_scale;
 183
 184     gst_video_sink_center_rect (src, dst, &result, TRUE);
 185
 186     gl->Viewport (result.x, result.y, result.w, result.h);
 187   }
 188
 189   gst_gl_shader_use (priv->shader);
 190
 191   if (gl->BindVertexArray)
 192     gl->BindVertexArray (priv->vao);
 193   gtk_gst_gl_widget_bind_buffer (gst_widget);
 194
 195   gl->ActiveTexture (GL_TEXTURE0);
 196   gl->BindTexture (GL_TEXTURE_2D, tex);
 197   gst_gl_shader_set_uniform_1i (priv->shader, "tex", 0);
 198
 199   gl->DrawElements (GL_TRIANGLES, 6, GL_UNSIGNED_SHORT, indices);
 200
 201   if (gl->BindVertexArray)
 202     gl->BindVertexArray (0);
 203   gtk_gst_gl_widget_unbind_buffer (gst_widget);
 204
 205   gl->BindTexture (GL_TEXTURE_2D, 0);
 206 }
 207
 208 static inline void
 209 _draw_black (GstGLContext * context)
 210 {
 211   const GstGLFuncs *gl = context->gl_vtable;
 212
 213   gst_gl_insert_debug_marker (context, "no buffer.  rendering black");
 214   gl->ClearColor (0.0, 0.0, 0.0, 0.0);
 215   gl->Clear (GL_COLOR_BUFFER_BIT);
 216 }
 217
 218 static gboolean
 219 gtk_gst_gl_widget_render (GtkGLArea * widget, GdkGLContext * context)
 220 {
 221   GtkGstGLWidgetPrivate *priv = GTK_GST_GL_WIDGET (widget)->priv;
 222   GtkGstBaseWidget *base_widget = GTK_GST_BASE_WIDGET (widget);
 223
 224   GTK_GST_BASE_WIDGET_LOCK (widget);
 225
 226   if (!priv->context || !priv->other_context)
 227     goto done;
 228
 229   gst_gl_context_activate (priv->other_context, TRUE);
 230
 231   if (!priv->initted)
 232     gtk_gst_gl_widget_init_redisplay (GTK_GST_GL_WIDGET (widget));
 233
 234   if (!priv->initted || !base_widget->negotiated) {
 235     _draw_black (priv->other_context);
 236     goto done;
 237   }
 238
 239   /* Upload latest buffer */
 240   if (base_widget->pending_buffer) {
 241     GstBuffer *buffer = base_widget->pending_buffer;
 242     GstVideoFrame gl_frame;
 243     GstGLSyncMeta *sync_meta;
 244
 245     if (!gst_video_frame_map (&gl_frame, &base_widget->v_info, buffer,
 246             GST_MAP_READ | GST_MAP_GL)) {
 247       _draw_black (priv->other_context);
 248       goto done;
 249     }
 250
 251     priv->current_tex = *(guint *) gl_frame.data[0];
 252     gst_gl_insert_debug_marker (priv->other_context, "redrawing texture %u",
 253         priv->current_tex);
 254
 255     gst_gl_overlay_compositor_upload_overlays (priv->overlay_compositor,
 256         buffer);
 257
 258     sync_meta = gst_buffer_get_gl_sync_meta (buffer);
 259     if (sync_meta) {
 260       /* XXX: the set_sync() seems to be needed for resizing */
 261       gst_gl_sync_meta_set_sync_point (sync_meta, priv->context);
 262       gst_gl_sync_meta_wait (sync_meta, priv->other_context);
 263     }
 264
 265     gst_video_frame_unmap (&gl_frame);
 266
 267     if (base_widget->buffer)
 268       gst_buffer_unref (base_widget->buffer);
 269
 270     /* Keep the buffer to ensure current_tex stay valid */
 271     base_widget->buffer = buffer;
 272     base_widget->pending_buffer = NULL;
 273   }
 274
 275   GST_DEBUG ("rendering buffer %p with gdk context %p",
 276       base_widget->buffer, context);
 277
 278   _redraw_texture (GTK_GST_GL_WIDGET (widget), priv->current_tex);
 279   gst_gl_overlay_compositor_draw_overlays (priv->overlay_compositor);
 280
 281   gst_gl_insert_debug_marker (priv->other_context, "texture %u redrawn",
 282       priv->current_tex);
 283
 284 done:
 285   if (priv->other_context)
 286     gst_gl_context_activate (priv->other_context, FALSE);
 287
 288   GTK_GST_BASE_WIDGET_UNLOCK (widget);
 289   return FALSE;
 290 }
 291
 292 static void
 293 _reset_gl (GtkGstGLWidget * gst_widget)
 294 {
 295   GtkGstGLWidgetPrivate *priv = gst_widget->priv;
 296   const GstGLFuncs *gl = priv->other_context->gl_vtable;
 297
 298   if (!priv->gdk_context)
 299     priv->gdk_context = gtk_gl_area_get_context (GTK_GL_AREA (gst_widget));
 300
 301   if (priv->gdk_context == NULL)
 302     return;
 303
 304   gdk_gl_context_make_current (priv->gdk_context);
 305   gst_gl_context_activate (priv->other_context, TRUE);
 306
 307   if (priv->vao) {
 308     gl->DeleteVertexArrays (1, &priv->vao);
 309     priv->vao = 0;
 310   }
 311
 312   if (priv->vertex_buffer) {
 313     gl->DeleteBuffers (1, &priv->vertex_buffer);
 314     priv->vertex_buffer = 0;
 315   }
 316
 317   if (priv->upload) {
 318     gst_object_unref (priv->upload);
 319     priv->upload = NULL;
 320   }
 321
 322   if (priv->shader) {
 323     gst_object_unref (priv->shader);
 324     priv->shader = NULL;
 325   }
 326
 327   if (priv->overlay_compositor)
 328     gst_object_unref (priv->overlay_compositor);
 329
 330   gst_gl_context_activate (priv->other_context, FALSE);
 331
 332   gst_object_unref (priv->other_context);
 333   priv->other_context = NULL;
 334
 335   gdk_gl_context_clear_current ();
 336
 337   g_object_unref (priv->gdk_context);
 338   priv->gdk_context = NULL;
 339 }
 340
 341 static void
 342 gtk_gst_gl_widget_finalize (GObject * object)
 343 {
 344   GtkGstGLWidgetPrivate *priv = GTK_GST_GL_WIDGET (object)->priv;
 345   GtkGstBaseWidget *base_widget = GTK_GST_BASE_WIDGET (object);
 346
 347   if (priv->other_context)
 348     gst_gtk_invoke_on_main ((GThreadFunc) _reset_gl, base_widget);
 349
 350   if (priv->context)
 351     gst_object_unref (priv->context);
 352
 353   if (priv->display)
 354     gst_object_unref (priv->display);
 355
 356   gtk_gst_base_widget_finalize (object);
 357   G_OBJECT_CLASS (gtk_gst_gl_widget_parent_class)->finalize (object);
 358 }
 359
 360 static void
 361 gtk_gst_gl_widget_class_init (GtkGstGLWidgetClass * klass)
 362 {
 363   GObjectClass *gobject_klass = (GObjectClass *) klass;
 364   GtkGLAreaClass *gl_widget_klass = (GtkGLAreaClass *) klass;
 365
 366   gtk_gst_base_widget_class_init (GTK_GST_BASE_WIDGET_CLASS (klass));
 367
 368   gobject_klass->finalize = gtk_gst_gl_widget_finalize;
 369   gl_widget_klass->render = gtk_gst_gl_widget_render;
 370 }
 371
 372 static void
 373 gtk_gst_gl_widget_init (GtkGstGLWidget * gst_widget)
 374 {
 375   GtkGstBaseWidget *base_widget = GTK_GST_BASE_WIDGET (gst_widget);
 376   GdkDisplay *display;
 377   GtkGstGLWidgetPrivate *priv;
 378
 379   gtk_gst_base_widget_init (base_widget);
 380
 381   gst_widget->priv = priv = gtk_gst_gl_widget_get_instance_private (gst_widget);
 382
 383   display = gdk_display_get_default ();
 384
 385 #if GST_GL_HAVE_WINDOW_X11 && GST_GL_HAVE_PLATFORM_GLX && defined (GDK_WINDOWING_X11)
 386   if (GDK_IS_X11_DISPLAY (display))
 387     priv->display = (GstGLDisplay *)
 388         gst_gl_display_x11_new_with_display (gdk_x11_display_get_xdisplay
 389         (display));
 390 #endif
 391 #if GST_GL_HAVE_WINDOW_WAYLAND && GST_GL_HAVE_PLATFORM_EGL && defined (GDK_WINDOWING_WAYLAND)
 392   if (GDK_IS_WAYLAND_DISPLAY (display)) {
 393     struct wl_display *wayland_display =
 394         gdk_wayland_display_get_wl_display (display);
 395     priv->display = (GstGLDisplay *)
 396         gst_gl_display_wayland_new_with_display (wayland_display);
 397   }
 398 #endif
 399
 400   (void) display;
 401
 402   if (!priv->display)
 403     priv->display = gst_gl_display_new ();
 404
 405   gtk_gl_area_set_has_alpha (GTK_GL_AREA (gst_widget),
 406       !base_widget->ignore_alpha);
 407 }
 408
 409 static void
 410 _get_gl_context (GtkGstGLWidget * gst_widget)
 411 {
 412   GtkGstGLWidgetPrivate *priv = gst_widget->priv;
 413   GstGLPlatform platform;
 414   GstGLAPI gl_api;
 415   guintptr gl_handle;
 416
 417   gtk_widget_realize (GTK_WIDGET (gst_widget));
 418
 419   if (priv->other_context)
 420     gst_object_unref (priv->other_context);
 421   priv->other_context = NULL;
 422
 423   if (priv->gdk_context)
 424     g_object_unref (priv->gdk_context);
 425
 426   priv->gdk_context = gtk_gl_area_get_context (GTK_GL_AREA (gst_widget));
 427   if (priv->gdk_context == NULL) {
 428     GError *error = gtk_gl_area_get_error (GTK_GL_AREA (gst_widget));
 429
 430     GST_ERROR_OBJECT (gst_widget, "Error creating GdkGLContext : %s",
 431         error ? error->message : "No error set by Gdk");
 432     g_clear_error (&error);
 433     return;
 434   }
 435
 436   g_object_ref (priv->gdk_context);
 437
 438   gdk_gl_context_make_current (priv->gdk_context);
 439
 440 #if GST_GL_HAVE_WINDOW_X11 && GST_GL_HAVE_PLATFORM_GLX && defined (GDK_WINDOWING_X11)
 441   if (GST_IS_GL_DISPLAY_X11 (priv->display)) {
 442     platform = GST_GL_PLATFORM_GLX;
 443     gl_api = gst_gl_context_get_current_gl_api (platform, NULL, NULL);
 444     gl_handle = gst_gl_context_get_current_gl_context (platform);
 445     if (gl_handle)
 446       priv->other_context =
 447           gst_gl_context_new_wrapped (priv->display, gl_handle,
 448           platform, gl_api);
 449   }
 450 #endif
 451 #if GST_GL_HAVE_WINDOW_WAYLAND && GST_GL_HAVE_PLATFORM_EGL && defined (GDK_WINDOWING_WAYLAND)
 452   if (GST_IS_GL_DISPLAY_WAYLAND (priv->display)) {
 453     platform = GST_GL_PLATFORM_EGL;
 454     gl_api = gst_gl_context_get_current_gl_api (platform, NULL, NULL);
 455     gl_handle = gst_gl_context_get_current_gl_context (platform);
 456     if (gl_handle)
 457       priv->other_context =
 458           gst_gl_context_new_wrapped (priv->display, gl_handle,
 459           platform, gl_api);
 460   }
 461 #endif
 462
 463   (void) platform;
 464   (void) gl_api;
 465   (void) gl_handle;
 466
 467   if (priv->other_context) {
 468     GError *error = NULL;
 469
 470     gst_gl_context_activate (priv->other_context, TRUE);
 471     if (!gst_gl_context_fill_info (priv->other_context, &error)) {
 472       GST_ERROR ("failed to retrieve gdk context info: %s", error->message);
 473       g_clear_error (&error);
 474       g_object_unref (priv->other_context);
 475       priv->other_context = NULL;
 476     } else {
 477       gst_gl_context_activate (priv->other_context, FALSE);
 478     }
 479   }
 480 }
 481
 482 GtkWidget *
 483 gtk_gst_gl_widget_new (void)
 484 {
 485   return (GtkWidget *) g_object_new (GTK_TYPE_GST_GL_WIDGET, NULL);
 486 }
 487
 488 gboolean
 489 gtk_gst_gl_widget_init_winsys (GtkGstGLWidget * gst_widget)
 490 {
 491   GtkGstGLWidgetPrivate *priv = gst_widget->priv;
 492   GError *error = NULL;
 493
 494   g_return_val_if_fail (GTK_IS_GST_GL_WIDGET (gst_widget), FALSE);
 495   g_return_val_if_fail (priv->display != NULL, FALSE);
 496
 497   GTK_GST_BASE_WIDGET_LOCK (gst_widget);
 498
 499   if (priv->display && priv->gdk_context && priv->other_context) {
 500     GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
 501     return TRUE;
 502   }
 503
 504   if (!priv->other_context) {
 505     GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
 506     gst_gtk_invoke_on_main ((GThreadFunc) _get_gl_context, gst_widget);
 507     GTK_GST_BASE_WIDGET_LOCK (gst_widget);
 508   }
 509
 510   if (!GST_IS_GL_CONTEXT (priv->other_context)) {
 511     GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
 512     return FALSE;
 513   }
 514
 515   GST_OBJECT_LOCK (priv->display);
 516   if (!gst_gl_display_create_context (priv->display, priv->other_context,
 517           &priv->context, &error)) {
 518     g_clear_error (&error);
 519     GST_OBJECT_UNLOCK (priv->display);
 520     GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
 521     return FALSE;
 522   }
 523   gst_gl_display_add_context (priv->display, priv->context);
 524   GST_OBJECT_UNLOCK (priv->display);
 525
 526   GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
 527   return TRUE;
 528 }
 529
 530 GstGLContext *
 531 gtk_gst_gl_widget_get_gtk_context (GtkGstGLWidget * gst_widget)
 532 {
 533   if (!gst_widget->priv->other_context)
 534     return NULL;
 535
 536   return gst_object_ref (gst_widget->priv->other_context);
 537 }
 538
 539 GstGLContext *
 540 gtk_gst_gl_widget_get_context (GtkGstGLWidget * gst_widget)
 541 {
 542   if (!gst_widget->priv->context)
 543     return NULL;
 544
 545   return gst_object_ref (gst_widget->priv->context);
 546 }
 547
 548 GstGLDisplay *
 549 gtk_gst_gl_widget_get_display (GtkGstGLWidget * gst_widget)
 550 {
 551   if (!gst_widget->priv->display)
 552     return NULL;
 553
 554   return gst_object_ref (gst_widget->priv->display);
 555 }