gst/gstinterface.c

   1 /* GStreamer
   2  *
   3  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   4  *                    2000 Wim Taymans <wtay@chello.be>
   5  *
   6  * gstinterface.c: Interface functions
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 /**
  25  * SECTION:gstimplementsinterface
  26  * @short_description: Core interface implemented by #GstElement instances that
  27  * allows runtime querying of interface availabillity
  28  * @see_also: #GstElement
  29  *
  30  * Provides interface functionality on per instance basis and not per class
  31  * basis, which is the case for gobject.
  32  */
  33
  34 #ifdef HAVE_CONFIG_H
  35 #include "config.h"
  36 #endif
  37
  38 #include "gst_private.h"
  39 #include "gstinterface.h"
  40
  41 static void
  42 gst_implements_interface_class_init (GstImplementsInterfaceClass * ifklass);
  43 static gboolean
  44 gst_implements_interface_supported_default (GstImplementsInterface * iface,
  45     GType iface_type);
  46
  47 GType
  48 gst_implements_interface_get_type (void)
  49 {
  50   static GType gst_interface_type = 0;
  51
  52   if (!gst_interface_type) {
  53     static const GTypeInfo gst_interface_info = {
  54       sizeof (GstImplementsInterfaceClass),
  55       (GBaseInitFunc) gst_implements_interface_class_init,
  56       NULL,
  57       NULL,
  58       NULL,
  59       NULL,
  60       0,
  61       0,
  62       NULL,
  63       NULL
  64     };
  65
  66     gst_interface_type = g_type_register_static (G_TYPE_INTERFACE,
  67         "GstImplementsInterface", &gst_interface_info, 0);
  68
  69     g_type_interface_add_prerequisite (gst_interface_type, GST_TYPE_ELEMENT);
  70   }
  71
  72   return gst_interface_type;
  73 }
  74
  75 static void
  76 gst_implements_interface_class_init (GstImplementsInterfaceClass * klass)
  77 {
  78   klass->supported = gst_implements_interface_supported_default;
  79 }
  80
  81 static gboolean
  82 gst_implements_interface_supported_default (GstImplementsInterface * interface,
  83     GType iface_type)
  84 {
  85   /* Well, if someone didn't set the virtual function,
  86    * then something is clearly wrong. So big no-no here */
  87
  88   return FALSE;
  89 }
  90
  91 /**
  92  * gst_element_implements_interface:
  93  * @element: #GstElement to check for the implementation of the interface
  94  * @iface_type: (final) type of the interface which we want to be implemented
  95  *
  96  * Test whether the given element implements a certain interface of type
  97  * iface_type, and test whether it is supported for this specific instance.
  98  *
  99  * Returns: whether or not the element implements the interface.
 100  */
 101
 102 gboolean
 103 gst_element_implements_interface (GstElement * element, GType iface_type)
 104 {
 105   if (G_TYPE_CHECK_INSTANCE_TYPE (G_OBJECT (element), iface_type)) {
 106     GstImplementsInterface *iface;
 107     GstImplementsInterfaceClass *ifclass;
 108
 109     iface = G_TYPE_CHECK_INSTANCE_CAST (G_OBJECT (element),
 110         iface_type, GstImplementsInterface);
 111     ifclass = GST_IMPLEMENTS_INTERFACE_GET_CLASS (iface);
 112
 113     if (ifclass->supported != NULL &&
 114         ifclass->supported (iface, iface_type) == TRUE) {
 115       return TRUE;
 116     }
 117   }
 118
 119   return FALSE;
 120 }
 121
 122 /**
 123  * gst_implements_interface_cast:
 124  * @from: the object (any sort) from which to cast to the interface
 125  * @type: the interface type to cast to
 126  *
 127  * cast a given object to an interface type, and check whether this
 128  * interface is supported for this specific instance.
 129  *
 130  * Returns: a gpointer to the interface type
 131  */
 132
 133 gpointer
 134 gst_implements_interface_cast (gpointer from, GType iface_type)
 135 {
 136   GstImplementsInterface *iface;
 137
 138   /* check cast, give warning+fail if it's invalid */
 139   if (!(iface = G_TYPE_CHECK_INSTANCE_CAST (from, iface_type,
 140               GstImplementsInterface))) {
 141     return NULL;
 142   }
 143
 144   /* if we're an element, take care that this interface
 145    * is actually implemented */
 146   if (GST_IS_ELEMENT (from)) {
 147     g_return_val_if_fail (gst_element_implements_interface (GST_ELEMENT (from),
 148             iface_type), NULL);
 149   }
 150
 151   return iface;
 152 }
 153
 154 /**
 155  * gst_implements_interface_check:
 156  * @from: the object (any sort) from which to check from for the interface
 157  * @type: the interface type to check for
 158  *
 159  * check a given object for an interface implementation, and check
 160  * whether this interface is supported for this specific instance.
 161  *
 162  * Returns: whether or not the object implements the given interface
 163  */
 164
 165 gboolean
 166 gst_implements_interface_check (gpointer from, GType type)
 167 {
 168   GstImplementsInterface *iface;
 169
 170   /* check cast, return FALSE if it fails, don't give a warning... */
 171   if (!G_TYPE_CHECK_INSTANCE_TYPE (from, type)) {
 172     return FALSE;
 173   }
 174
 175   iface = G_TYPE_CHECK_INSTANCE_CAST (from, type, GstImplementsInterface);
 176
 177   /* now, if we're an element (or derivative), is this thing
 178    * actually implemented for real? */
 179   if (GST_IS_ELEMENT (from)) {
 180     if (!gst_element_implements_interface (GST_ELEMENT (from), type)) {
 181       return FALSE;
 182     }
 183   }
 184
 185   return TRUE;
 186 }