.. _plugin_simaaidecoder:


|plugin|
========

This section talks about the GStreamer plugin named |plugin|.

Description
-----------

|plugin_highlighted| is used for decoding the incoming stream using ``Allegro Decoder``.
Supports the H.264 compression standards HEVC (High Efficiency Video Coding) with support for baseline/main/high profiles, 4:2:0 pixels and 8-bit precision. The 
encoder supports rates up to 4KP30, while the decoder supports up to 4KP60.

 * The standalone configuration of plugin through its individual parameters.

 * The configuration manager method, which only needs the ``config``and ``node-name`` properties.


The SiMa.ai decoder plugin supports the following:

.. image:: media/mlsoc_diagram_allegro.png
    :scale: 40%
    :align: center

|

Config JSON Parameters
----------------------

Config JSON is not needed for this plugin.


Example Usage
-------------

.. code-block::
    :linenos:

    simaaidecoder name=simaaidecoder1 op-buff-name=simaaidecoder1 dec-width=1280 dec-height=720 dec-fmt=YUV420P dec-fps=30 next-element=CVU op-buff-cached=true


``gst-inspect-1.0`` Output
---------------------------

.. code-block::
    :linenos:

    Factory Details:
    Rank                     primary (256)
    Long-name                SiMa.AI Decoder Plugin
    Klass                    Decoder
    Description              Video Decoder
    Author                   Pawan Kumar <pawankumar.ts@sima.ai>

    Plugin Details:
    Name                     simaaidecoder
    Description              GStreamer SiMa.ai Decoder Plugin
    Filename                 /usr/lib/gstreamer-1.0/libgstsimaaidecoder.so
    Version                  1.18.16
    License                  LGPL
    Source module            simaai-soc-pipeline-decoder
    Binary package           GStreamer SiMa.ai Decoder Plug-in
    Origin URL               https://bitbucket.org/sima-ai/simaai-soc-pipeline

    GObject
    +----GInitiallyUnowned
        +----GstObject
                +----GstElement
                    +----GstSimaAiDecoder

    Pad Templates:
    SINK template: 'sink'
        Availability: Always
        Capabilities:
        video/x-h264
                    parsed: true
            stream-format: byte-stream
                alignment: au
        video/x-h264
                    parsed: false
        video/x-h265
                    parsed: true
            stream-format: byte-stream
                alignment: au
        video/x-h265
                    parsed: false
    
    SRC template: 'src'
        Availability: Always
        Capabilities:
        video/x-raw
                    format: { (string)I420, (string)NV12 }

    Element has no clocking capabilities.
    Element has no URI handling capabilities.

    Pads:
    SRC: 'src'
        Pad Template: 'src'
    SINK: 'sink'
        Pad Template: 'sink'

    Element Properties:
    apu-mem-pool        : Choose one of o/p pool in APU "malloc" or "CMA(reserved)"
                            flags: readable, writable
                            String. Default: "malloc"
    config              : Config JSON for CM (if given no other config params needed)
                            flags: readable, writable
                            String. Default: ""
    dec-fmt             : o/p fmt either "NV12","YUV420P"
                            flags: readable, writable
                            String. Default: "NV12"
    dec-fps             : Works only for dec-type:split-input mode
                            flags: readable, writable
                            Integer. Range: 0 - 2147483647 Default: -1 
    dec-height          : Video file resolution height
                            flags: readable, writable
                            Integer. Range: 0 - 1080 Default: -1 
    dec-ip-cnt          : Decoder i/p count(Default:unalign-input 2,split-input 5)
                            flags: readable, writable
                            Integer. Range: 2 - 6 Default: 2 
    dec-mode            : Either "split-input" or "unalign-input"
                            flags: readable, writable
                            String. Default: "split-input"
    dec-type            : Either h264 or h265
                            flags: readable, writable
                            String. Default: "h264"
    dec-width           : Video file resolution width
                            flags: readable, writable
                            Integer. Range: 0 - 1920 Default: -1 
    dump-cnt            : No. of decode frames to be dumped
                            flags: readable, writable
                            Integer. Range: 0 - 2147483647 Default: -1 
    dump-path           : Path for decode frames to be dumped
                            flags: readable, writable
                            String. Default: "/tmp"
    ip-queue-max-buffers: High water mark for input queue ,if > then it blocks
                            flags: readable, writable
                            Integer. Range: 0 - 2147483647 Default: 60 
    ip-queue-min-buffers: Low water mark for input queue
                            flags: readable, writable
                            Integer. Range: 0 - 2147483647 Default: 30 
    name                : The name of the object
                            flags: readable, writable, 0x2000
                            String. Default: "simaaidecoder0"
    next-element        : Choose one of o/p pool "CVU","FPGA","ISP" "APU"(as of now only CVU & APU supported)
                            flags: readable, writable
                            String. Default: "CVU"
    node-name           : As in json for matching it for CM
                            flags: readable, writable
                            String. Default: ""
    op-buff-cached      : Specify if op-buff from decoder is cached (applicable for CVU & CMA heap)
                            flags: readable, writable
                            Boolean. Default: false
    op-buff-name        : "buffer-name" as custom meta for o/p buffer (Default: CM node-name,if no CM element-name)
                            flags: readable, writable
                            String. Default: "simaaidecoder0"
    op-pool-cnt         : o/p buffer count from pool as in next-element prop
                            flags: readable, writable
                            Integer. Range: 5 - 10 Default: 7 
    parent              : The parent of the object
                            flags: readable, writable, 0x2000
                            Object of type "GstObject"


.. note::

    Please refer to |plugin|'s README file for more information.

.. |plugin| replace:: simaaidecoder
.. |plugin_highlighted| replace:: ``simaaidecoder``