diff --git a/girs/GstAnalytics-1.0.gir b/girs/GstAnalytics-1.0.gir
index 7a04ce0c3d..8b62d06e64 100644
--- a/girs/GstAnalytics-1.0.gir
+++ b/girs/GstAnalytics-1.0.gir
@@ -11,10 +11,6 @@ and/or use gtk-doc annotations. -->
-
-
-
-
Handle containing data required to use gst_analytics_cls_mtd APIs. This type
is generally expected to be allocated on the stack.
@@ -98,7 +94,7 @@ Get quark of the class at @index
- Get a id identifying #GstAnalyticsMtd type.
+ Get an id identifying #GstAnalyticsMtd type.
opaque id of #GstAnalyticsMtd type
@@ -106,11 +102,13 @@ Get quark of the class at @index
-
+
+ Passes to functions asking for a relation span when the span is
+infinite.
-
+
@@ -164,8 +162,7 @@ Get analysis result type.
- @instance Instance of #GstAnalyticsRelatableMtd
-Get instance size
+ Get instance size
Size (in bytes) of this instance or 0 on failure.
@@ -173,6 +170,7 @@ Get instance size
+ Instance of #GstAnalyticsMtd
@@ -192,9 +190,12 @@ Get instance size
-
+
+ This structure must be provided when registering a new type of Mtd. It must
+have a static lifetime (never be freed).
+ The name of the metadata type
@@ -222,7 +223,7 @@ Get instance size
-
+
@@ -311,7 +312,7 @@ identified by @id is stored.
Get an id that represent object-detection metadata type
- Opaqu id of the #GstAnalyticsMtd type
+ Opaque id of the #GstAnalyticsMtd type
@@ -336,7 +337,11 @@ identified by @id is stored.
Only use for criteria.
-
+
+ An opaque #GstMeta that can be used to hold various types of results
+from analysis processes.
+
+The content should be accessed through the API.
Add analytic classification metadata to @instance.
@@ -374,14 +379,12 @@ identified by @id is stored.
-
+
Add a relatable metadata to @meta. This method is meant to be used by
new struct sub-classing GstAnalyticsRelatableMtd.
- A pointer to a memory area of size @size where to put the data
-
-Since 1.24
+ A pointer to a memory area of size @size where to put the data
@@ -499,7 +502,7 @@ Add an analytic tracking metadata to @instance.
-
+
Verify existence of relation(s) between @an_meta_first_d and
@an_meta_second_id according to relation condition @cond_types. It optionally
also return a shortest path of relations ( compliant with @cond_types)
@@ -507,9 +510,7 @@ between @an_meta_first_id and @an_meta_second_id.
TRUE if a relation between exit between @an_meta_first_id and
- @an_meta_second_id, otherwise FALSE.
-
-Since 1.24
+ @an_meta_second_id, otherwise FALSE.
@@ -550,14 +551,12 @@ Since 1.24
-
+
Fill @rlt if a analytics-meta with id == @an_meta_id exist in @meta instance,
otherwise this method return FALSE and @rlt is invalid.
- TRUE if successful.
-
-Since 1.24
+ TRUE if successful.
@@ -576,12 +575,10 @@ Since 1.24
-
+
- TRUE if @rlt_mtd was updated, other wise FALSE
-
-Since 1.24
+ TRUE if @rlt_mtd was updated, other wise FALSE
@@ -614,14 +611,12 @@ Since 1.24
-
+
Fill @rlt if a analytics-meta with id == @an_meta_id exist in @meta instance,
otherwise this method return FALSE and @rlt is invalid.
- TRUE if successful.
-
-Since 1.24
+ TRUE if successful.
@@ -645,12 +640,10 @@ Since 1.24
-
+
- Analytics data pointer
-
-Since 1.24
+ Analytics data pointer
@@ -664,14 +657,12 @@ Since 1.24
-
+
Fill @rlt if a analytics-meta with id == @an_meta_id exist in @meta instance,
otherwise this method return FALSE and @rlt is invalid.
- TRUE if successful.
-
-Since 1.24
+ TRUE if successful.
@@ -680,7 +671,7 @@ Since 1.24
- Id of #GstAnalyticsOdMtd instance to retrieve
+ Id of #GstAnalyticsODMtd instance to retrieve
@@ -715,14 +706,12 @@ Ids (@an_meta_first_id and @an_meta_second_id) must be from a call to
-
+
Fill @rlt if a analytics-meta with id == @an_meta_id exist in @meta instance,
otherwise this method return FALSE and @rlt is invalid.
- TRUE if successful.
-
-Since 1.24
+ TRUE if successful.
@@ -741,12 +730,10 @@ Since 1.24
-
+
- FALSE if end was reached and iteration is completed.
-
-Since 1.24
+ FALSE if end was reached and iteration is completed.
@@ -800,7 +787,8 @@ Ids must have been obtained a call to
-
+
+ Get the meta info
@@ -901,7 +889,7 @@ Get the opaque id identifying the relatable type
-
+
Attach a analysis-results-meta-relation meta (#GstAnalyticsRelationMeta)to @buffer.
A #GstAnalyticsRelationMeta is a metadata describing relation between other
@@ -909,9 +897,7 @@ analysis meta. It's more efficient to use #gst_buffer_add_analytics_relation_met
and providing the maximum number of analysis meta that will attached to a buffer.
- Newly attached #GstAnalyticsRelationMeta
-
-Since 1.24
+ Newly attached #GstAnalyticsRelationMeta
@@ -921,16 +907,14 @@ Since 1.24
-
+
Attache a analysis-results relation-meta (#GstAnalyticsRelationMeta) to @buffer.
A #GstAnalyticsRelationMeta is a metadata describing relation between other
analysis meta.
- Newly attached #GstAnalyticsRelationMeta
-
-Since 1.24
+ Newly attached #GstAnalyticsRelationMeta
@@ -959,13 +943,36 @@ Since 1.24
- Get a id identifying #GstAnalyticsMtd type.
+ Get an id identifying #GstAnalyticsMtd type.
opaque id of #GstAnalyticsMtd type
+
+ This type of metadata holds classification, it is generally used in
+relationship with another metadata type to enhance its content. For example,
+it can enhance the classifcation of an object detection held by the
+#GstAnalyticsODMtd metadata type.
+
+
+ The #GstAnalyticsRelationMeta is a #GstMeta that can contain a large number
+of results from the analysis of a meta. Each result can be accessed by
+using its id, or more conviently, by using a #GstAnalyticsMtd. A matrix
+of relationships between the various metadata is also defined and can be
+filled by the analysis processes.
+
+
+ This type of metadata holds the position of detected object inside the
+image, along with the probabily of each detection.
+
+
+ This type of metadata holds tracking information. In many cases, it is
+desired to track an object across many frames. This type of metadata holds
+information about the tracking, for example, it can be used alongside a
+#GstAnalyticsODMtd to track an object.
+
Gets the string version of the name of this type of analytics data
@@ -984,13 +991,12 @@ Since 1.24
Get an id that represent object-detection metadata type
- Opaqu id of the #GstAnalyticsMtd type
+ Opaque id of the #GstAnalyticsMtd type
- @instance Instance of #GstAnalyticsRelationMeta
-Get number of relatable meta attached to instance
+ Get number of relatable meta attached to instance
Number of analysis-meta attached to this
@@ -999,6 +1005,7 @@ instance.
+ Instance of #GstAnalyticsRelationMeta
@@ -1010,7 +1017,8 @@ instance.
-
+
+ Get the meta info
diff --git a/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsclassificationmtd.c b/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsclassificationmtd.c
index 410902af2f..0fc5065389 100644
--- a/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsclassificationmtd.c
+++ b/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsclassificationmtd.c
@@ -55,7 +55,7 @@ struct _GstAnalyticsClsMtdData
/**
* gst_analytics_cls_mtd_get_mtd_type:
- * Get a id identifying #GstAnalyticsMtd type.
+ * Get an id identifying #GstAnalyticsMtd type.
*
* Returns: opaque id of #GstAnalyticsMtd type
*
@@ -235,7 +235,7 @@ gst_analytics_relation_meta_add_one_cls_mtd (GstAnalyticsRelationMeta *
*
* Returns: TRUE if successful.
*
- * Since 1.24
+ * Since: 1.24
*/
gboolean
gst_analytics_relation_meta_get_cls_mtd (GstAnalyticsRelationMeta * meta,
diff --git a/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsmeta.c b/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsmeta.c
index 36073eb20e..054caff898 100644
--- a/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsmeta.c
+++ b/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsmeta.c
@@ -148,7 +148,8 @@ gst_analytics_mtd_get_id (GstAnalyticsMtd * handle)
/**
* gst_analytics_mtd_get_size:
- * @instance Instance of #GstAnalyticsRelatableMtd
+ * @instance: Instance of #GstAnalyticsMtd
+ *
* Get instance size
*
* Returns: Size (in bytes) of this instance or 0 on failure.
@@ -194,7 +195,8 @@ gst_analytics_mtd_type_get_name (GstAnalyticsMtdType type)
/**
* gst_analytics_relation_get_length:
- * @instance Instance of #GstAnalyticsRelationMeta
+ * @instance: Instance of #GstAnalyticsRelationMeta
+ *
* Get number of relatable meta attached to instance
*
* Returns: Number of analysis-meta attached to this
@@ -435,6 +437,13 @@ gst_analytics_relation_meta_clear (GstBuffer * buffer, GstMeta * meta)
}
}
+/**
+ * gst_analytics_relation_meta_get_info: (skip)
+ *
+ * Get the meta info
+ *
+ * Since: 1.24
+ */
const GstMetaInfo *
gst_analytics_relation_meta_get_info (void)
{
@@ -648,7 +657,7 @@ gst_analytics_relation_meta_set_relation (GstAnalyticsRelationMeta * meta,
* Returns: TRUE if a relation between exit between @an_meta_first_id and
* @an_meta_second_id, otherwise FALSE.
*
- * Since 1.24
+ * Since: 1.24
*/
gboolean
gst_analytics_relation_meta_exist (GstAnalyticsRelationMeta * rmeta,
@@ -777,7 +786,7 @@ gst_analytics_relation_meta_exist (GstAnalyticsRelationMeta * rmeta,
*
* Returns: (transfer none) (nullable) : Newly attached #GstAnalyticsRelationMeta
*
- * Since 1.24
+ * Since: 1.24
*/
GstAnalyticsRelationMeta *
gst_buffer_add_analytics_relation_meta (GstBuffer * buffer)
@@ -798,7 +807,7 @@ gst_buffer_add_analytics_relation_meta (GstBuffer * buffer)
*
* Returns: (transfer none) (nullable) : Newly attached #GstAnalyticsRelationMeta
*
- * Since 1.24
+ * Since: 1.24
*/
GstAnalyticsRelationMeta *
gst_buffer_add_analytics_relation_meta_full (GstBuffer * buffer,
@@ -850,7 +859,7 @@ gst_buffer_get_analytics_relation_meta (GstBuffer * buffer)
*
* Returns: A pointer to a memory area of size @size where to put the data
*
- * Since 1.24
+ * Since: 1.24
*/
gpointer
gst_analytics_relation_meta_add_mtd (GstAnalyticsRelationMeta * meta,
@@ -933,7 +942,7 @@ gst_analytics_relation_meta_add_mtd (GstAnalyticsRelationMeta * meta,
*
* Returns: TRUE if successful.
*
- * Since 1.24
+ * Since: 1.24
*/
gboolean
gst_analytics_relation_meta_get_mtd (GstAnalyticsRelationMeta * meta,
@@ -977,7 +986,7 @@ gst_analytics_relation_meta_get_mtd (GstAnalyticsRelationMeta * meta,
*
* Returns:(nullable): Analytics data pointer
*
- * Since 1.24
+ * Since: 1.24
*/
gpointer
gst_analytics_relation_meta_get_mtd_data (GstAnalyticsRelationMeta *
@@ -1003,7 +1012,7 @@ gst_analytics_relation_meta_get_mtd_data (GstAnalyticsRelationMeta *
*
* Returns: TRUE if @rlt_mtd was updated, other wise FALSE
*
- * Since 1.24
+ * Since: 1.24
*/
gboolean
gst_analytics_relation_meta_get_direct_related (GstAnalyticsRelationMeta * meta,
@@ -1076,7 +1085,7 @@ gst_analytics_relation_meta_get_direct_related (GstAnalyticsRelationMeta * meta,
*
* Returns: FALSE if end was reached and iteration is completed.
*
- * Since 1.24
+ * Since: 1.24
*/
gboolean
gst_analytics_relation_meta_iterate (GstAnalyticsRelationMeta * meta,
diff --git a/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsmeta.h b/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsmeta.h
index 327a5d8979..29147bf202 100644
--- a/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsmeta.h
+++ b/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsmeta.h
@@ -100,9 +100,23 @@ const gchar *gst_analytics_mtd_type_get_name (GstAnalyticsMtdType type);
typedef struct _GstAnalyticsRelationMetaInitParams
GstAnalyticsRelationMetaInitParams;
+/**
+ * GST_ANALYTICS_RELATION_META_API_TYPE:
+ *
+ * The Analyics Relation Meta API type
+ *
+ * Since: 1.24
+ */
#define GST_ANALYTICS_RELATION_META_API_TYPE \
(gst_analytics_relation_meta_api_get_type())
+/**
+ * GST_ANALYTICS_RELATION_META_INFO: (skip)
+ *
+ * Get the meta info
+ *
+ * Since: 1.24
+ */
#define GST_ANALYTICS_RELATION_META_INFO \
(gst_analytics_relation_meta_get_info())
diff --git a/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsobjectdetectionmtd.c b/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsobjectdetectionmtd.c
index 1657ff944b..070803b487 100644
--- a/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsobjectdetectionmtd.c
+++ b/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsobjectdetectionmtd.c
@@ -93,7 +93,7 @@ static const GstAnalyticsMtdImpl od_impl = {
* gst_analytics_od_mtd_get_mtd_type:
* Get an id that represent object-detection metadata type
*
- * Returns: Opaqu id of the #GstAnalyticsMtd type
+ * Returns: Opaque id of the #GstAnalyticsMtd type
*
* Since: 1.24
*/
@@ -227,7 +227,7 @@ gst_analytics_relation_meta_add_od_mtd (GstAnalyticsRelationMeta *
/**
* gst_analytics_relation_meta_get_od_mtd:
* @meta: Instance of #GstAnalyticsRelationMeta
- * @an_meta_id: Id of #GstAnalyticsOdMtd instance to retrieve
+ * @an_meta_id: Id of #GstAnalyticsODMtd instance to retrieve
* @rlt: (out caller-allocates)(not nullable): Will be filled with relatable
* meta
*
@@ -236,7 +236,7 @@ gst_analytics_relation_meta_add_od_mtd (GstAnalyticsRelationMeta *
*
* Returns: TRUE if successful.
*
- * Since 1.24
+ * Since: 1.24
*/
gboolean
gst_analytics_relation_meta_get_od_mtd (GstAnalyticsRelationMeta * meta,
diff --git a/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsobjecttrackingmtd.c b/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsobjecttrackingmtd.c
index 6e776efb36..40a646f188 100644
--- a/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsobjecttrackingmtd.c
+++ b/subprojects/gst-plugins-bad/gst-libs/gst/analytics/gstanalyticsobjecttrackingmtd.c
@@ -189,7 +189,7 @@ gst_analytics_relation_meta_add_tracking_mtd (GstAnalyticsRelationMeta *
*
* Returns: TRUE if successful.
*
- * Since 1.24
+ * Since: 1.24
*/
gboolean
gst_analytics_relation_meta_get_tracking_mtd (GstAnalyticsRelationMeta * meta,