3 * Copyright (C) 2015 Matthew Waters <matthew@centricular.com>
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.
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.
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.
27 #include "gtkgstglwidget.h"
28 #include <gst/video/video.h>
30 #if GST_GL_HAVE_WINDOW_X11 && defined (GDK_WINDOWING_X11)
32 #include <gst/gl/x11/gstgldisplay_x11.h>
33 #include <gst/gl/x11/gstglcontext_glx.h>
36 #if GST_GL_HAVE_WINDOW_WAYLAND && defined (GDK_WINDOWING_WAYLAND)
37 #include <gdk/gdkwayland.h>
38 #include <gst/gl/wayland/gstgldisplay_wayland.h>
42 * SECTION:gtkgstglwidget
43 * @short_description: a #GtkGLArea that renders GStreamer video #GstBuffers
44 * @see_also: #GtkGLArea, #GstBuffer
46 * #GtkGstGLWidget is an #GtkWidget that renders GStreamer video buffers.
49 #define GST_CAT_DEFAULT gtk_gst_gl_widget_debug
50 GST_DEBUG_CATEGORY_STATIC (GST_CAT_DEFAULT);
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"););
56 #define GTK_GST_GL_WIDGET_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), \
57 GTK_TYPE_GST_GL_WIDGET, GtkGstGLWidgetPrivate))
59 struct _GtkGstGLWidgetPrivate
65 GstGLDisplay *display;
66 GdkGLContext *gdk_context;
67 GstGLContext *other_context;
68 GstGLContext *context;
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
86 gtk_gst_gl_widget_bind_buffer (GtkGstGLWidget * gst_widget)
88 GtkGstGLWidgetPrivate *priv = gst_widget->priv;
89 const GstGLFuncs *gl = priv->context->gl_vtable;
91 gl->BindBuffer (GL_ARRAY_BUFFER, priv->vertex_buffer);
93 /* Load the vertex position */
94 gl->VertexAttribPointer (priv->attr_position, 3, GL_FLOAT, GL_FALSE,
95 5 * sizeof (GLfloat), (void *) 0);
97 /* Load the texture coordinate */
98 gl->VertexAttribPointer (priv->attr_texture, 2, GL_FLOAT, GL_FALSE,
99 5 * sizeof (GLfloat), (void *) (3 * sizeof (GLfloat)));
101 gl->EnableVertexAttribArray (priv->attr_position);
102 gl->EnableVertexAttribArray (priv->attr_texture);
106 gtk_gst_gl_widget_unbind_buffer (GtkGstGLWidget * gst_widget)
108 GtkGstGLWidgetPrivate *priv = gst_widget->priv;
109 const GstGLFuncs *gl = priv->context->gl_vtable;
111 gl->BindBuffer (GL_ARRAY_BUFFER, 0);
113 gl->DisableVertexAttribArray (priv->attr_position);
114 gl->DisableVertexAttribArray (priv->attr_texture);
118 gtk_gst_gl_widget_init_redisplay (GtkGstGLWidget * gst_widget)
120 GtkGstGLWidgetPrivate *priv = gst_widget->priv;
121 const GstGLFuncs *gl = priv->context->gl_vtable;
123 priv->shader = gst_gl_shader_new (priv->context);
125 gst_gl_shader_compile_with_default_vf_and_check (priv->shader,
126 &priv->attr_position, &priv->attr_texture);
128 if (gl->GenVertexArrays) {
129 gl->GenVertexArrays (1, &priv->vao);
130 gl->BindVertexArray (priv->vao);
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,
138 if (gl->GenVertexArrays) {
139 gtk_gst_gl_widget_bind_buffer (gst_widget);
140 gl->BindVertexArray (0);
143 gl->BindBuffer (GL_ARRAY_BUFFER, 0);
145 priv->initted = TRUE;
149 _redraw_texture (GtkGstGLWidget * gst_widget, guint tex)
151 GtkGstGLWidgetPrivate *priv = gst_widget->priv;
152 const GstGLFuncs *gl = priv->context->gl_vtable;
153 const GLushort indices[] = { 0, 1, 2, 0, 2, 3 };
155 if (gst_widget->base.force_aspect_ratio) {
156 GstVideoRectangle src, dst, result;
157 gint widget_width, widget_height, widget_scale;
159 gl->ClearColor (0.0, 0.0, 0.0, 0.0);
160 gl->Clear (GL_COLOR_BUFFER_BIT);
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);
168 src.w = gst_widget->base.display_width;
169 src.h = gst_widget->base.display_height;
173 dst.w = widget_width * widget_scale;
174 dst.h = widget_height * widget_scale;
176 gst_video_sink_center_rect (src, dst, &result, TRUE);
178 gl->Viewport (result.x, result.y, result.w, result.h);
181 gst_gl_shader_use (priv->shader);
183 if (gl->BindVertexArray)
184 gl->BindVertexArray (priv->vao);
186 gtk_gst_gl_widget_bind_buffer (gst_widget);
188 gl->ActiveTexture (GL_TEXTURE0);
189 gl->BindTexture (GL_TEXTURE_2D, tex);
190 gst_gl_shader_set_uniform_1i (priv->shader, "tex", 0);
192 gl->DrawElements (GL_TRIANGLES, 6, GL_UNSIGNED_SHORT, indices);
194 if (gl->BindVertexArray)
195 gl->BindVertexArray (0);
197 gtk_gst_gl_widget_unbind_buffer (gst_widget);
199 gl->BindTexture (GL_TEXTURE_2D, 0);
203 gtk_gst_gl_widget_render (GtkGLArea * widget, GdkGLContext * context)
205 GtkGstGLWidgetPrivate *priv = GTK_GST_GL_WIDGET (widget)->priv;
206 GtkGstBaseWidget *base_widget = GTK_GST_BASE_WIDGET (widget);
208 GTK_GST_BASE_WIDGET_LOCK (widget);
210 if (!priv->initted && priv->context)
211 gtk_gst_gl_widget_init_redisplay (GTK_GST_GL_WIDGET (widget));
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);
217 gst_gl_context_activate (priv->other_context, TRUE);
219 if (base_widget->new_buffer || priv->current_tex == 0) {
220 GstVideoFrame gl_frame;
221 GstGLSyncMeta *sync_meta;
223 if (!gst_video_frame_map (&gl_frame, &base_widget->v_info,
224 base_widget->buffer, GST_MAP_READ | GST_MAP_GL)) {
228 sync_meta = gst_buffer_get_gl_sync_meta (base_widget->buffer);
230 gst_gl_sync_meta_set_sync_point (sync_meta, priv->context);
231 gst_gl_sync_meta_wait (sync_meta, priv->other_context);
234 priv->current_tex = *(guint *) gl_frame.data[0];
236 gst_video_frame_unmap (&gl_frame);
239 _redraw_texture (GTK_GST_GL_WIDGET (widget), priv->current_tex);
240 base_widget->new_buffer = FALSE;
243 /* FIXME: nothing to display */
244 glClearColor (0.0, 0.0, 0.0, 0.0);
245 glClear (GL_COLOR_BUFFER_BIT);
248 if (priv->other_context)
249 gst_gl_context_activate (priv->other_context, FALSE);
251 GTK_GST_BASE_WIDGET_UNLOCK (widget);
255 typedef void (*ThreadFunc) (gpointer data);
257 struct invoke_context
267 _invoke_func (struct invoke_context *info)
269 g_mutex_lock (&info->lock);
270 info->func (info->data);
272 g_cond_signal (&info->cond);
273 g_mutex_unlock (&info->lock);
275 return G_SOURCE_REMOVE;
279 _invoke_on_main (ThreadFunc func, gpointer data)
281 GMainContext *main_context = g_main_context_default ();
282 struct invoke_context info;
284 g_mutex_init (&info.lock);
285 g_cond_init (&info.cond);
290 g_main_context_invoke (main_context, (GSourceFunc) _invoke_func, &info);
292 g_mutex_lock (&info.lock);
294 g_cond_wait (&info.cond, &info.lock);
295 g_mutex_unlock (&info.lock);
297 g_mutex_clear (&info.lock);
298 g_cond_clear (&info.cond);
302 _reset_gl (GtkGstGLWidget * gst_widget)
304 GtkGstGLWidgetPrivate *priv = gst_widget->priv;
305 const GstGLFuncs *gl = priv->other_context->gl_vtable;
307 if (!priv->gdk_context)
308 priv->gdk_context = gtk_gl_area_get_context (GTK_GL_AREA (gst_widget));
310 if (priv->gdk_context == NULL)
313 gdk_gl_context_make_current (priv->gdk_context);
314 gst_gl_context_activate (priv->other_context, TRUE);
317 gl->DeleteVertexArrays (1, &priv->vao);
321 if (priv->vertex_buffer) {
322 gl->DeleteBuffers (1, &priv->vertex_buffer);
323 priv->vertex_buffer = 0;
327 gst_object_unref (priv->upload);
332 gst_object_unref (priv->shader);
336 gst_gl_context_activate (priv->other_context, FALSE);
338 gst_object_unref (priv->other_context);
339 priv->other_context = NULL;
341 gdk_gl_context_clear_current ();
343 g_object_unref (priv->gdk_context);
344 priv->gdk_context = NULL;
348 _reset (GtkGstBaseWidget * base_widget)
350 GtkGstGLWidgetPrivate *priv = GTK_GST_GL_WIDGET (base_widget)->priv;
352 priv->initted = FALSE;
354 priv->vertex_buffer = 0;
355 priv->attr_position = 0;
356 priv->attr_texture = 0;
357 priv->current_tex = 0;
359 gtk_gl_area_set_has_alpha (GTK_GL_AREA (base_widget),
360 !base_widget->ignore_alpha);
363 /* called from main thread */
365 gtk_gst_gl_widget_reset (GtkGstBaseWidget * base_widget)
367 GtkGstGLWidgetPrivate *priv = GTK_GST_GL_WIDGET (base_widget)->priv;
368 const GstGLFuncs *gl = priv->other_context->gl_vtable;
370 _reset (base_widget);
373 gl->DeleteVertexArrays (1, &priv->vao);
377 if (priv->vertex_buffer) {
378 gl->DeleteBuffers (1, &priv->vertex_buffer);
379 priv->vertex_buffer = 0;
384 gtk_gst_gl_widget_finalize (GObject * object)
386 GtkGstGLWidgetPrivate *priv = GTK_GST_GL_WIDGET (object)->priv;
387 GtkGstBaseWidget *base_widget = GTK_GST_BASE_WIDGET (object);
389 _reset (base_widget);
391 if (priv->other_context)
392 _invoke_on_main ((ThreadFunc) _reset_gl, base_widget);
395 gst_object_unref (priv->context);
398 gst_object_unref (priv->display);
400 gtk_gst_base_widget_finalize (object);
401 G_OBJECT_CLASS (gtk_gst_gl_widget_parent_class)->finalize (object);
405 gtk_gst_gl_widget_class_init (GtkGstGLWidgetClass * klass)
407 GObjectClass *gobject_klass = (GObjectClass *) klass;
408 GtkGLAreaClass *gl_widget_klass = (GtkGLAreaClass *) klass;
409 GtkGstBaseWidget *base_widget_klass = (GtkGstBaseWidget *) klass;
411 g_type_class_add_private (klass, sizeof (GtkGstGLWidgetPrivate));
412 gtk_gst_base_widget_class_init (GTK_GST_BASE_WIDGET_CLASS (klass));
414 gobject_klass->finalize = gtk_gst_gl_widget_finalize;
415 gl_widget_klass->render = gtk_gst_gl_widget_render;
416 base_widget_klass->reset = gtk_gst_gl_widget_reset;
420 gtk_gst_gl_widget_init (GtkGstGLWidget * gst_widget)
422 GtkGstBaseWidget *base_widget = GTK_GST_BASE_WIDGET (gst_widget);
424 GtkGstGLWidgetPrivate *priv;
426 gtk_gst_base_widget_init (base_widget);
428 gst_widget->priv = priv = GTK_GST_GL_WIDGET_GET_PRIVATE (gst_widget);
430 display = gdk_display_get_default ();
432 #if GST_GL_HAVE_WINDOW_X11 && defined (GDK_WINDOWING_X11)
433 if (GDK_IS_X11_DISPLAY (display))
434 priv->display = (GstGLDisplay *)
435 gst_gl_display_x11_new_with_display (gdk_x11_display_get_xdisplay
438 #if GST_GL_HAVE_WINDOW_WAYLAND && defined (GDK_WINDOWING_WAYLAND)
439 if (GDK_IS_WAYLAND_DISPLAY (display)) {
440 struct wl_display *wayland_display =
441 gdk_wayland_display_get_wl_display (display);
442 priv->display = (GstGLDisplay *)
443 gst_gl_display_wayland_new_with_display (wayland_display);
450 priv->display = gst_gl_display_new ();
452 gtk_gl_area_set_has_alpha (GTK_GL_AREA (gst_widget),
453 !base_widget->ignore_alpha);
459 _get_gl_context (GtkGstGLWidget * gst_widget)
461 GtkGstGLWidgetPrivate *priv = gst_widget->priv;
462 GstGLPlatform platform;
466 gtk_widget_realize (GTK_WIDGET (gst_widget));
468 if (priv->gdk_context)
469 g_object_unref (priv->gdk_context);
470 priv->gdk_context = gtk_gl_area_get_context (GTK_GL_AREA (gst_widget));
471 if (priv->gdk_context == NULL) {
472 g_assert_not_reached ();
476 g_object_ref (priv->gdk_context);
478 gdk_gl_context_make_current (priv->gdk_context);
480 #if GST_GL_HAVE_WINDOW_X11 && defined (GDK_WINDOWING_X11)
481 if (GST_IS_GL_DISPLAY_X11 (priv->display)) {
482 platform = GST_GL_PLATFORM_GLX;
483 gl_api = gst_gl_context_get_current_gl_api (NULL, NULL);
484 gl_handle = gst_gl_context_get_current_gl_context (platform);
486 priv->other_context =
487 gst_gl_context_new_wrapped (priv->display, gl_handle,
491 #if GST_GL_HAVE_WINDOW_WAYLAND && defined (GDK_WINDOWING_WAYLAND)
492 if (GST_IS_GL_DISPLAY_WAYLAND (priv->display)) {
493 platform = GST_GL_PLATFORM_EGL;
494 gl_api = gst_gl_context_get_current_gl_api (NULL, NULL);
495 gl_handle = gst_gl_context_get_current_gl_context (platform);
497 priv->other_context =
498 gst_gl_context_new_wrapped (priv->display, gl_handle,
507 if (priv->other_context) {
508 GError *error = NULL;
510 gst_gl_context_activate (priv->other_context, TRUE);
511 if (!gst_gl_context_fill_info (priv->other_context, &error)) {
512 GST_ERROR ("failed to retreive gdk context info: %s", error->message);
513 g_object_unref (priv->other_context);
514 priv->other_context = NULL;
516 gst_gl_context_activate (priv->other_context, FALSE);
522 gtk_gst_gl_widget_new (void)
524 return (GtkWidget *) g_object_new (GTK_TYPE_GST_GL_WIDGET, NULL);
528 gtk_gst_gl_widget_init_winsys (GtkGstGLWidget * gst_widget)
530 GtkGstGLWidgetPrivate *priv = gst_widget->priv;
532 g_return_val_if_fail (GTK_IS_GST_GL_WIDGET (gst_widget), FALSE);
534 GTK_GST_BASE_WIDGET_LOCK (gst_widget);
536 if (priv->display && priv->gdk_context && priv->other_context) {
537 GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
541 if (!priv->other_context) {
542 GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
543 _invoke_on_main ((ThreadFunc) _get_gl_context, gst_widget);
544 GTK_GST_BASE_WIDGET_LOCK (gst_widget);
547 if (!GST_GL_IS_CONTEXT (priv->other_context)) {
548 GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
552 priv->context = gst_gl_context_new (priv->display);
554 if (!priv->context) {
555 GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
559 gst_gl_context_create (priv->context, priv->other_context, NULL);
561 GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
566 gtk_gst_gl_widget_get_gtk_context (GtkGstGLWidget * gst_widget)
568 if (!gst_widget->priv->other_context)
571 return gst_object_ref (gst_widget->priv->other_context);
575 gtk_gst_gl_widget_get_context (GtkGstGLWidget * gst_widget)
577 if (!gst_widget->priv->context)
580 return gst_object_ref (gst_widget->priv->context);
584 gtk_gst_gl_widget_get_display (GtkGstGLWidget * gst_widget)
586 if (!gst_widget->priv->display)
589 return gst_object_ref (gst_widget->priv->display);