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 <gst/video/video.h>
  29
  30 #if GST_GL_HAVE_WINDOW_X11 && defined (GDK_WINDOWING_X11)
  31 #include <gdk/gdkx.h>
  32 #include <gst/gl/x11/gstgldisplay_x11.h>
  33 #include <gst/gl/x11/gstglcontext_glx.h>
  34 #endif
  35
  36 #if GST_GL_HAVE_WINDOW_WAYLAND && defined (GDK_WINDOWING_WAYLAND)
  37 #include <gdk/gdkwayland.h>
  38 #include <gst/gl/wayland/gstgldisplay_wayland.h>
  39 #endif
  40
  41 /**
  42  * SECTION:gtkgstglwidget
  43  * @short_description: a #GtkGLArea that renders GStreamer video #GstBuffers
  44  * @see_also: #GtkGLArea, #GstBuffer
  45  *
  46  * #GtkGstGLWidget is an #GtkWidget that renders GStreamer video buffers.
  47  */
  48
  49 #define GST_CAT_DEFAULT gtk_gst_gl_widget_debug
  50 GST_DEBUG_CATEGORY_STATIC (GST_CAT_DEFAULT);
  51
  52 G_DEFINE_TYPE_WITH_CODE (GtkGstGLWidget, gtk_gst_gl_widget, GTK_TYPE_GL_AREA,
  53     GST_DEBUG_CATEGORY_INIT (GST_CAT_DEFAULT, "gtkgstglwidget", 0,
  54         "Gtk Gst GL Widget");
  55     );
  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
 122   priv->shader = gst_gl_shader_new (priv->context);
 123
 124   gst_gl_shader_compile_with_default_vf_and_check (priv->shader,
 125       &priv->attr_position, &priv->attr_texture);
 126
 127   if (gl->GenVertexArrays) {
 128     gl->GenVertexArrays (1, &priv->vao);
 129     gl->BindVertexArray (priv->vao);
 130   }
 131
 132   gl->GenBuffers (1, &priv->vertex_buffer);
 133   gl->BindBuffer (GL_ARRAY_BUFFER, priv->vertex_buffer);
 134   gl->BufferData (GL_ARRAY_BUFFER, 4 * 5 * sizeof (GLfloat), vertices,
 135       GL_STATIC_DRAW);
 136
 137   if (gl->GenVertexArrays) {
 138     gtk_gst_gl_widget_bind_buffer (gst_widget);
 139     gl->BindVertexArray (0);
 140   }
 141
 142   gl->BindBuffer (GL_ARRAY_BUFFER, 0);
 143
 144   priv->overlay_compositor =
 145       gst_gl_overlay_compositor_new (priv->other_context);
 146
 147   priv->initted = TRUE;
 148 }
 149
 150 static void
 151 _redraw_texture (GtkGstGLWidget * gst_widget, guint tex)
 152 {
 153   GtkGstGLWidgetPrivate *priv = gst_widget->priv;
 154   const GstGLFuncs *gl = priv->context->gl_vtable;
 155   const GLushort indices[] = { 0, 1, 2, 0, 2, 3 };
 156
 157   if (gst_widget->base.force_aspect_ratio) {
 158     GstVideoRectangle src, dst, result;
 159     gint widget_width, widget_height, widget_scale;
 160
 161     gl->ClearColor (0.0, 0.0, 0.0, 0.0);
 162     gl->Clear (GL_COLOR_BUFFER_BIT);
 163
 164     widget_scale = gtk_widget_get_scale_factor ((GtkWidget *) gst_widget);
 165     widget_width = gtk_widget_get_allocated_width ((GtkWidget *) gst_widget);
 166     widget_height = gtk_widget_get_allocated_height ((GtkWidget *) gst_widget);
 167
 168     src.x = 0;
 169     src.y = 0;
 170     src.w = gst_widget->base.display_width;
 171     src.h = gst_widget->base.display_height;
 172
 173     dst.x = 0;
 174     dst.y = 0;
 175     dst.w = widget_width * widget_scale;
 176     dst.h = widget_height * widget_scale;
 177
 178     gst_video_sink_center_rect (src, dst, &result, TRUE);
 179
 180     gl->Viewport (result.x, result.y, result.w, result.h);
 181   }
 182
 183   gst_gl_shader_use (priv->shader);
 184
 185   if (gl->BindVertexArray)
 186     gl->BindVertexArray (priv->vao);
 187   else
 188     gtk_gst_gl_widget_bind_buffer (gst_widget);
 189
 190   gl->ActiveTexture (GL_TEXTURE0);
 191   gl->BindTexture (GL_TEXTURE_2D, tex);
 192   gst_gl_shader_set_uniform_1i (priv->shader, "tex", 0);
 193
 194   gl->DrawElements (GL_TRIANGLES, 6, GL_UNSIGNED_SHORT, indices);
 195
 196   if (gl->BindVertexArray)
 197     gl->BindVertexArray (0);
 198   else
 199     gtk_gst_gl_widget_unbind_buffer (gst_widget);
 200
 201   gl->BindTexture (GL_TEXTURE_2D, 0);
 202 }
 203
 204 static inline void
 205 _draw_black (void)
 206 {
 207   glClearColor (0.0, 0.0, 0.0, 0.0);
 208   glClear (GL_COLOR_BUFFER_BIT);
 209 }
 210
 211 static gboolean
 212 gtk_gst_gl_widget_render (GtkGLArea * widget, GdkGLContext * context)
 213 {
 214   GtkGstGLWidgetPrivate *priv = GTK_GST_GL_WIDGET (widget)->priv;
 215   GtkGstBaseWidget *base_widget = GTK_GST_BASE_WIDGET (widget);
 216
 217   GTK_GST_BASE_WIDGET_LOCK (widget);
 218
 219   if (!priv->context || !priv->other_context)
 220     goto done;
 221
 222   gst_gl_context_activate (priv->other_context, TRUE);
 223
 224   if (!priv->initted)
 225     gtk_gst_gl_widget_init_redisplay (GTK_GST_GL_WIDGET (widget));
 226
 227   if (!priv->initted || !base_widget->negotiated) {
 228     _draw_black ();
 229     goto done;
 230   }
 231
 232   /* Upload latest buffer */
 233   if (base_widget->pending_buffer) {
 234     GstBuffer *buffer = base_widget->pending_buffer;
 235     GstVideoFrame gl_frame;
 236     GstGLSyncMeta *sync_meta;
 237
 238     if (!gst_video_frame_map (&gl_frame, &base_widget->v_info, buffer,
 239             GST_MAP_READ | GST_MAP_GL)) {
 240       _draw_black ();
 241       goto done;
 242     }
 243
 244     gst_gl_overlay_compositor_upload_overlays (priv->overlay_compositor,
 245         buffer);
 246
 247     sync_meta = gst_buffer_get_gl_sync_meta (buffer);
 248     if (sync_meta) {
 249       gst_gl_sync_meta_set_sync_point (sync_meta, priv->context);
 250       gst_gl_sync_meta_wait (sync_meta, priv->other_context);
 251     }
 252
 253     priv->current_tex = *(guint *) gl_frame.data[0];
 254
 255     gst_video_frame_unmap (&gl_frame);
 256
 257     if (base_widget->buffer)
 258       gst_buffer_unref (base_widget->buffer);
 259
 260     /* Keep the buffer to ensure current_tex stay valid */
 261     base_widget->buffer = buffer;
 262     base_widget->pending_buffer = NULL;
 263   }
 264
 265   GST_DEBUG ("rendering buffer %p with gdk context %p",
 266       base_widget->buffer, context);
 267
 268   _redraw_texture (GTK_GST_GL_WIDGET (widget), priv->current_tex);
 269   gst_gl_overlay_compositor_draw_overlays (priv->overlay_compositor);
 270
 271 done:
 272   if (priv->other_context)
 273     gst_gl_context_activate (priv->other_context, FALSE);
 274
 275   GTK_GST_BASE_WIDGET_UNLOCK (widget);
 276   return FALSE;
 277 }
 278
 279 typedef void (*ThreadFunc) (gpointer data);
 280
 281 struct invoke_context
 282 {
 283   ThreadFunc func;
 284   gpointer data;
 285   GMutex lock;
 286   GCond cond;
 287   gboolean fired;
 288 };
 289
 290 static gboolean
 291 _invoke_func (struct invoke_context *info)
 292 {
 293   g_mutex_lock (&info->lock);
 294   info->func (info->data);
 295   info->fired = TRUE;
 296   g_cond_signal (&info->cond);
 297   g_mutex_unlock (&info->lock);
 298
 299   return G_SOURCE_REMOVE;
 300 }
 301
 302 static void
 303 _invoke_on_main (ThreadFunc func, gpointer data)
 304 {
 305   GMainContext *main_context = g_main_context_default ();
 306   struct invoke_context info;
 307
 308   g_mutex_init (&info.lock);
 309   g_cond_init (&info.cond);
 310   info.fired = FALSE;
 311   info.func = func;
 312   info.data = data;
 313
 314   g_main_context_invoke (main_context, (GSourceFunc) _invoke_func, &info);
 315
 316   g_mutex_lock (&info.lock);
 317   while (!info.fired)
 318     g_cond_wait (&info.cond, &info.lock);
 319   g_mutex_unlock (&info.lock);
 320
 321   g_mutex_clear (&info.lock);
 322   g_cond_clear (&info.cond);
 323 }
 324
 325 static void
 326 _reset_gl (GtkGstGLWidget * gst_widget)
 327 {
 328   GtkGstGLWidgetPrivate *priv = gst_widget->priv;
 329   const GstGLFuncs *gl = priv->other_context->gl_vtable;
 330
 331   if (!priv->gdk_context)
 332     priv->gdk_context = gtk_gl_area_get_context (GTK_GL_AREA (gst_widget));
 333
 334   if (priv->gdk_context == NULL)
 335     return;
 336
 337   gdk_gl_context_make_current (priv->gdk_context);
 338   gst_gl_context_activate (priv->other_context, TRUE);
 339
 340   if (priv->vao) {
 341     gl->DeleteVertexArrays (1, &priv->vao);
 342     priv->vao = 0;
 343   }
 344
 345   if (priv->vertex_buffer) {
 346     gl->DeleteBuffers (1, &priv->vertex_buffer);
 347     priv->vertex_buffer = 0;
 348   }
 349
 350   if (priv->upload) {
 351     gst_object_unref (priv->upload);
 352     priv->upload = NULL;
 353   }
 354
 355   if (priv->shader) {
 356     gst_object_unref (priv->shader);
 357     priv->shader = NULL;
 358   }
 359
 360   if (priv->overlay_compositor)
 361     gst_object_unref (priv->overlay_compositor);
 362
 363   gst_gl_context_activate (priv->other_context, FALSE);
 364
 365   gst_object_unref (priv->other_context);
 366   priv->other_context = NULL;
 367
 368   gdk_gl_context_clear_current ();
 369
 370   g_object_unref (priv->gdk_context);
 371   priv->gdk_context = NULL;
 372 }
 373
 374 static void
 375 gtk_gst_gl_widget_finalize (GObject * object)
 376 {
 377   GtkGstGLWidgetPrivate *priv = GTK_GST_GL_WIDGET (object)->priv;
 378   GtkGstBaseWidget *base_widget = GTK_GST_BASE_WIDGET (object);
 379
 380   if (priv->other_context)
 381     _invoke_on_main ((ThreadFunc) _reset_gl, base_widget);
 382
 383   if (priv->context)
 384     gst_object_unref (priv->context);
 385
 386   if (priv->display)
 387     gst_object_unref (priv->display);
 388
 389   gtk_gst_base_widget_finalize (object);
 390   G_OBJECT_CLASS (gtk_gst_gl_widget_parent_class)->finalize (object);
 391 }
 392
 393 static void
 394 gtk_gst_gl_widget_class_init (GtkGstGLWidgetClass * klass)
 395 {
 396   GObjectClass *gobject_klass = (GObjectClass *) klass;
 397   GtkGLAreaClass *gl_widget_klass = (GtkGLAreaClass *) klass;
 398
 399   g_type_class_add_private (klass, sizeof (GtkGstGLWidgetPrivate));
 400   gtk_gst_base_widget_class_init (GTK_GST_BASE_WIDGET_CLASS (klass));
 401
 402   gobject_klass->finalize = gtk_gst_gl_widget_finalize;
 403   gl_widget_klass->render = gtk_gst_gl_widget_render;
 404 }
 405
 406 static void
 407 gtk_gst_gl_widget_init (GtkGstGLWidget * gst_widget)
 408 {
 409   GtkGstBaseWidget *base_widget = GTK_GST_BASE_WIDGET (gst_widget);
 410   GdkDisplay *display;
 411   GtkGstGLWidgetPrivate *priv;
 412
 413   gtk_gst_base_widget_init (base_widget);
 414
 415   gst_widget->priv = priv = GTK_GST_GL_WIDGET_GET_PRIVATE (gst_widget);
 416
 417   display = gdk_display_get_default ();
 418
 419 #if GST_GL_HAVE_WINDOW_X11 && defined (GDK_WINDOWING_X11)
 420   if (GDK_IS_X11_DISPLAY (display))
 421     priv->display = (GstGLDisplay *)
 422         gst_gl_display_x11_new_with_display (gdk_x11_display_get_xdisplay
 423         (display));
 424 #endif
 425 #if GST_GL_HAVE_WINDOW_WAYLAND && defined (GDK_WINDOWING_WAYLAND)
 426   if (GDK_IS_WAYLAND_DISPLAY (display)) {
 427     struct wl_display *wayland_display =
 428         gdk_wayland_display_get_wl_display (display);
 429     priv->display = (GstGLDisplay *)
 430         gst_gl_display_wayland_new_with_display (wayland_display);
 431   }
 432 #endif
 433
 434   (void) display;
 435
 436   if (!priv->display)
 437     priv->display = gst_gl_display_new ();
 438
 439   gtk_gl_area_set_has_alpha (GTK_GL_AREA (gst_widget),
 440       !base_widget->ignore_alpha);
 441 }
 442
 443 static void
 444 _get_gl_context (GtkGstGLWidget * gst_widget)
 445 {
 446   GtkGstGLWidgetPrivate *priv = gst_widget->priv;
 447   GstGLPlatform platform;
 448   GstGLAPI gl_api;
 449   guintptr gl_handle;
 450
 451   gtk_widget_realize (GTK_WIDGET (gst_widget));
 452
 453   if (priv->gdk_context)
 454     g_object_unref (priv->gdk_context);
 455   priv->gdk_context = gtk_gl_area_get_context (GTK_GL_AREA (gst_widget));
 456   if (priv->gdk_context == NULL) {
 457     GError *error = gtk_gl_area_get_error (GTK_GL_AREA (gst_widget));
 458
 459     GST_ERROR_OBJECT (gst_widget, "Error creating GdkGLContext : %s",
 460         error ? error->message : "No error set by Gdk");
 461     g_assert_not_reached ();
 462     return;
 463   }
 464
 465   g_object_ref (priv->gdk_context);
 466
 467   gdk_gl_context_make_current (priv->gdk_context);
 468
 469 #if GST_GL_HAVE_WINDOW_X11 && defined (GDK_WINDOWING_X11)
 470   if (GST_IS_GL_DISPLAY_X11 (priv->display)) {
 471     platform = GST_GL_PLATFORM_GLX;
 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 #if GST_GL_HAVE_WINDOW_WAYLAND && defined (GDK_WINDOWING_WAYLAND)
 481   if (GST_IS_GL_DISPLAY_WAYLAND (priv->display)) {
 482     platform = GST_GL_PLATFORM_EGL;
 483     gl_api = gst_gl_context_get_current_gl_api (platform, NULL, NULL);
 484     gl_handle = gst_gl_context_get_current_gl_context (platform);
 485     if (gl_handle)
 486       priv->other_context =
 487           gst_gl_context_new_wrapped (priv->display, gl_handle,
 488           platform, gl_api);
 489   }
 490 #endif
 491
 492   (void) platform;
 493   (void) gl_api;
 494   (void) gl_handle;
 495
 496   if (priv->other_context) {
 497     GError *error = NULL;
 498
 499     gst_gl_context_activate (priv->other_context, TRUE);
 500     if (!gst_gl_context_fill_info (priv->other_context, &error)) {
 501       GST_ERROR ("failed to retreive gdk context info: %s", error->message);
 502       g_object_unref (priv->other_context);
 503       priv->other_context = NULL;
 504     } else {
 505       gst_gl_context_activate (priv->other_context, FALSE);
 506     }
 507   }
 508 }
 509
 510 GtkWidget *
 511 gtk_gst_gl_widget_new (void)
 512 {
 513   return (GtkWidget *) g_object_new (GTK_TYPE_GST_GL_WIDGET, NULL);
 514 }
 515
 516 gboolean
 517 gtk_gst_gl_widget_init_winsys (GtkGstGLWidget * gst_widget)
 518 {
 519   GtkGstGLWidgetPrivate *priv = gst_widget->priv;
 520   GError *error = NULL;
 521
 522   g_return_val_if_fail (GTK_IS_GST_GL_WIDGET (gst_widget), FALSE);
 523
 524   GTK_GST_BASE_WIDGET_LOCK (gst_widget);
 525
 526   if (priv->display && priv->gdk_context && priv->other_context) {
 527     GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
 528     return TRUE;
 529   }
 530
 531   if (!priv->other_context) {
 532     GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
 533     _invoke_on_main ((ThreadFunc) _get_gl_context, gst_widget);
 534     GTK_GST_BASE_WIDGET_LOCK (gst_widget);
 535   }
 536
 537   if (!GST_GL_IS_CONTEXT (priv->other_context)) {
 538     GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
 539     return FALSE;
 540   }
 541
 542   if (!gst_gl_display_create_context (priv->display, priv->other_context,
 543           &priv->context, &error)) {
 544     g_clear_error (&error);
 545     GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
 546     return FALSE;
 547   }
 548
 549   GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
 550   return TRUE;
 551 }
 552
 553 GstGLContext *
 554 gtk_gst_gl_widget_get_gtk_context (GtkGstGLWidget * gst_widget)
 555 {
 556   if (!gst_widget->priv->other_context)
 557     return NULL;
 558
 559   return gst_object_ref (gst_widget->priv->other_context);
 560 }
 561
 562 GstGLContext *
 563 gtk_gst_gl_widget_get_context (GtkGstGLWidget * gst_widget)
 564 {
 565   if (!gst_widget->priv->context)
 566     return NULL;
 567
 568   return gst_object_ref (gst_widget->priv->context);
 569 }
 570
 571 GstGLDisplay *
 572 gtk_gst_gl_widget_get_display (GtkGstGLWidget * gst_widget)
 573 {
 574   if (!gst_widget->priv->display)
 575     return NULL;
 576
 577   return gst_object_ref (gst_widget->priv->display);
 578 }