Jetson Linux API Reference

https://docs.nvidia.com/jetson/l4t-multimedia/
Admin
Jetson Linux API Reference provides low-level APIs and sample applications for hardware-accelerated...
Tokens:572,818
Snippets:6,425
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### start()

Source: https://docs.nvidia.com/jetson/l4t-multimedia/functions_func_s.html

Starts the application profiler.

```APIDOC
## start()

### Description
Starts the application profiler.

### Method
start

### Class
NvApplicationProfiler

### Parameters
None

### Returns
- **status** (int) - Operation status.

```

--------------------------------

### Example transform using GPU

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_transform_unit_sample.html

Example command that converts a YUV420 input to NV12 using GPU (enable-gpu=1).

```bash
$ ./transform_sample ../../data/Video/sample_outdoor_car_1080p_10fps.yuv
yuv420 1920 1080 sample_outdoor_car_1080p_10fps_nv12.yuv nv12 1
```

--------------------------------

### Example transform using VIC

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_transform_unit_sample.html

Example command that converts a YUV420 input to NV12 using VIC (enable-gpu=0).

```bash
$ ./transform_sample ../../data/Video/sample_outdoor_car_1080p_10fps.yuv
yuv420 1920 1080 sample_outdoor_car_1080p_10fps_nv12.yuv nv12 0
```

--------------------------------

### Example run with sample H.264 file

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_02_video_dec_cuda.html

Example invocation decoding an H.264 file using the video_dec_cuda sample.

```bash
   $ ./video_dec_cuda ../../data/Video/sample_outdoor_car_1080p_10fps.h264 H264
```

--------------------------------

### Example video_convert invocation

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_07_video_convert.html

Example command converting a YUV file from YUV420 to YUYV format with 1920x1080 resolution.

```bash
$ ./video_convert ../../data/Picture/nvidia-logo.yuv 1920 1080 YUV420 test.yuv 1920 1080 YUYV
```

--------------------------------

### Example encode_sample command

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_encoder_unit_sample.html

Example invocation encoding a 1080p YUV file to an H.264 elementary stream.

```bash
$ ./encode_sample ../../data/Video/sample_outdoor_car_1080p_10fps.yuv 1920 1080 sample_outdoor_car_1080p_10fps.h264
```

--------------------------------

### Run JetPack installation script

Source: https://docs.nvidia.com/jetson/l4t-multimedia/mmapi_build.html

Makes the JetPack installer executable and runs it on the host machine. Replace <version> with the actual version.

```bash
$ chmod +x  ./JetPack-L4T-<version>-linux-x64.run
$ ./JetPack-L4T-<version>-linux-x64.run
```

--------------------------------

### Example: transcode two streams to H.265 and VP9

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_16_multivideo_transcode.html

Example command that transcodes two input H.264 files: one to H.265 and one to VP9, producing two output files.

```bash
   $ ./multivideo_transcode num_files 2 ../../data/Video/sample_outdoor_car_1080p_10fps.h264 H264 sample_outdoor_car_1080p_10fps.h265 H265 ../../data/Video/sample_outdoor_car_1080p_10fps.h264 H264 sample_outdoor_car_1080p_10fps_second.vp9 VP9

```

--------------------------------

### Build the backend sample

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_backend.html

Navigate to the backend directory and build the sample.

```bash
$ cd backend
$ make

```

--------------------------------

### Build the multi_camera sample

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_13_multi_camera.html

Navigate to the sample directory and run make to build the multi_camera sample.

```bash
$ cd 13_multi_camera
$ make
```

--------------------------------

### Install TensorRT with apt

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_backend.html

Update package lists and install TensorRT.

```bash
$ sudo apt-get update
$ sudo apt-get install tensorrt

```

--------------------------------

### Show backend help

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_backend.html

Display the command-line options for the backend sample.

```bash
$ cd backend
$ ./backend -h

```

--------------------------------

### Download JetPack installer

Source: https://docs.nvidia.com/jetson/l4t-multimedia/mmapi_build.html

Provides the URL to download the JetPack installer from NVIDIA's website.

```text
https://developer.nvidia.com/embedded/downloads
```

--------------------------------

### Show camera_sample help with -h

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_camera_unit_sample.html

Display the supported options for the camera_sample application.

```bash
   $ ./camera_sample -h

```

--------------------------------

### Update and install TensorRT

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_04_video_dec_trt.html

