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