2 * Copyright (C) 2016 Stefan Sauer <ensonic@users.sf.net>
4 * gsttracerrecord.c: tracer log record 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.
23 * SECTION:gsttracerrecord
24 * @short_description: Trace log entry class
26 * Tracing modules will create instances of this class to announce the data they
27 * will log and create a log formatter.
32 #define GST_USE_UNSTABLE_API
34 #include "gst_private.h"
35 #include "gstenumtypes.h"
37 #include "gststructure.h"
38 #include "gsttracerrecord.h"
41 GST_DEBUG_CATEGORY_EXTERN (tracer_debug);
42 #define GST_CAT_DEFAULT tracer_debug
52 static GParamSpec *properties[PROP_LAST];
54 struct _GstTracerRecord
62 struct _GstTracerRecordClass
64 GstObjectClass parent_class;
67 #define gst_tracer_record_parent_class parent_class
68 G_DEFINE_TYPE (GstTracerRecord, gst_tracer_record, GST_TYPE_OBJECT);
71 build_field_template (GQuark field_id, const GValue * value, gpointer user_data)
73 GString *s = (GString *) user_data;
74 const GstStructure *sub;
75 GValue template_value = { 0, };
77 GstTracerValueFlags flags;
80 g_return_val_if_fail (G_VALUE_TYPE (value) == GST_TYPE_STRUCTURE, FALSE);
82 sub = gst_value_get_structure (value);
83 gst_structure_get (sub, "type", G_TYPE_GTYPE, &type, "flags",
84 GST_TYPE_TRACER_VALUE_FLAGS, &flags, NULL);
86 if (flags & GST_TRACER_VALUE_FLAGS_OPTIONAL) {
87 gchar *opt_name = g_strconcat ("have-", g_quark_to_string (field_id), NULL);
89 /* add a boolean field, that indicates the presence of the next field */
90 g_value_init (&template_value, G_TYPE_BOOLEAN);
92 priv__gst_structure_append_template_to_gstring (g_quark_from_string
93 (opt_name), &template_value, s);
94 g_value_unset (&template_value);
98 g_value_init (&template_value, type);
99 res = priv__gst_structure_append_template_to_gstring (field_id,
101 g_value_unset (&template_value);
106 gst_tracer_record_build_format (GstTracerRecord * self)
108 GstStructure *structure = self->spec;
110 gchar *name = (gchar *) g_quark_to_string (structure->name);
113 g_return_if_fail (g_str_has_suffix (name, ".class"));
115 GST_TRACE ("%" GST_PTR_FORMAT, structure);
117 /* cut off '.class' suffix */
118 name = g_strdup (name);
119 p = strrchr (name, '.');
122 s = g_string_sized_new (STRUCTURE_ESTIMATED_STRING_LEN (structure));
123 g_string_append (s, name);
124 gst_structure_foreach (structure, build_field_template, s);
125 g_string_append_c (s, ';');
127 self->format = g_string_free (s, FALSE);
128 GST_INFO ("new format string: %s", self->format);
133 gst_tracer_record_dispose (GObject * object)
135 GstTracerRecord *self = GST_TRACER_RECORD (object);
137 gst_structure_free (self->spec);
138 g_free (self->format);
142 gst_tracer_record_set_property (GObject * object, guint prop_id,
143 const GValue * value, GParamSpec * pspec)
145 GstTracerRecord *self = GST_TRACER_RECORD_CAST (object);
149 self->spec = g_value_get_boxed (value);
150 gst_tracer_record_build_format (self);
153 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
159 gst_tracer_record_get_property (GObject * object, guint prop_id,
160 GValue * value, GParamSpec * pspec)
162 GstTracerRecord *self = GST_TRACER_RECORD_CAST (object);
166 // TODO(ensonic): copy?
167 g_value_set_boxed (value, self->spec);
170 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
176 gst_tracer_record_class_init (GstTracerRecordClass * klass)
178 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
180 gobject_class->set_property = gst_tracer_record_set_property;
181 gobject_class->get_property = gst_tracer_record_get_property;
182 gobject_class->dispose = gst_tracer_record_dispose;
184 properties[PROP_SPEC] =
185 g_param_spec_boxed ("spec", "Spec", "Log record specification",
187 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS);
189 g_object_class_install_properties (gobject_class, PROP_LAST, properties);
193 gst_tracer_record_init (GstTracerRecord * self)
198 * gst_tracer_record_new:
199 * @spec: the record specification
201 * Create a new tracer record. The record instance can be used to efficiently
202 * log entries using gst_tracer_record_log().
204 * The name of the @spec #GstStructure must end on '.class'. This name without
205 * the suffix will be used for the log records. The @spec must have a field for
206 * each value that gets logged where the field name is the value name. The field
207 * must be a nested structure describing the value. The sub structure must
208 * contain a field called 'type' of %G_TYPE_GTYPE that contains the GType of the
211 * The way to deal with optional values is to log an additional boolean before
212 * the optional field, that if %TRUE signals that the optional field is valid
213 * and %FALSE signals that the optional field should be ignored. One must still
214 * log a placeholder value for the optional field though. Please also note, that
215 * pointer type values must not be NULL - the underlying serialisation can not
216 * handle that right now.
219 * Please note that this is still under discussion and subject to change.
222 * Returns: a new #GstTracerRecord
225 gst_tracer_record_new (GstStructure * spec)
227 return g_object_new (GST_TYPE_TRACER_RECORD, "spec", spec, NULL);
230 #ifndef GST_DISABLE_GST_DEBUG
232 * gst_tracer_record_log:
233 * @self: the tracer-record
234 * @...: the args as described in the spec-
236 * Serialzes the trace event into the log.
238 * Right now this is using the gstreamer debug log with the level TRACE (7) and
239 * the category "GST_TRACER".
241 * Please note that this is still under discussion and subject to change.
245 gst_tracer_record_log (GstTracerRecord * self, ...)
250 * does it make sense to use the {file, line, func} from the tracer hook?
252 * - we'd need to pass them in the macros to gst_tracer_dispatch()
253 * - and each tracer needs to grab them from the va_list and pass them here
255 * - we create a context in dispatch, pass that to the tracer
256 * - and the tracer will pass that here
257 * ideally we also use *our* ts instead of the one that
258 * gst_debug_log_default() will pick
261 va_start (var_args, self);
262 if (G_LIKELY (GST_LEVEL_TRACE <= _gst_debug_min)) {
263 gst_debug_log_valist (GST_CAT_DEFAULT, GST_LEVEL_TRACE, "", "", 0, NULL,
264 self->format, var_args);