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