subprojects/gst-devtools/validate/gst/validate/gst-validate-override.c

   1 /* GStreamer
   2  *
   3  * Copyright (C) 2013 Collabora Ltd.
   4  *  Author: Thiago Sousa Santos <thiago.sousa.santos@collabora.com>
   5  * Copyright (C) 2015 Raspberry Pi Foundation
   6  *  Author: Thibault Saunier <thibault.saunier@collabora.com>
   7  *
   8  * gst-validate-override.c - Validate Override that allows customizing Validate behavior
   9  *
  10  * This library is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Library General Public
  12  * License as published by the Free Software Foundation; either
  13  * version 2.1 of the License, or (at your option) any later version.
  14  *
  15  * This library is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Library General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Library General Public
  21  * License along with this library; if not, write to the
  22  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23  * Boston, MA 02111-1307, USA.
  24  */
  25 /**
  26  * SECTION: gst-validate-override
  27  * @title: GstValidateOverride
  28  * @short_description: TODO
  29  *
  30  * TODO
  31  */
  32
  33 #ifdef HAVE_CONFIG_H
  34 #  include "config.h"
  35 #endif
  36
  37 #include <string.h>
  38
  39 #include "gst-validate-internal.h"
  40 #include "gst-validate-override.h"
  41
  42 /*  *INDENT-OFF* */
  43
  44 struct _GstValidateOverridePrivate
  45 {
  46   GHashTable *level_override;
  47 };
  48
  49 enum
  50 {
  51   PROP_FIRST_PROP = 1,
  52   PROP_RUNNER,
  53   PROP_LAST
  54 };
  55
  56 G_DEFINE_TYPE_WITH_CODE (GstValidateOverride, gst_validate_override,
  57     GST_TYPE_OBJECT, G_ADD_PRIVATE (GstValidateOverride)
  58     G_IMPLEMENT_INTERFACE (GST_TYPE_VALIDATE_REPORTER, NULL))
  59
  60 /*  *INDENT-ON* */
  61
  62 static void
  63 _get_property (GObject * object,
  64     guint property_id, GValue * value, GParamSpec * pspec)
  65 {
  66   switch (property_id) {
  67     case PROP_RUNNER:
  68       g_value_take_object (value,
  69           gst_validate_reporter_get_runner (GST_VALIDATE_REPORTER (object)));
  70       break;
  71     default:
  72       break;
  73   }
  74 }
  75
  76 static void
  77 _set_property (GObject * object,
  78     guint property_id, const GValue * value, GParamSpec * pspec)
  79 {
  80   switch (property_id) {
  81     case PROP_RUNNER:
  82       /* we assume the runner is valid as long as this scenario is,
  83        * no ref taken */
  84       gst_validate_reporter_set_runner (GST_VALIDATE_REPORTER (object),
  85           g_value_get_object (value));
  86       break;
  87     default:
  88       break;
  89   }
  90 }
  91
  92 static void
  93 gst_validate_override_finalize (GObject * object)
  94 {
  95   GstValidateOverride *self = GST_VALIDATE_OVERRIDE (object);
  96
  97   void (*chain_up) (GObject *) =
  98       ((GObjectClass *) gst_validate_override_parent_class)->finalize;
  99
 100   g_hash_table_unref (self->priv->level_override);
 101
 102   chain_up (object);
 103 }
 104
 105 static void
 106 gst_validate_override_class_init (GstValidateOverrideClass * klass)
 107 {
 108   GObjectClass *oclass = G_OBJECT_CLASS (klass);
 109
 110   oclass->finalize = gst_validate_override_finalize;
 111
 112   oclass->get_property = _get_property;
 113   oclass->set_property = _set_property;
 114
 115   g_object_class_install_property (oclass, PROP_RUNNER,
 116       g_param_spec_object ("validate-runner", "VALIDATE Runner",
 117           "The Validate runner to report errors to",
 118           GST_TYPE_VALIDATE_RUNNER,
 119           G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE));
 120 }
 121
 122 static void
 123 gst_validate_override_init (GstValidateOverride * self)
 124 {
 125   self->priv = gst_validate_override_get_instance_private (self);
 126
 127   self->priv->level_override = g_hash_table_new (g_direct_hash, g_direct_equal);
 128 }
 129
 130 GstValidateOverride *
 131 gst_validate_override_new (void)
 132 {
 133   return g_object_new (GST_TYPE_VALIDATE_OVERRIDE, NULL);
 134 }
 135
 136 void
 137 gst_validate_override_change_severity (GstValidateOverride * override,
 138     GstValidateIssueId issue_id, GstValidateReportLevel new_level)
 139 {
 140   g_hash_table_insert (override->priv->level_override,
 141       GINT_TO_POINTER (issue_id), (gpointer) new_level);
 142 }
 143
 144 /*
 145  * Also receives @default_level to preserve a custom level that might have
 146  * been set by a previous GstValidateOverride and should not go back to the
 147  * GstValidateIssue default
 148  */
 149 GstValidateReportLevel
 150 gst_validate_override_get_severity (GstValidateOverride * override,
 151     GstValidateIssueId issue_id, GstValidateReportLevel default_level)
 152 {
 153   GstValidateReportLevel *level = NULL;
 154
 155   if (g_hash_table_lookup_extended (override->priv->level_override,
 156           GINT_TO_POINTER (issue_id), NULL, (gpointer) & level)) {
 157
 158     return GPOINTER_TO_INT (level);
 159   }
 160   return default_level;
 161 }
 162
 163 /**
 164  * gst_validate_override_set_event_handler: (skip):
 165  */
 166 void
 167 gst_validate_override_set_event_handler (GstValidateOverride * override,
 168     GstValidateOverrideEventHandler handler)
 169 {
 170   override->event_handler = handler;
 171 }
 172
 173 /**
 174  * gst_validate_override_set_buffer_handler : (skip):
 175  */
 176 void
 177 gst_validate_override_set_buffer_handler (GstValidateOverride * override,
 178     GstValidateOverrideBufferHandler handler)
 179 {
 180   override->buffer_handler = handler;
 181 }
 182
 183 /**
 184  * gst_validate_override_set_query_handler: (skip):
 185  */
 186 void
 187 gst_validate_override_set_query_handler (GstValidateOverride * override,
 188     GstValidateOverrideQueryHandler handler)
 189 {
 190   override->query_handler = handler;
 191 }
 192
 193 /**
 194  * gst_validate_override_set_buffer_probe_handler: (skip):
 195  */
 196 void
 197 gst_validate_override_set_buffer_probe_handler (GstValidateOverride * override,
 198     GstValidateOverrideBufferHandler handler)
 199 {
 200   override->buffer_probe_handler = handler;
 201 }
 202
 203 /**
 204  * gst_validate_override_set_getcaps_handler: (skip):
 205  */
 206 void
 207 gst_validate_override_set_getcaps_handler (GstValidateOverride * override,
 208     GstValidateOverrideGetCapsHandler handler)
 209 {
 210   override->getcaps_handler = handler;
 211 }
 212
 213 /**
 214  * gst_validate_override_set_setcaps_handler: (skip):
 215  */
 216 void
 217 gst_validate_override_set_setcaps_handler (GstValidateOverride * override,
 218     GstValidateOverrideSetCapsHandler handler)
 219 {
 220   override->setcaps_handler = handler;
 221 }
 222
 223 /**
 224  * gst_validate_override_event_handler: (skip):
 225  */
 226 void
 227 gst_validate_override_event_handler (GstValidateOverride * override,
 228     GstValidateMonitor * monitor, GstEvent * event)
 229 {
 230   if (override->event_handler)
 231     override->event_handler (override, monitor, event);
 232 }
 233
 234 /**
 235  * gst_validate_override_buffer_handler: (skip):
 236  */
 237 void
 238 gst_validate_override_buffer_handler (GstValidateOverride * override,
 239     GstValidateMonitor * monitor, GstBuffer * buffer)
 240 {
 241   if (override->buffer_handler)
 242     override->buffer_handler (override, monitor, buffer);
 243 }
 244
 245 /**
 246  * gst_validate_override_query_handler: (skip):
 247  */
 248 void
 249 gst_validate_override_query_handler (GstValidateOverride * override,
 250     GstValidateMonitor * monitor, GstQuery * query)
 251 {
 252   if (override->query_handler)
 253     override->query_handler (override, monitor, query);
 254 }
 255
 256 /**
 257  * gst_validate_override_buffer_probe_handler: (skip):
 258  */
 259 void
 260 gst_validate_override_buffer_probe_handler (GstValidateOverride * override,
 261     GstValidateMonitor * monitor, GstBuffer * buffer)
 262 {
 263   if (override->buffer_probe_handler)
 264     override->buffer_probe_handler (override, monitor, buffer);
 265 }
 266
 267 /**
 268  * gst_validate_override_getcaps_handler: (skip):
 269  */
 270 void
 271 gst_validate_override_getcaps_handler (GstValidateOverride * override,
 272     GstValidateMonitor * monitor, GstCaps * caps)
 273 {
 274   if (override->getcaps_handler)
 275     override->getcaps_handler (override, monitor, caps);
 276 }
 277
 278 /**
 279  * gst_validate_override_setcaps_handler: (skip):
 280  */
 281 void
 282 gst_validate_override_setcaps_handler (GstValidateOverride * override,
 283     GstValidateMonitor * monitor, GstCaps * caps)
 284 {
 285   if (override->setcaps_handler)
 286     override->setcaps_handler (override, monitor, caps);
 287 }
 288
 289 /**
 290  * gst_validate_override_element_added_handler: (skip):
 291  */
 292 void
 293 gst_validate_override_element_added_handler (GstValidateOverride * override,
 294     GstValidateMonitor * monitor, GstElement * child)
 295 {
 296   if (override->element_added_handler)
 297     override->element_added_handler (override, monitor, child);
 298 }
 299
 300 /**
 301  * gst_validate_override_set_element_added_handler: (skip):
 302  */
 303 void
 304 gst_validate_override_set_element_added_handler (GstValidateOverride * override,
 305     GstValidateOverrideElementAddedHandler func)
 306 {
 307   override->element_added_handler = func;
 308 }
 309
 310 /**
 311  * gst_validate_override_can_attach: (skip):
 312  */
 313 gboolean
 314 gst_validate_override_can_attach (GstValidateOverride * override,
 315     GstValidateMonitor * monitor)
 316 {
 317   GstValidateOverrideClass *klass = GST_VALIDATE_OVERRIDE_GET_CLASS (override);
 318
 319   if (klass->can_attach)
 320     return klass->can_attach (override, monitor);
 321
 322   return TRUE;
 323 }
 324
 325 void
 326 gst_validate_override_attached (GstValidateOverride * override)
 327 {
 328   GstValidateOverrideClass *klass = GST_VALIDATE_OVERRIDE_GET_CLASS (override);
 329
 330   if (klass->attached)
 331     klass->attached (override);
 332 }