gst/gsttracer.c

   1 /* GStreamer
   2  * Copyright (C) 2013 Stefan Sauer <ensonic@users.sf.net>
   3  *
   4  * gsttracer.c: tracer base class
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public
  17  * License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  19  * Boston, MA 02110-1301, USA.
  20  */
  21
  22 /**
  23  * SECTION:gsttracer
  24  * @title: GstTracer
  25  * @short_description: Tracing base class
  26  *
  27  * Tracing modules will subclass #GstTracer and register through
  28  * gst_tracer_register(). Modules can attach to various hook-types - see
  29  * gst_tracing_register_hook(). When invoked they receive hook specific
  30  * contextual data, which they must not modify.
  31  *
  32  * Since: 1.8
  33  */
  34
  35 #define GST_USE_UNSTABLE_API
  36
  37 #include "gst_private.h"
  38 #include "gstenumtypes.h"
  39 #include "gsttracer.h"
  40 #include "gsttracerfactory.h"
  41 #include "gsttracerutils.h"
  42
  43 GST_DEBUG_CATEGORY_EXTERN (tracer_debug);
  44 #define GST_CAT_DEFAULT tracer_debug
  45
  46 /* tracing plugins base class */
  47
  48 enum
  49 {
  50   PROP_0,
  51   PROP_PARAMS,
  52   PROP_LAST
  53 };
  54
  55 static GParamSpec *properties[PROP_LAST];
  56
  57 static void gst_tracer_set_property (GObject * object, guint prop_id,
  58     const GValue * value, GParamSpec * pspec);
  59 static void gst_tracer_get_property (GObject * object, guint prop_id,
  60     GValue * value, GParamSpec * pspec);
  61
  62 struct _GstTracerPrivate
  63 {
  64   gchar *params;
  65 };
  66
  67 #define gst_tracer_parent_class parent_class
  68 G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (GstTracer, gst_tracer, GST_TYPE_OBJECT);
  69
  70 static void
  71 gst_tracer_dispose (GObject * object)
  72 {
  73   GstTracer *tracer = GST_TRACER (object);
  74   g_free (tracer->priv->params);
  75 }
  76
  77 static void
  78 gst_tracer_class_init (GstTracerClass * klass)
  79 {
  80   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
  81
  82   gobject_class->set_property = gst_tracer_set_property;
  83   gobject_class->get_property = gst_tracer_get_property;
  84   gobject_class->dispose = gst_tracer_dispose;
  85
  86   properties[PROP_PARAMS] =
  87       g_param_spec_string ("params", "Params", "Extra configuration parameters",
  88       NULL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS);
  89
  90   g_object_class_install_properties (gobject_class, PROP_LAST, properties);
  91 }
  92
  93 static void
  94 gst_tracer_init (GstTracer * tracer)
  95 {
  96   tracer->priv = gst_tracer_get_instance_private (tracer);
  97 }
  98
  99 static void
 100 gst_tracer_set_property (GObject * object, guint prop_id,
 101     const GValue * value, GParamSpec * pspec)
 102 {
 103   GstTracer *self = GST_TRACER_CAST (object);
 104
 105   switch (prop_id) {
 106     case PROP_PARAMS:
 107       self->priv->params = g_value_dup_string (value);
 108       break;
 109     default:
 110       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 111       break;
 112   }
 113 }
 114
 115 static void
 116 gst_tracer_get_property (GObject * object, guint prop_id,
 117     GValue * value, GParamSpec * pspec)
 118 {
 119   GstTracer *self = GST_TRACER_CAST (object);
 120
 121   switch (prop_id) {
 122     case PROP_PARAMS:
 123       g_value_set_string (value, self->priv->params);
 124       break;
 125     default:
 126       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 127       break;
 128   }
 129 }
 130
 131 /* tracing modules */
 132
 133 /**
 134  * gst_tracer_register:
 135  * @plugin: (allow-none): A #GstPlugin, or %NULL for a static typefind function
 136  * @name: The name for registering
 137  * @type: GType of tracer to register
 138  *
 139  * Create a new tracer-factory  capable of instantiating objects of the
 140  * @type and add the factory to @plugin.
 141  *
 142  * Returns: %TRUE, if the registering succeeded, %FALSE on error
 143  */
 144 gboolean
 145 gst_tracer_register (GstPlugin * plugin, const gchar * name, GType type)
 146 {
 147   GstPluginFeature *existing_feature;
 148   GstRegistry *registry;
 149   GstTracerFactory *factory;
 150
 151   g_return_val_if_fail (name != NULL, FALSE);
 152   g_return_val_if_fail (g_type_is_a (type, GST_TYPE_TRACER), FALSE);
 153
 154   registry = gst_registry_get ();
 155   /* check if feature already exists, if it exists there is no need to update it
 156    * when the registry is getting updated, outdated plugins and all their
 157    * features are removed and readded.
 158    */
 159   existing_feature = gst_registry_lookup_feature (registry, name);
 160   if (existing_feature) {
 161     GST_DEBUG_OBJECT (registry, "update existing feature %p (%s)",
 162         existing_feature, name);
 163     factory = GST_TRACER_FACTORY_CAST (existing_feature);
 164     factory->type = type;
 165     existing_feature->loaded = TRUE;
 166     gst_object_unref (existing_feature);
 167     return TRUE;
 168   }
 169
 170   factory = g_object_new (GST_TYPE_TRACER_FACTORY, NULL);
 171   GST_DEBUG_OBJECT (factory, "new tracer factory for %s", name);
 172
 173   gst_plugin_feature_set_name (GST_PLUGIN_FEATURE_CAST (factory), name);
 174   gst_plugin_feature_set_rank (GST_PLUGIN_FEATURE_CAST (factory),
 175       GST_RANK_NONE);
 176
 177   factory->type = type;
 178   GST_DEBUG_OBJECT (factory, "tracer factory for %u:%s",
 179       (guint) type, g_type_name (type));
 180
 181   if (plugin && plugin->desc.name) {
 182     GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = plugin->desc.name; /* interned string */
 183     GST_PLUGIN_FEATURE_CAST (factory)->plugin = plugin;
 184     g_object_add_weak_pointer ((GObject *) plugin,
 185         (gpointer *) & GST_PLUGIN_FEATURE_CAST (factory)->plugin);
 186   } else {
 187     GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = "NULL";
 188     GST_PLUGIN_FEATURE_CAST (factory)->plugin = NULL;
 189   }
 190   GST_PLUGIN_FEATURE_CAST (factory)->loaded = TRUE;
 191
 192   gst_registry_add_feature (gst_registry_get (),
 193       GST_PLUGIN_FEATURE_CAST (factory));
 194
 195   return TRUE;
 196 }