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