Line data Source code
1 : /*
2 : * Copyright (C) 2022 Sky UK
3 : *
4 : * This library is free software; you can redistribute it and/or
5 : * modify it under the terms of the GNU Lesser General Public
6 : * License as published by the Free Software Foundation;
7 : * version 2.1 of the License.
8 : *
9 : * This library is distributed in the hope that it will be useful,
10 : * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 : * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 : * Lesser General Public License for more details.
13 : *
14 : * You should have received a copy of the GNU Lesser General Public
15 : * License along with this library; if not, write to the Free Software
16 : * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17 : */
18 :
19 : #define USE_GLIB 1
20 :
21 : #include <cstring>
22 : #include <limits>
23 :
24 : #include <gst/gst.h>
25 :
26 : #include "ControlBackend.h"
27 : #include "GStreamerUtils.h"
28 : #include "IClientLogControl.h"
29 : #include "IMediaPipeline.h"
30 : #include "LogToGstHandler.h"
31 : #include "RialtoGStreamerMSEBaseSink.h"
32 : #include "RialtoGStreamerMSEBaseSinkPrivate.h"
33 :
34 : GST_DEBUG_CATEGORY_STATIC(RialtoMSEBaseSinkDebug);
35 : #define GST_CAT_DEFAULT RialtoMSEBaseSinkDebug
36 :
37 : #define rialto_mse_base_sink_parent_class parent_class
38 4675 : G_DEFINE_TYPE_WITH_CODE(RialtoMSEBaseSink, rialto_mse_base_sink, GST_TYPE_ELEMENT,
39 : G_ADD_PRIVATE(RialtoMSEBaseSink)
40 : GST_DEBUG_CATEGORY_INIT(RialtoMSEBaseSinkDebug, "rialtomsebasesink", 0,
41 : "rialto mse base sink"));
42 :
43 : enum
44 : {
45 : PROP_0,
46 : PROP_IS_SINGLE_PATH_STREAM,
47 : PROP_N_STREAMS,
48 : PROP_HAS_DRM,
49 : PROP_STATS,
50 : PROP_LAST_SAMPLE,
51 : PROP_ENABLE_LAST_SAMPLE,
52 : PROP_LAST
53 : };
54 :
55 : enum
56 : {
57 : SIGNAL_UNDERFLOW,
58 : SIGNAL_LAST
59 : };
60 :
61 : static guint g_signals[SIGNAL_LAST] = {0};
62 :
63 335 : void rialto_mse_base_sink_initialise_delegate(RialtoMSEBaseSink *sink, const std::shared_ptr<IPlaybackDelegate> &delegate)
64 : {
65 335 : std::unique_lock lock{sink->priv->m_sinkMutex};
66 335 : sink->priv->m_delegate = delegate;
67 :
68 337 : for (auto &[type, value] : sink->priv->m_queuedProperties)
69 : {
70 2 : delegate->setProperty(type, &value);
71 2 : g_value_unset(&value);
72 : }
73 335 : sink->priv->m_queuedProperties.clear();
74 : }
75 :
76 1960 : static std::shared_ptr<IPlaybackDelegate> rialto_mse_base_sink_get_delegate(RialtoMSEBaseSink *sink)
77 : {
78 1960 : std::unique_lock lock{sink->priv->m_sinkMutex};
79 1960 : if (!sink->priv->m_delegate)
80 : {
81 16 : GST_ERROR_OBJECT(sink, "Sink delegate not initialized");
82 : }
83 3920 : return sink->priv->m_delegate;
84 1960 : }
85 :
86 46 : static gboolean rialto_mse_base_sink_send_event(GstElement *element, GstEvent *event)
87 : {
88 46 : if (auto delegate = rialto_mse_base_sink_get_delegate(RIALTO_MSE_BASE_SINK(element)))
89 : {
90 45 : return delegate->handleSendEvent(event);
91 46 : }
92 1 : gst_event_unref(event);
93 1 : return FALSE;
94 : }
95 :
96 235 : gboolean rialto_mse_base_sink_event(GstPad *pad, GstObject *parent, GstEvent *event)
97 : {
98 235 : if (auto delegate = rialto_mse_base_sink_get_delegate(RIALTO_MSE_BASE_SINK(parent)))
99 : {
100 233 : return delegate->handleEvent(pad, parent, event);
101 235 : }
102 2 : gst_event_unref(event);
103 2 : return FALSE;
104 : }
105 :
106 37 : GstFlowReturn rialto_mse_base_sink_chain(GstPad *pad, GstObject *parent, GstBuffer *buf)
107 : {
108 37 : if (auto delegate = rialto_mse_base_sink_get_delegate(RIALTO_MSE_BASE_SINK(parent)))
109 : {
110 36 : return delegate->handleBuffer(buf);
111 37 : }
112 1 : gst_buffer_unref(buf);
113 1 : return GST_FLOW_ERROR;
114 : }
115 :
116 52 : static gboolean rialto_mse_base_sink_query(GstElement *element, GstQuery *query)
117 : {
118 52 : RialtoMSEBaseSink *sink = RIALTO_MSE_BASE_SINK(element);
119 52 : if (auto delegate = rialto_mse_base_sink_get_delegate(sink))
120 : {
121 52 : std::optional<gboolean> result{delegate->handleQuery(query)};
122 52 : if (result.has_value())
123 : {
124 22 : return result.value();
125 : }
126 30 : GstElement *parent = GST_ELEMENT(&sink->parent);
127 30 : return GST_ELEMENT_CLASS(parent_class)->query(parent, query);
128 52 : }
129 0 : return FALSE;
130 : }
131 :
132 1056 : static GstStateChangeReturn rialto_mse_base_sink_change_state(GstElement *element, GstStateChange transition)
133 : {
134 1056 : RialtoMSEBaseSink *sink = RIALTO_MSE_BASE_SINK(element);
135 1056 : if (auto delegate = rialto_mse_base_sink_get_delegate(sink))
136 : {
137 1055 : GstStateChangeReturn status = delegate->changeState(transition);
138 1055 : if (GST_STATE_CHANGE_FAILURE != status)
139 : {
140 1048 : if (GST_STATE_CHANGE_READY_TO_NULL == transition)
141 : {
142 327 : sink->priv->m_delegate.reset();
143 : }
144 1048 : GstStateChangeReturn result = GST_ELEMENT_CLASS(parent_class)->change_state(element, transition);
145 1048 : if (G_UNLIKELY(result == GST_STATE_CHANGE_FAILURE))
146 : {
147 0 : GST_WARNING_OBJECT(sink, "State change failed");
148 0 : return result;
149 : }
150 1048 : else if (result == GST_STATE_CHANGE_ASYNC)
151 : {
152 0 : return GST_STATE_CHANGE_ASYNC;
153 : }
154 : }
155 1055 : return status;
156 1056 : }
157 1 : return GST_STATE_CHANGE_FAILURE;
158 : }
159 :
160 64 : void rialto_mse_base_sink_handle_get_property(RialtoMSEBaseSink *sink, const IPlaybackDelegate::Property &property,
161 : GValue *value)
162 : {
163 64 : if (auto delegate = rialto_mse_base_sink_get_delegate(sink))
164 : {
165 63 : delegate->getProperty(property, value);
166 : }
167 : else // Copy queued value if present
168 : {
169 1 : std::unique_lock lock{sink->priv->m_sinkMutex};
170 1 : if (sink->priv->m_queuedProperties.find(property) != sink->priv->m_queuedProperties.end())
171 : {
172 1 : g_value_copy(&sink->priv->m_queuedProperties[property], value);
173 : }
174 65 : }
175 64 : }
176 :
177 470 : void rialto_mse_base_sink_handle_set_property(RialtoMSEBaseSink *sink, const IPlaybackDelegate::Property &property,
178 : const GValue *value)
179 : {
180 470 : if (auto delegate = rialto_mse_base_sink_get_delegate(sink))
181 : {
182 460 : delegate->setProperty(property, value);
183 : }
184 : else
185 : {
186 10 : std::unique_lock lock{sink->priv->m_sinkMutex};
187 10 : if (sink->priv->m_queuedProperties.find(property) != sink->priv->m_queuedProperties.end())
188 : {
189 1 : g_value_unset(&sink->priv->m_queuedProperties[property]);
190 : }
191 10 : sink->priv->m_queuedProperties[property] = G_VALUE_INIT;
192 10 : g_value_init(&(sink->priv->m_queuedProperties[property]), G_VALUE_TYPE(value));
193 10 : g_value_copy(value, &(sink->priv->m_queuedProperties[property]));
194 480 : }
195 470 : }
196 :
197 12 : static void rialto_mse_base_sink_get_property(GObject *object, guint propId, GValue *value, GParamSpec *pspec)
198 : {
199 12 : switch (propId)
200 : {
201 1 : case PROP_IS_SINGLE_PATH_STREAM:
202 : // Set default value if it can't be acquired
203 1 : g_value_set_boolean(value, FALSE);
204 1 : rialto_mse_base_sink_handle_get_property(RIALTO_MSE_BASE_SINK(object),
205 1 : IPlaybackDelegate::Property::IsSinglePathStream, value);
206 1 : break;
207 2 : case PROP_N_STREAMS:
208 : // Set default value if it can't be acquired
209 2 : g_value_set_int(value, 1);
210 2 : rialto_mse_base_sink_handle_get_property(RIALTO_MSE_BASE_SINK(object),
211 2 : IPlaybackDelegate::Property::NumberOfStreams, value);
212 2 : break;
213 1 : case PROP_HAS_DRM:
214 : // Set default value if it can't be acquired
215 1 : g_value_set_boolean(value, TRUE);
216 1 : rialto_mse_base_sink_handle_get_property(RIALTO_MSE_BASE_SINK(object), IPlaybackDelegate::Property::HasDrm,
217 : value);
218 1 : break;
219 2 : case PROP_STATS:
220 2 : rialto_mse_base_sink_handle_get_property(RIALTO_MSE_BASE_SINK(object), IPlaybackDelegate::Property::Stats, value);
221 2 : break;
222 2 : case PROP_ENABLE_LAST_SAMPLE:
223 2 : rialto_mse_base_sink_handle_get_property(RIALTO_MSE_BASE_SINK(object),
224 2 : IPlaybackDelegate::Property::EnableLastSample, value);
225 2 : break;
226 4 : case PROP_LAST_SAMPLE:
227 4 : rialto_mse_base_sink_handle_get_property(RIALTO_MSE_BASE_SINK(object), IPlaybackDelegate::Property::LastSample,
228 : value);
229 4 : break;
230 0 : default:
231 0 : G_OBJECT_WARN_INVALID_PROPERTY_ID(object, propId, pspec);
232 0 : break;
233 : }
234 12 : }
235 :
236 390 : static void rialto_mse_base_sink_set_property(GObject *object, guint propId, const GValue *value, GParamSpec *pspec)
237 : {
238 390 : switch (propId)
239 : {
240 193 : case PROP_IS_SINGLE_PATH_STREAM:
241 193 : rialto_mse_base_sink_handle_set_property(RIALTO_MSE_BASE_SINK(object),
242 193 : IPlaybackDelegate::Property::IsSinglePathStream, value);
243 193 : break;
244 195 : case PROP_N_STREAMS:
245 195 : rialto_mse_base_sink_handle_set_property(RIALTO_MSE_BASE_SINK(object),
246 195 : IPlaybackDelegate::Property::NumberOfStreams, value);
247 195 : break;
248 1 : case PROP_HAS_DRM:
249 1 : rialto_mse_base_sink_handle_set_property(RIALTO_MSE_BASE_SINK(object), IPlaybackDelegate::Property::HasDrm,
250 : value);
251 1 : break;
252 1 : case PROP_ENABLE_LAST_SAMPLE:
253 1 : rialto_mse_base_sink_handle_set_property(RIALTO_MSE_BASE_SINK(object),
254 1 : IPlaybackDelegate::Property::EnableLastSample, value);
255 1 : break;
256 0 : default:
257 0 : G_OBJECT_WARN_INVALID_PROPERTY_ID(object, propId, pspec);
258 0 : break;
259 : }
260 390 : }
261 :
262 1 : void rialto_mse_base_handle_rialto_server_sent_buffer_underflow(RialtoMSEBaseSink *sink)
263 : {
264 1 : GST_WARNING_OBJECT(sink, "Sending underflow signal");
265 : // send 2 last parameters just to be compatible with RDK's buffer-underflow-callback signal signature
266 1 : g_signal_emit(G_OBJECT(sink), g_signals[SIGNAL_UNDERFLOW], 0, 0, nullptr);
267 : }
268 :
269 338 : bool rialto_mse_base_sink_initialise_sinkpad(RialtoMSEBaseSink *sink)
270 : {
271 : GstPadTemplate *pad_template =
272 338 : gst_element_class_get_pad_template(GST_ELEMENT_CLASS(G_OBJECT_GET_CLASS(sink)), "sink");
273 338 : if (!pad_template)
274 : {
275 0 : GST_ERROR_OBJECT(sink, "Could not find sink pad template");
276 0 : return false;
277 : }
278 :
279 338 : GstPad *sinkPad = gst_pad_new_from_template(pad_template, "sink");
280 338 : if (!sinkPad)
281 : {
282 0 : GST_ERROR_OBJECT(sink, "Could not create sinkpad");
283 0 : return false;
284 : }
285 :
286 338 : gst_element_add_pad(GST_ELEMENT_CAST(sink), sinkPad);
287 338 : sink->priv->m_sinkPad = sinkPad;
288 :
289 338 : return true;
290 : }
291 :
292 338 : static void rialto_mse_base_sink_init(RialtoMSEBaseSink *sink)
293 : {
294 338 : GST_INFO_OBJECT(sink, "Init: %" GST_PTR_FORMAT, sink);
295 338 : sink->priv = static_cast<RialtoMSEBaseSinkPrivate *>(rialto_mse_base_sink_get_instance_private(sink));
296 338 : new (sink->priv) RialtoMSEBaseSinkPrivate();
297 :
298 338 : GST_OBJECT_FLAG_SET(sink, GST_ELEMENT_FLAG_SINK);
299 : }
300 :
301 338 : static void rialto_mse_base_sink_finalize(GObject *object)
302 : {
303 338 : RialtoMSEBaseSink *sink = RIALTO_MSE_BASE_SINK(object);
304 338 : RialtoMSEBaseSinkPrivate *priv = sink->priv;
305 338 : GST_INFO_OBJECT(sink, "Finalize: %" GST_PTR_FORMAT " %" GST_PTR_FORMAT, sink, priv);
306 :
307 338 : priv->~RialtoMSEBaseSinkPrivate();
308 338 : GST_CALL_PARENT(G_OBJECT_CLASS, finalize, (object));
309 : }
310 :
311 1 : static void rialto_mse_base_sink_class_init(RialtoMSEBaseSinkClass *klass)
312 : {
313 : std::shared_ptr<firebolt::rialto::IClientLogHandler> logToGstHandler =
314 1 : std::make_shared<firebolt::rialto::LogToGstHandler>();
315 1 : if (!firebolt::rialto::IClientLogControlFactory::createFactory()->createClientLogControl().registerLogHandler(logToGstHandler,
316 : true))
317 : {
318 0 : GST_ERROR("Unable to preRegister log handler");
319 : }
320 :
321 1 : GObjectClass *gobjectClass = G_OBJECT_CLASS(klass);
322 1 : GstElementClass *elementClass = GST_ELEMENT_CLASS(klass);
323 :
324 1 : gst_element_class_set_metadata(elementClass, "Rialto MSE base sink", "Generic", "A sink for Rialto", "Sky");
325 :
326 1 : gobjectClass->finalize = rialto_mse_base_sink_finalize;
327 1 : gobjectClass->get_property = rialto_mse_base_sink_get_property;
328 1 : gobjectClass->set_property = rialto_mse_base_sink_set_property;
329 1 : elementClass->query = rialto_mse_base_sink_query;
330 1 : elementClass->send_event = rialto_mse_base_sink_send_event;
331 1 : elementClass->change_state = rialto_mse_base_sink_change_state;
332 :
333 1 : g_signals[SIGNAL_UNDERFLOW] = g_signal_new("buffer-underflow-callback", G_TYPE_FROM_CLASS(klass),
334 : (GSignalFlags)(G_SIGNAL_RUN_LAST), 0, nullptr, nullptr,
335 : g_cclosure_marshal_VOID__UINT_POINTER, G_TYPE_NONE, 2, G_TYPE_UINT,
336 : G_TYPE_POINTER);
337 :
338 1 : g_object_class_install_property(gobjectClass, PROP_IS_SINGLE_PATH_STREAM,
339 : g_param_spec_boolean("single-path-stream", "single path stream",
340 : "is single path stream", FALSE, GParamFlags(G_PARAM_READWRITE)));
341 :
342 1 : g_object_class_install_property(gobjectClass, PROP_N_STREAMS,
343 : g_param_spec_int("streams-number", "streams number", "streams number", 1, G_MAXINT,
344 : 1, GParamFlags(G_PARAM_READWRITE)));
345 :
346 1 : g_object_class_install_property(gobjectClass, PROP_HAS_DRM,
347 : g_param_spec_boolean("has-drm", "has drm", "has drm", TRUE,
348 : GParamFlags(G_PARAM_READWRITE)));
349 1 : g_object_class_install_property(gobjectClass, PROP_STATS,
350 : g_param_spec_pointer("stats", NULL, "pointer to a gst_structure",
351 : GParamFlags(G_PARAM_READABLE)));
352 :
353 1 : g_object_class_install_property(gobjectClass, PROP_ENABLE_LAST_SAMPLE,
354 : g_param_spec_boolean("enable-last-sample", "Enable Last Buffer",
355 : "Enable the last-sample property", FALSE,
356 : GParamFlags(G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
357 :
358 1 : g_object_class_install_property(gobjectClass, PROP_LAST_SAMPLE,
359 : g_param_spec_boxed("last-sample", "Last Sample",
360 : "The last sample received in the sink", GST_TYPE_SAMPLE,
361 : GParamFlags(G_PARAM_READABLE | G_PARAM_STATIC_STRINGS)));
362 : }
|