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  * @launch: the launch description
  46  * @streams: the array of #GstRTSPMediaStream objects for this media.
  47  *
  48  * The definition and logic for constructing the pipeline for a media. The media
  49  * can contain multiple streams like audio and video.
  50  */
  51 struct _GstRTSPMediaFactory {
  52   GObject       parent;
  53
  54   gchar        *launch;
  55 };
  56
  57 /**
  58  * GstRTSPMediaFactoryClass:
  59  * @construct: the vmethod that will be called when the factory has to create the
  60  *       #GstRTSPMedia for @url. The default implementation of this
  61  *       function calls get_element to retrieve an element and then looks for
  62  *       pay%d to create the streams.
  63  * @handle_message: Handle a bus message for @media created from @factory.
  64  * @get_element: Construct an return a #GstElement thast is a #GstBin containing
  65  *       the pipeline to use for the media. The bin should contain elements
  66  *       pay%d for each stream. The default implementation of this functions
  67  *       returns the bin created from the launch parameter.
  68  *
  69  * the #GstRTSPMediaFactory class structure.
  70  */
  71 struct _GstRTSPMediaFactoryClass {
  72   GObjectClass  parent_class;
  73
  74   GstRTSPMedia *    (*construct)      (GstRTSPMediaFactory *factory, const GstRTSPUrl *url);
  75   void              (*handle_message) (GstRTSPMediaFactory *factory, GstRTSPMedia *media,
  76                                        GstMessage *message);
  77
  78   GstElement *      (*get_element)    (GstRTSPMediaFactory *factory, const GstRTSPUrl *url);
  79
  80 };
  81
  82 GType                 gst_rtsp_media_factory_get_type     (void);
  83
  84 /* configuring the factory */
  85 GstRTSPMediaFactory * gst_rtsp_media_factory_new          (void);
  86
  87 void                  gst_rtsp_media_factory_set_launch   (GstRTSPMediaFactory *factory,
  88                                                            const gchar *launch);
  89 gchar *               gst_rtsp_media_factory_get_launch   (GstRTSPMediaFactory *factory);
  90
  91 void                  gst_rtsp_media_factory_set_shared   (GstRTSPMediaFactory *factory,
  92                                                            gboolean shared);
  93 gboolean              gst_rtsp_media_factory_is_shared    (GstRTSPMediaFactory *factory);
  94
  95
  96 /* creating the media bin from the factory */
  97 GstRTSPMedia *        gst_rtsp_media_factory_construct    (GstRTSPMediaFactory *factory,
  98                                                            const GstRTSPUrl *url);
  99
 100 G_END_DECLS
 101
 102 #endif /* __GST_RTSP_MEDIA_FACTORY_H__ */