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