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