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., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, 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  * @lock: mutex protecting the datastructure.
  51  * @launch: the launch description
  52  * @shared: if media from this factory can be shared between clients
  53  * @media_lock: mutex protecting the medias.
  54  * @media: hashtable of shared media
  55  *
  56  * The definition and logic for constructing the pipeline for a media. The media
  57  * can contain multiple streams like audio and video.
  58  */
  59 struct _GstRTSPMediaFactory {
  60   GObject       parent;
  61
  62   GMutex       *lock;
  63   gchar        *launch;
  64   gboolean      shared;
  65   gboolean      eos_shutdown;
  66   GstRTSPAuth  *auth;
  67
  68   GMutex       *medias_lock;
  69   GHashTable   *medias;
  70 };
  71
  72 /**
  73  * GstRTSPMediaFactoryClass:
  74  * @gen_key: convert @url to a key for caching shared #GstRTSPMedia objects.
  75  *       The default implementation of this function will use the complete URL
  76  *       including the query parameters to return a key.
  77  * @get_element: Construct and return a #GstElement that is a #GstBin containing
  78  *       the elements to use for streaming the media. The bin should contain
  79  *       payloaders pay%d for each stream. The default implementation of this
  80  *       function returns the bin created from the launch parameter.
  81  * @construct: the vmethod that will be called when the factory has to create the
  82  *       #GstRTSPMedia for @url. The default implementation of this
  83  *       function calls get_element to retrieve an element and then looks for
  84  *       pay%d to create the streams.
  85  * @configure: configure the media created with @construct. The default
  86  *       implementation will configure the 'shared' property of the media.
  87  * @create_pipeline: create a new pipeline or re-use an existing one and
  88  *       add the #GstRTSPMedia's element created by @construct to the pipeline.
  89  *
  90  * The #GstRTSPMediaFactory class structure.
  91  */
  92 struct _GstRTSPMediaFactoryClass {
  93   GObjectClass  parent_class;
  94
  95   gchar *           (*gen_key)        (GstRTSPMediaFactory *factory, const GstRTSPUrl *url);
  96
  97   GstElement *      (*get_element)    (GstRTSPMediaFactory *factory, const GstRTSPUrl *url);
  98   GstRTSPMedia *    (*construct)      (GstRTSPMediaFactory *factory, const GstRTSPUrl *url);
  99   void              (*configure)      (GstRTSPMediaFactory *factory, GstRTSPMedia *media);
 100   GstElement *      (*create_pipeline)(GstRTSPMediaFactory *factory, GstRTSPMedia *media);
 101 };
 102
 103 GType                 gst_rtsp_media_factory_get_type     (void);
 104
 105 /* creating the factory */
 106 GstRTSPMediaFactory * gst_rtsp_media_factory_new          (void);
 107
 108 /* configuring the factory */
 109 void                  gst_rtsp_media_factory_set_launch   (GstRTSPMediaFactory *factory,
 110                                                            const gchar *launch);
 111 gchar *               gst_rtsp_media_factory_get_launch   (GstRTSPMediaFactory *factory);
 112
 113 void                  gst_rtsp_media_factory_set_shared   (GstRTSPMediaFactory *factory,
 114                                                            gboolean shared);
 115 gboolean              gst_rtsp_media_factory_is_shared    (GstRTSPMediaFactory *factory);
 116
 117 void                  gst_rtsp_media_factory_set_eos_shutdown   (GstRTSPMediaFactory *factory,
 118                                                                  gboolean eos_shutdown);
 119 gboolean              gst_rtsp_media_factory_is_eos_shutdown    (GstRTSPMediaFactory *factory);
 120
 121 void                  gst_rtsp_media_factory_set_auth     (GstRTSPMediaFactory *factory, GstRTSPAuth *auth);
 122 GstRTSPAuth *         gst_rtsp_media_factory_get_auth     (GstRTSPMediaFactory *factory);
 123
 124
 125 /* creating the media from the factory and a url */
 126 GstRTSPMedia *        gst_rtsp_media_factory_construct    (GstRTSPMediaFactory *factory,
 127                                                            const GstRTSPUrl *url);
 128
 129 void                  gst_rtsp_media_factory_collect_streams (GstRTSPMediaFactory *factory,
 130                                                               const GstRTSPUrl *url,
 131                                                               GstRTSPMedia *media);
 132
 133 G_END_DECLS
 134
 135 #endif /* __GST_RTSP_MEDIA_FACTORY_H__ */