/dvs/git/dirty/gitlab-master_av/dw/sdk/samples/sensors/camera/camera_slave_raw/README.md

Go to the documentation of this file.

# Copyright (c) 2019-2020 NVIDIA CORPORATION.  All rights reserved.

@page dwx_camera_slave_raw_sample Camera Slave with Raw Data Sample
@tableofcontents

@note SW Release Applicability: This sample is available in both **NVIDIA DriveWorks** and **NVIDIA DRIVE Software** releases.

@section dwx_camera_slave_raw_sample_description Description

The Camera Slave with Raw Data sample uses the GMSL camera interface available on
NVIDIA DRIVE<sup>&trade;</sup> platforms. The sample creates a file for the RAW
data from the first camera on the selected camera group. The file is written to the disk.

@section dwx_camera_slave_raw_sample_running Running the Sample

The Camera Slave with Raw Data sample, sample_camera_slave_raw, accepts the following parameters:

    ./sample_camera_slave_raw --host=[ip_address]
                              --port=[tcp_port_num]
                              --link=[sibling-num]
                              --mode=[fifo|mailbox]
                              --fifo-size=[3..16]
                              --interpolationDemosaic=[0|positive_integer]
                              --serializer-type=[h264|h265]
                              --write-file=[path/to/output/file]

Where:

    --host=[ip_address]
        Specifies the host IP address of the camera server
        Default value: 127.0.0.1

    --port=[tcp_port_num]
        Specifies the port # to connect to the server, each port number mapsto one camera group.
        Default value: 49252

    --link=[sibling-num]
        Specifies the sibling index of the camera group to connect to
        Default value: 0

    --mode=[fifo|mailbox]
        Specifies the streaming mode. Available options: fifo/mailbox
        In fifo mode, the server will queue the frames up to fifo-size frames, and if the slave is still slow, drop frame happens.
        In mailbox mode, each readFrame call will get the latest frame from server, and server will not queue frames.
        Default value: fifo

    --fifo-size[3..16]
        Specifies the fifo size of the sensor
        If it exceeds certain threshold which is defined by camera server, the size will be cut off to safe value.
        Default value: 4

    --serializer-type=[raw|lraw]
        Represents the format of the video with two possible options:
        raw or lraw.
        Default value: raw

    --write-file=[path/to/output/file]
        Specifies the output file.
        If --write-file is not provided, no file is written out on disk.
        Default value: none

@note: @ref sensor_distribution_tool must be running before launching this sample.