stats: add a stats frontend
[platform/upstream/gstreamer.git] / plugins / tracers / gststats.h
1 /* GStreamer
2  * Copyright (C) 2013 Stefan Sauer <ensonic@users.sf.net>
3  *
4  * gststats.h: tracing module that logs events
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_STATS_TRACER_H__
23 #define __GST_STATS_TRACER_H__
24
25 #include <gst/gst.h>
26
27 G_BEGIN_DECLS
28
29 #define GST_TYPE_STATS_TRACER \
30   (gst_stats_tracer_get_type())
31 #define GST_STATS_TRACER(obj) \
32   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_STATS_TRACER,GstStatsTracer))
33 #define GST_STATS_TRACER_CLASS(klass) \
34   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_STATS_TRACER,GstStatsTracerClass))
35 #define GST_IS_STATS_TRACER(obj) \
36   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_STATS_TRACER))
37 #define GST_IS_STATS_TRACER_CLASS(klass) \
38   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_STATS_TRACER))
39 #define GST_STATS_TRACER_CAST(obj) ((GstStatsTracer *)(obj))
40
41 typedef struct _GstStatsTracer GstStatsTracer;
42 typedef struct _GstStatsTracerClass GstStatsTracerClass;
43
44 /**
45  * GstStatsTracer:
46  *
47  * Opaque #GstStatsTracer data structure
48  */
49 struct _GstStatsTracer {
50   GstTracer      parent;
51
52   /*< private >*/
53   GPtrArray *elements;
54   GPtrArray *pads;
55   guint num_elements, num_pads;
56 };
57
58 struct _GstStatsTracerClass {
59   GstTracerClass parent_class;
60
61   /* signals */
62 };
63
64 G_GNUC_INTERNAL GType gst_stats_tracer_get_type (void);
65
66 G_END_DECLS
67
68 #endif /* __GST_STATS_TRACER_H__ */