NvVideoEncoder.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2016-2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: BSD-3-Clause
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef __NV_VIDEO_ENCODER_H__
#define __NV_VIDEO_ENCODER_H__
 
#include "NvV4l2Element.h"
 
class NvVideoEncoder:public NvV4l2Element
{
public:
    static NvVideoEncoder *createVideoEncoder(const char *name, int flags = 0);
 
     ~NvVideoEncoder();
 
    int setOutputPlaneFormat(uint32_t pixfmt, uint32_t width, uint32_t height,
                             enum v4l2_colorspace cs = V4L2_COLORSPACE_SMPTE170M);
    int setCapturePlaneFormat(uint32_t pixfmt, uint32_t width,
                              uint32_t height, uint32_t sizeimage);
 
    int setFrameRate(uint32_t framerate_num, uint32_t framerate_den);
 
    int setBitrate(uint32_t bitrate);
 
    int setPeakBitrate(uint32_t peak_bitrate);
 
    int setProfile(uint32_t profile);
 
    int setEncoderCommand(int cmd, int flags);
 
    int setLevel(uint32_t level);
 
    int setMaxPerfMode(int flag);
    int setConstantQp(bool enabled_rc);
 
    int setRateControlMode(enum v4l2_mpeg_video_bitrate_mode mode);
 
    int setIFrameInterval(uint32_t interval);
 
    int setIDRInterval(uint32_t interval);
 
    int forceIDR();
 
    int setTemporalTradeoff(v4l2_enc_temporal_tradeoff_level_type level);
 
    int setSliceLength(v4l2_enc_slice_length_type type, uint32_t length);
 
    int setHWPresetType(v4l2_enc_hw_preset_type type);
 
    int setROIParams(uint32_t buffer_index, v4l2_enc_frame_ROI_params & params);
 
    int setPPEInitParams(v4l2_enc_ppe_init_params & params);
 
    int enableROI(v4l2_enc_enable_roi_param &params);
 
    int enableReconCRC(v4l2_enc_enable_reconcrc_param &params);
 
    int enableExternalRPS(v4l2_enc_enable_ext_rps_ctr &params);
 
    int enableExternalRC(v4l2_enc_enable_ext_rate_ctr &params);
 
    int enableAV1Tile(v4l2_enc_av1_tile_config &params);
 
    int setAV1SsimRdo(bool enabled);
 
    int setAV1DisableCDFUpdate(bool disabled);
 
    int setAV1ErrResilienceMode(bool enabled);
 
    int setAV1FrameIDPresentFlag(bool enabled);
 
    int enableAV1TileGroups(bool enabled);
 
    int SetInputMetaParams(uint32_t buffer_index, v4l2_ctrl_videoenc_input_metadata &params);
 
    int setVirtualBufferSize(uint32_t size);
 
    int setNumReferenceFrames(uint32_t num_frames);
 
    int setSliceIntrarefresh(uint32_t interval);
 
    int setNumBFrames(uint32_t num);
 
    int setInsertSpsPpsAtIdrEnabled(bool enabled);
 
    int setCABAC(bool enabled);
 
    int setSliceLevelEncode(bool enabled);
 
    int enableMotionVectorReporting();
 
    int getMetadata(uint32_t buffer_index,
            v4l2_ctrl_videoenc_outputbuf_metadata &enc_metadata);
 
    int getMotionVectors(uint32_t buffer_index,
            v4l2_ctrl_videoenc_outputbuf_metadata_MV &enc_mv_metadata);
 
    int setQpRange(uint32_t MinQpI, uint32_t MaxQpI, uint32_t MinQpP,
            uint32_t MaxQpP, uint32_t MinQpB, uint32_t MaxQpB);
 
    int setSampleAspectRatioWidth(uint32_t sar_width);
 
    int setSampleAspectRatioHeight(uint32_t sar_height);
 
    int setInsertVuiEnabled(bool enabled);
 
    int setExtendedColorFormat(bool enabled);
 
    int setInsertAudEnabled(bool enabled);
 
    int setAlliFramesEncode(bool enabled);
 
    int setPocType(uint32_t pocType);
 
    int setInitQP(uint32_t IinitQP, uint32_t PinitQP, uint32_t BinitQP);
 
    int setFramesToEncode(uint32_t framesToEncode);
 
    int setChromaFactorIDC(uint8_t crfactor);
 
    int setLossless(bool enabled);
 
    int setDisableAMP(bool enabled);
 
    int enableTwoPassCBR();
 
    int DevicePoll(v4l2_ctrl_video_device_poll *devicepoll);
 
    int SetPollInterrupt();
 
    int ClearPollInterrupt();
 
private:
    NvVideoEncoder(const char *name, const char* dev_node, int flags);
 
    static const NvElementProfiler::ProfilerField valid_fields =
            NvElementProfiler::PROFILER_FIELD_TOTAL_UNITS |
            NvElementProfiler::PROFILER_FIELD_LATENCIES |
            NvElementProfiler::PROFILER_FIELD_FPS;
};
#endif