.. _plugin_simaaisrc:

|plugin|
========

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

This plugin is similar to filesrc or multifilesrc plugins but supports SiMa memory allocation. So 
it can be used to debug/develop SiMa pipelines. This plugin is extremely useful if you're debugging 
or developing new pipeline. simaaisrc plugin allows you to mock the input for your plugin and 
therefore test the another plugin in isolation.

.. note:: 

    * The ``mem-target`` parameter values are as follows:
        
        * ``0`` -> Allocating into A65 CPU memory
        * ``1`` -> Allocating into EV74 CVU memory
        * ``2`` or ``4`` -> Allocating into MLA memory


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

.. code-block:: bash
    :linenos:

    ! gst-launch-1.0 simaaisrc location=/data/test-001.out mem-target=0 .. !


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

.. code-block:: bash
    :linenos:

    Factory Details:
    Rank                     none (0)
    Long-name                SimaCustomSrc
    Klass                    Custom Source
    Description              Read image and push
    Author                   SiMa.Ai

    Plugin Details:
    Name                     simaaisrc
    Description              SiMa Custom Src
    Filename                 ./gst-plugins/libgstsimaaisrc.so
    Version                  0.1
    License                  unknown
    Source module            gst-plugins-sima
    Binary package           GStreamer
    Origin URL               SiMa.ai

    GObject
    +----GInitiallyUnowned
        +----GstObject
                +----GstElement
                    +----GstBaseSrc
                            +----GstSimaaiSrc

    Pad Templates:
    SRC template: 'src'
        Availability: Always
        Capabilities:
        ANY

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

    Pads:
    SRC: 'src'
        Pad Template: 'src'

    Element Properties:
    blocksize           : Size in bytes to read per buffer (-1 = default)
                            flags: readable, writable
                            Unsigned Integer. Range: 0 - 4294967295 Default: 4096 
    delay               : Sleep TimerSleep Time
                            flags: readable, writable
                            Integer64. Range: 0 - 9223372036854775807 Default: 0 
    do-timestamp        : Apply current stream time to buffers
                            flags: readable, writable
                            Boolean. Default: false
    index               : Index to use with location property to create file names.  The index is incremented by one for each buffer read.
                            flags: readable, writable
                            Integer. Range: 0 - 2147483647 Default: 0 
    location            : location
                            flags: readable, writable, changeable only in NULL or READY state
                            String. Default: null
    mem-target          : Memory target for simamemlib
                            flags: readable, writable
                            Integer. Range: 0 - 2 Default: 1868721529 
    name                : The name of the object
                            flags: readable, writable, 0x2000
                            String. Default: "simaaisrc0"
    node-name           : Node Name
                            flags: readable, writable, changeable only in NULL or READY state
                            String. Default: null
    num-buffers         : Number of buffers to output before sending EOS (-1 = unlimited)
                            flags: readable, writable
                            Integer. Range: -1 - 2147483647 Default: -1 
    parent              : The parent of the object
                            flags: readable, writable, 0x2000
                            Object of type "GstObject"
    pool-size           : Amount of buffers to allocate in output buffer pool
                            flags: readable, writable
                            Unsigned Integer. Range: 2 - 5 Default: 5 
    stream-id           : Stream Id
                            flags: readable, writable, changeable only in NULL or READY state
                            String. Default: "unknown-stream-id"
    typefind            : Run typefind before negotiating (deprecated, non-functional)
                            flags: readable, writable, deprecated
                            Boolean. Default: false



.. |plugin| replace:: simaaisrc
.. |plugin_highlighted| replace:: ``simaaisrc``