ext/qt/gstqtsink.cc

   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:gstqtsink
  23  *
  24  */
  25
  26 #ifdef HAVE_CONFIG_H
  27 #include "config.h"
  28 #endif
  29
  30 #include "gstqtsink.h"
  31 #include <QtGui/QGuiApplication>
  32
  33 #define GST_CAT_DEFAULT gst_debug_qt_gl_sink
  34 GST_DEBUG_CATEGORY (GST_CAT_DEFAULT);
  35
  36 static void gst_qt_sink_finalize (GObject * object);
  37 static void gst_qt_sink_set_property (GObject * object, guint prop_id,
  38     const GValue * value, GParamSpec * param_spec);
  39 static void gst_qt_sink_get_property (GObject * object, guint prop_id,
  40     GValue * value, GParamSpec * param_spec);
  41
  42 static gboolean gst_qt_sink_stop (GstBaseSink * bsink);
  43
  44 static gboolean gst_qt_sink_query (GstBaseSink * bsink, GstQuery * query);
  45
  46 static GstStateChangeReturn
  47 gst_qt_sink_change_state (GstElement * element, GstStateChange transition);
  48
  49 static void gst_qt_sink_get_times (GstBaseSink * bsink, GstBuffer * buf,
  50     GstClockTime * start, GstClockTime * end);
  51 static gboolean gst_qt_sink_set_caps (GstBaseSink * bsink, GstCaps * caps);
  52 static GstFlowReturn gst_qt_sink_show_frame (GstVideoSink * bsink,
  53     GstBuffer * buf);
  54 static gboolean gst_qt_sink_propose_allocation (GstBaseSink * bsink,
  55     GstQuery * query);
  56
  57 static GstStaticPadTemplate gst_qt_sink_template =
  58 GST_STATIC_PAD_TEMPLATE ("sink",
  59     GST_PAD_SINK,
  60     GST_PAD_ALWAYS,
  61     GST_STATIC_CAPS ("video/x-raw(" GST_CAPS_FEATURE_MEMORY_GL_MEMORY "), "
  62     "format = (string) RGBA, "
  63     "width = " GST_VIDEO_SIZE_RANGE ", "
  64     "height = " GST_VIDEO_SIZE_RANGE ", "
  65     "framerate = " GST_VIDEO_FPS_RANGE ", "
  66     "texture-target = (string) 2D"));
  67
  68 #define DEFAULT_FORCE_ASPECT_RATIO  TRUE
  69 #define DEFAULT_PAR_N               0
  70 #define DEFAULT_PAR_D               1
  71
  72 enum
  73 {
  74   ARG_0,
  75   PROP_WIDGET,
  76   PROP_FORCE_ASPECT_RATIO,
  77   PROP_PIXEL_ASPECT_RATIO,
  78 };
  79
  80 enum
  81 {
  82   SIGNAL_0,
  83   LAST_SIGNAL
  84 };
  85
  86 #define gst_qt_sink_parent_class parent_class
  87 G_DEFINE_TYPE_WITH_CODE (GstQtSink, gst_qt_sink,
  88     GST_TYPE_VIDEO_SINK, GST_DEBUG_CATEGORY_INIT (GST_CAT_DEFAULT,
  89         "qtsink", 0, "Qt Video Sink"));
  90
  91 static void
  92 gst_qt_sink_class_init (GstQtSinkClass * klass)
  93 {
  94   GObjectClass *gobject_class;
  95   GstElementClass *gstelement_class;
  96   GstBaseSinkClass *gstbasesink_class;
  97   GstVideoSinkClass *gstvideosink_class;
  98
  99   gobject_class = (GObjectClass *) klass;
 100   gstelement_class = (GstElementClass *) klass;
 101   gstbasesink_class = (GstBaseSinkClass *) klass;
 102   gstvideosink_class = (GstVideoSinkClass *) klass;
 103
 104   gobject_class->set_property = gst_qt_sink_set_property;
 105   gobject_class->get_property = gst_qt_sink_get_property;
 106
 107   gst_element_class_set_metadata (gstelement_class, "Qt Video Sink",
 108       "Sink/Video", "A video sink the renders to a QQuickItem",
 109       "Matthew Waters <matthew@centricular.com>");
 110
 111   g_object_class_install_property (gobject_class, PROP_WIDGET,
 112       g_param_spec_pointer ("widget", "QQuickItem",
 113           "The QQuickItem to place in the object heirachy",
 114           (GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
 115
 116   g_object_class_install_property (gobject_class, PROP_FORCE_ASPECT_RATIO,
 117       g_param_spec_boolean ("force-aspect-ratio",
 118           "Force aspect ratio",
 119           "When enabled, scaling will respect original aspect ratio",
 120           DEFAULT_FORCE_ASPECT_RATIO,
 121           (GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
 122
 123   g_object_class_install_property (gobject_class, PROP_PIXEL_ASPECT_RATIO,
 124       gst_param_spec_fraction ("pixel-aspect-ratio", "Pixel Aspect Ratio",
 125           "The pixel aspect ratio of the device", DEFAULT_PAR_N, DEFAULT_PAR_D,
 126           G_MAXINT, 1, 1, 1,
 127           (GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
 128
 129   gst_element_class_add_static_pad_template (gstelement_class, &gst_qt_sink_template);
 130
 131   gobject_class->finalize = gst_qt_sink_finalize;
 132
 133   gstelement_class->change_state = gst_qt_sink_change_state;
 134   gstbasesink_class->query = gst_qt_sink_query;
 135   gstbasesink_class->set_caps = gst_qt_sink_set_caps;
 136   gstbasesink_class->get_times = gst_qt_sink_get_times;
 137   gstbasesink_class->propose_allocation = gst_qt_sink_propose_allocation;
 138   gstbasesink_class->stop = gst_qt_sink_stop;
 139
 140   gstvideosink_class->show_frame = gst_qt_sink_show_frame;
 141 }
 142
 143 static void
 144 gst_qt_sink_init (GstQtSink * qt_sink)
 145 {
 146 }
 147
 148 static void
 149 gst_qt_sink_set_property (GObject * object, guint prop_id,
 150     const GValue * value, GParamSpec * pspec)
 151 {
 152   GstQtSink *qt_sink = GST_QT_SINK (object);
 153
 154   switch (prop_id) {
 155     case PROP_WIDGET:
 156       qt_sink->widget = static_cast<QtGLVideoItem *> (g_value_get_pointer (value));
 157       break;
 158     case PROP_FORCE_ASPECT_RATIO:
 159       g_return_if_fail (qt_sink->widget);
 160       qt_sink->widget->setForceAspectRatio (g_value_get_boolean (value));
 161       break;
 162     case PROP_PIXEL_ASPECT_RATIO:
 163       g_return_if_fail (qt_sink->widget);
 164       qt_sink->widget->setDAR (gst_value_get_fraction_numerator (value),
 165           gst_value_get_fraction_denominator (value));
 166       break;
 167     default:
 168       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 169       break;
 170   }
 171 }
 172
 173 static void
 174 _reset (GstQtSink * qt_sink)
 175 {
 176   if (qt_sink->display) {
 177     gst_object_unref (qt_sink->display);
 178     qt_sink->display = NULL;
 179   }
 180
 181   if (qt_sink->context) {
 182     gst_object_unref (qt_sink->context);
 183     qt_sink->context = NULL;
 184   }
 185
 186   if (qt_sink->qt_context) {
 187     gst_object_unref (qt_sink->qt_context);
 188     qt_sink->qt_context = NULL;
 189   }
 190 }
 191
 192 static void
 193 gst_qt_sink_finalize (GObject * object)
 194 {
 195   GstQtSink *qt_sink = GST_QT_SINK (object);
 196
 197   _reset (qt_sink);
 198
 199   G_OBJECT_CLASS (parent_class)->finalize (object);
 200 }
 201
 202 static void
 203 gst_qt_sink_get_property (GObject * object, guint prop_id,
 204     GValue * value, GParamSpec * pspec)
 205 {
 206   GstQtSink *qt_sink = GST_QT_SINK (object);
 207
 208   switch (prop_id) {
 209     case PROP_WIDGET:
 210       g_value_set_pointer (value, qt_sink->widget);
 211       break;
 212     case PROP_FORCE_ASPECT_RATIO:
 213       if (qt_sink->widget)
 214         g_value_set_boolean (value, qt_sink->widget->getForceAspectRatio ());
 215       else
 216         g_value_set_boolean (value, DEFAULT_FORCE_ASPECT_RATIO);
 217       break;
 218     case PROP_PIXEL_ASPECT_RATIO:
 219       if (qt_sink->widget) {
 220         gint num, den;
 221         qt_sink->widget->getDAR (&num, &den);
 222         gst_value_set_fraction (value, num, den);
 223       } else {
 224         gst_value_set_fraction (value, DEFAULT_PAR_N, DEFAULT_PAR_D);
 225       }
 226       break;
 227     default:
 228       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 229       break;
 230   }
 231 }
 232
 233 static gboolean
 234 gst_qt_sink_query (GstBaseSink * bsink, GstQuery * query)
 235 {
 236   GstQtSink *qt_sink = GST_QT_SINK (bsink);
 237   gboolean res = FALSE;
 238
 239   switch (GST_QUERY_TYPE (query)) {
 240     case GST_QUERY_CONTEXT:
 241     {
 242       const gchar *context_type;
 243       GstContext *context, *old_context;
 244       gboolean ret;
 245
 246       ret = gst_gl_handle_context_query ((GstElement *) qt_sink, query,
 247           &qt_sink->display, &qt_sink->qt_context);
 248
 249       if (qt_sink->display)
 250         gst_gl_display_filter_gl_api (qt_sink->display, gst_gl_context_get_gl_api (qt_sink->qt_context));
 251
 252       gst_query_parse_context_type (query, &context_type);
 253
 254       if (g_strcmp0 (context_type, "gst.gl.local_context") == 0) {
 255         GstStructure *s;
 256
 257         gst_query_parse_context (query, &old_context);
 258
 259         if (old_context)
 260           context = gst_context_copy (old_context);
 261         else
 262           context = gst_context_new ("gst.gl.local_context", FALSE);
 263
 264         s = gst_context_writable_structure (context);
 265         gst_structure_set (s, "context", GST_TYPE_GL_CONTEXT, qt_sink->context,
 266             NULL);
 267         gst_query_set_context (query, context);
 268         gst_context_unref (context);
 269
 270         ret = qt_sink->context != NULL;
 271       }
 272       GST_LOG_OBJECT (qt_sink, "context query of type %s %i", context_type,
 273           ret);
 274
 275       if (ret)
 276         return ret;
 277
 278       /* fallthrough */
 279     }
 280     default:
 281       res = GST_BASE_SINK_CLASS (parent_class)->query (bsink, query);
 282       break;
 283   }
 284
 285   return res;
 286 }
 287
 288 static gboolean
 289 gst_qt_sink_stop (GstBaseSink * bsink)
 290 {
 291   return TRUE;
 292 }
 293
 294 static GstStateChangeReturn
 295 gst_qt_sink_change_state (GstElement * element, GstStateChange transition)
 296 {
 297   GstQtSink *qt_sink = GST_QT_SINK (element);
 298   GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
 299   QGuiApplication *app;
 300
 301   GST_DEBUG ("changing state: %s => %s",
 302       gst_element_state_get_name (GST_STATE_TRANSITION_CURRENT (transition)),
 303       gst_element_state_get_name (GST_STATE_TRANSITION_NEXT (transition)));
 304
 305   switch (transition) {
 306     case GST_STATE_CHANGE_NULL_TO_READY:
 307       app = static_cast<QGuiApplication *> (QCoreApplication::instance ());
 308       if (!app) {
 309         GST_ELEMENT_ERROR (element, RESOURCE, NOT_FOUND,
 310             ("%s", "Failed to connect to Qt"),
 311             ("%s", "Could not retrieve QGuiApplication instance"));
 312         return GST_STATE_CHANGE_FAILURE;
 313       }
 314
 315       if (!qt_sink->widget) {
 316         GST_ELEMENT_ERROR (element, RESOURCE, NOT_FOUND,
 317             ("%s", "Required property \'widget\' not set"),
 318             (NULL));
 319         return GST_STATE_CHANGE_FAILURE;
 320       }
 321
 322       if (!qt_item_init_winsys (qt_sink->widget)) {
 323         GST_ELEMENT_ERROR (element, RESOURCE, NOT_FOUND,
 324             ("%s", "Could not initialize window system"),
 325             (NULL));
 326         return GST_STATE_CHANGE_FAILURE;
 327       }
 328
 329       qt_sink->display = qt_item_get_display (qt_sink->widget);
 330       qt_sink->context = qt_item_get_context (qt_sink->widget);
 331       qt_sink->qt_context = qt_item_get_qt_context (qt_sink->widget);
 332
 333       if (!qt_sink->display || !qt_sink->context || !qt_sink->qt_context) {
 334         GST_ELEMENT_ERROR (element, RESOURCE, NOT_FOUND,
 335             ("%s", "Could not retrieve window system OpenGL configuration"),
 336             (NULL));
 337         return GST_STATE_CHANGE_FAILURE;
 338       }
 339       break;
 340     case GST_STATE_CHANGE_READY_TO_PAUSED:
 341       break;
 342     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
 343       break;
 344     default:
 345       break;
 346   }
 347
 348   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 349   if (ret == GST_STATE_CHANGE_FAILURE)
 350     return ret;
 351
 352   switch (transition) {
 353     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
 354       break;
 355     case GST_STATE_CHANGE_PAUSED_TO_READY:
 356       qt_item_set_buffer (qt_sink->widget, NULL);
 357       break;
 358     case GST_STATE_CHANGE_READY_TO_NULL:
 359       break;
 360     default:
 361       break;
 362   }
 363
 364   return ret;
 365 }
 366
 367 static void
 368 gst_qt_sink_get_times (GstBaseSink * bsink, GstBuffer * buf,
 369     GstClockTime * start, GstClockTime * end)
 370 {
 371   GstQtSink *qt_sink;
 372
 373   qt_sink = GST_QT_SINK (bsink);
 374
 375   if (GST_BUFFER_TIMESTAMP_IS_VALID (buf)) {
 376     *start = GST_BUFFER_TIMESTAMP (buf);
 377     if (GST_BUFFER_DURATION_IS_VALID (buf))
 378       *end = *start + GST_BUFFER_DURATION (buf);
 379     else {
 380       if (GST_VIDEO_INFO_FPS_N (&qt_sink->v_info) > 0) {
 381         *end = *start +
 382             gst_util_uint64_scale_int (GST_SECOND,
 383             GST_VIDEO_INFO_FPS_D (&qt_sink->v_info),
 384             GST_VIDEO_INFO_FPS_N (&qt_sink->v_info));
 385       }
 386     }
 387   }
 388 }
 389
 390 gboolean
 391 gst_qt_sink_set_caps (GstBaseSink * bsink, GstCaps * caps)
 392 {
 393   GstQtSink *qt_sink = GST_QT_SINK (bsink);
 394
 395   GST_DEBUG ("set caps with %" GST_PTR_FORMAT, caps);
 396
 397   if (!gst_video_info_from_caps (&qt_sink->v_info, caps))
 398     return FALSE;
 399
 400   if (!qt_item_set_caps (qt_sink->widget, caps))
 401     return FALSE;
 402
 403   return TRUE;
 404 }
 405
 406 static GstFlowReturn
 407 gst_qt_sink_show_frame (GstVideoSink * vsink, GstBuffer * buf)
 408 {
 409   GstQtSink *qt_sink;
 410
 411   GST_TRACE ("rendering buffer:%p", buf);
 412
 413   qt_sink = GST_QT_SINK (vsink);
 414
 415   qt_item_set_buffer (qt_sink->widget, buf);
 416
 417   return GST_FLOW_OK;
 418 }
 419
 420 static gboolean
 421 gst_qt_sink_propose_allocation (GstBaseSink * bsink, GstQuery * query)
 422 {
 423   GstQtSink *qt_sink = GST_QT_SINK (bsink);
 424   GstBufferPool *pool;
 425   GstStructure *config;
 426   GstCaps *caps;
 427   guint size;
 428   gboolean need_pool;
 429
 430   if (!qt_sink->display || !qt_sink->context)
 431     return FALSE;
 432
 433   gst_query_parse_allocation (query, &caps, &need_pool);
 434
 435   if (caps == NULL)
 436     goto no_caps;
 437
 438   if ((pool = qt_sink->pool))
 439     gst_object_ref (pool);
 440
 441   if (pool != NULL) {
 442     GstCaps *pcaps;
 443
 444     /* we had a pool, check caps */
 445     GST_DEBUG_OBJECT (qt_sink, "check existing pool caps");
 446     config = gst_buffer_pool_get_config (pool);
 447     gst_buffer_pool_config_get_params (config, &pcaps, &size, NULL, NULL);
 448
 449     if (!gst_caps_is_equal (caps, pcaps)) {
 450       GST_DEBUG_OBJECT (qt_sink, "pool has different caps");
 451       /* different caps, we can't use this pool */
 452       gst_object_unref (pool);
 453       pool = NULL;
 454     }
 455     gst_structure_free (config);
 456   }
 457
 458   if (pool == NULL && need_pool) {
 459     GstVideoInfo info;
 460
 461     if (!gst_video_info_from_caps (&info, caps))
 462       goto invalid_caps;
 463
 464     GST_DEBUG_OBJECT (qt_sink, "create new pool");
 465     pool = gst_gl_buffer_pool_new (qt_sink->context);
 466
 467     /* the normal size of a frame */
 468     size = info.size;
 469
 470     config = gst_buffer_pool_get_config (pool);
 471     gst_buffer_pool_config_set_params (config, caps, size, 0, 0);
 472     if (!gst_buffer_pool_set_config (pool, config))
 473       goto config_failed;
 474   }
 475   /* we need at least 2 buffer because we hold on to the last one */
 476   if (pool) {
 477     gst_query_add_allocation_pool (query, pool, size, 2, 0);
 478     gst_object_unref (pool);
 479   }
 480
 481   /* we also support various metadata */
 482   gst_query_add_allocation_meta (query, GST_VIDEO_META_API_TYPE, 0);
 483
 484   if (qt_sink->context->gl_vtable->FenceSync)
 485     gst_query_add_allocation_meta (query, GST_GL_SYNC_META_API_TYPE, 0);
 486
 487   return TRUE;
 488
 489   /* ERRORS */
 490 no_caps:
 491   {
 492     GST_DEBUG_OBJECT (bsink, "no caps specified");
 493     return FALSE;
 494   }
 495 invalid_caps:
 496   {
 497     GST_DEBUG_OBJECT (bsink, "invalid caps specified");
 498     return FALSE;
 499   }
 500 config_failed:
 501   {
 502     GST_DEBUG_OBJECT (bsink, "failed setting config");
 503     return FALSE;
 504   }
 505 }