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>
37 * SECTION:gtkgstglwidget
38 * @short_description: a #GtkGLArea that renders GStreamer video #GstBuffers
39 * @see_also: #GtkGLArea, #GstBuffer
41 * #GtkGstGLWidget is an #GtkWidget that renders GStreamer video buffers.
44 #define GST_CAT_DEFAULT gtk_gst_gl_widget_debug
45 GST_DEBUG_CATEGORY_STATIC (GST_CAT_DEFAULT);
47 G_DEFINE_TYPE_WITH_CODE (GtkGstGLWidget, gtk_gst_gl_widget, GTK_TYPE_GL_AREA,
48 GST_DEBUG_CATEGORY_INIT (GST_CAT_DEFAULT, "gtkgstglwidget", 0,
49 "Gtk Gst GL Widget"););
51 #define GTK_GST_GL_WIDGET_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), \
52 GTK_TYPE_GST_GL_WIDGET, GtkGstGLWidgetPrivate))
54 #define DEFAULT_FORCE_ASPECT_RATIO TRUE
59 PROP_FORCE_ASPECT_RATIO,
62 struct _GtkGstGLWidgetPrivate
67 gboolean force_aspect_ratio;
77 GstGLDisplay *display;
78 GdkGLContext *gdk_context;
79 GstGLContext *other_context;
80 GstGLContext *context;
91 gtk_gst_gl_widget_get_preferred_width (GtkWidget * widget, gint * min,
94 GtkGstGLWidget *gst_widget = (GtkGstGLWidget *) widget;
95 gint video_width = GST_VIDEO_INFO_WIDTH (&gst_widget->priv->v_info);
97 if (!gst_widget->priv->negotiated)
103 *natural = video_width;
107 gtk_gst_gl_widget_get_preferred_height (GtkWidget * widget, gint * min,
110 GtkGstGLWidget *gst_widget = (GtkGstGLWidget *) widget;
111 gint video_height = GST_VIDEO_INFO_HEIGHT (&gst_widget->priv->v_info);
113 if (!gst_widget->priv->negotiated)
119 *natural = video_height;
122 static const GLfloat vertices[] = {
123 1.0f, 1.0f, 0.0f, 1.0f, 0.0f,
124 -1.0f, 1.0f, 0.0f, 0.0f, 0.0f,
125 -1.0f, -1.0f, 0.0f, 0.0f, 1.0f,
126 1.0f, -1.0f, 0.0f, 1.0f, 1.0f
130 gtk_gst_gl_widget_bind_buffer (GtkGstGLWidget * gst_widget)
132 const GstGLFuncs *gl = gst_widget->priv->context->gl_vtable;
134 gl->BindBuffer (GL_ARRAY_BUFFER, gst_widget->priv->vertex_buffer);
136 /* Load the vertex position */
137 gl->VertexAttribPointer (gst_widget->priv->attr_position, 3, GL_FLOAT,
138 GL_FALSE, 5 * sizeof (GLfloat), (void *) 0);
140 /* Load the texture coordinate */
141 gl->VertexAttribPointer (gst_widget->priv->attr_texture, 2, GL_FLOAT,
142 GL_FALSE, 5 * sizeof (GLfloat), (void *) (3 * sizeof (GLfloat)));
144 gl->EnableVertexAttribArray (gst_widget->priv->attr_position);
145 gl->EnableVertexAttribArray (gst_widget->priv->attr_texture);
149 gtk_gst_gl_widget_unbind_buffer (GtkGstGLWidget * gst_widget)
151 const GstGLFuncs *gl = gst_widget->priv->context->gl_vtable;
153 gl->BindBuffer (GL_ARRAY_BUFFER, 0);
155 gl->DisableVertexAttribArray (gst_widget->priv->attr_position);
156 gl->DisableVertexAttribArray (gst_widget->priv->attr_texture);
160 gtk_gst_gl_widget_init_redisplay (GtkGstGLWidget * gst_widget)
162 const GstGLFuncs *gl = gst_widget->priv->context->gl_vtable;
164 gst_widget->priv->shader = gst_gl_shader_new (gst_widget->priv->context);
166 gst_gl_shader_compile_with_default_vf_and_check
167 (gst_widget->priv->shader, &gst_widget->priv->attr_position,
168 &gst_widget->priv->attr_texture);
170 if (gl->GenVertexArrays) {
171 gl->GenVertexArrays (1, &gst_widget->priv->vao);
172 gl->BindVertexArray (gst_widget->priv->vao);
175 gl->GenBuffers (1, &gst_widget->priv->vertex_buffer);
176 gl->BindBuffer (GL_ARRAY_BUFFER, gst_widget->priv->vertex_buffer);
177 gl->BufferData (GL_ARRAY_BUFFER, 4 * 5 * sizeof (GLfloat), vertices,
180 if (gl->GenVertexArrays) {
181 gtk_gst_gl_widget_bind_buffer (gst_widget);
182 gl->BindVertexArray (0);
185 gl->BindBuffer (GL_ARRAY_BUFFER, 0);
187 gst_widget->priv->initted = TRUE;
191 _redraw_texture (GtkGstGLWidget * gst_widget, guint tex)
193 const GstGLFuncs *gl = gst_widget->priv->context->gl_vtable;
194 GLushort indices[] = { 0, 1, 2, 0, 2, 3 };
196 if (gst_widget->priv->force_aspect_ratio) {
197 GstVideoRectangle src, dst, result;
198 gint gtk_viewport[4];
200 gl->ClearColor (0.0, 0.0, 0.0, 0.0);
201 gl->Clear (GL_COLOR_BUFFER_BIT);
203 gl->GetIntegerv (GL_VIEWPORT, gtk_viewport);
207 src.w = GST_VIDEO_INFO_WIDTH (&gst_widget->priv->v_info);
208 src.h = GST_VIDEO_INFO_HEIGHT (&gst_widget->priv->v_info);
210 dst.x = gtk_viewport[0];
211 dst.y = gtk_viewport[1];
212 dst.w = gtk_viewport[2];
213 dst.h = gtk_viewport[3];
215 gst_video_sink_center_rect (src, dst, &result, TRUE);
217 gl->Viewport (result.x, result.y, result.w, result.h);
220 gst_gl_shader_use (gst_widget->priv->shader);
222 if (gl->BindVertexArray)
223 gl->BindVertexArray (gst_widget->priv->vao);
225 gtk_gst_gl_widget_bind_buffer (gst_widget);
227 gl->ActiveTexture (GL_TEXTURE0);
228 gl->BindTexture (GL_TEXTURE_2D, tex);
229 gst_gl_shader_set_uniform_1i (gst_widget->priv->shader, "tex", 0);
231 gl->DrawElements (GL_TRIANGLES, 6, GL_UNSIGNED_SHORT, indices);
233 if (gl->BindVertexArray)
234 gl->BindVertexArray (0);
236 gtk_gst_gl_widget_unbind_buffer (gst_widget);
238 gl->BindTexture (GL_TEXTURE_2D, 0);
242 gtk_gst_gl_widget_render (GtkGLArea * widget, GdkGLContext * context)
244 GtkGstGLWidget *gst_widget = (GtkGstGLWidget *) widget;
246 g_mutex_lock (&gst_widget->priv->lock);
248 if (!gst_widget->priv->initted && gst_widget->priv->context)
249 gtk_gst_gl_widget_init_redisplay (gst_widget);
251 if (gst_widget->priv->initted && gst_widget->priv->negotiated
252 && gst_widget->priv->buffer) {
253 GST_DEBUG ("rendering buffer %p with gdk context %p",
254 gst_widget->priv->buffer, context);
256 gst_gl_context_activate (gst_widget->priv->other_context, TRUE);
258 if (gst_widget->priv->new_buffer || gst_widget->priv->current_tex == 0) {
259 GstVideoFrame gl_frame;
260 GstGLSyncMeta *sync_meta;
262 if (!gst_video_frame_map (&gl_frame, &gst_widget->priv->v_info,
263 gst_widget->priv->buffer, GST_MAP_READ | GST_MAP_GL)) {
267 sync_meta = gst_buffer_get_gl_sync_meta (gst_widget->priv->buffer);
269 gst_gl_sync_meta_set_sync_point (sync_meta, gst_widget->priv->context);
270 gst_gl_sync_meta_wait (sync_meta, gst_widget->priv->other_context);
273 gst_widget->priv->current_tex = *(guint *) gl_frame.data[0];
275 gst_video_frame_unmap (&gl_frame);
278 _redraw_texture (gst_widget, gst_widget->priv->current_tex);
279 gst_widget->priv->new_buffer = FALSE;
282 /* FIXME: nothing to display */
283 glClearColor (0.0, 0.0, 0.0, 0.0);
284 glClear (GL_COLOR_BUFFER_BIT);
287 if (gst_widget->priv->other_context)
288 gst_gl_context_activate (gst_widget->priv->other_context, FALSE);
290 g_mutex_unlock (&gst_widget->priv->lock);
294 typedef void (*ThreadFunc) (gpointer data);
296 struct invoke_context
306 _invoke_func (struct invoke_context *info)
308 g_mutex_lock (&info->lock);
309 info->func (info->data);
311 g_cond_signal (&info->cond);
312 g_mutex_unlock (&info->lock);
314 return G_SOURCE_REMOVE;
318 _invoke_on_main (ThreadFunc func, gpointer data)
320 GMainContext *main_context = g_main_context_default ();
321 struct invoke_context info;
323 g_mutex_init (&info.lock);
324 g_cond_init (&info.cond);
329 g_main_context_invoke (main_context, (GSourceFunc) _invoke_func, &info);
331 g_mutex_lock (&info.lock);
333 g_cond_wait (&info.cond, &info.lock);
334 g_mutex_unlock (&info.lock);
336 g_mutex_clear (&info.lock);
337 g_cond_clear (&info.cond);
341 _reset_gl (GtkGstGLWidget * gst_widget)
343 const GstGLFuncs *gl = gst_widget->priv->other_context->gl_vtable;
345 if (!gst_widget->priv->gdk_context)
346 gst_widget->priv->gdk_context =
347 gtk_gl_area_get_context (GTK_GL_AREA (gst_widget));
348 if (gst_widget->priv->gdk_context == NULL)
351 gdk_gl_context_make_current (gst_widget->priv->gdk_context);
352 gst_gl_context_activate (gst_widget->priv->other_context, TRUE);
354 if (gst_widget->priv->vao) {
355 gl->DeleteVertexArrays (1, &gst_widget->priv->vao);
356 gst_widget->priv->vao = 0;
359 if (gst_widget->priv->vertex_buffer) {
360 gl->DeleteBuffers (1, &gst_widget->priv->vertex_buffer);
361 gst_widget->priv->vertex_buffer = 0;
364 if (gst_widget->priv->upload) {
365 gst_object_unref (gst_widget->priv->upload);
366 gst_widget->priv->upload = NULL;
369 if (gst_widget->priv->shader) {
370 gst_object_unref (gst_widget->priv->shader);
371 gst_widget->priv->shader = NULL;
374 gst_gl_context_activate (gst_widget->priv->other_context, FALSE);
376 gst_object_unref (gst_widget->priv->other_context);
377 gst_widget->priv->other_context = NULL;
379 gdk_gl_context_clear_current ();
381 g_object_unref (gst_widget->priv->gdk_context);
382 gst_widget->priv->gdk_context = NULL;
386 _reset (GtkGstGLWidget * gst_widget)
388 gst_buffer_replace (&gst_widget->priv->buffer, NULL);
390 gst_caps_replace (&gst_widget->priv->caps, NULL);
391 gst_caps_replace (&gst_widget->priv->gl_caps, NULL);
393 gst_widget->priv->negotiated = FALSE;
394 gst_widget->priv->initted = FALSE;
395 gst_widget->priv->vao = 0;
396 gst_widget->priv->vertex_buffer = 0;
397 gst_widget->priv->attr_position = 0;
398 gst_widget->priv->attr_texture = 0;
399 gst_widget->priv->current_tex = 0;
400 gst_widget->priv->new_buffer = TRUE;
404 gtk_gst_gl_widget_finalize (GObject * object)
406 GtkGstGLWidget *widget = GTK_GST_GL_WIDGET_CAST (object);
408 g_mutex_clear (&widget->priv->lock);
412 if (widget->priv->other_context) {
413 _invoke_on_main ((ThreadFunc) _reset_gl, widget);
416 if (widget->priv->context) {
417 gst_object_unref (widget->priv->context);
418 widget->priv->context = NULL;
421 if (widget->priv->display) {
422 gst_object_unref (widget->priv->display);
423 widget->priv->display = NULL;
426 G_OBJECT_CLASS (gtk_gst_gl_widget_parent_class)->finalize (object);
430 gtk_gst_gl_widget_set_property (GObject * object, guint prop_id,
431 const GValue * value, GParamSpec * pspec)
433 GtkGstGLWidget *gtk_widget = GTK_GST_GL_WIDGET (object);
436 case PROP_FORCE_ASPECT_RATIO:
437 gtk_widget->priv->force_aspect_ratio = g_value_get_boolean (value);
440 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
446 gtk_gst_gl_widget_get_property (GObject * object, guint prop_id, GValue * value,
449 GtkGstGLWidget *gtk_widget = GTK_GST_GL_WIDGET (object);
452 case PROP_FORCE_ASPECT_RATIO:
453 g_value_set_boolean (value, gtk_widget->priv->force_aspect_ratio);
456 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
462 gtk_gst_gl_widget_class_init (GtkGstGLWidgetClass * klass)
464 GObjectClass *gobject_klass = (GObjectClass *) klass;
465 GtkWidgetClass *widget_klass = (GtkWidgetClass *) klass;
466 GtkGLAreaClass *gl_widget_klass = (GtkGLAreaClass *) klass;
468 g_type_class_add_private (klass, sizeof (GtkGstGLWidgetPrivate));
470 gobject_klass->set_property = gtk_gst_gl_widget_set_property;
471 gobject_klass->get_property = gtk_gst_gl_widget_get_property;
472 gobject_klass->finalize = gtk_gst_gl_widget_finalize;
474 g_object_class_install_property (gobject_klass, PROP_FORCE_ASPECT_RATIO,
475 g_param_spec_boolean ("force-aspect-ratio",
476 "Force aspect ratio",
477 "When enabled, scaling will respect original aspect ratio",
478 DEFAULT_FORCE_ASPECT_RATIO,
479 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
481 gl_widget_klass->render = gtk_gst_gl_widget_render;
483 widget_klass->get_preferred_width = gtk_gst_gl_widget_get_preferred_width;
484 widget_klass->get_preferred_height = gtk_gst_gl_widget_get_preferred_height;
488 gtk_gst_gl_widget_init (GtkGstGLWidget * widget)
492 widget->priv = GTK_GST_GL_WIDGET_GET_PRIVATE (widget);
494 widget->priv->force_aspect_ratio = DEFAULT_FORCE_ASPECT_RATIO;
496 g_mutex_init (&widget->priv->lock);
498 display = gdk_display_get_default ();
500 #if GST_GL_HAVE_WINDOW_X11 && defined (GDK_WINDOWING_X11)
501 if (GDK_IS_X11_DISPLAY (display))
502 widget->priv->display = (GstGLDisplay *)
503 gst_gl_display_x11_new_with_display (gdk_x11_display_get_xdisplay
507 if (!widget->priv->display)
508 widget->priv->display = gst_gl_display_new ();
510 gtk_gl_area_set_has_alpha ((GtkGLArea *) widget, TRUE);
514 gtk_gst_gl_widget_new (void)
516 return (GtkWidget *) g_object_new (GTK_TYPE_GST_GL_WIDGET, NULL);
520 _queue_draw (GtkGstGLWidget * widget)
522 gtk_widget_queue_draw (GTK_WIDGET (widget));
524 return G_SOURCE_REMOVE;
528 gtk_gst_gl_widget_set_buffer (GtkGstGLWidget * widget, GstBuffer * buffer)
530 GMainContext *main_context = g_main_context_default ();
532 g_return_if_fail (GTK_IS_GST_GL_WIDGET (widget));
533 g_return_if_fail (widget->priv->negotiated);
535 g_mutex_lock (&widget->priv->lock);
537 gst_buffer_replace (&widget->priv->buffer, buffer);
538 widget->priv->new_buffer = TRUE;
540 g_mutex_unlock (&widget->priv->lock);
542 g_main_context_invoke (main_context, (GSourceFunc) _queue_draw, widget);
546 _get_gl_context (GtkGstGLWidget * gst_widget)
548 GstGLPlatform platform;
552 gtk_widget_realize (GTK_WIDGET (gst_widget));
554 if (gst_widget->priv->gdk_context)
555 g_object_unref (gst_widget->priv->gdk_context);
556 gst_widget->priv->gdk_context =
557 gtk_gl_area_get_context (GTK_GL_AREA (gst_widget));
558 if (gst_widget->priv->gdk_context == NULL) {
559 g_assert_not_reached ();
563 g_object_ref (gst_widget->priv->gdk_context);
565 gdk_gl_context_make_current (gst_widget->priv->gdk_context);
567 #if GST_GL_HAVE_WINDOW_X11 && defined (GDK_WINDOWING_X11)
568 if (GST_IS_GL_DISPLAY_X11 (gst_widget->priv->display)) {
569 platform = GST_GL_PLATFORM_GLX;
570 gl_api = gst_gl_context_get_current_gl_api (NULL, NULL);
571 gl_handle = gst_gl_context_get_current_gl_context (platform);
573 gst_widget->priv->other_context =
574 gst_gl_context_new_wrapped (gst_widget->priv->display, gl_handle,
579 if (gst_widget->priv->other_context) {
580 GError *error = NULL;
582 gst_gl_context_activate (gst_widget->priv->other_context, TRUE);
583 if (!gst_gl_context_fill_info (gst_widget->priv->other_context, &error)) {
584 GST_ERROR ("failed to retreive gdk context info: %s", error->message);
585 g_object_unref (gst_widget->priv->other_context);
586 gst_widget->priv->other_context = NULL;
588 gst_gl_context_activate (gst_widget->priv->other_context, FALSE);
594 _queue_resize (GtkGstGLWidget * widget)
596 gtk_widget_queue_resize (GTK_WIDGET (widget));
598 return G_SOURCE_REMOVE;
602 gtk_gst_gl_widget_init_winsys (GtkGstGLWidget * widget)
604 g_return_val_if_fail (GTK_IS_GST_GL_WIDGET (widget), FALSE);
606 g_mutex_lock (&widget->priv->lock);
608 if (widget->priv->display && widget->priv->gdk_context
609 && widget->priv->other_context) {
610 g_mutex_unlock (&widget->priv->lock);
614 if (!widget->priv->other_context) {
615 _invoke_on_main ((ThreadFunc) _get_gl_context, widget);
618 if (!GST_GL_IS_CONTEXT (widget->priv->other_context)) {
619 g_mutex_unlock (&widget->priv->lock);
623 widget->priv->context = gst_gl_context_new (widget->priv->display);
625 if (!widget->priv->context) {
626 g_mutex_unlock (&widget->priv->lock);
630 gst_gl_context_create (widget->priv->context, widget->priv->other_context,
633 g_mutex_unlock (&widget->priv->lock);
638 gtk_gst_gl_widget_set_caps (GtkGstGLWidget * widget, GstCaps * caps)
640 GMainContext *main_context = g_main_context_default ();
643 g_return_val_if_fail (GTK_IS_GST_GL_WIDGET (widget), FALSE);
644 g_return_val_if_fail (GST_IS_CAPS (caps), FALSE);
645 g_return_val_if_fail (gst_caps_is_fixed (caps), FALSE);
647 if (widget->priv->caps && gst_caps_is_equal_fixed (widget->priv->caps, caps))
650 if (!gst_video_info_from_caps (&v_info, caps))
653 g_mutex_lock (&widget->priv->lock);
657 gst_caps_replace (&widget->priv->caps, caps);
659 widget->priv->gl_caps = gst_video_info_to_caps (&v_info);
660 gst_caps_set_features (widget->priv->gl_caps, 0,
661 gst_caps_features_from_string (GST_CAPS_FEATURE_MEMORY_GL_MEMORY));
663 widget->priv->v_info = v_info;
664 widget->priv->negotiated = TRUE;
666 g_mutex_unlock (&widget->priv->lock);
668 g_main_context_invoke (main_context, (GSourceFunc) _queue_resize, widget);
674 gtk_gst_gl_widget_get_gtk_context (GtkGstGLWidget * gst_widget)
676 if (!gst_widget->priv->other_context)
679 return gst_object_ref (gst_widget->priv->other_context);
683 gtk_gst_gl_widget_get_context (GtkGstGLWidget * gst_widget)
685 if (!gst_widget->priv->context)
688 return gst_object_ref (gst_widget->priv->context);
692 gtk_gst_gl_widget_get_display (GtkGstGLWidget * gst_widget)
694 if (!gst_widget->priv->display)
697 return gst_object_ref (gst_widget->priv->display);