Jetson Linux API Reference

32.7.3 Release
NvVideoEncoder.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-2021, NVIDIA CORPORATION. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * * Redistributions of source code must retain the above copyright
8  * notice, this list of conditions and the following disclaimer.
9  * * Redistributions in binary form must reproduce the above copyright
10  * notice, this list of conditions and the following disclaimer in the
11  * documentation and/or other materials provided with the distribution.
12  * * Neither the name of NVIDIA CORPORATION nor the names of its
13  * contributors may be used to endorse or promote products derived
14  * from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
20  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
21  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
23  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
24  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 
45 #ifndef __NV_VIDEO_ENCODER_H__
46 #define __NV_VIDEO_ENCODER_H__
47 
48 #include "NvV4l2Element.h"
49 
60 {
61 public:
76  static NvVideoEncoder *createVideoEncoder(const char *name, int flags = 0);
77 
79 
92  int setOutputPlaneFormat(uint32_t pixfmt, uint32_t width, uint32_t height);
105  int setCapturePlaneFormat(uint32_t pixfmt, uint32_t width,
106  uint32_t height, uint32_t sizeimage);
107 
119  int setFrameRate(uint32_t framerate_num, uint32_t framerate_den);
120 
132  int setBitrate(uint32_t bitrate);
133 
145  int setPeakBitrate(uint32_t peak_bitrate);
146 
159  int setProfile(uint32_t profile);
160 
168  int setEncoderCommand(int cmd, int flags);
169 
182  int setLevel(uint32_t level);
183 
196  int setMaxPerfMode(int flag);
209  int setConstantQp(int qp_value);
210 
224 
236  int setIFrameInterval(uint32_t interval);
237 
249  int setIDRInterval(uint32_t interval);
250 
260  int forceIDR();
261 
275 
289  int setSliceLength(v4l2_enc_slice_length_type type, uint32_t length);
290 
303 
318  int setROIParams(uint32_t buffer_index, v4l2_enc_frame_ROI_params & params);
319 
332 
345 
358 
371 
386  int SetInputMetaParams(uint32_t buffer_index, v4l2_ctrl_videoenc_input_metadata &params);
387 
398  int setVirtualBufferSize(uint32_t size);
399 
410  int setNumReferenceFrames(uint32_t num_frames);
411 
422  int setSliceIntrarefresh(uint32_t interval);
423 
434  int setNumBFrames(uint32_t num);
435 
447  int setInsertSpsPpsAtIdrEnabled(bool enabled);
448 
460  int setCABAC(bool enabled);
461 
473  int setSliceLevelEncode(bool enabled);
474 
485 
501  int getMetadata(uint32_t buffer_index,
503 
519  int getMotionVectors(uint32_t buffer_index,
521 
537  int setQpRange(uint32_t MinQpI, uint32_t MaxQpI, uint32_t MinQpP,
538  uint32_t MaxQpP, uint32_t MinQpB, uint32_t MaxQpB);
539 
551  int setSampleAspectRatioWidth(uint32_t sar_width);
552 
564  int setSampleAspectRatioHeight(uint32_t sar_height);
565 
577  int setInsertVuiEnabled(bool enabled);
578 
590  int setExtendedColorFormat(bool enabled);
591 
603  int setInsertAudEnabled(bool enabled);
604 
616  int setAlliFramesEncode(bool enabled);
617 
629  int setPocType(uint32_t pocType);
630 
642  int setChromaFactorIDC(uint8_t crfactor);
643 
655  int setLossless(bool enabled);
656 
668  int setDisableAMP(bool enabled);
669 
676  int DevicePoll(v4l2_ctrl_video_device_poll *devicepoll);
677 
682  int SetPollInterrupt();
683 
688  int ClearPollInterrupt();
689 
690 private:
694  NvVideoEncoder(const char *name, int flags);
695 
696  static const NvElementProfiler::ProfilerField valid_fields =
700 };
703 #endif
NvVideoEncoder::setChromaFactorIDC
int setChromaFactorIDC(uint8_t crfactor)
Sets the H.265 encoder Chroma Format IDC.
v4l2_enc_enable_roi_param_
Holds the params to configure encoder for ROI parameters encoding.
Definition: v4l2_nv_extensions.h:2084
NvV4l2Element
Defines a helper class for V4L2 based components.
Definition: NvV4l2Element.h:65
NvVideoEncoder::setInsertSpsPpsAtIdrEnabled
int setInsertSpsPpsAtIdrEnabled(bool enabled)
Enables/disables insert SPS PPS at every IDR.
v4l2_enc_frame_ROI_params_
Holds the encoder frame ROI parameters to be used with V4L2_CID_MPEG_VIDEOENC_ROI_PARAMS IOCTL.
Definition: v4l2_nv_extensions.h:1861
v4l2_enc_slice_length_type
v4l2_enc_slice_length_type
Enum specifying the type of slice length.
Definition: v4l2_nv_extensions.h:1741
NvVideoEncoder::setROIParams
int setROIParams(uint32_t buffer_index, v4l2_enc_frame_ROI_params &params)
Sets the Region of Interest (ROI) parameters for the next buffer, which will be queued on the output ...
NvVideoEncoder::setInsertAudEnabled
int setInsertAudEnabled(bool enabled)
Enables/disables insert AUD.
NvVideoEncoder::setIFrameInterval
int setIFrameInterval(uint32_t interval)
Sets the encoder I-frame interval.
NvVideoEncoder::setSliceLevelEncode
int setSliceLevelEncode(bool enabled)
Enables/disables Slice level encoding for H264 / HEVC.
NvVideoEncoder::setIDRInterval
int setIDRInterval(uint32_t interval)
Sets the encoder IDR interval.
NvVideoEncoder::enableExternalRC
int enableExternalRC(v4l2_enc_enable_ext_rate_ctr &params)
Enable External Picture RC.
v4l2_ctrl_videoenc_outputbuf_metadata_
Holds the encoder output metadata for a frame, to be used with V4L2_CID_MPEG_VIDEOENC_METADATA IOCTL.
Definition: v4l2_nv_extensions.h:1925
NvVideoEncoder::ClearPollInterrupt
int ClearPollInterrupt()
Clears the polling interrupt, now if the application calls Poll, the device should block until the ev...
NvVideoEncoder::setHWPresetType
int setHWPresetType(v4l2_enc_hw_preset_type type)
Sets the encoder HW Preset Type.
NvElementProfiler::ProfilerField
int ProfilerField
Definition: NvElementProfiler.h:79
NvVideoEncoder::setSliceIntrarefresh
int setSliceIntrarefresh(uint32_t interval)
Sets slice intra-refresh interval params.
v4l2_enc_temporal_tradeoff_level_type
v4l2_enc_temporal_tradeoff_level_type
Specifies the types of encoder temporal tradeoff levels.
Definition: v4l2_nv_extensions.h:1697
_v4l2_ctrl_video_device_poll
Poll device.
Definition: v4l2_nv_extensions.h:2452
NvVideoEncoder::setPeakBitrate
int setPeakBitrate(uint32_t peak_bitrate)
Sets the encoder peak bitrate.
v4l2_enc_enable_ext_rps_ctrl_
Holds the params to configure encoder for external rps control to be used with V4L2_CID_MPEG_VIDEOENC...
Definition: v4l2_nv_extensions.h:2002
NvVideoEncoder::SetInputMetaParams
int SetInputMetaParams(uint32_t buffer_index, v4l2_ctrl_videoenc_input_metadata &params)
Set input Metadata parameters for the next buffer which will be queued on output plane with index buf...
NvVideoEncoder::setVirtualBufferSize
int setVirtualBufferSize(uint32_t size)
Sets the virtual buffer size of the encoder.
NvVideoEncoder::enableMotionVectorReporting
int enableMotionVectorReporting()
Enables video encoder output motion vector metadata reporting.
NvVideoEncoder::setEncoderCommand
int setEncoderCommand(int cmd, int flags)
Sets the encoder command.
NvVideoEncoder::enableROI
int enableROI(v4l2_enc_enable_roi_param &params)
Enables External ROI.
NvVideoEncoder::enableExternalRPS
int enableExternalRPS(v4l2_enc_enable_ext_rps_ctr &params)
Enable External RPS.
v4l2_ctrl_videoenc_outputbuf_metadata_MV_
Holds the motion vector parameters for one complete frame.
Definition: v4l2_nv_extensions.h:1890
NvVideoEncoder::setProfile
int setProfile(uint32_t profile)
Sets the encoder profile.
NvVideoEncoder::setSampleAspectRatioWidth
int setSampleAspectRatioWidth(uint32_t sar_width)
Sets Sample Aspect Ratio width for VUI encoding.
NvVideoEncoder::setNumBFrames
int setNumBFrames(uint32_t num)
Sets the number of B frames to P frames.
v4l2_mpeg_video_bitrate_mode
v4l2_mpeg_video_bitrate_mode
Definition: v4l2-controls.h:353
NvVideoEncoder::setLevel
int setLevel(uint32_t level)
Set the encoder level.
NvVideoEncoder::enableReconCRC
int enableReconCRC(v4l2_enc_enable_reconcrc_param &params)
Enables Recon CRC.
NvElementProfiler::PROFILER_FIELD_LATENCIES
static const ProfilerField PROFILER_FIELD_LATENCIES
Definition: NvElementProfiler.h:83
NvVideoEncoder::setQpRange
int setQpRange(uint32_t MinQpI, uint32_t MaxQpI, uint32_t MinQpP, uint32_t MaxQpP, uint32_t MinQpB, uint32_t MaxQpB)
Sets QP values for I/P/B frames.
NvVideoEncoder::DevicePoll
int DevicePoll(v4l2_ctrl_video_device_poll *devicepoll)
Issues Poll on the device which blocks until : a) Either there is something to dequeue from capture o...
NvVideoEncoder::setMaxPerfMode
int setMaxPerfMode(int flag)
Sets the encoder for maximum performance.
NvVideoEncoder::setCapturePlaneFormat
int setCapturePlaneFormat(uint32_t pixfmt, uint32_t width, uint32_t height, uint32_t sizeimage)
Sets the format on the converter capture plane.
NvVideoEncoder::setSampleAspectRatioHeight
int setSampleAspectRatioHeight(uint32_t sar_height)
Sets Sample Aspect Ratio height for VUI encoding.
NvVideoEncoder::getMotionVectors
int getMotionVectors(uint32_t buffer_index, v4l2_ctrl_videoenc_outputbuf_metadata_MV &enc_mv_metadata)
Gets motion vector metadata for the encoded capture plane buffer.
NvVideoEncoder::setFrameRate
int setFrameRate(uint32_t framerate_num, uint32_t framerate_den)
Sets the encode framerate.
NvVideoEncoder::setDisableAMP
int setDisableAMP(bool enabled)
Sets the Disable AMP types to true for H.265.
NvVideoEncoder::setOutputPlaneFormat
int setOutputPlaneFormat(uint32_t pixfmt, uint32_t width, uint32_t height)
Sets the format on the encoder output plane.
NvVideoEncoder::setAlliFramesEncode
int setAlliFramesEncode(bool enabled)
Enables/disables all i-frame encode.
NvVideoEncoder::setTemporalTradeoff
int setTemporalTradeoff(v4l2_enc_temporal_tradeoff_level_type level)
Sets the encoder Temporal Tradeoff.
NvVideoEncoder::createVideoEncoder
static NvVideoEncoder * createVideoEncoder(const char *name, int flags=0)
Creates a new V4L2 Video Encoder object named name.
NvVideoEncoder::setExtendedColorFormat
int setExtendedColorFormat(bool enabled)
Enables/disables extended color format.
NvElementProfiler::PROFILER_FIELD_FPS
static const ProfilerField PROFILER_FIELD_FPS
Definition: NvElementProfiler.h:84
NvVideoEncoder::setRateControlMode
int setRateControlMode(enum v4l2_mpeg_video_bitrate_mode mode)
Sets the encoder rate control mode.
NvVideoEncoder::setSliceLength
int setSliceLength(v4l2_enc_slice_length_type type, uint32_t length)
Sets the encoder output slice length.
v4l2_enc_hw_preset_type
v4l2_enc_hw_preset_type
Specifies the encoder HW Preset type.
Definition: v4l2_nv_extensions.h:1713
NvVideoEncoder::setInsertVuiEnabled
int setInsertVuiEnabled(bool enabled)
Enables/disables insert VUI.
NvV4l2Element.h
NvElementProfiler::PROFILER_FIELD_TOTAL_UNITS
static const ProfilerField PROFILER_FIELD_TOTAL_UNITS
Definition: NvElementProfiler.h:81
NvVideoEncoder::SetPollInterrupt
int SetPollInterrupt()
Sets the polling interrupt, now if the application calls Poll, the device should not block,...
v4l2_ctrl_videoenc_input_metadata_
Holds the encoder frame input metadata parameters.
Definition: v4l2_nv_extensions.h:2118
NvVideoEncoder::~NvVideoEncoder
~NvVideoEncoder()
NvVideoEncoder::setNumReferenceFrames
int setNumReferenceFrames(uint32_t num_frames)
Sets the number of reference frames of the encoder.
v4l2_enc_enable_ext_rate_ctrl_
Holds the params to configure encoder for external rate control mode to be used with V4L2_CID_MPEG_VI...
Definition: v4l2_nv_extensions.h:2053
NvVideoEncoder::setPocType
int setPocType(uint32_t pocType)
Sets the encoder Picture Order Control type.
v4l2_enc_enable_reconcrc_param_
Holds the params to configure encoder for Reconstructed CRC encoding.
Definition: v4l2_nv_extensions.h:2095
NvVideoEncoder::forceIDR
int forceIDR()
Forces an IDR frame.
NvVideoEncoder::setLossless
int setLossless(bool enabled)
Sets the lossless encoding for H.264/H.265.
NvVideoEncoder::setBitrate
int setBitrate(uint32_t bitrate)
Sets the encoder bitrate.
NvVideoEncoder::getMetadata
int getMetadata(uint32_t buffer_index, v4l2_ctrl_videoenc_outputbuf_metadata &enc_metadata)
Gets metadata for the encoded capture plane buffer.
NvVideoEncoder::setCABAC
int setCABAC(bool enabled)
Enables/disables CABAC entropy encoding for H264.
NvVideoEncoder::setConstantQp
int setConstantQp(int qp_value)
Sets the encoder constant qp.
NvVideoEncoder
Defines a helper class for V4L2 Video Encoder.
Definition: NvVideoEncoder.h:59