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.
30 #include "gstqtsink.h"
31 #include <QGuiApplication>
33 #define GST_CAT_DEFAULT gst_debug_qt_gl_sink
34 GST_DEBUG_CATEGORY (GST_CAT_DEFAULT);
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);
42 static gboolean gst_qt_sink_stop (GstBaseSink * bsink);
44 static gboolean gst_qt_sink_query (GstBaseSink * bsink, GstQuery * query);
46 static GstStateChangeReturn
47 gst_qt_sink_change_state (GstElement * element, GstStateChange transition);
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,
54 static gboolean gst_qt_sink_propose_allocation (GstBaseSink * bsink,
57 static GstStaticPadTemplate gst_qt_sink_template =
58 GST_STATIC_PAD_TEMPLATE ("sink",
61 GST_STATIC_CAPS (GST_VIDEO_CAPS_MAKE_WITH_FEATURES
62 (GST_CAPS_FEATURE_MEMORY_GL_MEMORY, "RGBA")));
64 #define DEFAULT_FORCE_ASPECT_RATIO TRUE
65 #define DEFAULT_PAR_N 0
66 #define DEFAULT_PAR_D 1
72 PROP_FORCE_ASPECT_RATIO,
73 PROP_PIXEL_ASPECT_RATIO,
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"));
88 gst_qt_sink_class_init (GstQtSinkClass * klass)
90 GObjectClass *gobject_class;
91 GstElementClass *gstelement_class;
92 GstBaseSinkClass *gstbasesink_class;
93 GstVideoSinkClass *gstvideosink_class;
95 gobject_class = (GObjectClass *) klass;
96 gstelement_class = (GstElementClass *) klass;
97 gstbasesink_class = (GstBaseSinkClass *) klass;
98 gstvideosink_class = (GstVideoSinkClass *) klass;
100 gobject_class->set_property = gst_qt_sink_set_property;
101 gobject_class->get_property = gst_qt_sink_get_property;
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>");
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)));
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)));
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,
123 (GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
125 gst_element_class_add_pad_template (gstelement_class,
126 gst_static_pad_template_get (&gst_qt_sink_template));
128 gobject_class->finalize = gst_qt_sink_finalize;
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;
137 gstvideosink_class->show_frame = gst_qt_sink_show_frame;
141 gst_qt_sink_init (GstQtSink * qt_sink)
146 gst_qt_sink_set_property (GObject * object, guint prop_id,
147 const GValue * value, GParamSpec * pspec)
149 GstQtSink *qt_sink = GST_QT_SINK (object);
153 qt_sink->widget = static_cast<QtGLVideoItem *> (g_value_get_pointer (value));
155 case PROP_FORCE_ASPECT_RATIO:
156 g_return_if_fail (qt_sink->widget);
157 qt_sink->widget->setForceAspectRatio (g_value_get_boolean (value));
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));
165 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
171 _reset (GstQtSink * qt_sink)
173 if (qt_sink->display) {
174 gst_object_unref (qt_sink->display);
175 qt_sink->display = NULL;
178 if (qt_sink->context) {
179 gst_object_unref (qt_sink->context);
180 qt_sink->context = NULL;
183 if (qt_sink->qt_context) {
184 gst_object_unref (qt_sink->qt_context);
185 qt_sink->qt_context = NULL;
190 gst_qt_sink_finalize (GObject * object)
192 GstQtSink *qt_sink = GST_QT_SINK (object);
196 G_OBJECT_CLASS (parent_class)->finalize (object);
200 gst_qt_sink_get_property (GObject * object, guint prop_id,
201 GValue * value, GParamSpec * pspec)
203 GstQtSink *qt_sink = GST_QT_SINK (object);
207 g_value_set_pointer (value, qt_sink->widget);
209 case PROP_FORCE_ASPECT_RATIO:
211 g_value_set_boolean (value, qt_sink->widget->getForceAspectRatio ());
213 g_value_set_boolean (value, DEFAULT_FORCE_ASPECT_RATIO);
215 case PROP_PIXEL_ASPECT_RATIO:
216 if (qt_sink->widget) {
218 qt_sink->widget->getDAR (&num, &den);
219 gst_value_set_fraction (value, num, den);
221 gst_value_set_fraction (value, DEFAULT_PAR_N, DEFAULT_PAR_D);
225 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
231 gst_qt_sink_query (GstBaseSink * bsink, GstQuery * query)
233 GstQtSink *qt_sink = GST_QT_SINK (bsink);
234 gboolean res = FALSE;
236 switch (GST_QUERY_TYPE (query)) {
237 case GST_QUERY_CONTEXT:
239 const gchar *context_type;
240 GstContext *context, *old_context;
243 ret = gst_gl_handle_context_query ((GstElement *) qt_sink, query,
244 &qt_sink->display, &qt_sink->qt_context);
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));
249 gst_query_parse_context_type (query, &context_type);
251 if (g_strcmp0 (context_type, "gst.gl.local_context") == 0) {
254 gst_query_parse_context (query, &old_context);
257 context = gst_context_copy (old_context);
259 context = gst_context_new ("gst.gl.local_context", FALSE);
261 s = gst_context_writable_structure (context);
262 gst_structure_set (s, "context", GST_GL_TYPE_CONTEXT, qt_sink->context,
264 gst_query_set_context (query, context);
265 gst_context_unref (context);
267 ret = qt_sink->context != NULL;
269 GST_LOG_OBJECT (qt_sink, "context query of type %s %i", context_type,
276 res = GST_BASE_SINK_CLASS (parent_class)->query (bsink, query);
284 gst_qt_sink_stop (GstBaseSink * bsink)
289 static GstStateChangeReturn
290 gst_qt_sink_change_state (GstElement * element, GstStateChange transition)
292 GstQtSink *qt_sink = GST_QT_SINK (element);
293 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
294 QGuiApplication *app;
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)));
300 switch (transition) {
301 case GST_STATE_CHANGE_NULL_TO_READY:
302 app = dynamic_cast<QGuiApplication *> (QCoreApplication::instance ());
304 GST_ELEMENT_ERROR (element, RESOURCE, NOT_FOUND,
305 ("%s", "Failed to connect to Qt"),
306 ("%s", "Could not retreive QGuiApplication instance"));
307 return GST_STATE_CHANGE_FAILURE;
310 if (!qt_sink->widget) {
311 GST_ELEMENT_ERROR (element, RESOURCE, NOT_FOUND,
312 ("%s", "Required property \'widget\' not set"),
314 return GST_STATE_CHANGE_FAILURE;
317 if (!qt_item_init_winsys (qt_sink->widget)) {
318 GST_ELEMENT_ERROR (element, RESOURCE, NOT_FOUND,
319 ("%s", "Could not initialize window system"),
321 return GST_STATE_CHANGE_FAILURE;
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);
328 if (!qt_sink->display || !qt_sink->context || !qt_sink->qt_context) {
329 GST_ELEMENT_ERROR (element, RESOURCE, NOT_FOUND,
330 ("%s", "Could not retreive window system OpenGL configuration"),
332 return GST_STATE_CHANGE_FAILURE;
335 case GST_STATE_CHANGE_READY_TO_PAUSED:
337 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
343 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
344 if (ret == GST_STATE_CHANGE_FAILURE)
347 switch (transition) {
348 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
350 case GST_STATE_CHANGE_PAUSED_TO_READY:
351 qt_item_set_buffer (qt_sink->widget, NULL);
353 case GST_STATE_CHANGE_READY_TO_NULL:
363 gst_qt_sink_get_times (GstBaseSink * bsink, GstBuffer * buf,
364 GstClockTime * start, GstClockTime * end)
368 qt_sink = GST_QT_SINK (bsink);
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);
375 if (GST_VIDEO_INFO_FPS_N (&qt_sink->v_info) > 0) {
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));
386 gst_qt_sink_set_caps (GstBaseSink * bsink, GstCaps * caps)
388 GstQtSink *qt_sink = GST_QT_SINK (bsink);
390 GST_DEBUG ("set caps with %" GST_PTR_FORMAT, caps);
392 if (!gst_video_info_from_caps (&qt_sink->v_info, caps))
395 if (!qt_item_set_caps (qt_sink->widget, caps))
402 gst_qt_sink_show_frame (GstVideoSink * vsink, GstBuffer * buf)
406 GST_TRACE ("rendering buffer:%p", buf);
408 qt_sink = GST_QT_SINK (vsink);
410 qt_item_set_buffer (qt_sink->widget, buf);
416 gst_qt_sink_propose_allocation (GstBaseSink * bsink, GstQuery * query)
418 GstQtSink *qt_sink = GST_QT_SINK (bsink);
420 GstStructure *config;
425 if (!qt_sink->display || !qt_sink->context)
428 gst_query_parse_allocation (query, &caps, &need_pool);
433 if ((pool = qt_sink->pool))
434 gst_object_ref (pool);
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);
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);
450 gst_structure_free (config);
453 if (pool == NULL && need_pool) {
456 if (!gst_video_info_from_caps (&info, caps))
459 GST_DEBUG_OBJECT (qt_sink, "create new pool");
460 pool = gst_gl_buffer_pool_new (qt_sink->context);
462 /* the normal size of a frame */
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))
470 /* we need at least 2 buffer because we hold on to the last one */
472 gst_query_add_allocation_pool (query, pool, size, 2, 0);
473 gst_object_unref (pool);
476 /* we also support various metadata */
477 gst_query_add_allocation_meta (query, GST_VIDEO_META_API_TYPE, 0);
479 if (qt_sink->context->gl_vtable->FenceSync)
480 gst_query_add_allocation_meta (query, GST_GL_SYNC_META_API_TYPE, 0);
487 GST_DEBUG_OBJECT (bsink, "no caps specified");
492 GST_DEBUG_OBJECT (bsink, "invalid caps specified");
497 GST_DEBUG_OBJECT (bsink, "failed setting config");