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   else
 204     gtk_gst_gl_widget_unbind_buffer (gst_widget);
 205
 206   gl->BindTexture (GL_TEXTURE_2D, 0);
 207 }
 208
 209 static inline void
 210 _draw_black (GstGLContext * context)
 211 {
 212   const GstGLFuncs *gl = context->gl_vtable;
 213
 214   gst_gl_insert_debug_marker (context, "no buffer.  rendering black");
 215   gl->ClearColor (0.0, 0.0, 0.0, 0.0);
 216   gl->Clear (GL_COLOR_BUFFER_BIT);
 217 }
 218
 219 static gboolean
 220 gtk_gst_gl_widget_render (GtkGLArea * widget, GdkGLContext * context)
 221 {
 222   GtkGstGLWidgetPrivate *priv = GTK_GST_GL_WIDGET (widget)->priv;
 223   GtkGstBaseWidget *base_widget = GTK_GST_BASE_WIDGET (widget);
 224
 225   GTK_GST_BASE_WIDGET_LOCK (widget);
 226
 227   if (!priv->context || !priv->other_context)
 228     goto done;
 229
 230   gst_gl_context_activate (priv->other_context, TRUE);
 231
 232   if (!priv->initted)
 233     gtk_gst_gl_widget_init_redisplay (GTK_GST_GL_WIDGET (widget));
 234
 235   if (!priv->initted || !base_widget->negotiated) {
 236     _draw_black (priv->other_context);
 237     goto done;
 238   }
 239
 240   /* Upload latest buffer */
 241   if (base_widget->pending_buffer) {
 242     GstBuffer *buffer = base_widget->pending_buffer;
 243     GstVideoFrame gl_frame;
 244     GstGLSyncMeta *sync_meta;
 245
 246     if (!gst_video_frame_map (&gl_frame, &base_widget->v_info, buffer,
 247             GST_MAP_READ | GST_MAP_GL)) {
 248       _draw_black (priv->other_context);
 249       goto done;
 250     }
 251
 252     priv->current_tex = *(guint *) gl_frame.data[0];
 253     gst_gl_insert_debug_marker (priv->other_context, "redrawing texture %u",
 254         priv->current_tex);
 255
 256     gst_gl_overlay_compositor_upload_overlays (priv->overlay_compositor,
 257         buffer);
 258
 259     sync_meta = gst_buffer_get_gl_sync_meta (buffer);
 260     if (sync_meta) {
 261       /* XXX: the set_sync() seems to be needed for resizing */
 262       gst_gl_sync_meta_set_sync_point (sync_meta, priv->context);
 263       gst_gl_sync_meta_wait (sync_meta, priv->other_context);
 264     }
 265
 266     gst_video_frame_unmap (&gl_frame);
 267
 268     if (base_widget->buffer)
 269       gst_buffer_unref (base_widget->buffer);
 270
 271     /* Keep the buffer to ensure current_tex stay valid */
 272     base_widget->buffer = buffer;
 273     base_widget->pending_buffer = NULL;
 274   }
 275
 276   GST_DEBUG ("rendering buffer %p with gdk context %p",
 277       base_widget->buffer, context);
 278
 279   _redraw_texture (GTK_GST_GL_WIDGET (widget), priv->current_tex);
 280   gst_gl_overlay_compositor_draw_overlays (priv->overlay_compositor);
 281
 282   gst_gl_insert_debug_marker (priv->other_context, "texture %u redrawn",
 283       priv->current_tex);
 284
 285 done:
 286   if (priv->other_context)
 287     gst_gl_context_activate (priv->other_context, FALSE);
 288
 289   GTK_GST_BASE_WIDGET_UNLOCK (widget);
 290   return FALSE;
 291 }
 292
 293 static void
 294 _reset_gl (GtkGstGLWidget * gst_widget)
 295 {
 296   GtkGstGLWidgetPrivate *priv = gst_widget->priv;
 297   const GstGLFuncs *gl = priv->other_context->gl_vtable;
 298
 299   if (!priv->gdk_context)
 300     priv->gdk_context = gtk_gl_area_get_context (GTK_GL_AREA (gst_widget));
 301
 302   if (priv->gdk_context == NULL)
 303     return;
 304
 305   gdk_gl_context_make_current (priv->gdk_context);
 306   gst_gl_context_activate (priv->other_context, TRUE);
 307
 308   if (priv->vao) {
 309     gl->DeleteVertexArrays (1, &priv->vao);
 310     priv->vao = 0;
 311   }
 312
 313   if (priv->vertex_buffer) {
 314     gl->DeleteBuffers (1, &priv->vertex_buffer);
 315     priv->vertex_buffer = 0;
 316   }
 317
 318   if (priv->upload) {
 319     gst_object_unref (priv->upload);
 320     priv->upload = NULL;
 321   }
 322
 323   if (priv->shader) {
 324     gst_object_unref (priv->shader);
 325     priv->shader = NULL;
 326   }
 327
 328   if (priv->overlay_compositor)
 329     gst_object_unref (priv->overlay_compositor);
 330
 331   gst_gl_context_activate (priv->other_context, FALSE);
 332
 333   gst_object_unref (priv->other_context);
 334   priv->other_context = NULL;
 335
 336   gdk_gl_context_clear_current ();
 337
 338   g_object_unref (priv->gdk_context);
 339   priv->gdk_context = NULL;
 340 }
 341
 342 static void
 343 gtk_gst_gl_widget_finalize (GObject * object)
 344 {
 345   GtkGstGLWidgetPrivate *priv = GTK_GST_GL_WIDGET (object)->priv;
 346   GtkGstBaseWidget *base_widget = GTK_GST_BASE_WIDGET (object);
 347
 348   if (priv->other_context)
 349     gst_gtk_invoke_on_main ((GThreadFunc) _reset_gl, base_widget);
 350
 351   if (priv->context)
 352     gst_object_unref (priv->context);
 353
 354   if (priv->display)
 355     gst_object_unref (priv->display);
 356
 357   gtk_gst_base_widget_finalize (object);
 358   G_OBJECT_CLASS (gtk_gst_gl_widget_parent_class)->finalize (object);
 359 }
 360
 361 static void
 362 gtk_gst_gl_widget_class_init (GtkGstGLWidgetClass * klass)
 363 {
 364   GObjectClass *gobject_klass = (GObjectClass *) klass;
 365   GtkGLAreaClass *gl_widget_klass = (GtkGLAreaClass *) klass;
 366
 367   gtk_gst_base_widget_class_init (GTK_GST_BASE_WIDGET_CLASS (klass));
 368
 369   gobject_klass->finalize = gtk_gst_gl_widget_finalize;
 370   gl_widget_klass->render = gtk_gst_gl_widget_render;
 371 }
 372
 373 static void
 374 gtk_gst_gl_widget_init (GtkGstGLWidget * gst_widget)
 375 {
 376   GtkGstBaseWidget *base_widget = GTK_GST_BASE_WIDGET (gst_widget);
 377   GdkDisplay *display;
 378   GtkGstGLWidgetPrivate *priv;
 379
 380   gtk_gst_base_widget_init (base_widget);
 381
 382   gst_widget->priv = priv = gtk_gst_gl_widget_get_instance_private (gst_widget);
 383
 384   display = gdk_display_get_default ();
 385
 386 #if GST_GL_HAVE_WINDOW_X11 && GST_GL_HAVE_PLATFORM_GLX && defined (GDK_WINDOWING_X11)
 387   if (GDK_IS_X11_DISPLAY (display))
 388     priv->display = (GstGLDisplay *)
 389         gst_gl_display_x11_new_with_display (gdk_x11_display_get_xdisplay
 390         (display));
 391 #endif
 392 #if GST_GL_HAVE_WINDOW_WAYLAND && GST_GL_HAVE_PLATFORM_EGL && defined (GDK_WINDOWING_WAYLAND)
 393   if (GDK_IS_WAYLAND_DISPLAY (display)) {
 394     struct wl_display *wayland_display =
 395         gdk_wayland_display_get_wl_display (display);
 396     priv->display = (GstGLDisplay *)
 397         gst_gl_display_wayland_new_with_display (wayland_display);
 398   }
 399 #endif
 400
 401   (void) display;
 402
 403   if (!priv->display)
 404     priv->display = gst_gl_display_new ();
 405
 406   gtk_gl_area_set_has_alpha (GTK_GL_AREA (gst_widget),
 407       !base_widget->ignore_alpha);
 408 }
 409
 410 static void
 411 _get_gl_context (GtkGstGLWidget * gst_widget)
 412 {
 413   GtkGstGLWidgetPrivate *priv = gst_widget->priv;
 414   GstGLPlatform platform;
 415   GstGLAPI gl_api;
 416   guintptr gl_handle;
 417
 418   gtk_widget_realize (GTK_WIDGET (gst_widget));
 419
 420   if (priv->other_context)
 421     gst_object_unref (priv->other_context);
 422   priv->other_context = NULL;
 423
 424   if (priv->gdk_context)
 425     g_object_unref (priv->gdk_context);
 426
 427   priv->gdk_context = gtk_gl_area_get_context (GTK_GL_AREA (gst_widget));
 428   if (priv->gdk_context == NULL) {
 429     GError *error = gtk_gl_area_get_error (GTK_GL_AREA (gst_widget));
 430
 431     GST_ERROR_OBJECT (gst_widget, "Error creating GdkGLContext : %s",
 432         error ? error->message : "No error set by Gdk");
 433     g_clear_error (&error);
 434     return;
 435   }
 436
 437   g_object_ref (priv->gdk_context);
 438
 439   gdk_gl_context_make_current (priv->gdk_context);
 440
 441 #if GST_GL_HAVE_WINDOW_X11 && GST_GL_HAVE_PLATFORM_GLX && defined (GDK_WINDOWING_X11)
 442   if (GST_IS_GL_DISPLAY_X11 (priv->display)) {
 443     platform = GST_GL_PLATFORM_GLX;
 444     gl_api = gst_gl_context_get_current_gl_api (platform, NULL, NULL);
 445     gl_handle = gst_gl_context_get_current_gl_context (platform);
 446     if (gl_handle)
 447       priv->other_context =
 448           gst_gl_context_new_wrapped (priv->display, gl_handle,
 449           platform, gl_api);
 450   }
 451 #endif
 452 #if GST_GL_HAVE_WINDOW_WAYLAND && GST_GL_HAVE_PLATFORM_EGL && defined (GDK_WINDOWING_WAYLAND)
 453   if (GST_IS_GL_DISPLAY_WAYLAND (priv->display)) {
 454     platform = GST_GL_PLATFORM_EGL;
 455     gl_api = gst_gl_context_get_current_gl_api (platform, NULL, NULL);
 456     gl_handle = gst_gl_context_get_current_gl_context (platform);
 457     if (gl_handle)
 458       priv->other_context =
 459           gst_gl_context_new_wrapped (priv->display, gl_handle,
 460           platform, gl_api);
 461   }
 462 #endif
 463
 464   (void) platform;
 465   (void) gl_api;
 466   (void) gl_handle;
 467
 468   if (priv->other_context) {
 469     GError *error = NULL;
 470
 471     gst_gl_context_activate (priv->other_context, TRUE);
 472     if (!gst_gl_context_fill_info (priv->other_context, &error)) {
 473       GST_ERROR ("failed to retrieve gdk context info: %s", error->message);
 474       g_clear_error (&error);
 475       g_object_unref (priv->other_context);
 476       priv->other_context = NULL;
 477     } else {
 478       gst_gl_context_activate (priv->other_context, FALSE);
 479     }
 480   }
 481 }
 482
 483 GtkWidget *
 484 gtk_gst_gl_widget_new (void)
 485 {
 486   return (GtkWidget *) g_object_new (GTK_TYPE_GST_GL_WIDGET, NULL);
 487 }
 488
 489 gboolean
 490 gtk_gst_gl_widget_init_winsys (GtkGstGLWidget * gst_widget)
 491 {
 492   GtkGstGLWidgetPrivate *priv = gst_widget->priv;
 493   GError *error = NULL;
 494
 495   g_return_val_if_fail (GTK_IS_GST_GL_WIDGET (gst_widget), FALSE);
 496   g_return_val_if_fail (priv->display != NULL, FALSE);
 497
 498   GTK_GST_BASE_WIDGET_LOCK (gst_widget);
 499
 500   if (priv->display && priv->gdk_context && priv->other_context) {
 501     GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
 502     return TRUE;
 503   }
 504
 505   if (!priv->other_context) {
 506     GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
 507     gst_gtk_invoke_on_main ((GThreadFunc) _get_gl_context, gst_widget);
 508     GTK_GST_BASE_WIDGET_LOCK (gst_widget);
 509   }
 510
 511   if (!GST_IS_GL_CONTEXT (priv->other_context)) {
 512     GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
 513     return FALSE;
 514   }
 515
 516   GST_OBJECT_LOCK (priv->display);
 517   if (!gst_gl_display_create_context (priv->display, priv->other_context,
 518           &priv->context, &error)) {
 519     g_clear_error (&error);
 520     GST_OBJECT_UNLOCK (priv->display);
 521     GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
 522     return FALSE;
 523   }
 524   gst_gl_display_add_context (priv->display, priv->context);
 525   GST_OBJECT_UNLOCK (priv->display);
 526
 527   GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
 528   return TRUE;
 529 }
 530
 531 GstGLContext *
 532 gtk_gst_gl_widget_get_gtk_context (GtkGstGLWidget * gst_widget)
 533 {
 534   if (!gst_widget->priv->other_context)
 535     return NULL;
 536
 537   return gst_object_ref (gst_widget->priv->other_context);
 538 }
 539
 540 GstGLContext *
 541 gtk_gst_gl_widget_get_context (GtkGstGLWidget * gst_widget)
 542 {
 543   if (!gst_widget->priv->context)
 544     return NULL;
 545
 546   return gst_object_ref (gst_widget->priv->context);
 547 }
 548
 549 GstGLDisplay *
 550 gtk_gst_gl_widget_get_display (GtkGstGLWidget * gst_widget)
 551 {
 552   if (!gst_widget->priv->display)
 553     return NULL;
 554
 555   return gst_object_ref (gst_widget->priv->display);
 556 }