Run apt-get update and install TensorRT after modifying the repository configuration.

```bash
$ sudo apt-get update
$ sudo apt-get install tensorrt
```

--------------------------------

### Build the sample

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_04_video_dec_trt.html

Change to the sample directory and run make to build the video_dec_trt executable.

```bash
$ cd /usr/src/jetson_multimedia_api/samples/04_video_dec_trt
$ make
```

--------------------------------

### jpeg_encode example command

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_05_jpeg_encode.html

Example invocation of the jpeg_encode sample using a 1920x1080 YUV file.

```bash
   $ ./jpeg_encode ../../data/Picture/nvidia-logo.yuv 1920 1080 test.jpg

```

--------------------------------

### Build multivideo_encode sample

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_15_multivideo_encode.html

Commands to build the sample application from the source directory. Requires prior setup steps 1-3 (and step 4 if building on x86 host).

```bash
 $ cd /usr/src/jetson_multimedia_api/samples/15_multivideo_encode
 $ make

```

--------------------------------

### NvApplicationProfiler::stop

Source: https://docs.nvidia.com/jetson/l4t-multimedia/NvApplicationProfiler_8h_source.html

Stops the profiler that was previously started with `start()`. This concludes the profiling session, after which collected data can be retrieved.

```APIDOC
## NvApplicationProfiler::stop

### Description
Stops the profiler, ending the data collection process. After stopping, profiling data can be printed using `printProfilerData()`. This method is typically called when profiling is no longer needed.

### Method
`void stop()`
```

--------------------------------

### Build the video_decode sample

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_00_video_decode.html

Change to the sample directory and run make to build the application.

```bash
 $ cd /usr/src/jetson_multimedia_api/samples/00_video_decode
 $ make

```

--------------------------------

### Build the camera_recording sample

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_10_camera_recording.html

Change to the sample directory and run make to build the executable. The sample creates the H.264 video file in the current directory.

```bash
$ cd /usr/src/jetson_multimedia_api/samples/10_camera_recording
$ make
```

--------------------------------

### Build the 08_video_dec_drm sample

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_08_video_decode_drm.html

Navigate to the sample directory and run make to build the sample.

```bash
 $ cd /usr/src/jetson_multimedia_api/samples/08_video_dec_drm
 $ make

```

--------------------------------

### Build multivideo_transcode sample

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_16_multivideo_transcode.html

Build the multivideo_transcode sample by entering the sample directory and running make.

```bash
 $ cd /usr/src/jetson_multimedia_api/samples/16_multivideo_transcode
 $ make

```

--------------------------------

### Build camera_sample with make

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_camera_unit_sample.html

Build the camera_sample application from the camera_unit_sample directory. Requires the prerequisites listed in the Building and Running section, including a camera and, if building on a host Linux PC (x86), following step 4 in Building and Running.

```bash
 $ cd /usr/src/jetson_multimedia_api/samples/unittest_samples/camera_unit_sample
 $ make

```

--------------------------------

### start(uint32_t sampling_interval_ms)

Source: https://docs.nvidia.com/jetson/l4t-multimedia/classNvApplicationProfiler.html

Starts the profiler with the specified sampling interval in milliseconds. This method is used to begin collecting profiling data.

```APIDOC
## start(uint32_t sampling_interval_ms)

### Description
Starts the profiler with the specified sampling interval.

### Method
start

### Signature
void start(uint32_t sampling_interval_ms)

### Parameters
- **sampling_interval_ms** (uint32_t) - Required - The sampling interval in milliseconds.

### Returns
void
```

--------------------------------

### Run the camera_recording sample

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_10_camera_recording.html

Run the built executable with optional command-line options.

```bash
$ ./camera_recording [OPTIONS]
```

--------------------------------

### Build multivideo_decode sample

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_14_multivideo_decode.html

Navigate to the sample directory and run make to build the multivideo_decode executable.

```bash
$ cd /usr/src/jetson_multimedia_api/samples/14_multivideo_decode
$ make
```

--------------------------------

### Example video_encode invocation

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_01_video_encode.html

Example command that encodes a YUV file to H.264. Uses sample_outdoor_car_1080p_10fps.yuv as input and produces an H.264 file.

```bash
   $ ./video_encode ../../data/Video/sample_outdoor_car_1080p_10fps.yuv 1920 1080 H264 sample_outdoor_car_1080p_10fps.h264

```

