/* GStreamer
* Copyright (C) 2013 Stefan Sauer <ensonic@users.sf.net>
*
- * gsttracer.h: tracing subsystem
+ * gsttracer.c: tracer base class
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* Boston, MA 02110-1301, USA.
*/
+/**
+ * SECTION:gsttracer
+ * @title: GstTracer
+ * @short_description: Tracing base class
+ *
+ * Tracing modules will subclass #GstTracer and register through
+ * gst_tracer_register(). Modules can attach to various hook-types - see
+ * gst_tracing_register_hook(). When invoked they receive hook specific
+ * contextual data, which they must not modify.
+ *
+ * Since: 1.8
+ */
+
+#define GST_USE_UNSTABLE_API
+
#include "gst_private.h"
#include "gstenumtypes.h"
-#include "gstquark.h"
-#include "gstregistry.h"
#include "gsttracer.h"
#include "gsttracerfactory.h"
-#include "gstutils.h"
-
-#ifndef GST_DISABLE_GST_DEBUG
+#include "gsttracerutils.h"
GST_DEBUG_CATEGORY_EXTERN (tracer_debug);
#define GST_CAT_DEFAULT tracer_debug
{
PROP_0,
PROP_PARAMS,
- PROP_MASK,
PROP_LAST
};
struct _GstTracerPrivate
{
- const gchar *params;
- GstTracerHook mask;
+ gchar *params;
};
#define gst_tracer_parent_class parent_class
-G_DEFINE_ABSTRACT_TYPE (GstTracer, gst_tracer, GST_TYPE_OBJECT);
+G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (GstTracer, gst_tracer, GST_TYPE_OBJECT);
+
+static void
+gst_tracer_dispose (GObject * object)
+{
+ GstTracer *tracer = GST_TRACER (object);
+ g_free (tracer->priv->params);
+}
static void
gst_tracer_class_init (GstTracerClass * klass)
gobject_class->set_property = gst_tracer_set_property;
gobject_class->get_property = gst_tracer_get_property;
+ gobject_class->dispose = gst_tracer_dispose;
properties[PROP_PARAMS] =
g_param_spec_string ("params", "Params", "Extra configuration parameters",
NULL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS);
- properties[PROP_MASK] =
- g_param_spec_flags ("mask", "Mask", "Event mask", GST_TYPE_TRACER_HOOK,
- GST_TRACER_HOOK_NONE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
-
g_object_class_install_properties (gobject_class, PROP_LAST, properties);
- g_type_class_add_private (klass, sizeof (GstTracerPrivate));
}
static void
gst_tracer_init (GstTracer * tracer)
{
- tracer->priv = G_TYPE_INSTANCE_GET_PRIVATE (tracer, GST_TYPE_TRACER,
- GstTracerPrivate);
+ tracer->priv = gst_tracer_get_instance_private (tracer);
}
static void
switch (prop_id) {
case PROP_PARAMS:
- self->priv->params = g_value_get_string (value);
- break;
- case PROP_MASK:
- self->priv->mask = g_value_get_flags (value);
+ self->priv->params = g_value_dup_string (value);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
case PROP_PARAMS:
g_value_set_string (value, self->priv->params);
break;
- case PROP_MASK:
- g_value_set_flags (value, self->priv->mask);
- break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
-static void
-gst_tracer_invoke (GstTracer * self, GstTracerHookId id, GstStructure * s)
-{
- GstTracerClass *klass = GST_TRACER_GET_CLASS (self);
-
- g_return_if_fail (klass->invoke);
-
- klass->invoke (id, s);
-}
-
/* tracing modules */
+/**
+ * gst_tracer_register:
+ * @plugin: (allow-none): A #GstPlugin, or %NULL for a static typefind function
+ * @name: The name for registering
+ * @type: GType of tracer to register
+ *
+ * Create a new tracer-factory capable of instantiating objects of the
+ * @type and add the factory to @plugin.
+ *
+ * Returns: %TRUE, if the registering succeeded, %FALSE on error
+ */
gboolean
gst_tracer_register (GstPlugin * plugin, const gchar * name, GType type)
{
factory = GST_TRACER_FACTORY_CAST (existing_feature);
factory->type = type;
existing_feature->loaded = TRUE;
- //g_type_set_qdata (type, __gst_elementclass_factory, factory);
gst_object_unref (existing_feature);
return TRUE;
}
- factory = g_object_newv (GST_TYPE_TRACER_FACTORY, 0, NULL);
+ factory = g_object_new (GST_TYPE_TRACER_FACTORY, NULL);
GST_DEBUG_OBJECT (factory, "new tracer factory for %s", name);
gst_plugin_feature_set_name (GST_PLUGIN_FEATURE_CAST (factory), name);
return TRUE;
}
-
-/* tracing helpers */
-
-static gboolean tracer_enabled = FALSE;
-
-static GList *tracers[GST_TRACER_HOOK_ID_LAST] = { NULL, };
-
-/* Initialize the debugging system */
-void
-_priv_gst_tracer_init (void)
-{
- const gchar *env = g_getenv ("GST_TRACE");
-
- if (env != NULL && *env != '\0') {
- GstRegistry *registry = gst_registry_get ();
- GstPluginFeature *feature;
- GstTracerFactory *factory;
- GstTracerHook mask;
- GstTracer *tracer;
- gchar **t = g_strsplit_set (env, ",", 0);
- gint i = 0, j;
- gchar *params;
-
- GST_INFO ("enabling tracers: '%s'", env);
-
- while (t[i]) {
- // TODO(ensonic): check t[i] for params
- params = NULL;
-
- GST_INFO ("checking tracer: '%s'", t[i]);
-
- if ((feature = gst_registry_lookup_feature (registry, t[i]))) {
- factory = GST_TRACER_FACTORY (gst_plugin_feature_load (feature));
- if (factory) {
- GST_INFO_OBJECT (factory, "creating tracer: type-id=%u",
- (guint) factory->type);
-
- tracer = g_object_new (factory->type, "params", params, NULL);
- g_object_get (tracer, "mask", &mask, NULL);
-
- if (mask) {
- /* add to lists according to mask */
- j = 0;
- while (mask && (j < GST_TRACER_HOOK_ID_LAST)) {
- if (mask & 1) {
- tracers[j] = g_list_prepend (tracers[j],
- gst_object_ref (tracer));
- GST_WARNING_OBJECT (tracer, "added tracer to hook %d", j);
- }
- mask >>= 1;
- j++;
- }
-
- tracer_enabled = TRUE;
- } else {
- GST_WARNING_OBJECT (tracer,
- "tracer with zero mask won't have any effect");
- }
- gst_object_unref (tracer);
- } else {
- GST_WARNING_OBJECT (feature,
- "loading plugin containing feature %s failed!", t[i]);
- }
- } else {
- GST_WARNING ("no tracer named '%s'", t[i]);
- }
- i++;
- }
- g_strfreev (t);
- }
-}
-
-void
-_priv_gst_tracer_deinit (void)
-{
- gint i;
- GList *node;
-
- /* shutdown tracers for final reports */
- for (i = 0; i < GST_TRACER_HOOK_ID_LAST; i++) {
- for (node = tracers[i]; node; node = g_list_next (node)) {
- gst_object_unref (node->data);
- }
- g_list_free (tracers[i]);
- tracers[i] = NULL;
- }
-}
-
-gboolean
-gst_tracer_is_enabled (GstTracerHookId id)
-{
- return tracer_enabled && (tracers[id] != NULL);
-}
-
-static void
-dispatch (GstTracerHookId id, GstStructure * s)
-{
- GList *node;
- for (node = tracers[id]; node; node = g_list_next (node)) {
- gst_tracer_invoke (node->data, id, s);
- }
-}
-
-/* tracing hooks */
-void
-gst_tracer_push_buffer_pre (GstPad * pad, GstBuffer * buffer)
-{
- dispatch (GST_TRACER_HOOK_ID_BUFFERS,
- gst_structure_new_id (GST_QUARK (PUSH_BUFFER_PRE),
- GST_QUARK (DOT_TS), G_TYPE_UINT64, gst_util_get_timestamp (),
- GST_QUARK (PAD), GST_TYPE_PAD, pad,
- GST_QUARK (BUFFER), GST_TYPE_BUFFER, buffer, NULL));
-}
-
-void
-gst_tracer_push_buffer_post (GstPad * pad, GstFlowReturn res)
-{
- dispatch (GST_TRACER_HOOK_ID_BUFFERS,
- gst_structure_new_id (GST_QUARK (PUSH_BUFFER_POST),
- GST_QUARK (DOT_TS), G_TYPE_UINT64, gst_util_get_timestamp (),
- GST_QUARK (PAD), GST_TYPE_PAD, pad,
- GST_QUARK (RETURN), G_TYPE_INT, res, NULL));
-}
-
-void
-gst_tracer_push_buffer_list_pre (GstPad * pad, GstBufferList * list)
-{
- dispatch (GST_TRACER_HOOK_ID_BUFFERS,
- gst_structure_new_id (GST_QUARK (PUSH_BUFFER_LIST_PRE),
- GST_QUARK (DOT_TS), G_TYPE_UINT64, gst_util_get_timestamp (),
- GST_QUARK (PAD), GST_TYPE_PAD, pad,
- GST_QUARK (LIST), GST_TYPE_BUFFER_LIST, list, NULL));
-}
-
-void
-gst_tracer_push_buffer_list_post (GstPad * pad, GstFlowReturn res)
-{
- dispatch (GST_TRACER_HOOK_ID_BUFFERS,
- gst_structure_new_id (GST_QUARK (PUSH_BUFFER_LIST_POST),
- GST_QUARK (DOT_TS), G_TYPE_UINT64, gst_util_get_timestamp (),
- GST_QUARK (PAD), GST_TYPE_PAD, pad,
- GST_QUARK (RETURN), G_TYPE_INT, res, NULL));
-}
-
-#endif /* GST_DISABLE_GST_DEBUG */