gst/rtsp-server/rtsp-media-factory.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/gstrtspurl.h>
  22
  23 #include "rtsp-media.h"
  24 #include "rtsp-permissions.h"
  25 #include "rtsp-address-pool.h"
  26
  27 #ifndef __GST_RTSP_MEDIA_FACTORY_H__
  28 #define __GST_RTSP_MEDIA_FACTORY_H__
  29
  30 G_BEGIN_DECLS
  31
  32 /* types for the media factory */
  33 #define GST_TYPE_RTSP_MEDIA_FACTORY              (gst_rtsp_media_factory_get_type ())
  34 #define GST_IS_RTSP_MEDIA_FACTORY(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_RTSP_MEDIA_FACTORY))
  35 #define GST_IS_RTSP_MEDIA_FACTORY_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_RTSP_MEDIA_FACTORY))
  36 #define GST_RTSP_MEDIA_FACTORY_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_RTSP_MEDIA_FACTORY, GstRTSPMediaFactoryClass))
  37 #define GST_RTSP_MEDIA_FACTORY(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_RTSP_MEDIA_FACTORY, GstRTSPMediaFactory))
  38 #define GST_RTSP_MEDIA_FACTORY_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_RTSP_MEDIA_FACTORY, GstRTSPMediaFactoryClass))
  39 #define GST_RTSP_MEDIA_FACTORY_CAST(obj)         ((GstRTSPMediaFactory*)(obj))
  40 #define GST_RTSP_MEDIA_FACTORY_CLASS_CAST(klass) ((GstRTSPMediaFactoryClass*)(klass))
  41
  42 typedef struct _GstRTSPMediaFactory GstRTSPMediaFactory;
  43 typedef struct _GstRTSPMediaFactoryClass GstRTSPMediaFactoryClass;
  44 typedef struct _GstRTSPMediaFactoryPrivate GstRTSPMediaFactoryPrivate;
  45
  46 /**
  47  * GstRTSPMediaFactory:
  48  *
  49  * The definition and logic for constructing the pipeline for a media. The media
  50  * can contain multiple streams like audio and video.
  51  */
  52 struct _GstRTSPMediaFactory {
  53   GObject            parent;
  54
  55   /*< private >*/
  56   GstRTSPMediaFactoryPrivate *priv;
  57   gpointer _gst_reserved[GST_PADDING];
  58 };
  59
  60 /**
  61  * GstRTSPMediaFactoryClass:
  62  * @gen_key: convert @url to a key for caching shared #GstRTSPMedia objects.
  63  *       The default implementation of this function will use the complete URL
  64  *       including the query parameters to return a key.
  65  * @create_element: Construct and return a #GstElement that is a #GstBin containing
  66  *       the elements to use for streaming the media. The bin should contain
  67  *       payloaders pay\%d for each stream. The default implementation of this
  68  *       function returns the bin created from the launch parameter.
  69  * @construct: the vmethod that will be called when the factory has to create the
  70  *       #GstRTSPMedia for @url. The default implementation of this
  71  *       function calls create_element to retrieve an element and then looks for
  72  *       pay\%d to create the streams.
  73  * @create_pipeline: create a new pipeline or re-use an existing one and
  74  *       add the #GstRTSPMedia's element created by @construct to the pipeline.
  75  * @configure: configure the media created with @construct. The default
  76  *       implementation will configure the 'shared' property of the media.
  77  * @media_constructed: signal emited when a media was constructed
  78  * @media_configure: signal emited when a media should be configured
  79  *
  80  * The #GstRTSPMediaFactory class structure.
  81  */
  82 struct _GstRTSPMediaFactoryClass {
  83   GObjectClass  parent_class;
  84
  85   gchar *         (*gen_key)            (GstRTSPMediaFactory *factory, const GstRTSPUrl *url);
  86
  87   GstElement *    (*create_element)     (GstRTSPMediaFactory *factory, const GstRTSPUrl *url);
  88   GstRTSPMedia *  (*construct)          (GstRTSPMediaFactory *factory, const GstRTSPUrl *url);
  89   GstElement *    (*create_pipeline)    (GstRTSPMediaFactory *factory, GstRTSPMedia *media);
  90   void            (*configure)          (GstRTSPMediaFactory *factory, GstRTSPMedia *media);
  91
  92   /* signals */
  93   void            (*media_constructed)  (GstRTSPMediaFactory *factory, GstRTSPMedia *media);
  94   void            (*media_configure)    (GstRTSPMediaFactory *factory, GstRTSPMedia *media);
  95
  96   /*< private >*/
  97   gpointer         _gst_reserved[GST_PADDING_LARGE];
  98 };
  99
 100 GType                 gst_rtsp_media_factory_get_type     (void);
 101
 102 /* creating the factory */
 103 GstRTSPMediaFactory * gst_rtsp_media_factory_new          (void);
 104
 105 /* configuring the factory */
 106 void                  gst_rtsp_media_factory_set_launch       (GstRTSPMediaFactory *factory,
 107                                                                const gchar *launch);
 108 gchar *               gst_rtsp_media_factory_get_launch       (GstRTSPMediaFactory *factory);
 109
 110 void                  gst_rtsp_media_factory_set_permissions  (GstRTSPMediaFactory *factory,
 111                                                                GstRTSPPermissions *permissions);
 112 GstRTSPPermissions *  gst_rtsp_media_factory_get_permissions  (GstRTSPMediaFactory *factory);
 113 void                  gst_rtsp_media_factory_add_role         (GstRTSPMediaFactory *factory,
 114                                                                const gchar *role,
 115                                                                const gchar *fieldname, ...);
 116
 117 void                  gst_rtsp_media_factory_set_shared       (GstRTSPMediaFactory *factory,
 118                                                                gboolean shared);
 119 gboolean              gst_rtsp_media_factory_is_shared        (GstRTSPMediaFactory *factory);
 120
 121 void                  gst_rtsp_media_factory_set_stop_on_disconnect       (GstRTSPMediaFactory *factory,
 122                                                                            gboolean stop_on_disconnect);
 123 gboolean              gst_rtsp_media_factory_is_stop_on_disonnect        (GstRTSPMediaFactory *factory);
 124
 125 void                  gst_rtsp_media_factory_set_suspend_mode (GstRTSPMediaFactory *factory,
 126                                                                GstRTSPSuspendMode mode);
 127 GstRTSPSuspendMode    gst_rtsp_media_factory_get_suspend_mode (GstRTSPMediaFactory *factory);
 128
 129 void                  gst_rtsp_media_factory_set_eos_shutdown (GstRTSPMediaFactory *factory,
 130                                                                gboolean eos_shutdown);
 131 gboolean              gst_rtsp_media_factory_is_eos_shutdown  (GstRTSPMediaFactory *factory);
 132
 133 void                  gst_rtsp_media_factory_set_profiles     (GstRTSPMediaFactory *factory,
 134                                                                GstRTSPProfile profiles);
 135 GstRTSPProfile        gst_rtsp_media_factory_get_profiles     (GstRTSPMediaFactory *factory);
 136
 137 void                  gst_rtsp_media_factory_set_protocols    (GstRTSPMediaFactory *factory,
 138                                                                GstRTSPLowerTrans protocols);
 139 GstRTSPLowerTrans     gst_rtsp_media_factory_get_protocols    (GstRTSPMediaFactory *factory);
 140
 141 void                  gst_rtsp_media_factory_set_address_pool (GstRTSPMediaFactory * factory,
 142                                                                GstRTSPAddressPool * pool);
 143 GstRTSPAddressPool *  gst_rtsp_media_factory_get_address_pool (GstRTSPMediaFactory * factory);
 144
 145 void                  gst_rtsp_media_factory_set_buffer_size  (GstRTSPMediaFactory * factory,
 146                                                                guint size);
 147 guint                 gst_rtsp_media_factory_get_buffer_size  (GstRTSPMediaFactory * factory);
 148 void                  gst_rtsp_media_factory_set_retransmission_time (GstRTSPMediaFactory * factory,
 149                                                                       GstClockTime time);
 150 GstClockTime          gst_rtsp_media_factory_get_retransmission_time (GstRTSPMediaFactory * factory);
 151
 152 void                  gst_rtsp_media_factory_set_latency      (GstRTSPMediaFactory * factory,
 153                                                                guint                 latency);
 154 guint                 gst_rtsp_media_factory_get_latency      (GstRTSPMediaFactory * factory);
 155
 156 void                  gst_rtsp_media_factory_set_transport_mode (GstRTSPMediaFactory *factory,
 157                                                                  GstRTSPTransportMode mode);
 158 GstRTSPTransportMode  gst_rtsp_media_factory_get_transport_mode (GstRTSPMediaFactory *factory);
 159
 160 void                  gst_rtsp_media_factory_set_media_gtype  (GstRTSPMediaFactory * factory,
 161                                                                GType media_gtype);
 162 GType                 gst_rtsp_media_factory_get_media_gtype  (GstRTSPMediaFactory * factory);
 163
 164 void                  gst_rtsp_media_factory_set_clock        (GstRTSPMediaFactory *factory,
 165                                                                GstClock * clock);
 166 GstClock *            gst_rtsp_media_factory_get_clock        (GstRTSPMediaFactory *factory);
 167
 168 /* creating the media from the factory and a url */
 169 GstRTSPMedia *        gst_rtsp_media_factory_construct        (GstRTSPMediaFactory *factory,
 170                                                                const GstRTSPUrl *url);
 171
 172 GstElement *          gst_rtsp_media_factory_create_element   (GstRTSPMediaFactory *factory,
 173                                                                const GstRTSPUrl *url);
 174
 175 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
 176 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstRTSPMediaFactory, gst_object_unref)
 177 #endif
 178
 179 G_END_DECLS
 180
 181 #endif /* __GST_RTSP_MEDIA_FACTORY_H__ */