nvenc_base.h

Go to the documentation of this file.

 
#pragma once
 
// lib includes
#include <ffnvcodec/nvEncodeAPI.h>
 
// local includes
#include "nvenc_colorspace.h"
#include "nvenc_config.h"
#include "nvenc_encoded_frame.h"
#include "src/logging.h"
#include "src/video.h"
 
namespace nvenc {
 
  class nvenc_base {
  public:
    explicit nvenc_base(NV_ENC_DEVICE_TYPE device_type);
    virtual ~nvenc_base();
 
    nvenc_base(const nvenc_base &) = delete;
    nvenc_base &operator=(const nvenc_base &) = delete;
 
    bool create_encoder(const nvenc_config &config, const video::config_t &client_config, const nvenc_colorspace_t &colorspace, NV_ENC_BUFFER_FORMAT buffer_format);
 
    void destroy_encoder();
 
    nvenc_encoded_frame encode_frame(uint64_t frame_index, bool force_idr);
 
    bool invalidate_ref_frames(uint64_t first_frame, uint64_t last_frame);
 
  protected:
    virtual bool init_library() = 0;
 
    virtual bool create_and_register_input_buffer() = 0;
 
    virtual bool synchronize_input_buffer() {
      return true;
    }
 
    virtual bool wait_for_async_event(uint32_t timeout_ms) {
      return false;
    }
 
    bool nvenc_failed(NVENCSTATUS status);
 
    uint32_t min_struct_version(uint32_t version, uint32_t v11_struct_version = 0, uint32_t v12_struct_version = 0);
 
    const NV_ENC_DEVICE_TYPE device_type;
 
    void *encoder = nullptr;
 
    struct {
      uint32_t width = 0;
      uint32_t height = 0;
      NV_ENC_BUFFER_FORMAT buffer_format = NV_ENC_BUFFER_FORMAT_UNDEFINED;
      uint32_t ref_frames_in_dpb = 0;
      bool rfi = false;
    } encoder_params;
 
    std::string last_nvenc_error_string;
 
    // Derived classes set these variables
    void *device = nullptr;  
    std::shared_ptr<NV_ENCODE_API_FUNCTION_LIST> nvenc;  
    NV_ENC_REGISTERED_PTR registered_input_buffer = nullptr;  
    void *async_event_handle = nullptr;  
 
  private:
    NV_ENC_OUTPUT_PTR output_bitstream = nullptr;
    uint32_t minimum_api_version = 0;
 
    struct {
      uint64_t last_encoded_frame_index = 0;
      bool rfi_needs_confirmation = false;
      std::pair<uint64_t, uint64_t> last_rfi_range;
      logging::min_max_avg_periodic_logger<double> frame_size_logger = {debug, "NvEnc: encoded frame sizes in kB", ""};
    } encoder_state;
  };
 
}  // namespace nvenc