///
///
///
///
///
///
/**
* Type Definitions for Gjs (https://gjs.guide/)
*
* These type definitions are automatically generated, do not edit them by hand.
* If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gir
*
* The based EJS template file is used for the generated .d.ts file of each GIR module like Gtk-4.0, GObject-2.0, ...
*/
declare module 'gi://GstAnalytics?version=1.0' {
// Module dependencies
import type GstVideo from 'gi://GstVideo?version=1.0';
import type GstBase from 'gi://GstBase?version=1.0';
import type Gst from 'gi://Gst?version=1.0';
import type GObject from 'gi://GObject?version=2.0';
import type GLib from 'gi://GLib?version=2.0';
import type GModule from 'gi://GModule?version=2.0';
export namespace GstAnalytics {
/**
* GstAnalytics-1.0
*/
/**
* Enum value describing supported segmentation type
*/
/**
* Enum value describing supported segmentation type
*/
export namespace SegmentationType {
export const $gtype: GObject.GType;
}
enum SegmentationType {
/**
* Segmentation where the belonging of each
* pixel to a class of objects is identified.
*/
SEMANTIC,
/**
* Segmentation where the belonging of each
* pixel to instance of an object is identified.
*/
INSTANCE,
}
/**
* Describe the type of data contain in the tensor.
*/
/**
* Describe the type of data contain in the tensor.
*/
export namespace TensorDataType {
export const $gtype: GObject.GType;
}
enum TensorDataType {
/**
* signed 4 bit integer tensor data
*/
INT4,
/**
* signed 8 bit integer tensor data
*/
INT8,
/**
* signed 16 bit integer tensor data
*/
INT16,
/**
* signed 32 bit integer tensor data
*/
INT32,
/**
* signed 64 bit integer tensor data
*/
INT64,
/**
* unsigned 4 bit integer tensor data
*/
UINT4,
/**
* unsigned 8 bit integer tensor data
*/
UINT8,
/**
* unsigned 16 bit integer tensor data
*/
UINT16,
/**
* unsigned 32 bit integer tensor data
*/
UINT32,
/**
* unsigned 64 bit integer tensor data
*/
UINT64,
/**
* 16 bit floating point tensor data
*/
FLOAT16,
/**
* 32 bit floating point tensor data
*/
FLOAT32,
/**
* 64 bit floating point tensor data
*/
FLOAT64,
/**
* "brain" 16 bit floating point tensor data
*/
BFLOAT16,
}
/**
* Indicate to read tensor from memory in row-major or column-major order.
*/
/**
* Indicate to read tensor from memory in row-major or column-major order.
*/
export namespace TensorDimOrder {
export const $gtype: GObject.GType;
}
enum TensorDimOrder {
/**
* elements along a row are consecutive in memory
*/
ROW_MAJOR,
/**
* elements along a column are consecutive in memory
*/
COL_MAJOR,
}
/**
* Indicate tensor storage in memory.
*/
/**
* Indicate tensor storage in memory.
*/
export namespace TensorLayout {
export const $gtype: GObject.GType;
}
enum TensorLayout {
/**
* indicate the tensor is stored in a dense format in memory
*/
TENSOR_LAYOUT_CONTIGUOUS,
}
/**
* Passes to functions asking for a relation span when the span is
* infinite.
*/
const INF_RELATION_SPAN: number;
/**
* A wildcard matching any type of analysis
*/
const MTD_TYPE_ANY: number;
/**
* Attach a analysis-results-meta-relation meta (#GstAnalyticsRelationMeta)to `buffer`.
*
* A #GstAnalyticsRelationMeta is a metadata describing relation between other
* analysis meta. It's more efficient to use #gst_buffer_add_analytics_relation_meta_full
* and providing the maximum number of analysis meta that will attached to a buffer.
* @param buffer a #GstBuffer
* @returns Newly attached #GstAnalyticsRelationMeta
*/
function buffer_add_analytics_relation_meta(buffer: Gst.Buffer): RelationMeta | null;
/**
* Attache a analysis-results relation-meta (#GstAnalyticsRelationMeta) to `buffer`.
*
* A #GstAnalyticsRelationMeta is a metadata describing relation between other
* analysis meta.
* @param buffer a #GstBuffer
* @param init_params Initialization parameters
* @returns Newly attached #GstAnalyticsRelationMeta
*/
function buffer_add_analytics_relation_meta_full(
buffer: Gst.Buffer,
init_params: RelationMetaInitParams,
): RelationMeta | null;
/**
* Adds a #GstTensorMeta to a buffer or returns the existing one
* @param buffer A writable #GstBuffer
* @returns The new #GstTensorMeta
*/
function buffer_add_tensor_meta(buffer: Gst.Buffer): TensorMeta;
/**
* Retrives the meta or %NULL if it doesn't exist
* @param buffer a #GstBuffer
* @returns The #GstAnalyticsRelationMeta if there is one
*/
function buffer_get_analytics_relation_meta(buffer: Gst.Buffer): RelationMeta | null;
/**
* Gets the #GstTensorMeta from a buffer
* @param buffer A #GstBuffer
* @returns The #GstTensorMeta if there is wone
*/
function buffer_get_tensor_meta(buffer: Gst.Buffer): TensorMeta | null;
/**
* Get an id identifying #GstAnalyticsMtd type.
* @returns opaque id of #GstAnalyticsMtd type
*/
function cls_mtd_get_mtd_type(): MtdType;
/**
* Gets the string version of the name of this type of analytics data
* @param type The type of analytics data
* @returns the name
*/
function mtd_type_get_name(type: MtdType): string;
/**
* Get an id that represent object-detection metadata type
* @returns Opaque id of the #GstAnalyticsMtd type
*/
function od_mtd_get_mtd_type(): MtdType;
/**
* Get number of relatable meta attached to instance
* @param instance Instance of #GstAnalyticsRelationMeta
* @returns Number of analysis-meta attached to this instance.
*/
function relation_get_length(instance: RelationMeta): number;
function relation_meta_api_get_type(): GObject.GType;
/**
* Get an instance of #GstAnalyticsMtdType that represent segmentation
* metadata type.
* @returns A #GstAnalyticsMtdType type
*/
function segmentation_mtd_get_mtd_type(): MtdType;
function tracking_mtd_get_mtd_type(): MtdType;
export namespace RelTypes {
export const $gtype: GObject.GType;
}
enum RelTypes {
/**
* No relation
*/
NONE,
/**
* First analysis-meta is part of second analysis-meta
*/
IS_PART_OF,
/**
* First analysis-meta contain second analysis-meta.
*/
CONTAIN,
/**
* First analysis-meta relate to second analysis-meta.
*/
RELATE_TO,
/**
* Used to express relations between two groups where each group's components
* correspond to the respective component in the other group.
*/
N_TO_N,
/**
* Only use for criteria.
*/
ANY,
}
/**
* Handle containing data required to use gst_analytics_cls_mtd APIs. This type
* is generally expected to be allocated on the stack.
*/
class ClsMtd {
static $gtype: GObject.GType;
// Fields
id: number;
// Constructors
_init(...args: any[]): void;
// Static methods
/**
* Get an id identifying #GstAnalyticsMtd type.
*/
static get_mtd_type(): MtdType;
// Methods
get_index_by_quark(quark: GLib.Quark): number;
get_length(): number;
/**
* Get confidence level for class at `index`
* @param index Object class index
* @returns confidence level for @index, <0.0 if the call failed.
*/
get_level(index: number): number;
get_quark(index: number): GLib.Quark;
}
/**
* Handle containing data required to use gst_analytics_mtd API. This type
* is generally expected to be allocated on the stack.
*/
class Mtd {
static $gtype: GObject.GType;
// Fields
id: number;
// Constructors
_init(...args: any[]): void;
// Static methods
/**
* Gets the string version of the name of this type of analytics data
* @param type The type of analytics data
*/
static type_get_name(type: MtdType): string;
// Methods
/**
* Get instance id
* @returns Id of @instance
*/
get_id(): number;
get_mtd_type(): MtdType;
/**
* Get instance size
* @returns Size (in bytes) of this instance or 0 on failure.
*/
get_size(): number;
}
/**
* This structure must be provided when registering a new type of Mtd. It must
* have a static lifetime (never be freed).
*/
class MtdImpl {
static $gtype: GObject.GType;
// Fields
name: string;
// Constructors
constructor(
properties?: Partial<{
name: string;
}>,
);
_init(...args: any[]): void;
}
/**
* Handle containing data required to use gst_analytics_od_mtd APIs. This type
* is generally expected to be allocated on the stack.
*/
class ODMtd {
static $gtype: GObject.GType;
// Fields
id: number;
// Constructors
_init(...args: any[]): void;
// Static methods
/**
* Get an id that represent object-detection metadata type
*/
static get_mtd_type(): MtdType;
// Methods
/**
* Retrieve location confidence level.
* @returns TRUE on success, otherwise FALSE.
*/
get_confidence_lvl(): [boolean, number];
/**
* Retrieve location and location confidence level.
* @returns TRUE on success, otherwise FALSE.
*/
get_location(): [boolean, number, number, number, number, number];
/**
* Quark of the class of object associated with this location.
* @returns Quark different from on success and 0 on failure.
*/
get_obj_type(): GLib.Quark;
/**
* Retrieve oriented location and location confidence level.
* @returns TRUE on success, otherwise FALSE.
*/
get_oriented_location(): [boolean, number, number, number, number, number, number];
}
/**
* An opaque #GstMeta that can be used to hold various types of results
* from analysis processes.
*
* The content should be accessed through the API.
*/
abstract class RelationMeta {
static $gtype: GObject.GType;
// Constructors
_init(...args: any[]): void;
// Methods
/**
* Add analytic classification metadata to `instance`.
* @param confidence_levels confidence levels
* @param class_quarks labels of this classification. Order define index, quark, labels relation. This array need to exist as long has this classification meta exist.
* @returns Added successfully
*/
add_cls_mtd(confidence_levels: number[], class_quarks: GLib.Quark[]): [boolean, ClsMtd];
add_od_mtd(
type: GLib.Quark,
x: number,
y: number,
w: number,
h: number,
loc_conf_lvl: number,
): [boolean, ODMtd | null];
/**
* Add analytic classification metadata to `instance`.
* @param confidence_level confidence levels
* @param class_quark labels of this classification. Order define index, quark, labels relation. This array need to exist as long has this classification meta exist.
* @returns Added successfully
*/
add_one_cls_mtd(confidence_level: number, class_quark: GLib.Quark): [boolean, ClsMtd];
add_oriented_od_mtd(
type: GLib.Quark,
x: number,
y: number,
w: number,
h: number,
r: number,
loc_conf_lvl: number,
): [boolean, ODMtd | null];
/**
* Add analytics segmentation metadata to `instance`. The rectangle (`masks_loc_x,`
* `mask_loc_y,` `mask_loc_w,` `mask_loc_h)` define a area of the image that
* correspond to the segmentation masks stored in `buffer`. For example if the
* segmentation masks stored in `buffer` describe the segmented regions for the
* entire image the rectangular area will be (`masks_loc_x` = 0, `masks_loc_y` = 0,
* `masks_loc_w` = image_width, `masks_loc_h` = image_height).
* @param buffer Buffer containing segmentation masks. @buffer must have a #GstVideoMeta attached
* @param segmentation_type Segmentation type
* @param region_ids Arrays of region ids present in the mask.
* @param masks_loc_x Left coordinate of the rectangle corresponding to the masks in the image.
* @param masks_loc_y Top coordinate of the rectangle corresponding to the masks in the image.
* @param masks_loc_w Width of the rectangle corresponding to the masks in the image.
* @param masks_loc_h Height of the rectangle corresponding to the masks in the image.
* @returns TRUE if added successfully, otherwise FALSE
*/
add_segmentation_mtd(
buffer: Gst.Buffer,
segmentation_type: SegmentationType | null,
region_ids: number[],
masks_loc_x: number,
masks_loc_y: number,
masks_loc_w: number,
masks_loc_h: number,
): [boolean, SegmentationMtd];
add_tracking_mtd(tracking_id: number, tracking_first_seen: Gst.ClockTime): [boolean, TrackingMtd];
/**
* 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)`
* between `an_meta_first_id` and `an_meta_second_id`.
* @param an_meta_first_id First analysis-meta
* @param an_meta_second_id Second analysis-meta
* @param max_relation_span Maximum number of relation between @an_meta_first_id and @an_meta_second_id. A value of 1 mean only only consider direct relation.
* @param cond_types condition on relation types.
* @returns TRUE if a relation between exit between @an_meta_first_id and @an_meta_second_id, otherwise FALSE.
*/
exist(
an_meta_first_id: number,
an_meta_second_id: number,
max_relation_span: number,
cond_types: RelTypes | null,
): [boolean, number[] | null];
/**
* Fill `rlt` if a analytics-meta with id == `an_meta_id` exist in `meta` instance,
* otherwise this method return FALSE and `rlt` is invalid.
* @param an_meta_id Id of #GstAnalyticsClsMtd instance to retrieve
* @returns TRUE if successful.
*/
get_cls_mtd(an_meta_id: number): [boolean, ClsMtd];
get_direct_related(
an_meta_id: number,
relation_type: RelTypes | null,
type: MtdType,
state: any,
): [boolean, any, Mtd];
/**
* Fill `rlt` if a analytics-meta with id == `an_meta_id` exist in `meta` instance,
* otherwise this method return FALSE and `rlt` is invalid.
* @param an_meta_id Id of GstAnalyticsMtd instance to retrieve
* @param type Filter on a specific type of analysis, use %GST_ANALYTICS_MTD_TYPE_ANY to match any type
* @returns TRUE if successful.
*/
get_mtd(an_meta_id: number, type: MtdType): [boolean, Mtd];
/**
* Fill `rlt` if a analytics-meta with id == `an_meta_id` exist in `meta` instance,
* otherwise this method return FALSE and `rlt` is invalid.
* @param an_meta_id Id of #GstAnalyticsODMtd instance to retrieve
* @returns TRUE if successful.
*/
get_od_mtd(an_meta_id: number): [boolean, ODMtd];
/**
* Get relations between first and second analysis-meta.
* Ids (`an_meta_first_id` and `an_meta_second_id)` must be from a call to
* `gst_analytics_mtd_get_id` (handle).
* @param an_meta_first_id Id of first analysis-meta
* @param an_meta_second_id Id of second analysis-meta
* @returns relation description between first and second analysis-meta.
*/
get_relation(an_meta_first_id: number, an_meta_second_id: number): RelTypes;
/**
* Fill `rlt` if a analytics-meta with id == `an_meta_id` exist in `meta` instance,
* otherwise this method return FALSE and `rlt` is invalid.
* @param an_meta_id Id of #GstAnalyticsSegmentationMtd instance to retrieve
* @returns TRUE if successful.
*/
get_segmentation_mtd(an_meta_id: number): [boolean, SegmentationMtd];
/**
* Fill `rlt` if a analytics-meta with id == `an_meta_id` exist in `meta` instance,
* otherwise this method return FALSE and `rlt` is invalid.
* @param an_meta_id Id of GstAnalyticsMtd instance to retrieve
* @returns TRUE if successful.
*/
get_tracking_mtd(an_meta_id: number): [boolean, TrackingMtd];
iterate(state: any | null, type: MtdType): [boolean, Mtd];
/**
* Sets the relation (#GstAnalyticsRelTypes) between `an_meta_first` and
* `an_meta_second`.
* Ids must have been obtained a call to
* `gst_analytics_mtd_get_id(`handle).
* @param type a #GstAnalyticsRelTypes defining relation between two analysis-meta
* @param an_meta_first_id first meta id
* @param an_meta_second_id second meta id
* @returns TRUE on success and FALSE on failure.
*/
set_relation(type: RelTypes | null, an_meta_first_id: number, an_meta_second_id: number): boolean;
}
/**
* GstAnalyticsRelationMeta initialization parameters.
*/
class RelationMetaInitParams {
static $gtype: GObject.GType;
// Fields
initial_relation_order: number;
initial_buf_size: number;
// Constructors
constructor(
properties?: Partial<{
initial_relation_order: number;
initial_buf_size: number;
}>,
);
_init(...args: any[]): void;
}
/**
* This type of metadata holds information on which pixels belongs to
* a region of the image representing a type of object.
*
* It supports two types of segmentation, semantic or instance:
* * Semantic: All objects of the same type have the same id
* * Instance: Each instance of an object has a different id
*
* The results of the segmentation are stored in a #GstBuffer that has a
* #GstVideoMeta associated with it. This buffer is stored in the
* GstAnalyticsSegmentationMtd using
* #gst_analytics_relation_meta_add_segmentation_mtd(). The #GstBuffer
* containing the segmentation mask is image-like but the color values are
* arbitrary values, referred by region-id in this API, without meaning beyond
* specifying that two pixels in the original image with the same values in
* their corresponding mask value belong to the same region.
*
* To further describe a region, the #GstAnalyticsSegmentationMtd can be
* associated with other #GstAnalyticsMtd. Since region ids are
* generated by the segmentation process itself and are not always sequential,
* we use a map of indexes to region ids starting with 0 without discontinuity
* which facilitate N-to-N mapping with other #GstAnalyticsMtd. For
* example it can be associated with #GstAnalyticsClsMtd to describe the class
* of object matching the pixels of a segmented region.
*
* Example: Associate Instance Segmentation with Classification
*
* In the following example the segmentation process will fill segmask with
* values of 0 for background, 12 for the first region which correspond to a
* to a strawberry, 7 for the second region that also correspond to a
* strawberry in the image and 31 for the third region that correspond to a
* leaf in the image.
* region_ids is fill during segmentation post-processing
*
* region_ids:
* |region-index | region-id |
* |-------------|-----------|
* | 0 | 0 |
* | 1 | 12 |
* | 2 | 7 |
* | 3 | 31 |
*
* region_count = 4
*
* ``` C
* GstAnalyticsSegmentationMtd segmtd;
* GstAnalyticsClassificationMtd clsmtd;
* GstBuffer *segmask, *img;
* guint *region_ids;
* gsize region_count, class_count;
* gfloat *class_confidence;
* GQuark *classes;
*
* ... (segmentation filling segmask based on img)
*
* gst_analytics_relation_meta_add_segmentation_mtd (rmeta, segmask,
* GST_SEGMENTATION_TYPE_INSTANCE, region_count, region_ids, &segmtd);
* class_count = region_count;
*
* ... (class-index must match and correspond to region-index)
* classes [0] = g_quark_from_string ("background");
* classes [1] = g_quark_from_string ("strawberry");
* classes [2] = g_quark_from_string ("strawberry");
* classes [3] = g_quark_from_string ("leaf");
*
* ... (set confidence level for each class associated with a region
* ... where -1.0 mean undefined.)
* class_confidence [0] = -1.0;
* class_confidence [1] = 0.6;
* class_confidence [2] = 0.9;
* class_confidence [3] = 0.8;
*
* gst_analytics_relation_meta_add_cls_mtd (rmeta, class_count,
* class_confidence, classes, &clsmtd);
*
* gst_analytics_relation_meta_set_relation (rmeta,
* GST_ANALYTICS_REL_TYPE_RELATE_TO, segmtd.id, clsmtd.id);
* ```
*
* Example: Associate Semantic Segmentation with Classification
* Assuming the same context as for Instance Segmentation above but instead
* a semantic segmentation is performed, therefore region-id-12 and region-id-7
* are now represented by the same region-id-12
*
* region_ids: (here
* |region-index | region-id |
* |-------------|-----------|
* | 0 | 0 |
* | 1 | 12 |
* | 2 | 31 |
*
* Code remain the same except that we set all confidence level to undefined
* (-1.0).
*
* ```
* ... (class-index must match and correspond to region-index)
* classes [0] = g_quark_from_string ("background");
* classes [1] = g_quark_from_string ("strawberry");
* classes [2] = g_quark_from_string ("leaf");
*
* ... (set confidence level for each class associated with a region
* ... where -1.0 mean undefined.)
* class_confidence [0] = -1.0;
* class_confidence [1] = -1.0;
* class_confidence [2] = -1.0;
*
* gst_analytics_relation_meta_add_cls_mtd (rmeta, class_count,
* class_confidence, classes, &clsmtd);
*
* gst_analytics_relation_meta_set_relation (rmeta,
* GST_ANALYTICS_REL_TYPE_RELATE_TO, segmtd.id, clsmtd.id);
* ```
*
* Example: Retrieving class associated with a segmentation region-id-12
* This the typical case for an overlay as we visit the segmentation mask we
* we find region-id values
*
* ```
* gsize idx;
* gst_analytics_segmentation_mtd_get_region_index (&segmtd, &idx, 12);
* gst_analytics_relation_meta_get_direct_related (rmeta, segmtd.id,
* GST_ANALYTICS_REL_TYPE_RELATE_TO, gst_analytics_cls_mtd_get_type (),
* NULL, &clsmtd);
*
* GQuark region_class = gst_analytics_cls_mtd_get_quark (&segmtd, idx)
* ...
* ```
*
* Since: 1.26
*/
class SegmentationMtd {
static $gtype: GObject.GType;
// Fields
id: number;
// Constructors
_init(...args: any[]): void;
// Static methods
/**
* Get an instance of #GstAnalyticsMtdType that represent segmentation
* metadata type.
*/
static get_mtd_type(): MtdType;
// Methods
/**
* Get segmentation mask data.
* @returns Segmentation mask data stored in a #GstBuffer
*/
get_mask(): [Gst.Buffer, number, number, number, number];
/**
* Get the regions count.
* @returns Number of regions segmented
*/
get_region_count(): number;
/**
* Get id of the region corresponding to `index,` which should be
* smaller than the return value of
* gst_analytics_segmentation_mtd_get_region_count()
* @param index Region index
* @returns The region ID
*/
get_region_id(index: number): number;
/**
* Get region index of the region identified by `id`.
* @param id Region id
* @returns TRUE if a region with @id exist, otherwise FALSE
*/
get_region_index(id: number): [boolean, number];
}
/**
* Hold tensor data
*/
class Tensor {
static $gtype: GObject.GType;
// Fields
id: GLib.Quark;
layout: TensorLayout;
data_type: TensorDataType;
dims_order: TensorDimOrder;
num_dims: number;
dims: number[];
// Constructors
constructor(num_dims: number);
_init(...args: any[]): void;
static alloc(num_dims: number): Tensor;
static new_simple(
id: GLib.Quark,
data_type: TensorDataType,
data: Gst.Buffer,
dims_order: TensorDimOrder,
dims: number[],
): Tensor;
// Methods
/**
* Create a copy of `tensor`.
* @returns a new #GstTensor
*/
copy(): Tensor | null;
/**
* Free tensor
*/
free(): void;
/**
* Gets the dimensions of the tensor.
* @returns The dims array form the tensor
*/
get_dims(): number[];
}
class TensorMeta {
static $gtype: GObject.GType;
// Fields
num_tensors: number;
// Constructors
_init(...args: any[]): void;
// Methods
/**
* Retrieves a tensor from the #GstTensorMeta, the index must be
* smaller than #GstTensorMeta.num_tensors
* @param index The number of the tensor to get
* @returns a GstTensor
*/
get(index: number): Tensor;
/**
* Finds the first tensor with the requsted ID in the meta
* @param id The tensor id to look for
* @returns The index of the tensor inthe meta, or -1 if its not found.
*/
get_index_from_id(id: GLib.Quark): number;
/**
* Sets tensors into the #GstTensorMeta
* @param tensors An array of poiners to #GstTensor
*/
set(tensors: Tensor[]): void;
}
/**
* Store information on results of object tracking
*/
class TrackingMtd {
static $gtype: GObject.GType;
// Fields
id: number;
// Constructors
_init(...args: any[]): void;
// Static methods
static get_mtd_type(): MtdType;
// Methods
/**
* Retrieve tracking information.
* @returns Successfully retrieved info.
*/
get_info(): [boolean, number, Gst.ClockTime, Gst.ClockTime, boolean];
set_lost(): boolean;
update_last_seen(last_seen: Gst.ClockTime): boolean;
}
type MtdType = never;
/**
* Name of the imported GIR library
* `see` https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L188
*/
const __name__: string;
/**
* Version of the imported GIR library
* `see` https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L189
*/
const __version__: string;
}
export default GstAnalytics;
}
declare module 'gi://GstAnalytics' {
import GstAnalytics10 from 'gi://GstAnalytics?version=1.0';
export default GstAnalytics10;
}
// END