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 "gstgtkutils.h"
29 #include <gst/video/video.h>
31 #if GST_GL_HAVE_WINDOW_X11 && GST_GL_HAVE_PLATFORM_GLX && defined (GDK_WINDOWING_X11)
33 #include <gst/gl/x11/gstgldisplay_x11.h>
34 #include <gst/gl/x11/gstglcontext_glx.h>
37 #if GST_GL_HAVE_WINDOW_WAYLAND && GST_GL_HAVE_PLATFORM_EGL && defined (GDK_WINDOWING_WAYLAND)
38 #include <gdk/gdkwayland.h>
39 #include <gst/gl/wayland/gstgldisplay_wayland.h>
43 * SECTION:gtkgstglwidget
44 * @short_description: a #GtkGLArea that renders GStreamer video #GstBuffers
45 * @see_also: #GtkGLArea, #GstBuffer
47 * #GtkGstGLWidget is an #GtkWidget that renders GStreamer video buffers.
50 #define GST_CAT_DEFAULT gtk_gst_gl_widget_debug
51 GST_DEBUG_CATEGORY_STATIC (GST_CAT_DEFAULT);
53 G_DEFINE_TYPE_WITH_CODE (GtkGstGLWidget, gtk_gst_gl_widget, GTK_TYPE_GL_AREA,
54 GST_DEBUG_CATEGORY_INIT (GST_CAT_DEFAULT, "gtkgstglwidget", 0,
55 "Gtk Gst GL Widget"););
57 #define GTK_GST_GL_WIDGET_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), \
58 GTK_TYPE_GST_GL_WIDGET, GtkGstGLWidgetPrivate))
60 struct _GtkGstGLWidgetPrivate
63 GstGLDisplay *display;
64 GdkGLContext *gdk_context;
65 GstGLContext *other_context;
66 GstGLContext *context;
74 GstGLOverlayCompositor *overlay_compositor;
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
85 gtk_gst_gl_widget_bind_buffer (GtkGstGLWidget * gst_widget)
87 GtkGstGLWidgetPrivate *priv = gst_widget->priv;
88 const GstGLFuncs *gl = priv->context->gl_vtable;
90 gl->BindBuffer (GL_ARRAY_BUFFER, priv->vertex_buffer);
92 /* Load the vertex position */
93 gl->VertexAttribPointer (priv->attr_position, 3, GL_FLOAT, GL_FALSE,
94 5 * sizeof (GLfloat), (void *) 0);
96 /* Load the texture coordinate */
97 gl->VertexAttribPointer (priv->attr_texture, 2, GL_FLOAT, GL_FALSE,
98 5 * sizeof (GLfloat), (void *) (3 * sizeof (GLfloat)));
100 gl->EnableVertexAttribArray (priv->attr_position);
101 gl->EnableVertexAttribArray (priv->attr_texture);
105 gtk_gst_gl_widget_unbind_buffer (GtkGstGLWidget * gst_widget)
107 GtkGstGLWidgetPrivate *priv = gst_widget->priv;
108 const GstGLFuncs *gl = priv->context->gl_vtable;
110 gl->BindBuffer (GL_ARRAY_BUFFER, 0);
112 gl->DisableVertexAttribArray (priv->attr_position);
113 gl->DisableVertexAttribArray (priv->attr_texture);
117 gtk_gst_gl_widget_init_redisplay (GtkGstGLWidget * gst_widget)
119 GtkGstGLWidgetPrivate *priv = gst_widget->priv;
120 const GstGLFuncs *gl = priv->context->gl_vtable;
121 GError *error = NULL;
123 gst_gl_insert_debug_marker (priv->other_context, "initializing redisplay");
124 if (!(priv->shader = gst_gl_shader_new_default (priv->context, &error))) {
125 GST_ERROR ("Failed to initialize shader: %s", error->message);
129 priv->attr_position =
130 gst_gl_shader_get_attribute_location (priv->shader, "a_position");
132 gst_gl_shader_get_attribute_location (priv->shader, "a_texcoord");
134 if (gl->GenVertexArrays) {
135 gl->GenVertexArrays (1, &priv->vao);
136 gl->BindVertexArray (priv->vao);
139 gl->GenBuffers (1, &priv->vertex_buffer);
140 gl->BindBuffer (GL_ARRAY_BUFFER, priv->vertex_buffer);
141 gl->BufferData (GL_ARRAY_BUFFER, 4 * 5 * sizeof (GLfloat), vertices,
144 if (gl->GenVertexArrays) {
145 gtk_gst_gl_widget_bind_buffer (gst_widget);
146 gl->BindVertexArray (0);
149 gl->BindBuffer (GL_ARRAY_BUFFER, 0);
151 priv->overlay_compositor =
152 gst_gl_overlay_compositor_new (priv->other_context);
154 priv->initted = TRUE;
158 _redraw_texture (GtkGstGLWidget * gst_widget, guint tex)
160 GtkGstGLWidgetPrivate *priv = gst_widget->priv;
161 const GstGLFuncs *gl = priv->context->gl_vtable;
162 const GLushort indices[] = { 0, 1, 2, 0, 2, 3 };
164 if (gst_widget->base.force_aspect_ratio) {
165 GstVideoRectangle src, dst, result;
166 gint widget_width, widget_height, widget_scale;
168 gl->ClearColor (0.0, 0.0, 0.0, 0.0);
169 gl->Clear (GL_COLOR_BUFFER_BIT);
171 widget_scale = gtk_widget_get_scale_factor ((GtkWidget *) gst_widget);
172 widget_width = gtk_widget_get_allocated_width ((GtkWidget *) gst_widget);
173 widget_height = gtk_widget_get_allocated_height ((GtkWidget *) gst_widget);
177 src.w = gst_widget->base.display_width;
178 src.h = gst_widget->base.display_height;
182 dst.w = widget_width * widget_scale;
183 dst.h = widget_height * widget_scale;
185 gst_video_sink_center_rect (src, dst, &result, TRUE);
187 gl->Viewport (result.x, result.y, result.w, result.h);
190 gst_gl_shader_use (priv->shader);
192 if (gl->BindVertexArray)
193 gl->BindVertexArray (priv->vao);
195 gtk_gst_gl_widget_bind_buffer (gst_widget);
197 gl->ActiveTexture (GL_TEXTURE0);
198 gl->BindTexture (GL_TEXTURE_2D, tex);
199 gst_gl_shader_set_uniform_1i (priv->shader, "tex", 0);
201 gl->DrawElements (GL_TRIANGLES, 6, GL_UNSIGNED_SHORT, indices);
203 if (gl->BindVertexArray)
204 gl->BindVertexArray (0);
206 gtk_gst_gl_widget_unbind_buffer (gst_widget);
208 gl->BindTexture (GL_TEXTURE_2D, 0);
212 _draw_black (GstGLContext * context)
214 const GstGLFuncs *gl = context->gl_vtable;
216 gst_gl_insert_debug_marker (context, "no buffer. rendering black");
217 gl->ClearColor (0.0, 0.0, 0.0, 0.0);
218 gl->Clear (GL_COLOR_BUFFER_BIT);
222 gtk_gst_gl_widget_render (GtkGLArea * widget, GdkGLContext * context)
224 GtkGstGLWidgetPrivate *priv = GTK_GST_GL_WIDGET (widget)->priv;
225 GtkGstBaseWidget *base_widget = GTK_GST_BASE_WIDGET (widget);
227 GTK_GST_BASE_WIDGET_LOCK (widget);
229 if (!priv->context || !priv->other_context)
232 gst_gl_context_activate (priv->other_context, TRUE);
235 gtk_gst_gl_widget_init_redisplay (GTK_GST_GL_WIDGET (widget));
237 if (!priv->initted || !base_widget->negotiated) {
238 _draw_black (priv->other_context);
242 /* Upload latest buffer */
243 if (base_widget->pending_buffer) {
244 GstBuffer *buffer = base_widget->pending_buffer;
245 GstVideoFrame gl_frame;
246 GstGLSyncMeta *sync_meta;
248 if (!gst_video_frame_map (&gl_frame, &base_widget->v_info, buffer,
249 GST_MAP_READ | GST_MAP_GL)) {
250 _draw_black (priv->other_context);
254 priv->current_tex = *(guint *) gl_frame.data[0];
255 gst_gl_insert_debug_marker (priv->other_context, "redrawing texture %u",
258 gst_gl_overlay_compositor_upload_overlays (priv->overlay_compositor,
261 sync_meta = gst_buffer_get_gl_sync_meta (buffer);
263 /* XXX: the set_sync() seems to be needed for resizing */
264 gst_gl_sync_meta_set_sync_point (sync_meta, priv->context);
265 gst_gl_sync_meta_wait (sync_meta, priv->other_context);
268 gst_video_frame_unmap (&gl_frame);
270 if (base_widget->buffer)
271 gst_buffer_unref (base_widget->buffer);
273 /* Keep the buffer to ensure current_tex stay valid */
274 base_widget->buffer = buffer;
275 base_widget->pending_buffer = NULL;
278 GST_DEBUG ("rendering buffer %p with gdk context %p",
279 base_widget->buffer, context);
281 _redraw_texture (GTK_GST_GL_WIDGET (widget), priv->current_tex);
282 gst_gl_overlay_compositor_draw_overlays (priv->overlay_compositor);
284 gst_gl_insert_debug_marker (priv->other_context, "texture %u redrawn",
288 if (priv->other_context)
289 gst_gl_context_activate (priv->other_context, FALSE);
291 GTK_GST_BASE_WIDGET_UNLOCK (widget);
296 _reset_gl (GtkGstGLWidget * gst_widget)
298 GtkGstGLWidgetPrivate *priv = gst_widget->priv;
299 const GstGLFuncs *gl = priv->other_context->gl_vtable;
301 if (!priv->gdk_context)
302 priv->gdk_context = gtk_gl_area_get_context (GTK_GL_AREA (gst_widget));
304 if (priv->gdk_context == NULL)
307 gdk_gl_context_make_current (priv->gdk_context);
308 gst_gl_context_activate (priv->other_context, TRUE);
311 gl->DeleteVertexArrays (1, &priv->vao);
315 if (priv->vertex_buffer) {
316 gl->DeleteBuffers (1, &priv->vertex_buffer);
317 priv->vertex_buffer = 0;
321 gst_object_unref (priv->upload);
326 gst_object_unref (priv->shader);
330 if (priv->overlay_compositor)
331 gst_object_unref (priv->overlay_compositor);
333 gst_gl_context_activate (priv->other_context, FALSE);
335 gst_object_unref (priv->other_context);
336 priv->other_context = NULL;
338 gdk_gl_context_clear_current ();
340 g_object_unref (priv->gdk_context);
341 priv->gdk_context = NULL;
345 gtk_gst_gl_widget_finalize (GObject * object)
347 GtkGstGLWidgetPrivate *priv = GTK_GST_GL_WIDGET (object)->priv;
348 GtkGstBaseWidget *base_widget = GTK_GST_BASE_WIDGET (object);
350 if (priv->other_context)
351 gst_gtk_invoke_on_main ((GThreadFunc) _reset_gl, base_widget);
354 gst_object_unref (priv->context);
357 gst_object_unref (priv->display);
359 gtk_gst_base_widget_finalize (object);
360 G_OBJECT_CLASS (gtk_gst_gl_widget_parent_class)->finalize (object);
364 gtk_gst_gl_widget_class_init (GtkGstGLWidgetClass * klass)
366 GObjectClass *gobject_klass = (GObjectClass *) klass;
367 GtkGLAreaClass *gl_widget_klass = (GtkGLAreaClass *) klass;
369 g_type_class_add_private (klass, sizeof (GtkGstGLWidgetPrivate));
370 gtk_gst_base_widget_class_init (GTK_GST_BASE_WIDGET_CLASS (klass));
372 gobject_klass->finalize = gtk_gst_gl_widget_finalize;
373 gl_widget_klass->render = gtk_gst_gl_widget_render;
377 gtk_gst_gl_widget_init (GtkGstGLWidget * gst_widget)
379 GtkGstBaseWidget *base_widget = GTK_GST_BASE_WIDGET (gst_widget);
381 GtkGstGLWidgetPrivate *priv;
383 gtk_gst_base_widget_init (base_widget);
385 gst_widget->priv = priv = GTK_GST_GL_WIDGET_GET_PRIVATE (gst_widget);
387 display = gdk_display_get_default ();
389 #if GST_GL_HAVE_WINDOW_X11 && GST_GL_HAVE_PLATFORM_GLX && defined (GDK_WINDOWING_X11)
390 if (GDK_IS_X11_DISPLAY (display))
391 priv->display = (GstGLDisplay *)
392 gst_gl_display_x11_new_with_display (gdk_x11_display_get_xdisplay
395 #if GST_GL_HAVE_WINDOW_WAYLAND && GST_GL_HAVE_PLATFORM_EGL && defined (GDK_WINDOWING_WAYLAND)
396 if (GDK_IS_WAYLAND_DISPLAY (display)) {
397 struct wl_display *wayland_display =
398 gdk_wayland_display_get_wl_display (display);
399 priv->display = (GstGLDisplay *)
400 gst_gl_display_wayland_new_with_display (wayland_display);
407 priv->display = gst_gl_display_new ();
409 gtk_gl_area_set_has_alpha (GTK_GL_AREA (gst_widget),
410 !base_widget->ignore_alpha);
414 _get_gl_context (GtkGstGLWidget * gst_widget)
416 GtkGstGLWidgetPrivate *priv = gst_widget->priv;
417 GstGLPlatform platform;
421 gtk_widget_realize (GTK_WIDGET (gst_widget));
423 if (priv->gdk_context)
424 g_object_unref (priv->gdk_context);
425 priv->gdk_context = gtk_gl_area_get_context (GTK_GL_AREA (gst_widget));
426 if (priv->gdk_context == NULL) {
427 GError *error = gtk_gl_area_get_error (GTK_GL_AREA (gst_widget));
429 GST_ERROR_OBJECT (gst_widget, "Error creating GdkGLContext : %s",
430 error ? error->message : "No error set by Gdk");
431 g_clear_error (&error);
432 g_assert_not_reached ();
436 g_object_ref (priv->gdk_context);
438 gdk_gl_context_make_current (priv->gdk_context);
440 #if GST_GL_HAVE_WINDOW_X11 && GST_GL_HAVE_PLATFORM_GLX && defined (GDK_WINDOWING_X11)
441 if (GST_IS_GL_DISPLAY_X11 (priv->display)) {
442 platform = GST_GL_PLATFORM_GLX;
443 gl_api = gst_gl_context_get_current_gl_api (platform, NULL, NULL);
444 gl_handle = gst_gl_context_get_current_gl_context (platform);
446 priv->other_context =
447 gst_gl_context_new_wrapped (priv->display, gl_handle,
451 #if GST_GL_HAVE_WINDOW_WAYLAND && GST_GL_HAVE_PLATFORM_EGL && defined (GDK_WINDOWING_WAYLAND)
452 if (GST_IS_GL_DISPLAY_WAYLAND (priv->display)) {
453 platform = GST_GL_PLATFORM_EGL;
454 gl_api = gst_gl_context_get_current_gl_api (platform, NULL, NULL);
455 gl_handle = gst_gl_context_get_current_gl_context (platform);
457 priv->other_context =
458 gst_gl_context_new_wrapped (priv->display, gl_handle,
467 if (priv->other_context) {
468 GError *error = NULL;
470 gst_gl_context_activate (priv->other_context, TRUE);
471 if (!gst_gl_context_fill_info (priv->other_context, &error)) {
472 GST_ERROR ("failed to retrieve gdk context info: %s", error->message);
473 g_clear_error (&error);
474 g_object_unref (priv->other_context);
475 priv->other_context = NULL;
477 gst_gl_context_activate (priv->other_context, FALSE);
483 gtk_gst_gl_widget_new (void)
485 return (GtkWidget *) g_object_new (GTK_TYPE_GST_GL_WIDGET, NULL);
489 gtk_gst_gl_widget_init_winsys (GtkGstGLWidget * gst_widget)
491 GtkGstGLWidgetPrivate *priv = gst_widget->priv;
492 GError *error = NULL;
494 g_return_val_if_fail (GTK_IS_GST_GL_WIDGET (gst_widget), FALSE);
496 GTK_GST_BASE_WIDGET_LOCK (gst_widget);
498 if (priv->display && priv->gdk_context && priv->other_context) {
499 GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
503 if (!priv->other_context) {
504 GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
505 gst_gtk_invoke_on_main ((GThreadFunc) _get_gl_context, gst_widget);
506 GTK_GST_BASE_WIDGET_LOCK (gst_widget);
509 if (!GST_IS_GL_CONTEXT (priv->other_context)) {
510 GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
514 if (!gst_gl_display_create_context (priv->display, priv->other_context,
515 &priv->context, &error)) {
516 g_clear_error (&error);
517 GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
521 GTK_GST_BASE_WIDGET_UNLOCK (gst_widget);
526 gtk_gst_gl_widget_get_gtk_context (GtkGstGLWidget * gst_widget)
528 if (!gst_widget->priv->other_context)
531 return gst_object_ref (gst_widget->priv->other_context);
535 gtk_gst_gl_widget_get_context (GtkGstGLWidget * gst_widget)
537 if (!gst_widget->priv->context)
540 return gst_object_ref (gst_widget->priv->context);
544 gtk_gst_gl_widget_get_display (GtkGstGLWidget * gst_widget)
546 if (!gst_widget->priv->display)
549 return gst_object_ref (gst_widget->priv->display);