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

Go to the documentation of this file.

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

@page dwx_cameraserver_client_raw_sample Camera Server Client with Raw Data Capture Sample

@tableofcontents

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

@section dwx_cameraserver_client_raw_sample_description Description

The Camera Server Client with Raw Data Capture 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, and writes it to a disk.

@section dwx_cameraserver_client_raw_sample_running Running the Sample

Ensure @ref sensor_distribution_tool is running before launching this sample.

The Camera Server Client with Raw Data Capture sample, sample_cameraserver_client_raw, accepts the following parameters:

    ./sample_cameraserver_client_raw --host=[ip_address]
                              --port=[tcp_port_num]
                              --link=[sibling-num]
                              --mode=[fifo|mailbox]
                              --fifo-size=[3..16]
                              --interpolationDemosaic=[0|positive_integer]
                              --serializer-type=[raw|lraw]
                              --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.
        If "fifo" is selected, the server queues the frames up to fifo-size frames. If the client is still slow, drop frame happens.
        If "mailbox" is selected, each readFrame call fetches the latest frame from the server, and the server will not queue frames.
        Default value: fifo

    --fifo-size[3..16]
        Specifies the fifo size of the sensor. It has no effect when the client is connected in `mailbox` mode.
        If it exceeds a certain threshold defined by the camera server, the size is cut off to a safer 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