Make get_flex_version.py script executable
[platform/upstream/gstreamer.git] / gst / gsttracerrecord.h
index 2ce3382..2392d1c 100644 (file)
@@ -27,7 +27,6 @@
 G_BEGIN_DECLS
 
 typedef struct _GstTracerRecord GstTracerRecord;
-typedef struct _GstTracerRecordPrivate GstTracerRecordPrivate;
 typedef struct _GstTracerRecordClass GstTracerRecordClass;
 
 #define GST_TYPE_TRACER_RECORD            (gst_tracer_record_get_type())
@@ -38,6 +37,7 @@ typedef struct _GstTracerRecordClass GstTracerRecordClass;
 #define GST_TRACER_RECORD_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj),GST_TYPE_TRACER_RECORD,GstTracerRecordClass))
 #define GST_TRACER_RECORD_CAST(obj)       ((GstTracerRecord *)(obj))
 
+GST_API
 GType gst_tracer_record_get_type          (void);
 
 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
@@ -51,7 +51,7 @@ G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstTracerRecord, gst_object_unref)
  * @GST_TRACER_VALUE_SCOPE_ELEMENT: the value is related to an #GstElement
  * @GST_TRACER_VALUE_SCOPE_PAD: the value is related to a #GstPad
  *
- * Tracing record will contain fields that contain a meassured value or extra
+ * Tracing record will contain fields that contain a measured value or extra
  * meta-data. One such meta data are values that tell where a measurement was
  * taken. This enumerating declares to which scope such a meta data field
  * relates to. If it is e.g. %GST_TRACER_VALUE_SCOPE_PAD, then each of the log
@@ -67,11 +67,36 @@ typedef enum
   GST_TRACER_VALUE_SCOPE_PAD
 } GstTracerValueScope;
 
+/**
+ * GstTracerValueFlags:
+ * @GST_TRACER_VALUE_FLAGS_NONE: no flags
+ * @GST_TRACER_VALUE_FLAGS_OPTIONAL: the value is optional. When using this flag
+ *   one need to have an additional boolean arg before this value in the
+ *   var-args list passed to  gst_tracer_record_log().
+ * @GST_TRACER_VALUE_FLAGS_AGGREGATED: the value is a combined figure, since the
+ *   start of tracing. Examples are averages or timestamps.
+ *
+ * Flag that describe the value. These flags help applications processing the
+ * logs to understand the values.
+ */
+typedef enum
+{
+  GST_TRACER_VALUE_FLAGS_NONE = 0,
+  GST_TRACER_VALUE_FLAGS_OPTIONAL = (1 << 0),
+  GST_TRACER_VALUE_FLAGS_AGGREGATED = (1 << 1),
+} GstTracerValueFlags;
+
 #ifdef GST_USE_UNSTABLE_API
 
-GstTracerRecord * gst_tracer_record_new (GstStructure *spec);
+GST_API
+GstTracerRecord * gst_tracer_record_new (const gchar * name, const gchar * firstfield, ...);
 
+#ifndef GST_DISABLE_GST_DEBUG
+GST_API
 void              gst_tracer_record_log (GstTracerRecord *self, ...);
+#else
+#define gst_tracer_record_log(...) G_STMT_START {} G_STMT_END
+#endif
 
 #endif