ext/gtk/gstgtkglsink.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 /**
  22  * SECTION:gstgtkglsink
  23  *
  24  */
  25
  26 #ifdef HAVE_CONFIG_H
  27 #include "config.h"
  28 #endif
  29
  30 #include "gstgtkglsink.h"
  31
  32 GST_DEBUG_CATEGORY (gst_debug_gtk_gl_sink);
  33 #define GST_CAT_DEFAULT gst_debug_gtk_gl_sink
  34
  35 #define DEFAULT_FORCE_ASPECT_RATIO  TRUE
  36 #define DEFAULT_PAR_N               0
  37 #define DEFAULT_PAR_D               1
  38 #define DEFAULT_IGNORE_ALPHA        TRUE
  39
  40 static void gst_gtk_gl_sink_finalize (GObject * object);
  41 static void gst_gtk_gl_sink_set_property (GObject * object, guint prop_id,
  42     const GValue * value, GParamSpec * param_spec);
  43 static void gst_gtk_gl_sink_get_property (GObject * object, guint prop_id,
  44     GValue * value, GParamSpec * param_spec);
  45
  46 static gboolean gst_gtk_gl_sink_stop (GstBaseSink * bsink);
  47
  48 static gboolean gst_gtk_gl_sink_query (GstBaseSink * bsink, GstQuery * query);
  49
  50 static GstStateChangeReturn
  51 gst_gtk_gl_sink_change_state (GstElement * element, GstStateChange transition);
  52
  53 static void gst_gtk_gl_sink_get_times (GstBaseSink * bsink, GstBuffer * buf,
  54     GstClockTime * start, GstClockTime * end);
  55 static gboolean gst_gtk_gl_sink_set_caps (GstBaseSink * bsink, GstCaps * caps);
  56 static GstFlowReturn gst_gtk_gl_sink_show_frame (GstVideoSink * bsink,
  57     GstBuffer * buf);
  58 static gboolean gst_gtk_gl_sink_propose_allocation (GstBaseSink * bsink,
  59     GstQuery * query);
  60
  61 static GstStaticPadTemplate gst_gtk_gl_sink_template =
  62 GST_STATIC_PAD_TEMPLATE ("sink",
  63     GST_PAD_SINK,
  64     GST_PAD_ALWAYS,
  65     GST_STATIC_CAPS (GST_VIDEO_CAPS_MAKE_WITH_FEATURES
  66         (GST_CAPS_FEATURE_MEMORY_GL_MEMORY, "RGBA")));
  67
  68 enum
  69 {
  70   PROP_0,
  71   PROP_WIDGET,
  72   PROP_FORCE_ASPECT_RATIO,
  73   PROP_PIXEL_ASPECT_RATIO,
  74   PROP_IGNORE_ALPHA,
  75 };
  76
  77 enum
  78 {
  79   SIGNAL_0,
  80   LAST_SIGNAL
  81 };
  82
  83 #define gst_gtk_gl_sink_parent_class parent_class
  84 G_DEFINE_TYPE_WITH_CODE (GstGtkGLSink, gst_gtk_gl_sink,
  85     GST_TYPE_VIDEO_SINK, GST_DEBUG_CATEGORY_INIT (gst_debug_gtk_gl_sink,
  86         "gtkglsink", 0, "Gtk Video Sink"));
  87
  88 static void
  89 gst_gtk_gl_sink_class_init (GstGtkGLSinkClass * klass)
  90 {
  91   GObjectClass *gobject_class;
  92   GstElementClass *gstelement_class;
  93   GstBaseSinkClass *gstbasesink_class;
  94   GstVideoSinkClass *gstvideosink_class;
  95
  96   gobject_class = (GObjectClass *) klass;
  97   gstelement_class = (GstElementClass *) klass;
  98   gstbasesink_class = (GstBaseSinkClass *) klass;
  99   gstvideosink_class = (GstVideoSinkClass *) klass;
 100
 101   gobject_class->set_property = gst_gtk_gl_sink_set_property;
 102   gobject_class->get_property = gst_gtk_gl_sink_get_property;
 103
 104   gst_element_class_set_metadata (gstelement_class, "Gtk Video Sink",
 105       "Sink/Video", "A video sink that renders to a GtkWidget",
 106       "Matthew Waters <matthew@centricular.com>");
 107
 108   g_object_class_install_property (gobject_class, PROP_WIDGET,
 109       g_param_spec_object ("widget", "Gtk Widget",
 110           "The GtkWidget to place in the widget heirachy",
 111           GTK_TYPE_WIDGET, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 112
 113   g_object_class_install_property (gobject_class, PROP_FORCE_ASPECT_RATIO,
 114       g_param_spec_boolean ("force-aspect-ratio",
 115           "Force aspect ratio",
 116           "When enabled, scaling will respect original aspect ratio",
 117           DEFAULT_FORCE_ASPECT_RATIO,
 118           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 119
 120   g_object_class_install_property (gobject_class, PROP_PIXEL_ASPECT_RATIO,
 121       gst_param_spec_fraction ("pixel-aspect-ratio", "Pixel Aspect Ratio",
 122           "The pixel aspect ratio of the device", DEFAULT_PAR_N, DEFAULT_PAR_D,
 123           G_MAXINT, 1, 1, 1, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 124
 125   g_object_class_install_property (gobject_class, PROP_IGNORE_ALPHA,
 126       g_param_spec_boolean ("ignore-alpha", "Ignore Alpha",
 127           "When enabled, alpha will be ignored and converted to black",
 128           DEFAULT_IGNORE_ALPHA, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 129
 130   gst_element_class_add_pad_template (gstelement_class,
 131       gst_static_pad_template_get (&gst_gtk_gl_sink_template));
 132
 133   gobject_class->finalize = gst_gtk_gl_sink_finalize;
 134
 135   gstelement_class->change_state = gst_gtk_gl_sink_change_state;
 136   gstbasesink_class->query = gst_gtk_gl_sink_query;
 137   gstbasesink_class->set_caps = gst_gtk_gl_sink_set_caps;
 138   gstbasesink_class->get_times = gst_gtk_gl_sink_get_times;
 139   gstbasesink_class->propose_allocation = gst_gtk_gl_sink_propose_allocation;
 140   gstbasesink_class->stop = gst_gtk_gl_sink_stop;
 141
 142   gstvideosink_class->show_frame = gst_gtk_gl_sink_show_frame;
 143 }
 144
 145 static void
 146 gst_gtk_gl_sink_init (GstGtkGLSink * gtk_sink)
 147 {
 148   gtk_sink->force_aspect_ratio = DEFAULT_FORCE_ASPECT_RATIO;
 149   gtk_sink->par_n = DEFAULT_PAR_N;
 150   gtk_sink->par_d = DEFAULT_PAR_D;
 151   gtk_sink->ignore_alpha = DEFAULT_IGNORE_ALPHA;
 152 }
 153
 154 static void
 155 gst_gtk_gl_sink_finalize (GObject * object)
 156 {
 157   GstGtkGLSink *gtk_sink = GST_GTK_GL_SINK (object);;
 158
 159   g_object_unref (gtk_sink->widget);
 160
 161   G_OBJECT_CLASS (parent_class)->finalize (object);
 162 }
 163
 164 static GtkGstGLWidget *
 165 gst_gtk_gl_sink_get_widget (GstGtkGLSink * gtk_sink)
 166 {
 167   if (gtk_sink->widget != NULL)
 168     return gtk_sink->widget;
 169
 170   /* Ensure GTK is initialized, this has no side effect if it was already
 171    * initialized. Also, we do that lazily, so the application can be first */
 172   if (!gtk_init_check (NULL, NULL)) {
 173     GST_ERROR_OBJECT (gtk_sink, "Could not ensure GTK initialization.");
 174     return NULL;
 175   }
 176
 177   gtk_sink->widget = (GtkGstGLWidget *) gtk_gst_gl_widget_new ();
 178   gtk_sink->bind_force_aspect_ratio =
 179       g_object_bind_property (gtk_sink, "force-aspect-ratio", gtk_sink->widget,
 180       "force-aspect-ratio", G_BINDING_BIDIRECTIONAL | G_BINDING_SYNC_CREATE);
 181   gtk_sink->bind_pixel_aspect_ratio =
 182       g_object_bind_property (gtk_sink, "pixel-aspect-ratio", gtk_sink->widget,
 183       "pixel-aspect-ratio", G_BINDING_BIDIRECTIONAL | G_BINDING_SYNC_CREATE);
 184   gtk_sink->bind_ignore_alpha =
 185       g_object_bind_property (gtk_sink, "ignore-alpha", gtk_sink->widget,
 186       "ignore-alpha", G_BINDING_BIDIRECTIONAL | G_BINDING_SYNC_CREATE);
 187
 188   /* Take the floating ref, otherwise the destruction of the container will
 189    * make this widget disapear possibly before we are done. */
 190   gst_object_ref_sink (gtk_sink->widget);
 191
 192   return gtk_sink->widget;
 193 }
 194
 195 static void
 196 gst_gtk_gl_sink_get_property (GObject * object, guint prop_id,
 197     GValue * value, GParamSpec * pspec)
 198 {
 199   GstGtkGLSink *gtk_sink;
 200
 201   gtk_sink = GST_GTK_GL_SINK (object);
 202
 203   switch (prop_id) {
 204     case PROP_WIDGET:
 205       g_value_set_object (value, gst_gtk_gl_sink_get_widget (gtk_sink));
 206       break;
 207     case PROP_FORCE_ASPECT_RATIO:
 208       g_value_set_boolean (value, gtk_sink->force_aspect_ratio);
 209       break;
 210     case PROP_PIXEL_ASPECT_RATIO:
 211       gst_value_set_fraction (value, gtk_sink->par_n, gtk_sink->par_d);
 212       break;
 213     case PROP_IGNORE_ALPHA:
 214       g_value_set_boolean (value, gtk_sink->ignore_alpha);
 215       break;
 216     default:
 217       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 218       break;
 219   }
 220 }
 221
 222 static void
 223 gst_gtk_gl_sink_set_property (GObject * object, guint prop_id,
 224     const GValue * value, GParamSpec * pspec)
 225 {
 226   GstGtkGLSink *gtk_sink = GST_GTK_GL_SINK (object);
 227
 228   switch (prop_id) {
 229     case PROP_FORCE_ASPECT_RATIO:
 230       gtk_sink->force_aspect_ratio = g_value_get_boolean (value);
 231       break;
 232     case PROP_PIXEL_ASPECT_RATIO:
 233       gtk_sink->par_n = gst_value_get_fraction_numerator (value);
 234       gtk_sink->par_d = gst_value_get_fraction_denominator (value);
 235       break;
 236     case PROP_IGNORE_ALPHA:
 237       gtk_sink->ignore_alpha = g_value_get_boolean (value);
 238       break;
 239     default:
 240       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 241       break;
 242   }
 243 }
 244
 245 static gboolean
 246 gst_gtk_gl_sink_query (GstBaseSink * bsink, GstQuery * query)
 247 {
 248   GstGtkGLSink *gtk_sink = GST_GTK_GL_SINK (bsink);
 249   gboolean res = FALSE;
 250
 251   switch (GST_QUERY_TYPE (query)) {
 252     case GST_QUERY_CONTEXT:
 253     {
 254       const gchar *context_type;
 255       GstContext *context, *old_context;
 256       gboolean ret;
 257
 258       ret = gst_gl_handle_context_query ((GstElement *) gtk_sink, query,
 259           &gtk_sink->display, &gtk_sink->gtk_context);
 260
 261       if (gtk_sink->display)
 262         gst_gl_display_filter_gl_api (gtk_sink->display, GST_GL_API_OPENGL3);
 263
 264       gst_query_parse_context_type (query, &context_type);
 265
 266       if (g_strcmp0 (context_type, "gst.gl.local_context") == 0) {
 267         GstStructure *s;
 268
 269         gst_query_parse_context (query, &old_context);
 270
 271         if (old_context)
 272           context = gst_context_copy (old_context);
 273         else
 274           context = gst_context_new ("gst.gl.local_context", FALSE);
 275
 276         s = gst_context_writable_structure (context);
 277         gst_structure_set (s, "context", GST_GL_TYPE_CONTEXT, gtk_sink->context,
 278             NULL);
 279         gst_query_set_context (query, context);
 280         gst_context_unref (context);
 281
 282         ret = gtk_sink->context != NULL;
 283       }
 284       GST_LOG_OBJECT (gtk_sink, "context query of type %s %i", context_type,
 285           ret);
 286
 287       if (ret)
 288         return ret;
 289     }
 290     default:
 291       res = GST_BASE_SINK_CLASS (parent_class)->query (bsink, query);
 292       break;
 293   }
 294
 295   return res;
 296 }
 297
 298 static gboolean
 299 gst_gtk_gl_sink_stop (GstBaseSink * bsink)
 300 {
 301   return TRUE;
 302 }
 303
 304 static GstStateChangeReturn
 305 gst_gtk_gl_sink_change_state (GstElement * element, GstStateChange transition)
 306 {
 307   GstGtkGLSink *gtk_sink = GST_GTK_GL_SINK (element);
 308   GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
 309
 310   GST_DEBUG ("changing state: %s => %s",
 311       gst_element_state_get_name (GST_STATE_TRANSITION_CURRENT (transition)),
 312       gst_element_state_get_name (GST_STATE_TRANSITION_NEXT (transition)));
 313
 314   switch (transition) {
 315     case GST_STATE_CHANGE_NULL_TO_READY:
 316       if (gst_gtk_gl_sink_get_widget (gtk_sink) == NULL)
 317         return GST_STATE_CHANGE_FAILURE;
 318
 319       /* After this point, gtk_sink->widget will always be set */
 320
 321       if (!gtk_widget_get_parent (GTK_WIDGET (gtk_sink->widget))) {
 322         GST_ERROR_OBJECT (gtk_sink,
 323             "gtkglsink widget needs to be parented to work.");
 324         return GST_STATE_CHANGE_FAILURE;
 325       }
 326
 327       if (!gtk_gst_gl_widget_init_winsys (gtk_sink->widget))
 328         return GST_STATE_CHANGE_FAILURE;
 329
 330       gtk_sink->display = gtk_gst_gl_widget_get_display (gtk_sink->widget);
 331       gtk_sink->context = gtk_gst_gl_widget_get_context (gtk_sink->widget);
 332       gtk_sink->gtk_context =
 333           gtk_gst_gl_widget_get_gtk_context (gtk_sink->widget);
 334
 335       if (!gtk_sink->display || !gtk_sink->context || !gtk_sink->gtk_context)
 336         return GST_STATE_CHANGE_FAILURE;
 337       break;
 338     case GST_STATE_CHANGE_READY_TO_PAUSED:
 339       break;
 340     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
 341       break;
 342     default:
 343       break;
 344   }
 345
 346   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 347   if (ret == GST_STATE_CHANGE_FAILURE)
 348     return ret;
 349
 350   switch (transition) {
 351     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
 352       break;
 353     case GST_STATE_CHANGE_PAUSED_TO_READY:
 354       gtk_gst_gl_widget_set_buffer (gtk_sink->widget, NULL);
 355       break;
 356     case GST_STATE_CHANGE_READY_TO_NULL:
 357       if (gtk_sink->display) {
 358         gst_object_unref (gtk_sink->display);
 359         gtk_sink->display = NULL;
 360       }
 361
 362       if (gtk_sink->context) {
 363         gst_object_unref (gtk_sink->context);
 364         gtk_sink->context = NULL;
 365       }
 366
 367       if (gtk_sink->gtk_context) {
 368         gst_object_unref (gtk_sink->gtk_context);
 369         gtk_sink->gtk_context = NULL;
 370       }
 371       break;
 372     default:
 373       break;
 374   }
 375
 376   return ret;
 377 }
 378
 379 static void
 380 gst_gtk_gl_sink_get_times (GstBaseSink * bsink, GstBuffer * buf,
 381     GstClockTime * start, GstClockTime * end)
 382 {
 383   GstGtkGLSink *gtk_sink;
 384
 385   gtk_sink = GST_GTK_GL_SINK (bsink);
 386
 387   if (GST_BUFFER_TIMESTAMP_IS_VALID (buf)) {
 388     *start = GST_BUFFER_TIMESTAMP (buf);
 389     if (GST_BUFFER_DURATION_IS_VALID (buf))
 390       *end = *start + GST_BUFFER_DURATION (buf);
 391     else {
 392       if (GST_VIDEO_INFO_FPS_N (&gtk_sink->v_info) > 0) {
 393         *end = *start +
 394             gst_util_uint64_scale_int (GST_SECOND,
 395             GST_VIDEO_INFO_FPS_D (&gtk_sink->v_info),
 396             GST_VIDEO_INFO_FPS_N (&gtk_sink->v_info));
 397       }
 398     }
 399   }
 400 }
 401
 402 gboolean
 403 gst_gtk_gl_sink_set_caps (GstBaseSink * bsink, GstCaps * caps)
 404 {
 405   GstGtkGLSink *gtk_sink = GST_GTK_GL_SINK (bsink);
 406
 407   GST_DEBUG ("set caps with %" GST_PTR_FORMAT, caps);
 408
 409   if (!gst_video_info_from_caps (&gtk_sink->v_info, caps))
 410     return FALSE;
 411
 412   if (!gtk_gst_gl_widget_set_caps (gtk_sink->widget, caps))
 413     return FALSE;
 414
 415   return TRUE;
 416 }
 417
 418 static GstFlowReturn
 419 gst_gtk_gl_sink_show_frame (GstVideoSink * vsink, GstBuffer * buf)
 420 {
 421   GstGtkGLSink *gtk_sink;
 422
 423   GST_TRACE ("rendering buffer:%p", buf);
 424
 425   gtk_sink = GST_GTK_GL_SINK (vsink);
 426
 427   gtk_gst_gl_widget_set_buffer (gtk_sink->widget, buf);
 428
 429   return GST_FLOW_OK;
 430 }
 431
 432 static gboolean
 433 gst_gtk_gl_sink_propose_allocation (GstBaseSink * bsink, GstQuery * query)
 434 {
 435   GstGtkGLSink *gtk_sink = GST_GTK_GL_SINK (bsink);
 436   GstBufferPool *pool;
 437   GstStructure *config;
 438   GstCaps *caps;
 439   guint size;
 440   gboolean need_pool;
 441
 442   if (!gtk_sink->display || !gtk_sink->context)
 443     return FALSE;
 444
 445   gst_query_parse_allocation (query, &caps, &need_pool);
 446
 447   if (caps == NULL)
 448     goto no_caps;
 449
 450   if ((pool = gtk_sink->pool))
 451     gst_object_ref (pool);
 452
 453   if (pool != NULL) {
 454     GstCaps *pcaps;
 455
 456     /* we had a pool, check caps */
 457     GST_DEBUG_OBJECT (gtk_sink, "check existing pool caps");
 458     config = gst_buffer_pool_get_config (pool);
 459     gst_buffer_pool_config_get_params (config, &pcaps, &size, NULL, NULL);
 460
 461     if (!gst_caps_is_equal (caps, pcaps)) {
 462       GST_DEBUG_OBJECT (gtk_sink, "pool has different caps");
 463       /* different caps, we can't use this pool */
 464       gst_object_unref (pool);
 465       pool = NULL;
 466     }
 467     gst_structure_free (config);
 468   }
 469
 470   if (pool == NULL && need_pool) {
 471     GstVideoInfo info;
 472
 473     if (!gst_video_info_from_caps (&info, caps))
 474       goto invalid_caps;
 475
 476     GST_DEBUG_OBJECT (gtk_sink, "create new pool");
 477     pool = gst_gl_buffer_pool_new (gtk_sink->context);
 478
 479     /* the normal size of a frame */
 480     size = info.size;
 481
 482     config = gst_buffer_pool_get_config (pool);
 483     gst_buffer_pool_config_set_params (config, caps, size, 0, 0);
 484     if (!gst_buffer_pool_set_config (pool, config))
 485       goto config_failed;
 486   }
 487   /* we need at least 2 buffer because we hold on to the last one */
 488   if (pool) {
 489     gst_query_add_allocation_pool (query, pool, size, 2, 0);
 490     gst_object_unref (pool);
 491   }
 492
 493   /* we also support various metadata */
 494   gst_query_add_allocation_meta (query, GST_VIDEO_META_API_TYPE, 0);
 495
 496   if (gtk_sink->context->gl_vtable->FenceSync)
 497     gst_query_add_allocation_meta (query, GST_GL_SYNC_META_API_TYPE, 0);
 498
 499   return TRUE;
 500
 501   /* ERRORS */
 502 no_caps:
 503   {
 504     GST_DEBUG_OBJECT (bsink, "no caps specified");
 505     return FALSE;
 506   }
 507 invalid_caps:
 508   {
 509     GST_DEBUG_OBJECT (bsink, "invalid caps specified");
 510     return FALSE;
 511   }
 512 config_failed:
 513   {
 514     GST_DEBUG_OBJECT (bsink, "failed setting config");
 515     return FALSE;
 516   }
 517 }