2 * Copyright (C) 2013 Stefan Sauer <ensonic@users.sf.net>
4 * gsttracer.c: tracer base class
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.
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.
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.
24 * @short_description: Tracing base class
26 * Tracing modules will subclass #GstTracer and register through
27 * gst_tracer_register(). Modules can attach to various hook-types - see
28 * #GstTracerHook. When invoked they receive hook specific contextual data,
29 * which they must not modify.
32 #define GST_USE_UNSTABLE_API
34 #include "gst_private.h"
35 #include "gstenumtypes.h"
36 #include "gsttracer.h"
37 #include "gsttracerfactory.h"
39 GST_DEBUG_CATEGORY_EXTERN (tracer_debug);
40 #define GST_CAT_DEFAULT tracer_debug
42 /* tracing plugins base class */
51 static GParamSpec *properties[PROP_LAST];
53 static void gst_tracer_set_property (GObject * object, guint prop_id,
54 const GValue * value, GParamSpec * pspec);
55 static void gst_tracer_get_property (GObject * object, guint prop_id,
56 GValue * value, GParamSpec * pspec);
58 struct _GstTracerPrivate
63 #define gst_tracer_parent_class parent_class
64 G_DEFINE_ABSTRACT_TYPE (GstTracer, gst_tracer, GST_TYPE_OBJECT);
67 gst_tracer_class_init (GstTracerClass * klass)
69 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
71 gobject_class->set_property = gst_tracer_set_property;
72 gobject_class->get_property = gst_tracer_get_property;
74 properties[PROP_PARAMS] =
75 g_param_spec_string ("params", "Params", "Extra configuration parameters",
76 NULL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS);
78 g_object_class_install_properties (gobject_class, PROP_LAST, properties);
79 g_type_class_add_private (klass, sizeof (GstTracerPrivate));
83 gst_tracer_init (GstTracer * tracer)
85 tracer->priv = G_TYPE_INSTANCE_GET_PRIVATE (tracer, GST_TYPE_TRACER,
90 gst_tracer_set_property (GObject * object, guint prop_id,
91 const GValue * value, GParamSpec * pspec)
93 GstTracer *self = GST_TRACER_CAST (object);
97 self->priv->params = g_value_get_string (value);
100 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
106 gst_tracer_get_property (GObject * object, guint prop_id,
107 GValue * value, GParamSpec * pspec)
109 GstTracer *self = GST_TRACER_CAST (object);
113 g_value_set_string (value, self->priv->params);
116 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
121 /* tracing modules */
124 gst_tracer_register (GstPlugin * plugin, const gchar * name, GType type)
126 GstPluginFeature *existing_feature;
127 GstRegistry *registry;
128 GstTracerFactory *factory;
130 g_return_val_if_fail (name != NULL, FALSE);
131 g_return_val_if_fail (g_type_is_a (type, GST_TYPE_TRACER), FALSE);
133 registry = gst_registry_get ();
134 /* check if feature already exists, if it exists there is no need to update it
135 * when the registry is getting updated, outdated plugins and all their
136 * features are removed and readded.
138 existing_feature = gst_registry_lookup_feature (registry, name);
139 if (existing_feature) {
140 GST_DEBUG_OBJECT (registry, "update existing feature %p (%s)",
141 existing_feature, name);
142 factory = GST_TRACER_FACTORY_CAST (existing_feature);
143 factory->type = type;
144 existing_feature->loaded = TRUE;
145 gst_object_unref (existing_feature);
149 factory = g_object_newv (GST_TYPE_TRACER_FACTORY, 0, NULL);
150 GST_DEBUG_OBJECT (factory, "new tracer factory for %s", name);
152 gst_plugin_feature_set_name (GST_PLUGIN_FEATURE_CAST (factory), name);
153 gst_plugin_feature_set_rank (GST_PLUGIN_FEATURE_CAST (factory),
156 factory->type = type;
157 GST_DEBUG_OBJECT (factory, "tracer factory for %u:%s",
158 (guint) type, g_type_name (type));
160 if (plugin && plugin->desc.name) {
161 GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = plugin->desc.name; /* interned string */
162 GST_PLUGIN_FEATURE_CAST (factory)->plugin = plugin;
163 g_object_add_weak_pointer ((GObject *) plugin,
164 (gpointer *) & GST_PLUGIN_FEATURE_CAST (factory)->plugin);
166 GST_PLUGIN_FEATURE_CAST (factory)->plugin_name = "NULL";
167 GST_PLUGIN_FEATURE_CAST (factory)->plugin = NULL;
169 GST_PLUGIN_FEATURE_CAST (factory)->loaded = TRUE;
171 gst_registry_add_feature (gst_registry_get (),
172 GST_PLUGIN_FEATURE_CAST (factory));
177 /* tracing module helpers */
180 gst_tracer_log_trace (GstStructure * s)
182 GST_TRACE ("%" GST_PTR_FORMAT, s);
184 gst_debug_log_valist (
185 GST_CAT_DEFAULT, GST_LEVEL_TRACE,
186 file, func, line, object
187 "%" GST_PTR_FORMAT, s);
188 // does it make sense to use the {file, line, func} from the tracer hook?
190 // - we'd need to pass them in the macros to gst_tracer_dispatch()
191 // - and each tracer needs to grab them from the va_list and pass them here
193 // - we create a content in dispatch, pass that to the tracer
194 // - and the tracer will pass that here
195 // ideally we also use *our* ts instead of the one that
196 // gst_debug_log_default() will pick
198 gst_structure_free (s);