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-permissions.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 typedef struct _GstRTSPMediaFactoryPrivate GstRTSPMediaFactoryPrivate;
  45
  46 /**
  47  * GstRTSPMediaFactory:
  48  *
  49  * The definition and logic for constructing the pipeline for a media. The media
  50  * can contain multiple streams like audio and video.
  51  */
  52 struct _GstRTSPMediaFactory {
  53   GObject            parent;
  54
  55   /*< private >*/
  56   GstRTSPMediaFactoryPrivate *priv;
  57 };
  58
  59 /**
  60  * GstRTSPMediaFactoryClass:
  61  * @gen_key: convert @url to a key for caching shared #GstRTSPMedia objects.
  62  *       The default implementation of this function will use the complete URL
  63  *       including the query parameters to return a key.
  64  * @create_element: Construct and return a #GstElement that is a #GstBin containing
  65  *       the elements to use for streaming the media. The bin should contain
  66  *       payloaders pay%d for each stream. The default implementation of this
  67  *       function returns the bin created from the launch parameter.
  68  * @construct: the vmethod that will be called when the factory has to create the
  69  *       #GstRTSPMedia for @url. The default implementation of this
  70  *       function calls create_element to retrieve an element and then looks for
  71  *       pay%d to create the streams.
  72  * @configure: configure the media created with @construct. The default
  73  *       implementation will configure the 'shared' property of the media.
  74  * @create_pipeline: create a new pipeline or re-use an existing one and
  75  *       add the #GstRTSPMedia's element created by @construct to the pipeline.
  76  * @media_constructed: signal emited when a media was constructed
  77  * @media_configure: signal emited when a media should be configured
  78  *
  79  * The #GstRTSPMediaFactory class structure.
  80  */
  81 struct _GstRTSPMediaFactoryClass {
  82   GObjectClass  parent_class;
  83
  84   gchar *         (*gen_key)            (GstRTSPMediaFactory *factory, const GstRTSPUrl *url);
  85
  86   GstElement *    (*create_element)     (GstRTSPMediaFactory *factory, const GstRTSPUrl *url);
  87   GstRTSPMedia *  (*construct)          (GstRTSPMediaFactory *factory, const GstRTSPUrl *url);
  88   void            (*configure)          (GstRTSPMediaFactory *factory, GstRTSPMedia *media);
  89   GstElement *    (*create_pipeline)    (GstRTSPMediaFactory *factory, GstRTSPMedia *media);
  90
  91   /* signals */
  92   void            (*media_constructed)  (GstRTSPMediaFactory *factory, GstRTSPMedia *media);
  93   void            (*media_configure)    (GstRTSPMediaFactory *factory, GstRTSPMedia *media);
  94 };
  95
  96 GType                 gst_rtsp_media_factory_get_type     (void);
  97
  98 /* creating the factory */
  99 GstRTSPMediaFactory * gst_rtsp_media_factory_new          (void);
 100
 101 /* configuring the factory */
 102 void                  gst_rtsp_media_factory_set_permissions  (GstRTSPMediaFactory *factory,
 103                                                                GstRTSPPermissions *permissions);
 104 GstRTSPPermissions *  gst_rtsp_media_factory_get_permissions  (GstRTSPMediaFactory *factory);
 105
 106 void                  gst_rtsp_media_factory_set_launch       (GstRTSPMediaFactory *factory,
 107                                                                const gchar *launch);
 108 gchar *               gst_rtsp_media_factory_get_launch       (GstRTSPMediaFactory *factory);
 109
 110 void                  gst_rtsp_media_factory_set_shared       (GstRTSPMediaFactory *factory,
 111                                                                gboolean shared);
 112 gboolean              gst_rtsp_media_factory_is_shared        (GstRTSPMediaFactory *factory);
 113
 114 void                  gst_rtsp_media_factory_set_eos_shutdown (GstRTSPMediaFactory *factory,
 115                                                                gboolean eos_shutdown);
 116 gboolean              gst_rtsp_media_factory_is_eos_shutdown  (GstRTSPMediaFactory *factory);
 117
 118 void                  gst_rtsp_media_factory_set_protocols    (GstRTSPMediaFactory *factory,
 119                                                                GstRTSPLowerTrans protocols);
 120 GstRTSPLowerTrans     gst_rtsp_media_factory_get_protocols    (GstRTSPMediaFactory *factory);
 121
 122 void                  gst_rtsp_media_factory_set_address_pool (GstRTSPMediaFactory * factory,
 123                                                                GstRTSPAddressPool * pool);
 124 GstRTSPAddressPool *  gst_rtsp_media_factory_get_address_pool (GstRTSPMediaFactory * factory);
 125
 126 void                  gst_rtsp_media_factory_set_buffer_size  (GstRTSPMediaFactory * factory,
 127                                                                guint size);
 128 guint                 gst_rtsp_media_factory_get_buffer_size  (GstRTSPMediaFactory * factory);
 129
 130 /* creating the media from the factory and a url */
 131 GstRTSPMedia *        gst_rtsp_media_factory_construct        (GstRTSPMediaFactory *factory,
 132                                                                const GstRTSPUrl *url);
 133
 134 GstElement *          gst_rtsp_media_factory_create_element   (GstRTSPMediaFactory *factory,
 135                                                                const GstRTSPUrl *url);
 136
 137 G_END_DECLS
 138
 139 #endif /* __GST_RTSP_MEDIA_FACTORY_H__ */