ext/soup/gstsouphttpsrc.c

   1 /* GStreamer
   2  * Copyright (C) 2007-2008 Wouter Cloetens <wouter@mind.be>
   3  *
   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.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more
  13  */
  14
  15 /**
  16  * SECTION:element-souphttpsrc
  17  *
  18  * This plugin reads data from a remote location specified by a URI.
  19  * Supported protocols are 'http', 'https'.
  20  *
  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.
  26  *
  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.
  35  *
  36  * <refsect2>
  37  * <title>Example launch line</title>
  38  * |[
  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.
  43  * |[
  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."
  53  * |[
  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.
  67  * </refsect2>
  68  */
  69
  70 #ifdef HAVE_CONFIG_H
  71 #include "config.h"
  72 #endif
  73
  74 #include <string.h>
  75 #ifdef HAVE_STDLIB_H
  76 #include <stdlib.h>             /* atoi() */
  77 #endif
  78 #include <gst/gstelement.h>
  79 #include <gst/gst-i18n-plugin.h>
  80 #include <libsoup/soup.h>
  81 #include "gstsouphttpsrc.h"
  82
  83 #include <gst/tag/tag.h>
  84
  85 GST_DEBUG_CATEGORY_STATIC (souphttpsrc_debug);
  86 #define GST_CAT_DEFAULT souphttpsrc_debug
  87
  88 static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
  89     GST_PAD_SRC,
  90     GST_PAD_ALWAYS,
  91     GST_STATIC_CAPS_ANY);
  92
  93 enum
  94 {
  95   PROP_0,
  96   PROP_LOCATION,
  97   PROP_IS_LIVE,
  98   PROP_USER_AGENT,
  99   PROP_AUTOMATIC_REDIRECT,
 100   PROP_PROXY,
 101   PROP_USER_ID,
 102   PROP_USER_PW,
 103   PROP_PROXY_ID,
 104   PROP_PROXY_PW,
 105   PROP_COOKIES,
 106   PROP_IRADIO_MODE,
 107   PROP_TIMEOUT,
 108   PROP_EXTRA_HEADERS
 109 };
 110
 111 #define DEFAULT_USER_AGENT           "GStreamer souphttpsrc "
 112 #define DEFAULT_IRADIO_MODE          TRUE
 113
 114 static void gst_soup_http_src_uri_handler_init (gpointer g_iface,
 115     gpointer iface_data);
 116 static void gst_soup_http_src_finalize (GObject * gobject);
 117
 118 static void gst_soup_http_src_set_property (GObject * object, guint prop_id,
 119     const GValue * value, GParamSpec * pspec);
 120 static void gst_soup_http_src_get_property (GObject * object, guint prop_id,
 121     GValue * value, GParamSpec * pspec);
 122
 123 static GstFlowReturn gst_soup_http_src_create (GstPushSrc * psrc,
 124     GstBuffer ** outbuf);
 125 static gboolean gst_soup_http_src_start (GstBaseSrc * bsrc);
 126 static gboolean gst_soup_http_src_stop (GstBaseSrc * bsrc);
 127 static gboolean gst_soup_http_src_get_size (GstBaseSrc * bsrc, guint64 * size);
 128 static gboolean gst_soup_http_src_is_seekable (GstBaseSrc * bsrc);
 129 static gboolean gst_soup_http_src_do_seek (GstBaseSrc * bsrc,
 130     GstSegment * segment);
 131 static gboolean gst_soup_http_src_query (GstBaseSrc * bsrc, GstQuery * query);
 132 static gboolean gst_soup_http_src_unlock (GstBaseSrc * bsrc);
 133 static gboolean gst_soup_http_src_unlock_stop (GstBaseSrc * bsrc);
 134 static gboolean gst_soup_http_src_set_location (GstSoupHTTPSrc * src,
 135     const gchar * uri, GError ** error);
 136 static gboolean gst_soup_http_src_set_proxy (GstSoupHTTPSrc * src,
 137     const gchar * uri);
 138 static char *gst_soup_http_src_unicodify (const char *str);
 139 static gboolean gst_soup_http_src_build_message (GstSoupHTTPSrc * src,
 140     const gchar * method);
 141 static void gst_soup_http_src_cancel_message (GstSoupHTTPSrc * src);
 142 static void gst_soup_http_src_queue_message (GstSoupHTTPSrc * src);
 143 static gboolean gst_soup_http_src_add_range_header (GstSoupHTTPSrc * src,
 144     guint64 offset, guint64 stop_offset);
 145 static void gst_soup_http_src_session_unpause_message (GstSoupHTTPSrc * src);
 146 static void gst_soup_http_src_session_pause_message (GstSoupHTTPSrc * src);
 147 static gboolean gst_soup_http_src_session_open (GstSoupHTTPSrc * src);
 148 static void gst_soup_http_src_session_close (GstSoupHTTPSrc * src);
 149 static void gst_soup_http_src_parse_status (SoupMessage * msg,
 150     GstSoupHTTPSrc * src);
 151 static void gst_soup_http_src_chunk_free (gpointer gstbuf);
 152 static SoupBuffer *gst_soup_http_src_chunk_allocator (SoupMessage * msg,
 153     gsize max_len, gpointer user_data);
 154 static void gst_soup_http_src_got_chunk_cb (SoupMessage * msg,
 155     SoupBuffer * chunk, GstSoupHTTPSrc * src);
 156 static void gst_soup_http_src_response_cb (SoupSession * session,
 157     SoupMessage * msg, GstSoupHTTPSrc * src);
 158 static void gst_soup_http_src_got_headers_cb (SoupMessage * msg,
 159     GstSoupHTTPSrc * src);
 160 static void gst_soup_http_src_got_body_cb (SoupMessage * msg,
 161     GstSoupHTTPSrc * src);
 162 static void gst_soup_http_src_finished_cb (SoupMessage * msg,
 163     GstSoupHTTPSrc * src);
 164 static void gst_soup_http_src_authenticate_cb (SoupSession * session,
 165     SoupMessage * msg, SoupAuth * auth, gboolean retrying,
 166     GstSoupHTTPSrc * src);
 167
 168 #define gst_soup_http_src_parent_class parent_class
 169 G_DEFINE_TYPE_WITH_CODE (GstSoupHTTPSrc, gst_soup_http_src, GST_TYPE_PUSH_SRC,
 170     G_IMPLEMENT_INTERFACE (GST_TYPE_URI_HANDLER,
 171         gst_soup_http_src_uri_handler_init));
 172
 173 static void
 174 gst_soup_http_src_class_init (GstSoupHTTPSrcClass * klass)
 175 {
 176   GObjectClass *gobject_class;
 177   GstElementClass *gstelement_class;
 178   GstBaseSrcClass *gstbasesrc_class;
 179   GstPushSrcClass *gstpushsrc_class;
 180
 181   gobject_class = (GObjectClass *) klass;
 182   gstelement_class = (GstElementClass *) klass;
 183   gstbasesrc_class = (GstBaseSrcClass *) klass;
 184   gstpushsrc_class = (GstPushSrcClass *) klass;
 185
 186   gobject_class->set_property = gst_soup_http_src_set_property;
 187   gobject_class->get_property = gst_soup_http_src_get_property;
 188   gobject_class->finalize = gst_soup_http_src_finalize;
 189
 190   g_object_class_install_property (gobject_class,
 191       PROP_LOCATION,
 192       g_param_spec_string ("location", "Location",
 193           "Location to read from", "",
 194           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 195   g_object_class_install_property (gobject_class,
 196       PROP_USER_AGENT,
 197       g_param_spec_string ("user-agent", "User-Agent",
 198           "Value of the User-Agent HTTP request header field",
 199           DEFAULT_USER_AGENT, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 200   g_object_class_install_property (gobject_class,
 201       PROP_AUTOMATIC_REDIRECT,
 202       g_param_spec_boolean ("automatic-redirect", "automatic-redirect",
 203           "Automatically follow HTTP redirects (HTTP Status Code 3xx)",
 204           TRUE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 205   g_object_class_install_property (gobject_class,
 206       PROP_PROXY,
 207       g_param_spec_string ("proxy", "Proxy",
 208           "HTTP proxy server URI", "",
 209           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 210   g_object_class_install_property (gobject_class,
 211       PROP_USER_ID,
 212       g_param_spec_string ("user-id", "user-id",
 213           "HTTP location URI user id for authentication", "",
 214           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 215   g_object_class_install_property (gobject_class, PROP_USER_PW,
 216       g_param_spec_string ("user-pw", "user-pw",
 217           "HTTP location URI user password for authentication", "",
 218           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 219   g_object_class_install_property (gobject_class, PROP_PROXY_ID,
 220       g_param_spec_string ("proxy-id", "proxy-id",
 221           "HTTP proxy URI user id for authentication", "",
 222           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 223   g_object_class_install_property (gobject_class, PROP_PROXY_PW,
 224       g_param_spec_string ("proxy-pw", "proxy-pw",
 225           "HTTP proxy URI user password for authentication", "",
 226           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 227   g_object_class_install_property (gobject_class, PROP_COOKIES,
 228       g_param_spec_boxed ("cookies", "Cookies", "HTTP request cookies",
 229           G_TYPE_STRV, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 230   g_object_class_install_property (gobject_class, PROP_IS_LIVE,
 231       g_param_spec_boolean ("is-live", "is-live", "Act like a live source",
 232           FALSE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 233   g_object_class_install_property (gobject_class, PROP_TIMEOUT,
 234       g_param_spec_uint ("timeout", "timeout",
 235           "Value in seconds to timeout a blocking I/O (0 = No timeout).", 0,
 236           3600, 0, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 237   g_object_class_install_property (gobject_class, PROP_EXTRA_HEADERS,
 238       g_param_spec_boxed ("extra-headers", "Extra Headers",
 239           "Extra headers to append to the HTTP request",
 240           GST_TYPE_STRUCTURE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 241   g_object_class_install_property (gobject_class, PROP_IRADIO_MODE,
 242       g_param_spec_boolean ("iradio-mode", "iradio-mode",
 243           "Enable internet radio mode (ask server to send shoutcast/icecast "
 244           "metadata interleaved with the actual stream data)",
 245           DEFAULT_IRADIO_MODE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 246
 247   gst_element_class_add_pad_template (gstelement_class,
 248       gst_static_pad_template_get (&srctemplate));
 249
 250   gst_element_class_set_static_metadata (gstelement_class, "HTTP client source",
 251       "Source/Network",
 252       "Receive data as a client over the network via HTTP using SOUP",
 253       "Wouter Cloetens <wouter@mind.be>");
 254
 255   gstbasesrc_class->start = GST_DEBUG_FUNCPTR (gst_soup_http_src_start);
 256   gstbasesrc_class->stop = GST_DEBUG_FUNCPTR (gst_soup_http_src_stop);
 257   gstbasesrc_class->unlock = GST_DEBUG_FUNCPTR (gst_soup_http_src_unlock);
 258   gstbasesrc_class->unlock_stop =
 259       GST_DEBUG_FUNCPTR (gst_soup_http_src_unlock_stop);
 260   gstbasesrc_class->get_size = GST_DEBUG_FUNCPTR (gst_soup_http_src_get_size);
 261   gstbasesrc_class->is_seekable =
 262       GST_DEBUG_FUNCPTR (gst_soup_http_src_is_seekable);
 263   gstbasesrc_class->do_seek = GST_DEBUG_FUNCPTR (gst_soup_http_src_do_seek);
 264   gstbasesrc_class->query = GST_DEBUG_FUNCPTR (gst_soup_http_src_query);
 265
 266   gstpushsrc_class->create = GST_DEBUG_FUNCPTR (gst_soup_http_src_create);
 267
 268   GST_DEBUG_CATEGORY_INIT (souphttpsrc_debug, "souphttpsrc", 0,
 269       "SOUP HTTP src");
 270 }
 271
 272 static void
 273 gst_soup_http_src_reset (GstSoupHTTPSrc * src)
 274 {
 275   src->interrupted = FALSE;
 276   src->retry = FALSE;
 277   src->have_size = FALSE;
 278   src->got_headers = FALSE;
 279   src->seekable = FALSE;
 280   src->read_position = 0;
 281   src->request_position = 0;
 282   src->stop_position = -1;
 283   src->content_size = 0;
 284   src->have_body = FALSE;
 285
 286   gst_caps_replace (&src->src_caps, NULL);
 287   g_free (src->iradio_name);
 288   src->iradio_name = NULL;
 289   g_free (src->iradio_genre);
 290   src->iradio_genre = NULL;
 291   g_free (src->iradio_url);
 292   src->iradio_url = NULL;
 293 }
 294
 295 static void
 296 gst_soup_http_src_init (GstSoupHTTPSrc * src)
 297 {
 298   const gchar *proxy;
 299
 300   g_mutex_init (&src->mutex);
 301   g_cond_init (&src->request_finished_cond);
 302   src->location = NULL;
 303   src->redirection_uri = NULL;
 304   src->automatic_redirect = TRUE;
 305   src->user_agent = g_strdup (DEFAULT_USER_AGENT);
 306   src->user_id = NULL;
 307   src->user_pw = NULL;
 308   src->proxy_id = NULL;
 309   src->proxy_pw = NULL;
 310   src->cookies = NULL;
 311   src->iradio_mode = DEFAULT_IRADIO_MODE;
 312   src->loop = NULL;
 313   src->context = NULL;
 314   src->session = NULL;
 315   src->msg = NULL;
 316   proxy = g_getenv ("http_proxy");
 317   if (proxy && !gst_soup_http_src_set_proxy (src, proxy)) {
 318     GST_WARNING_OBJECT (src,
 319         "The proxy in the http_proxy env var (\"%s\") cannot be parsed.",
 320         proxy);
 321   }
 322
 323   gst_soup_http_src_reset (src);
 324 }
 325
 326 static void
 327 gst_soup_http_src_finalize (GObject * gobject)
 328 {
 329   GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (gobject);
 330
 331   GST_DEBUG_OBJECT (src, "finalize");
 332
 333   g_mutex_clear (&src->mutex);
 334   g_cond_clear (&src->request_finished_cond);
 335   g_free (src->location);
 336   if (src->redirection_uri) {
 337     g_free (src->redirection_uri);
 338   }
 339   g_free (src->user_agent);
 340   if (src->proxy != NULL) {
 341     soup_uri_free (src->proxy);
 342   }
 343   g_free (src->user_id);
 344   g_free (src->user_pw);
 345   g_free (src->proxy_id);
 346   g_free (src->proxy_pw);
 347   g_strfreev (src->cookies);
 348
 349   G_OBJECT_CLASS (parent_class)->finalize (gobject);
 350 }
 351
 352 static void
 353 gst_soup_http_src_set_property (GObject * object, guint prop_id,
 354     const GValue * value, GParamSpec * pspec)
 355 {
 356   GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (object);
 357
 358   switch (prop_id) {
 359     case PROP_LOCATION:
 360     {
 361       const gchar *location;
 362
 363       location = g_value_get_string (value);
 364
 365       if (location == NULL) {
 366         GST_WARNING ("location property cannot be NULL");
 367         goto done;
 368       }
 369       if (!gst_soup_http_src_set_location (src, location, NULL)) {
 370         GST_WARNING ("badly formatted location");
 371         goto done;
 372       }
 373       break;
 374     }
 375     case PROP_USER_AGENT:
 376       if (src->user_agent)
 377         g_free (src->user_agent);
 378       src->user_agent = g_value_dup_string (value);
 379       break;
 380     case PROP_IRADIO_MODE:
 381       src->iradio_mode = g_value_get_boolean (value);
 382       break;
 383     case PROP_AUTOMATIC_REDIRECT:
 384       src->automatic_redirect = g_value_get_boolean (value);
 385       break;
 386     case PROP_PROXY:
 387     {
 388       const gchar *proxy;
 389
 390       proxy = g_value_get_string (value);
 391
 392       if (proxy == NULL) {
 393         GST_WARNING ("proxy property cannot be NULL");
 394         goto done;
 395       }
 396       if (!gst_soup_http_src_set_proxy (src, proxy)) {
 397         GST_WARNING ("badly formatted proxy URI");
 398         goto done;
 399       }
 400       break;
 401     }
 402     case PROP_COOKIES:
 403       g_strfreev (src->cookies);
 404       src->cookies = g_strdupv (g_value_get_boxed (value));
 405       break;
 406     case PROP_IS_LIVE:
 407       gst_base_src_set_live (GST_BASE_SRC (src), g_value_get_boolean (value));
 408       break;
 409     case PROP_USER_ID:
 410       if (src->user_id)
 411         g_free (src->user_id);
 412       src->user_id = g_value_dup_string (value);
 413       break;
 414     case PROP_USER_PW:
 415       if (src->user_pw)
 416         g_free (src->user_pw);
 417       src->user_pw = g_value_dup_string (value);
 418       break;
 419     case PROP_PROXY_ID:
 420       if (src->proxy_id)
 421         g_free (src->proxy_id);
 422       src->proxy_id = g_value_dup_string (value);
 423       break;
 424     case PROP_PROXY_PW:
 425       if (src->proxy_pw)
 426         g_free (src->proxy_pw);
 427       src->proxy_pw = g_value_dup_string (value);
 428       break;
 429     case PROP_TIMEOUT:
 430       src->timeout = g_value_get_uint (value);
 431       break;
 432     case PROP_EXTRA_HEADERS:{
 433       const GstStructure *s = gst_value_get_structure (value);
 434
 435       if (src->extra_headers)
 436         gst_structure_free (src->extra_headers);
 437
 438       src->extra_headers = s ? gst_structure_copy (s) : NULL;
 439       break;
 440     }
 441     default:
 442       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 443       break;
 444   }
 445 done:
 446   return;
 447 }
 448
 449 static void
 450 gst_soup_http_src_get_property (GObject * object, guint prop_id,
 451     GValue * value, GParamSpec * pspec)
 452 {
 453   GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (object);
 454
 455   switch (prop_id) {
 456     case PROP_LOCATION:
 457       g_value_set_string (value, src->location);
 458       break;
 459     case PROP_USER_AGENT:
 460       g_value_set_string (value, src->user_agent);
 461       break;
 462     case PROP_AUTOMATIC_REDIRECT:
 463       g_value_set_boolean (value, src->automatic_redirect);
 464       break;
 465     case PROP_PROXY:
 466       if (src->proxy == NULL)
 467         g_value_set_static_string (value, "");
 468       else {
 469         char *proxy = soup_uri_to_string (src->proxy, FALSE);
 470
 471         g_value_set_string (value, proxy);
 472         g_free (proxy);
 473       }
 474       break;
 475     case PROP_COOKIES:
 476       g_value_set_boxed (value, g_strdupv (src->cookies));
 477       break;
 478     case PROP_IS_LIVE:
 479       g_value_set_boolean (value, gst_base_src_is_live (GST_BASE_SRC (src)));
 480       break;
 481     case PROP_IRADIO_MODE:
 482       g_value_set_boolean (value, src->iradio_mode);
 483       break;
 484     case PROP_USER_ID:
 485       g_value_set_string (value, src->user_id);
 486       break;
 487     case PROP_USER_PW:
 488       g_value_set_string (value, src->user_pw);
 489       break;
 490     case PROP_PROXY_ID:
 491       g_value_set_string (value, src->proxy_id);
 492       break;
 493     case PROP_PROXY_PW:
 494       g_value_set_string (value, src->proxy_pw);
 495       break;
 496     case PROP_TIMEOUT:
 497       g_value_set_uint (value, src->timeout);
 498       break;
 499     case PROP_EXTRA_HEADERS:
 500       gst_value_set_structure (value, src->extra_headers);
 501       break;
 502     default:
 503       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 504       break;
 505   }
 506 }
 507
 508 static gchar *
 509 gst_soup_http_src_unicodify (const gchar * str)
 510 {
 511   const gchar *env_vars[] = { "GST_ICY_TAG_ENCODING",
 512     "GST_TAG_ENCODING", NULL
 513   };
 514
 515   return gst_tag_freeform_string_to_utf8 (str, -1, env_vars);
 516 }
 517
 518 static void
 519 gst_soup_http_src_cancel_message (GstSoupHTTPSrc * src)
 520 {
 521   if (src->msg != NULL) {
 522     src->session_io_status = GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_CANCELLED;
 523     soup_session_cancel_message (src->session, src->msg, SOUP_STATUS_CANCELLED);
 524   }
 525   src->session_io_status = GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_IDLE;
 526   src->msg = NULL;
 527 }
 528
 529 static void
 530 gst_soup_http_src_queue_message (GstSoupHTTPSrc * src)
 531 {
 532   soup_session_queue_message (src->session, src->msg,
 533       (SoupSessionCallback) gst_soup_http_src_response_cb, src);
 534   src->session_io_status = GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_QUEUED;
 535 }
 536
 537 static gboolean
 538 gst_soup_http_src_add_range_header (GstSoupHTTPSrc * src, guint64 offset,
 539     guint64 stop_offset)
 540 {
 541   gchar buf[64];
 542
 543   gint rc;
 544
 545   soup_message_headers_remove (src->msg->request_headers, "Range");
 546   if (offset || stop_offset != -1) {
 547     if (stop_offset != -1) {
 548       rc = g_snprintf (buf, sizeof (buf), "bytes=%" G_GUINT64_FORMAT "-%"
 549           G_GUINT64_FORMAT, offset, stop_offset);
 550     } else {
 551       rc = g_snprintf (buf, sizeof (buf), "bytes=%" G_GUINT64_FORMAT "-",
 552           offset);
 553     }
 554     if (rc > sizeof (buf) || rc < 0)
 555       return FALSE;
 556     soup_message_headers_append (src->msg->request_headers, "Range", buf);
 557   }
 558   src->read_position = offset;
 559   return TRUE;
 560 }
 561
 562 static gboolean
 563 _append_extra_header (GQuark field_id, const GValue * value, gpointer user_data)
 564 {
 565   GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (user_data);
 566   const gchar *field_name = g_quark_to_string (field_id);
 567   gchar *field_content = NULL;
 568
 569   if (G_VALUE_TYPE (value) == G_TYPE_STRING) {
 570     field_content = g_value_dup_string (value);
 571   } else {
 572     GValue dest = { 0, };
 573
 574     g_value_init (&dest, G_TYPE_STRING);
 575     if (g_value_transform (value, &dest)) {
 576       field_content = g_value_dup_string (&dest);
 577     }
 578   }
 579
 580   if (field_content == NULL) {
 581     GST_ERROR_OBJECT (src, "extra-headers field '%s' contains no value "
 582         "or can't be converted to a string", field_name);
 583     return FALSE;
 584   }
 585
 586   GST_DEBUG_OBJECT (src, "Appending extra header: \"%s: %s\"", field_name,
 587       field_content);
 588   soup_message_headers_append (src->msg->request_headers, field_name,
 589       field_content);
 590
 591   g_free (field_content);
 592
 593   return TRUE;
 594 }
 595
 596 static gboolean
 597 _append_extra_headers (GQuark field_id, const GValue * value,
 598     gpointer user_data)
 599 {
 600   if (G_VALUE_TYPE (value) == GST_TYPE_ARRAY) {
 601     guint n = gst_value_array_get_size (value);
 602     guint i;
 603
 604     for (i = 0; i < n; i++) {
 605       const GValue *v = gst_value_array_get_value (value, i);
 606
 607       if (!_append_extra_header (field_id, v, user_data))
 608         return FALSE;
 609     }
 610   } else if (G_VALUE_TYPE (value) == GST_TYPE_LIST) {
 611     guint n = gst_value_list_get_size (value);
 612     guint i;
 613
 614     for (i = 0; i < n; i++) {
 615       const GValue *v = gst_value_list_get_value (value, i);
 616
 617       if (!_append_extra_header (field_id, v, user_data))
 618         return FALSE;
 619     }
 620   } else {
 621     return _append_extra_header (field_id, value, user_data);
 622   }
 623
 624   return TRUE;
 625 }
 626
 627
 628 static gboolean
 629 gst_soup_http_src_add_extra_headers (GstSoupHTTPSrc * src)
 630 {
 631   if (!src->extra_headers)
 632     return TRUE;
 633
 634   return gst_structure_foreach (src->extra_headers, _append_extra_headers, src);
 635 }
 636
 637
 638 static void
 639 gst_soup_http_src_session_unpause_message (GstSoupHTTPSrc * src)
 640 {
 641   soup_session_unpause_message (src->session, src->msg);
 642 }
 643
 644 static void
 645 gst_soup_http_src_session_pause_message (GstSoupHTTPSrc * src)
 646 {
 647   soup_session_pause_message (src->session, src->msg);
 648 }
 649
 650 static gboolean
 651 gst_soup_http_src_session_open (GstSoupHTTPSrc * src)
 652 {
 653   if (src->session) {
 654     GST_DEBUG_OBJECT (src, "Session is already open");
 655     return TRUE;
 656   }
 657
 658   if (!src->location) {
 659     GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ, (_("No URL set.")),
 660         ("Missing location property"));
 661     return FALSE;
 662   }
 663
 664   src->context = g_main_context_new ();
 665
 666   src->loop = g_main_loop_new (src->context, TRUE);
 667   if (!src->loop) {
 668     GST_ELEMENT_ERROR (src, LIBRARY, INIT,
 669         (NULL), ("Failed to start GMainLoop"));
 670     g_main_context_unref (src->context);
 671     return FALSE;
 672   }
 673
 674   GST_DEBUG_OBJECT (src, "Creating session");
 675   if (src->proxy == NULL) {
 676     src->session =
 677         soup_session_async_new_with_options (SOUP_SESSION_ASYNC_CONTEXT,
 678         src->context, SOUP_SESSION_USER_AGENT, src->user_agent,
 679         SOUP_SESSION_TIMEOUT, src->timeout,
 680         SOUP_SESSION_ADD_FEATURE_BY_TYPE, SOUP_TYPE_PROXY_RESOLVER_DEFAULT,
 681         NULL);
 682   } else {
 683     src->session =
 684         soup_session_async_new_with_options (SOUP_SESSION_ASYNC_CONTEXT,
 685         src->context, SOUP_SESSION_PROXY_URI, src->proxy,
 686         SOUP_SESSION_TIMEOUT, src->timeout,
 687         SOUP_SESSION_USER_AGENT, src->user_agent, NULL);
 688   }
 689
 690   if (!src->session) {
 691     GST_ELEMENT_ERROR (src, LIBRARY, INIT,
 692         (NULL), ("Failed to create async session"));
 693     return FALSE;
 694   }
 695
 696   g_signal_connect (src->session, "authenticate",
 697       G_CALLBACK (gst_soup_http_src_authenticate_cb), src);
 698   return TRUE;
 699 }
 700
 701 static void
 702 gst_soup_http_src_session_close (GstSoupHTTPSrc * src)
 703 {
 704   if (src->session) {
 705     soup_session_abort (src->session);  /* This unrefs the message. */
 706     g_object_unref (src->session);
 707     src->session = NULL;
 708     src->msg = NULL;
 709   }
 710 }
 711
 712 static void
 713 gst_soup_http_src_authenticate_cb (SoupSession * session, SoupMessage * msg,
 714     SoupAuth * auth, gboolean retrying, GstSoupHTTPSrc * src)
 715 {
 716   if (!retrying) {
 717     /* First time authentication only, if we fail and are called again with retry true fall through */
 718     if (msg->status_code == SOUP_STATUS_UNAUTHORIZED) {
 719       if (src->user_id && src->user_pw)
 720         soup_auth_authenticate (auth, src->user_id, src->user_pw);
 721     } else if (msg->status_code == SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED) {
 722       if (src->proxy_id && src->proxy_pw)
 723         soup_auth_authenticate (auth, src->proxy_id, src->proxy_pw);
 724     }
 725   }
 726 }
 727
 728 static void
 729 gst_soup_http_src_headers_foreach (const gchar * name, const gchar * val,
 730     gpointer src)
 731 {
 732   GST_DEBUG_OBJECT (src, " %s: %s", name, val);
 733 }
 734
 735 static void
 736 gst_soup_http_src_got_headers_cb (SoupMessage * msg, GstSoupHTTPSrc * src)
 737 {
 738   const char *value;
 739   GstTagList *tag_list;
 740   GstBaseSrc *basesrc;
 741   guint64 newsize;
 742   GHashTable *params = NULL;
 743
 744   GST_DEBUG_OBJECT (src, "got headers:");
 745   soup_message_headers_foreach (msg->response_headers,
 746       gst_soup_http_src_headers_foreach, src);
 747
 748   if (msg->status_code == SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED &&
 749       src->proxy_id && src->proxy_pw)
 750     return;
 751
 752   if (src->automatic_redirect && SOUP_STATUS_IS_REDIRECTION (msg->status_code)) {
 753     src->redirection_uri = g_strdup (soup_message_headers_get_one
 754         (msg->response_headers, "Location"));
 755     GST_DEBUG_OBJECT (src, "%u redirect to \"%s\"", msg->status_code,
 756         src->redirection_uri);
 757     return;
 758   }
 759
 760   if (msg->status_code == SOUP_STATUS_UNAUTHORIZED)
 761     return;
 762
 763   src->session_io_status = GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_RUNNING;
 764   src->got_headers = TRUE;
 765
 766   /* Parse Content-Length. */
 767   if (soup_message_headers_get_encoding (msg->response_headers) ==
 768       SOUP_ENCODING_CONTENT_LENGTH) {
 769     newsize = src->request_position +
 770         soup_message_headers_get_content_length (msg->response_headers);
 771     if (!src->have_size || (src->content_size != newsize)) {
 772       src->content_size = newsize;
 773       src->have_size = TRUE;
 774       src->seekable = TRUE;
 775       GST_DEBUG_OBJECT (src, "size = %" G_GUINT64_FORMAT, src->content_size);
 776
 777       basesrc = GST_BASE_SRC_CAST (src);
 778       basesrc->segment.duration = src->content_size;
 779       gst_element_post_message (GST_ELEMENT (src),
 780           gst_message_new_duration_changed (GST_OBJECT (src)));
 781     }
 782   }
 783
 784   /* Icecast stuff */
 785   tag_list = gst_tag_list_new_empty ();
 786
 787   if ((value =
 788           soup_message_headers_get_one (msg->response_headers,
 789               "icy-metaint")) != NULL) {
 790     gint icy_metaint = atoi (value);
 791
 792     GST_DEBUG_OBJECT (src, "icy-metaint: %s (parsed: %d)", value, icy_metaint);
 793     if (icy_metaint > 0) {
 794       if (src->src_caps)
 795         gst_caps_unref (src->src_caps);
 796
 797       src->src_caps = gst_caps_new_simple ("application/x-icy",
 798           "metadata-interval", G_TYPE_INT, icy_metaint, NULL);
 799
 800       gst_base_src_set_caps (GST_BASE_SRC (src), src->src_caps);
 801     }
 802   }
 803   if ((value =
 804           soup_message_headers_get_content_type (msg->response_headers,
 805               &params)) != NULL) {
 806     GST_DEBUG_OBJECT (src, "Content-Type: %s", value);
 807     if (g_ascii_strcasecmp (value, "audio/L16") == 0) {
 808       gint channels = 2;
 809       gint rate = 44100;
 810       char *param;
 811
 812       if (src->src_caps)
 813         gst_caps_unref (src->src_caps);
 814
 815       param = g_hash_table_lookup (params, "channels");
 816       if (param != NULL)
 817         channels = atol (param);
 818
 819       param = g_hash_table_lookup (params, "rate");
 820       if (param != NULL)
 821         rate = atol (param);
 822
 823       src->src_caps = gst_caps_new_simple ("audio/x-raw",
 824           "format", G_TYPE_STRING, "S16BE",
 825           "layout", G_TYPE_STRING, "interleaved",
 826           "channels", G_TYPE_INT, channels, "rate", G_TYPE_INT, rate, NULL);
 827
 828       gst_base_src_set_caps (GST_BASE_SRC (src), src->src_caps);
 829     } else {
 830       /* Set the Content-Type field on the caps */
 831       if (src->src_caps) {
 832         src->src_caps = gst_caps_make_writable (src->src_caps);
 833         gst_caps_set_simple (src->src_caps, "content-type", G_TYPE_STRING,
 834             value, NULL);
 835         gst_base_src_set_caps (GST_BASE_SRC (src), src->src_caps);
 836       }
 837     }
 838   }
 839
 840   if (params != NULL)
 841     g_hash_table_destroy (params);
 842
 843   if ((value =
 844           soup_message_headers_get_one (msg->response_headers,
 845               "icy-name")) != NULL) {
 846     g_free (src->iradio_name);
 847     src->iradio_name = gst_soup_http_src_unicodify (value);
 848     if (src->iradio_name) {
 849       gst_tag_list_add (tag_list, GST_TAG_MERGE_REPLACE, GST_TAG_ORGANIZATION,
 850           src->iradio_name, NULL);
 851     }
 852   }
 853   if ((value =
 854           soup_message_headers_get_one (msg->response_headers,
 855               "icy-genre")) != NULL) {
 856     g_free (src->iradio_genre);
 857     src->iradio_genre = gst_soup_http_src_unicodify (value);
 858     if (src->iradio_genre) {
 859       gst_tag_list_add (tag_list, GST_TAG_MERGE_REPLACE, GST_TAG_GENRE,
 860           src->iradio_genre, NULL);
 861     }
 862   }
 863   if ((value = soup_message_headers_get_one (msg->response_headers, "icy-url"))
 864       != NULL) {
 865     g_free (src->iradio_url);
 866     src->iradio_url = gst_soup_http_src_unicodify (value);
 867     if (src->iradio_url) {
 868       gst_tag_list_add (tag_list, GST_TAG_MERGE_REPLACE, GST_TAG_LOCATION,
 869           src->iradio_url, NULL);
 870     }
 871   }
 872   if (!gst_tag_list_is_empty (tag_list)) {
 873     GST_DEBUG_OBJECT (src,
 874         "calling gst_element_found_tags with %" GST_PTR_FORMAT, tag_list);
 875     gst_pad_push_event (GST_BASE_SRC_PAD (src), gst_event_new_tag (tag_list));
 876   } else {
 877     gst_tag_list_unref (tag_list);
 878   }
 879
 880   /* Handle HTTP errors. */
 881   gst_soup_http_src_parse_status (msg, src);
 882
 883   /* Check if Range header was respected. */
 884   if (src->ret == GST_FLOW_CUSTOM_ERROR &&
 885       src->read_position && msg->status_code != SOUP_STATUS_PARTIAL_CONTENT) {
 886     src->seekable = FALSE;
 887     GST_ELEMENT_ERROR (src, RESOURCE, SEEK,
 888         (_("Server does not support seeking.")),
 889         ("Server does not accept Range HTTP header, URL: %s", src->location));
 890     src->ret = GST_FLOW_ERROR;
 891   }
 892
 893   /* If we are going to error out, stop all processing right here, so we
 894    * don't output any data (such as an error html page), and return
 895    * GST_FLOW_ERROR from the create function instead of having
 896    * got_chunk_cb overwrite src->ret with FLOW_OK again. */
 897   if (src->ret == GST_FLOW_ERROR || src->ret == GST_FLOW_EOS) {
 898     gst_soup_http_src_session_pause_message (src);
 899
 900     if (src->loop)
 901       g_main_loop_quit (src->loop);
 902   }
 903   g_cond_signal (&src->request_finished_cond);
 904 }
 905
 906 /* Have body. Signal EOS. */
 907 static void
 908 gst_soup_http_src_got_body_cb (SoupMessage * msg, GstSoupHTTPSrc * src)
 909 {
 910   if (G_UNLIKELY (msg != src->msg)) {
 911     GST_DEBUG_OBJECT (src, "got body, but not for current message");
 912     return;
 913   }
 914   if (G_UNLIKELY (src->session_io_status !=
 915           GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_RUNNING)) {
 916     /* Probably a redirect. */
 917     return;
 918   }
 919   GST_DEBUG_OBJECT (src, "got body");
 920   src->ret = GST_FLOW_EOS;
 921   src->have_body = TRUE;
 922
 923   /* no need to interrupt the message here, we do it on the
 924    * finished_cb anyway if needed. And getting the body might mean
 925    * that the connection was hang up before finished. This happens when
 926    * the pipeline is stalled for too long (long pauses during playback).
 927    * Best to let it continue from here and pause because it reached the
 928    * final bytes based on content_size or received an out of range error */
 929 }
 930
 931 /* Finished. Signal EOS. */
 932 static void
 933 gst_soup_http_src_finished_cb (SoupMessage * msg, GstSoupHTTPSrc * src)
 934 {
 935   if (G_UNLIKELY (msg != src->msg)) {
 936     GST_DEBUG_OBJECT (src, "finished, but not for current message");
 937     return;
 938   }
 939   GST_DEBUG_OBJECT (src, "finished");
 940   src->ret = GST_FLOW_EOS;
 941   if (src->session_io_status == GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_CANCELLED) {
 942     /* gst_soup_http_src_cancel_message() triggered this; probably a seek
 943      * that occurred in the QUEUEING state; i.e. before the connection setup
 944      * was complete. Do nothing */
 945   } else if (src->session_io_status ==
 946       GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_RUNNING && src->read_position > 0 &&
 947       (!src->have_size || src->read_position < src->content_size)) {
 948     /* The server disconnected while streaming. Reconnect and seeking to the
 949      * last location. */
 950     src->retry = TRUE;
 951     src->ret = GST_FLOW_CUSTOM_ERROR;
 952   } else if (G_UNLIKELY (src->session_io_status !=
 953           GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_RUNNING)) {
 954     if (msg->method == SOUP_METHOD_HEAD) {
 955       GST_DEBUG_OBJECT (src, "Ignoring error %d:%s during HEAD request",
 956           msg->status_code, msg->reason_phrase);
 957     } else {
 958       gst_soup_http_src_parse_status (msg, src);
 959     }
 960   }
 961   if (src->loop)
 962     g_main_loop_quit (src->loop);
 963   g_cond_signal (&src->request_finished_cond);
 964 }
 965
 966 /* Buffer lifecycle management.
 967  *
 968  * gst_soup_http_src_create() runs the GMainLoop for this element, to let
 969  * Soup take control.
 970  * A GstBuffer is allocated in gst_soup_http_src_chunk_allocator() and
 971  * associated with a SoupBuffer.
 972  * Soup reads HTTP data in the GstBuffer's data buffer.
 973  * The gst_soup_http_src_got_chunk_cb() is then called with the SoupBuffer.
 974  * That sets gst_soup_http_src_create()'s return argument to the GstBuffer,
 975  * increments its refcount (to 2), pauses the flow of data from the HTTP
 976  * source to prevent gst_soup_http_src_got_chunk_cb() from being called
 977  * again and breaks out of the GMainLoop.
 978  * Because the SOUP_MESSAGE_OVERWRITE_CHUNKS flag is set, Soup frees the
 979  * SoupBuffer and calls gst_soup_http_src_chunk_free(), which decrements the
 980  * refcount (to 1).
 981  * gst_soup_http_src_create() returns the GstBuffer. It will be freed by a
 982  * downstream element.
 983  * If Soup fails to read HTTP data, it does not call
 984  * gst_soup_http_src_got_chunk_cb(), but still frees the SoupBuffer and
 985  * calls gst_soup_http_src_chunk_free(), which decrements the GstBuffer's
 986  * refcount to 0, freeing it.
 987  */
 988
 989 typedef struct
 990 {
 991   GstBuffer *buffer;
 992   GstMapInfo map;
 993 } SoupGstChunk;
 994
 995 static void
 996 gst_soup_http_src_chunk_free (gpointer user_data)
 997 {
 998   SoupGstChunk *chunk = (SoupGstChunk *) user_data;
 999
1000   gst_buffer_unmap (chunk->buffer, &chunk->map);
1001   gst_buffer_unref (chunk->buffer);
1002   g_slice_free (SoupGstChunk, chunk);
1003 }
1004
1005 static SoupBuffer *
1006 gst_soup_http_src_chunk_allocator (SoupMessage * msg, gsize max_len,
1007     gpointer user_data)
1008 {
1009   GstSoupHTTPSrc *src = (GstSoupHTTPSrc *) user_data;
1010   GstBaseSrc *basesrc = GST_BASE_SRC_CAST (src);
1011   GstBuffer *gstbuf;
1012   SoupBuffer *soupbuf;
1013   gsize length;
1014   GstFlowReturn rc;
1015   SoupGstChunk *chunk;
1016
1017   if (max_len)
1018     length = MIN (basesrc->blocksize, max_len);
1019   else
1020     length = basesrc->blocksize;
1021   GST_DEBUG_OBJECT (src, "alloc %" G_GSIZE_FORMAT " bytes <= %" G_GSIZE_FORMAT,
1022       length, max_len);
1023
1024   rc = GST_BASE_SRC_CLASS (parent_class)->alloc (basesrc, -1, length, &gstbuf);
1025   if (G_UNLIKELY (rc != GST_FLOW_OK)) {
1026     /* Failed to allocate buffer. Stall SoupSession and return error code
1027      * to create(). */
1028     src->ret = rc;
1029     g_main_loop_quit (src->loop);
1030     return NULL;
1031   }
1032
1033   chunk = g_slice_new0 (SoupGstChunk);
1034   chunk->buffer = gstbuf;
1035   gst_buffer_map (gstbuf, &chunk->map, GST_MAP_READWRITE);
1036
1037   soupbuf = soup_buffer_new_with_owner (chunk->map.data, chunk->map.size,
1038       chunk, gst_soup_http_src_chunk_free);
1039
1040   return soupbuf;
1041 }
1042
1043 static void
1044 gst_soup_http_src_got_chunk_cb (SoupMessage * msg, SoupBuffer * chunk,
1045     GstSoupHTTPSrc * src)
1046 {
1047   GstBaseSrc *basesrc;
1048   guint64 new_position;
1049   SoupGstChunk *gchunk;
1050
1051   if (G_UNLIKELY (msg != src->msg)) {
1052     GST_DEBUG_OBJECT (src, "got chunk, but not for current message");
1053     return;
1054   }
1055   src->have_body = FALSE;
1056   if (G_UNLIKELY (src->session_io_status !=
1057           GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_RUNNING)) {
1058     /* Probably a redirect. */
1059     return;
1060   }
1061   basesrc = GST_BASE_SRC_CAST (src);
1062   GST_DEBUG_OBJECT (src, "got chunk of %" G_GSIZE_FORMAT " bytes",
1063       chunk->length);
1064
1065   /* Extract the GstBuffer from the SoupBuffer and set its fields. */
1066   gchunk = (SoupGstChunk *) soup_buffer_get_owner (chunk);
1067   *src->outbuf = gchunk->buffer;
1068
1069   gst_buffer_resize (*src->outbuf, 0, chunk->length);
1070   GST_BUFFER_OFFSET (*src->outbuf) = basesrc->segment.position;
1071
1072   gst_buffer_ref (*src->outbuf);
1073
1074   new_position = src->read_position + chunk->length;
1075   if (G_LIKELY (src->request_position == src->read_position))
1076     src->request_position = new_position;
1077   src->read_position = new_position;
1078
1079   if (src->content_size != 0 && new_position > src->content_size) {
1080     GST_DEBUG_OBJECT (src, "Got position previous estimated content size "
1081         "(%" G_GINT64_FORMAT " > %" G_GINT64_FORMAT ")", new_position,
1082         src->content_size);
1083     src->content_size = new_position;
1084     basesrc->segment.duration = src->content_size;
1085     gst_element_post_message (GST_ELEMENT (src),
1086         gst_message_new_duration_changed (GST_OBJECT (src)));
1087   }
1088
1089   src->ret = GST_FLOW_OK;
1090   g_main_loop_quit (src->loop);
1091   gst_soup_http_src_session_pause_message (src);
1092 }
1093
1094 static void
1095 gst_soup_http_src_response_cb (SoupSession * session, SoupMessage * msg,
1096     GstSoupHTTPSrc * src)
1097 {
1098   if (G_UNLIKELY (msg != src->msg)) {
1099     GST_DEBUG_OBJECT (src, "got response %d: %s, but not for current message",
1100         msg->status_code, msg->reason_phrase);
1101     return;
1102   }
1103   if (G_UNLIKELY (src->session_io_status !=
1104           GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_RUNNING)
1105       && SOUP_STATUS_IS_REDIRECTION (msg->status_code)) {
1106     /* Ignore redirections. */
1107     return;
1108   }
1109   GST_DEBUG_OBJECT (src, "got response %d: %s", msg->status_code,
1110       msg->reason_phrase);
1111   if (src->session_io_status == GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_RUNNING &&
1112       src->read_position > 0) {
1113     /* The server disconnected while streaming. Reconnect and seeking to the
1114      * last location. */
1115     src->retry = TRUE;
1116   } else
1117     gst_soup_http_src_parse_status (msg, src);
1118   /* The session's SoupMessage object expires after this callback returns. */
1119   src->msg = NULL;
1120   g_main_loop_quit (src->loop);
1121 }
1122
1123 #define SOUP_HTTP_SRC_ERROR(src,soup_msg,cat,code,error_message)     \
1124   GST_ELEMENT_ERROR ((src), cat, code, ("%s", error_message),        \
1125       ("%s (%d), URL: %s", (soup_msg)->reason_phrase,                \
1126           (soup_msg)->status_code, (src)->location));
1127
1128 static void
1129 gst_soup_http_src_parse_status (SoupMessage * msg, GstSoupHTTPSrc * src)
1130 {
1131   if (msg->method == SOUP_METHOD_HEAD) {
1132     if (!SOUP_STATUS_IS_SUCCESSFUL (msg->status_code))
1133       GST_DEBUG_OBJECT (src, "Ignoring error %d during HEAD request",
1134           msg->status_code);
1135   } else if (SOUP_STATUS_IS_TRANSPORT_ERROR (msg->status_code)) {
1136     switch (msg->status_code) {
1137       case SOUP_STATUS_CANT_RESOLVE:
1138       case SOUP_STATUS_CANT_RESOLVE_PROXY:
1139         SOUP_HTTP_SRC_ERROR (src, msg, RESOURCE, NOT_FOUND,
1140             _("Could not resolve server name."));
1141         src->ret = GST_FLOW_ERROR;
1142         break;
1143       case SOUP_STATUS_CANT_CONNECT:
1144       case SOUP_STATUS_CANT_CONNECT_PROXY:
1145         SOUP_HTTP_SRC_ERROR (src, msg, RESOURCE, OPEN_READ,
1146             _("Could not establish connection to server."));
1147         src->ret = GST_FLOW_ERROR;
1148         break;
1149       case SOUP_STATUS_SSL_FAILED:
1150         SOUP_HTTP_SRC_ERROR (src, msg, RESOURCE, OPEN_READ,
1151             _("Secure connection setup failed."));
1152         src->ret = GST_FLOW_ERROR;
1153         break;
1154       case SOUP_STATUS_IO_ERROR:
1155         SOUP_HTTP_SRC_ERROR (src, msg, RESOURCE, READ,
1156             _("A network error occured, or the server closed the connection "
1157                 "unexpectedly."));
1158         src->ret = GST_FLOW_ERROR;
1159         break;
1160       case SOUP_STATUS_MALFORMED:
1161         SOUP_HTTP_SRC_ERROR (src, msg, RESOURCE, READ,
1162             _("Server sent bad data."));
1163         src->ret = GST_FLOW_ERROR;
1164         break;
1165       case SOUP_STATUS_CANCELLED:
1166         /* No error message when interrupted by program. */
1167         break;
1168     }
1169   } else if (SOUP_STATUS_IS_CLIENT_ERROR (msg->status_code) ||
1170       SOUP_STATUS_IS_REDIRECTION (msg->status_code) ||
1171       SOUP_STATUS_IS_SERVER_ERROR (msg->status_code)) {
1172     /* Report HTTP error. */
1173
1174     /* when content_size is unknown and we have just finished receiving
1175      * a body message, requests that go beyond the content limits will result
1176      * in an error. Here we convert those to EOS */
1177     if (msg->status_code == SOUP_STATUS_REQUESTED_RANGE_NOT_SATISFIABLE &&
1178         src->have_body && src->have_size) {
1179       GST_DEBUG_OBJECT (src, "Requested range out of limits and received full "
1180           "body, returning EOS");
1181       src->ret = GST_FLOW_EOS;
1182       return;
1183     }
1184
1185     /* FIXME: reason_phrase is not translated and not suitable for user
1186      * error dialog according to libsoup documentation.
1187      * FIXME: error code (OPEN_READ vs. READ) should depend on http status? */
1188     GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ,
1189         ("%s", msg->reason_phrase),
1190         ("%s (%d), URL: %s", msg->reason_phrase, msg->status_code,
1191             src->location));
1192     src->ret = GST_FLOW_ERROR;
1193   }
1194 }
1195
1196 static gboolean
1197 gst_soup_http_src_build_message (GstSoupHTTPSrc * src, const gchar * method)
1198 {
1199   src->msg = soup_message_new (method, src->location);
1200   if (!src->msg) {
1201     GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ,
1202         ("Error parsing URL."), ("URL: %s", src->location));
1203     return FALSE;
1204   }
1205   src->session_io_status = GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_IDLE;
1206   soup_message_headers_append (src->msg->request_headers, "Connection",
1207       "close");
1208   if (src->iradio_mode) {
1209     soup_message_headers_append (src->msg->request_headers, "icy-metadata",
1210         "1");
1211   }
1212   if (src->cookies) {
1213     gchar **cookie;
1214
1215     for (cookie = src->cookies; *cookie != NULL; cookie++) {
1216       soup_message_headers_append (src->msg->request_headers, "Cookie",
1217           *cookie);
1218     }
1219   }
1220   src->retry = FALSE;
1221
1222   g_signal_connect (src->msg, "got_headers",
1223       G_CALLBACK (gst_soup_http_src_got_headers_cb), src);
1224   g_signal_connect (src->msg, "got_body",
1225       G_CALLBACK (gst_soup_http_src_got_body_cb), src);
1226   g_signal_connect (src->msg, "finished",
1227       G_CALLBACK (gst_soup_http_src_finished_cb), src);
1228   g_signal_connect (src->msg, "got_chunk",
1229       G_CALLBACK (gst_soup_http_src_got_chunk_cb), src);
1230   soup_message_set_flags (src->msg, SOUP_MESSAGE_OVERWRITE_CHUNKS |
1231       (src->automatic_redirect ? 0 : SOUP_MESSAGE_NO_REDIRECT));
1232   soup_message_set_chunk_allocator (src->msg,
1233       gst_soup_http_src_chunk_allocator, src, NULL);
1234   gst_soup_http_src_add_range_header (src, src->request_position,
1235       src->stop_position);
1236
1237   gst_soup_http_src_add_extra_headers (src);
1238
1239   GST_DEBUG_OBJECT (src, "request headers:");
1240   soup_message_headers_foreach (src->msg->request_headers,
1241       gst_soup_http_src_headers_foreach, src);
1242
1243   return TRUE;
1244 }
1245
1246 static GstFlowReturn
1247 gst_soup_http_src_do_request (GstSoupHTTPSrc * src, const gchar * method,
1248     GstBuffer ** outbuf)
1249 {
1250   GST_LOG_OBJECT (src, "Running request for method: %s", method);
1251   if (src->msg && (src->request_position != src->read_position)) {
1252     if (src->session_io_status == GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_IDLE) {
1253       gst_soup_http_src_add_range_header (src, src->request_position,
1254           src->stop_position);
1255     } else {
1256       GST_DEBUG_OBJECT (src, "Seek from position %" G_GUINT64_FORMAT
1257           " to %" G_GUINT64_FORMAT ": requeueing connection request",
1258           src->read_position, src->request_position);
1259       gst_soup_http_src_cancel_message (src);
1260     }
1261   }
1262   if (!src->msg)
1263     if (!gst_soup_http_src_build_message (src, method)) {
1264       return GST_FLOW_ERROR;
1265     }
1266
1267   src->ret = GST_FLOW_CUSTOM_ERROR;
1268   src->outbuf = outbuf;
1269   do {
1270     if (src->interrupted) {
1271       GST_DEBUG_OBJECT (src, "interrupted");
1272       break;
1273     }
1274     if (src->retry) {
1275       GST_DEBUG_OBJECT (src, "Reconnecting");
1276       if (!gst_soup_http_src_build_message (src, method)) {
1277         return GST_FLOW_ERROR;
1278       }
1279       src->retry = FALSE;
1280       continue;
1281     }
1282     if (!src->msg) {
1283       GST_DEBUG_OBJECT (src, "EOS reached");
1284       break;
1285     }
1286
1287     switch (src->session_io_status) {
1288       case GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_IDLE:
1289         GST_DEBUG_OBJECT (src, "Queueing connection request");
1290         gst_soup_http_src_queue_message (src);
1291         break;
1292       case GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_QUEUED:
1293         break;
1294       case GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_RUNNING:
1295         gst_soup_http_src_session_unpause_message (src);
1296         break;
1297       case GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_CANCELLED:
1298         /* Impossible. */
1299         break;
1300     }
1301
1302     if (src->ret == GST_FLOW_CUSTOM_ERROR)
1303       g_main_loop_run (src->loop);
1304   } while (src->ret == GST_FLOW_CUSTOM_ERROR);
1305
1306   if (src->ret == GST_FLOW_CUSTOM_ERROR)
1307     src->ret = GST_FLOW_EOS;
1308   g_cond_signal (&src->request_finished_cond);
1309   return src->ret;
1310 }
1311
1312 static GstFlowReturn
1313 gst_soup_http_src_create (GstPushSrc * psrc, GstBuffer ** outbuf)
1314 {
1315   GstSoupHTTPSrc *src;
1316   GstFlowReturn ret;
1317
1318   src = GST_SOUP_HTTP_SRC (psrc);
1319
1320   g_mutex_lock (&src->mutex);
1321   ret = gst_soup_http_src_do_request (src, SOUP_METHOD_GET, outbuf);
1322   g_mutex_unlock (&src->mutex);
1323   return ret;
1324 }
1325
1326 static gboolean
1327 gst_soup_http_src_start (GstBaseSrc * bsrc)
1328 {
1329   GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (bsrc);
1330
1331   GST_DEBUG_OBJECT (src, "start(\"%s\")", src->location);
1332
1333   return gst_soup_http_src_session_open (src);
1334 }
1335
1336 static gboolean
1337 gst_soup_http_src_stop (GstBaseSrc * bsrc)
1338 {
1339   GstSoupHTTPSrc *src;
1340
1341   src = GST_SOUP_HTTP_SRC (bsrc);
1342   GST_DEBUG_OBJECT (src, "stop()");
1343   gst_soup_http_src_session_close (src);
1344   if (src->loop) {
1345     g_main_loop_unref (src->loop);
1346     g_main_context_unref (src->context);
1347     src->loop = NULL;
1348     src->context = NULL;
1349   }
1350   if (src->extra_headers) {
1351     gst_structure_free (src->extra_headers);
1352     src->extra_headers = NULL;
1353   }
1354
1355   gst_soup_http_src_reset (src);
1356   return TRUE;
1357 }
1358
1359 /* Interrupt a blocking request. */
1360 static gboolean
1361 gst_soup_http_src_unlock (GstBaseSrc * bsrc)
1362 {
1363   GstSoupHTTPSrc *src;
1364
1365   src = GST_SOUP_HTTP_SRC (bsrc);
1366   GST_DEBUG_OBJECT (src, "unlock()");
1367
1368   src->interrupted = TRUE;
1369   if (src->loop)
1370     g_main_loop_quit (src->loop);
1371   g_cond_signal (&src->request_finished_cond);
1372   return TRUE;
1373 }
1374
1375 /* Interrupt interrupt. */
1376 static gboolean
1377 gst_soup_http_src_unlock_stop (GstBaseSrc * bsrc)
1378 {
1379   GstSoupHTTPSrc *src;
1380
1381   src = GST_SOUP_HTTP_SRC (bsrc);
1382   GST_DEBUG_OBJECT (src, "unlock_stop()");
1383
1384   src->interrupted = FALSE;
1385   return TRUE;
1386 }
1387
1388 static gboolean
1389 gst_soup_http_src_get_size (GstBaseSrc * bsrc, guint64 * size)
1390 {
1391   GstSoupHTTPSrc *src;
1392
1393   src = GST_SOUP_HTTP_SRC (bsrc);
1394
1395   if (src->have_size) {
1396     GST_DEBUG_OBJECT (src, "get_size() = %" G_GUINT64_FORMAT,
1397         src->content_size);
1398     *size = src->content_size;
1399     return TRUE;
1400   }
1401   GST_DEBUG_OBJECT (src, "get_size() = FALSE");
1402   return FALSE;
1403 }
1404
1405 static void
1406 gst_soup_http_src_check_seekable (GstSoupHTTPSrc * src)
1407 {
1408   GstFlowReturn ret = GST_FLOW_OK;
1409
1410   /* Special case to check if the server allows range requests
1411    * before really starting to get data in the buffer creation
1412    * loops.
1413    */
1414   if (!src->got_headers && GST_STATE (src) >= GST_STATE_PAUSED) {
1415     g_mutex_lock (&src->mutex);
1416     while (!src->got_headers && !src->interrupted && ret == GST_FLOW_OK) {
1417       if ((src->msg && src->msg->method != SOUP_METHOD_HEAD) &&
1418           src->session_io_status != GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_IDLE) {
1419         /* wait for the current request to finish */
1420         g_cond_wait (&src->request_finished_cond, &src->mutex);
1421       } else {
1422         if (gst_soup_http_src_session_open (src)) {
1423           ret = gst_soup_http_src_do_request (src, SOUP_METHOD_HEAD, NULL);
1424         }
1425       }
1426     }
1427     if (src->ret == GST_FLOW_EOS) {
1428       /* A HEAD request shouldn't lead to EOS */
1429       src->ret = GST_FLOW_OK;
1430     }
1431     /* resets status to idle */
1432     gst_soup_http_src_cancel_message (src);
1433     g_mutex_unlock (&src->mutex);
1434   }
1435
1436 }
1437
1438 static gboolean
1439 gst_soup_http_src_is_seekable (GstBaseSrc * bsrc)
1440 {
1441   GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (bsrc);
1442
1443   gst_soup_http_src_check_seekable (src);
1444
1445   return src->seekable;
1446 }
1447
1448 static gboolean
1449 gst_soup_http_src_do_seek (GstBaseSrc * bsrc, GstSegment * segment)
1450 {
1451   GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (bsrc);
1452
1453   GST_DEBUG_OBJECT (src, "do_seek(%" G_GUINT64_FORMAT "-%" G_GUINT64_FORMAT
1454       ")", segment->start, segment->stop);
1455   if (src->read_position == segment->start &&
1456       src->request_position == src->read_position &&
1457       src->stop_position == segment->stop) {
1458     GST_DEBUG_OBJECT (src,
1459         "Seek to current read/end position and no seek pending");
1460     return TRUE;
1461   }
1462
1463   gst_soup_http_src_check_seekable (src);
1464
1465   /* If we have no headers we don't know yet if it is seekable or not.
1466    * Store the start position and error out later if it isn't */
1467   if (src->got_headers && !src->seekable) {
1468     GST_WARNING_OBJECT (src, "Not seekable");
1469     return FALSE;
1470   }
1471
1472   if (segment->rate < 0.0 || segment->format != GST_FORMAT_BYTES) {
1473     GST_WARNING_OBJECT (src, "Invalid seek segment");
1474     return FALSE;
1475   }
1476
1477   if (src->content_size != 0 && segment->start >= src->content_size) {
1478     GST_WARNING_OBJECT (src,
1479         "Potentially seeking behind end of file, might EOS immediately");
1480   }
1481
1482   /* Wait for create() to handle the jump in offset. */
1483   src->request_position = segment->start;
1484   src->stop_position = segment->stop;
1485   return TRUE;
1486 }
1487
1488 static gboolean
1489 gst_soup_http_src_query (GstBaseSrc * bsrc, GstQuery * query)
1490 {
1491   GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (bsrc);
1492   gboolean ret;
1493   GstSchedulingFlags flags;
1494   gint minsize, maxsize, align;
1495
1496   switch (GST_QUERY_TYPE (query)) {
1497     case GST_QUERY_URI:
1498       gst_query_set_uri (query, src->location);
1499       if (src->redirection_uri != NULL)
1500         gst_query_set_uri_redirection (query, src->redirection_uri);
1501       ret = TRUE;
1502       break;
1503     default:
1504       ret = FALSE;
1505       break;
1506   }
1507
1508   if (!ret)
1509     ret = GST_BASE_SRC_CLASS (parent_class)->query (bsrc, query);
1510
1511   switch (GST_QUERY_TYPE (query)) {
1512     case GST_QUERY_SCHEDULING:
1513       gst_query_parse_scheduling (query, &flags, &minsize, &maxsize, &align);
1514       flags |= GST_SCHEDULING_FLAG_BANDWIDTH_LIMITED;
1515       gst_query_set_scheduling (query, flags, minsize, maxsize, align);
1516       break;
1517     default:
1518       break;
1519   }
1520
1521   return ret;
1522 }
1523
1524 static gboolean
1525 gst_soup_http_src_set_location (GstSoupHTTPSrc * src, const gchar * uri,
1526     GError ** error)
1527 {
1528   const char *alt_schemes[] = { "icy://", "icyx://" };
1529   guint i;
1530
1531   if (src->location) {
1532     g_free (src->location);
1533     src->location = NULL;
1534   }
1535
1536   if (uri == NULL)
1537     return FALSE;
1538
1539   for (i = 0; i < G_N_ELEMENTS (alt_schemes); i++) {
1540     if (g_str_has_prefix (uri, alt_schemes[i])) {
1541       src->location =
1542           g_strdup_printf ("http://%s", uri + strlen (alt_schemes[i]));
1543       return TRUE;
1544     }
1545   }
1546
1547   if (src->redirection_uri) {
1548     g_free (src->redirection_uri);
1549     src->redirection_uri = NULL;
1550   }
1551
1552   src->location = g_strdup (uri);
1553
1554   return TRUE;
1555 }
1556
1557 static gboolean
1558 gst_soup_http_src_set_proxy (GstSoupHTTPSrc * src, const gchar * uri)
1559 {
1560   if (src->proxy) {
1561     soup_uri_free (src->proxy);
1562     src->proxy = NULL;
1563   }
1564   if (g_str_has_prefix (uri, "http://")) {
1565     src->proxy = soup_uri_new (uri);
1566   } else {
1567     gchar *new_uri = g_strconcat ("http://", uri, NULL);
1568
1569     src->proxy = soup_uri_new (new_uri);
1570     g_free (new_uri);
1571   }
1572
1573   return TRUE;
1574 }
1575
1576 static guint
1577 gst_soup_http_src_uri_get_type (GType type)
1578 {
1579   return GST_URI_SRC;
1580 }
1581
1582 static const gchar *const *
1583 gst_soup_http_src_uri_get_protocols (GType type)
1584 {
1585   static const gchar *protocols[] = { "http", "https", "icy", "icyx", NULL };
1586
1587   return protocols;
1588 }
1589
1590 static gchar *
1591 gst_soup_http_src_uri_get_uri (GstURIHandler * handler)
1592 {
1593   GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (handler);
1594
1595   /* FIXME: make thread-safe */
1596   return g_strdup (src->location);
1597 }
1598
1599 static gboolean
1600 gst_soup_http_src_uri_set_uri (GstURIHandler * handler, const gchar * uri,
1601     GError ** error)
1602 {
1603   GstSoupHTTPSrc *src = GST_SOUP_HTTP_SRC (handler);
1604
1605   return gst_soup_http_src_set_location (src, uri, error);
1606 }
1607
1608 static void
1609 gst_soup_http_src_uri_handler_init (gpointer g_iface, gpointer iface_data)
1610 {
1611   GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
1612
1613   iface->get_type = gst_soup_http_src_uri_get_type;
1614   iface->get_protocols = gst_soup_http_src_uri_get_protocols;
1615   iface->get_uri = gst_soup_http_src_uri_get_uri;
1616   iface->set_uri = gst_soup_http_src_uri_set_uri;
1617 }