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 /**
  44  * GstRTSPMediaFactory:
  45  * @lock: mutex protecting the datastructure.
  46  * @launch: the launch description
  47  * @shared: if media from this factory can be shared between clients
  48  * @media_lock: mutex protecting the medias.
  49  * @media: hashtable of shared media
  50  *
  51  * The definition and logic for constructing the pipeline for a media. The media
  52  * can contain multiple streams like audio and video.
  53  */
  54 struct _GstRTSPMediaFactory {
  55   GObject       parent;
  56
  57   GMutex       *lock;
  58   gchar        *launch;
  59   gboolean      shared;
  60
  61   GMutex       *medias_lock;
  62   GHashTable   *medias;
  63 };
  64
  65 /**
  66  * GstRTSPMediaFactoryClass:
  67  * @gen_key: convert @url to a key for caching media
  68  * @get_element: Construct an return a #GstElement thast is a #GstBin containing
  69  *       the elements to use for the media. The bin should contain payloaders
  70  *       pay%d for each stream. The default implementation of this functions
  71  *       returns the bin created from the launch parameter.
  72  * @construct: the vmethod that will be called when the factory has to create the
  73  *       #GstRTSPMedia for @url. The default implementation of this
  74  *       function calls get_element to retrieve an element and then looks for
  75  *       pay%d to create the streams.
  76  * @configure: configure the media created with @construct. The default
  77  *       implementation will configure the 'shared' property of the media.
  78  * @handle_message: Handle a bus message for @media created from @factory.
  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 *      (*get_element)    (GstRTSPMediaFactory *factory, const GstRTSPUrl *url);
  88   GstRTSPMedia *    (*construct)      (GstRTSPMediaFactory *factory, const GstRTSPUrl *url);
  89   void              (*configure)      (GstRTSPMediaFactory *factory, GstRTSPMedia *media);
  90
  91   void              (*handle_message) (GstRTSPMediaFactory *factory, GstRTSPMedia *media,
  92                                        GstMessage *message);
  93
  94
  95 };
  96
  97 GType                 gst_rtsp_media_factory_get_type     (void);
  98
  99 /* creating the factory */
 100 GstRTSPMediaFactory * gst_rtsp_media_factory_new          (void);
 101
 102 /* configuring the factory */
 103 void                  gst_rtsp_media_factory_set_launch   (GstRTSPMediaFactory *factory,
 104                                                            const gchar *launch);
 105 gchar *               gst_rtsp_media_factory_get_launch   (GstRTSPMediaFactory *factory);
 106
 107 void                  gst_rtsp_media_factory_set_shared   (GstRTSPMediaFactory *factory,
 108                                                            gboolean shared);
 109 gboolean              gst_rtsp_media_factory_is_shared    (GstRTSPMediaFactory *factory);
 110
 111 /* creating the media from the factory and a url */
 112 GstRTSPMedia *        gst_rtsp_media_factory_construct    (GstRTSPMediaFactory *factory,
 113                                                            const GstRTSPUrl *url);
 114
 115 G_END_DECLS
 116
 117 #endif /* __GST_RTSP_MEDIA_FACTORY_H__ */