Gst-nvdsosd
=============

This plugin draws bounding boxes, text, and region of interest (RoI) polygons. (Polygons are presented as a set of lines.)
The plugin accepts an RGBA buffer with attached metadata from the upstream component. It draws bounding boxes, which may be shaded depending on the configuration (e.g. width, color, and opacity) of a given bounding box. It also draws text and RoI polygons at specified locations in the frame. Text and polygon parameters are configurable through metadata.

.. image:: /content/DS_plugin_gst-nvdsosd.png
         :align: center
         :alt: Gst-nvdsosd


Inputs and Outputs
-----------------------

* Inputs
   
   * RGBA buffer
   * NvDsBatchMeta (holds NvDsFrameMeta consisting of bounding boxes, text parameters, and lines parameters)
   * NvDsLineMeta (RoI polygon)


* Control parameters

  *	gpu-id (dGPU only)
  *	display-clock
  *	display-text
  *	clock-font
  *	clock-font-size
  *	x-clock-offset
  *	y-clock-offset
  *	clock-color
  *	process-mode
  *	hw-blend-color-attr
  *	display-bbox
  *	display-mask


* Output

  *	RGBA buffer modified in place to overlay bounding boxes, texts, and polygons represented in the metadata

Features
-----------
The following table summarizes the features of the plugin.

  .. csv-table:: Gst-nvsosd features
   :file: ../text/tables/Gst-nvdsosd tables/DS_Plugin_gst-nvdsosd_features.csv
   :widths: 30, 30, 30
   :header-rows: 1

Gst Properties
----------------
The following table describes the Gst properties of the Gst-nvdsosd plugin.

  .. csv-table:: Gst-nvsosd gst properties
   :file: ../text/tables/Gst-nvdsosd tables/DS_Plugin_gst-nvdsosd_gst-properties.csv
   :widths: 20, 20, 20, 20
   :header-rows: 1

.. note:: If ``process-mode=2`` i.e., HW mode is being used on Jetson, and solid filled rectangles need to be drawn with alpha=1.0, ensure that ``border_width`` is set as 0 and set ``bbox_bg_color`` value of the rectangles to the color required.