--------------------------------

### View supported options for multivideo_decode

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_14_multivideo_decode.html

Run the sample with --help to display all supported command-line options.

```bash
$ ./multivideo_decode --help
```

--------------------------------

### View supported options

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_08_video_decode_drm.html

Display the help for the sample to see supported options.

```bash
   $ ./video_dec_drm --help

```

--------------------------------

### drmModeGetLease

Source: https://docs.nvidia.com/jetson/l4t-multimedia/drm-nvdc-docs_8h_source.html

Gets a lease.

```APIDOC
## drmModeGetLease

### Description
Gets a lease.

### Function Signature
`drmModeObjectListPtr drmModeGetLease(int fd);`

### Parameters
- **fd** (int) - Required - The file descriptor.

### Return Value
- **drmModeObjectListPtr** - Returns a pointer to the object list or NULL on failure.
```

--------------------------------

### Build the video_encode sample

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_01_video_encode.html

Commands to build the video_encode sample. Navigate to the sample directory and run make.

```bash
 $ cd /usr/src/jetson_multimedia_api/samples/01_video_encode
 $ make

```

--------------------------------

### drmModeGetFB2

Source: https://docs.nvidia.com/jetson/l4t-multimedia/drm-nvdc-docs_8h_source.html

Gets a framebuffer2.

```APIDOC
## drmModeGetFB2

### Description
Gets a framebuffer2.

### Function Signature
`drmModeFB2Ptr drmModeGetFB2(int fd, uint32_t bufferId);`

### Parameters
- **fd** (int) - Required - The file descriptor.
- **bufferId** (uint32_t) - Required - The buffer ID.

### Return Value
- **drmModeFB2Ptr** - Returns a pointer to the framebuffer2 or NULL on failure.
```

--------------------------------

### Run the sample

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_04_video_dec_trt.html

Execute the video_dec_trt binary with the required arguments: channel number, input files, input format, and optional flags.

```bash
$ ./video_dec_trt [Channel-num] <in-file1> <in-file2> ... <in-format> [options]
```

--------------------------------

### View supported options with --help

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_16_multivideo_transcode.html

Display the supported options for the multivideo_transcode sample.

```bash
   $ ./multivideo_transcode --help

```

--------------------------------

### startDQThread

Source: https://docs.nvidia.com/jetson/l4t-multimedia/NvV4l2ElementPlane_8h_source.html

Starts the DQ thread.

```APIDOC
## NvV4l2ElementPlane::startDQThread

### Description
Starts the DQ thread.

### Method
startDQThread

### Signature
int startDQThread(void *data);

### Parameters
- **data** (void*) - User data passed to the thread callback.

### Returns
- **int** - Status code (0 on success, negative on error).

```

--------------------------------

### drmCtlInstHandler

Source: https://docs.nvidia.com/jetson/l4t-multimedia/drm-nvdc-docs_8h_source.html

Installs an interrupt handler.

```APIDOC
## drmCtlInstHandler

### Description
Installs an interrupt handler.

### Function Signature
int drmCtlInstHandler(int fd, int irq);

### Parameters
- **fd** (int) - Required - File descriptor of the DRM device.
- **irq** (int) - Required - Interrupt request number.

### Returns
- **int** - 0 on success, negative error code on failure.

```

--------------------------------

### NvBufferGetParams

Source: https://docs.nvidia.com/jetson/l4t-multimedia/nvbuf__utils_8h.html

Gets buffer parameters.

```APIDOC
## NvBufferGetParams

### Description
Gets buffer parameters.

### Method
NvBufferGetParams

### Signature
int NvBufferGetParams(int dmabuf_fd, NvBufferParams *params)

### Parameters
- **dmabuf_fd** (int) - Required - The DMABUF file descriptor.
- **params** (NvBufferParams*) - Required - Pointer to store the buffer parameters.

### Returns
- **int** - 0 on success, -1 on failure.
```

--------------------------------

### Run camera_sample with options

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_camera_unit_sample.html

Run the camera_sample application with optional command-line options. The captured preview stream can be displayed over HDMI.

```bash
$ ./camera_sample [OPTIONS]

```

--------------------------------

### getFormat

Source: https://docs.nvidia.com/jetson/l4t-multimedia/classNvV4l2ElementPlane.html

Gets the plane format.

