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-auth.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
  45 #define GST_RTSP_MEDIA_FACTORY_GET_LOCK(f)       (&(GST_RTSP_MEDIA_FACTORY_CAST(f)->lock))
  46 #define GST_RTSP_MEDIA_FACTORY_LOCK(f)           (g_mutex_lock(GST_RTSP_MEDIA_FACTORY_GET_LOCK(f)))
  47 #define GST_RTSP_MEDIA_FACTORY_UNLOCK(f)         (g_mutex_unlock(GST_RTSP_MEDIA_FACTORY_GET_LOCK(f)))
  48
  49 /**
  50  * GstRTSPMediaFactory:
  51  * @parent: the parent GObject
  52  * @lock: mutex protecting the datastructure.
  53  * @launch: the launch description
  54  * @shared: if media from this factory can be shared between clients
  55  * @eos_shutdown: if shutdown should first send EOS to the pipeline
  56  * @protocols: allowed transport protocols
  57  * @auth: the authentication manager
  58  * @buffer_size: the kernel udp buffer size
  59  * @pool: the multicast address pool to use
  60  * @medias_lock: mutex protecting the medias.
  61  * @medias: hashtable of shared media
  62  *
  63  * The definition and logic for constructing the pipeline for a media. The media
  64  * can contain multiple streams like audio and video.
  65  */
  66 struct _GstRTSPMediaFactory {
  67   GObject            parent;
  68
  69   GMutex             lock;
  70   gchar             *launch;
  71   gboolean           shared;
  72   gboolean           eos_shutdown;
  73   GstRTSPLowerTrans  protocols;
  74   GstRTSPAuth       *auth;
  75   guint              buffer_size;
  76   GstRTSPAddressPool *pool;
  77
  78   GMutex             medias_lock;
  79   GHashTable        *medias;
  80 };
  81
  82 /**
  83  * GstRTSPMediaFactoryClass:
  84  * @gen_key: convert @url to a key for caching shared #GstRTSPMedia objects.
  85  *       The default implementation of this function will use the complete URL
  86  *       including the query parameters to return a key.
  87  * @create_element: Construct and return a #GstElement that is a #GstBin containing
  88  *       the elements to use for streaming the media. The bin should contain
  89  *       payloaders pay%d for each stream. The default implementation of this
  90  *       function returns the bin created from the launch parameter.
  91  * @construct: the vmethod that will be called when the factory has to create the
  92  *       #GstRTSPMedia for @url. The default implementation of this
  93  *       function calls create_element to retrieve an element and then looks for
  94  *       pay%d to create the streams.
  95  * @configure: configure the media created with @construct. The default
  96  *       implementation will configure the 'shared' property of the media.
  97  * @create_pipeline: create a new pipeline or re-use an existing one and
  98  *       add the #GstRTSPMedia's element created by @construct to the pipeline.
  99  * @media_constructed: signal emited when a media was cunstructed
 100  * @media_configure: signal emited when a media should be configured
 101  *
 102  * The #GstRTSPMediaFactory class structure.
 103  */
 104 struct _GstRTSPMediaFactoryClass {
 105   GObjectClass  parent_class;
 106
 107   gchar *         (*gen_key)            (GstRTSPMediaFactory *factory, const GstRTSPUrl *url);
 108
 109   GstElement *    (*create_element)     (GstRTSPMediaFactory *factory, const GstRTSPUrl *url);
 110   GstRTSPMedia *  (*construct)          (GstRTSPMediaFactory *factory, const GstRTSPUrl *url);
 111   void            (*configure)          (GstRTSPMediaFactory *factory, GstRTSPMedia *media);
 112   GstElement *    (*create_pipeline)    (GstRTSPMediaFactory *factory, GstRTSPMedia *media);
 113
 114   /* signals */
 115   void            (*media_constructed)  (GstRTSPMediaFactory *factory, GstRTSPMedia *media);
 116   void            (*media_configure)    (GstRTSPMediaFactory *factory, GstRTSPMedia *media);
 117 };
 118
 119 GType                 gst_rtsp_media_factory_get_type     (void);
 120
 121 /* creating the factory */
 122 GstRTSPMediaFactory * gst_rtsp_media_factory_new          (void);
 123
 124 /* configuring the factory */
 125 void                  gst_rtsp_media_factory_set_launch   (GstRTSPMediaFactory *factory,
 126                                                            const gchar *launch);
 127 gchar *               gst_rtsp_media_factory_get_launch   (GstRTSPMediaFactory *factory);
 128
 129 void                  gst_rtsp_media_factory_set_shared   (GstRTSPMediaFactory *factory,
 130                                                            gboolean shared);
 131 gboolean              gst_rtsp_media_factory_is_shared    (GstRTSPMediaFactory *factory);
 132
 133 void                  gst_rtsp_media_factory_set_eos_shutdown   (GstRTSPMediaFactory *factory,
 134                                                                  gboolean eos_shutdown);
 135 gboolean              gst_rtsp_media_factory_is_eos_shutdown    (GstRTSPMediaFactory *factory);
 136
 137 void                  gst_rtsp_media_factory_set_protocols  (GstRTSPMediaFactory *factory, GstRTSPLowerTrans protocols);
 138 GstRTSPLowerTrans     gst_rtsp_media_factory_get_protocols  (GstRTSPMediaFactory *factory);
 139
 140 void                  gst_rtsp_media_factory_set_auth     (GstRTSPMediaFactory *factory, GstRTSPAuth *auth);
 141 GstRTSPAuth *         gst_rtsp_media_factory_get_auth     (GstRTSPMediaFactory *factory);
 142
 143 void                  gst_rtsp_media_factory_set_address_pool   (GstRTSPMediaFactory * factory,
 144                                                                  GstRTSPAddressPool * pool);
 145 GstRTSPAddressPool *  gst_rtsp_media_factory_get_address_pool   (GstRTSPMediaFactory * factory);
 146
 147 void                  gst_rtsp_media_factory_set_buffer_size    (GstRTSPMediaFactory * factory, guint size);
 148 guint                 gst_rtsp_media_factory_get_buffer_size    (GstRTSPMediaFactory * factory);
 149
 150 /* creating the media from the factory and a url */
 151 GstRTSPMedia *        gst_rtsp_media_factory_construct       (GstRTSPMediaFactory *factory,
 152                                                               const GstRTSPUrl *url);
 153
 154 GstElement *          gst_rtsp_media_factory_create_element  (GstRTSPMediaFactory *factory,
 155                                                               const GstRTSPUrl *url);
 156
 157 G_END_DECLS
 158
 159 #endif /* __GST_RTSP_MEDIA_FACTORY_H__ */