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>
80 #include <libsoup/soup.h>
81 #include "gstsouphttpsrc.h"
82 #include "gstsouputils.h"
84 #include <gst/tag/tag.h>
86 GST_DEBUG_CATEGORY_STATIC (souphttpsrc_debug);
87 #define GST_CAT_DEFAULT souphttpsrc_debug
89 static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
100 PROP_AUTOMATIC_REDIRECT,
115 PROP_SSL_USE_SYSTEM_CA_FILE
118 #define DEFAULT_USER_AGENT "GStreamer souphttpsrc "
119 #define DEFAULT_IRADIO_MODE TRUE
120 #define DEFAULT_SOUP_LOG_LEVEL SOUP_LOGGER_LOG_HEADERS
121 #define DEFAULT_COMPRESS FALSE
122 #define DEFAULT_KEEP_ALIVE FALSE
123 #define DEFAULT_SSL_STRICT TRUE
124 #define DEFAULT_SSL_CA_FILE NULL
125 #define DEFAULT_SSL_USE_SYSTEM_CA_FILE TRUE
127 static void gst_soup_http_src_uri_handler_init (gpointer g_iface,
128 gpointer iface_data);
129 static void gst_soup_http_src_finalize (GObject * gobject);
130 static void gst_soup_http_src_dispose (GObject * gobject);
132 static void gst_soup_http_src_set_property (GObject * object, guint prop_id,
133 const GValue * value, GParamSpec * pspec);
134 static void gst_soup_http_src_get_property (GObject * object, guint prop_id,
135 GValue * value, GParamSpec * pspec);
137 static GstStateChangeReturn gst_soup_http_src_change_state (GstElement *
138 element, GstStateChange transition);
139 static GstFlowReturn gst_soup_http_src_create (GstPushSrc * psrc,
140 GstBuffer ** outbuf);
141 static gboolean gst_soup_http_src_start (GstBaseSrc * bsrc);
142 static gboolean gst_soup_http_src_stop (GstBaseSrc * bsrc);
143 static gboolean gst_soup_http_src_get_size (GstBaseSrc * bsrc, guint64 * size);
144 static gboolean gst_soup_http_src_is_seekable (GstBaseSrc * bsrc);
145 static gboolean gst_soup_http_src_do_seek (GstBaseSrc * bsrc,
146 GstSegment * segment);
147 static gboolean gst_soup_http_src_query (GstBaseSrc * bsrc, GstQuery * query);
148 static gboolean gst_soup_http_src_unlock (GstBaseSrc * bsrc);
149 static gboolean gst_soup_http_src_unlock_stop (GstBaseSrc * bsrc);
150 static gboolean gst_soup_http_src_set_location (GstSoupHTTPSrc * src,
151 const gchar * uri, GError ** error);
152 static gboolean gst_soup_http_src_set_proxy (GstSoupHTTPSrc * src,
154 static char *gst_soup_http_src_unicodify (const char *str);
155 static gboolean gst_soup_http_src_build_message (GstSoupHTTPSrc * src,
156 const gchar * method);
157 static void gst_soup_http_src_cancel_message (GstSoupHTTPSrc * src);
158 static void gst_soup_http_src_queue_message (GstSoupHTTPSrc * src);
159 static gboolean gst_soup_http_src_add_range_header (GstSoupHTTPSrc * src,
160 guint64 offset, guint64 stop_offset);
161 static void gst_soup_http_src_session_unpause_message (GstSoupHTTPSrc * src);
162 static void gst_soup_http_src_session_pause_message (GstSoupHTTPSrc * src);
163 static gboolean gst_soup_http_src_session_open (GstSoupHTTPSrc * src);
164 static void gst_soup_http_src_session_close (GstSoupHTTPSrc * src);
165 static void gst_soup_http_src_parse_status (SoupMessage * msg,
166 GstSoupHTTPSrc * src);
167 static void gst_soup_http_src_chunk_free (gpointer gstbuf);
168 static SoupBuffer *gst_soup_http_src_chunk_allocator (SoupMessage * msg,
169 gsize max_len, gpointer user_data);
170 static void gst_soup_http_src_got_chunk_cb (SoupMessage * msg,
171 SoupBuffer * chunk, GstSoupHTTPSrc * src);
172 static void gst_soup_http_src_response_cb (SoupSession * session,
173 SoupMessage * msg, GstSoupHTTPSrc * src);
174 static void gst_soup_http_src_got_headers_cb (SoupMessage * msg,
175 GstSoupHTTPSrc * src);
176 static void gst_soup_http_src_got_body_cb (SoupMessage * msg,
177 GstSoupHTTPSrc * src);
178 static void gst_soup_http_src_finished_cb (SoupMessage * msg,
179 GstSoupHTTPSrc * src);
180 static void gst_soup_http_src_authenticate_cb (SoupSession * session,
181 SoupMessage * msg, SoupAuth * auth, gboolean retrying,
182 GstSoupHTTPSrc * src);
184 #define gst_soup_http_src_parent_class parent_class
185 G_DEFINE_TYPE_WITH_CODE (GstSoupHTTPSrc, gst_soup_http_src, GST_TYPE_PUSH_SRC,
186 G_IMPLEMENT_INTERFACE (GST_TYPE_URI_HANDLER,
187 gst_soup_http_src_uri_handler_init));
190 gst_soup_http_src_class_init (GstSoupHTTPSrcClass * klass)
192 GObjectClass *gobject_class;
193 GstElementClass *gstelement_class;
194 GstBaseSrcClass *gstbasesrc_class;
195 GstPushSrcClass *gstpushsrc_class;
197 gobject_class = (GObjectClass *) klass;
198 gstelement_class = (GstElementClass *) klass;
199 gstbasesrc_class = (GstBaseSrcClass *) klass;
200 gstpushsrc_class = (GstPushSrcClass *) klass;
202 gobject_class->set_property = gst_soup_http_src_set_property;
203 gobject_class->get_property = gst_soup_http_src_get_property;
204 gobject_class->finalize = gst_soup_http_src_finalize;
205 gobject_class->dispose = gst_soup_http_src_dispose;
207 g_object_class_install_property (gobject_class,
209 g_param_spec_string ("location", "Location",
210 "Location to read from", "",
211 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
212 g_object_class_install_property (gobject_class,
214 g_param_spec_string ("user-agent", "User-Agent",
215 "Value of the User-Agent HTTP request header field",
216 DEFAULT_USER_AGENT, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
217 g_object_class_install_property (gobject_class,
218 PROP_AUTOMATIC_REDIRECT,
219 g_param_spec_boolean ("automatic-redirect", "automatic-redirect",
220 "Automatically follow HTTP redirects (HTTP Status Code 3xx)",
221 TRUE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
222 g_object_class_install_property (gobject_class,
224 g_param_spec_string ("proxy", "Proxy",
225 "HTTP proxy server URI", "",
226 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
227 g_object_class_install_property (gobject_class,
229 g_param_spec_string ("user-id", "user-id",
230 "HTTP location URI user id for authentication", "",
231 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
232 g_object_class_install_property (gobject_class, PROP_USER_PW,
233 g_param_spec_string ("user-pw", "user-pw",
234 "HTTP location URI user password for authentication", "",
235 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
236 g_object_class_install_property (gobject_class, PROP_PROXY_ID,
237 g_param_spec_string ("proxy-id", "proxy-id",
238 "HTTP proxy URI user id for authentication", "",
239 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
240 g_object_class_install_property (gobject_class, PROP_PROXY_PW,
241 g_param_spec_string ("proxy-pw", "proxy-pw",
242 "HTTP proxy URI user password for authentication", "",
243 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
244 g_object_class_install_property (gobject_class, PROP_COOKIES,
245 g_param_spec_boxed ("cookies", "Cookies", "HTTP request cookies",
246 G_TYPE_STRV, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
247 g_object_class_install_property (gobject_class, PROP_IS_LIVE,
248 g_param_spec_boolean ("is-live", "is-live", "Act like a live source",
249 FALSE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
250 g_object_class_install_property (gobject_class, PROP_TIMEOUT,
251 g_param_spec_uint ("timeout", "timeout",
252 "Value in seconds to timeout a blocking I/O (0 = No timeout).", 0,
253 3600, 0, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
254 g_object_class_install_property (gobject_class, PROP_EXTRA_HEADERS,
255 g_param_spec_boxed ("extra-headers", "Extra Headers",
256 "Extra headers to append to the HTTP request",
257 GST_TYPE_STRUCTURE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
258 g_object_class_install_property (gobject_class, PROP_IRADIO_MODE,
259 g_param_spec_boolean ("iradio-mode", "iradio-mode",
260 "Enable internet radio mode (ask server to send shoutcast/icecast "
261 "metadata interleaved with the actual stream data)",
262 DEFAULT_IRADIO_MODE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
265 * GstSoupHTTPSrc::http-log-level:
267 * If set and > 0, captures and dumps HTTP session data as
268 * log messages if log level >= GST_LEVEL_TRACE
272 g_object_class_install_property (gobject_class, PROP_SOUP_LOG_LEVEL,
273 g_param_spec_enum ("http-log-level", "HTTP log level",
274 "Set log level for soup's HTTP session log",
275 SOUP_TYPE_LOGGER_LOG_LEVEL, DEFAULT_SOUP_LOG_LEVEL,
276 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
279 * GstSoupHTTPSrc::compress:
281 * If set to %TRUE, souphttpsrc will automatically handle gzip
282 * and deflate Content-Encodings. This does not make much difference
283 * and causes more load for normal media files, but makes a real
284 * difference in size for plaintext files.
288 g_object_class_install_property (gobject_class, PROP_COMPRESS,
289 g_param_spec_boolean ("compress", "Compress",
290 "Allow compressed content encodings",
291 DEFAULT_COMPRESS, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
294 * GstSoupHTTPSrc::keep-alive:
296 * If set to %TRUE, souphttpsrc will keep alive connections when being
297 * set to READY state and only will close connections when connecting
298 * to a different server or when going to NULL state..
302 g_object_class_install_property (gobject_class, PROP_KEEP_ALIVE,
303 g_param_spec_boolean ("keep-alive", "keep-alive",
304 "Use HTTP persistent connections", DEFAULT_KEEP_ALIVE,
305 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
308 * GstSoupHTTPSrc::ssl-strict:
310 * If set to %TRUE, souphttpsrc will reject all SSL certificates that
311 * are considered invalid.
315 g_object_class_install_property (gobject_class, PROP_SSL_STRICT,
316 g_param_spec_boolean ("ssl-strict", "SSL Strict",
317 "Strict SSL certificate checking", DEFAULT_SSL_STRICT,
318 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
321 * GstSoupHTTPSrc::ssl-ca-file:
323 * A SSL anchor CA file that should be used for checking certificates
324 * instead of the system CA file.
328 g_object_class_install_property (gobject_class, PROP_SSL_CA_FILE,
329 g_param_spec_string ("ssl-ca-file", "SSL CA File",
330 "Location of a SSL anchor CA file to use", DEFAULT_SSL_CA_FILE,
331 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
334 * GstSoupHTTPSrc::ssl-use-system-ca-file:
336 * If set to %TRUE, souphttpsrc will use the system's CA file for
337 * checking certificates.
341 g_object_class_install_property (gobject_class, PROP_SSL_USE_SYSTEM_CA_FILE,
342 g_param_spec_boolean ("ssl-use-system-ca-file", "Use System CA File",
343 "Use system CA file", DEFAULT_SSL_USE_SYSTEM_CA_FILE,
344 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
346 gst_element_class_add_pad_template (gstelement_class,
347 gst_static_pad_template_get (&srctemplate));
349 gst_element_class_set_static_metadata (gstelement_class, "HTTP client source",
351 "Receive data as a client over the network via HTTP using SOUP",
352 "Wouter Cloetens <wouter@mind.be>");
353 gstelement_class->change_state =
354 GST_DEBUG_FUNCPTR (gst_soup_http_src_change_state);
356 gstbasesrc_class->start = GST_DEBUG_FUNCPTR (gst_soup_http_src_start);
357 gstbasesrc_class->stop = GST_DEBUG_FUNCPTR (gst_soup_http_src_stop);
358 gstbasesrc_class->unlock = GST_DEBUG_FUNCPTR (gst_soup_http_src_unlock);
359 gstbasesrc_class->unlock_stop =
360 GST_DEBUG_FUNCPTR (gst_soup_http_src_unlock_stop);
361 gstbasesrc_class->get_size = GST_DEBUG_FUNCPTR (gst_soup_http_src_get_size);
362 gstbasesrc_class->is_seekable =
363 GST_DEBUG_FUNCPTR (gst_soup_http_src_is_seekable);
364 gstbasesrc_class->do_seek = GST_DEBUG_FUNCPTR (gst_soup_http_src_do_seek);
365 gstbasesrc_class->query = GST_DEBUG_FUNCPTR (gst_soup_http_src_query);
367 gstpushsrc_class->create = GST_DEBUG_FUNCPTR (gst_soup_http_src_create);
369 GST_DEBUG_CATEGORY_INIT (souphttpsrc_debug, "souphttpsrc", 0,
374 gst_soup_http_src_reset (GstSoupHTTPSrc * src)
376 src->interrupted = FALSE;
378 src->have_size = FALSE;
379 src->got_headers = FALSE;
380 src->seekable = FALSE;
381 src->read_position = 0;
382 src->request_position = 0;
383 src->stop_position = -1;
384 src->content_size = 0;
385 src->have_body = FALSE;
387 src->ret = GST_FLOW_OK;
389 gst_caps_replace (&src->src_caps, NULL);
390 g_free (src->iradio_name);
391 src->iradio_name = NULL;
392 g_free (src->iradio_genre);
393 src->iradio_genre = NULL;
394 g_free (src->iradio_url);
395 src->iradio_url = NULL;
399 gst_soup_http_src_init (GstSoupHTTPSrc * src)
403 g_mutex_init (&src->mutex);
404 g_cond_init (&src->request_finished_cond);
405 src->location = NULL;
406 src->redirection_uri = NULL;
407 src->automatic_redirect = TRUE;
408 src->user_agent = g_strdup (DEFAULT_USER_AGENT);
411 src->proxy_id = NULL;
412 src->proxy_pw = NULL;
414 src->iradio_mode = DEFAULT_IRADIO_MODE;
419 src->log_level = DEFAULT_SOUP_LOG_LEVEL;
420 src->ssl_strict = DEFAULT_SSL_STRICT;
421 src->ssl_use_system_ca_file = DEFAULT_SSL_USE_SYSTEM_CA_FILE;
422 proxy = g_getenv ("http_proxy");
423 if (proxy && !gst_soup_http_src_set_proxy (src, proxy)) {
424 GST_WARNING_OBJECT (src,
425 "The proxy in the http_proxy env var (\"%s\") cannot be parsed.",
429 gst_base_src_set_automatic_eos (GST_BASE_SRC (src), FALSE);
431 gst_soup_http_src_reset (src);
435 gst_soup_http_src_dispose (GObject * gobject)
437 GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (gobject);
439 GST_DEBUG_OBJECT (src, "dispose");
441 gst_soup_http_src_session_close (src);
443 G_OBJECT_CLASS (parent_class)->dispose (gobject);
447 gst_soup_http_src_finalize (GObject * gobject)
449 GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (gobject);
451 GST_DEBUG_OBJECT (src, "finalize");
453 g_mutex_clear (&src->mutex);
454 g_cond_clear (&src->request_finished_cond);
455 g_free (src->location);
456 if (src->redirection_uri) {
457 g_free (src->redirection_uri);
459 g_free (src->user_agent);
460 if (src->proxy != NULL) {
461 soup_uri_free (src->proxy);
463 g_free (src->user_id);
464 g_free (src->user_pw);
465 g_free (src->proxy_id);
466 g_free (src->proxy_pw);
467 g_strfreev (src->cookies);
469 if (src->extra_headers) {
470 gst_structure_free (src->extra_headers);
471 src->extra_headers = NULL;
474 g_free (src->ssl_ca_file);
476 G_OBJECT_CLASS (parent_class)->finalize (gobject);
480 gst_soup_http_src_set_property (GObject * object, guint prop_id,
481 const GValue * value, GParamSpec * pspec)
483 GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (object);
488 const gchar *location;
490 location = g_value_get_string (value);
492 if (location == NULL) {
493 GST_WARNING ("location property cannot be NULL");
496 if (!gst_soup_http_src_set_location (src, location, NULL)) {
497 GST_WARNING ("badly formatted location");
502 case PROP_USER_AGENT:
504 g_free (src->user_agent);
505 src->user_agent = g_value_dup_string (value);
507 case PROP_IRADIO_MODE:
508 src->iradio_mode = g_value_get_boolean (value);
510 case PROP_AUTOMATIC_REDIRECT:
511 src->automatic_redirect = g_value_get_boolean (value);
517 proxy = g_value_get_string (value);
520 GST_WARNING ("proxy property cannot be NULL");
523 if (!gst_soup_http_src_set_proxy (src, proxy)) {
524 GST_WARNING ("badly formatted proxy URI");
530 g_strfreev (src->cookies);
531 src->cookies = g_strdupv (g_value_get_boxed (value));
534 gst_base_src_set_live (GST_BASE_SRC (src), g_value_get_boolean (value));
538 g_free (src->user_id);
539 src->user_id = g_value_dup_string (value);
543 g_free (src->user_pw);
544 src->user_pw = g_value_dup_string (value);
548 g_free (src->proxy_id);
549 src->proxy_id = g_value_dup_string (value);
553 g_free (src->proxy_pw);
554 src->proxy_pw = g_value_dup_string (value);
557 src->timeout = g_value_get_uint (value);
559 case PROP_EXTRA_HEADERS:{
560 const GstStructure *s = gst_value_get_structure (value);
562 if (src->extra_headers)
563 gst_structure_free (src->extra_headers);
565 src->extra_headers = s ? gst_structure_copy (s) : NULL;
568 case PROP_SOUP_LOG_LEVEL:
569 src->log_level = g_value_get_enum (value);
572 src->compress = g_value_get_boolean (value);
574 case PROP_KEEP_ALIVE:
575 src->keep_alive = g_value_get_boolean (value);
577 case PROP_SSL_STRICT:
578 src->ssl_strict = g_value_get_boolean (value);
580 case PROP_SSL_CA_FILE:
581 if (src->ssl_ca_file)
582 g_free (src->ssl_ca_file);
583 src->ssl_ca_file = g_value_dup_string (value);
585 case PROP_SSL_USE_SYSTEM_CA_FILE:
586 src->ssl_use_system_ca_file = g_value_get_boolean (value);
589 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
597 gst_soup_http_src_get_property (GObject * object, guint prop_id,
598 GValue * value, GParamSpec * pspec)
600 GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (object);
604 g_value_set_string (value, src->location);
606 case PROP_USER_AGENT:
607 g_value_set_string (value, src->user_agent);
609 case PROP_AUTOMATIC_REDIRECT:
610 g_value_set_boolean (value, src->automatic_redirect);
613 if (src->proxy == NULL)
614 g_value_set_static_string (value, "");
616 char *proxy = soup_uri_to_string (src->proxy, FALSE);
618 g_value_set_string (value, proxy);
623 g_value_set_boxed (value, g_strdupv (src->cookies));
626 g_value_set_boolean (value, gst_base_src_is_live (GST_BASE_SRC (src)));
628 case PROP_IRADIO_MODE:
629 g_value_set_boolean (value, src->iradio_mode);
632 g_value_set_string (value, src->user_id);
635 g_value_set_string (value, src->user_pw);
638 g_value_set_string (value, src->proxy_id);
641 g_value_set_string (value, src->proxy_pw);
644 g_value_set_uint (value, src->timeout);
646 case PROP_EXTRA_HEADERS:
647 gst_value_set_structure (value, src->extra_headers);
649 case PROP_SOUP_LOG_LEVEL:
650 g_value_set_enum (value, src->log_level);
653 g_value_set_boolean (value, src->compress);
655 case PROP_KEEP_ALIVE:
656 g_value_set_boolean (value, src->keep_alive);
658 case PROP_SSL_STRICT:
659 g_value_set_boolean (value, src->ssl_strict);
661 case PROP_SSL_CA_FILE:
662 g_value_set_string (value, src->ssl_ca_file);
664 case PROP_SSL_USE_SYSTEM_CA_FILE:
665 g_value_set_boolean (value, src->ssl_strict);
668 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
674 gst_soup_http_src_unicodify (const gchar * str)
676 const gchar *env_vars[] = { "GST_ICY_TAG_ENCODING",
677 "GST_TAG_ENCODING", NULL
680 return gst_tag_freeform_string_to_utf8 (str, -1, env_vars);
684 gst_soup_http_src_cancel_message (GstSoupHTTPSrc * src)
686 if (src->msg != NULL) {
687 src->session_io_status = GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_CANCELLED;
688 soup_session_cancel_message (src->session, src->msg, SOUP_STATUS_CANCELLED);
690 src->session_io_status = GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_IDLE;
695 gst_soup_http_src_queue_message (GstSoupHTTPSrc * src)
697 soup_session_queue_message (src->session, src->msg,
698 (SoupSessionCallback) gst_soup_http_src_response_cb, src);
699 src->session_io_status = GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_QUEUED;
703 gst_soup_http_src_add_range_header (GstSoupHTTPSrc * src, guint64 offset,
710 soup_message_headers_remove (src->msg->request_headers, "Range");
711 if (offset || stop_offset != -1) {
712 if (stop_offset != -1) {
713 rc = g_snprintf (buf, sizeof (buf), "bytes=%" G_GUINT64_FORMAT "-%"
714 G_GUINT64_FORMAT, offset, stop_offset);
716 rc = g_snprintf (buf, sizeof (buf), "bytes=%" G_GUINT64_FORMAT "-",
719 if (rc > sizeof (buf) || rc < 0)
721 soup_message_headers_append (src->msg->request_headers, "Range", buf);
723 src->read_position = offset;
728 _append_extra_header (GQuark field_id, const GValue * value, gpointer user_data)
730 GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (user_data);
731 const gchar *field_name = g_quark_to_string (field_id);
732 gchar *field_content = NULL;
734 if (G_VALUE_TYPE (value) == G_TYPE_STRING) {
735 field_content = g_value_dup_string (value);
737 GValue dest = { 0, };
739 g_value_init (&dest, G_TYPE_STRING);
740 if (g_value_transform (value, &dest)) {
741 field_content = g_value_dup_string (&dest);
745 if (field_content == NULL) {
746 GST_ERROR_OBJECT (src, "extra-headers field '%s' contains no value "
747 "or can't be converted to a string", field_name);
751 GST_DEBUG_OBJECT (src, "Appending extra header: \"%s: %s\"", field_name,
753 soup_message_headers_append (src->msg->request_headers, field_name,
756 g_free (field_content);
762 _append_extra_headers (GQuark field_id, const GValue * value,
765 if (G_VALUE_TYPE (value) == GST_TYPE_ARRAY) {
766 guint n = gst_value_array_get_size (value);
769 for (i = 0; i < n; i++) {
770 const GValue *v = gst_value_array_get_value (value, i);
772 if (!_append_extra_header (field_id, v, user_data))
775 } else if (G_VALUE_TYPE (value) == GST_TYPE_LIST) {
776 guint n = gst_value_list_get_size (value);
779 for (i = 0; i < n; i++) {
780 const GValue *v = gst_value_list_get_value (value, i);
782 if (!_append_extra_header (field_id, v, user_data))
786 return _append_extra_header (field_id, value, user_data);
794 gst_soup_http_src_add_extra_headers (GstSoupHTTPSrc * src)
796 if (!src->extra_headers)
799 return gst_structure_foreach (src->extra_headers, _append_extra_headers, src);
804 gst_soup_http_src_session_unpause_message (GstSoupHTTPSrc * src)
806 soup_session_unpause_message (src->session, src->msg);
810 gst_soup_http_src_session_pause_message (GstSoupHTTPSrc * src)
812 soup_session_pause_message (src->session, src->msg);
816 gst_soup_http_src_session_open (GstSoupHTTPSrc * src)
819 GST_DEBUG_OBJECT (src, "Session is already open");
823 if (!src->location) {
824 GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ, (_("No URL set.")),
825 ("Missing location property"));
830 src->context = g_main_context_new ();
833 src->loop = g_main_loop_new (src->context, TRUE);
835 GST_ELEMENT_ERROR (src, LIBRARY, INIT,
836 (NULL), ("Failed to start GMainLoop"));
837 g_main_context_unref (src->context);
842 GST_DEBUG_OBJECT (src, "Creating session");
843 if (src->proxy == NULL) {
845 soup_session_async_new_with_options (SOUP_SESSION_ASYNC_CONTEXT,
846 src->context, SOUP_SESSION_USER_AGENT, src->user_agent,
847 SOUP_SESSION_TIMEOUT, src->timeout,
848 SOUP_SESSION_SSL_STRICT, src->ssl_strict,
849 SOUP_SESSION_ADD_FEATURE_BY_TYPE, SOUP_TYPE_PROXY_RESOLVER_DEFAULT,
853 soup_session_async_new_with_options (SOUP_SESSION_ASYNC_CONTEXT,
854 src->context, SOUP_SESSION_PROXY_URI, src->proxy,
855 SOUP_SESSION_TIMEOUT, src->timeout,
856 SOUP_SESSION_SSL_STRICT, src->ssl_strict,
857 SOUP_SESSION_USER_AGENT, src->user_agent, NULL);
861 GST_ELEMENT_ERROR (src, LIBRARY, INIT,
862 (NULL), ("Failed to create async session"));
866 g_signal_connect (src->session, "authenticate",
867 G_CALLBACK (gst_soup_http_src_authenticate_cb), src);
870 gst_soup_util_log_setup (src->session, src->log_level, GST_ELEMENT (src));
871 if (src->ssl_ca_file)
872 g_object_set (src->session, "ssl-ca-file", src->ssl_ca_file, NULL);
874 g_object_set (src->session, "ssl-use-system-ca-file",
875 src->ssl_use_system_ca_file, NULL);
877 GST_DEBUG_OBJECT (src, "Re-using session");
881 soup_session_add_feature_by_type (src->session, SOUP_TYPE_CONTENT_DECODER);
883 soup_session_remove_feature_by_type (src->session,
884 SOUP_TYPE_CONTENT_DECODER);
890 gst_soup_http_src_session_close (GstSoupHTTPSrc * src)
893 soup_session_abort (src->session); /* This unrefs the message. */
894 g_object_unref (src->session);
899 g_main_loop_unref (src->loop);
900 g_main_context_unref (src->context);
907 gst_soup_http_src_authenticate_cb (SoupSession * session, SoupMessage * msg,
908 SoupAuth * auth, gboolean retrying, GstSoupHTTPSrc * src)
911 /* First time authentication only, if we fail and are called again with retry true fall through */
912 if (msg->status_code == SOUP_STATUS_UNAUTHORIZED) {
913 if (src->user_id && src->user_pw)
914 soup_auth_authenticate (auth, src->user_id, src->user_pw);
915 } else if (msg->status_code == SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED) {
916 if (src->proxy_id && src->proxy_pw)
917 soup_auth_authenticate (auth, src->proxy_id, src->proxy_pw);
923 gst_soup_http_src_got_headers_cb (SoupMessage * msg, GstSoupHTTPSrc * src)
926 GstTagList *tag_list;
929 GHashTable *params = NULL;
931 GST_INFO_OBJECT (src, "got headers");
933 if (msg->status_code == SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED &&
934 src->proxy_id && src->proxy_pw)
937 if (src->automatic_redirect && SOUP_STATUS_IS_REDIRECTION (msg->status_code)) {
938 src->redirection_uri = g_strdup (soup_message_headers_get_one
939 (msg->response_headers, "Location"));
940 GST_DEBUG_OBJECT (src, "%u redirect to \"%s\"", msg->status_code,
941 src->redirection_uri);
945 if (msg->status_code == SOUP_STATUS_UNAUTHORIZED)
948 src->session_io_status = GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_RUNNING;
949 src->got_headers = TRUE;
951 /* Parse Content-Length. */
952 if (soup_message_headers_get_encoding (msg->response_headers) ==
953 SOUP_ENCODING_CONTENT_LENGTH) {
954 newsize = src->request_position +
955 soup_message_headers_get_content_length (msg->response_headers);
956 if (!src->have_size || (src->content_size != newsize)) {
957 src->content_size = newsize;
958 src->have_size = TRUE;
959 src->seekable = TRUE;
960 GST_DEBUG_OBJECT (src, "size = %" G_GUINT64_FORMAT, src->content_size);
962 basesrc = GST_BASE_SRC_CAST (src);
963 basesrc->segment.duration = src->content_size;
964 gst_element_post_message (GST_ELEMENT (src),
965 gst_message_new_duration_changed (GST_OBJECT (src)));
970 tag_list = gst_tag_list_new_empty ();
973 soup_message_headers_get_one (msg->response_headers,
974 "icy-metaint")) != NULL) {
975 gint icy_metaint = atoi (value);
977 GST_DEBUG_OBJECT (src, "icy-metaint: %s (parsed: %d)", value, icy_metaint);
978 if (icy_metaint > 0) {
980 gst_caps_unref (src->src_caps);
982 src->src_caps = gst_caps_new_simple ("application/x-icy",
983 "metadata-interval", G_TYPE_INT, icy_metaint, NULL);
985 gst_base_src_set_caps (GST_BASE_SRC (src), src->src_caps);
989 soup_message_headers_get_content_type (msg->response_headers,
991 GST_DEBUG_OBJECT (src, "Content-Type: %s", value);
992 if (g_ascii_strcasecmp (value, "audio/L16") == 0) {
998 gst_caps_unref (src->src_caps);
1000 param = g_hash_table_lookup (params, "channels");
1002 channels = atol (param);
1004 param = g_hash_table_lookup (params, "rate");
1006 rate = atol (param);
1008 src->src_caps = gst_caps_new_simple ("audio/x-raw",
1009 "format", G_TYPE_STRING, "S16BE",
1010 "layout", G_TYPE_STRING, "interleaved",
1011 "channels", G_TYPE_INT, channels, "rate", G_TYPE_INT, rate, NULL);
1013 gst_base_src_set_caps (GST_BASE_SRC (src), src->src_caps);
1015 /* Set the Content-Type field on the caps */
1016 if (src->src_caps) {
1017 src->src_caps = gst_caps_make_writable (src->src_caps);
1018 gst_caps_set_simple (src->src_caps, "content-type", G_TYPE_STRING,
1020 gst_base_src_set_caps (GST_BASE_SRC (src), src->src_caps);
1026 g_hash_table_destroy (params);
1029 soup_message_headers_get_one (msg->response_headers,
1030 "icy-name")) != NULL) {
1031 g_free (src->iradio_name);
1032 src->iradio_name = gst_soup_http_src_unicodify (value);
1033 if (src->iradio_name) {
1034 gst_tag_list_add (tag_list, GST_TAG_MERGE_REPLACE, GST_TAG_ORGANIZATION,
1035 src->iradio_name, NULL);
1039 soup_message_headers_get_one (msg->response_headers,
1040 "icy-genre")) != NULL) {
1041 g_free (src->iradio_genre);
1042 src->iradio_genre = gst_soup_http_src_unicodify (value);
1043 if (src->iradio_genre) {
1044 gst_tag_list_add (tag_list, GST_TAG_MERGE_REPLACE, GST_TAG_GENRE,
1045 src->iradio_genre, NULL);
1048 if ((value = soup_message_headers_get_one (msg->response_headers, "icy-url"))
1050 g_free (src->iradio_url);
1051 src->iradio_url = gst_soup_http_src_unicodify (value);
1052 if (src->iradio_url) {
1053 gst_tag_list_add (tag_list, GST_TAG_MERGE_REPLACE, GST_TAG_LOCATION,
1054 src->iradio_url, NULL);
1057 if (!gst_tag_list_is_empty (tag_list)) {
1058 GST_DEBUG_OBJECT (src,
1059 "calling gst_element_found_tags with %" GST_PTR_FORMAT, tag_list);
1060 gst_pad_push_event (GST_BASE_SRC_PAD (src), gst_event_new_tag (tag_list));
1062 gst_tag_list_unref (tag_list);
1065 /* Handle HTTP errors. */
1066 gst_soup_http_src_parse_status (msg, src);
1068 /* Check if Range header was respected. */
1069 if (src->ret == GST_FLOW_CUSTOM_ERROR &&
1070 src->read_position && msg->status_code != SOUP_STATUS_PARTIAL_CONTENT) {
1071 src->seekable = FALSE;
1072 GST_ELEMENT_ERROR (src, RESOURCE, SEEK,
1073 (_("Server does not support seeking.")),
1074 ("Server does not accept Range HTTP header, URL: %s", src->location));
1075 src->ret = GST_FLOW_ERROR;
1078 /* If we are going to error out, stop all processing right here, so we
1079 * don't output any data (such as an error html page), and return
1080 * GST_FLOW_ERROR from the create function instead of having
1081 * got_chunk_cb overwrite src->ret with FLOW_OK again. */
1082 if (src->ret == GST_FLOW_ERROR || src->ret == GST_FLOW_EOS) {
1083 gst_soup_http_src_session_pause_message (src);
1086 g_main_loop_quit (src->loop);
1088 g_cond_signal (&src->request_finished_cond);
1091 /* Have body. Signal EOS. */
1093 gst_soup_http_src_got_body_cb (SoupMessage * msg, GstSoupHTTPSrc * src)
1095 if (G_UNLIKELY (msg != src->msg)) {
1096 GST_DEBUG_OBJECT (src, "got body, but not for current message");
1099 if (G_UNLIKELY (src->session_io_status !=
1100 GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_RUNNING)) {
1101 /* Probably a redirect. */
1104 GST_DEBUG_OBJECT (src, "got body");
1105 src->ret = GST_FLOW_EOS;
1106 src->have_body = TRUE;
1108 /* no need to interrupt the message here, we do it on the
1109 * finished_cb anyway if needed. And getting the body might mean
1110 * that the connection was hang up before finished. This happens when
1111 * the pipeline is stalled for too long (long pauses during playback).
1112 * Best to let it continue from here and pause because it reached the
1113 * final bytes based on content_size or received an out of range error */
1116 /* Finished. Signal EOS. */
1118 gst_soup_http_src_finished_cb (SoupMessage * msg, GstSoupHTTPSrc * src)
1120 if (G_UNLIKELY (msg != src->msg)) {
1121 GST_DEBUG_OBJECT (src, "finished, but not for current message");
1124 GST_DEBUG_OBJECT (src, "finished");
1125 src->ret = GST_FLOW_EOS;
1126 if (src->session_io_status == GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_CANCELLED) {
1127 /* gst_soup_http_src_cancel_message() triggered this; probably a seek
1128 * that occurred in the QUEUEING state; i.e. before the connection setup
1129 * was complete. Do nothing */
1130 } else if (src->session_io_status ==
1131 GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_RUNNING && src->read_position > 0 &&
1132 (src->have_size && src->read_position < src->content_size)) {
1133 /* The server disconnected while streaming. Reconnect and seeking to the
1136 src->ret = GST_FLOW_CUSTOM_ERROR;
1137 } else if (G_UNLIKELY (src->session_io_status !=
1138 GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_RUNNING)) {
1139 if (msg->method == SOUP_METHOD_HEAD) {
1140 GST_DEBUG_OBJECT (src, "Ignoring error %d:%s during HEAD request",
1141 msg->status_code, msg->reason_phrase);
1143 gst_soup_http_src_parse_status (msg, src);
1147 g_main_loop_quit (src->loop);
1148 g_cond_signal (&src->request_finished_cond);
1151 /* Buffer lifecycle management.
1153 * gst_soup_http_src_create() runs the GMainLoop for this element, to let
1154 * Soup take control.
1155 * A GstBuffer is allocated in gst_soup_http_src_chunk_allocator() and
1156 * associated with a SoupBuffer.
1157 * Soup reads HTTP data in the GstBuffer's data buffer.
1158 * The gst_soup_http_src_got_chunk_cb() is then called with the SoupBuffer.
1159 * That sets gst_soup_http_src_create()'s return argument to the GstBuffer,
1160 * increments its refcount (to 2), pauses the flow of data from the HTTP
1161 * source to prevent gst_soup_http_src_got_chunk_cb() from being called
1162 * again and breaks out of the GMainLoop.
1163 * Because the SOUP_MESSAGE_OVERWRITE_CHUNKS flag is set, Soup frees the
1164 * SoupBuffer and calls gst_soup_http_src_chunk_free(), which decrements the
1166 * gst_soup_http_src_create() returns the GstBuffer. It will be freed by a
1167 * downstream element.
1168 * If Soup fails to read HTTP data, it does not call
1169 * gst_soup_http_src_got_chunk_cb(), but still frees the SoupBuffer and
1170 * calls gst_soup_http_src_chunk_free(), which decrements the GstBuffer's
1171 * refcount to 0, freeing it.
1181 gst_soup_http_src_chunk_free (gpointer user_data)
1183 SoupGstChunk *chunk = (SoupGstChunk *) user_data;
1185 gst_buffer_unmap (chunk->buffer, &chunk->map);
1186 gst_buffer_unref (chunk->buffer);
1187 g_slice_free (SoupGstChunk, chunk);
1191 gst_soup_http_src_chunk_allocator (SoupMessage * msg, gsize max_len,
1194 GstSoupHTTPSrc *src = (GstSoupHTTPSrc *) user_data;
1195 GstBaseSrc *basesrc = GST_BASE_SRC_CAST (src);
1197 SoupBuffer *soupbuf;
1200 SoupGstChunk *chunk;
1203 length = MIN (basesrc->blocksize, max_len);
1205 length = basesrc->blocksize;
1206 GST_DEBUG_OBJECT (src, "alloc %" G_GSIZE_FORMAT " bytes <= %" G_GSIZE_FORMAT,
1209 rc = GST_BASE_SRC_CLASS (parent_class)->alloc (basesrc, -1, length, &gstbuf);
1210 if (G_UNLIKELY (rc != GST_FLOW_OK)) {
1211 /* Failed to allocate buffer. Stall SoupSession and return error code
1214 g_main_loop_quit (src->loop);
1218 chunk = g_slice_new0 (SoupGstChunk);
1219 chunk->buffer = gstbuf;
1220 gst_buffer_map (gstbuf, &chunk->map, GST_MAP_READWRITE);
1222 soupbuf = soup_buffer_new_with_owner (chunk->map.data, chunk->map.size,
1223 chunk, gst_soup_http_src_chunk_free);
1229 gst_soup_http_src_got_chunk_cb (SoupMessage * msg, SoupBuffer * chunk,
1230 GstSoupHTTPSrc * src)
1232 GstBaseSrc *basesrc;
1233 guint64 new_position;
1234 SoupGstChunk *gchunk;
1236 if (G_UNLIKELY (msg != src->msg)) {
1237 GST_DEBUG_OBJECT (src, "got chunk, but not for current message");
1240 if (G_UNLIKELY (!src->outbuf)) {
1241 GST_DEBUG_OBJECT (src, "got chunk but we're not expecting one");
1242 src->ret = GST_FLOW_OK;
1243 gst_soup_http_src_cancel_message (src);
1244 g_main_loop_quit (src->loop);
1248 src->have_body = FALSE;
1249 if (G_UNLIKELY (src->session_io_status !=
1250 GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_RUNNING)) {
1251 /* Probably a redirect. */
1254 basesrc = GST_BASE_SRC_CAST (src);
1255 GST_DEBUG_OBJECT (src, "got chunk of %" G_GSIZE_FORMAT " bytes",
1258 /* Extract the GstBuffer from the SoupBuffer and set its fields. */
1259 gchunk = (SoupGstChunk *) soup_buffer_get_owner (chunk);
1260 *src->outbuf = gchunk->buffer;
1262 gst_buffer_resize (*src->outbuf, 0, chunk->length);
1263 GST_BUFFER_OFFSET (*src->outbuf) = basesrc->segment.position;
1265 gst_buffer_ref (*src->outbuf);
1267 new_position = src->read_position + chunk->length;
1268 if (G_LIKELY (src->request_position == src->read_position))
1269 src->request_position = new_position;
1270 src->read_position = new_position;
1272 if (src->have_size) {
1273 if (new_position > src->content_size) {
1274 GST_DEBUG_OBJECT (src, "Got position previous estimated content size "
1275 "(%" G_GINT64_FORMAT " > %" G_GINT64_FORMAT ")", new_position,
1277 src->content_size = new_position;
1278 basesrc->segment.duration = src->content_size;
1279 gst_element_post_message (GST_ELEMENT (src),
1280 gst_message_new_duration_changed (GST_OBJECT (src)));
1281 } else if (new_position == src->content_size) {
1282 GST_DEBUG_OBJECT (src, "We're EOS now");
1286 src->ret = GST_FLOW_OK;
1287 g_main_loop_quit (src->loop);
1288 gst_soup_http_src_session_pause_message (src);
1292 gst_soup_http_src_response_cb (SoupSession * session, SoupMessage * msg,
1293 GstSoupHTTPSrc * src)
1295 if (G_UNLIKELY (msg != src->msg)) {
1296 GST_DEBUG_OBJECT (src, "got response %d: %s, but not for current message",
1297 msg->status_code, msg->reason_phrase);
1300 if (G_UNLIKELY (src->session_io_status !=
1301 GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_RUNNING)
1302 && SOUP_STATUS_IS_REDIRECTION (msg->status_code)) {
1303 /* Ignore redirections. */
1306 GST_DEBUG_OBJECT (src, "got response %d: %s", msg->status_code,
1307 msg->reason_phrase);
1308 if (src->session_io_status == GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_RUNNING &&
1309 src->read_position > 0 && (src->have_size
1310 && src->read_position < src->content_size)) {
1311 /* The server disconnected while streaming. Reconnect and seeking to the
1315 gst_soup_http_src_parse_status (msg, src);
1316 /* The session's SoupMessage object expires after this callback returns. */
1318 g_main_loop_quit (src->loop);
1321 #define SOUP_HTTP_SRC_ERROR(src,soup_msg,cat,code,error_message) \
1322 GST_ELEMENT_ERROR ((src), cat, code, ("%s", error_message), \
1323 ("%s (%d), URL: %s", (soup_msg)->reason_phrase, \
1324 (soup_msg)->status_code, (src)->location));
1327 gst_soup_http_src_parse_status (SoupMessage * msg, GstSoupHTTPSrc * src)
1329 if (msg->method == SOUP_METHOD_HEAD) {
1330 if (!SOUP_STATUS_IS_SUCCESSFUL (msg->status_code))
1331 GST_DEBUG_OBJECT (src, "Ignoring error %d during HEAD request",
1333 } else if (SOUP_STATUS_IS_TRANSPORT_ERROR (msg->status_code)) {
1334 switch (msg->status_code) {
1335 case SOUP_STATUS_CANT_RESOLVE:
1336 case SOUP_STATUS_CANT_RESOLVE_PROXY:
1337 SOUP_HTTP_SRC_ERROR (src, msg, RESOURCE, NOT_FOUND,
1338 _("Could not resolve server name."));
1339 src->ret = GST_FLOW_ERROR;
1341 case SOUP_STATUS_CANT_CONNECT:
1342 case SOUP_STATUS_CANT_CONNECT_PROXY:
1343 SOUP_HTTP_SRC_ERROR (src, msg, RESOURCE, OPEN_READ,
1344 _("Could not establish connection to server."));
1345 src->ret = GST_FLOW_ERROR;
1347 case SOUP_STATUS_SSL_FAILED:
1348 SOUP_HTTP_SRC_ERROR (src, msg, RESOURCE, OPEN_READ,
1349 _("Secure connection setup failed."));
1350 src->ret = GST_FLOW_ERROR;
1352 case SOUP_STATUS_IO_ERROR:
1353 SOUP_HTTP_SRC_ERROR (src, msg, RESOURCE, READ,
1354 _("A network error occured, or the server closed the connection "
1356 src->ret = GST_FLOW_ERROR;
1358 case SOUP_STATUS_MALFORMED:
1359 SOUP_HTTP_SRC_ERROR (src, msg, RESOURCE, READ,
1360 _("Server sent bad data."));
1361 src->ret = GST_FLOW_ERROR;
1363 case SOUP_STATUS_CANCELLED:
1364 /* No error message when interrupted by program. */
1367 } else if (SOUP_STATUS_IS_CLIENT_ERROR (msg->status_code) ||
1368 SOUP_STATUS_IS_REDIRECTION (msg->status_code) ||
1369 SOUP_STATUS_IS_SERVER_ERROR (msg->status_code)) {
1370 /* Report HTTP error. */
1372 /* when content_size is unknown and we have just finished receiving
1373 * a body message, requests that go beyond the content limits will result
1374 * in an error. Here we convert those to EOS */
1375 if (msg->status_code == SOUP_STATUS_REQUESTED_RANGE_NOT_SATISFIABLE &&
1376 src->have_body && !src->have_size) {
1377 GST_DEBUG_OBJECT (src, "Requested range out of limits and received full "
1378 "body, returning EOS");
1379 src->ret = GST_FLOW_EOS;
1383 /* FIXME: reason_phrase is not translated and not suitable for user
1384 * error dialog according to libsoup documentation.
1386 if (msg->status_code == SOUP_STATUS_NOT_FOUND) {
1387 GST_ELEMENT_ERROR (src, RESOURCE, NOT_FOUND,
1388 ("%s", msg->reason_phrase),
1389 ("%s (%d), URL: %s", msg->reason_phrase, msg->status_code,
1391 } else if (msg->status_code == SOUP_STATUS_UNAUTHORIZED ||
1392 msg->status_code == SOUP_STATUS_PAYMENT_REQUIRED ||
1393 msg->status_code == SOUP_STATUS_FORBIDDEN ||
1394 msg->status_code == SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED) {
1395 GST_ELEMENT_ERROR (src, RESOURCE, NOT_AUTHORIZED,
1396 ("%s", msg->reason_phrase),
1397 ("%s (%d), URL: %s", msg->reason_phrase, msg->status_code,
1400 GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ,
1401 ("%s", msg->reason_phrase),
1402 ("%s (%d), URL: %s", msg->reason_phrase, msg->status_code,
1405 src->ret = GST_FLOW_ERROR;
1410 gst_soup_http_src_build_message (GstSoupHTTPSrc * src, const gchar * method)
1412 src->msg = soup_message_new (method, src->location);
1414 GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ,
1415 ("Error parsing URL."), ("URL: %s", src->location));
1418 src->session_io_status = GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_IDLE;
1419 if (!src->keep_alive) {
1420 soup_message_headers_append (src->msg->request_headers, "Connection",
1423 if (src->iradio_mode) {
1424 soup_message_headers_append (src->msg->request_headers, "icy-metadata",
1430 for (cookie = src->cookies; *cookie != NULL; cookie++) {
1431 soup_message_headers_append (src->msg->request_headers, "Cookie",
1437 g_signal_connect (src->msg, "got_headers",
1438 G_CALLBACK (gst_soup_http_src_got_headers_cb), src);
1439 g_signal_connect (src->msg, "got_body",
1440 G_CALLBACK (gst_soup_http_src_got_body_cb), src);
1441 g_signal_connect (src->msg, "finished",
1442 G_CALLBACK (gst_soup_http_src_finished_cb), src);
1443 g_signal_connect (src->msg, "got_chunk",
1444 G_CALLBACK (gst_soup_http_src_got_chunk_cb), src);
1445 soup_message_set_flags (src->msg, SOUP_MESSAGE_OVERWRITE_CHUNKS |
1446 (src->automatic_redirect ? 0 : SOUP_MESSAGE_NO_REDIRECT));
1447 soup_message_set_chunk_allocator (src->msg,
1448 gst_soup_http_src_chunk_allocator, src, NULL);
1449 gst_soup_http_src_add_range_header (src, src->request_position,
1450 src->stop_position);
1452 gst_soup_http_src_add_extra_headers (src);
1457 static GstFlowReturn
1458 gst_soup_http_src_do_request (GstSoupHTTPSrc * src, const gchar * method,
1459 GstBuffer ** outbuf)
1461 /* If we're not OK, just go out of here */
1462 if (src->ret != GST_FLOW_OK) {
1463 GST_DEBUG_OBJECT (src, "Previous flow return not OK: %s",
1464 gst_flow_get_name (src->ret));
1468 GST_LOG_OBJECT (src, "Running request for method: %s", method);
1469 if (src->msg && (src->request_position != src->read_position)) {
1470 if (src->session_io_status == GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_IDLE) {
1471 gst_soup_http_src_add_range_header (src, src->request_position,
1472 src->stop_position);
1474 GST_DEBUG_OBJECT (src, "Seek from position %" G_GUINT64_FORMAT
1475 " to %" G_GUINT64_FORMAT ": requeueing connection request",
1476 src->read_position, src->request_position);
1477 gst_soup_http_src_cancel_message (src);
1481 if (!gst_soup_http_src_build_message (src, method)) {
1482 return GST_FLOW_ERROR;
1485 src->ret = GST_FLOW_CUSTOM_ERROR;
1486 src->outbuf = outbuf;
1488 if (src->interrupted) {
1489 GST_DEBUG_OBJECT (src, "interrupted");
1490 src->ret = GST_FLOW_FLUSHING;
1494 GST_DEBUG_OBJECT (src, "Reconnecting");
1495 if (!gst_soup_http_src_build_message (src, method)) {
1496 return GST_FLOW_ERROR;
1502 GST_DEBUG_OBJECT (src, "EOS reached");
1506 switch (src->session_io_status) {
1507 case GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_IDLE:
1508 GST_DEBUG_OBJECT (src, "Queueing connection request");
1509 gst_soup_http_src_queue_message (src);
1511 case GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_QUEUED:
1513 case GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_RUNNING:
1514 gst_soup_http_src_session_unpause_message (src);
1516 case GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_CANCELLED:
1521 if (src->ret == GST_FLOW_CUSTOM_ERROR)
1522 g_main_loop_run (src->loop);
1524 } while (src->ret == GST_FLOW_CUSTOM_ERROR);
1526 /* Let the request finish if we had a stop position and are there */
1527 if (src->ret == GST_FLOW_OK && src->stop_position != -1
1528 && src->read_position >= src->stop_position) {
1530 gst_soup_http_src_session_unpause_message (src);
1531 g_main_loop_run (src->loop);
1533 g_cond_signal (&src->request_finished_cond);
1534 /* Return OK unconditionally here, src->ret will
1535 * be most likely be EOS now but we want to
1536 * consume the buffer we got above */
1540 if (src->ret == GST_FLOW_CUSTOM_ERROR)
1541 src->ret = GST_FLOW_EOS;
1542 g_cond_signal (&src->request_finished_cond);
1547 static GstFlowReturn
1548 gst_soup_http_src_create (GstPushSrc * psrc, GstBuffer ** outbuf)
1550 GstSoupHTTPSrc *src;
1553 src = GST_SOUP_HTTP_SRC (psrc);
1555 g_mutex_lock (&src->mutex);
1557 ret = gst_soup_http_src_do_request (src, SOUP_METHOD_GET, outbuf);
1558 g_mutex_unlock (&src->mutex);
1563 gst_soup_http_src_start (GstBaseSrc * bsrc)
1565 GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (bsrc);
1567 GST_DEBUG_OBJECT (src, "start(\"%s\")", src->location);
1569 return gst_soup_http_src_session_open (src);
1573 gst_soup_http_src_stop (GstBaseSrc * bsrc)
1575 GstSoupHTTPSrc *src;
1577 src = GST_SOUP_HTTP_SRC (bsrc);
1578 GST_DEBUG_OBJECT (src, "stop()");
1579 if (src->keep_alive)
1580 gst_soup_http_src_cancel_message (src);
1582 gst_soup_http_src_session_close (src);
1584 gst_soup_http_src_reset (src);
1588 static GstStateChangeReturn
1589 gst_soup_http_src_change_state (GstElement * element, GstStateChange transition)
1591 GstStateChangeReturn ret;
1592 GstSoupHTTPSrc *src;
1594 src = GST_SOUP_HTTP_SRC (element);
1596 switch (transition) {
1597 case GST_STATE_CHANGE_READY_TO_NULL:
1598 gst_soup_http_src_session_close (src);
1604 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
1609 /* Interrupt a blocking request. */
1611 gst_soup_http_src_unlock (GstBaseSrc * bsrc)
1613 GstSoupHTTPSrc *src;
1615 src = GST_SOUP_HTTP_SRC (bsrc);
1616 GST_DEBUG_OBJECT (src, "unlock()");
1618 src->interrupted = TRUE;
1619 src->ret = GST_FLOW_FLUSHING;
1621 g_main_loop_quit (src->loop);
1622 g_cond_signal (&src->request_finished_cond);
1626 /* Interrupt interrupt. */
1628 gst_soup_http_src_unlock_stop (GstBaseSrc * bsrc)
1630 GstSoupHTTPSrc *src;
1632 src = GST_SOUP_HTTP_SRC (bsrc);
1633 GST_DEBUG_OBJECT (src, "unlock_stop()");
1635 src->interrupted = FALSE;
1636 src->ret = GST_FLOW_OK;
1641 gst_soup_http_src_get_size (GstBaseSrc * bsrc, guint64 * size)
1643 GstSoupHTTPSrc *src;
1645 src = GST_SOUP_HTTP_SRC (bsrc);
1647 if (src->have_size) {
1648 GST_DEBUG_OBJECT (src, "get_size() = %" G_GUINT64_FORMAT,
1650 *size = src->content_size;
1653 GST_DEBUG_OBJECT (src, "get_size() = FALSE");
1658 gst_soup_http_src_check_seekable (GstSoupHTTPSrc * src)
1660 GstFlowReturn ret = GST_FLOW_OK;
1662 /* Special case to check if the server allows range requests
1663 * before really starting to get data in the buffer creation
1666 if (!src->got_headers && GST_STATE (src) >= GST_STATE_PAUSED) {
1667 g_mutex_lock (&src->mutex);
1668 while (!src->got_headers && !src->interrupted && ret == GST_FLOW_OK) {
1669 if ((src->msg && src->msg->method != SOUP_METHOD_HEAD) &&
1670 src->session_io_status != GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_IDLE) {
1671 /* wait for the current request to finish */
1672 g_cond_wait (&src->request_finished_cond, &src->mutex);
1674 if (gst_soup_http_src_session_open (src)) {
1675 ret = gst_soup_http_src_do_request (src, SOUP_METHOD_HEAD, NULL);
1679 if (src->ret == GST_FLOW_EOS) {
1680 /* A HEAD request shouldn't lead to EOS */
1681 src->ret = GST_FLOW_OK;
1683 /* resets status to idle */
1684 gst_soup_http_src_cancel_message (src);
1685 g_mutex_unlock (&src->mutex);
1691 gst_soup_http_src_is_seekable (GstBaseSrc * bsrc)
1693 GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (bsrc);
1695 gst_soup_http_src_check_seekable (src);
1697 return src->seekable;
1701 gst_soup_http_src_do_seek (GstBaseSrc * bsrc, GstSegment * segment)
1703 GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (bsrc);
1705 GST_DEBUG_OBJECT (src, "do_seek(%" G_GUINT64_FORMAT "-%" G_GUINT64_FORMAT
1706 ")", segment->start, segment->stop);
1707 if (src->read_position == segment->start &&
1708 src->request_position == src->read_position &&
1709 src->stop_position == segment->stop) {
1710 GST_DEBUG_OBJECT (src,
1711 "Seek to current read/end position and no seek pending");
1715 gst_soup_http_src_check_seekable (src);
1717 /* If we have no headers we don't know yet if it is seekable or not.
1718 * Store the start position and error out later if it isn't */
1719 if (src->got_headers && !src->seekable) {
1720 GST_WARNING_OBJECT (src, "Not seekable");
1724 if (segment->rate < 0.0 || segment->format != GST_FORMAT_BYTES) {
1725 GST_WARNING_OBJECT (src, "Invalid seek segment");
1729 if (src->have_size && segment->start >= src->content_size) {
1730 GST_WARNING_OBJECT (src,
1731 "Potentially seeking behind end of file, might EOS immediately");
1734 /* Wait for create() to handle the jump in offset. */
1735 src->request_position = segment->start;
1736 src->stop_position = segment->stop;
1742 gst_soup_http_src_query (GstBaseSrc * bsrc, GstQuery * query)
1744 GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (bsrc);
1746 GstSchedulingFlags flags;
1747 gint minsize, maxsize, align;
1749 switch (GST_QUERY_TYPE (query)) {
1751 gst_query_set_uri (query, src->location);
1752 if (src->redirection_uri != NULL)
1753 gst_query_set_uri_redirection (query, src->redirection_uri);
1762 ret = GST_BASE_SRC_CLASS (parent_class)->query (bsrc, query);
1764 switch (GST_QUERY_TYPE (query)) {
1765 case GST_QUERY_SCHEDULING:
1766 gst_query_parse_scheduling (query, &flags, &minsize, &maxsize, &align);
1767 flags |= GST_SCHEDULING_FLAG_BANDWIDTH_LIMITED;
1768 gst_query_set_scheduling (query, flags, minsize, maxsize, align);
1778 gst_soup_http_src_set_location (GstSoupHTTPSrc * src, const gchar * uri,
1781 const char *alt_schemes[] = { "icy://", "icyx://" };
1784 if (src->location) {
1785 g_free (src->location);
1786 src->location = NULL;
1792 for (i = 0; i < G_N_ELEMENTS (alt_schemes); i++) {
1793 if (g_str_has_prefix (uri, alt_schemes[i])) {
1795 g_strdup_printf ("http://%s", uri + strlen (alt_schemes[i]));
1800 if (src->redirection_uri) {
1801 g_free (src->redirection_uri);
1802 src->redirection_uri = NULL;
1805 src->location = g_strdup (uri);
1811 gst_soup_http_src_set_proxy (GstSoupHTTPSrc * src, const gchar * uri)
1814 soup_uri_free (src->proxy);
1817 if (g_str_has_prefix (uri, "http://")) {
1818 src->proxy = soup_uri_new (uri);
1820 gchar *new_uri = g_strconcat ("http://", uri, NULL);
1822 src->proxy = soup_uri_new (new_uri);
1830 gst_soup_http_src_uri_get_type (GType type)
1835 static const gchar *const *
1836 gst_soup_http_src_uri_get_protocols (GType type)
1838 static const gchar *protocols[] = { "http", "https", "icy", "icyx", NULL };
1844 gst_soup_http_src_uri_get_uri (GstURIHandler * handler)
1846 GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (handler);
1848 /* FIXME: make thread-safe */
1849 return g_strdup (src->location);
1853 gst_soup_http_src_uri_set_uri (GstURIHandler * handler, const gchar * uri,
1856 GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (handler);
1858 return gst_soup_http_src_set_location (src, uri, error);
1862 gst_soup_http_src_uri_handler_init (gpointer g_iface, gpointer iface_data)
1864 GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
1866 iface->get_type = gst_soup_http_src_uri_get_type;
1867 iface->get_protocols = gst_soup_http_src_uri_get_protocols;
1868 iface->get_uri = gst_soup_http_src_uri_get_uri;
1869 iface->set_uri = gst_soup_http_src_uri_set_uri;