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 <QtGui/QGuiApplication>
33 #include <gst/gl/gstglfuncs.h>
35 #define GST_CAT_DEFAULT gst_debug_qt_gl_sink
36 GST_DEBUG_CATEGORY (GST_CAT_DEFAULT);
38 static void gst_qt_sink_finalize (GObject * object);
39 static void gst_qt_sink_set_property (GObject * object, guint prop_id,
40 const GValue * value, GParamSpec * param_spec);
41 static void gst_qt_sink_get_property (GObject * object, guint prop_id,
42 GValue * value, GParamSpec * param_spec);
44 static gboolean gst_qt_sink_stop (GstBaseSink * bsink);
46 static gboolean gst_qt_sink_query (GstBaseSink * bsink, GstQuery * query);
48 static GstStateChangeReturn
49 gst_qt_sink_change_state (GstElement * element, GstStateChange transition);
51 static void gst_qt_sink_get_times (GstBaseSink * bsink, GstBuffer * buf,
52 GstClockTime * start, GstClockTime * end);
53 static gboolean gst_qt_sink_set_caps (GstBaseSink * bsink, GstCaps * caps);
54 static GstFlowReturn gst_qt_sink_show_frame (GstVideoSink * bsink,
56 static gboolean gst_qt_sink_propose_allocation (GstBaseSink * bsink,
59 static GstStaticPadTemplate gst_qt_sink_template =
60 GST_STATIC_PAD_TEMPLATE ("sink",
63 GST_STATIC_CAPS ("video/x-raw(" GST_CAPS_FEATURE_MEMORY_GL_MEMORY "), "
64 "format = (string) RGBA, "
65 "width = " GST_VIDEO_SIZE_RANGE ", "
66 "height = " GST_VIDEO_SIZE_RANGE ", "
67 "framerate = " GST_VIDEO_FPS_RANGE ", "
68 "texture-target = (string) 2D"));
70 #define DEFAULT_FORCE_ASPECT_RATIO TRUE
71 #define DEFAULT_PAR_N 0
72 #define DEFAULT_PAR_D 1
78 PROP_FORCE_ASPECT_RATIO,
79 PROP_PIXEL_ASPECT_RATIO,
88 #define gst_qt_sink_parent_class parent_class
89 G_DEFINE_TYPE_WITH_CODE (GstQtSink, gst_qt_sink,
90 GST_TYPE_VIDEO_SINK, GST_DEBUG_CATEGORY_INIT (GST_CAT_DEFAULT,
91 "qtsink", 0, "Qt Video Sink"));
94 gst_qt_sink_class_init (GstQtSinkClass * klass)
96 GObjectClass *gobject_class;
97 GstElementClass *gstelement_class;
98 GstBaseSinkClass *gstbasesink_class;
99 GstVideoSinkClass *gstvideosink_class;
101 gobject_class = (GObjectClass *) klass;
102 gstelement_class = (GstElementClass *) klass;
103 gstbasesink_class = (GstBaseSinkClass *) klass;
104 gstvideosink_class = (GstVideoSinkClass *) klass;
106 gobject_class->set_property = gst_qt_sink_set_property;
107 gobject_class->get_property = gst_qt_sink_get_property;
109 gst_element_class_set_metadata (gstelement_class, "Qt Video Sink",
110 "Sink/Video", "A video sink that renders to a QQuickItem",
111 "Matthew Waters <matthew@centricular.com>");
113 g_object_class_install_property (gobject_class, PROP_WIDGET,
114 g_param_spec_pointer ("widget", "QQuickItem",
115 "The QQuickItem to place in the object hierarchy",
116 (GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
118 g_object_class_install_property (gobject_class, PROP_FORCE_ASPECT_RATIO,
119 g_param_spec_boolean ("force-aspect-ratio",
120 "Force aspect ratio",
121 "When enabled, scaling will respect original aspect ratio",
122 DEFAULT_FORCE_ASPECT_RATIO,
123 (GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
125 g_object_class_install_property (gobject_class, PROP_PIXEL_ASPECT_RATIO,
126 gst_param_spec_fraction ("pixel-aspect-ratio", "Pixel Aspect Ratio",
127 "The pixel aspect ratio of the device", DEFAULT_PAR_N, DEFAULT_PAR_D,
129 (GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
131 gst_element_class_add_static_pad_template (gstelement_class, &gst_qt_sink_template);
133 gobject_class->finalize = gst_qt_sink_finalize;
135 gstelement_class->change_state = gst_qt_sink_change_state;
136 gstbasesink_class->query = gst_qt_sink_query;
137 gstbasesink_class->set_caps = gst_qt_sink_set_caps;
138 gstbasesink_class->get_times = gst_qt_sink_get_times;
139 gstbasesink_class->propose_allocation = gst_qt_sink_propose_allocation;
140 gstbasesink_class->stop = gst_qt_sink_stop;
142 gstvideosink_class->show_frame = gst_qt_sink_show_frame;
146 gst_qt_sink_init (GstQtSink * qt_sink)
148 qt_sink->widget = QSharedPointer<QtGLVideoItemInterface>();
152 gst_qt_sink_set_property (GObject * object, guint prop_id,
153 const GValue * value, GParamSpec * pspec)
155 GstQtSink *qt_sink = GST_QT_SINK (object);
159 QtGLVideoItem *qt_item = static_cast<QtGLVideoItem *> (g_value_get_pointer (value));
161 qt_sink->widget = qt_item->getInterface();
163 qt_sink->widget.clear();
166 case PROP_FORCE_ASPECT_RATIO:
167 g_return_if_fail (qt_sink->widget);
168 qt_sink->widget->setForceAspectRatio (g_value_get_boolean (value));
170 case PROP_PIXEL_ASPECT_RATIO:
171 g_return_if_fail (qt_sink->widget);
172 qt_sink->widget->setDAR (gst_value_get_fraction_numerator (value),
173 gst_value_get_fraction_denominator (value));
176 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
182 _reset (GstQtSink * qt_sink)
184 if (qt_sink->display) {
185 gst_object_unref (qt_sink->display);
186 qt_sink->display = NULL;
189 if (qt_sink->context) {
190 gst_object_unref (qt_sink->context);
191 qt_sink->context = NULL;
194 if (qt_sink->qt_context) {
195 gst_object_unref (qt_sink->qt_context);
196 qt_sink->qt_context = NULL;
201 gst_qt_sink_finalize (GObject * object)
203 GstQtSink *qt_sink = GST_QT_SINK (object);
207 qt_sink->widget.clear();
209 G_OBJECT_CLASS (parent_class)->finalize (object);
213 gst_qt_sink_get_property (GObject * object, guint prop_id,
214 GValue * value, GParamSpec * pspec)
216 GstQtSink *qt_sink = GST_QT_SINK (object);
220 /* This is not really safe - the app needs to be
221 * sure the widget is going to be kept alive or
224 g_value_set_pointer (value, qt_sink->widget->videoItem());
226 g_value_set_pointer (value, NULL);
228 case PROP_FORCE_ASPECT_RATIO:
230 g_value_set_boolean (value, qt_sink->widget->getForceAspectRatio ());
232 g_value_set_boolean (value, DEFAULT_FORCE_ASPECT_RATIO);
234 case PROP_PIXEL_ASPECT_RATIO:
235 if (qt_sink->widget) {
237 qt_sink->widget->getDAR (&num, &den);
238 gst_value_set_fraction (value, num, den);
240 gst_value_set_fraction (value, DEFAULT_PAR_N, DEFAULT_PAR_D);
244 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
250 gst_qt_sink_query (GstBaseSink * bsink, GstQuery * query)
252 GstQtSink *qt_sink = GST_QT_SINK (bsink);
253 gboolean res = FALSE;
255 switch (GST_QUERY_TYPE (query)) {
256 case GST_QUERY_CONTEXT:
258 if (gst_gl_handle_context_query ((GstElement *) qt_sink, query,
259 qt_sink->display, qt_sink->context, qt_sink->qt_context))
265 res = GST_BASE_SINK_CLASS (parent_class)->query (bsink, query);
273 gst_qt_sink_stop (GstBaseSink * bsink)
278 static GstStateChangeReturn
279 gst_qt_sink_change_state (GstElement * element, GstStateChange transition)
281 GstQtSink *qt_sink = GST_QT_SINK (element);
282 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
283 QGuiApplication *app;
285 GST_DEBUG ("changing state: %s => %s",
286 gst_element_state_get_name (GST_STATE_TRANSITION_CURRENT (transition)),
287 gst_element_state_get_name (GST_STATE_TRANSITION_NEXT (transition)));
289 switch (transition) {
290 case GST_STATE_CHANGE_NULL_TO_READY:
291 app = static_cast<QGuiApplication *> (QCoreApplication::instance ());
293 GST_ELEMENT_ERROR (element, RESOURCE, NOT_FOUND,
294 ("%s", "Failed to connect to Qt"),
295 ("%s", "Could not retrieve QGuiApplication instance"));
296 return GST_STATE_CHANGE_FAILURE;
299 if (!qt_sink->widget) {
300 GST_ELEMENT_ERROR (element, RESOURCE, NOT_FOUND,
301 ("%s", "Required property \'widget\' not set"),
303 return GST_STATE_CHANGE_FAILURE;
306 if (!qt_sink->widget->initWinSys()) {
307 GST_ELEMENT_ERROR (element, RESOURCE, NOT_FOUND,
308 ("%s", "Could not initialize window system"),
310 return GST_STATE_CHANGE_FAILURE;
313 qt_sink->display = qt_sink->widget->getDisplay();
314 qt_sink->context = qt_sink->widget->getContext();
315 qt_sink->qt_context = qt_sink->widget->getQtContext();
317 if (!qt_sink->display || !qt_sink->context || !qt_sink->qt_context) {
318 GST_ELEMENT_ERROR (element, RESOURCE, NOT_FOUND,
319 ("%s", "Could not retrieve window system OpenGL configuration"),
321 return GST_STATE_CHANGE_FAILURE;
324 case GST_STATE_CHANGE_READY_TO_PAUSED:
326 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
332 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
333 if (ret == GST_STATE_CHANGE_FAILURE)
336 switch (transition) {
337 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
339 case GST_STATE_CHANGE_PAUSED_TO_READY:
341 qt_sink->widget->setBuffer(NULL);
343 case GST_STATE_CHANGE_READY_TO_NULL:
353 gst_qt_sink_get_times (GstBaseSink * bsink, GstBuffer * buf,
354 GstClockTime * start, GstClockTime * end)
358 qt_sink = GST_QT_SINK (bsink);
360 if (GST_BUFFER_TIMESTAMP_IS_VALID (buf)) {
361 *start = GST_BUFFER_TIMESTAMP (buf);
362 if (GST_BUFFER_DURATION_IS_VALID (buf))
363 *end = *start + GST_BUFFER_DURATION (buf);
365 if (GST_VIDEO_INFO_FPS_N (&qt_sink->v_info) > 0) {
367 gst_util_uint64_scale_int (GST_SECOND,
368 GST_VIDEO_INFO_FPS_D (&qt_sink->v_info),
369 GST_VIDEO_INFO_FPS_N (&qt_sink->v_info));
376 gst_qt_sink_set_caps (GstBaseSink * bsink, GstCaps * caps)
378 GstQtSink *qt_sink = GST_QT_SINK (bsink);
380 GST_DEBUG ("set caps with %" GST_PTR_FORMAT, caps);
382 if (!gst_video_info_from_caps (&qt_sink->v_info, caps))
385 if (!qt_sink->widget)
388 return qt_sink->widget->setCaps(caps);
392 gst_qt_sink_show_frame (GstVideoSink * vsink, GstBuffer * buf)
396 GST_TRACE ("rendering buffer:%p", buf);
398 qt_sink = GST_QT_SINK (vsink);
401 qt_sink->widget->setBuffer(buf);
407 gst_qt_sink_propose_allocation (GstBaseSink * bsink, GstQuery * query)
409 GstQtSink *qt_sink = GST_QT_SINK (bsink);
411 GstStructure *config;
416 if (!qt_sink->display || !qt_sink->context)
419 gst_query_parse_allocation (query, &caps, &need_pool);
424 if ((pool = qt_sink->pool))
425 gst_object_ref (pool);
430 /* we had a pool, check caps */
431 GST_DEBUG_OBJECT (qt_sink, "check existing pool caps");
432 config = gst_buffer_pool_get_config (pool);
433 gst_buffer_pool_config_get_params (config, &pcaps, &size, NULL, NULL);
435 if (!gst_caps_is_equal (caps, pcaps)) {
436 GST_DEBUG_OBJECT (qt_sink, "pool has different caps");
437 /* different caps, we can't use this pool */
438 gst_object_unref (pool);
441 gst_structure_free (config);
444 if (pool == NULL && need_pool) {
447 if (!gst_video_info_from_caps (&info, caps))
450 GST_DEBUG_OBJECT (qt_sink, "create new pool");
451 pool = gst_gl_buffer_pool_new (qt_sink->context);
453 /* the normal size of a frame */
456 config = gst_buffer_pool_get_config (pool);
457 gst_buffer_pool_config_set_params (config, caps, size, 0, 0);
458 if (!gst_buffer_pool_set_config (pool, config))
461 /* we need at least 2 buffer because we hold on to the last one */
463 gst_query_add_allocation_pool (query, pool, size, 2, 0);
464 gst_object_unref (pool);
467 /* we also support various metadata */
468 gst_query_add_allocation_meta (query, GST_VIDEO_META_API_TYPE, 0);
470 if (qt_sink->context->gl_vtable->FenceSync)
471 gst_query_add_allocation_meta (query, GST_GL_SYNC_META_API_TYPE, 0);
478 GST_DEBUG_OBJECT (bsink, "no caps specified");
483 GST_DEBUG_OBJECT (bsink, "invalid caps specified");
488 GST_DEBUG_OBJECT (bsink, "failed setting config");