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