ext/soup/gstsouphttpsrc.h

   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 #ifndef __GST_SOUP_HTTP_SRC_H__
  16 #define __GST_SOUP_HTTP_SRC_H__
  17
  18 #include <gst/gst.h>
  19 #include <gst/base/gstpushsrc.h>
  20 #include <glib.h>
  21
  22 G_BEGIN_DECLS
  23
  24 #include <libsoup/soup.h>
  25
  26 #define GST_TYPE_SOUP_HTTP_SRC \
  27   (gst_soup_http_src_get_type())
  28 #define GST_SOUP_HTTP_SRC(obj) \
  29   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_SOUP_HTTP_SRC,GstSoupHTTPSrc))
  30 #define GST_SOUP_HTTP_SRC_CLASS(klass) \
  31   (G_TYPE_CHECK_CLASS_CAST((klass), \
  32       GST_TYPE_SOUP_HTTP_SRC,GstSoupHTTPSrcClass))
  33 #define GST_IS_SOUP_HTTP_SRC(obj) \
  34   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_SOUP_HTTP_SRC))
  35 #define GST_IS_SOUP_HTTP_SRC_CLASS(klass) \
  36   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_SOUP_HTTP_SRC))
  37
  38 typedef struct _GstSoupHTTPSrc GstSoupHTTPSrc;
  39 typedef struct _GstSoupHTTPSrcClass GstSoupHTTPSrcClass;
  40
  41 typedef enum {
  42   GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_IDLE,
  43   GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_QUEUED,
  44   GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_RUNNING,
  45   GST_SOUP_HTTP_SRC_SESSION_IO_STATUS_CANCELLED,
  46 } GstSoupHTTPSrcSessionIOStatus;
  47
  48 struct _GstSoupHTTPSrc {
  49   GstPushSrc element;
  50
  51   gchar *location;             /* Full URI. */
  52   gchar *redirection_uri;      /* Full URI after redirections. */
  53   gboolean redirection_permanent; /* Permanent or temporary redirect? */
  54   gchar *user_agent;           /* User-Agent HTTP header. */
  55   gboolean automatic_redirect; /* Follow redirects. */
  56   SoupURI *proxy;              /* HTTP proxy URI. */
  57   gchar *user_id;              /* Authentication user id for location URI. */
  58   gchar *user_pw;              /* Authentication user password for location URI. */
  59   gchar *proxy_id;             /* Authentication user id for proxy URI. */
  60   gchar *proxy_pw;             /* Authentication user password for proxy URI. */
  61   gchar **cookies;             /* HTTP request cookies. */
  62   GMainContext *context;       /* I/O context. */
  63   GMainLoop *loop;             /* Event loop. */
  64   SoupSession *session;        /* Async context. */
  65   GstSoupHTTPSrcSessionIOStatus session_io_status;
  66                                /* Async I/O status. */
  67   SoupMessage *msg;            /* Request message. */
  68   GstFlowReturn ret;           /* Return code from callback. */
  69   GstBuffer **outbuf;          /* Return buffer allocated by callback. */
  70   gboolean interrupted;        /* Signal unlock(). */
  71   gboolean retry;              /* Should attempt to reconnect. */
  72   gint retry_count;            /* Number of retries since we received data */
  73   gint max_retries;            /* Maximum number of retries */
  74
  75   gboolean got_headers;        /* Already received headers from the server */
  76   gboolean have_size;          /* Received and parsed Content-Length
  77                                   header. */
  78   guint64 content_size;        /* Value of Content-Length header. */
  79   guint64 read_position;       /* Current position. */
  80   gboolean seekable;           /* FALSE if the server does not support
  81                                   Range. */
  82   guint64 request_position;    /* Seek to this position. */
  83   guint64 stop_position;       /* Stop at this position. */
  84   gboolean have_body;          /* Indicates if it has just been signaled the
  85                                 * end of the message body. This is used to
  86                                 * decide if an out of range request should be
  87                                 * handled as an error or EOS when the content
  88                                 * size is unknown */
  89   gboolean keep_alive;         /* Use keep-alive sessions */
  90   gboolean ssl_strict;
  91   gchar *ssl_ca_file;
  92   gboolean ssl_use_system_ca_file;
  93   GTlsDatabase *tls_database;
  94
  95   /* Shoutcast/icecast metadata extraction handling. */
  96   gboolean iradio_mode;
  97   GstCaps *src_caps;
  98   gchar *iradio_name;
  99   gchar *iradio_genre;
 100   gchar *iradio_url;
 101
 102   GstStructure *extra_headers;
 103
 104   SoupLoggerLogLevel log_level;/* Soup HTTP session logger level */
 105
 106   gboolean compress;
 107
 108   guint timeout;
 109
 110   GMutex mutex;
 111   GCond request_finished_cond;
 112
 113   GstEvent *http_headers_event;
 114 };
 115
 116 struct _GstSoupHTTPSrcClass {
 117   GstPushSrcClass parent_class;
 118 };
 119
 120 GType gst_soup_http_src_get_type (void);
 121
 122 G_END_DECLS
 123
 124 #endif /* __GST_SOUP_HTTP_SRC_H__ */
 125