tiperfoverlay

TI Perf Overlay

tiperfoverlay is used to report and overlay and/or dump the performance stats like mpu load, hardware accelerator loads, ddr load.

Hierarchy

GObject
 +----GInitiallyUnowned
       +----GstObject
             +----GstElement
                   +----GstBaseTransform
                         +----GstTIPerfOverlay

Pad templates

sink

Capabilities – ANY

Availability – always

Direction – sink

src

Capabilities – ANY

Availability – always

Direction – sink

Properties

Element Properties:
  dump                : Dump Performance Stats on the terminal
                        flags: readable, writable, changeable only in NULL or READY state
                        Boolean. Default: false
  location            : File location to dump Stats
                        flags: readable, writable, changeable only in NULL or READY state
                        String. Default: null
  main-title          : Main Title to overlay (Set to null or "" to disable)
                        flags: readable, writable, changeable only in NULL or READY state
                        String. Default: "Texas Instruments Edge AI"
  name                : The name of the object
                        flags: readable, writable, 0x2000
                        String. Default: "tiperfoverlay0"
  num-dumps           : Number of samples to dump in file
                        flags: readable, writable
                        Unsigned Integer. Range: 0 - 4294967295 Default: 1 
  overlay             : Overlay Performance Stats on frame
                        flags: readable, writable, changeable only in NULL or READY state
                        Boolean. Default: true
  parent              : The parent of the object
                        flags: readable, writable, 0x2000
                        Object of type "GstObject"
  qos                 : Handle Quality-of-Service events
                        flags: readable, writable
                        Boolean. Default: false
  start-dumps         : Start Frame for dumping stats in file
                        flags: readable, writable
                        Unsigned Integer. Range: 0 - 4294967295 Default: 300 
  title               : Title to overlay
                        flags: readable, writable, changeable only in NULL or READY state
                        String. Default: null
  update-fps-interval : Time in millisecond to update fps after
                        flags: readable, writable, changeable only in NULL or READY state
                        Unsigned Integer. Range: 1 - 2147483647 Default: 2000 
  update-stats-interval: Time in millisecond to update stats after
                        flags: readable, writable, changeable only in NULL or READY state
                        Unsigned Integer. Range: 1 - 2147483647 Default: 1000 

Input format

If the input format of the frame is NV12, tiperfoverlay will by default overlay performance stats on the frame. If the input frame is not NV12, it will not overlay any graphics, but performance will still be captured and can be dumped on terminal and/or csv file by setting appropriate properties.

Pipeline examples

perfoverlay with NV12 input frame (overlay on frame)

gst-launch-1.0 videotestsrc ! video/x-raw,format=NV12,width=1280,height=720 ! \
queue ! tiperfoverlay ! kmssink driver-name=tidss sync=false

perfoverlay with result dump on terminal

gst-launch-1.0 videotestsrc ! video/x-raw,format=RGB ! \
queue ! tiperfoverlay dump=true ! fakesink

perfoverlay with result dump on a csv file

gst-launch-1.0 videotestsrc ! video/x-raw,format=RGB ! \
queue ! tiperfoverlay dump=true location=data.csv num-dumps=10 ! fakesink