gst/gstpadtemplate.h

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wim.taymans@chello.be>
   4  *
   5  * gstpadtemplate.h: Header for GstPadTemplate object
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23
  24 #ifndef __GST_PAD_TEMPLATE_H__
  25 #define __GST_PAD_TEMPLATE_H__
  26
  27 #include <gst/gstconfig.h>
  28
  29 #include <gst/gstobject.h>
  30 #include <gst/gstbuffer.h>
  31 #include <gst/gstcaps.h>
  32 #include <gst/gstevent.h>
  33 #include <gst/gstquery.h>
  34 #include <gst/gsttask.h>
  35
  36 G_BEGIN_DECLS
  37
  38 /* FIXME: this awful circular dependency need to be resolved properly (see pad.h) */
  39 /*typedef struct _GstPadTemplate GstPadTemplate; */
  40 typedef struct _GstPadTemplateClass GstPadTemplateClass;
  41 typedef struct _GstStaticPadTemplate GstStaticPadTemplate;
  42
  43 #define GST_TYPE_STATIC_PAD_TEMPLATE    (gst_static_pad_template_get_type ())
  44
  45 #define GST_TYPE_PAD_TEMPLATE           (gst_pad_template_get_type ())
  46 #define GST_PAD_TEMPLATE(obj)           (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PAD_TEMPLATE,GstPadTemplate))
  47 #define GST_PAD_TEMPLATE_CLASS(klass)   (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PAD_TEMPLATE,GstPadTemplateClass))
  48 #define GST_IS_PAD_TEMPLATE(obj)        (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PAD_TEMPLATE))
  49 #define GST_IS_PAD_TEMPLATE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PAD_TEMPLATE))
  50
  51 /**
  52  * GstPadPresence:
  53  * @GST_PAD_ALWAYS: the pad is always available
  54  * @GST_PAD_SOMETIMES: the pad will become available depending on the media stream
  55  * @GST_PAD_REQUEST: the pad is only available on request with
  56  *  gst_element_get_request_pad().
  57  *
  58  * Indicates when this pad will become available.
  59  */
  60 typedef enum {
  61   GST_PAD_ALWAYS,
  62   GST_PAD_SOMETIMES,
  63   GST_PAD_REQUEST
  64 } GstPadPresence;
  65
  66 /**
  67  * GST_PAD_TEMPLATE_NAME_TEMPLATE:
  68  * @templ: the template to query
  69  *
  70  * Get the nametemplate of the padtemplate.
  71  */
  72 #define GST_PAD_TEMPLATE_NAME_TEMPLATE(templ)   (((GstPadTemplate *)(templ))->name_template)
  73
  74 /**
  75  * GST_PAD_TEMPLATE_DIRECTION:
  76  * @templ: the template to query
  77  *
  78  * Get the #GstPadDirection of the padtemplate.
  79  */
  80 #define GST_PAD_TEMPLATE_DIRECTION(templ)       (((GstPadTemplate *)(templ))->direction)
  81
  82 /**
  83  * GST_PAD_TEMPLATE_PRESENCE:
  84  * @templ: the template to query
  85  *
  86  * Get the #GstPadPresence of the padtemplate.
  87  */
  88 #define GST_PAD_TEMPLATE_PRESENCE(templ)        (((GstPadTemplate *)(templ))->presence)
  89
  90 /**
  91  * GST_PAD_TEMPLATE_CAPS:
  92  * @templ: the template to query
  93  *
  94  * Get a handle to the padtemplate #GstCaps
  95  */
  96 #define GST_PAD_TEMPLATE_CAPS(templ)            (((GstPadTemplate *)(templ))->caps)
  97
  98 /**
  99  * GstPadTemplateFlags:
 100  * @GST_PAD_TEMPLATE_FIXED: the padtemplate has no variable properties
 101  * @GST_PAD_TEMPLATE_FLAG_LAST: first flag that can be used by subclasses.
 102  *
 103  * Flags for the padtemplate
 104  */
 105 typedef enum {
 106   /* FIXME0.11: this is not used and the purpose is unclear */
 107   GST_PAD_TEMPLATE_FIXED        = (GST_OBJECT_FLAG_LAST << 0),
 108   /* padding */
 109   GST_PAD_TEMPLATE_FLAG_LAST    = (GST_OBJECT_FLAG_LAST << 4)
 110 } GstPadTemplateFlags;
 111
 112 /**
 113  * GST_PAD_TEMPLATE_IS_FIXED:
 114  * @templ: the template to query
 115  *
 116  * Check if the properties of the padtemplate are fixed
 117  */
 118 #define GST_PAD_TEMPLATE_IS_FIXED(templ)        (GST_OBJECT_FLAG_IS_SET(templ, GST_PAD_TEMPLATE_FIXED))
 119
 120 /**
 121  * GstPadTemplate:
 122  *
 123  * The padtemplate object.
 124  */
 125 struct _GstPadTemplate {
 126   GstObject        object;
 127
 128   gchar           *name_template;
 129   GstPadDirection  direction;
 130   GstPadPresence   presence;
 131   GstCaps         *caps;
 132
 133   gpointer _gst_reserved[GST_PADDING];
 134 };
 135
 136 struct _GstPadTemplateClass {
 137   GstObjectClass   parent_class;
 138
 139   /* signal callbacks */
 140   void (*pad_created)   (GstPadTemplate *templ, GstPad *pad);
 141
 142   gpointer _gst_reserved[GST_PADDING];
 143 };
 144
 145 /**
 146  * GstStaticPadTemplate:
 147  * @name_template: the name of the template
 148  * @direction: the direction of the template
 149  * @presence: the presence of the template
 150  * @static_caps: the caps of the template.
 151  *
 152  * Structure describing the #GstStaticPadTemplate.
 153  */
 154 struct _GstStaticPadTemplate {
 155   const gchar     *name_template;
 156   GstPadDirection  direction;
 157   GstPadPresence   presence;
 158   GstStaticCaps    static_caps;
 159 };
 160
 161 /**
 162  * GST_STATIC_PAD_TEMPLATE:
 163  * @padname: the name template of the pad
 164  * @dir: the GstPadDirection of the pad
 165  * @pres: the GstPadPresence of the pad
 166  * @caps: the GstStaticCaps of the pad
 167  *
 168  * Convenience macro to fill the values of a GstStaticPadTemplate
 169  * structure.
 170  */
 171 #define GST_STATIC_PAD_TEMPLATE(padname, dir, pres, caps) \
 172 { \
 173   /* name_template */    padname, \
 174   /* direction */        dir, \
 175   /* presence */         pres, \
 176   /* caps */             caps \
 177 }
 178
 179 /* templates and factories */
 180 GType                   gst_pad_template_get_type               (void);
 181 GType                   gst_static_pad_template_get_type        (void);
 182
 183 GstPadTemplate*         gst_pad_template_new                    (const gchar *name_template,
 184                                                                  GstPadDirection direction, GstPadPresence presence,
 185                                                                  GstCaps *caps);
 186
 187 GstPadTemplate *        gst_static_pad_template_get             (GstStaticPadTemplate *pad_template);
 188 GstCaps*                gst_static_pad_template_get_caps        (GstStaticPadTemplate *templ);
 189 GstCaps*                gst_pad_template_get_caps               (GstPadTemplate *templ);
 190
 191 void                    gst_pad_template_pad_created            (GstPadTemplate * templ, GstPad * pad);
 192
 193 G_END_DECLS
 194
 195 #endif /* __GST_PAD_TEMPLATE_H__ */
 196