gst/rtsp-server/rtsp-stream.h

   1 /* GStreamer
   2  * Copyright (C) 2008 Wim Taymans <wim.taymans at gmail.com>
   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 details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  17  * Boston, MA 02110-1301, USA.
  18  */
  19
  20 #include <gst/gst.h>
  21 #include <gst/rtsp/gstrtsprange.h>
  22 #include <gst/rtsp/gstrtspurl.h>
  23 #include <gio/gio.h>
  24
  25 #ifndef __GST_RTSP_STREAM_H__
  26 #define __GST_RTSP_STREAM_H__
  27
  28 G_BEGIN_DECLS
  29
  30 /* types for the media stream */
  31 #define GST_TYPE_RTSP_STREAM              (gst_rtsp_stream_get_type ())
  32 #define GST_IS_RTSP_STREAM(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_RTSP_STREAM))
  33 #define GST_IS_RTSP_STREAM_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_RTSP_STREAM))
  34 #define GST_RTSP_STREAM_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_RTSP_STREAM, GstRTSPStreamClass))
  35 #define GST_RTSP_STREAM(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_RTSP_STREAM, GstRTSPStream))
  36 #define GST_RTSP_STREAM_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_RTSP_STREAM, GstRTSPStreamClass))
  37 #define GST_RTSP_STREAM_CAST(obj)         ((GstRTSPStream*)(obj))
  38 #define GST_RTSP_STREAM_CLASS_CAST(klass) ((GstRTSPStreamClass*)(klass))
  39
  40 typedef struct _GstRTSPStream GstRTSPStream;
  41 typedef struct _GstRTSPStreamClass GstRTSPStreamClass;
  42 typedef struct _GstRTSPStreamPrivate GstRTSPStreamPrivate;
  43
  44 #include "rtsp-stream-transport.h"
  45 #include "rtsp-address-pool.h"
  46 #include "rtsp-session.h"
  47
  48 /**
  49  * GstRTSPStream:
  50  *
  51  * The definition of a media stream.
  52  */
  53 struct _GstRTSPStream {
  54   GObject       parent;
  55
  56   /*< private >*/
  57   GstRTSPStreamPrivate *priv;
  58   gpointer _gst_reserved[GST_PADDING];};
  59
  60 struct _GstRTSPStreamClass {
  61   GObjectClass parent_class;
  62
  63   /*< private >*/
  64   gpointer _gst_reserved[GST_PADDING];
  65 };
  66
  67 GType             gst_rtsp_stream_get_type         (void);
  68
  69 GstRTSPStream *   gst_rtsp_stream_new              (guint idx, GstElement *payloader,
  70                                                     GstPad *srcpad);
  71 guint             gst_rtsp_stream_get_index        (GstRTSPStream *stream);
  72 guint             gst_rtsp_stream_get_pt           (GstRTSPStream *stream);
  73 GstPad *          gst_rtsp_stream_get_srcpad       (GstRTSPStream *stream);
  74
  75 void              gst_rtsp_stream_set_control      (GstRTSPStream *stream, const gchar *control);
  76 gchar *           gst_rtsp_stream_get_control      (GstRTSPStream *stream);
  77 gboolean          gst_rtsp_stream_has_control      (GstRTSPStream *stream, const gchar *control);
  78
  79 void              gst_rtsp_stream_set_mtu          (GstRTSPStream *stream, guint mtu);
  80 guint             gst_rtsp_stream_get_mtu          (GstRTSPStream *stream);
  81
  82 void              gst_rtsp_stream_set_dscp_qos     (GstRTSPStream *stream, gint dscp_qos);
  83 gint              gst_rtsp_stream_get_dscp_qos     (GstRTSPStream *stream);
  84
  85 gboolean          gst_rtsp_stream_is_transport_supported  (GstRTSPStream *stream,
  86                                                            GstRTSPTransport *transport);
  87
  88 void              gst_rtsp_stream_set_protocols    (GstRTSPStream *stream, GstRTSPLowerTrans protocols);
  89 GstRTSPLowerTrans gst_rtsp_stream_get_protocols    (GstRTSPStream *stream);
  90
  91 void              gst_rtsp_stream_set_address_pool (GstRTSPStream *stream, GstRTSPAddressPool *pool);
  92 GstRTSPAddressPool *
  93                   gst_rtsp_stream_get_address_pool (GstRTSPStream *stream);
  94
  95 GstRTSPAddress *  gst_rtsp_stream_reserve_address  (GstRTSPStream *stream,
  96                                                     const gchar * address,
  97                                                     guint port,
  98                                                     guint n_ports,
  99                                                     guint ttl);
 100
 101 gboolean          gst_rtsp_stream_join_bin         (GstRTSPStream *stream,
 102                                                     GstBin *bin, GstElement *rtpbin,
 103                                                     GstState state);
 104 gboolean          gst_rtsp_stream_leave_bin        (GstRTSPStream *stream,
 105                                                     GstBin *bin, GstElement *rtpbin);
 106
 107 gboolean          gst_rtsp_stream_set_blocked      (GstRTSPStream * stream,
 108                                                     gboolean blocked);
 109 gboolean          gst_rtsp_stream_is_blocking      (GstRTSPStream * stream);
 110
 111 void              gst_rtsp_stream_get_server_port  (GstRTSPStream *stream,
 112                                                     GstRTSPRange *server_port,
 113                                                     GSocketFamily family);
 114 GstRTSPAddress *  gst_rtsp_stream_get_multicast_address (GstRTSPStream *stream,
 115                                                          GSocketFamily family);
 116
 117
 118 GObject *         gst_rtsp_stream_get_rtpsession   (GstRTSPStream *stream);
 119
 120 void              gst_rtsp_stream_get_ssrc         (GstRTSPStream *stream,
 121                                                     guint *ssrc);
 122
 123 gboolean          gst_rtsp_stream_get_rtpinfo      (GstRTSPStream *stream,
 124                                                     guint *rtptime, guint *seq,
 125                                                     guint *clock_rate,
 126                                                     GstClockTime *running_time);
 127 GstCaps *         gst_rtsp_stream_get_caps         (GstRTSPStream *stream);
 128
 129 GstFlowReturn     gst_rtsp_stream_recv_rtp         (GstRTSPStream *stream,
 130                                                     GstBuffer *buffer);
 131 GstFlowReturn     gst_rtsp_stream_recv_rtcp        (GstRTSPStream *stream,
 132                                                     GstBuffer *buffer);
 133
 134 gboolean          gst_rtsp_stream_add_transport    (GstRTSPStream *stream,
 135                                                     GstRTSPStreamTransport *trans);
 136 gboolean          gst_rtsp_stream_remove_transport (GstRTSPStream *stream,
 137                                                     GstRTSPStreamTransport *trans);
 138
 139 GSocket *         gst_rtsp_stream_get_rtp_socket   (GstRTSPStream *stream,
 140                                                     GSocketFamily family);
 141 GSocket *         gst_rtsp_stream_get_rtcp_socket  (GstRTSPStream *stream,
 142                                                     GSocketFamily family);
 143
 144 /**
 145  * GstRTSPStreamTransportFilterFunc:
 146  * @stream: a #GstRTSPStream object
 147  * @trans: a #GstRTSPStreamTransport in @stream
 148  * @user_data: user data that has been given to gst_rtsp_stream_transport_filter()
 149  *
 150  * This function will be called by the gst_rtsp_stream_transport_filter(). An
 151  * implementation should return a value of #GstRTSPFilterResult.
 152  *
 153  * When this function returns #GST_RTSP_FILTER_REMOVE, @trans will be removed
 154  * from @stream.
 155  *
 156  * A return value of #GST_RTSP_FILTER_KEEP will leave @trans untouched in
 157  * @stream.
 158  *
 159  * A value of #GST_RTSP_FILTER_REF will add @trans to the result #GList of
 160  * gst_rtsp_stream_transport_filter().
 161  *
 162  * Returns: a #GstRTSPFilterResult.
 163  */
 164 typedef GstRTSPFilterResult (*GstRTSPStreamTransportFilterFunc) (GstRTSPStream *stream,
 165                                                                  GstRTSPStreamTransport *trans,
 166                                                                  gpointer user_data);
 167
 168 GList *                gst_rtsp_stream_transport_filter  (GstRTSPStream *stream,
 169                                                           GstRTSPStreamTransportFilterFunc func,
 170                                                           gpointer user_data);
 171
 172 G_END_DECLS
 173
 174 #endif /* __GST_RTSP_STREAM_H__ */