gst/rtsp/gstrtspsrc.h

   1 /* GStreamer
   2  * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
   3  *               <2006> Wim Taymans <wim@fluendo.com>
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Library General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Library General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Library General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20 /*
  21  * Unless otherwise indicated, Source Code is licensed under MIT license.
  22  * See further explanation attached in License Statement (distributed in the file
  23  * LICENSE).
  24  *
  25  * Permission is hereby granted, free of charge, to any person obtaining a copy of
  26  * this software and associated documentation files (the "Software"), to deal in
  27  * the Software without restriction, including without limitation the rights to
  28  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
  29  * of the Software, and to permit persons to whom the Software is furnished to do
  30  * so, subject to the following conditions:
  31  *
  32  * The above copyright notice and this permission notice shall be included in all
  33  * copies or substantial portions of the Software.
  34  *
  35  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  36  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  37  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  38  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  39  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  40  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  41  * SOFTWARE.
  42  */
  43
  44 #ifndef __GST_RTSPSRC_H__
  45 #define __GST_RTSPSRC_H__
  46
  47 #include <gst/gst.h>
  48
  49 G_BEGIN_DECLS
  50
  51 #include <gst/rtsp/gstrtspconnection.h>
  52 #include <gst/rtsp/gstrtspmessage.h>
  53 #include <gst/rtsp/gstrtspurl.h>
  54 #include <gst/rtsp/gstrtsprange.h>
  55
  56 #include "gstrtspext.h"
  57
  58 #define GST_TYPE_RTSPSRC \
  59   (gst_rtspsrc_get_type())
  60 #define GST_RTSPSRC(obj) \
  61   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_RTSPSRC,GstRTSPSrc))
  62 #define GST_RTSPSRC_CLASS(klass) \
  63   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_RTSPSRC,GstRTSPSrcClass))
  64 #define GST_IS_RTSPSRC(obj) \
  65   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_RTSPSRC))
  66 #define GST_IS_RTSPSRC_CLASS(klass) \
  67   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_RTSPSRC))
  68 #define GST_RTSPSRC_CAST(obj) \
  69   ((GstRTSPSrc *)(obj))
  70
  71 typedef struct _GstRTSPSrc GstRTSPSrc;
  72 typedef struct _GstRTSPSrcClass GstRTSPSrcClass;
  73
  74 #define GST_RTSP_STATE_GET_LOCK(rtsp)    (&GST_RTSPSRC_CAST(rtsp)->state_rec_lock)
  75 #define GST_RTSP_STATE_LOCK(rtsp)        (g_rec_mutex_lock (GST_RTSP_STATE_GET_LOCK(rtsp)))
  76 #define GST_RTSP_STATE_UNLOCK(rtsp)      (g_rec_mutex_unlock (GST_RTSP_STATE_GET_LOCK(rtsp)))
  77
  78 #define GST_RTSP_STREAM_GET_LOCK(rtsp)   (&GST_RTSPSRC_CAST(rtsp)->stream_rec_lock)
  79 #define GST_RTSP_STREAM_LOCK(rtsp)       (g_rec_mutex_lock (GST_RTSP_STREAM_GET_LOCK(rtsp)))
  80 #define GST_RTSP_STREAM_UNLOCK(rtsp)     (g_rec_mutex_unlock (GST_RTSP_STREAM_GET_LOCK(rtsp)))
  81
  82 typedef struct _GstRTSPConnInfo GstRTSPConnInfo;
  83
  84 struct _GstRTSPConnInfo {
  85   gchar              *location;
  86   GstRTSPUrl         *url;
  87   gchar              *url_str;
  88   GstRTSPConnection  *connection;
  89   gboolean            connected;
  90 };
  91
  92 typedef struct _GstRTSPStream GstRTSPStream;
  93
  94 struct _GstRTSPStream {
  95   gint          id;
  96
  97   GstRTSPSrc   *parent; /* parent, no extra ref to parent is taken */
  98
  99   /* pad we expose or NULL when it does not have an actual pad */
 100   GstPad       *srcpad;
 101   GstFlowReturn last_ret;
 102   gboolean      added;
 103   gboolean      disabled;
 104   gboolean      eos;
 105   gboolean      discont;
 106
 107   /* for interleaved mode */
 108   guint8        channel[2];
 109   GstCaps      *caps;
 110   GstPad       *channelpad[2];
 111
 112   /* our udp sources */
 113   GstElement   *udpsrc[2];
 114   GstPad       *blockedpad;
 115   gulong        blockid;
 116   gboolean      is_ipv6;
 117
 118   /* our udp sinks back to the server */
 119   GstElement   *udpsink[2];
 120   GstPad       *rtcppad;
 121
 122   /* fakesrc for sending dummy data */
 123   GstElement   *fakesrc;
 124
 125   /* state */
 126   gint          pt;
 127   guint         port;
 128   gboolean      container;
 129   /* original control url */
 130   gchar        *control_url;
 131   guint32       ssrc;
 132   guint32       seqbase;
 133   guint64       timebase;
 134
 135   /* per stream connection */
 136   GstRTSPConnInfo  conninfo;
 137
 138   /* session */
 139   GObject      *session;
 140
 141   /* bandwidth */
 142   guint         as_bandwidth;
 143   guint         rs_bandwidth;
 144   guint         rr_bandwidth;
 145
 146   /* destination */
 147   gchar        *destination;
 148   gboolean      is_multicast;
 149   guint         ttl;
 150 };
 151
 152 /**
 153  * GstRTSPNatMethod:
 154  * @GST_RTSP_NAT_NONE: none
 155  * @GST_RTSP_NAT_DUMMY: send dummy packets
 156  *
 157  * Different methods for trying to traverse firewalls.
 158  */
 159 typedef enum
 160 {
 161   GST_RTSP_NAT_NONE,
 162   GST_RTSP_NAT_DUMMY
 163 } GstRTSPNatMethod;
 164
 165 struct _GstRTSPSrc {
 166   GstBin           parent;
 167
 168   /* task and mutex for interleaved mode */
 169   gboolean         interleaved;
 170   GstTask         *task;
 171   GRecMutex        stream_rec_lock;
 172   GstSegment       segment;
 173   gboolean         running;
 174   gboolean         need_range;
 175   gboolean         skip;
 176   gint             free_channel;
 177   GstEvent        *start_segment;
 178   GstClockTime     base_time;
 179
 180   /* UDP mode loop */
 181   gint             pending_cmd;
 182   gint             busy_cmd;
 183   gboolean         ignore_timeout;
 184   gboolean         open_error;
 185
 186   /* mutex for protecting state changes */
 187   GRecMutex        state_rec_lock;
 188
 189   GstSDPMessage   *sdp;
 190   gboolean         from_sdp;
 191   gint             numstreams;
 192   GList           *streams;
 193   GstStructure    *props;
 194   gboolean         need_activate;
 195
 196   /* properties */
 197   GstRTSPLowerTrans protocols;
 198   gboolean          debug;
 199   guint             retry;
 200   guint64           udp_timeout;
 201   GTimeVal          tcp_timeout;
 202   GTimeVal         *ptcp_timeout;
 203   guint             latency;
 204   guint64           connection_speed;
 205   GstRTSPNatMethod  nat_method;
 206   gboolean          do_rtcp;
 207   gboolean          do_rtsp_keep_alive;
 208   gchar            *proxy_host;
 209   guint             proxy_port;
 210   gchar            *proxy_user;
 211   gchar            *proxy_passwd;
 212   guint             rtp_blocksize;
 213   gchar            *user_id;
 214   gchar            *user_pw;
 215   gint              buffer_mode;
 216   GstRTSPRange      client_port_range;
 217   gint              udp_buffer_size;
 218   gboolean          short_header;
 219
 220   /* state */
 221   GstRTSPState       state;
 222   gchar             *content_base;
 223   GstRTSPLowerTrans  cur_protocols;
 224   gboolean           tried_url_auth;
 225   gchar             *addr;
 226   gboolean           need_redirect;
 227   GstRTSPTimeRange  *range;
 228   gchar             *control;
 229   guint              next_port_num;
 230
 231   /* supported methods */
 232   gint               methods;
 233
 234   gboolean           seekable;
 235   GstClockTime       last_pos;
 236
 237   /* session management */
 238   GstElement      *manager;
 239   gulong           manager_sig_id;
 240   gulong           manager_ptmap_id;
 241
 242   GstRTSPConnInfo  conninfo;
 243
 244   /* a list of RTSP extensions as GstElement */
 245   GstRTSPExtensionList  *extensions;
 246 };
 247
 248 struct _GstRTSPSrcClass {
 249   GstBinClass parent_class;
 250 };
 251
 252 GType gst_rtspsrc_get_type(void);
 253
 254 G_END_DECLS
 255
 256 #endif /* __GST_RTSPSRC_H__ */