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