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