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
  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
  42 #include "rtsp-stream.h"
  43 #include "rtsp-auth.h"
  44 #include "rtsp-address-pool.h"
  45
  46 /**
  47  * GstRTSPMediaStatus:
  48  * @GST_RTSP_MEDIA_STATUS_UNPREPARED: media pipeline not prerolled
  49  * @GST_RTSP_MEDIA_STATUS_UNPREPARING: media pipeline is busy doing a clean
  50  *                                     shutdown.
  51  * @GST_RTSP_MEDIA_STATUS_PREPARING: media pipeline is prerolling
  52  * @GST_RTSP_MEDIA_STATUS_PREPARED: media pipeline is prerolled
  53  * @GST_RTSP_MEDIA_STATUS_ERROR: media pipeline is in error
  54  *
  55  * The state of the media pipeline.
  56  */
  57 typedef enum {
  58   GST_RTSP_MEDIA_STATUS_UNPREPARED  = 0,
  59   GST_RTSP_MEDIA_STATUS_UNPREPARING = 1,
  60   GST_RTSP_MEDIA_STATUS_PREPARING   = 2,
  61   GST_RTSP_MEDIA_STATUS_PREPARED    = 3,
  62   GST_RTSP_MEDIA_STATUS_ERROR       = 4
  63 } GstRTSPMediaStatus;
  64
  65 /**
  66  * GstRTSPMedia:
  67  * @parent: parent GObject
  68  * @lock: for protecting the object
  69  * @cond: for signaling the object
  70  * @shared: if this media can be shared between clients
  71  * @reusable: if this media can be reused after an unprepare
  72  * @protocols: the allowed lower transport for this stream
  73  * @reused: if this media has been reused
  74  * @is_ipv6: if this media is using ipv6
  75  * @eos_shutdown: if EOS should be sent on shutdown
  76  * @buffer_size: The UDP buffer size
  77  * @auth: the authentication service in use
  78  * @multicast_group: the multicast group to use
  79  * @element: the data providing element
  80  * @streams: the different #GstRTSPStream provided by @element
  81  * @dynamic: list of dynamic elements managed by @element
  82  * @status: the status of the media pipeline
  83  * @n_active: the number of active connections
  84  * @adding: when elements are added to the pipeline
  85  * @pipeline: the toplevel pipeline
  86  * @fakesink: for making state changes async
  87  * @source: the bus watch for pipeline messages.
  88  * @id: the id of the watch
  89  * @is_live: if the pipeline is live
  90  * @seekable: if the pipeline can perform a seek
  91  * @buffering: if the pipeline is buffering
  92  * @target_state: the desired target state of the pipeline
  93  * @rtpbin: the rtpbin
  94  * @range: the range of the media being streamed
  95  *
  96  * A class that contains the GStreamer element along with a list of
  97  * #GstRTSPStream objects that can produce data.
  98  *
  99  * This object is usually created from a #GstRTSPMediaFactory.
 100  */
 101 struct _GstRTSPMedia {
 102   GObject            parent;
 103
 104   GMutex             lock;
 105   GCond              cond;
 106
 107   gboolean           shared;
 108   gboolean           reusable;
 109   GstRTSPLowerTrans  protocols;
 110   gboolean           reused;
 111   gboolean           is_ipv6;
 112   gboolean           eos_shutdown;
 113   guint              buffer_size;
 114   GstRTSPAuth       *auth;
 115   GstRTSPAddressPool*pool;
 116
 117   GstElement        *element;
 118   GRecMutex          state_lock;
 119   GPtrArray         *streams;
 120   GList             *dynamic;
 121   GstRTSPMediaStatus status;
 122   gint               n_active;
 123   gboolean           adding;
 124
 125   /* the pipeline for the media */
 126   GstElement        *pipeline;
 127   GstElement        *fakesink;
 128   GSource           *source;
 129   guint              id;
 130
 131   gboolean           is_live;
 132   gboolean           seekable;
 133   gboolean           buffering;
 134   GstState           target_state;
 135
 136   /* RTP session manager */
 137   GstElement        *rtpbin;
 138
 139   /* the range of media */
 140   GstRTSPTimeRange   range;
 141 };
 142
 143 /**
 144  * GstRTSPMediaClass:
 145  * @context: the main context for dispatching messages
 146  * @loop: the mainloop for message.
 147  * @thread: the thread dispatching messages.
 148  * @handle_message: handle a message
 149  * @unprepare: the default implementation sets the pipeline's state
 150  *             to GST_STATE_NULL and removes all elements.
 151  *
 152  * The RTSP media class
 153  */
 154 struct _GstRTSPMediaClass {
 155   GObjectClass  parent_class;
 156
 157   /* thread for the mainloop */
 158   GMainContext *context;
 159   GMainLoop    *loop;
 160   GThread      *thread;
 161
 162   /* vmethods */
 163   gboolean        (*handle_message)  (GstRTSPMedia *media, GstMessage *message);
 164   gboolean        (*unprepare)       (GstRTSPMedia *media);
 165
 166   /* signals */
 167   gboolean        (*new_stream)      (GstRTSPMedia *media, GstRTSPStream * stream);
 168
 169   gboolean        (*prepared)        (GstRTSPMedia *media);
 170   gboolean        (*unprepared)      (GstRTSPMedia *media);
 171
 172   gboolean        (*new_state)       (GstRTSPMedia *media, GstState state);
 173 };
 174
 175 GType                 gst_rtsp_media_get_type         (void);
 176
 177 /* creating the media */
 178 GstRTSPMedia *        gst_rtsp_media_new              (void);
 179
 180 void                  gst_rtsp_media_set_shared       (GstRTSPMedia *media, gboolean shared);
 181 gboolean              gst_rtsp_media_is_shared        (GstRTSPMedia *media);
 182
 183 void                  gst_rtsp_media_set_reusable     (GstRTSPMedia *media, gboolean reusable);
 184 gboolean              gst_rtsp_media_is_reusable      (GstRTSPMedia *media);
 185
 186 void                  gst_rtsp_media_set_protocols    (GstRTSPMedia *media, GstRTSPLowerTrans protocols);
 187 GstRTSPLowerTrans     gst_rtsp_media_get_protocols    (GstRTSPMedia *media);
 188
 189 void                  gst_rtsp_media_set_eos_shutdown (GstRTSPMedia *media, gboolean eos_shutdown);
 190 gboolean              gst_rtsp_media_is_eos_shutdown  (GstRTSPMedia *media);
 191
 192 void                  gst_rtsp_media_set_auth         (GstRTSPMedia *media, GstRTSPAuth *auth);
 193 GstRTSPAuth *         gst_rtsp_media_get_auth         (GstRTSPMedia *media);
 194
 195 void                  gst_rtsp_media_set_address_pool (GstRTSPMedia *media, GstRTSPAddressPool *pool);
 196 GstRTSPAddressPool *  gst_rtsp_media_get_address_pool (GstRTSPMedia *media);
 197
 198 void                  gst_rtsp_media_set_buffer_size  (GstRTSPMedia *media, guint size);
 199 guint                 gst_rtsp_media_get_buffer_size  (GstRTSPMedia *media);
 200
 201
 202 /* prepare the media for playback */
 203 gboolean              gst_rtsp_media_prepare          (GstRTSPMedia *media);
 204 gboolean              gst_rtsp_media_unprepare        (GstRTSPMedia *media);
 205
 206 /* creating streams */
 207 void                  gst_rtsp_media_collect_streams  (GstRTSPMedia *media);
 208 GstRTSPStream *       gst_rtsp_media_create_stream    (GstRTSPMedia *media,
 209                                                        GstElement *payloader,
 210                                                        GstPad *srcpad);
 211
 212 /* dealing with the media */
 213 guint                 gst_rtsp_media_n_streams        (GstRTSPMedia *media);
 214 GstRTSPStream *       gst_rtsp_media_get_stream       (GstRTSPMedia *media, guint idx);
 215
 216 gboolean              gst_rtsp_media_seek             (GstRTSPMedia *media, GstRTSPTimeRange *range);
 217 gchar *               gst_rtsp_media_get_range_string (GstRTSPMedia *media, gboolean play);
 218
 219 gboolean              gst_rtsp_media_set_state        (GstRTSPMedia *media, GstState state,
 220                                                        GPtrArray *transports);
 221
 222 G_END_DECLS
 223
 224 #endif /* __GST_RTSP_MEDIA_H__ */