gst/rtsp-server/rtsp-media.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/rtsp.h>
  22 #include <gst/net/gstnet.h>
  23
  24 #ifndef __GST_RTSP_MEDIA_H__
  25 #define __GST_RTSP_MEDIA_H__
  26
  27 G_BEGIN_DECLS
  28
  29 /* types for the media */
  30 #define GST_TYPE_RTSP_MEDIA              (gst_rtsp_media_get_type ())
  31 #define GST_IS_RTSP_MEDIA(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_RTSP_MEDIA))
  32 #define GST_IS_RTSP_MEDIA_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_RTSP_MEDIA))
  33 #define GST_RTSP_MEDIA_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_RTSP_MEDIA, GstRTSPMediaClass))
  34 #define GST_RTSP_MEDIA(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_RTSP_MEDIA, GstRTSPMedia))
  35 #define GST_RTSP_MEDIA_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_RTSP_MEDIA, GstRTSPMediaClass))
  36 #define GST_RTSP_MEDIA_CAST(obj)         ((GstRTSPMedia*)(obj))
  37 #define GST_RTSP_MEDIA_CLASS_CAST(klass) ((GstRTSPMediaClass*)(klass))
  38
  39 typedef struct _GstRTSPMedia GstRTSPMedia;
  40 typedef struct _GstRTSPMediaClass GstRTSPMediaClass;
  41 typedef struct _GstRTSPMediaPrivate GstRTSPMediaPrivate;
  42
  43 /**
  44  * GstRTSPMediaStatus:
  45  * @GST_RTSP_MEDIA_STATUS_UNPREPARED: media pipeline not prerolled
  46  * @GST_RTSP_MEDIA_STATUS_UNPREPARING: media pipeline is busy doing a clean
  47  *                                     shutdown.
  48  * @GST_RTSP_MEDIA_STATUS_PREPARING: media pipeline is prerolling
  49  * @GST_RTSP_MEDIA_STATUS_PREPARED: media pipeline is prerolled
  50  * @GST_RTSP_MEDIA_STATUS_SUSPENDED: media is suspended
  51  * @GST_RTSP_MEDIA_STATUS_ERROR: media pipeline is in error
  52  *
  53  * The state of the media pipeline.
  54  */
  55 typedef enum {
  56   GST_RTSP_MEDIA_STATUS_UNPREPARED  = 0,
  57   GST_RTSP_MEDIA_STATUS_UNPREPARING = 1,
  58   GST_RTSP_MEDIA_STATUS_PREPARING   = 2,
  59   GST_RTSP_MEDIA_STATUS_PREPARED    = 3,
  60   GST_RTSP_MEDIA_STATUS_SUSPENDED   = 4,
  61   GST_RTSP_MEDIA_STATUS_ERROR       = 5
  62 } GstRTSPMediaStatus;
  63
  64 /**
  65  * GstRTSPSuspendMode:
  66  * @GST_RTSP_SUSPEND_MODE_NONE: Media is not suspended
  67  * @GST_RTSP_SUSPEND_MODE_PAUSE: Media is PAUSED in suspend
  68  * @GST_RTSP_SUSPEND_MODE_RESET: The media is set to NULL when suspended
  69  *
  70  * The suspend mode of the media pipeline. A media pipeline is suspended right
  71  * after creating the SDP and when the client performs a PAUSED request.
  72  */
  73 typedef enum {
  74   GST_RTSP_SUSPEND_MODE_NONE   = 0,
  75   GST_RTSP_SUSPEND_MODE_PAUSE  = 1,
  76   GST_RTSP_SUSPEND_MODE_RESET  = 2
  77 } GstRTSPSuspendMode;
  78
  79 /**
  80  * GstRTSPTransportMode:
  81  * @GST_RTSP_TRANSPORT_MODE_PLAY: Transport supports PLAY mode
  82  * @GST_RTSP_TRANSPORT_MODE_RECORD: Transport supports RECORD mode
  83  *
  84  * The supported modes of the media.
  85  */
  86 typedef enum {
  87   GST_RTSP_TRANSPORT_MODE_PLAY    = 1,
  88   GST_RTSP_TRANSPORT_MODE_RECORD  = 2,
  89 } GstRTSPTransportMode;
  90
  91 #define GST_TYPE_RTSP_TRANSPORT_MODE (gst_rtsp_transport_mode_get_type())
  92 GType gst_rtsp_transport_mode_get_type (void);
  93
  94 #define GST_TYPE_RTSP_SUSPEND_MODE (gst_rtsp_suspend_mode_get_type())
  95 GType gst_rtsp_suspend_mode_get_type (void);
  96
  97 #include "rtsp-stream.h"
  98 #include "rtsp-thread-pool.h"
  99 #include "rtsp-permissions.h"
 100 #include "rtsp-address-pool.h"
 101 #include "rtsp-sdp.h"
 102
 103 /**
 104  * GstRTSPMedia:
 105  *
 106  * A class that contains the GStreamer element along with a list of
 107  * #GstRTSPStream objects that can produce data.
 108  *
 109  * This object is usually created from a #GstRTSPMediaFactory.
 110  */
 111 struct _GstRTSPMedia {
 112   GObject            parent;
 113
 114   /*< private >*/
 115   GstRTSPMediaPrivate *priv;
 116   gpointer _gst_reserved[GST_PADDING];
 117 };
 118
 119 /**
 120  * GstRTSPMediaClass:
 121  * @handle_message: handle a message
 122  * @prepare: the default implementation adds all elements and sets the
 123  *           pipeline's state to GST_STATE_PAUSED (or GST_STATE_PLAYING
 124  *           in case of NO_PREROLL elements).
 125  * @unprepare: the default implementation sets the pipeline's state
 126  *             to GST_STATE_NULL and removes all elements.
 127  * @suspend: the default implementation sets the pipeline's state to
 128  *           GST_STATE_NULL GST_STATE_PAUSED depending on the selected
 129  *           suspend mode.
 130  * @unsuspend: the default implementation reverts the suspend operation.
 131  *             The pipeline will be prerolled again if it's state was
 132  *             set to GST_STATE_NULL in suspend.
 133  * @convert_range: convert a range to the given unit
 134  * @query_position: query the current position in the pipeline
 135  * @query_stop: query when playback will stop
 136  *
 137  * The RTSP media class
 138  */
 139 struct _GstRTSPMediaClass {
 140   GObjectClass  parent_class;
 141
 142   /* vmethods */
 143   gboolean        (*handle_message)  (GstRTSPMedia *media, GstMessage *message);
 144   gboolean        (*prepare)         (GstRTSPMedia *media, GstRTSPThread *thread);
 145   gboolean        (*start_preroll)   (GstRTSPMedia *media);
 146   gboolean        (*unprepare)       (GstRTSPMedia *media);
 147   gboolean        (*suspend)         (GstRTSPMedia *media);
 148   gboolean        (*unsuspend)       (GstRTSPMedia *media);
 149   gboolean        (*convert_range)   (GstRTSPMedia *media, GstRTSPTimeRange *range,
 150                                       GstRTSPRangeUnit unit);
 151   gboolean        (*query_position)  (GstRTSPMedia *media, gint64 *position);
 152   gboolean        (*query_stop)      (GstRTSPMedia *media, gint64 *stop);
 153   GstElement *    (*create_rtpbin)   (GstRTSPMedia *media);
 154   gboolean        (*setup_rtpbin)    (GstRTSPMedia *media, GstElement *rtpbin);
 155   gboolean        (*setup_sdp)       (GstRTSPMedia *media, GstSDPMessage *sdp, GstSDPInfo *info);
 156   gboolean        (*start_prepare)   (GstRTSPMedia *media);
 157
 158   /* signals */
 159   void            (*new_stream)      (GstRTSPMedia *media, GstRTSPStream * stream);
 160   void            (*removed_stream)  (GstRTSPMedia *media, GstRTSPStream * stream);
 161
 162   void            (*prepared)        (GstRTSPMedia *media);
 163   void            (*unprepared)      (GstRTSPMedia *media);
 164
 165   void            (*target_state)    (GstRTSPMedia *media, GstState state);
 166   void            (*new_state)       (GstRTSPMedia *media, GstState state);
 167
 168   gboolean        (*handle_sdp)      (GstRTSPMedia *media, GstSDPMessage *sdp);
 169
 170   void            (*preparing)       (GstRTSPMedia *media, GstRTSPStream * stream, guint idx);
 171   void            (*unpreparing)     (GstRTSPMedia *media, GstRTSPStream * stream, guint idx);
 172   /*< private >*/
 173   gpointer         _gst_reserved[GST_PADDING_LARGE-1];
 174 };
 175
 176 GType                 gst_rtsp_media_get_type         (void);
 177
 178 /* creating the media */
 179 GstRTSPMedia *        gst_rtsp_media_new              (GstElement *element);
 180 GstElement *          gst_rtsp_media_get_element      (GstRTSPMedia *media);
 181
 182 void                  gst_rtsp_media_take_pipeline    (GstRTSPMedia *media, GstPipeline *pipeline);
 183
 184 GstRTSPMediaStatus    gst_rtsp_media_get_status       (GstRTSPMedia *media);
 185
 186 void                  gst_rtsp_media_set_permissions  (GstRTSPMedia *media,
 187                                                        GstRTSPPermissions *permissions);
 188 GstRTSPPermissions *  gst_rtsp_media_get_permissions  (GstRTSPMedia *media);
 189
 190 void                  gst_rtsp_media_set_shared       (GstRTSPMedia *media, gboolean shared);
 191 gboolean              gst_rtsp_media_is_shared        (GstRTSPMedia *media);
 192
 193 void                  gst_rtsp_media_set_transport_mode  (GstRTSPMedia *media, GstRTSPTransportMode mode);
 194 GstRTSPTransportMode  gst_rtsp_media_get_transport_mode  (GstRTSPMedia *media);
 195
 196 void                  gst_rtsp_media_set_reusable     (GstRTSPMedia *media, gboolean reusable);
 197 gboolean              gst_rtsp_media_is_reusable      (GstRTSPMedia *media);
 198
 199 void                  gst_rtsp_media_set_profiles     (GstRTSPMedia *media, GstRTSPProfile profiles);
 200 GstRTSPProfile        gst_rtsp_media_get_profiles     (GstRTSPMedia *media);
 201
 202 void                  gst_rtsp_media_set_protocols    (GstRTSPMedia *media, GstRTSPLowerTrans protocols);
 203 GstRTSPLowerTrans     gst_rtsp_media_get_protocols    (GstRTSPMedia *media);
 204
 205 void                  gst_rtsp_media_set_eos_shutdown (GstRTSPMedia *media, gboolean eos_shutdown);
 206 gboolean              gst_rtsp_media_is_eos_shutdown  (GstRTSPMedia *media);
 207
 208 void                  gst_rtsp_media_set_address_pool (GstRTSPMedia *media, GstRTSPAddressPool *pool);
 209 GstRTSPAddressPool *  gst_rtsp_media_get_address_pool (GstRTSPMedia *media);
 210
 211 void                  gst_rtsp_media_set_buffer_size  (GstRTSPMedia *media, guint size);
 212 guint                 gst_rtsp_media_get_buffer_size  (GstRTSPMedia *media);
 213
 214 void                  gst_rtsp_media_set_retransmission_time  (GstRTSPMedia *media, GstClockTime time);
 215 GstClockTime          gst_rtsp_media_get_retransmission_time  (GstRTSPMedia *media);
 216
 217 void                  gst_rtsp_media_set_latency      (GstRTSPMedia *media, guint latency);
 218 guint                 gst_rtsp_media_get_latency      (GstRTSPMedia *media);
 219
 220 void                  gst_rtsp_media_use_time_provider (GstRTSPMedia *media, gboolean time_provider);
 221 gboolean              gst_rtsp_media_is_time_provider  (GstRTSPMedia *media);
 222 GstNetTimeProvider *  gst_rtsp_media_get_time_provider (GstRTSPMedia *media,
 223                                                         const gchar *address, guint16 port);
 224
 225 /* prepare the media for playback */
 226 gboolean              gst_rtsp_media_prepare          (GstRTSPMedia *media, GstRTSPThread *thread);
 227 gboolean              gst_rtsp_media_unprepare        (GstRTSPMedia *media);
 228
 229 void                  gst_rtsp_media_set_suspend_mode (GstRTSPMedia *media, GstRTSPSuspendMode mode);
 230 GstRTSPSuspendMode    gst_rtsp_media_get_suspend_mode (GstRTSPMedia *media);
 231
 232 gboolean              gst_rtsp_media_suspend          (GstRTSPMedia *media);
 233 gboolean              gst_rtsp_media_unsuspend        (GstRTSPMedia *media);
 234
 235 gboolean              gst_rtsp_media_setup_sdp        (GstRTSPMedia * media, GstSDPMessage * sdp,
 236                                                        GstSDPInfo * info);
 237
 238 gboolean              gst_rtsp_media_handle_sdp (GstRTSPMedia * media, GstSDPMessage * sdp);
 239
 240
 241 /* creating streams */
 242 void                  gst_rtsp_media_collect_streams  (GstRTSPMedia *media);
 243 GstRTSPStream *       gst_rtsp_media_create_stream    (GstRTSPMedia *media,
 244                                                        GstElement *payloader,
 245                                                        GstPad *pad);
 246
 247 /* dealing with the media */
 248 GstClock *            gst_rtsp_media_get_clock        (GstRTSPMedia *media);
 249 GstClockTime          gst_rtsp_media_get_base_time    (GstRTSPMedia *media);
 250
 251 guint                 gst_rtsp_media_n_streams        (GstRTSPMedia *media);
 252 GstRTSPStream *       gst_rtsp_media_get_stream       (GstRTSPMedia *media, guint idx);
 253 GstRTSPStream *       gst_rtsp_media_find_stream      (GstRTSPMedia *media, const gchar * control);
 254
 255 gboolean              gst_rtsp_media_seek             (GstRTSPMedia *media, GstRTSPTimeRange *range);
 256 gchar *               gst_rtsp_media_get_range_string (GstRTSPMedia *media,
 257                                                        gboolean play,
 258                                                        GstRTSPRangeUnit unit);
 259
 260 gboolean              gst_rtsp_media_set_state        (GstRTSPMedia *media, GstState state,
 261                                                        GPtrArray *transports);
 262 void                  gst_rtsp_media_set_pipeline_state (GstRTSPMedia * media,
 263                                                          GstState state);
 264 GstStateChangeReturn  gst_rtsp_media_set_target_state (GstRTSPMedia * media, GstState state, gboolean do_state);
 265 void                  gst_rtsp_media_set_status (GstRTSPMedia * media, GstRTSPMediaStatus status);
 266
 267 GstElement *          gst_rtsp_media_get_pipeline     (GstRTSPMedia * media);
 268 GstElement *          gst_rtsp_media_get_rtpbin       (GstRTSPMedia * media);
 269
 270 G_END_DECLS
 271
 272 #endif /* __GST_RTSP_MEDIA_H__ */