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 #include "rtsp-stream.h"
  45 #include "rtsp-thread-pool.h"
  46 #include "rtsp-permissions.h"
  47 #include "rtsp-address-pool.h"
  48
  49 /**
  50  * GstRTSPMediaStatus:
  51  * @GST_RTSP_MEDIA_STATUS_UNPREPARED: media pipeline not prerolled
  52  * @GST_RTSP_MEDIA_STATUS_UNPREPARING: media pipeline is busy doing a clean
  53  *                                     shutdown.
  54  * @GST_RTSP_MEDIA_STATUS_PREPARING: media pipeline is prerolling
  55  * @GST_RTSP_MEDIA_STATUS_PREPARED: media pipeline is prerolled
  56  * @GST_RTSP_MEDIA_STATUS_ERROR: media pipeline is in error
  57  *
  58  * The state of the media pipeline.
  59  */
  60 typedef enum {
  61   GST_RTSP_MEDIA_STATUS_UNPREPARED  = 0,
  62   GST_RTSP_MEDIA_STATUS_UNPREPARING = 1,
  63   GST_RTSP_MEDIA_STATUS_PREPARING   = 2,
  64   GST_RTSP_MEDIA_STATUS_PREPARED    = 3,
  65   GST_RTSP_MEDIA_STATUS_ERROR       = 4
  66 } GstRTSPMediaStatus;
  67
  68 /**
  69  * GstRTSPMedia:
  70  *
  71  * A class that contains the GStreamer element along with a list of
  72  * #GstRTSPStream objects that can produce data.
  73  *
  74  * This object is usually created from a #GstRTSPMediaFactory.
  75  */
  76 struct _GstRTSPMedia {
  77   GObject            parent;
  78
  79   /*< private >*/
  80   GstRTSPMediaPrivate *priv;
  81 };
  82
  83 /**
  84  * GstRTSPMediaClass:
  85  * @handle_message: handle a message
  86  * @unprepare: the default implementation sets the pipeline's state
  87  *             to GST_STATE_NULL and removes all elements.
  88  * @convert_range: convert a range to the given unit
  89  * @query_position: query the current posision in the pipeline
  90  * @query_stop: query when playback will stop
  91  *
  92  * The RTSP media class
  93  */
  94 struct _GstRTSPMediaClass {
  95   GObjectClass  parent_class;
  96
  97   /* vmethods */
  98   gboolean        (*handle_message)  (GstRTSPMedia *media, GstMessage *message);
  99   gboolean        (*unprepare)       (GstRTSPMedia *media);
 100   gboolean        (*convert_range)   (GstRTSPMedia *media, GstRTSPTimeRange *range,
 101                                       GstRTSPRangeUnit unit);
 102   gboolean        (*query_position)  (GstRTSPMedia *media, gint64 *position);
 103   gboolean        (*query_stop)      (GstRTSPMedia *media, gint64 *stop);
 104
 105   /* signals */
 106   void            (*new_stream)      (GstRTSPMedia *media, GstRTSPStream * stream);
 107   void            (*removed_stream)  (GstRTSPMedia *media, GstRTSPStream * stream);
 108
 109   void            (*prepared)        (GstRTSPMedia *media);
 110   void            (*unprepared)      (GstRTSPMedia *media);
 111
 112   void            (*new_state)       (GstRTSPMedia *media, GstState state);
 113 };
 114
 115 GType                 gst_rtsp_media_get_type         (void);
 116
 117 /* creating the media */
 118 GstRTSPMedia *        gst_rtsp_media_new              (GstElement *element);
 119 GstElement *          gst_rtsp_media_get_element      (GstRTSPMedia *media);
 120
 121 void                  gst_rtsp_media_take_pipeline    (GstRTSPMedia *media, GstPipeline *pipeline);
 122
 123 GstRTSPMediaStatus    gst_rtsp_media_get_status       (GstRTSPMedia *media);
 124
 125 void                  gst_rtsp_media_set_permissions  (GstRTSPMedia *media,
 126                                                        GstRTSPPermissions *permissions);
 127 GstRTSPPermissions *  gst_rtsp_media_get_permissions  (GstRTSPMedia *media);
 128
 129 void                  gst_rtsp_media_set_shared       (GstRTSPMedia *media, gboolean shared);
 130 gboolean              gst_rtsp_media_is_shared        (GstRTSPMedia *media);
 131
 132 void                  gst_rtsp_media_set_reusable     (GstRTSPMedia *media, gboolean reusable);
 133 gboolean              gst_rtsp_media_is_reusable      (GstRTSPMedia *media);
 134
 135 void                  gst_rtsp_media_set_protocols    (GstRTSPMedia *media, GstRTSPLowerTrans protocols);
 136 GstRTSPLowerTrans     gst_rtsp_media_get_protocols    (GstRTSPMedia *media);
 137
 138 void                  gst_rtsp_media_set_eos_shutdown (GstRTSPMedia *media, gboolean eos_shutdown);
 139 gboolean              gst_rtsp_media_is_eos_shutdown  (GstRTSPMedia *media);
 140
 141 void                  gst_rtsp_media_set_address_pool (GstRTSPMedia *media, GstRTSPAddressPool *pool);
 142 GstRTSPAddressPool *  gst_rtsp_media_get_address_pool (GstRTSPMedia *media);
 143
 144 void                  gst_rtsp_media_set_buffer_size  (GstRTSPMedia *media, guint size);
 145 guint                 gst_rtsp_media_get_buffer_size  (GstRTSPMedia *media);
 146
 147 void                  gst_rtsp_media_use_time_provider (GstRTSPMedia *media, gboolean time_provider);
 148 gboolean              gst_rtsp_media_is_time_provider  (GstRTSPMedia *media);
 149 GstNetTimeProvider *  gst_rtsp_media_get_time_provider (GstRTSPMedia *media,
 150                                                         const gchar *address, guint16 port);
 151
 152 /* prepare the media for playback */
 153 gboolean              gst_rtsp_media_prepare          (GstRTSPMedia *media, GstRTSPThread *thread);
 154 gboolean              gst_rtsp_media_unprepare        (GstRTSPMedia *media);
 155
 156 /* creating streams */
 157 void                  gst_rtsp_media_collect_streams  (GstRTSPMedia *media);
 158 GstRTSPStream *       gst_rtsp_media_create_stream    (GstRTSPMedia *media,
 159                                                        GstElement *payloader,
 160                                                        GstPad *srcpad);
 161
 162 /* dealing with the media */
 163 GstClock *            gst_rtsp_media_get_clock        (GstRTSPMedia *media);
 164 GstClockTime          gst_rtsp_media_get_base_time    (GstRTSPMedia *media);
 165
 166 guint                 gst_rtsp_media_n_streams        (GstRTSPMedia *media);
 167 GstRTSPStream *       gst_rtsp_media_get_stream       (GstRTSPMedia *media, guint idx);
 168 GstRTSPStream *       gst_rtsp_media_find_stream      (GstRTSPMedia *media, const gchar * control);
 169
 170 gboolean              gst_rtsp_media_seek             (GstRTSPMedia *media, GstRTSPTimeRange *range);
 171 gchar *               gst_rtsp_media_get_range_string (GstRTSPMedia *media,
 172                                                        gboolean play,
 173                                                        GstRTSPRangeUnit unit);
 174
 175 gboolean              gst_rtsp_media_set_state        (GstRTSPMedia *media, GstState state,
 176                                                        GPtrArray *transports);
 177 void                  gst_rtsp_media_set_pipeline_state (GstRTSPMedia * media,
 178                                                          GstState state);
 179
 180 G_END_DECLS
 181
 182 #endif /* __GST_RTSP_MEDIA_H__ */