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 (GstGLContext * context)
 206 {
 207   const GstGLFuncs *gl = context->gl_vtable;
 208
 209   gl->ClearColor (0.0, 0.0, 0.0, 0.0);
 210   gl->Clear (GL_COLOR_BUFFER_BIT);
 211 }
 212
 213 static gboolean
 214 gtk_gst_gl_widget_render (GtkGLArea * widget, GdkGLContext * context)
 215 {
 216   GtkGstGLWidgetPrivate *priv = GTK_GST_GL_WIDGET (widget)->priv;
 217   GtkGstBaseWidget *base_widget = GTK_GST_BASE_WIDGET (widget);
 218
 219   GTK_GST_BASE_WIDGET_LOCK (widget);
 220
 221   if (!priv->context || !priv->other_context)
 222     goto done;
 223
 224   gst_gl_context_activate (priv->other_context, TRUE);
 225
 226   if (!priv->initted)
 227     gtk_gst_gl_widget_init_redisplay (GTK_GST_GL_WIDGET (widget));
 228
 229   if (!priv->initted || !base_widget->negotiated) {
 230     _draw_black (priv->other_context);
 231     goto done;
 232   }
 233
 234   /* Upload latest buffer */
 235   if (base_widget->pending_buffer) {
 236     GstBuffer *buffer = base_widget->pending_buffer;
 237     GstVideoFrame gl_frame;
 238     GstGLSyncMeta *sync_meta;
 239
 240     if (!gst_video_frame_map (&gl_frame, &base_widget->v_info, buffer,
 241             GST_MAP_READ | GST_MAP_GL)) {
 242       _draw_black (priv->other_context);
 243       goto done;
 244     }
 245
 246     gst_gl_overlay_compositor_upload_overlays (priv->overlay_compositor,
 247         buffer);
 248
 249     sync_meta = gst_buffer_get_gl_sync_meta (buffer);
 250     if (sync_meta) {
 251       gst_gl_sync_meta_set_sync_point (sync_meta, priv->context);
 252       gst_gl_sync_meta_wait (sync_meta, priv->other_context);
 253     }
 254
 255     priv->current_tex = *(guint *) gl_frame.data[0];
 256
 257     gst_video_frame_unmap (&gl_frame);
 258
 259     if (base_widget->buffer)
 260       gst_buffer_unref (base_widget->buffer);
 261
 262     /* Keep the buffer to ensure current_tex stay valid */
 263     base_widget->buffer = buffer;
 264     base_widget->pending_buffer = NULL;
 265   }
 266
 267   GST_DEBUG ("rendering buffer %p with gdk context %p",
 268       base_widget->buffer, context);
 269
 270   _redraw_texture (GTK_GST_GL_WIDGET (widget), priv->current_tex);
 271   gst_gl_overlay_compositor_draw_overlays (priv->overlay_compositor);
 272
 273 done:
 274   if (priv->other_context)
 275     gst_gl_context_activate (priv->other_context, FALSE);
 276
 277   GTK_GST_BASE_WIDGET_UNLOCK (widget);
 278   return FALSE;
 279 }
 280
 281 typedef void (*ThreadFunc) (gpointer data);
 282
 283 struct invoke_context
 284 {
 285   ThreadFunc func;
 286   gpointer data;
 287   GMutex lock;
 288   GCond cond;
 289   gboolean fired;
 290 };
 291
 292 static gboolean
 293 _invoke_func (struct invoke_context *info)
 294 {
 295   g_mutex_lock (&info->lock);
 296   info->func (info->data);
 297   info->fired = TRUE;
 298   g_cond_signal (&info->cond);
 299   g_mutex_unlock (&info->lock);
 300
 301   return G_SOURCE_REMOVE;
 302 }
 303
 304 static void
 305 _invoke_on_main (ThreadFunc func, gpointer data)
 306 {
 307   GMainContext *main_context = g_main_context_default ();
 308   struct invoke_context info;
 309
 310   g_mutex_init (&info.lock);
 311   g_cond_init (&info.cond);
 312   info.fired = FALSE;
 313   info.func = func;
 314   info.data = data;
 315
 316   g_main_context_invoke (main_context, (GSourceFunc) _invoke_func, &info);
 317
 318   g_mutex_lock (&info.lock);
 319   while (!info.fired)
 320     g_cond_wait (&info.cond, &info.lock);
 321   g_mutex_unlock (&info.lock);
 322
 323   g_mutex_clear (&info.lock);
 324   g_cond_clear (&info.cond);
 325 }
 326
 327 static void
 328 _reset_gl (GtkGstGLWidget * gst_widget)
 329 {
 330   GtkGstGLWidgetPrivate *priv = gst_widget->priv;
 331   const GstGLFuncs *gl = priv->other_context->gl_vtable;
 332
 333   if (!priv->gdk_context)
 334     priv->gdk_context = gtk_gl_area_get_context (GTK_GL_AREA (gst_widget));
 335
 336   if (priv->gdk_context == NULL)
 337     return;
 338
 339   gdk_gl_context_make_current (priv->gdk_context);
 340   gst_gl_context_activate (priv->other_context, TRUE);
 341
 342   if (priv->vao) {
 343     gl->DeleteVertexArrays (1, &priv->vao);
 344     priv->vao = 0;
 345   }
 346
 347   if (priv->vertex_buffer) {
 348     gl->DeleteBuffers (1, &priv->vertex_buffer);
 349     priv->vertex_buffer = 0;
 350   }
 351
 352   if (priv->upload) {
 353     gst_object_unref (priv->upload);
 354     priv->upload = NULL;
 355   }
 356
 357   if (priv->shader) {
 358     gst_object_unref (priv->shader);
 359     priv->shader = NULL;
 360   }
 361
 362   if (priv->overlay_compositor)
 363     gst_object_unref (priv->overlay_compositor);
 364
 365   gst_gl_context_activate (priv->other_context, FALSE);
 366
 367   gst_object_unref (priv->other_context);
 368   priv->other_context = NULL;
 369
 370   gdk_gl_context_clear_current ();
 371
 372   g_object_unref (priv->gdk_context);
 373   priv->gdk_context = NULL;
 374 }
 375
 376 static void
 377 gtk_gst_gl_widget_finalize (GObject * object)
 378 {
 379   GtkGstGLWidgetPrivate *priv = GTK_GST_GL_WIDGET (object)->priv;
 380   GtkGstBaseWidget *base_widget = GTK_GST_BASE_WIDGET (object);
 381
 382   if (priv->other_context)
 383     _invoke_on_main ((ThreadFunc) _reset_gl, base_widget);
 384
 385   if (priv->context)
 386     gst_object_unref (priv->context);
 387
 388   if (priv->display)
 389     gst_object_unref (priv->display);
 390
 391   gtk_gst_base_widget_finalize (object);
 392   G_OBJECT_CLASS (gtk_gst_gl_widget_parent_class)->finalize (object);
 393 }
 394
 395 static void
 396 gtk_gst_gl_widget_class_init (GtkGstGLWidgetClass * klass)
 397 {
 398   GObjectClass *gobject_klass = (GObjectClass *) klass;
 399   GtkGLAreaClass *gl_widget_klass = (GtkGLAreaClass *) klass;
 400
 401   g_type_class_add_private (klass, sizeof (GtkGstGLWidgetPrivate));
 402   gtk_gst_base_widget_class_init (GTK_GST_BASE_WIDGET_CLASS (klass));
 403
 404   gobject_klass->finalize = gtk_gst_gl_widget_finalize;
 405   gl_widget_klass->render = gtk_gst_gl_widget_render;
 406 }
 407
 408 static void
 409 gtk_gst_gl_widget_init (GtkGstGLWidget * gst_widget)
 410 {
 411   GtkGstBaseWidget *base_widget = GTK_GST_BASE_WIDGET (gst_widget);
 412   GdkDisplay *display;
 413   GtkGstGLWidgetPrivate *priv;
 414
 415   gtk_gst_base_widget_init (base_widget);
 416
 417   gst_widget->priv = priv = GTK_GST_GL_WIDGET_GET_PRIVATE (gst_widget);
 418
 419   display = gdk_display_get_default ();
 420
 421 #if GST_GL_HAVE_WINDOW_X11 && defined (GDK_WINDOWING_X11)
 422   if (GDK_IS_X11_DISPLAY (display))
 423     priv->display = (GstGLDisplay *)
 424         gst_gl_display_x11_new_with_display (gdk_x11_display_get_xdisplay
 425         (display));
 426 #endif
 427 #if GST_GL_HAVE_WINDOW_WAYLAND && defined (GDK_WINDOWING_WAYLAND)
 428   if (GDK_IS_WAYLAND_DISPLAY (display)) {
 429     struct wl_display *wayland_display =
 430         gdk_wayland_display_get_wl_display (display);
 431     priv->display = (GstGLDisplay *)
 432         gst_gl_display_wayland_new_with_display (wayland_display);
 433   }
 434 #endif
 435
 436   (void) display;
 437
 438   if (!priv->display)
 439     priv->display = gst_gl_display_new ();
 440
 441   gtk_gl_area_set_has_alpha (GTK_GL_AREA (gst_widget),
 442       !base_widget->ignore_alpha);
 443 }
 444
 445 static void
 446 _get_gl_context (GtkGstGLWidget * gst_widget)
 447 {
 448   GtkGstGLWidgetPrivate *priv = gst_widget->priv;
 449   GstGLPlatform platform;
 450   GstGLAPI gl_api;
 451   guintptr gl_handle;
 452
 453   gtk_widget_realize (GTK_WIDGET (gst_widget));
 454
 455   if (priv->gdk_context)
 456     g_object_unref (priv->gdk_context);
 457   priv->gdk_context = gtk_gl_area_get_context (GTK_GL_AREA (gst_widget));
 458   if (priv->gdk_context == NULL) {
 459     GError *error = gtk_gl_area_get_error (GTK_GL_AREA (gst_widget));
 460
 461     GST_ERROR_OBJECT (gst_widget, "Error creating GdkGLContext : %s",
 462         error ? error->message : "No error set by Gdk");
 463     g_assert_not_reached ();
 464     return;
 465   }
 466
 467   g_object_ref (priv->gdk_context);
 468
 469   gdk_gl_context_make_current (priv->gdk_context);
 470
 471 #if GST_GL_HAVE_WINDOW_X11 && defined (GDK_WINDOWING_X11)
 472   if (GST_IS_GL_DISPLAY_X11 (priv->display)) {
 473     platform = GST_GL_PLATFORM_GLX;
 474     gl_api = gst_gl_context_get_current_gl_api (platform, 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 #if GST_GL_HAVE_WINDOW_WAYLAND && defined (GDK_WINDOWING_WAYLAND)
 483   if (GST_IS_GL_DISPLAY_WAYLAND (priv->display)) {
 484     platform = GST_GL_PLATFORM_EGL;
 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
 494   (void) platform;
 495   (void) gl_api;
 496   (void) gl_handle;
 497
 498   if (priv->other_context) {
 499     GError *error = NULL;
 500
 501     gst_gl_context_activate (priv->other_context, TRUE);
 502     if (!gst_gl_context_fill_info (priv->other_context, &error)) {
 503       GST_ERROR ("failed to retrieve gdk context info: %s", error->message);
 504       g_object_unref (priv->other_context);
 505       priv->other_context = NULL;
 506     } else {
 507       gst_gl_context_activate (priv->other_context, FALSE);
 508     }
 509   }
 510 }
 511
 512 GtkWidget *
 513 gtk_gst_gl_widget_new (void)
 514 {
 515   return (GtkWidget *) g_object_new (GTK_TYPE_GST_GL_WIDGET, NULL);
 516 }
 517
 518 gboolean
 519 gtk_gst_gl_widget_init_winsys (GtkGstGLWidget * gst_widget)
 520 {
 521   GtkGstGLWidgetPrivate *priv = gst_widget->priv;
 522   GError *error = NULL;
 523
 524   g_return_val_if_fail (GTK_IS_GST_GL_WIDGET (gst_widget), FALSE);
 525
 526   GTK_GST_BASE_WIDGET_LOCK (gst_widget);
 527
 528   if (priv->display && priv->gdk_context && priv->other_context) {
 529     GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
 530     return TRUE;
 531   }
 532
 533   if (!priv->other_context) {
 534     GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
 535     _invoke_on_main ((ThreadFunc) _get_gl_context, gst_widget);
 536     GTK_GST_BASE_WIDGET_LOCK (gst_widget);
 537   }
 538
 539   if (!GST_GL_IS_CONTEXT (priv->other_context)) {
 540     GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
 541     return FALSE;
 542   }
 543
 544   if (!gst_gl_display_create_context (priv->display, priv->other_context,
 545           &priv->context, &error)) {
 546     g_clear_error (&error);
 547     GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
 548     return FALSE;
 549   }
 550
 551   GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
 552   return TRUE;
 553 }
 554
 555 GstGLContext *
 556 gtk_gst_gl_widget_get_gtk_context (GtkGstGLWidget * gst_widget)
 557 {
 558   if (!gst_widget->priv->other_context)
 559     return NULL;
 560
 561   return gst_object_ref (gst_widget->priv->other_context);
 562 }
 563
 564 GstGLContext *
 565 gtk_gst_gl_widget_get_context (GtkGstGLWidget * gst_widget)
 566 {
 567   if (!gst_widget->priv->context)
 568     return NULL;
 569
 570   return gst_object_ref (gst_widget->priv->context);
 571 }
 572
 573 GstGLDisplay *
 574 gtk_gst_gl_widget_get_display (GtkGstGLWidget * gst_widget)
 575 {
 576   if (!gst_widget->priv->display)
 577     return NULL;
 578
 579   return gst_object_ref (gst_widget->priv->display);
 580 }