```APIDOC
## getFormat

### Description
Gets the plane format.

### Method
int getFormat(struct v4l2_format &format)

### Parameters
- **format** (struct v4l2_format&) - Reference to a v4l2_format structure to receive the format.

### Returns
- **int** - 0 on success, negative error code on failure.

```

--------------------------------

### Build the frontend application

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_front_end.html

Change to the frontend directory and run make to build the application.

```bash
$ cd frontend
$ make
```

--------------------------------

### drmModeGetFB

Source: https://docs.nvidia.com/jetson/l4t-multimedia/drm-nvdc-docs_8h_source.html

Gets framebuffer information.

```APIDOC
## drmModeGetFB

### Description
Function stub.

### Function Signature
`drmModeFBPtr drmModeGetFB(int fd, uint32_t bufferId)`

### Parameters
- **fd** (int) - File descriptor of the DRM device.
- **bufferId** (uint32_t) - ID of the framebuffer.

### Returns
- **drmModeFBPtr** - Pointer to framebuffer structure.
```

--------------------------------

### Build the transform unit sample

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_transform_unit_sample.html

Commands to build the sample. Requires following steps 1-3 in Building and Running, and step 4 if building from a host Linux PC.

```bash
$ cd /usr/src/jetson_multimedia_api/samples/unittest_samples/transform_unit_sample
$ make
```

--------------------------------

### drmModeGetPlane

Source: https://docs.nvidia.com/jetson/l4t-multimedia/drm-nvdc-docs_8h.html

Gets information about a plane.

```APIDOC
## drmModeGetPlane

### Description
Gets information about a plane.

### Function Signature
drmModePlanePtr drmModeGetPlane(int fd, uint32_t plane_id)

### Parameters
- **fd** (int) - Required - File descriptor of the DRM device.
- **plane_id** (uint32_t) - Required - Plane ID.

### Return Value
- **drmModePlanePtr** - Pointer to plane information, or NULL on failure.
```

--------------------------------

### Build the 12_camera_v4l2_cuda sample with make

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_12_camera_v4l2_cuda.html

Builds the sample from the 12_camera_v4l2_cuda directory. Run in the terminal before executing the sample.

```bash
  $ cd 12_camera_v4l2_cuda
  $ make

```

--------------------------------

### Run the frontend application

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_front_end.html

Execute the frontend binary with the specified deploy and model files, and disable preview.

```bash
$ ./frontend --deploy ../../data/Model/GoogleNet_three_class/GoogleNet_modified_threeClass_VGA.prototxt \
     --model ../../data/Model/GoogleNet_three_class/GoogleNet_modified_threeClass_VGA.caffemodel \
     --no-preview
```

--------------------------------

### drmModeGetEncoder

Source: https://docs.nvidia.com/jetson/l4t-multimedia/drm-nvdc-docs_8h.html

Gets information for an encoder.

```APIDOC
## drmModeGetEncoder

### Description
Gets information for an encoder.

### Function Signature
drmModeEncoderPtr drmModeGetEncoder(int fd, uint32_t encoder_id)

### Parameters
- **fd** (int) - Required - File descriptor of the DRM device.
- **encoder_id** (uint32_t) - Required - Encoder ID.

### Return Value
- **drmModeEncoderPtr** - Pointer to encoder information, or NULL on failure.
```

--------------------------------

### drmModeGetCrtc

Source: https://docs.nvidia.com/jetson/l4t-multimedia/drm-nvdc-docs_8h.html

Gets information for a CRTC.

```APIDOC
## drmModeGetCrtc

### Description
Gets information for a CRTC.

### Function Signature
drmModeCrtcPtr drmModeGetCrtc(int fd, uint32_t crtc_id)

### Parameters
- **fd** (int) - Required - File descriptor of the DRM device.
- **crtc_id** (uint32_t) - Required - CRTC ID.

### Return Value
- **drmModeCrtcPtr** - Pointer to CRTC information, or NULL on failure.
```

--------------------------------

### View command-line options

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_front_end.html

Change to the frontend directory and run the binary with -h to display available command-line options.

```bash
$ cd frontend
$ ./frontend -h
```

--------------------------------

### Build the video_cuda_enc sample

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_03_video_cuda_enc.html

Builds the video_cuda_enc sample. Enter these commands from a terminal prompt on the target device or host after completing the prerequisite setup steps.

```shell
 $ cd /usr/src/jetson_multimedia_api/samples/03_video_cuda_enc
 $ make
```

