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
  25 #ifndef __GST_RTSP_MEDIA_FACTORY_H__
  26 #define __GST_RTSP_MEDIA_FACTORY_H__
  27
  28 G_BEGIN_DECLS
  29
  30 /* types for the media factory */
  31 #define GST_TYPE_RTSP_MEDIA_FACTORY              (gst_rtsp_media_factory_get_type ())
  32 #define GST_IS_RTSP_MEDIA_FACTORY(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_RTSP_MEDIA_FACTORY))
  33 #define GST_IS_RTSP_MEDIA_FACTORY_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_RTSP_MEDIA_FACTORY))
  34 #define GST_RTSP_MEDIA_FACTORY_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_RTSP_MEDIA_FACTORY, GstRTSPMediaFactoryClass))
  35 #define GST_RTSP_MEDIA_FACTORY(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_RTSP_MEDIA_FACTORY, GstRTSPMediaFactory))
  36 #define GST_RTSP_MEDIA_FACTORY_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_RTSP_MEDIA_FACTORY, GstRTSPMediaFactoryClass))
  37 #define GST_RTSP_MEDIA_FACTORY_CAST(obj)         ((GstRTSPMediaFactory*)(obj))
  38 #define GST_RTSP_MEDIA_FACTORY_CLASS_CAST(klass) ((GstRTSPMediaFactoryClass*)(klass))
  39
  40 typedef struct _GstRTSPMediaFactory GstRTSPMediaFactory;
  41 typedef struct _GstRTSPMediaFactoryClass GstRTSPMediaFactoryClass;
  42
  43 #define GST_RTSP_MEDIA_FACTORY_GET_LOCK(f)       (GST_RTSP_MEDIA_FACTORY_CAST(f)->lock)
  44 #define GST_RTSP_MEDIA_FACTORY_LOCK(f)           (g_mutex_lock(GST_RTSP_MEDIA_FACTORY_GET_LOCK(f)))
  45 #define GST_RTSP_MEDIA_FACTORY_UNLOCK(f)         (g_mutex_unlock(GST_RTSP_MEDIA_FACTORY_GET_LOCK(f)))
  46
  47 /**
  48  * GstRTSPMediaFactory:
  49  * @lock: mutex protecting the datastructure.
  50  * @launch: the launch description
  51  * @shared: if media from this factory can be shared between clients
  52  * @media_lock: mutex protecting the medias.
  53  * @media: hashtable of shared media
  54  *
  55  * The definition and logic for constructing the pipeline for a media. The media
  56  * can contain multiple streams like audio and video.
  57  */
  58 struct _GstRTSPMediaFactory {
  59   GObject       parent;
  60
  61   GMutex       *lock;
  62   gchar        *launch;
  63   gboolean      shared;
  64   gboolean      eos_shutdown;
  65
  66   GMutex       *medias_lock;
  67   GHashTable   *medias;
  68 };
  69
  70 /**
  71  * GstRTSPMediaFactoryClass:
  72  * @gen_key: convert @url to a key for caching shared #GstRTSPMedia objects.
  73  *       The default implementation of this function will use the complete URL
  74  *       including the query parameters to return a key.
  75  * @get_element: Construct and return a #GstElement that is a #GstBin containing
  76  *       the elements to use for streaming the media. The bin should contain
  77  *       payloaders pay%d for each stream. The default implementation of this
  78  *       function returns the bin created from the launch parameter.
  79  * @construct: the vmethod that will be called when the factory has to create the
  80  *       #GstRTSPMedia for @url. The default implementation of this
  81  *       function calls get_element to retrieve an element and then looks for
  82  *       pay%d to create the streams.
  83  * @configure: configure the media created with @construct. The default
  84  *       implementation will configure the 'shared' property of the media.
  85  * @create_pipeline: create a new pipeline or re-use an existing one and
  86  *       add the #GstRTSPMedia's element created by @construct to the pipeline.
  87  *
  88  * The #GstRTSPMediaFactory class structure.
  89  */
  90 struct _GstRTSPMediaFactoryClass {
  91   GObjectClass  parent_class;
  92
  93   gchar *           (*gen_key)        (GstRTSPMediaFactory *factory, const GstRTSPUrl *url);
  94
  95   GstElement *      (*get_element)    (GstRTSPMediaFactory *factory, const GstRTSPUrl *url);
  96   GstRTSPMedia *    (*construct)      (GstRTSPMediaFactory *factory, const GstRTSPUrl *url);
  97   void              (*configure)      (GstRTSPMediaFactory *factory, GstRTSPMedia *media);
  98   GstElement *      (*create_pipeline)(GstRTSPMediaFactory *factory, GstRTSPMedia *media);
  99 };
 100
 101 GType                 gst_rtsp_media_factory_get_type     (void);
 102
 103 /* creating the factory */
 104 GstRTSPMediaFactory * gst_rtsp_media_factory_new          (void);
 105
 106 /* configuring the factory */
 107 void                  gst_rtsp_media_factory_set_launch   (GstRTSPMediaFactory *factory,
 108                                                            const gchar *launch);
 109 gchar *               gst_rtsp_media_factory_get_launch   (GstRTSPMediaFactory *factory);
 110
 111 void                  gst_rtsp_media_factory_set_shared   (GstRTSPMediaFactory *factory,
 112                                                            gboolean shared);
 113 gboolean              gst_rtsp_media_factory_is_shared    (GstRTSPMediaFactory *factory);
 114
 115 void                  gst_rtsp_media_factory_set_eos_shutdown   (GstRTSPMediaFactory *factory,
 116                                                                  gboolean eos_shutdown);
 117 gboolean              gst_rtsp_media_factory_is_eos_shutdown    (GstRTSPMediaFactory *factory);
 118
 119 /* creating the media from the factory and a url */
 120 GstRTSPMedia *        gst_rtsp_media_factory_construct    (GstRTSPMediaFactory *factory,
 121                                                            const GstRTSPUrl *url);
 122
 123 void                  gst_rtsp_media_factory_collect_streams (GstRTSPMediaFactory *factory,
 124                                                               const GstRTSPUrl *url,
 125                                                               GstRTSPMedia *media);
 126
 127 G_END_DECLS
 128
 129 #endif /* __GST_RTSP_MEDIA_FACTORY_H__ */