2 * Copyright (C) 2009, 2010 Sebastian Dröge <sebastian.droege@collabora.co.uk>
3 * Copyright (C) 2013 Collabora Ltd.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser 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 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #include "WebKitWebSourceGStreamer.h"
23 #if ENABLE(VIDEO) && USE(GSTREAMER)
25 #include "GRefPtrGStreamer.h"
26 #include "GStreamerUtilities.h"
27 #include "GUniquePtrGStreamer.h"
28 #include "HTTPHeaderNames.h"
29 #include "MainThreadNotifier.h"
30 #include "MediaPlayer.h"
31 #include "NotImplemented.h"
32 #include "PlatformMediaResourceLoader.h"
33 #include "ResourceError.h"
34 #include "ResourceHandle.h"
35 #include "ResourceHandleClient.h"
36 #include "ResourceRequest.h"
37 #include "ResourceResponse.h"
38 #include "SharedBuffer.h"
39 #include <gst/app/gstappsrc.h>
41 #include <gst/pbutils/missing-plugins.h>
42 #include <wtf/MainThread.h>
43 #include <wtf/Noncopyable.h>
44 #include <wtf/glib/GMutexLocker.h>
45 #include <wtf/glib/GRefPtr.h>
46 #include <wtf/glib/GUniquePtr.h>
47 #include <wtf/text/CString.h>
50 #include "SoupNetworkSession.h"
53 using namespace WebCore;
55 class StreamingClient {
57 StreamingClient(WebKitWebSrc*, ResourceRequest&&);
58 virtual ~StreamingClient();
61 char* createReadBuffer(size_t requestedSize, size_t& actualSize);
62 void handleResponseReceived(const ResourceResponse&);
63 void handleDataReceived(const char*, int);
64 void handleNotifyFinished();
66 GRefPtr<GstElement> m_src;
67 ResourceRequest m_request;
70 class CachedResourceStreamingClient final : public PlatformMediaResourceClient, public StreamingClient {
71 WTF_MAKE_NONCOPYABLE(CachedResourceStreamingClient);
73 CachedResourceStreamingClient(WebKitWebSrc*, ResourceRequest&&);
74 virtual ~CachedResourceStreamingClient();
77 // PlatformMediaResourceClient virtual methods.
79 char* getOrCreateReadBuffer(PlatformMediaResource&, size_t requestedSize, size_t& actualSize) override;
81 void responseReceived(PlatformMediaResource&, const ResourceResponse&) override;
82 void dataReceived(PlatformMediaResource&, const char*, int) override;
83 void accessControlCheckFailed(PlatformMediaResource&, const ResourceError&) override;
84 void loadFailed(PlatformMediaResource&, const ResourceError&) override;
85 void loadFinished(PlatformMediaResource&) override;
88 class ResourceHandleStreamingClient : public ThreadSafeRefCounted<ResourceHandleStreamingClient>, public ResourceHandleClient, public StreamingClient {
90 static Ref<ResourceHandleStreamingClient> create(WebKitWebSrc* src, ResourceRequest&& request)
92 return adoptRef(*new ResourceHandleStreamingClient(src, WTFMove(request)));
94 virtual ~ResourceHandleStreamingClient();
98 // StreamingClient virtual methods.
99 bool loadFailed() const;
100 void setDefersLoading(bool);
103 ResourceHandleStreamingClient(WebKitWebSrc*, ResourceRequest&&);
104 void cleanupAndStopRunLoop();
106 // ResourceHandleClient virtual methods.
108 char* getOrCreateReadBuffer(size_t requestedSize, size_t& actualSize) override;
110 ResourceRequest willSendRequest(ResourceHandle*, ResourceRequest&&, ResourceResponse&&) override;
111 void didReceiveResponse(ResourceHandle*, ResourceResponse&&) override;
112 void didReceiveData(ResourceHandle*, const char*, unsigned, int) override;
113 void didReceiveBuffer(ResourceHandle*, Ref<SharedBuffer>&&, int encodedLength) override;
114 void didFinishLoading(ResourceHandle*) override;
115 void didFail(ResourceHandle*, const ResourceError&) override;
116 void wasBlocked(ResourceHandle*) override;
117 void cannotShowURL(ResourceHandle*) override;
119 RefPtr<Thread> m_thread;
120 Lock m_initializeRunLoopConditionMutex;
121 Condition m_initializeRunLoopCondition;
122 RunLoop* m_runLoop { nullptr };
123 Lock m_terminateRunLoopConditionMutex;
124 Condition m_terminateRunLoopCondition;
125 RefPtr<ResourceHandle> m_resource;
127 std::unique_ptr<SoupNetworkSession> m_session;
131 enum MainThreadSourceNotification {
139 #define WEBKIT_WEB_SRC_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE((obj), WEBKIT_TYPE_WEB_SRC, WebKitWebSrcPrivate))
140 struct _WebKitWebSrcPrivate {
144 CString redirectedURI;
146 GUniquePtr<GstStructure> extraHeaders;
148 GUniquePtr<gchar> httpMethod;
150 WebCore::MediaPlayer* player;
152 RefPtr<PlatformMediaResourceLoader> loader;
153 RefPtr<PlatformMediaResource> resource;
154 RefPtr<ResourceHandleStreamingClient> client;
156 bool didPassAccessControlCheck;
164 guint64 requestedOffset;
166 bool createdInMainThread;
167 RefPtr<MainThreadNotifier<MainThreadSourceNotification>> notifier;
168 GRefPtr<GstBuffer> buffer;
174 PROP_RESOLVED_LOCATION,
181 static GstStaticPadTemplate srcTemplate = GST_STATIC_PAD_TEMPLATE("src",
184 GST_STATIC_CAPS_ANY);
186 GST_DEBUG_CATEGORY_STATIC(webkit_web_src_debug);
187 #define GST_CAT_DEFAULT webkit_web_src_debug
189 static void webKitWebSrcUriHandlerInit(gpointer gIface, gpointer ifaceData);
191 static void webKitWebSrcDispose(GObject*);
192 static void webKitWebSrcFinalize(GObject*);
193 static void webKitWebSrcSetProperty(GObject*, guint propertyID, const GValue*, GParamSpec*);
194 static void webKitWebSrcGetProperty(GObject*, guint propertyID, GValue*, GParamSpec*);
195 static GstStateChangeReturn webKitWebSrcChangeState(GstElement*, GstStateChange);
197 static gboolean webKitWebSrcQueryWithParent(GstPad*, GstObject*, GstQuery*);
199 static void webKitWebSrcNeedData(WebKitWebSrc*);
200 static void webKitWebSrcEnoughData(WebKitWebSrc*);
201 static gboolean webKitWebSrcSeek(WebKitWebSrc*, guint64);
203 static GstAppSrcCallbacks appsrcCallbacks = {
205 [](GstAppSrc*, guint, gpointer userData) {
206 webKitWebSrcNeedData(WEBKIT_WEB_SRC(userData));
209 [](GstAppSrc*, gpointer userData) {
210 webKitWebSrcEnoughData(WEBKIT_WEB_SRC(userData));
213 [](GstAppSrc*, guint64 offset, gpointer userData) -> gboolean {
214 return webKitWebSrcSeek(WEBKIT_WEB_SRC(userData), offset);
219 #define webkit_web_src_parent_class parent_class
220 // We split this out into another macro to avoid a check-webkit-style error.
221 #define WEBKIT_WEB_SRC_CATEGORY_INIT GST_DEBUG_CATEGORY_INIT(webkit_web_src_debug, "webkitwebsrc", 0, "websrc element");
222 G_DEFINE_TYPE_WITH_CODE(WebKitWebSrc, webkit_web_src, GST_TYPE_BIN,
223 G_IMPLEMENT_INTERFACE(GST_TYPE_URI_HANDLER, webKitWebSrcUriHandlerInit);
224 WEBKIT_WEB_SRC_CATEGORY_INIT);
226 static void webkit_web_src_class_init(WebKitWebSrcClass* klass)
228 GObjectClass* oklass = G_OBJECT_CLASS(klass);
229 GstElementClass* eklass = GST_ELEMENT_CLASS(klass);
231 oklass->dispose = webKitWebSrcDispose;
232 oklass->finalize = webKitWebSrcFinalize;
233 oklass->set_property = webKitWebSrcSetProperty;
234 oklass->get_property = webKitWebSrcGetProperty;
236 gst_element_class_add_pad_template(eklass,
237 gst_static_pad_template_get(&srcTemplate));
238 gst_element_class_set_metadata(eklass, "WebKit Web source element", "Source", "Handles HTTP/HTTPS uris",
239 "Sebastian Dröge <sebastian.droege@collabora.co.uk>");
241 /* Allows setting the uri using the 'location' property, which is used
242 * for example by gst_element_make_from_uri() */
243 g_object_class_install_property(oklass, PROP_LOCATION,
244 g_param_spec_string("location", "location", "Location to read from",
245 nullptr, static_cast<GParamFlags>(G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
247 g_object_class_install_property(oklass, PROP_RESOLVED_LOCATION,
248 g_param_spec_string("resolved-location", "Resolved location", "The location resolved by the server",
249 nullptr, static_cast<GParamFlags>(G_PARAM_READABLE | G_PARAM_STATIC_STRINGS)));
251 g_object_class_install_property(oklass, PROP_KEEP_ALIVE,
252 g_param_spec_boolean("keep-alive", "keep-alive", "Use HTTP persistent connections",
253 FALSE, static_cast<GParamFlags>(G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
255 g_object_class_install_property(oklass, PROP_EXTRA_HEADERS,
256 g_param_spec_boxed("extra-headers", "Extra Headers", "Extra headers to append to the HTTP request",
257 GST_TYPE_STRUCTURE, static_cast<GParamFlags>(G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
259 g_object_class_install_property(oklass, PROP_COMPRESS,
260 g_param_spec_boolean("compress", "Compress", "Allow compressed content encodings",
261 FALSE, static_cast<GParamFlags>(G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
263 g_object_class_install_property(oklass, PROP_METHOD,
264 g_param_spec_string("method", "method", "The HTTP method to use (default: GET)",
265 nullptr, static_cast<GParamFlags>(G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
267 eklass->change_state = webKitWebSrcChangeState;
269 g_type_class_add_private(klass, sizeof(WebKitWebSrcPrivate));
272 static void webkit_web_src_init(WebKitWebSrc* src)
274 WebKitWebSrcPrivate* priv = WEBKIT_WEB_SRC_GET_PRIVATE(src);
277 new (priv) WebKitWebSrcPrivate();
279 priv->createdInMainThread = isMainThread();
280 priv->notifier = MainThreadNotifier<MainThreadSourceNotification>::create();
282 priv->appsrc = GST_APP_SRC(gst_element_factory_make("appsrc", nullptr));
284 GST_ERROR_OBJECT(src, "Failed to create appsrc");
288 gst_bin_add(GST_BIN(src), GST_ELEMENT(priv->appsrc));
291 GRefPtr<GstPad> targetPad = adoptGRef(gst_element_get_static_pad(GST_ELEMENT(priv->appsrc), "src"));
292 priv->srcpad = webkitGstGhostPadFromStaticTemplate(&srcTemplate, "src", targetPad.get());
294 gst_element_add_pad(GST_ELEMENT(src), priv->srcpad);
296 GST_OBJECT_FLAG_SET(priv->srcpad, GST_PAD_FLAG_NEED_PARENT);
297 gst_pad_set_query_function(priv->srcpad, webKitWebSrcQueryWithParent);
299 gst_app_src_set_callbacks(priv->appsrc, &appsrcCallbacks, src, nullptr);
300 gst_app_src_set_emit_signals(priv->appsrc, FALSE);
301 gst_app_src_set_stream_type(priv->appsrc, GST_APP_STREAM_TYPE_SEEKABLE);
303 // 512k is a abitrary number but we should choose a value
304 // here to not pause/unpause the SoupMessage too often and
305 // to make sure there's always some data available for
306 // GStreamer to handle.
307 gst_app_src_set_max_bytes(priv->appsrc, 512 * 1024);
309 // Emit the need-data signal if the queue contains less
310 // than 20% of data. Without this the need-data signal
311 // is emitted when the queue is empty, we then dispatch
312 // the soup message unpausing to the main loop and from
313 // there unpause the soup message. This already takes
314 // quite some time and libsoup even needs some more time
315 // to actually provide data again. If we do all this
316 // already if the queue is 20% empty, it's much more
317 // likely that libsoup already provides new data before
318 // the queue is really empty.
319 // This might need tweaking for ports not using libsoup.
320 g_object_set(priv->appsrc, "min-percent", 20, nullptr);
322 gst_base_src_set_automatic_eos(GST_BASE_SRC(priv->appsrc), FALSE);
324 gst_app_src_set_caps(priv->appsrc, nullptr);
325 gst_app_src_set_size(priv->appsrc, -1);
328 static void webKitWebSrcDispose(GObject* object)
330 WebKitWebSrcPrivate* priv = WEBKIT_WEB_SRC(object)->priv;
331 if (priv->notifier) {
332 priv->notifier->invalidate();
333 priv->notifier = nullptr;
336 priv->player = nullptr;
338 GST_CALL_PARENT(G_OBJECT_CLASS, dispose, (object));
341 static void webKitWebSrcFinalize(GObject* object)
343 WebKitWebSrcPrivate* priv = WEBKIT_WEB_SRC(object)->priv;
345 priv->~WebKitWebSrcPrivate();
347 GST_CALL_PARENT(G_OBJECT_CLASS, finalize, (object));
350 static void webKitWebSrcSetProperty(GObject* object, guint propID, const GValue* value, GParamSpec* pspec)
352 WebKitWebSrc* src = WEBKIT_WEB_SRC(object);
356 gst_uri_handler_set_uri(reinterpret_cast<GstURIHandler*>(src), g_value_get_string(value), nullptr);
358 case PROP_KEEP_ALIVE:
359 src->priv->keepAlive = g_value_get_boolean(value);
361 case PROP_EXTRA_HEADERS: {
362 const GstStructure* s = gst_value_get_structure(value);
363 src->priv->extraHeaders.reset(s ? gst_structure_copy(s) : nullptr);
367 src->priv->compress = g_value_get_boolean(value);
370 src->priv->httpMethod.reset(g_value_dup_string(value));
373 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, propID, pspec);
378 static void webKitWebSrcGetProperty(GObject* object, guint propID, GValue* value, GParamSpec* pspec)
380 WebKitWebSrc* src = WEBKIT_WEB_SRC(object);
381 WebKitWebSrcPrivate* priv = src->priv;
383 WTF::GMutexLocker<GMutex> locker(*GST_OBJECT_GET_LOCK(src));
386 g_value_set_string(value, priv->originalURI.data());
388 case PROP_RESOLVED_LOCATION:
389 g_value_set_string(value, priv->redirectedURI.isNull() ? priv->originalURI.data() : priv->redirectedURI.data());
391 case PROP_KEEP_ALIVE:
392 g_value_set_boolean(value, priv->keepAlive);
394 case PROP_EXTRA_HEADERS:
395 gst_value_set_structure(value, priv->extraHeaders.get());
398 g_value_set_boolean(value, priv->compress);
401 g_value_set_string(value, priv->httpMethod.get());
404 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, propID, pspec);
409 static void webKitWebSrcStop(WebKitWebSrc* src)
411 WebKitWebSrcPrivate* priv = src->priv;
413 if (priv->resource || (priv->loader && !priv->keepAlive)) {
414 GRefPtr<WebKitWebSrc> protector = WTF::ensureGRef(src);
415 priv->notifier->cancelPendingNotifications(MainThreadSourceNotification::NeedData | MainThreadSourceNotification::EnoughData | MainThreadSourceNotification::Seek);
416 priv->notifier->notify(MainThreadSourceNotification::Stop, [protector, keepAlive = priv->keepAlive] {
417 WebKitWebSrcPrivate* priv = protector->priv;
419 WTF::GMutexLocker<GMutex> locker(*GST_OBJECT_GET_LOCK(protector.get()));
420 if (priv->resource) {
421 priv->resource->stop();
422 priv->resource->setClient(nullptr);
423 priv->resource = nullptr;
427 priv->loader = nullptr;
432 priv->client->invalidate();
433 priv->client = nullptr;
436 WTF::GMutexLocker<GMutex> locker(*GST_OBJECT_GET_LOCK(src));
438 bool wasSeeking = std::exchange(priv->isSeeking, false);
441 unmapGstBuffer(priv->buffer.get());
442 priv->buffer.clear();
445 priv->paused = false;
448 priv->seekable = FALSE;
452 priv->requestedOffset = 0;
453 priv->player = nullptr;
459 gst_app_src_set_caps(priv->appsrc, nullptr);
461 gst_app_src_set_size(priv->appsrc, -1);
464 GST_DEBUG_OBJECT(src, "Stopped request");
467 static bool webKitWebSrcSetExtraHeader(GQuark fieldId, const GValue* value, gpointer userData)
469 GUniquePtr<gchar> fieldContent;
471 if (G_VALUE_HOLDS_STRING(value))
472 fieldContent.reset(g_value_dup_string(value));
474 GValue dest = G_VALUE_INIT;
476 g_value_init(&dest, G_TYPE_STRING);
477 if (g_value_transform(value, &dest))
478 fieldContent.reset(g_value_dup_string(&dest));
481 const gchar* fieldName = g_quark_to_string(fieldId);
482 if (!fieldContent.get()) {
483 GST_ERROR("extra-headers field '%s' contains no value or can't be converted to a string", fieldName);
487 GST_DEBUG("Appending extra header: \"%s: %s\"", fieldName, fieldContent.get());
488 ResourceRequest* request = static_cast<ResourceRequest*>(userData);
489 request->setHTTPHeaderField(fieldName, fieldContent.get());
493 static gboolean webKitWebSrcProcessExtraHeaders(GQuark fieldId, const GValue* value, gpointer userData)
495 if (G_VALUE_TYPE(value) == GST_TYPE_ARRAY) {
496 unsigned size = gst_value_array_get_size(value);
498 for (unsigned i = 0; i < size; i++) {
499 if (!webKitWebSrcSetExtraHeader(fieldId, gst_value_array_get_value(value, i), userData))
505 if (G_VALUE_TYPE(value) == GST_TYPE_LIST) {
506 unsigned size = gst_value_list_get_size(value);
508 for (unsigned i = 0; i < size; i++) {
509 if (!webKitWebSrcSetExtraHeader(fieldId, gst_value_list_get_value(value, i), userData))
515 return webKitWebSrcSetExtraHeader(fieldId, value, userData);
518 static void webKitWebSrcStart(WebKitWebSrc* src)
520 WebKitWebSrcPrivate* priv = src->priv;
522 WTF::GMutexLocker<GMutex> locker(*GST_OBJECT_GET_LOCK(src));
524 priv->didPassAccessControlCheck = false;
526 if (priv->originalURI.isNull()) {
527 GST_ERROR_OBJECT(src, "No URI provided");
529 webKitWebSrcStop(src);
533 ASSERT(!priv->client);
535 GST_DEBUG_OBJECT(src, "Fetching %s", priv->originalURI.data());
536 URL url = URL(URL(), priv->originalURI.data());
538 ResourceRequest request(url);
539 request.setAllowCookies(true);
540 request.setFirstPartyForCookies(url);
545 request.setHTTPReferrer(priv->player->referrer());
547 if (priv->httpMethod.get())
548 request.setHTTPMethod(priv->httpMethod.get());
551 // By default, HTTP Accept-Encoding is disabled here as we don't
552 // want the received response to be encoded in any way as we need
553 // to rely on the proper size of the returned data on
554 // didReceiveResponse.
555 // If Accept-Encoding is used, the server may send the data in encoded format and
556 // request.expectedContentLength() will have the "wrong" size (the size of the
557 // compressed data), even though the data received in didReceiveData is uncompressed.
558 // This is however useful to enable for adaptive streaming
559 // scenarios, when the demuxer needs to download playlists.
561 request.setAcceptEncoding(false);
564 // Let Apple web servers know we want to access their nice movie trailers.
565 if (!g_ascii_strcasecmp("movies.apple.com", url.host().utf8().data())
566 || !g_ascii_strcasecmp("trailers.apple.com", url.host().utf8().data()))
567 request.setHTTPUserAgent("Quicktime/7.6.6");
569 if (priv->requestedOffset) {
570 GUniquePtr<gchar> val(g_strdup_printf("bytes=%" G_GUINT64_FORMAT "-", priv->requestedOffset));
571 request.setHTTPHeaderField(HTTPHeaderName::Range, val.get());
573 priv->offset = priv->requestedOffset;
575 if (!priv->keepAlive) {
576 GST_DEBUG_OBJECT(src, "Persistent connection support disabled");
577 request.setHTTPHeaderField(HTTPHeaderName::Connection, "close");
580 if (priv->extraHeaders)
581 gst_structure_foreach(priv->extraHeaders.get(), webKitWebSrcProcessExtraHeaders, &request);
583 // We always request Icecast/Shoutcast metadata, just in case ...
584 request.setHTTPHeaderField(HTTPHeaderName::IcyMetadata, "1");
586 if (!priv->player || !priv->createdInMainThread) {
587 priv->client = ResourceHandleStreamingClient::create(src, WTFMove(request));
588 if (priv->client->loadFailed()) {
589 GST_ERROR_OBJECT(src, "Failed to setup streaming client");
591 webKitWebSrcStop(src);
593 GST_DEBUG_OBJECT(src, "Started request");
598 GRefPtr<WebKitWebSrc> protector = WTF::ensureGRef(src);
599 priv->notifier->notify(MainThreadSourceNotification::Start, [protector, request = WTFMove(request)] {
600 WebKitWebSrcPrivate* priv = protector->priv;
602 WTF::GMutexLocker<GMutex> locker(*GST_OBJECT_GET_LOCK(protector.get()));
604 priv->loader = priv->player->createResourceLoader();
606 PlatformMediaResourceLoader::LoadOptions loadOptions = 0;
607 if (request.url().protocolIsBlob())
608 loadOptions |= PlatformMediaResourceLoader::LoadOption::BufferData;
609 priv->resource = priv->loader->requestResource(ResourceRequest(request), loadOptions);
610 if (priv->resource) {
611 priv->resource->setClient(std::make_unique<CachedResourceStreamingClient>(protector.get(), ResourceRequest(request)));
612 GST_DEBUG_OBJECT(protector.get(), "Started request");
614 GST_ERROR_OBJECT(protector.get(), "Failed to setup streaming client");
615 priv->loader = nullptr;
617 webKitWebSrcStop(protector.get());
622 static GstStateChangeReturn webKitWebSrcChangeState(GstElement* element, GstStateChange transition)
624 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
625 WebKitWebSrc* src = WEBKIT_WEB_SRC(element);
626 WebKitWebSrcPrivate* priv = src->priv;
628 switch (transition) {
629 case GST_STATE_CHANGE_NULL_TO_READY:
631 gst_element_post_message(element,
632 gst_missing_element_message_new(element, "appsrc"));
633 GST_ELEMENT_ERROR(src, CORE, MISSING_PLUGIN, (nullptr), ("no appsrc"));
634 return GST_STATE_CHANGE_FAILURE;
641 ret = GST_ELEMENT_CLASS(parent_class)->change_state(element, transition);
642 if (G_UNLIKELY(ret == GST_STATE_CHANGE_FAILURE)) {
643 GST_DEBUG_OBJECT(src, "State change failed");
647 switch (transition) {
648 case GST_STATE_CHANGE_READY_TO_PAUSED:
650 GST_DEBUG_OBJECT(src, "READY->PAUSED");
651 webKitWebSrcStart(src);
654 case GST_STATE_CHANGE_PAUSED_TO_READY:
656 GST_DEBUG_OBJECT(src, "PAUSED->READY");
657 webKitWebSrcStop(src);
667 static gboolean webKitWebSrcQueryWithParent(GstPad* pad, GstObject* parent, GstQuery* query)
669 WebKitWebSrc* src = WEBKIT_WEB_SRC(GST_ELEMENT(parent));
670 gboolean result = FALSE;
672 switch (GST_QUERY_TYPE(query)) {
673 case GST_QUERY_DURATION: {
676 gst_query_parse_duration(query, &format, nullptr);
678 GST_DEBUG_OBJECT(src, "duration query in format %s", gst_format_get_name(format));
679 WTF::GMutexLocker<GMutex> locker(*GST_OBJECT_GET_LOCK(src));
680 if (format == GST_FORMAT_BYTES && src->priv->size > 0) {
681 gst_query_set_duration(query, format, src->priv->size);
686 case GST_QUERY_URI: {
687 WTF::GMutexLocker<GMutex> locker(*GST_OBJECT_GET_LOCK(src));
688 gst_query_set_uri(query, src->priv->originalURI.data());
689 if (!src->priv->redirectedURI.isNull())
690 gst_query_set_uri_redirection(query, src->priv->redirectedURI.data());
694 case GST_QUERY_SCHEDULING: {
695 GstSchedulingFlags flags;
696 int minSize, maxSize, align;
698 gst_query_parse_scheduling(query, &flags, &minSize, &maxSize, &align);
699 gst_query_set_scheduling(query, static_cast<GstSchedulingFlags>(flags | GST_SCHEDULING_FLAG_BANDWIDTH_LIMITED), minSize, maxSize, align);
704 GRefPtr<GstPad> target = adoptGRef(gst_ghost_pad_get_target(GST_GHOST_PAD_CAST(pad)));
706 // Forward the query to the proxy target pad.
708 result = gst_pad_query(target.get(), query);
716 static bool urlHasSupportedProtocol(const URL& url)
718 return url.isValid() && (url.protocolIsInHTTPFamily() || url.protocolIsBlob());
721 // uri handler interface
723 static GstURIType webKitWebSrcUriGetType(GType)
728 const gchar* const* webKitWebSrcGetProtocols(GType)
730 static const char* protocols[] = {"webkit+http", "webkit+https", "blob", nullptr };
734 static URL convertPlaybinURI(const char* uriString)
736 URL url(URL(), uriString);
737 ASSERT(url.protocol().substring(0, 7) == "webkit+");
738 url.setProtocol(url.protocol().substring(7).toString());
742 static gchar* webKitWebSrcGetUri(GstURIHandler* handler)
744 WebKitWebSrc* src = WEBKIT_WEB_SRC(handler);
747 WTF::GMutexLocker<GMutex> locker(*GST_OBJECT_GET_LOCK(src));
748 ret = g_strdup(src->priv->originalURI.data());
752 static gboolean webKitWebSrcSetUri(GstURIHandler* handler, const gchar* uri, GError** error)
754 WebKitWebSrc* src = WEBKIT_WEB_SRC(handler);
755 WebKitWebSrcPrivate* priv = src->priv;
757 if (GST_STATE(src) >= GST_STATE_PAUSED) {
758 GST_ERROR_OBJECT(src, "URI can only be set in states < PAUSED");
762 WTF::GMutexLocker<GMutex> locker(*GST_OBJECT_GET_LOCK(src));
764 priv->redirectedURI = CString();
765 priv->originalURI = CString();
769 URL url = convertPlaybinURI(uri);
770 if (!urlHasSupportedProtocol(url)) {
771 g_set_error(error, GST_URI_ERROR, GST_URI_ERROR_BAD_URI, "Invalid URI '%s'", uri);
775 priv->originalURI = url.string().utf8();
779 static void webKitWebSrcUriHandlerInit(gpointer gIface, gpointer)
781 GstURIHandlerInterface* iface = (GstURIHandlerInterface *) gIface;
783 iface->get_type = webKitWebSrcUriGetType;
784 iface->get_protocols = webKitWebSrcGetProtocols;
785 iface->get_uri = webKitWebSrcGetUri;
786 iface->set_uri = webKitWebSrcSetUri;
789 static void webKitWebSrcNeedData(WebKitWebSrc* src)
791 WebKitWebSrcPrivate* priv = src->priv;
793 GST_DEBUG_OBJECT(src, "Need more data");
796 WTF::GMutexLocker<GMutex> locker(*GST_OBJECT_GET_LOCK(src));
799 priv->paused = false;
801 priv->client->setDefersLoading(false);
806 GRefPtr<WebKitWebSrc> protector = WTF::ensureGRef(src);
807 priv->notifier->notify(MainThreadSourceNotification::NeedData, [protector] {
808 WebKitWebSrcPrivate* priv = protector->priv;
810 priv->resource->setDefersLoading(false);
814 static void webKitWebSrcEnoughData(WebKitWebSrc* src)
816 WebKitWebSrcPrivate* priv = src->priv;
818 GST_DEBUG_OBJECT(src, "Have enough data");
821 WTF::GMutexLocker<GMutex> locker(*GST_OBJECT_GET_LOCK(src));
826 priv->client->setDefersLoading(true);
831 GRefPtr<WebKitWebSrc> protector = WTF::ensureGRef(src);
832 priv->notifier->notify(MainThreadSourceNotification::EnoughData, [protector] {
833 WebKitWebSrcPrivate* priv = protector->priv;
835 priv->resource->setDefersLoading(true);
839 static gboolean webKitWebSrcSeek(WebKitWebSrc* src, guint64 offset)
841 WebKitWebSrcPrivate* priv = src->priv;
844 WTF::GMutexLocker<GMutex> locker(*GST_OBJECT_GET_LOCK(src));
845 if (offset == priv->offset && priv->requestedOffset == priv->offset)
851 priv->isSeeking = true;
852 priv->requestedOffset = offset;
855 GST_DEBUG_OBJECT(src, "Seeking to offset: %" G_GUINT64_FORMAT, src->priv->requestedOffset);
857 webKitWebSrcStop(src);
858 webKitWebSrcStart(src);
862 GRefPtr<WebKitWebSrc> protector = WTF::ensureGRef(src);
863 priv->notifier->notify(MainThreadSourceNotification::Seek, [protector] {
864 webKitWebSrcStop(protector.get());
865 webKitWebSrcStart(protector.get());
870 void webKitWebSrcSetMediaPlayer(WebKitWebSrc* src, WebCore::MediaPlayer* player)
873 ASSERT(src->priv->createdInMainThread);
874 WTF::GMutexLocker<GMutex> locker(*GST_OBJECT_GET_LOCK(src));
875 src->priv->player = player;
878 bool webKitSrcPassedCORSAccessCheck(WebKitWebSrc* src)
880 return src->priv->didPassAccessControlCheck;
883 StreamingClient::StreamingClient(WebKitWebSrc* src, ResourceRequest&& request)
884 : m_src(GST_ELEMENT(src))
885 , m_request(WTFMove(request))
889 StreamingClient::~StreamingClient()
893 char* StreamingClient::createReadBuffer(size_t requestedSize, size_t& actualSize)
895 WebKitWebSrc* src = WEBKIT_WEB_SRC(m_src.get());
896 WebKitWebSrcPrivate* priv = src->priv;
898 ASSERT(!priv->buffer);
900 GstBuffer* buffer = gst_buffer_new_and_alloc(requestedSize);
902 mapGstBuffer(buffer, GST_MAP_WRITE);
904 WTF::GMutexLocker<GMutex> locker(*GST_OBJECT_GET_LOCK(src));
905 priv->buffer = adoptGRef(buffer);
908 actualSize = gst_buffer_get_size(buffer);
909 return getGstBufferDataPointer(buffer);
912 void StreamingClient::handleResponseReceived(const ResourceResponse& response)
914 WebKitWebSrc* src = WEBKIT_WEB_SRC(m_src.get());
915 WebKitWebSrcPrivate* priv = src->priv;
917 GST_DEBUG_OBJECT(src, "Received response: %d", response.httpStatusCode());
919 auto responseURI = response.url().string().utf8();
920 if (priv->originalURI != responseURI)
921 priv->redirectedURI = WTFMove(responseURI);
923 if (response.httpStatusCode() >= 400) {
924 GST_ELEMENT_ERROR(src, RESOURCE, READ, ("Received %d HTTP error code", response.httpStatusCode()), (nullptr));
925 gst_app_src_end_of_stream(priv->appsrc);
926 webKitWebSrcStop(src);
930 WTF::GMutexLocker<GMutex> locker(*GST_OBJECT_GET_LOCK(src));
932 if (priv->isSeeking) {
933 GST_DEBUG_OBJECT(src, "Seek in progress, ignoring response");
937 if (priv->requestedOffset) {
938 // Seeking ... we expect a 206 == PARTIAL_CONTENT
939 if (response.httpStatusCode() == 200) {
940 // Range request didn't have a ranged response; resetting offset.
942 } else if (response.httpStatusCode() != 206) {
943 // Range request completely failed.
945 GST_ELEMENT_ERROR(src, RESOURCE, READ, ("Received unexpected %d HTTP status code", response.httpStatusCode()), (nullptr));
946 gst_app_src_end_of_stream(priv->appsrc);
947 webKitWebSrcStop(src);
952 long long length = response.expectedContentLength();
953 if (length > 0 && priv->requestedOffset && response.httpStatusCode() == 206)
954 length += priv->requestedOffset;
956 priv->size = length >= 0 ? length : 0;
957 priv->seekable = length > 0 && g_ascii_strcasecmp("none", response.httpHeaderField(HTTPHeaderName::AcceptRanges).utf8().data());
961 // notify size/duration
963 gst_app_src_set_size(priv->appsrc, length);
965 gst_app_src_set_size(priv->appsrc, -1);
967 // Signal to downstream if this is an Icecast stream.
968 GRefPtr<GstCaps> caps;
969 String metadataIntervalAsString = response.httpHeaderField(HTTPHeaderName::IcyMetaInt);
970 if (!metadataIntervalAsString.isEmpty()) {
971 bool isMetadataIntervalParsed;
972 int metadataInterval = metadataIntervalAsString.toInt(&isMetadataIntervalParsed);
973 if (isMetadataIntervalParsed && metadataInterval > 0)
974 caps = adoptGRef(gst_caps_new_simple("application/x-icy", "metadata-interval", G_TYPE_INT, metadataInterval, nullptr));
976 gst_app_src_set_caps(priv->appsrc, caps.get());
978 // Emit a GST_EVENT_CUSTOM_DOWNSTREAM_STICKY event to let GStreamer know about the HTTP headers sent and received.
979 GstStructure* httpHeaders = gst_structure_new_empty("http-headers");
980 gst_structure_set(httpHeaders, "uri", G_TYPE_STRING, priv->originalURI.data(), nullptr);
981 if (!priv->redirectedURI.isNull())
982 gst_structure_set(httpHeaders, "redirection-uri", G_TYPE_STRING, priv->redirectedURI.data(), nullptr);
983 GUniquePtr<GstStructure> headers(gst_structure_new_empty("request-headers"));
984 for (const auto& header : m_request.httpHeaderFields())
985 gst_structure_set(headers.get(), header.key.utf8().data(), G_TYPE_STRING, header.value.utf8().data(), nullptr);
986 gst_structure_set(httpHeaders, "request-headers", GST_TYPE_STRUCTURE, headers.get(), nullptr);
987 headers.reset(gst_structure_new_empty("response-headers"));
988 for (const auto& header : response.httpHeaderFields())
989 gst_structure_set(headers.get(), header.key.utf8().data(), G_TYPE_STRING, header.value.utf8().data(), nullptr);
990 gst_structure_set(httpHeaders, "response-headers", GST_TYPE_STRUCTURE, headers.get(), nullptr);
991 gst_pad_push_event(GST_BASE_SRC_PAD(priv->appsrc), gst_event_new_custom(GST_EVENT_CUSTOM_DOWNSTREAM_STICKY, httpHeaders));
994 void StreamingClient::handleDataReceived(const char* data, int length)
996 WebKitWebSrc* src = WEBKIT_WEB_SRC(m_src.get());
997 WebKitWebSrcPrivate* priv = src->priv;
999 WTF::GMutexLocker<GMutex> locker(*GST_OBJECT_GET_LOCK(src));
1001 GST_LOG_OBJECT(src, "Have %lld bytes of data", priv->buffer ? static_cast<long long>(gst_buffer_get_size(priv->buffer.get())) : length);
1003 ASSERT(!priv->buffer || data == getGstBufferDataPointer(priv->buffer.get()));
1006 unmapGstBuffer(priv->buffer.get());
1008 if (priv->isSeeking) {
1009 GST_DEBUG_OBJECT(src, "Seek in progress, ignoring data");
1010 priv->buffer.clear();
1014 if (priv->offset < priv->requestedOffset) {
1015 // Range request failed; seeking manually.
1016 if (priv->offset + length <= priv->requestedOffset) {
1017 // Discard all the buffers coming before the requested seek position.
1018 priv->offset += length;
1019 priv->buffer.clear();
1023 if (priv->offset + length > priv->requestedOffset) {
1024 guint64 offset = priv->requestedOffset - priv->offset;
1028 gst_buffer_resize(priv->buffer.get(), offset, -1);
1029 priv->offset = priv->requestedOffset;
1032 priv->requestedOffset = 0;
1035 // Ports using the GStreamer backend but not the soup implementation of ResourceHandle
1036 // won't be using buffers provided by this client, the buffer is created here in that case.
1038 priv->buffer = adoptGRef(createGstBufferForData(data, length));
1040 gst_buffer_set_size(priv->buffer.get(), static_cast<gssize>(length));
1042 GST_BUFFER_OFFSET(priv->buffer.get()) = priv->offset;
1043 if (priv->requestedOffset == priv->offset)
1044 priv->requestedOffset += length;
1045 priv->offset += length;
1046 // priv->size == 0 if received length on didReceiveResponse < 0.
1047 if (priv->size > 0 && priv->offset > priv->size) {
1048 GST_DEBUG_OBJECT(src, "Updating internal size from %" G_GUINT64_FORMAT " to %" G_GUINT64_FORMAT, priv->size, priv->offset);
1049 gst_app_src_set_size(priv->appsrc, priv->offset);
1050 priv->size = priv->offset;
1052 GST_BUFFER_OFFSET_END(priv->buffer.get()) = priv->offset;
1056 GstFlowReturn ret = gst_app_src_push_buffer(priv->appsrc, priv->buffer.leakRef());
1057 if (ret != GST_FLOW_OK && ret != GST_FLOW_EOS)
1058 GST_ELEMENT_ERROR(src, CORE, FAILED, (nullptr), (nullptr));
1061 void StreamingClient::handleNotifyFinished()
1063 WebKitWebSrc* src = WEBKIT_WEB_SRC(m_src.get());
1064 WebKitWebSrcPrivate* priv = src->priv;
1066 GST_DEBUG_OBJECT(src, "Have EOS");
1068 WTF::GMutexLocker<GMutex> locker(*GST_OBJECT_GET_LOCK(src));
1069 if (!priv->isSeeking) {
1071 gst_app_src_end_of_stream(priv->appsrc);
1075 CachedResourceStreamingClient::CachedResourceStreamingClient(WebKitWebSrc* src, ResourceRequest&& request)
1076 : StreamingClient(src, WTFMove(request))
1080 CachedResourceStreamingClient::~CachedResourceStreamingClient()
1085 char* CachedResourceStreamingClient::getOrCreateReadBuffer(PlatformMediaResource&, size_t requestedSize, size_t& actualSize)
1087 return createReadBuffer(requestedSize, actualSize);
1091 void CachedResourceStreamingClient::responseReceived(PlatformMediaResource&, const ResourceResponse& response)
1093 WebKitWebSrcPrivate* priv = WEBKIT_WEB_SRC(m_src.get())->priv;
1094 priv->didPassAccessControlCheck = priv->resource->didPassAccessControlCheck();
1095 handleResponseReceived(response);
1098 void CachedResourceStreamingClient::dataReceived(PlatformMediaResource&, const char* data, int length)
1100 handleDataReceived(data, length);
1103 void CachedResourceStreamingClient::accessControlCheckFailed(PlatformMediaResource&, const ResourceError& error)
1105 WebKitWebSrc* src = WEBKIT_WEB_SRC(m_src.get());
1106 GST_ELEMENT_ERROR(src, RESOURCE, READ, ("%s", error.localizedDescription().utf8().data()), (nullptr));
1107 gst_app_src_end_of_stream(src->priv->appsrc);
1108 webKitWebSrcStop(src);
1111 void CachedResourceStreamingClient::loadFailed(PlatformMediaResource&, const ResourceError& error)
1113 WebKitWebSrc* src = WEBKIT_WEB_SRC(m_src.get());
1115 if (!error.isCancellation()) {
1116 GST_ERROR_OBJECT(src, "Have failure: %s", error.localizedDescription().utf8().data());
1117 GST_ELEMENT_ERROR(src, RESOURCE, FAILED, ("%s", error.localizedDescription().utf8().data()), (nullptr));
1120 gst_app_src_end_of_stream(src->priv->appsrc);
1123 void CachedResourceStreamingClient::loadFinished(PlatformMediaResource&)
1125 handleNotifyFinished();
1128 ResourceHandleStreamingClient::ResourceHandleStreamingClient(WebKitWebSrc* src, ResourceRequest&& request)
1129 : StreamingClient(src, WTFMove(request))
1131 LockHolder locker(m_initializeRunLoopConditionMutex);
1132 m_thread = Thread::create("ResourceHandleStreamingClient", [this] {
1134 LockHolder locker(m_initializeRunLoopConditionMutex);
1135 m_runLoop = &RunLoop::current();
1137 m_session = std::make_unique<SoupNetworkSession>();
1138 m_resource = ResourceHandle::create(*m_session, m_request, this, true, false);
1140 // FIXME: This create will hit an assert in debug builds. See https://bugs.webkit.org/show_bug.cgi?id=167003.
1141 m_resource = ResourceHandle::create(nullptr, m_request, this, true, false);
1143 m_initializeRunLoopCondition.notifyOne();
1148 m_runLoop->dispatch([this] { m_resource->setDefersLoading(false); });
1151 m_initializeRunLoopCondition.wait(m_initializeRunLoopConditionMutex);
1154 ResourceHandleStreamingClient::~ResourceHandleStreamingClient()
1162 void ResourceHandleStreamingClient::cleanupAndStopRunLoop()
1164 m_resource->clearClient();
1165 m_resource->cancel();
1166 m_resource = nullptr;
1168 m_session = nullptr;
1173 void ResourceHandleStreamingClient::invalidate()
1175 if (m_runLoop == &RunLoop::current()) {
1176 cleanupAndStopRunLoop();
1180 LockHolder locker(m_terminateRunLoopConditionMutex);
1181 m_runLoop->dispatch([this, protectedThis = makeRef(*this)] {
1182 cleanupAndStopRunLoop();
1183 LockHolder locker(m_terminateRunLoopConditionMutex);
1184 m_terminateRunLoopCondition.notifyOne();
1186 m_terminateRunLoopCondition.wait(m_terminateRunLoopConditionMutex);
1189 bool ResourceHandleStreamingClient::loadFailed() const
1194 void ResourceHandleStreamingClient::setDefersLoading(bool defers)
1196 m_runLoop->dispatch([this, protectedThis = makeRef(*this), defers] {
1198 m_resource->setDefersLoading(defers);
1203 char* ResourceHandleStreamingClient::getOrCreateReadBuffer(size_t requestedSize, size_t& actualSize)
1205 return createReadBuffer(requestedSize, actualSize);
1209 ResourceRequest ResourceHandleStreamingClient::willSendRequest(ResourceHandle*, ResourceRequest&& request, ResourceResponse&&)
1211 return WTFMove(request);
1214 void ResourceHandleStreamingClient::didReceiveResponse(ResourceHandle*, ResourceResponse&& response)
1217 handleResponseReceived(response);
1220 void ResourceHandleStreamingClient::didReceiveData(ResourceHandle*, const char* /* data */, unsigned /* length */, int)
1222 ASSERT_NOT_REACHED();
1225 void ResourceHandleStreamingClient::didReceiveBuffer(ResourceHandle*, Ref<SharedBuffer>&& buffer, int /* encodedLength */)
1230 for (const auto& element : buffer.get())
1231 handleDataReceived(element.segment->data(), element.segment->size());
1234 void ResourceHandleStreamingClient::didFinishLoading(ResourceHandle*)
1237 handleNotifyFinished();
1240 void ResourceHandleStreamingClient::didFail(ResourceHandle*, const ResourceError& error)
1242 WebKitWebSrc* src = WEBKIT_WEB_SRC(m_src.get());
1244 GST_ERROR_OBJECT(src, "Have failure: %s", error.localizedDescription().utf8().data());
1245 GST_ELEMENT_ERROR(src, RESOURCE, FAILED, ("%s", error.localizedDescription().utf8().data()), (nullptr));
1246 gst_app_src_end_of_stream(src->priv->appsrc);
1249 void ResourceHandleStreamingClient::wasBlocked(ResourceHandle*)
1251 WebKitWebSrc* src = WEBKIT_WEB_SRC(m_src.get());
1252 GUniquePtr<gchar> uri;
1254 GST_ERROR_OBJECT(src, "Request was blocked");
1256 WTF::GMutexLocker<GMutex> locker(*GST_OBJECT_GET_LOCK(src));
1257 uri.reset(g_strdup(src->priv->originalURI.data()));
1260 GST_ELEMENT_ERROR(src, RESOURCE, OPEN_READ, ("Access to \"%s\" was blocked", uri.get()), (nullptr));
1263 void ResourceHandleStreamingClient::cannotShowURL(ResourceHandle*)
1265 WebKitWebSrc* src = WEBKIT_WEB_SRC(m_src.get());
1266 GUniquePtr<gchar> uri;
1268 GST_ERROR_OBJECT(src, "Cannot show URL");
1270 WTF::GMutexLocker<GMutex> locker(*GST_OBJECT_GET_LOCK(src));
1271 uri.reset(g_strdup(src->priv->originalURI.data()));
1274 GST_ELEMENT_ERROR(src, RESOURCE, OPEN_READ, ("Can't show \"%s\"", uri.get()), (nullptr));
1277 #endif // USE(GSTREAMER)