一、插件概述

   DeepStream SDK基于GStreamer框架。本手册介绍了DeepStream GStreamer插件以及DeepStream的输入，输出和控制参数。在包含NVIDIA®Jetson™模块或NVIDIA dGPU适配器1的系统上支持DeepStream SDK 。本手册适用于希望使用DeepStream SDK开发DeepStream应用程序或其他插件的工程师。它还包含有关SDK中使用的元数据的信息。开发人员也可以添加自定义元数据。该手册介绍了SDK中定义的用于使用IPlugin实现自定义推理层的方法NVIDIA®TensorRT™的界面。您可以在使用本手册时参考SDK随附的示例示例，以熟悉DeepStream应用程序和插件开发。

二、DeepStream SDK中的元数据

Gst Buffer是GStreamer中数据传输的基本单位。每个Gst缓冲区都有关联的元数据。DeepStream SDK附加了DeepStream元数据对象NvDsBatchMeta，如以下各节所述。

NvDsBatchMeta：基本元数据结构

DeepStream对元数据使用可扩展的标准结构。基本元数据结构NvDsBatchMeta以在Gst-nvstreammux插件内部创建的批处理级元数据开始。辅助元数据结构包含框架，对象，分类器和标签数据。DeepStream还提供了一种在批处理，框架或对象级别添加用户特定的元数据的机制。DeepStream通过附加NvDsBatchMeta结构并将Gst-nvstreammux插件中的GstNvDsMetaType.meta_type设置为NVDS_BATCH_GST_META，将元数据附加到Gst缓冲区。当您的应用处理Gst缓冲区时，它可以遍历附加的元数据以找到NVDS_BATCH_GST_META。函数gst_buffer_get_nvds_batch_meta（）从Gst缓冲区提取NvDsBatchMeta。（请参阅sources / include / gstnvdsmeta.h中的声明。）有关此功能用法的示例，请参见deepstream-test1示例应用程序

三、NvDsBatchMeta内部的用户/自定义元数据添加

要在NvDsBatchMeta内的批次，帧或对象级别上附加特定于用户的元数据，必须通过调用nvds_acquire_user_meta_from_pool（）从用户元池中获取NvDsUserMeta的实例。（有关详细信息，请参见sources / includes / nvdsmeta.h。）然后，您必须初始化NvDsUserMeta。您必须设置的成员是user_meta_data，meta_type，copy_func和release_func。有关更多详细信息，请参阅sources / apps / sample_apps / deepstream-user-metadata-test / deepstream_user_metadata_app.c中的示例应用程序源代码。

在Gst-nvstreammux上游的Gst插件中添加自定义元

DeepStream SDK在Gst-nvstreammux插件中创建批处理级别的元数据。它在批处理，批处理中的帧以及帧中的对象的层次结构中保存NvDsBatchMeta元数据。

在Gst-nvstreammux之前向插件添加元数据

此过程在Gst-nvstreammux之前的插件处将元数据引入DeepStream管道。

1. 设置插件的NvDsMeta结构的以下成员：

• 复制¬_func

• free_func

• meta_type

• gst_to_nvds_meta_transform_func

• gst_to_nvds_meta_release_func

1. 通过调用附加元数据，gst_buffer_add_nvds_meta()并在返回的NvDsMeta实例中设置meta_type gst_buffer_add_nvds_meta()。

2. Gst-nvstreammux插件将在步骤2中创建的输入gst-meta从Gst缓冲区转换为与相应NvDsFrameMeta对象关联的NvDsUserMeta对象。它将此对象添加到frame_user_data列表中。

3. 在NvDsFrameMeta对象中的frame_user_meta列表中搜索在步骤2中设置的meta_type，然后访问附加的元数据。

有关sources/apps/sample_apps/deepstream-gst-metadata-test/deepstream_gst_metadata.c更多详细信息，请参见中的示例应用程序源代码。如果gst meta不附带gst_buffer_add_nvds_meta()，则不会将其转换为DeepStream元数据。Gst缓冲区中仍然可用。

 

新的元数据字段

注意本节中的信息仅适用于DeepStream 5.0及更高版本。

在DeepStream 5.0 GA发行之前，边界框（或bbox）坐标首先由检测器组件生成，并且如果管道中有跟踪器组件，则跟踪器组件会使用更新/修订的bbox坐标覆盖它们。但是，“置信度”字段的值将检测器置信度值保留在元数据中，即使存在跟踪器组件，也将丢弃跟踪器置信度值。这是因为IOU和KLT跟踪器未提供任何置信度值。DeepStream 4.0中引入的NvDCF跟踪器可以提供可靠的跟踪器置信度值。这导致DeepStream 5.0 GA版本中将bbox坐标和置信度值存储在元数据（即NvDsObjectMeta）中的重大变化。DeepStream 5.0 GA版本中的NvDsObjectMeta结构具有三个bbox信息和两个置信度值：

1. detector_bbox_info-当检测器检测到对象时，保留对象的边界框参数。

2. tracker_bbox_info-由跟踪器处理时，保存对象的边界框参数。

3. rect_params-保留由在管道中更新对象的最后一个组件处理的对象的边界框坐标。这些边界框坐标被裁剪，以使它们不会落在框架边界之外。

这些边界框参数用于覆盖：

1. 置信度-持有对象的置信度值，由推理组件设置。

2. tracker_confidence-保留由NvDCF设置的对象的置信度值。对于IOU和KLT跟踪器，将为-0.1。

如上所述，来自检测器和跟踪器的bbox坐标分别存储在新引入的detector_bbox_info和中tracker_bbox_info。bbox info rect_params像以前的DeepStream版本中一样继续保存bbox info，以实现向后兼容。请注意，在将来的版本中将不建议使用rect_params。预先存在的置信度参数将保留检测器的置信度值，而新引入的tracker_confidence参数将保留跟踪器的置信度值。