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/video/video.h>
  30
  31 #if GST_GL_HAVE_WINDOW_X11 && GST_GL_HAVE_PLATFORM_GLX && defined (GDK_WINDOWING_X11)
  32 #include <gdk/gdkx.h>
  33 #include <gst/gl/x11/gstgldisplay_x11.h>
  34 #include <gst/gl/x11/gstglcontext_glx.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  * @short_description: a #GtkGLArea that renders GStreamer video #GstBuffers
  45  * @see_also: #GtkGLArea, #GstBuffer
  46  *
  47  * #GtkGstGLWidget is an #GtkWidget that renders GStreamer video buffers.
  48  */
  49
  50 #define GST_CAT_DEFAULT gtk_gst_gl_widget_debug
  51 GST_DEBUG_CATEGORY_STATIC (GST_CAT_DEFAULT);
  52
  53 G_DEFINE_TYPE_WITH_CODE (GtkGstGLWidget, gtk_gst_gl_widget, GTK_TYPE_GL_AREA,
  54     GST_DEBUG_CATEGORY_INIT (GST_CAT_DEFAULT, "gtkgstglwidget", 0,
  55         "Gtk Gst GL Widget"););
  56
  57 #define GTK_GST_GL_WIDGET_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), \
  58     GTK_TYPE_GST_GL_WIDGET, GtkGstGLWidgetPrivate))
  59
  60 struct _GtkGstGLWidgetPrivate
  61 {
  62   gboolean initted;
  63   GstGLDisplay *display;
  64   GdkGLContext *gdk_context;
  65   GstGLContext *other_context;
  66   GstGLContext *context;
  67   GstGLUpload *upload;
  68   GstGLShader *shader;
  69   GLuint vao;
  70   GLuint vertex_buffer;
  71   GLint attr_position;
  72   GLint attr_texture;
  73   GLuint current_tex;
  74   GstGLOverlayCompositor *overlay_compositor;
  75 };
  76
  77 static const GLfloat vertices[] = {
  78   1.0f, 1.0f, 0.0f, 1.0f, 0.0f,
  79   -1.0f, 1.0f, 0.0f, 0.0f, 0.0f,
  80   -1.0f, -1.0f, 0.0f, 0.0f, 1.0f,
  81   1.0f, -1.0f, 0.0f, 1.0f, 1.0f
  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   else
 195     gtk_gst_gl_widget_bind_buffer (gst_widget);
 196
 197   gl->ActiveTexture (GL_TEXTURE0);
 198   gl->BindTexture (GL_TEXTURE_2D, tex);
 199   gst_gl_shader_set_uniform_1i (priv->shader, "tex", 0);
 200
 201   gl->DrawElements (GL_TRIANGLES, 6, GL_UNSIGNED_SHORT, indices);
 202
 203   if (gl->BindVertexArray)
 204     gl->BindVertexArray (0);
 205   else
 206     gtk_gst_gl_widget_unbind_buffer (gst_widget);
 207
 208   gl->BindTexture (GL_TEXTURE_2D, 0);
 209 }
 210
 211 static inline void
 212 _draw_black (GstGLContext * context)
 213 {
 214   const GstGLFuncs *gl = context->gl_vtable;
 215
 216   gst_gl_insert_debug_marker (context, "no buffer.  rendering black");
 217   gl->ClearColor (0.0, 0.0, 0.0, 0.0);
 218   gl->Clear (GL_COLOR_BUFFER_BIT);
 219 }
 220
 221 static gboolean
 222 gtk_gst_gl_widget_render (GtkGLArea * widget, GdkGLContext * context)
 223 {
 224   GtkGstGLWidgetPrivate *priv = GTK_GST_GL_WIDGET (widget)->priv;
 225   GtkGstBaseWidget *base_widget = GTK_GST_BASE_WIDGET (widget);
 226
 227   GTK_GST_BASE_WIDGET_LOCK (widget);
 228
 229   if (!priv->context || !priv->other_context)
 230     goto done;
 231
 232   gst_gl_context_activate (priv->other_context, TRUE);
 233
 234   if (!priv->initted)
 235     gtk_gst_gl_widget_init_redisplay (GTK_GST_GL_WIDGET (widget));
 236
 237   if (!priv->initted || !base_widget->negotiated) {
 238     _draw_black (priv->other_context);
 239     goto done;
 240   }
 241
 242   /* Upload latest buffer */
 243   if (base_widget->pending_buffer) {
 244     GstBuffer *buffer = base_widget->pending_buffer;
 245     GstVideoFrame gl_frame;
 246     GstGLSyncMeta *sync_meta;
 247
 248     if (!gst_video_frame_map (&gl_frame, &base_widget->v_info, buffer,
 249             GST_MAP_READ | GST_MAP_GL)) {
 250       _draw_black (priv->other_context);
 251       goto done;
 252     }
 253
 254     priv->current_tex = *(guint *) gl_frame.data[0];
 255     gst_gl_insert_debug_marker (priv->other_context, "redrawing texture %u",
 256         priv->current_tex);
 257
 258     gst_gl_overlay_compositor_upload_overlays (priv->overlay_compositor,
 259         buffer);
 260
 261     sync_meta = gst_buffer_get_gl_sync_meta (buffer);
 262     if (sync_meta) {
 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   g_type_class_add_private (klass, sizeof (GtkGstGLWidgetPrivate));
 369   gtk_gst_base_widget_class_init (GTK_GST_BASE_WIDGET_CLASS (klass));
 370
 371   gobject_klass->finalize = gtk_gst_gl_widget_finalize;
 372   gl_widget_klass->render = gtk_gst_gl_widget_render;
 373 }
 374
 375 static void
 376 gtk_gst_gl_widget_init (GtkGstGLWidget * gst_widget)
 377 {
 378   GtkGstBaseWidget *base_widget = GTK_GST_BASE_WIDGET (gst_widget);
 379   GdkDisplay *display;
 380   GtkGstGLWidgetPrivate *priv;
 381
 382   gtk_gst_base_widget_init (base_widget);
 383
 384   gst_widget->priv = priv = GTK_GST_GL_WIDGET_GET_PRIVATE (gst_widget);
 385
 386   display = gdk_display_get_default ();
 387
 388 #if GST_GL_HAVE_WINDOW_X11 && GST_GL_HAVE_PLATFORM_GLX && defined (GDK_WINDOWING_X11)
 389   if (GDK_IS_X11_DISPLAY (display))
 390     priv->display = (GstGLDisplay *)
 391         gst_gl_display_x11_new_with_display (gdk_x11_display_get_xdisplay
 392         (display));
 393 #endif
 394 #if GST_GL_HAVE_WINDOW_WAYLAND && GST_GL_HAVE_PLATFORM_EGL && 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   gtk_gl_area_set_has_alpha (GTK_GL_AREA (gst_widget),
 409       !base_widget->ignore_alpha);
 410 }
 411
 412 static void
 413 _get_gl_context (GtkGstGLWidget * gst_widget)
 414 {
 415   GtkGstGLWidgetPrivate *priv = gst_widget->priv;
 416   GstGLPlatform platform;
 417   GstGLAPI gl_api;
 418   guintptr gl_handle;
 419
 420   gtk_widget_realize (GTK_WIDGET (gst_widget));
 421
 422   if (priv->gdk_context)
 423     g_object_unref (priv->gdk_context);
 424   priv->gdk_context = gtk_gl_area_get_context (GTK_GL_AREA (gst_widget));
 425   if (priv->gdk_context == NULL) {
 426     GError *error = gtk_gl_area_get_error (GTK_GL_AREA (gst_widget));
 427
 428     GST_ERROR_OBJECT (gst_widget, "Error creating GdkGLContext : %s",
 429         error ? error->message : "No error set by Gdk");
 430     g_clear_error (&error);
 431     g_assert_not_reached ();
 432     return;
 433   }
 434
 435   g_object_ref (priv->gdk_context);
 436
 437   gdk_gl_context_make_current (priv->gdk_context);
 438
 439 #if GST_GL_HAVE_WINDOW_X11 && GST_GL_HAVE_PLATFORM_GLX && defined (GDK_WINDOWING_X11)
 440   if (GST_IS_GL_DISPLAY_X11 (priv->display)) {
 441     platform = GST_GL_PLATFORM_GLX;
 442     gl_api = gst_gl_context_get_current_gl_api (platform, NULL, NULL);
 443     gl_handle = gst_gl_context_get_current_gl_context (platform);
 444     if (gl_handle)
 445       priv->other_context =
 446           gst_gl_context_new_wrapped (priv->display, gl_handle,
 447           platform, gl_api);
 448   }
 449 #endif
 450 #if GST_GL_HAVE_WINDOW_WAYLAND && GST_GL_HAVE_PLATFORM_EGL && defined (GDK_WINDOWING_WAYLAND)
 451   if (GST_IS_GL_DISPLAY_WAYLAND (priv->display)) {
 452     platform = GST_GL_PLATFORM_EGL;
 453     gl_api = gst_gl_context_get_current_gl_api (platform, NULL, NULL);
 454     gl_handle = gst_gl_context_get_current_gl_context (platform);
 455     if (gl_handle)
 456       priv->other_context =
 457           gst_gl_context_new_wrapped (priv->display, gl_handle,
 458           platform, gl_api);
 459   }
 460 #endif
 461
 462   (void) platform;
 463   (void) gl_api;
 464   (void) gl_handle;
 465
 466   if (priv->other_context) {
 467     GError *error = NULL;
 468
 469     gst_gl_context_activate (priv->other_context, TRUE);
 470     if (!gst_gl_context_fill_info (priv->other_context, &error)) {
 471       GST_ERROR ("failed to retrieve gdk context info: %s", error->message);
 472       g_clear_error (&error);
 473       g_object_unref (priv->other_context);
 474       priv->other_context = NULL;
 475     } else {
 476       gst_gl_context_activate (priv->other_context, FALSE);
 477     }
 478   }
 479 }
 480
 481 GtkWidget *
 482 gtk_gst_gl_widget_new (void)
 483 {
 484   return (GtkWidget *) g_object_new (GTK_TYPE_GST_GL_WIDGET, NULL);
 485 }
 486
 487 gboolean
 488 gtk_gst_gl_widget_init_winsys (GtkGstGLWidget * gst_widget)
 489 {
 490   GtkGstGLWidgetPrivate *priv = gst_widget->priv;
 491   GError *error = NULL;
 492
 493   g_return_val_if_fail (GTK_IS_GST_GL_WIDGET (gst_widget), FALSE);
 494
 495   GTK_GST_BASE_WIDGET_LOCK (gst_widget);
 496
 497   if (priv->display && priv->gdk_context && priv->other_context) {
 498     GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
 499     return TRUE;
 500   }
 501
 502   if (!priv->other_context) {
 503     GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
 504     gst_gtk_invoke_on_main ((GThreadFunc) _get_gl_context, gst_widget);
 505     GTK_GST_BASE_WIDGET_LOCK (gst_widget);
 506   }
 507
 508   if (!GST_GL_IS_CONTEXT (priv->other_context)) {
 509     GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
 510     return FALSE;
 511   }
 512
 513   if (!gst_gl_display_create_context (priv->display, priv->other_context,
 514           &priv->context, &error)) {
 515     g_clear_error (&error);
 516     GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
 517     return FALSE;
 518   }
 519
 520   GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
 521   return TRUE;
 522 }
 523
 524 GstGLContext *
 525 gtk_gst_gl_widget_get_gtk_context (GtkGstGLWidget * gst_widget)
 526 {
 527   if (!gst_widget->priv->other_context)
 528     return NULL;
 529
 530   return gst_object_ref (gst_widget->priv->other_context);
 531 }
 532
 533 GstGLContext *
 534 gtk_gst_gl_widget_get_context (GtkGstGLWidget * gst_widget)
 535 {
 536   if (!gst_widget->priv->context)
 537     return NULL;
 538
 539   return gst_object_ref (gst_widget->priv->context);
 540 }
 541
 542 GstGLDisplay *
 543 gtk_gst_gl_widget_get_display (GtkGstGLWidget * gst_widget)
 544 {
 545   if (!gst_widget->priv->display)
 546     return NULL;
 547
 548   return gst_object_ref (gst_widget->priv->display);
 549 }