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