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 /**
  92  * GstRTSPPublishClockMode:
  93  * @GST_RTSP_PUBLISH_CLOCK_MODE_NONE: Publish nothing
  94  * @GST_RTSP_PUBLISH_CLOCK_MODE_CLOCK: Publish the clock but not the offset
  95  * @GST_RTSP_PUBLISH_CLOCK_MODE_CLOCK_AND_OFFSET: Publish the clock and offset
  96  *
  97  * Whether the clock and possibly RTP/clock offset should be published according to RFC7273.
  98  */
  99 typedef enum {
 100   GST_RTSP_PUBLISH_CLOCK_MODE_NONE,
 101   GST_RTSP_PUBLISH_CLOCK_MODE_CLOCK,
 102   GST_RTSP_PUBLISH_CLOCK_MODE_CLOCK_AND_OFFSET
 103 } GstRTSPPublishClockMode;
 104
 105 #define GST_TYPE_RTSP_TRANSPORT_MODE (gst_rtsp_transport_mode_get_type())
 106 GST_EXPORT
 107 GType gst_rtsp_transport_mode_get_type (void);
 108
 109 #define GST_TYPE_RTSP_SUSPEND_MODE (gst_rtsp_suspend_mode_get_type())
 110 GST_EXPORT
 111 GType gst_rtsp_suspend_mode_get_type (void);
 112
 113 #define GST_TYPE_RTSP_PUBLISH_CLOCK_MODE (gst_rtsp_publish_clock_mode_get_type())
 114 GST_EXPORT
 115 GType gst_rtsp_publish_clock_mode_get_type (void);
 116
 117 #include "rtsp-stream.h"
 118 #include "rtsp-thread-pool.h"
 119 #include "rtsp-permissions.h"
 120 #include "rtsp-address-pool.h"
 121 #include "rtsp-sdp.h"
 122
 123 /**
 124  * GstRTSPMedia:
 125  *
 126  * A class that contains the GStreamer element along with a list of
 127  * #GstRTSPStream objects that can produce data.
 128  *
 129  * This object is usually created from a #GstRTSPMediaFactory.
 130  */
 131 struct _GstRTSPMedia {
 132   GObject            parent;
 133
 134   /*< private >*/
 135   GstRTSPMediaPrivate *priv;
 136   gpointer _gst_reserved[GST_PADDING];
 137 };
 138
 139 /**
 140  * GstRTSPMediaClass:
 141  * @handle_message: handle a message
 142  * @prepare: the default implementation adds all elements and sets the
 143  *           pipeline's state to GST_STATE_PAUSED (or GST_STATE_PLAYING
 144  *           in case of NO_PREROLL elements).
 145  * @unprepare: the default implementation sets the pipeline's state
 146  *             to GST_STATE_NULL and removes all elements.
 147  * @suspend: the default implementation sets the pipeline's state to
 148  *           GST_STATE_NULL GST_STATE_PAUSED depending on the selected
 149  *           suspend mode.
 150  * @unsuspend: the default implementation reverts the suspend operation.
 151  *             The pipeline will be prerolled again if it's state was
 152  *             set to GST_STATE_NULL in suspend.
 153  * @convert_range: convert a range to the given unit
 154  * @query_position: query the current position in the pipeline
 155  * @query_stop: query when playback will stop
 156  *
 157  * The RTSP media class
 158  */
 159 struct _GstRTSPMediaClass {
 160   GObjectClass  parent_class;
 161
 162   /* vmethods */
 163   gboolean        (*handle_message)  (GstRTSPMedia *media, GstMessage *message);
 164   gboolean        (*prepare)         (GstRTSPMedia *media, GstRTSPThread *thread);
 165   gboolean        (*unprepare)       (GstRTSPMedia *media);
 166   gboolean        (*suspend)         (GstRTSPMedia *media);
 167   gboolean        (*unsuspend)       (GstRTSPMedia *media);
 168   gboolean        (*convert_range)   (GstRTSPMedia *media, GstRTSPTimeRange *range,
 169                                       GstRTSPRangeUnit unit);
 170   gboolean        (*query_position)  (GstRTSPMedia *media, gint64 *position);
 171   gboolean        (*query_stop)      (GstRTSPMedia *media, gint64 *stop);
 172   GstElement *    (*create_rtpbin)   (GstRTSPMedia *media);
 173   gboolean        (*setup_rtpbin)    (GstRTSPMedia *media, GstElement *rtpbin);
 174   gboolean        (*setup_sdp)       (GstRTSPMedia *media, GstSDPMessage *sdp, GstSDPInfo *info);
 175
 176   /* signals */
 177   void            (*new_stream)      (GstRTSPMedia *media, GstRTSPStream * stream);
 178   void            (*removed_stream)  (GstRTSPMedia *media, GstRTSPStream * stream);
 179
 180   void            (*prepared)        (GstRTSPMedia *media);
 181   void            (*unprepared)      (GstRTSPMedia *media);
 182
 183   void            (*target_state)    (GstRTSPMedia *media, GstState state);
 184   void            (*new_state)       (GstRTSPMedia *media, GstState state);
 185
 186   gboolean        (*handle_sdp)      (GstRTSPMedia *media, GstSDPMessage *sdp);
 187
 188   /*< private >*/
 189   gpointer         _gst_reserved[GST_PADDING_LARGE-1];
 190 };
 191
 192 GST_EXPORT
 193 GType                 gst_rtsp_media_get_type         (void);
 194
 195 /* creating the media */
 196
 197 GST_EXPORT
 198 GstRTSPMedia *        gst_rtsp_media_new              (GstElement *element);
 199
 200 GST_EXPORT
 201 GstElement *          gst_rtsp_media_get_element      (GstRTSPMedia *media);
 202
 203 GST_EXPORT
 204 void                  gst_rtsp_media_take_pipeline    (GstRTSPMedia *media, GstPipeline *pipeline);
 205
 206 GST_EXPORT
 207 GstRTSPMediaStatus    gst_rtsp_media_get_status       (GstRTSPMedia *media);
 208
 209 GST_EXPORT
 210 void                  gst_rtsp_media_set_permissions  (GstRTSPMedia *media,
 211                                                        GstRTSPPermissions *permissions);
 212
 213 GST_EXPORT
 214 GstRTSPPermissions *  gst_rtsp_media_get_permissions  (GstRTSPMedia *media);
 215
 216 GST_EXPORT
 217 void                  gst_rtsp_media_set_shared       (GstRTSPMedia *media, gboolean shared);
 218
 219 GST_EXPORT
 220 gboolean              gst_rtsp_media_is_shared        (GstRTSPMedia *media);
 221
 222 GST_EXPORT
 223 void                  gst_rtsp_media_set_stop_on_disconnect (GstRTSPMedia *media, gboolean stop_on_disconnect);
 224
 225 GST_EXPORT
 226 gboolean              gst_rtsp_media_is_stop_on_disconnect  (GstRTSPMedia *media);
 227
 228 GST_EXPORT
 229 void                  gst_rtsp_media_set_transport_mode  (GstRTSPMedia *media, GstRTSPTransportMode mode);
 230
 231 GST_EXPORT
 232 GstRTSPTransportMode  gst_rtsp_media_get_transport_mode  (GstRTSPMedia *media);
 233
 234 GST_EXPORT
 235 void                  gst_rtsp_media_set_reusable     (GstRTSPMedia *media, gboolean reusable);
 236
 237 GST_EXPORT
 238 gboolean              gst_rtsp_media_is_reusable      (GstRTSPMedia *media);
 239
 240 GST_EXPORT
 241 void                  gst_rtsp_media_set_profiles     (GstRTSPMedia *media, GstRTSPProfile profiles);
 242
 243 GST_EXPORT
 244 GstRTSPProfile        gst_rtsp_media_get_profiles     (GstRTSPMedia *media);
 245
 246 GST_EXPORT
 247 void                  gst_rtsp_media_set_protocols    (GstRTSPMedia *media, GstRTSPLowerTrans protocols);
 248
 249 GST_EXPORT
 250 GstRTSPLowerTrans     gst_rtsp_media_get_protocols    (GstRTSPMedia *media);
 251
 252 GST_EXPORT
 253 void                  gst_rtsp_media_set_eos_shutdown (GstRTSPMedia *media, gboolean eos_shutdown);
 254
 255 GST_EXPORT
 256 gboolean              gst_rtsp_media_is_eos_shutdown  (GstRTSPMedia *media);
 257
 258 GST_EXPORT
 259 void                  gst_rtsp_media_set_address_pool (GstRTSPMedia *media, GstRTSPAddressPool *pool);
 260
 261 GST_EXPORT
 262 GstRTSPAddressPool *  gst_rtsp_media_get_address_pool (GstRTSPMedia *media);
 263
 264 GST_EXPORT
 265 void                  gst_rtsp_media_set_multicast_iface (GstRTSPMedia *media, const gchar *multicast_iface);
 266
 267 GST_EXPORT
 268 gchar *               gst_rtsp_media_get_multicast_iface (GstRTSPMedia *media);
 269
 270 GST_EXPORT
 271 void                  gst_rtsp_media_set_buffer_size  (GstRTSPMedia *media, guint size);
 272
 273 GST_EXPORT
 274 guint                 gst_rtsp_media_get_buffer_size  (GstRTSPMedia *media);
 275
 276 GST_EXPORT
 277 void                  gst_rtsp_media_set_retransmission_time  (GstRTSPMedia *media, GstClockTime time);
 278
 279 GST_EXPORT
 280 GstClockTime          gst_rtsp_media_get_retransmission_time  (GstRTSPMedia *media);
 281
 282 GST_EXPORT
 283 void                  gst_rtsp_media_set_latency      (GstRTSPMedia *media, guint latency);
 284
 285 GST_EXPORT
 286 guint                 gst_rtsp_media_get_latency      (GstRTSPMedia *media);
 287
 288 GST_EXPORT
 289 void                  gst_rtsp_media_use_time_provider (GstRTSPMedia *media, gboolean time_provider);
 290
 291 GST_EXPORT
 292 gboolean              gst_rtsp_media_is_time_provider  (GstRTSPMedia *media);
 293
 294 GST_EXPORT
 295 GstNetTimeProvider *  gst_rtsp_media_get_time_provider (GstRTSPMedia *media,
 296                                                         const gchar *address, guint16 port);
 297
 298 GST_EXPORT
 299 void                  gst_rtsp_media_set_clock         (GstRTSPMedia *media, GstClock * clock);
 300
 301
 302 GST_EXPORT
 303 void                    gst_rtsp_media_set_publish_clock_mode (GstRTSPMedia * media, GstRTSPPublishClockMode mode);
 304
 305 GST_EXPORT
 306 GstRTSPPublishClockMode gst_rtsp_media_get_publish_clock_mode (GstRTSPMedia * media);
 307
 308 /* prepare the media for playback */
 309
 310 GST_EXPORT
 311 gboolean              gst_rtsp_media_prepare          (GstRTSPMedia *media, GstRTSPThread *thread);
 312
 313 GST_EXPORT
 314 gboolean              gst_rtsp_media_unprepare        (GstRTSPMedia *media);
 315
 316 GST_EXPORT
 317 void                  gst_rtsp_media_set_suspend_mode (GstRTSPMedia *media, GstRTSPSuspendMode mode);
 318
 319 GST_EXPORT
 320 GstRTSPSuspendMode    gst_rtsp_media_get_suspend_mode (GstRTSPMedia *media);
 321
 322 GST_EXPORT
 323 gboolean              gst_rtsp_media_suspend          (GstRTSPMedia *media);
 324
 325 GST_EXPORT
 326 gboolean              gst_rtsp_media_unsuspend        (GstRTSPMedia *media);
 327
 328 GST_EXPORT
 329 gboolean              gst_rtsp_media_setup_sdp        (GstRTSPMedia * media, GstSDPMessage * sdp,
 330                                                        GstSDPInfo * info);
 331
 332 GST_EXPORT
 333 gboolean              gst_rtsp_media_handle_sdp (GstRTSPMedia * media, GstSDPMessage * sdp);
 334
 335
 336 /* creating streams */
 337
 338 GST_EXPORT
 339 void                  gst_rtsp_media_collect_streams  (GstRTSPMedia *media);
 340
 341 GST_EXPORT
 342 GstRTSPStream *       gst_rtsp_media_create_stream    (GstRTSPMedia *media,
 343                                                        GstElement *payloader,
 344                                                        GstPad *pad);
 345
 346 /* dealing with the media */
 347
 348 GST_EXPORT
 349 GstClock *            gst_rtsp_media_get_clock        (GstRTSPMedia *media);
 350
 351 GST_EXPORT
 352 GstClockTime          gst_rtsp_media_get_base_time    (GstRTSPMedia *media);
 353
 354 GST_EXPORT
 355 guint                 gst_rtsp_media_n_streams        (GstRTSPMedia *media);
 356
 357 GST_EXPORT
 358 GstRTSPStream *       gst_rtsp_media_get_stream       (GstRTSPMedia *media, guint idx);
 359
 360 GST_EXPORT
 361 GstRTSPStream *       gst_rtsp_media_find_stream      (GstRTSPMedia *media, const gchar * control);
 362
 363 GST_EXPORT
 364 gboolean              gst_rtsp_media_seek             (GstRTSPMedia *media, GstRTSPTimeRange *range);
 365
 366 GST_EXPORT
 367 gboolean              gst_rtsp_media_seek_full        (GstRTSPMedia *media,
 368                                                        GstRTSPTimeRange *range,
 369                                                        GstSeekFlags flags);
 370
 371 GST_EXPORT
 372 GstClockTimeDiff      gst_rtsp_media_seekable         (GstRTSPMedia *media);
 373
 374 GST_EXPORT
 375 gchar *               gst_rtsp_media_get_range_string (GstRTSPMedia *media,
 376                                                        gboolean play,
 377                                                        GstRTSPRangeUnit unit);
 378
 379 GST_EXPORT
 380 gboolean              gst_rtsp_media_set_state        (GstRTSPMedia *media, GstState state,
 381                                                        GPtrArray *transports);
 382
 383 GST_EXPORT
 384 void                  gst_rtsp_media_set_pipeline_state (GstRTSPMedia * media,
 385                                                          GstState state);
 386
 387 GST_EXPORT
 388 gboolean              gst_rtsp_media_complete_pipeline (GstRTSPMedia * media, GPtrArray * transports);
 389
 390 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
 391 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstRTSPMedia, gst_object_unref)
 392 #endif
 393
 394 G_END_DECLS
 395
 396 #endif /* __GST_RTSP_MEDIA_H__ */