pciesink
========

The ``pciesink`` GStreamer plugin sends data to a SiMa PCIe endpoint device. It receives buffers from the pipeline and transmits their contents via the PCIe interface. The plugin utilizes SiMa.ai’s PCIe library for communication.

Properties
----------

================= ======= ================================= ================================================================
Property Name     Type    Default Value                     Description
================= ======= ================================= ================================================================
config            string  ``/mnt/cfg/pcie_xxxxx_sink.json`` Path to the JSON configuration file.
num-buffers       uint    5                                 Number of buffers allocated.
data-buffer-size  uint    4194304                           Size of each data buffer (in bytes).
data-buf-name     string  ``ev-ggcnn-postproc``             Name of the data buffer node.
param-buffer-size uint    48                                Size of each parameter buffer (in bytes).
param-buf-name    string  ``camera_params``                 Name of the parameter buffer node.
use-multi-buffers uint    0                                 If 1, indicates the presence of parameter buffers; otherwise, 0.
queue             uint    0                                 Data queue number to listen on.
transmit          boolean FALSE                             If TRUE, transmits KPI messages.
================= ======= ================================= ================================================================

Usage
-----

The ``pciesink`` plugin is integrated into a GStreamer pipeline as a sink element. It accepts buffers and transmits them to the PCIe endpoint. The following example demonstrates its basic usage:

.. code:: bash

   gst-launch-1.0 filesrc location=/path/to/your/video.mp4 ! ... ! simaaipciesink config=/path/to/config.json num-buffers=10 data-buffer-size=8388608 transmit=true

Replace ``/path/to/your/video.mp4`` with the actual path to your video file and ``/path/to/config.json`` with the path to your JSON configuration file. Adjust ``num-buffers`` and ``data-buffer-size`` as needed.

The ``...`` represents any necessary processing elements in your pipeline before sending data to the ``pciesink``. The plugin expects buffers with SiMa.ai metadata. Ensure your pipeline produces buffers appropriately formatted for the SiMa.ai ecosystem.

Installation
------------

To install the ``pciesink`` plugin, copy the plugin file (``gstsimaaipciesink.so`` and necessary dependencies) from ``/usr/local/simaai/plugin_zoo/gst-simaai-plugins-base/gst/`` into your project’s ``plugins/`` directory. The plugin should then be automatically detected by GStreamer. The plugin will load configuration parameters from the JSON file specified by the “config” property. If the config file is not specified it will use default values. The plugin requires a correctly configured SiMa.ai environment.