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