--------------------------------

### drmModeGetConnector

Source: https://docs.nvidia.com/jetson/l4t-multimedia/drm-nvdc-docs_8h.html

Gets information for a connector.

```APIDOC
## drmModeGetConnector

### Description
Gets information for a connector.

### Function Signature
drmModeConnectorPtr drmModeGetConnector(int fd, uint32_t connector_id)

### Parameters
- **fd** (int) - Required - File descriptor of the DRM device.
- **connector_id** (uint32_t) - Required - Connector ID.

### Return Value
- **drmModeConnectorPtr** - Pointer to connector information, or NULL on failure.
```

--------------------------------

### getControl

Source: https://docs.nvidia.com/jetson/l4t-multimedia/classNvVideoDecoder.html

Gets the value of a control.

```APIDOC
## NvVideoDecoder::getControl

### Description
Gets the value of a control.

### Method
getControl

### Parameters
- **id** (uint32_t) - Required - Control ID.
- **value** (int32_t&) - Required - Reference to store the value.

### Returns
int - 0 on success, negative error code on failure.
```

--------------------------------

### getControl

Source: https://docs.nvidia.com/jetson/l4t-multimedia/classNvVideoConverter.html

Gets the value of a control.

```APIDOC
## getControl

### Description
Gets the value of a control.

### Method
getControl

### Parameters
- **id** (uint32_t) - Required - Control identifier.
- **value** (int32_t &) - Required - Reference to receive the control value.

### Returns
int - 0 on success, negative error code on failure.
```

--------------------------------

### Build video_dec_cuda sample

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_02_video_dec_cuda.html

Build the 02_video_dec_cuda sample by entering the sample directory and running make. Requires Jetson Multimedia API samples and Steps 1-3, plus Step 4 for host builds.

```bash
 $ cd /usr/src/jetson_multimedia_api/samples/02_video_dec_cuda
 $ make
```

--------------------------------

### Example: decode_sample with sample H.264 file

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_decoder_unit_sample.html

Example invocation of decode_sample using the provided sample H.264 file and specifying an output YUV file. The output file will contain the decoded raw YUV data.

```bash
$ ./decode_sample ../../data/Video/sample_outdoor_car_1080p_10fps.h264 out_sample_outdoor_car_1080p_10fps.yuv

```

--------------------------------

### Build decode_sample: cd and make

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_decoder_unit_sample.html

Commands to build the decode_sample application from the decoder_unit_sample directory. Requires following steps 1-3 in the Building and Running section, and step 4 if building from a host Linux PC (x86).

```bash
$ cd /usr/src/jetson_multimedia_api/samples/unittest_samples/decoder_unit_sample
$ make

```

--------------------------------

### Example: encode two H.264 streams in parallel

Source: https://docs.nvidia.com/jetson/l4t-multimedia/l4t_mm_15_multivideo_encode.html

Example invocation that encodes two 1080p YUV files to H.264 elementary streams. The same input file is used for both streams, producing two separate output files.

```bash
   $ ./multivideo_encode num_files 2 ../../data/Video/sample_outdoor_car_1080p_10fps.yuv 1920 1080 H264 sample_outdoor_car_1080p_10fps.h264 ../../data/Video/sample_outdoor_car_1080p_10fps.yuv 1920 1080 H264 sample_outdoor_car_1080p_10fps_second.h264

```

--------------------------------

### getBinStart()

Source: https://docs.nvidia.com/jetson/l4t-multimedia/classArgus_1_1Ext_1_1IBayerSharpnessMap.html

Returns the starting location of the first bin, in pixels, relative to the top-left corner of the image.

```APIDOC
## getBinStart()

### Description
Returns the starting location of the first bin, in pixels, where the location is relative to the top-left corner of the image.

### Method
`virtual Point2D<uint32_t> Argus::Ext::IBayerSharpnessMap::getBinStart() const`

### Parameters
None.

### Returns
`Point2D<uint32_t>` - The starting location of the first bin, in pixels.

```

--------------------------------

### startProcessing()

Source: https://docs.nvidia.com/jetson/l4t-multimedia/functions_func_s.html

Starts processing for the element profiler.

```APIDOC
## startProcessing()

### Description
Starts processing for the element profiler.

### Method
startProcessing

### Class
NvElementProfiler

### Parameters
None

### Returns
- **status** (int) - Operation status.

```
Tokens:
Raw