gst/gsttracer.h

   1 /* GStreamer
   2  * Copyright (C) 2013 Stefan Sauer <ensonic@users.sf.net>
   3  *
   4  * gsttracer.h: 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 #ifndef __GST_TRACER_H__
  23 #define __GST_TRACER_H__
  24
  25 #include <glib.h>
  26 #include <glib-object.h>
  27 #include <gst/gstobject.h>
  28 #include <gst/gstconfig.h>
  29
  30 G_BEGIN_DECLS
  31
  32 typedef struct _GstTracer GstTracer;
  33 typedef struct _GstTracerPrivate GstTracerPrivate;
  34 typedef struct _GstTracerClass GstTracerClass;
  35
  36 #define GST_TYPE_TRACER            (gst_tracer_get_type())
  37 #define GST_TRACER(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_TRACER,GstTracer))
  38 #define GST_TRACER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_TRACER,GstTracerClass))
  39 #define GST_IS_TRACER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_TRACER))
  40 #define GST_IS_TRACER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_TRACER))
  41 #define GST_TRACER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj),GST_TYPE_TRACER,GstTracerClass))
  42 #define GST_TRACER_CAST(obj)       ((GstTracer *)(obj))
  43
  44 struct _GstTracer {
  45   GstObject        parent;
  46   /*< private >*/
  47   GstTracerPrivate *priv;
  48   gpointer _gst_reserved[GST_PADDING];
  49 };
  50
  51 struct _GstTracerClass {
  52   GstObjectClass parent_class;
  53
  54   /*< private >*/
  55   gpointer _gst_reserved[GST_PADDING];
  56 };
  57
  58 GST_API
  59 GType gst_tracer_get_type          (void);
  60
  61 #ifdef GST_USE_UNSTABLE_API
  62
  63 GST_API
  64 void gst_tracing_register_hook (GstTracer *tracer, const gchar *detail,
  65   GCallback func);
  66
  67 /* tracing modules */
  68
  69 GST_API
  70 gboolean gst_tracer_register (GstPlugin * plugin, const gchar * name, GType type);
  71
  72 #endif
  73
  74 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
  75 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstTracer, gst_object_unref)
  76 #endif
  77
  78 G_END_DECLS
  79
  80 #endif /* __GST_TRACER_H__ */
  81