2 * Copyright (C) 2007-2008 Wouter Cloetens <wouter@mind.be>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
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 * Library General Public License for more
16 * SECTION:element-souphttpsrc
18 * This plugin reads data from a remote location specified by a URI.
19 * Supported protocols are 'http', 'https'.
21 * An HTTP proxy must be specified by its URL.
22 * If the "http_proxy" environment variable is set, its value is used.
23 * If built with libsoup's GNOME integration features, the GNOME proxy
24 * configuration will be used, or failing that, proxy autodetection.
25 * The #GstSoupHTTPSrc:proxy property can be used to override the default.
27 * In case the #GstSoupHTTPSrc:iradio-mode property is set and the location is
28 * an HTTP resource, souphttpsrc will send special Icecast HTTP headers to the
29 * server to request additional Icecast meta-information.
30 * If the server is not an Icecast server, it will behave as if the
31 * #GstSoupHTTPSrc:iradio-mode property were not set. If it is, souphttpsrc will
32 * output data with a media type of application/x-icy, in which case you will
33 * need to use the #ICYDemux element as follow-up element to extract the Icecast
34 * metadata and to determine the underlying media type.
37 * <title>Example launch line</title>
39 * gst-launch-1.0 -v souphttpsrc location=https://some.server.org/index.html
40 * ! filesink location=/home/joe/server.html
41 * ]| The above pipeline reads a web page from a server using the HTTPS protocol
42 * and writes it to a local file.
44 * gst-launch-1.0 -v souphttpsrc user-agent="FooPlayer 0.99 beta"
45 * automatic-redirect=false proxy=http://proxy.intranet.local:8080
46 * location=http://music.foobar.com/demo.mp3 ! mad ! audioconvert
47 * ! audioresample ! alsasink
48 * ]| The above pipeline will read and decode and play an mp3 file from a
49 * web server using the HTTP protocol. If the server sends redirects,
50 * the request fails instead of following the redirect. The specified
51 * HTTP proxy server is used. The User-Agent HTTP request header
52 * is set to a custom string instead of "GStreamer souphttpsrc."
54 * gst-launch-1.0 -v souphttpsrc location=http://10.11.12.13/mjpeg
55 * do-timestamp=true ! multipartdemux
56 * ! image/jpeg,width=640,height=480 ! matroskamux
57 * ! filesink location=mjpeg.mkv
58 * ]| The above pipeline reads a motion JPEG stream from an IP camera
59 * using the HTTP protocol, encoded as mime/multipart image/jpeg
60 * parts, and writes a Matroska motion JPEG file. The width and
61 * height properties are set in the caps to provide the Matroska
62 * multiplexer with the information to set this in the header.
63 * Timestamps are set on the buffers as they arrive from the camera.
64 * These are used by the mime/multipart demultiplexer to emit timestamps
65 * on the JPEG-encoded video frame buffers. This allows the Matroska
66 * multiplexer to timestamp the frames in the resulting file.
76 #include <stdlib.h> /* atoi() */
78 #include <gst/gstelement.h>
79 #include <gst/gst-i18n-plugin.h>
81 #include <libsoup/soup.h>
82 #include "gstsouphttpsrc.h"
83 #include "gstsouputils.h"
85 #include <gst/tag/tag.h>
87 GST_DEBUG_CATEGORY_STATIC (souphttpsrc_debug);
88 #define GST_CAT_DEFAULT souphttpsrc_debug
90 static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
101 PROP_AUTOMATIC_REDIRECT,
116 PROP_SSL_USE_SYSTEM_CA_FILE,
120 PROP_TLS_INTERACTION,
123 #define DEFAULT_USER_AGENT "GStreamer souphttpsrc "
124 #define DEFAULT_IRADIO_MODE TRUE
125 #define DEFAULT_SOUP_LOG_LEVEL SOUP_LOGGER_LOG_HEADERS
126 #define DEFAULT_COMPRESS FALSE
127 #define DEFAULT_KEEP_ALIVE FALSE
128 #define DEFAULT_SSL_STRICT TRUE
129 #define DEFAULT_SSL_CA_FILE NULL
130 #define DEFAULT_SSL_USE_SYSTEM_CA_FILE TRUE
131 #define DEFAULT_TLS_DATABASE NULL
132 #define DEFAULT_TLS_INTERACTION NULL
133 #define DEFAULT_TIMEOUT 15
134 #define DEFAULT_RETRIES 3
135 #define DEFAULT_SOUP_METHOD NULL
137 static void gst_soup_http_src_uri_handler_init (gpointer g_iface,
138 gpointer iface_data);
139 static void gst_soup_http_src_finalize (GObject * gobject);
140 static void gst_soup_http_src_dispose (GObject * gobject);
142 static void gst_soup_http_src_set_property (GObject * object, guint prop_id,
143 const GValue * value, GParamSpec * pspec);
144 static void gst_soup_http_src_get_property (GObject * object, guint prop_id,
145 GValue * value, GParamSpec * pspec);
147 static GstStateChangeReturn gst_soup_http_src_change_state (GstElement *
148 element, GstStateChange transition);
149 static GstFlowReturn gst_soup_http_src_create (GstPushSrc * psrc,
150 GstBuffer ** outbuf);
151 static gboolean gst_soup_http_src_start (GstBaseSrc * bsrc);
152 static gboolean gst_soup_http_src_stop (GstBaseSrc * bsrc);
153 static gboolean gst_soup_http_src_get_size (GstBaseSrc * bsrc, guint64 * size);
154 static gboolean gst_soup_http_src_is_seekable (GstBaseSrc * bsrc);
155 static gboolean gst_soup_http_src_do_seek (GstBaseSrc * bsrc,
156 GstSegment * segment);
157 static gboolean gst_soup_http_src_query (GstBaseSrc * bsrc, GstQuery * query);
158 static gboolean gst_soup_http_src_unlock (GstBaseSrc * bsrc);
159 static gboolean gst_soup_http_src_unlock_stop (GstBaseSrc * bsrc);
160 static gboolean gst_soup_http_src_set_location (GstSoupHTTPSrc * src,
161 const gchar * uri, GError ** error);
162 static gboolean gst_soup_http_src_set_proxy (GstSoupHTTPSrc * src,
164 static char *gst_soup_http_src_unicodify (const char *str);
165 static gboolean gst_soup_http_src_build_message (GstSoupHTTPSrc * src,
166 const gchar * method);
167 static void gst_soup_http_src_cancel_message (GstSoupHTTPSrc * src);
168 static gboolean gst_soup_http_src_add_range_header (GstSoupHTTPSrc * src,
169 guint64 offset, guint64 stop_offset);
170 static gboolean gst_soup_http_src_session_open (GstSoupHTTPSrc * src);
171 static void gst_soup_http_src_session_close (GstSoupHTTPSrc * src);
172 static void gst_soup_http_src_parse_status (SoupMessage * msg,
173 GstSoupHTTPSrc * src);
174 static void gst_soup_http_src_got_headers (GstSoupHTTPSrc * src,
176 static void gst_soup_http_src_authenticate_cb (SoupSession * session,
177 SoupMessage * msg, SoupAuth * auth, gboolean retrying,
178 GstSoupHTTPSrc * src);
179 static void gst_soup_http_src_destroy_input_stream (GstSoupHTTPSrc * src);
181 #define gst_soup_http_src_parent_class parent_class
182 G_DEFINE_TYPE_WITH_CODE (GstSoupHTTPSrc, gst_soup_http_src, GST_TYPE_PUSH_SRC,
183 G_IMPLEMENT_INTERFACE (GST_TYPE_URI_HANDLER,
184 gst_soup_http_src_uri_handler_init));
187 gst_soup_http_src_class_init (GstSoupHTTPSrcClass * klass)
189 GObjectClass *gobject_class;
190 GstElementClass *gstelement_class;
191 GstBaseSrcClass *gstbasesrc_class;
192 GstPushSrcClass *gstpushsrc_class;
194 gobject_class = (GObjectClass *) klass;
195 gstelement_class = (GstElementClass *) klass;
196 gstbasesrc_class = (GstBaseSrcClass *) klass;
197 gstpushsrc_class = (GstPushSrcClass *) klass;
199 gobject_class->set_property = gst_soup_http_src_set_property;
200 gobject_class->get_property = gst_soup_http_src_get_property;
201 gobject_class->finalize = gst_soup_http_src_finalize;
202 gobject_class->dispose = gst_soup_http_src_dispose;
204 g_object_class_install_property (gobject_class,
206 g_param_spec_string ("location", "Location",
207 "Location to read from", "",
208 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
209 g_object_class_install_property (gobject_class,
211 g_param_spec_string ("user-agent", "User-Agent",
212 "Value of the User-Agent HTTP request header field",
213 DEFAULT_USER_AGENT, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
214 g_object_class_install_property (gobject_class,
215 PROP_AUTOMATIC_REDIRECT,
216 g_param_spec_boolean ("automatic-redirect", "automatic-redirect",
217 "Automatically follow HTTP redirects (HTTP Status Code 3xx)",
218 TRUE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
219 g_object_class_install_property (gobject_class,
221 g_param_spec_string ("proxy", "Proxy",
222 "HTTP proxy server URI", "",
223 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
224 g_object_class_install_property (gobject_class,
226 g_param_spec_string ("user-id", "user-id",
227 "HTTP location URI user id for authentication", "",
228 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
229 g_object_class_install_property (gobject_class, PROP_USER_PW,
230 g_param_spec_string ("user-pw", "user-pw",
231 "HTTP location URI user password for authentication", "",
232 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
233 g_object_class_install_property (gobject_class, PROP_PROXY_ID,
234 g_param_spec_string ("proxy-id", "proxy-id",
235 "HTTP proxy URI user id for authentication", "",
236 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
237 g_object_class_install_property (gobject_class, PROP_PROXY_PW,
238 g_param_spec_string ("proxy-pw", "proxy-pw",
239 "HTTP proxy URI user password for authentication", "",
240 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
241 g_object_class_install_property (gobject_class, PROP_COOKIES,
242 g_param_spec_boxed ("cookies", "Cookies", "HTTP request cookies",
243 G_TYPE_STRV, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
244 g_object_class_install_property (gobject_class, PROP_IS_LIVE,
245 g_param_spec_boolean ("is-live", "is-live", "Act like a live source",
246 FALSE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
247 g_object_class_install_property (gobject_class, PROP_TIMEOUT,
248 g_param_spec_uint ("timeout", "timeout",
249 "Value in seconds to timeout a blocking I/O (0 = No timeout).", 0,
250 3600, DEFAULT_TIMEOUT, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
251 g_object_class_install_property (gobject_class, PROP_EXTRA_HEADERS,
252 g_param_spec_boxed ("extra-headers", "Extra Headers",
253 "Extra headers to append to the HTTP request",
254 GST_TYPE_STRUCTURE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
255 g_object_class_install_property (gobject_class, PROP_IRADIO_MODE,
256 g_param_spec_boolean ("iradio-mode", "iradio-mode",
257 "Enable internet radio mode (ask server to send shoutcast/icecast "
258 "metadata interleaved with the actual stream data)",
259 DEFAULT_IRADIO_MODE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
262 * GstSoupHTTPSrc::http-log-level:
264 * If set and > 0, captures and dumps HTTP session data as
265 * log messages if log level >= GST_LEVEL_TRACE
269 g_object_class_install_property (gobject_class, PROP_SOUP_LOG_LEVEL,
270 g_param_spec_enum ("http-log-level", "HTTP log level",
271 "Set log level for soup's HTTP session log",
272 SOUP_TYPE_LOGGER_LOG_LEVEL, DEFAULT_SOUP_LOG_LEVEL,
273 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
276 * GstSoupHTTPSrc::compress:
278 * If set to %TRUE, souphttpsrc will automatically handle gzip
279 * and deflate Content-Encodings. This does not make much difference
280 * and causes more load for normal media files, but makes a real
281 * difference in size for plaintext files.
285 g_object_class_install_property (gobject_class, PROP_COMPRESS,
286 g_param_spec_boolean ("compress", "Compress",
287 "Allow compressed content encodings",
288 DEFAULT_COMPRESS, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
291 * GstSoupHTTPSrc::keep-alive:
293 * If set to %TRUE, souphttpsrc will keep alive connections when being
294 * set to READY state and only will close connections when connecting
295 * to a different server or when going to NULL state..
299 g_object_class_install_property (gobject_class, PROP_KEEP_ALIVE,
300 g_param_spec_boolean ("keep-alive", "keep-alive",
301 "Use HTTP persistent connections", DEFAULT_KEEP_ALIVE,
302 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
305 * GstSoupHTTPSrc::ssl-strict:
307 * If set to %TRUE, souphttpsrc will reject all SSL certificates that
308 * are considered invalid.
312 g_object_class_install_property (gobject_class, PROP_SSL_STRICT,
313 g_param_spec_boolean ("ssl-strict", "SSL Strict",
314 "Strict SSL certificate checking", DEFAULT_SSL_STRICT,
315 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
318 * GstSoupHTTPSrc::ssl-ca-file:
320 * A SSL anchor CA file that should be used for checking certificates
321 * instead of the system CA file.
323 * If this property is non-%NULL, #GstSoupHTTPSrc::ssl-use-system-ca-file
324 * value will be ignored.
326 * Deprecated: Use #GstSoupHTTPSrc::tls-database property instead.
329 g_object_class_install_property (gobject_class, PROP_SSL_CA_FILE,
330 g_param_spec_string ("ssl-ca-file", "SSL CA File",
331 "Location of a SSL anchor CA file to use", DEFAULT_SSL_CA_FILE,
332 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
335 * GstSoupHTTPSrc::ssl-use-system-ca-file:
337 * If set to %TRUE, souphttpsrc will use the system's CA file for
338 * checking certificates, unless #GstSoupHTTPSrc::ssl-ca-file or
339 * #GstSoupHTTPSrc::tls-database are non-%NULL.
343 g_object_class_install_property (gobject_class, PROP_SSL_USE_SYSTEM_CA_FILE,
344 g_param_spec_boolean ("ssl-use-system-ca-file", "Use System CA File",
345 "Use system CA file", DEFAULT_SSL_USE_SYSTEM_CA_FILE,
346 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
349 * GstSoupHTTPSrc::tls-database:
351 * TLS database with anchor certificate authorities used to validate
352 * the server certificate.
354 * If this property is non-%NULL, #GstSoupHTTPSrc::ssl-use-system-ca-file
355 * and #GstSoupHTTPSrc::ssl-ca-file values will be ignored.
359 g_object_class_install_property (gobject_class, PROP_TLS_DATABASE,
360 g_param_spec_object ("tls-database", "TLS database",
361 "TLS database with anchor certificate authorities used to validate the server certificate",
362 G_TYPE_TLS_DATABASE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
365 * GstSoupHTTPSrc::tls-interaction:
367 * A #GTlsInteraction object to be used when the connection or certificate
368 * database need to interact with the user. This will be used to prompt the
369 * user for passwords or certificate where necessary.
373 g_object_class_install_property (gobject_class, PROP_TLS_INTERACTION,
374 g_param_spec_object ("tls-interaction", "TLS interaction",
375 "A GTlsInteraction object to be used when the connection or certificate database need to interact with the user.",
376 G_TYPE_TLS_INTERACTION, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
379 * GstSoupHTTPSrc::retries:
381 * Maximum number of retries until giving up.
385 g_object_class_install_property (gobject_class, PROP_RETRIES,
386 g_param_spec_int ("retries", "Retries",
387 "Maximum number of retries until giving up (-1=infinite)", -1,
388 G_MAXINT, DEFAULT_RETRIES,
389 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
392 * GstSoupHTTPSrc::method
394 * The HTTP method to use when making a request
398 g_object_class_install_property (gobject_class, PROP_METHOD,
399 g_param_spec_string ("method", "HTTP method",
400 "The HTTP method to use (GET, HEAD, OPTIONS, etc)",
401 DEFAULT_SOUP_METHOD, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
403 gst_element_class_add_static_pad_template (gstelement_class, &srctemplate);
405 gst_element_class_set_static_metadata (gstelement_class, "HTTP client source",
407 "Receive data as a client over the network via HTTP using SOUP",
408 "Wouter Cloetens <wouter@mind.be>");
409 gstelement_class->change_state =
410 GST_DEBUG_FUNCPTR (gst_soup_http_src_change_state);
412 gstbasesrc_class->start = GST_DEBUG_FUNCPTR (gst_soup_http_src_start);
413 gstbasesrc_class->stop = GST_DEBUG_FUNCPTR (gst_soup_http_src_stop);
414 gstbasesrc_class->unlock = GST_DEBUG_FUNCPTR (gst_soup_http_src_unlock);
415 gstbasesrc_class->unlock_stop =
416 GST_DEBUG_FUNCPTR (gst_soup_http_src_unlock_stop);
417 gstbasesrc_class->get_size = GST_DEBUG_FUNCPTR (gst_soup_http_src_get_size);
418 gstbasesrc_class->is_seekable =
419 GST_DEBUG_FUNCPTR (gst_soup_http_src_is_seekable);
420 gstbasesrc_class->do_seek = GST_DEBUG_FUNCPTR (gst_soup_http_src_do_seek);
421 gstbasesrc_class->query = GST_DEBUG_FUNCPTR (gst_soup_http_src_query);
423 gstpushsrc_class->create = GST_DEBUG_FUNCPTR (gst_soup_http_src_create);
425 GST_DEBUG_CATEGORY_INIT (souphttpsrc_debug, "souphttpsrc", 0,
430 gst_soup_http_src_reset (GstSoupHTTPSrc * src)
432 src->retry_count = 0;
433 src->have_size = FALSE;
434 src->got_headers = FALSE;
435 src->seekable = FALSE;
436 src->read_position = 0;
437 src->request_position = 0;
438 src->stop_position = -1;
439 src->content_size = 0;
440 src->have_body = FALSE;
442 src->ret = GST_FLOW_OK;
443 g_cancellable_reset (src->cancellable);
444 gst_soup_http_src_destroy_input_stream (src);
446 gst_caps_replace (&src->src_caps, NULL);
447 g_free (src->iradio_name);
448 src->iradio_name = NULL;
449 g_free (src->iradio_genre);
450 src->iradio_genre = NULL;
451 g_free (src->iradio_url);
452 src->iradio_url = NULL;
456 gst_soup_http_src_init (GstSoupHTTPSrc * src)
460 g_mutex_init (&src->mutex);
461 g_cond_init (&src->have_headers_cond);
462 src->cancellable = g_cancellable_new ();
463 src->poll_context = g_main_context_new ();
464 src->location = NULL;
465 src->redirection_uri = NULL;
466 src->automatic_redirect = TRUE;
467 src->user_agent = g_strdup (DEFAULT_USER_AGENT);
470 src->proxy_id = NULL;
471 src->proxy_pw = NULL;
473 src->iradio_mode = DEFAULT_IRADIO_MODE;
476 src->timeout = DEFAULT_TIMEOUT;
477 src->log_level = DEFAULT_SOUP_LOG_LEVEL;
478 src->ssl_strict = DEFAULT_SSL_STRICT;
479 src->ssl_use_system_ca_file = DEFAULT_SSL_USE_SYSTEM_CA_FILE;
480 src->tls_database = DEFAULT_TLS_DATABASE;
481 src->tls_interaction = DEFAULT_TLS_INTERACTION;
482 src->max_retries = DEFAULT_RETRIES;
483 src->method = DEFAULT_SOUP_METHOD;
484 proxy = g_getenv ("http_proxy");
485 if (!gst_soup_http_src_set_proxy (src, proxy)) {
486 GST_WARNING_OBJECT (src,
487 "The proxy in the http_proxy env var (\"%s\") cannot be parsed.",
491 gst_base_src_set_automatic_eos (GST_BASE_SRC (src), FALSE);
493 gst_soup_http_src_reset (src);
497 gst_soup_http_src_dispose (GObject * gobject)
499 GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (gobject);
501 GST_DEBUG_OBJECT (src, "dispose");
503 gst_soup_http_src_session_close (src);
505 G_OBJECT_CLASS (parent_class)->dispose (gobject);
509 gst_soup_http_src_finalize (GObject * gobject)
511 GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (gobject);
513 GST_DEBUG_OBJECT (src, "finalize");
515 g_mutex_clear (&src->mutex);
516 g_cond_clear (&src->have_headers_cond);
517 g_object_unref (src->cancellable);
518 g_main_context_unref (src->poll_context);
519 g_free (src->location);
520 g_free (src->redirection_uri);
521 g_free (src->user_agent);
522 if (src->proxy != NULL) {
523 soup_uri_free (src->proxy);
525 g_free (src->user_id);
526 g_free (src->user_pw);
527 g_free (src->proxy_id);
528 g_free (src->proxy_pw);
529 g_strfreev (src->cookies);
531 if (src->extra_headers) {
532 gst_structure_free (src->extra_headers);
533 src->extra_headers = NULL;
536 g_free (src->ssl_ca_file);
538 if (src->tls_database)
539 g_object_unref (src->tls_database);
540 g_free (src->method);
542 if (src->tls_interaction)
543 g_object_unref (src->tls_interaction);
545 G_OBJECT_CLASS (parent_class)->finalize (gobject);
549 gst_soup_http_src_set_property (GObject * object, guint prop_id,
550 const GValue * value, GParamSpec * pspec)
552 GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (object);
557 const gchar *location;
559 location = g_value_get_string (value);
561 if (location == NULL) {
562 GST_WARNING ("location property cannot be NULL");
565 if (!gst_soup_http_src_set_location (src, location, NULL)) {
566 GST_WARNING ("badly formatted location");
571 case PROP_USER_AGENT:
572 g_free (src->user_agent);
573 src->user_agent = g_value_dup_string (value);
575 case PROP_IRADIO_MODE:
576 src->iradio_mode = g_value_get_boolean (value);
578 case PROP_AUTOMATIC_REDIRECT:
579 src->automatic_redirect = g_value_get_boolean (value);
585 proxy = g_value_get_string (value);
586 if (!gst_soup_http_src_set_proxy (src, proxy)) {
587 GST_WARNING ("badly formatted proxy URI");
593 g_strfreev (src->cookies);
594 src->cookies = g_strdupv (g_value_get_boxed (value));
597 gst_base_src_set_live (GST_BASE_SRC (src), g_value_get_boolean (value));
600 g_free (src->user_id);
601 src->user_id = g_value_dup_string (value);
604 g_free (src->user_pw);
605 src->user_pw = g_value_dup_string (value);
608 g_free (src->proxy_id);
609 src->proxy_id = g_value_dup_string (value);
612 g_free (src->proxy_pw);
613 src->proxy_pw = g_value_dup_string (value);
616 src->timeout = g_value_get_uint (value);
618 case PROP_EXTRA_HEADERS:{
619 const GstStructure *s = gst_value_get_structure (value);
621 if (src->extra_headers)
622 gst_structure_free (src->extra_headers);
624 src->extra_headers = s ? gst_structure_copy (s) : NULL;
627 case PROP_SOUP_LOG_LEVEL:
628 src->log_level = g_value_get_enum (value);
631 src->compress = g_value_get_boolean (value);
633 case PROP_KEEP_ALIVE:
634 src->keep_alive = g_value_get_boolean (value);
636 case PROP_SSL_STRICT:
637 src->ssl_strict = g_value_get_boolean (value);
639 case PROP_SSL_CA_FILE:
640 g_free (src->ssl_ca_file);
641 src->ssl_ca_file = g_value_dup_string (value);
643 case PROP_SSL_USE_SYSTEM_CA_FILE:
644 src->ssl_use_system_ca_file = g_value_get_boolean (value);
646 case PROP_TLS_DATABASE:
647 g_clear_object (&src->tls_database);
648 src->tls_database = g_value_dup_object (value);
650 case PROP_TLS_INTERACTION:
651 g_clear_object (&src->tls_interaction);
652 src->tls_interaction = g_value_dup_object (value);
655 src->max_retries = g_value_get_int (value);
658 g_free (src->method);
659 src->method = g_value_dup_string (value);
662 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
670 gst_soup_http_src_get_property (GObject * object, guint prop_id,
671 GValue * value, GParamSpec * pspec)
673 GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (object);
677 g_value_set_string (value, src->location);
679 case PROP_USER_AGENT:
680 g_value_set_string (value, src->user_agent);
682 case PROP_AUTOMATIC_REDIRECT:
683 g_value_set_boolean (value, src->automatic_redirect);
686 if (src->proxy == NULL)
687 g_value_set_static_string (value, "");
689 char *proxy = soup_uri_to_string (src->proxy, FALSE);
691 g_value_set_string (value, proxy);
696 g_value_set_boxed (value, g_strdupv (src->cookies));
699 g_value_set_boolean (value, gst_base_src_is_live (GST_BASE_SRC (src)));
701 case PROP_IRADIO_MODE:
702 g_value_set_boolean (value, src->iradio_mode);
705 g_value_set_string (value, src->user_id);
708 g_value_set_string (value, src->user_pw);
711 g_value_set_string (value, src->proxy_id);
714 g_value_set_string (value, src->proxy_pw);
717 g_value_set_uint (value, src->timeout);
719 case PROP_EXTRA_HEADERS:
720 gst_value_set_structure (value, src->extra_headers);
722 case PROP_SOUP_LOG_LEVEL:
723 g_value_set_enum (value, src->log_level);
726 g_value_set_boolean (value, src->compress);
728 case PROP_KEEP_ALIVE:
729 g_value_set_boolean (value, src->keep_alive);
731 case PROP_SSL_STRICT:
732 g_value_set_boolean (value, src->ssl_strict);
734 case PROP_SSL_CA_FILE:
735 g_value_set_string (value, src->ssl_ca_file);
737 case PROP_SSL_USE_SYSTEM_CA_FILE:
738 g_value_set_boolean (value, src->ssl_use_system_ca_file);
740 case PROP_TLS_DATABASE:
741 g_value_set_object (value, src->tls_database);
743 case PROP_TLS_INTERACTION:
744 g_value_set_object (value, src->tls_interaction);
747 g_value_set_int (value, src->max_retries);
750 g_value_set_string (value, src->method);
753 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
759 gst_soup_http_src_unicodify (const gchar * str)
761 const gchar *env_vars[] = { "GST_ICY_TAG_ENCODING",
762 "GST_TAG_ENCODING", NULL
765 return gst_tag_freeform_string_to_utf8 (str, -1, env_vars);
769 gst_soup_http_src_destroy_input_stream (GstSoupHTTPSrc * src)
771 if (src->input_stream) {
772 if (src->poll_source) {
773 g_source_destroy (src->poll_source);
774 g_source_unref (src->poll_source);
775 src->poll_source = NULL;
777 g_input_stream_close (src->input_stream, src->cancellable, NULL);
778 g_object_unref (src->input_stream);
779 src->input_stream = NULL;
784 gst_soup_http_src_cancel_message (GstSoupHTTPSrc * src)
786 g_cancellable_cancel (src->cancellable);
787 g_cond_signal (&src->have_headers_cond);
791 gst_soup_http_src_add_range_header (GstSoupHTTPSrc * src, guint64 offset,
797 soup_message_headers_remove (src->msg->request_headers, "Range");
798 if (offset || stop_offset != -1) {
799 if (stop_offset != -1) {
800 g_assert (offset != stop_offset);
802 rc = g_snprintf (buf, sizeof (buf), "bytes=%" G_GUINT64_FORMAT "-%"
803 G_GUINT64_FORMAT, offset, (stop_offset > 0) ? stop_offset - 1 :
806 rc = g_snprintf (buf, sizeof (buf), "bytes=%" G_GUINT64_FORMAT "-",
809 if (rc > sizeof (buf) || rc < 0)
811 soup_message_headers_append (src->msg->request_headers, "Range", buf);
813 src->read_position = offset;
818 _append_extra_header (GQuark field_id, const GValue * value, gpointer user_data)
820 GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (user_data);
821 const gchar *field_name = g_quark_to_string (field_id);
822 gchar *field_content = NULL;
824 if (G_VALUE_TYPE (value) == G_TYPE_STRING) {
825 field_content = g_value_dup_string (value);
827 GValue dest = { 0, };
829 g_value_init (&dest, G_TYPE_STRING);
830 if (g_value_transform (value, &dest)) {
831 field_content = g_value_dup_string (&dest);
835 if (field_content == NULL) {
836 GST_ERROR_OBJECT (src, "extra-headers field '%s' contains no value "
837 "or can't be converted to a string", field_name);
841 GST_DEBUG_OBJECT (src, "Appending extra header: \"%s: %s\"", field_name,
843 soup_message_headers_append (src->msg->request_headers, field_name,
846 g_free (field_content);
852 _append_extra_headers (GQuark field_id, const GValue * value,
855 if (G_VALUE_TYPE (value) == GST_TYPE_ARRAY) {
856 guint n = gst_value_array_get_size (value);
859 for (i = 0; i < n; i++) {
860 const GValue *v = gst_value_array_get_value (value, i);
862 if (!_append_extra_header (field_id, v, user_data))
865 } else if (G_VALUE_TYPE (value) == GST_TYPE_LIST) {
866 guint n = gst_value_list_get_size (value);
869 for (i = 0; i < n; i++) {
870 const GValue *v = gst_value_list_get_value (value, i);
872 if (!_append_extra_header (field_id, v, user_data))
876 return _append_extra_header (field_id, value, user_data);
884 gst_soup_http_src_add_extra_headers (GstSoupHTTPSrc * src)
886 if (!src->extra_headers)
889 return gst_structure_foreach (src->extra_headers, _append_extra_headers, src);
893 gst_soup_http_src_session_open (GstSoupHTTPSrc * src)
896 GST_DEBUG_OBJECT (src, "Session is already open");
900 if (!src->location) {
901 GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ, (_("No URL set.")),
902 ("Missing location property"));
907 GST_DEBUG_OBJECT (src, "Creating session");
908 if (src->proxy == NULL) {
910 soup_session_new_with_options (SOUP_SESSION_USER_AGENT,
911 src->user_agent, SOUP_SESSION_TIMEOUT, src->timeout,
912 SOUP_SESSION_SSL_STRICT, src->ssl_strict,
913 SOUP_SESSION_TLS_INTERACTION, src->tls_interaction, NULL);
916 soup_session_new_with_options (SOUP_SESSION_PROXY_URI, src->proxy,
917 SOUP_SESSION_TIMEOUT, src->timeout,
918 SOUP_SESSION_SSL_STRICT, src->ssl_strict,
919 SOUP_SESSION_USER_AGENT, src->user_agent,
920 SOUP_SESSION_TLS_INTERACTION, src->tls_interaction, NULL);
924 GST_ELEMENT_ERROR (src, LIBRARY, INIT,
925 (NULL), ("Failed to create async session"));
929 g_signal_connect (src->session, "authenticate",
930 G_CALLBACK (gst_soup_http_src_authenticate_cb), src);
933 gst_soup_util_log_setup (src->session, src->log_level, GST_ELEMENT (src));
934 if (src->tls_database)
935 g_object_set (src->session, "tls-database", src->tls_database, NULL);
936 else if (src->ssl_ca_file)
937 g_object_set (src->session, "ssl-ca-file", src->ssl_ca_file, NULL);
939 g_object_set (src->session, "ssl-use-system-ca-file",
940 src->ssl_use_system_ca_file, NULL);
942 GST_DEBUG_OBJECT (src, "Re-using session");
946 soup_session_add_feature_by_type (src->session, SOUP_TYPE_CONTENT_DECODER);
948 soup_session_remove_feature_by_type (src->session,
949 SOUP_TYPE_CONTENT_DECODER);
955 gst_soup_http_src_session_close (GstSoupHTTPSrc * src)
957 GST_DEBUG_OBJECT (src, "Closing session");
959 g_mutex_lock (&src->mutex);
961 soup_session_abort (src->session); /* This unrefs the message. */
962 g_object_unref (src->session);
966 g_mutex_unlock (&src->mutex);
970 gst_soup_http_src_authenticate_cb (SoupSession * session, SoupMessage * msg,
971 SoupAuth * auth, gboolean retrying, GstSoupHTTPSrc * src)
974 /* First time authentication only, if we fail and are called again with retry true fall through */
975 if (msg->status_code == SOUP_STATUS_UNAUTHORIZED) {
976 if (src->user_id && src->user_pw)
977 soup_auth_authenticate (auth, src->user_id, src->user_pw);
978 } else if (msg->status_code == SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED) {
979 if (src->proxy_id && src->proxy_pw)
980 soup_auth_authenticate (auth, src->proxy_id, src->proxy_pw);
986 insert_http_header (const gchar * name, const gchar * value, gpointer user_data)
988 GstStructure *headers = user_data;
991 gv = gst_structure_get_value (headers, name);
992 if (gv && GST_VALUE_HOLDS_ARRAY (gv)) {
993 GValue v = G_VALUE_INIT;
995 g_value_init (&v, G_TYPE_STRING);
996 g_value_set_string (&v, value);
997 gst_value_array_append_value ((GValue *) gv, &v);
999 } else if (gv && G_VALUE_HOLDS_STRING (gv)) {
1000 GValue arr = G_VALUE_INIT;
1001 GValue v = G_VALUE_INIT;
1002 const gchar *old_value = g_value_get_string (gv);
1004 g_value_init (&arr, GST_TYPE_ARRAY);
1005 g_value_init (&v, G_TYPE_STRING);
1006 g_value_set_string (&v, old_value);
1007 gst_value_array_append_value (&arr, &v);
1008 g_value_set_string (&v, value);
1009 gst_value_array_append_value (&arr, &v);
1011 gst_structure_set_value (headers, name, &arr);
1013 g_value_unset (&arr);
1015 gst_structure_set (headers, name, G_TYPE_STRING, value, NULL);
1020 gst_soup_http_src_got_headers (GstSoupHTTPSrc * src, SoupMessage * msg)
1023 GstTagList *tag_list;
1024 GstBaseSrc *basesrc;
1026 GHashTable *params = NULL;
1027 GstEvent *http_headers_event;
1028 GstStructure *http_headers, *headers;
1029 const gchar *accept_ranges;
1031 GST_INFO_OBJECT (src, "got headers");
1033 if (msg->status_code == SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED &&
1034 src->proxy_id && src->proxy_pw)
1037 if (src->automatic_redirect && SOUP_STATUS_IS_REDIRECTION (msg->status_code)) {
1038 src->redirection_uri = g_strdup (soup_message_headers_get_one
1039 (msg->response_headers, "Location"));
1040 src->redirection_permanent =
1041 (msg->status_code == SOUP_STATUS_MOVED_PERMANENTLY);
1042 GST_DEBUG_OBJECT (src, "%u redirect to \"%s\" (permanent %d)",
1043 msg->status_code, src->redirection_uri, src->redirection_permanent);
1047 if (msg->status_code == SOUP_STATUS_UNAUTHORIZED) {
1048 /* force an error */
1049 gst_soup_http_src_parse_status (msg, src);
1053 src->got_headers = TRUE;
1054 g_cond_broadcast (&src->have_headers_cond);
1056 http_headers = gst_structure_new_empty ("http-headers");
1057 gst_structure_set (http_headers, "uri", G_TYPE_STRING, src->location, NULL);
1058 if (src->redirection_uri)
1059 gst_structure_set (http_headers, "redirection-uri", G_TYPE_STRING,
1060 src->redirection_uri, NULL);
1061 headers = gst_structure_new_empty ("request-headers");
1062 soup_message_headers_foreach (msg->request_headers, insert_http_header,
1064 gst_structure_set (http_headers, "request-headers", GST_TYPE_STRUCTURE,
1066 gst_structure_free (headers);
1067 headers = gst_structure_new_empty ("response-headers");
1068 soup_message_headers_foreach (msg->response_headers, insert_http_header,
1070 gst_structure_set (http_headers, "response-headers", GST_TYPE_STRUCTURE,
1072 gst_structure_free (headers);
1074 http_headers_event =
1075 gst_event_new_custom (GST_EVENT_CUSTOM_DOWNSTREAM_STICKY, http_headers);
1076 gst_event_replace (&src->http_headers_event, http_headers_event);
1077 gst_event_unref (http_headers_event);
1079 /* Parse Content-Length. */
1080 if (soup_message_headers_get_encoding (msg->response_headers) ==
1081 SOUP_ENCODING_CONTENT_LENGTH) {
1082 newsize = src->request_position +
1083 soup_message_headers_get_content_length (msg->response_headers);
1084 if (!src->have_size || (src->content_size != newsize)) {
1085 src->content_size = newsize;
1086 src->have_size = TRUE;
1087 src->seekable = TRUE;
1088 GST_DEBUG_OBJECT (src, "size = %" G_GUINT64_FORMAT, src->content_size);
1090 basesrc = GST_BASE_SRC_CAST (src);
1091 basesrc->segment.duration = src->content_size;
1092 gst_element_post_message (GST_ELEMENT (src),
1093 gst_message_new_duration_changed (GST_OBJECT (src)));
1097 /* If the server reports Accept-Ranges: none we don't have to try
1098 * doing range requests at all
1100 if ((accept_ranges =
1101 soup_message_headers_get_one (msg->response_headers,
1102 "Accept-Ranges"))) {
1103 if (g_ascii_strcasecmp (accept_ranges, "none") == 0)
1104 src->seekable = FALSE;
1108 tag_list = gst_tag_list_new_empty ();
1111 soup_message_headers_get_one (msg->response_headers,
1112 "icy-metaint")) != NULL) {
1113 gint icy_metaint = atoi (value);
1115 GST_DEBUG_OBJECT (src, "icy-metaint: %s (parsed: %d)", value, icy_metaint);
1116 if (icy_metaint > 0) {
1118 gst_caps_unref (src->src_caps);
1120 src->src_caps = gst_caps_new_simple ("application/x-icy",
1121 "metadata-interval", G_TYPE_INT, icy_metaint, NULL);
1123 gst_base_src_set_caps (GST_BASE_SRC (src), src->src_caps);
1127 soup_message_headers_get_content_type (msg->response_headers,
1128 ¶ms)) != NULL) {
1129 GST_DEBUG_OBJECT (src, "Content-Type: %s", value);
1130 if (g_ascii_strcasecmp (value, "audio/L16") == 0) {
1136 gst_caps_unref (src->src_caps);
1138 param = g_hash_table_lookup (params, "channels");
1140 channels = atol (param);
1142 param = g_hash_table_lookup (params, "rate");
1144 rate = atol (param);
1146 src->src_caps = gst_caps_new_simple ("audio/x-unaligned-raw",
1147 "format", G_TYPE_STRING, "S16BE",
1148 "layout", G_TYPE_STRING, "interleaved",
1149 "channels", G_TYPE_INT, channels, "rate", G_TYPE_INT, rate, NULL);
1151 gst_base_src_set_caps (GST_BASE_SRC (src), src->src_caps);
1153 /* Set the Content-Type field on the caps */
1154 if (src->src_caps) {
1155 src->src_caps = gst_caps_make_writable (src->src_caps);
1156 gst_caps_set_simple (src->src_caps, "content-type", G_TYPE_STRING,
1158 gst_base_src_set_caps (GST_BASE_SRC (src), src->src_caps);
1164 g_hash_table_destroy (params);
1167 soup_message_headers_get_one (msg->response_headers,
1168 "icy-name")) != NULL) {
1169 g_free (src->iradio_name);
1170 src->iradio_name = gst_soup_http_src_unicodify (value);
1171 if (src->iradio_name) {
1172 gst_tag_list_add (tag_list, GST_TAG_MERGE_REPLACE, GST_TAG_ORGANIZATION,
1173 src->iradio_name, NULL);
1177 soup_message_headers_get_one (msg->response_headers,
1178 "icy-genre")) != NULL) {
1179 g_free (src->iradio_genre);
1180 src->iradio_genre = gst_soup_http_src_unicodify (value);
1181 if (src->iradio_genre) {
1182 gst_tag_list_add (tag_list, GST_TAG_MERGE_REPLACE, GST_TAG_GENRE,
1183 src->iradio_genre, NULL);
1186 if ((value = soup_message_headers_get_one (msg->response_headers, "icy-url"))
1188 g_free (src->iradio_url);
1189 src->iradio_url = gst_soup_http_src_unicodify (value);
1190 if (src->iradio_url) {
1191 gst_tag_list_add (tag_list, GST_TAG_MERGE_REPLACE, GST_TAG_LOCATION,
1192 src->iradio_url, NULL);
1195 if (!gst_tag_list_is_empty (tag_list)) {
1196 GST_DEBUG_OBJECT (src,
1197 "calling gst_element_found_tags with %" GST_PTR_FORMAT, tag_list);
1198 gst_pad_push_event (GST_BASE_SRC_PAD (src), gst_event_new_tag (tag_list));
1200 gst_tag_list_unref (tag_list);
1203 /* Handle HTTP errors. */
1204 gst_soup_http_src_parse_status (msg, src);
1206 /* Check if Range header was respected. */
1207 if (src->ret == GST_FLOW_CUSTOM_ERROR &&
1208 src->read_position && msg->status_code != SOUP_STATUS_PARTIAL_CONTENT) {
1209 src->seekable = FALSE;
1210 GST_ELEMENT_ERROR (src, RESOURCE, SEEK,
1211 (_("Server does not support seeking.")),
1212 ("Server does not accept Range HTTP header, URL: %s, Redirect to: %s",
1213 src->location, GST_STR_NULL (src->redirection_uri)));
1214 src->ret = GST_FLOW_ERROR;
1217 /* If we are going to error out, stop all processing right here, so we
1218 * don't output any data (such as an error html page), and return
1219 * GST_FLOW_ERROR from the create function instead of having
1220 * got_chunk_cb overwrite src->ret with FLOW_OK again. */
1221 if (src->ret == GST_FLOW_ERROR || src->ret == GST_FLOW_EOS) {
1226 gst_soup_http_src_alloc_buffer (GstSoupHTTPSrc * src)
1228 GstBaseSrc *basesrc = GST_BASE_SRC_CAST (src);
1232 rc = GST_BASE_SRC_CLASS (parent_class)->alloc (basesrc, -1,
1233 basesrc->blocksize, &gstbuf);
1234 if (G_UNLIKELY (rc != GST_FLOW_OK)) {
1241 #define SOUP_HTTP_SRC_ERROR(src,soup_msg,cat,code,error_message) \
1242 GST_ELEMENT_ERROR ((src), cat, code, ("%s", error_message), \
1243 ("%s (%d), URL: %s, Redirect to: %s", (soup_msg)->reason_phrase, \
1244 (soup_msg)->status_code, (src)->location, GST_STR_NULL ((src)->redirection_uri)));
1247 gst_soup_http_src_parse_status (SoupMessage * msg, GstSoupHTTPSrc * src)
1249 if (msg->method == SOUP_METHOD_HEAD) {
1250 if (!SOUP_STATUS_IS_SUCCESSFUL (msg->status_code))
1251 GST_DEBUG_OBJECT (src, "Ignoring error %d during HEAD request",
1253 } else if (SOUP_STATUS_IS_TRANSPORT_ERROR (msg->status_code)) {
1254 switch (msg->status_code) {
1255 case SOUP_STATUS_CANT_RESOLVE:
1256 case SOUP_STATUS_CANT_RESOLVE_PROXY:
1257 SOUP_HTTP_SRC_ERROR (src, msg, RESOURCE, NOT_FOUND,
1258 _("Could not resolve server name."));
1259 src->ret = GST_FLOW_ERROR;
1261 case SOUP_STATUS_CANT_CONNECT:
1262 case SOUP_STATUS_CANT_CONNECT_PROXY:
1263 SOUP_HTTP_SRC_ERROR (src, msg, RESOURCE, OPEN_READ,
1264 _("Could not establish connection to server."));
1265 src->ret = GST_FLOW_ERROR;
1267 case SOUP_STATUS_SSL_FAILED:
1268 SOUP_HTTP_SRC_ERROR (src, msg, RESOURCE, OPEN_READ,
1269 _("Secure connection setup failed."));
1270 src->ret = GST_FLOW_ERROR;
1272 case SOUP_STATUS_IO_ERROR:
1273 if (src->max_retries == -1 || src->retry_count < src->max_retries) {
1274 src->ret = GST_FLOW_CUSTOM_ERROR;
1276 SOUP_HTTP_SRC_ERROR (src, msg, RESOURCE, READ,
1277 _("A network error occurred, or the server closed the connection "
1279 src->ret = GST_FLOW_ERROR;
1282 case SOUP_STATUS_MALFORMED:
1283 SOUP_HTTP_SRC_ERROR (src, msg, RESOURCE, READ,
1284 _("Server sent bad data."));
1285 src->ret = GST_FLOW_ERROR;
1287 case SOUP_STATUS_CANCELLED:
1288 /* No error message when interrupted by program. */
1291 } else if (SOUP_STATUS_IS_CLIENT_ERROR (msg->status_code) ||
1292 SOUP_STATUS_IS_REDIRECTION (msg->status_code) ||
1293 SOUP_STATUS_IS_SERVER_ERROR (msg->status_code)) {
1294 /* Report HTTP error. */
1296 /* when content_size is unknown and we have just finished receiving
1297 * a body message, requests that go beyond the content limits will result
1298 * in an error. Here we convert those to EOS */
1299 if (msg->status_code == SOUP_STATUS_REQUESTED_RANGE_NOT_SATISFIABLE &&
1300 src->have_body && !src->have_size) {
1301 GST_DEBUG_OBJECT (src, "Requested range out of limits and received full "
1302 "body, returning EOS");
1303 src->ret = GST_FLOW_EOS;
1307 /* FIXME: reason_phrase is not translated and not suitable for user
1308 * error dialog according to libsoup documentation.
1310 if (msg->status_code == SOUP_STATUS_NOT_FOUND) {
1311 GST_ELEMENT_ERROR (src, RESOURCE, NOT_FOUND,
1312 ("%s", msg->reason_phrase),
1313 ("%s (%d), URL: %s, Redirect to: %s", msg->reason_phrase,
1314 msg->status_code, src->location,
1315 GST_STR_NULL (src->redirection_uri)));
1316 } else if (msg->status_code == SOUP_STATUS_UNAUTHORIZED
1317 || msg->status_code == SOUP_STATUS_PAYMENT_REQUIRED
1318 || msg->status_code == SOUP_STATUS_FORBIDDEN
1319 || msg->status_code == SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED) {
1320 GST_ELEMENT_ERROR (src, RESOURCE, NOT_AUTHORIZED, ("%s",
1321 msg->reason_phrase), ("%s (%d), URL: %s, Redirect to: %s",
1322 msg->reason_phrase, msg->status_code, src->location,
1323 GST_STR_NULL (src->redirection_uri)));
1325 GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ,
1326 ("%s", msg->reason_phrase),
1327 ("%s (%d), URL: %s, Redirect to: %s", msg->reason_phrase,
1328 msg->status_code, src->location,
1329 GST_STR_NULL (src->redirection_uri)));
1331 src->ret = GST_FLOW_ERROR;
1336 gst_soup_http_src_build_message (GstSoupHTTPSrc * src, const gchar * method)
1338 g_return_val_if_fail (src->msg == NULL, FALSE);
1340 src->msg = soup_message_new (method, src->location);
1342 GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ,
1343 ("Error parsing URL."), ("URL: %s", src->location));
1346 if (!src->keep_alive) {
1347 soup_message_headers_append (src->msg->request_headers, "Connection",
1350 if (src->iradio_mode) {
1351 soup_message_headers_append (src->msg->request_headers, "icy-metadata",
1357 for (cookie = src->cookies; *cookie != NULL; cookie++) {
1358 soup_message_headers_append (src->msg->request_headers, "Cookie",
1363 soup_message_set_flags (src->msg, SOUP_MESSAGE_OVERWRITE_CHUNKS |
1364 (src->automatic_redirect ? 0 : SOUP_MESSAGE_NO_REDIRECT));
1365 gst_soup_http_src_add_range_header (src, src->request_position,
1366 src->stop_position);
1368 gst_soup_http_src_add_extra_headers (src);
1374 gst_soup_http_src_check_input_stream_interfaces (GstSoupHTTPSrc * src)
1376 if (!src->input_stream)
1379 src->has_pollable_interface = G_IS_POLLABLE_INPUT_STREAM (src->input_stream)
1380 && g_pollable_input_stream_can_poll ((GPollableInputStream *)
1384 static GstFlowReturn
1385 gst_soup_http_src_send_message (GstSoupHTTPSrc * src)
1387 g_return_val_if_fail (src->msg != NULL, GST_FLOW_ERROR);
1389 g_assert (src->input_stream == NULL);
1390 g_assert (src->poll_source == NULL);
1392 /* FIXME We are ignoring the GError here, might be useful to debug */
1394 soup_session_send (src->session, src->msg, src->cancellable, NULL);
1396 if (g_cancellable_is_cancelled (src->cancellable))
1397 return GST_FLOW_FLUSHING;
1399 gst_soup_http_src_got_headers (src, src->msg);
1400 if (src->ret != GST_FLOW_OK) {
1404 if (!src->input_stream) {
1405 GST_DEBUG_OBJECT (src, "Didn't get an input stream");
1406 return GST_FLOW_ERROR;
1409 if (SOUP_STATUS_IS_SUCCESSFUL (src->msg->status_code)) {
1410 GST_DEBUG_OBJECT (src, "Successfully got a reply");
1412 /* FIXME - be more helpful to people debugging */
1413 return GST_FLOW_ERROR;
1416 gst_soup_http_src_check_input_stream_interfaces (src);
1421 static GstFlowReturn
1422 gst_soup_http_src_do_request (GstSoupHTTPSrc * src, const gchar * method)
1424 if (src->max_retries != -1 && src->retry_count > src->max_retries) {
1425 GST_DEBUG_OBJECT (src, "Max retries reached");
1426 src->ret = GST_FLOW_ERROR;
1431 /* EOS immediately if we have an empty segment */
1432 if (src->request_position == src->stop_position)
1433 return GST_FLOW_EOS;
1435 GST_LOG_OBJECT (src, "Running request for method: %s", method);
1437 /* Update the position if we are retrying */
1438 if (src->msg && (src->request_position != src->read_position)) {
1439 gst_soup_http_src_add_range_header (src, src->request_position,
1440 src->stop_position);
1444 if (!gst_soup_http_src_build_message (src, method)) {
1445 return GST_FLOW_ERROR;
1449 if (g_cancellable_is_cancelled (src->cancellable)) {
1450 GST_INFO_OBJECT (src, "interrupted");
1451 src->ret = GST_FLOW_FLUSHING;
1454 src->ret = gst_soup_http_src_send_message (src);
1461 gst_soup_http_src_update_position (GstSoupHTTPSrc * src, gint64 bytes_read)
1463 GstBaseSrc *basesrc = GST_BASE_SRC_CAST (src);
1464 guint64 new_position;
1466 new_position = src->read_position + bytes_read;
1467 if (G_LIKELY (src->request_position == src->read_position))
1468 src->request_position = new_position;
1469 src->read_position = new_position;
1471 if (src->have_size) {
1472 if (new_position > src->content_size) {
1473 GST_DEBUG_OBJECT (src, "Got position previous estimated content size "
1474 "(%" G_GINT64_FORMAT " > %" G_GINT64_FORMAT ")", new_position,
1476 src->content_size = new_position;
1477 basesrc->segment.duration = src->content_size;
1478 gst_element_post_message (GST_ELEMENT (src),
1479 gst_message_new_duration_changed (GST_OBJECT (src)));
1480 } else if (new_position == src->content_size) {
1481 GST_DEBUG_OBJECT (src, "We're EOS now");
1487 _gst_soup_http_src_data_available_callback (GObject * pollable_stream,
1490 GstSoupHTTPSrc *src = udata;
1492 src->have_data = TRUE;
1496 /* Need to wait on a gsource to know when data is available */
1498 gst_soup_http_src_wait_for_data (GstSoupHTTPSrc * src)
1500 src->have_data = FALSE;
1502 if (!src->poll_source) {
1504 g_pollable_input_stream_create_source ((GPollableInputStream *)
1505 src->input_stream, src->cancellable);
1506 g_source_set_callback (src->poll_source,
1507 (GSourceFunc) _gst_soup_http_src_data_available_callback, src, NULL);
1508 g_source_attach (src->poll_source, src->poll_context);
1511 while (!src->have_data && !g_cancellable_is_cancelled (src->cancellable)) {
1512 g_main_context_iteration (src->poll_context, TRUE);
1515 return src->have_data;
1518 static GstFlowReturn
1519 gst_soup_http_src_read_buffer (GstSoupHTTPSrc * src, GstBuffer ** outbuf)
1527 bsrc = GST_BASE_SRC_CAST (src);
1529 *outbuf = gst_soup_http_src_alloc_buffer (src);
1531 GST_WARNING_OBJECT (src, "Failed to allocate buffer");
1532 return GST_FLOW_ERROR;
1535 if (!gst_buffer_map (*outbuf, &mapinfo, GST_MAP_WRITE)) {
1536 GST_WARNING_OBJECT (src, "Failed to map buffer");
1537 return GST_FLOW_ERROR;
1540 if (src->has_pollable_interface) {
1543 g_pollable_input_stream_read_nonblocking ((GPollableInputStream *)
1544 src->input_stream, mapinfo.data, mapinfo.size, src->cancellable,
1546 if (read_bytes == -1) {
1547 if (err && g_error_matches (err, G_IO_ERROR, G_IO_ERROR_WOULD_BLOCK)) {
1551 /* no data yet, wait */
1552 if (gst_soup_http_src_wait_for_data (src))
1561 g_input_stream_read (src->input_stream, mapinfo.data, mapinfo.size,
1562 src->cancellable, NULL);
1568 GST_DEBUG_OBJECT (src, "Read %" G_GSSIZE_FORMAT " bytes from http input",
1571 g_mutex_lock (&src->mutex);
1572 if (g_cancellable_is_cancelled (src->cancellable)) {
1573 gst_buffer_unmap (*outbuf, &mapinfo);
1574 gst_buffer_unref (*outbuf);
1575 g_mutex_unlock (&src->mutex);
1576 return GST_FLOW_FLUSHING;
1578 g_mutex_unlock (&src->mutex);
1580 gst_buffer_unmap (*outbuf, &mapinfo);
1581 if (read_bytes > 0) {
1582 gst_buffer_set_size (*outbuf, read_bytes);
1583 GST_BUFFER_OFFSET (*outbuf) = bsrc->segment.position;
1585 gst_soup_http_src_update_position (src, read_bytes);
1587 /* Got some data, reset retry counter */
1588 src->retry_count = 0;
1590 gst_buffer_unref (*outbuf);
1591 if (read_bytes < 0) {
1592 /* Maybe the server disconnected, retry */
1593 ret = GST_FLOW_CUSTOM_ERROR;
1596 src->have_body = TRUE;
1602 static GstFlowReturn
1603 gst_soup_http_src_create (GstPushSrc * psrc, GstBuffer ** outbuf)
1605 GstSoupHTTPSrc *src;
1606 GstFlowReturn ret = GST_FLOW_OK;
1607 GstEvent *http_headers_event = NULL;
1609 src = GST_SOUP_HTTP_SRC (psrc);
1612 g_mutex_lock (&src->mutex);
1614 /* Check for pending position change */
1615 if (src->request_position != src->read_position) {
1616 gst_soup_http_src_destroy_input_stream (src);
1619 if (g_cancellable_is_cancelled (src->cancellable)) {
1620 ret = GST_FLOW_FLUSHING;
1621 g_mutex_unlock (&src->mutex);
1625 /* If we have no open connection to the server, start one */
1626 if (!src->input_stream) {
1629 gst_soup_http_src_do_request (src,
1630 src->method ? src->method : SOUP_METHOD_GET);
1631 http_headers_event = src->http_headers_event;
1632 src->http_headers_event = NULL;
1634 g_mutex_unlock (&src->mutex);
1636 if (ret == GST_FLOW_OK || ret == GST_FLOW_CUSTOM_ERROR) {
1637 if (http_headers_event) {
1638 gst_pad_push_event (GST_BASE_SRC_PAD (src), http_headers_event);
1639 http_headers_event = NULL;
1643 if (ret == GST_FLOW_OK)
1644 ret = gst_soup_http_src_read_buffer (src, outbuf);
1647 GST_DEBUG_OBJECT (src, "Returning %d %s", ret, gst_flow_get_name (ret));
1648 if (ret != GST_FLOW_OK) {
1649 if (http_headers_event)
1650 gst_event_unref (http_headers_event);
1652 g_mutex_lock (&src->mutex);
1653 gst_soup_http_src_destroy_input_stream (src);
1654 g_mutex_unlock (&src->mutex);
1655 if (ret == GST_FLOW_CUSTOM_ERROR)
1662 gst_soup_http_src_start (GstBaseSrc * bsrc)
1664 GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (bsrc);
1666 GST_DEBUG_OBJECT (src, "start(\"%s\")", src->location);
1668 return gst_soup_http_src_session_open (src);
1672 gst_soup_http_src_stop (GstBaseSrc * bsrc)
1674 GstSoupHTTPSrc *src;
1676 src = GST_SOUP_HTTP_SRC (bsrc);
1677 GST_DEBUG_OBJECT (src, "stop()");
1678 if (src->keep_alive && !src->msg)
1679 gst_soup_http_src_cancel_message (src);
1681 gst_soup_http_src_session_close (src);
1683 gst_soup_http_src_reset (src);
1687 static GstStateChangeReturn
1688 gst_soup_http_src_change_state (GstElement * element, GstStateChange transition)
1690 GstStateChangeReturn ret;
1691 GstSoupHTTPSrc *src;
1693 src = GST_SOUP_HTTP_SRC (element);
1695 switch (transition) {
1696 case GST_STATE_CHANGE_READY_TO_NULL:
1697 gst_soup_http_src_session_close (src);
1703 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
1708 /* Interrupt a blocking request. */
1710 gst_soup_http_src_unlock (GstBaseSrc * bsrc)
1712 GstSoupHTTPSrc *src;
1714 src = GST_SOUP_HTTP_SRC (bsrc);
1715 GST_DEBUG_OBJECT (src, "unlock()");
1717 src->ret = GST_FLOW_FLUSHING;
1718 gst_soup_http_src_cancel_message (src);
1722 /* Interrupt interrupt. */
1724 gst_soup_http_src_unlock_stop (GstBaseSrc * bsrc)
1726 GstSoupHTTPSrc *src;
1728 src = GST_SOUP_HTTP_SRC (bsrc);
1729 GST_DEBUG_OBJECT (src, "unlock_stop()");
1731 src->ret = GST_FLOW_OK;
1732 g_cancellable_reset (src->cancellable);
1737 gst_soup_http_src_get_size (GstBaseSrc * bsrc, guint64 * size)
1739 GstSoupHTTPSrc *src;
1741 src = GST_SOUP_HTTP_SRC (bsrc);
1743 if (src->have_size) {
1744 GST_DEBUG_OBJECT (src, "get_size() = %" G_GUINT64_FORMAT,
1746 *size = src->content_size;
1749 GST_DEBUG_OBJECT (src, "get_size() = FALSE");
1754 gst_soup_http_src_check_seekable (GstSoupHTTPSrc * src)
1756 GstFlowReturn ret = GST_FLOW_OK;
1758 /* Special case to check if the server allows range requests
1759 * before really starting to get data in the buffer creation
1762 if (!src->got_headers && GST_STATE (src) >= GST_STATE_PAUSED) {
1763 g_mutex_lock (&src->mutex);
1764 while (!src->got_headers && !g_cancellable_is_cancelled (src->cancellable)
1765 && ret == GST_FLOW_OK) {
1766 if ((src->msg && src->msg->method != SOUP_METHOD_HEAD)) {
1767 /* wait for the current request to finish */
1768 g_cond_wait (&src->have_headers_cond, &src->mutex);
1770 if (gst_soup_http_src_session_open (src)) {
1771 ret = gst_soup_http_src_do_request (src, SOUP_METHOD_HEAD);
1775 if (src->ret == GST_FLOW_EOS) {
1776 /* A HEAD request shouldn't lead to EOS */
1777 src->ret = GST_FLOW_OK;
1779 g_mutex_unlock (&src->mutex);
1784 gst_soup_http_src_is_seekable (GstBaseSrc * bsrc)
1786 GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (bsrc);
1788 gst_soup_http_src_check_seekable (src);
1790 return src->seekable;
1794 gst_soup_http_src_do_seek (GstBaseSrc * bsrc, GstSegment * segment)
1796 GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (bsrc);
1798 GST_DEBUG_OBJECT (src, "do_seek(%" G_GUINT64_FORMAT "-%" G_GUINT64_FORMAT
1799 ")", segment->start, segment->stop);
1800 if (src->read_position == segment->start &&
1801 src->request_position == src->read_position &&
1802 src->stop_position == segment->stop) {
1803 GST_DEBUG_OBJECT (src,
1804 "Seek to current read/end position and no seek pending");
1808 gst_soup_http_src_check_seekable (src);
1810 /* If we have no headers we don't know yet if it is seekable or not.
1811 * Store the start position and error out later if it isn't */
1812 if (src->got_headers && !src->seekable) {
1813 GST_WARNING_OBJECT (src, "Not seekable");
1817 if (segment->rate < 0.0 || segment->format != GST_FORMAT_BYTES) {
1818 GST_WARNING_OBJECT (src, "Invalid seek segment");
1822 if (src->have_size && segment->start >= src->content_size) {
1823 GST_WARNING_OBJECT (src,
1824 "Potentially seeking behind end of file, might EOS immediately");
1827 /* Wait for create() to handle the jump in offset. */
1828 src->request_position = segment->start;
1829 src->stop_position = segment->stop;
1835 gst_soup_http_src_query (GstBaseSrc * bsrc, GstQuery * query)
1837 GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (bsrc);
1839 GstSchedulingFlags flags;
1840 gint minsize, maxsize, align;
1842 switch (GST_QUERY_TYPE (query)) {
1844 gst_query_set_uri (query, src->location);
1845 if (src->redirection_uri != NULL) {
1846 gst_query_set_uri_redirection (query, src->redirection_uri);
1847 gst_query_set_uri_redirection_permanent (query,
1848 src->redirection_permanent);
1858 ret = GST_BASE_SRC_CLASS (parent_class)->query (bsrc, query);
1860 switch (GST_QUERY_TYPE (query)) {
1861 case GST_QUERY_SCHEDULING:
1862 gst_query_parse_scheduling (query, &flags, &minsize, &maxsize, &align);
1863 flags |= GST_SCHEDULING_FLAG_BANDWIDTH_LIMITED;
1864 gst_query_set_scheduling (query, flags, minsize, maxsize, align);
1874 gst_soup_http_src_set_location (GstSoupHTTPSrc * src, const gchar * uri,
1877 const char *alt_schemes[] = { "icy://", "icyx://" };
1880 if (src->location) {
1881 g_free (src->location);
1882 src->location = NULL;
1888 for (i = 0; i < G_N_ELEMENTS (alt_schemes); i++) {
1889 if (g_str_has_prefix (uri, alt_schemes[i])) {
1891 g_strdup_printf ("http://%s", uri + strlen (alt_schemes[i]));
1896 if (src->redirection_uri) {
1897 g_free (src->redirection_uri);
1898 src->redirection_uri = NULL;
1901 src->location = g_strdup (uri);
1907 gst_soup_http_src_set_proxy (GstSoupHTTPSrc * src, const gchar * uri)
1910 soup_uri_free (src->proxy);
1914 if (uri == NULL || *uri == '\0')
1917 if (g_str_has_prefix (uri, "http://")) {
1918 src->proxy = soup_uri_new (uri);
1920 gchar *new_uri = g_strconcat ("http://", uri, NULL);
1922 src->proxy = soup_uri_new (new_uri);
1926 return (src->proxy != NULL);
1930 gst_soup_http_src_uri_get_type (GType type)
1935 static const gchar *const *
1936 gst_soup_http_src_uri_get_protocols (GType type)
1938 static const gchar *protocols[] = { "http", "https", "icy", "icyx", NULL };
1944 gst_soup_http_src_uri_get_uri (GstURIHandler * handler)
1946 GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (handler);
1948 /* FIXME: make thread-safe */
1949 return g_strdup (src->location);
1953 gst_soup_http_src_uri_set_uri (GstURIHandler * handler, const gchar * uri,
1956 GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (handler);
1958 return gst_soup_http_src_set_location (src, uri, error);
1962 gst_soup_http_src_uri_handler_init (gpointer g_iface, gpointer iface_data)
1964 GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
1966 iface->get_type = gst_soup_http_src_uri_get_type;
1967 iface->get_protocols = gst_soup_http_src_uri_get_protocols;
1968 iface->get_uri = gst_soup_http_src_uri_get_uri;
1969 iface->set_uri = gst_soup_http_src_uri_set_uri;