nvenc::nvenc_base Class Reference

Abstract platform-agnostic base of standalone NVENC encoder. Derived classes perform platform-specific operations. More...

#include <src/nvenc/nvenc_base.h>

Inheritance diagram for nvenc::nvenc_base:

Collaboration diagram for nvenc::nvenc_base:

Public Member Functions
bool	create_encoder (const nvenc_config &config, const video::config_t &client_config, const nvenc_colorspace_t &colorspace, NV_ENC_BUFFER_FORMAT buffer_format)
	Create the encoder.
void	destroy_encoder ()
	Destroy the encoder. Derived classes classes call it in the destructor.
nvenc_encoded_frame	encode_frame (uint64_t frame_index, bool force_idr)
	Encode the next frame using platform-specific input surface.
bool	invalidate_ref_frames (uint64_t first_frame, uint64_t last_frame)
	Perform reference frame invalidation (RFI) procedure.
	nvenc_base (const nvenc_base &)=delete
	nvenc_base (NV_ENC_DEVICE_TYPE device_type)
nvenc_base &	operator= (const nvenc_base &)=delete

Protected Member Functions
virtual bool	create_and_register_input_buffer ()=0
	Required. Used for creating outside-facing input surface, registering this surface with nvenc->nvEncRegisterResource() and setting registered_input_buffer variable. Called during create_encoder().
virtual bool	init_library ()=0
	Required. Used for loading NvEnc library and setting nvenc variable with NvEncodeAPICreateInstance(). Called during create_encoder() if nvenc variable is not initialized.
bool	nvenc_failed (NVENCSTATUS status)
virtual bool	synchronize_input_buffer ()
	Optional. Override if you must perform additional operations on the registered input surface in the beginning of encode_frame(). Typically used for interop copy.
virtual bool	wait_for_async_event (uint32_t timeout_ms)
	Optional. Override if you want to create encoder in async mode. In this case must also set async_event_handle variable.

Protected Attributes
void *	async_event_handle = nullptr
void *	device = nullptr
const NV_ENC_DEVICE_TYPE	device_type
void *	encoder = nullptr
struct {
NV_ENC_BUFFER_FORMAT   buffer_format = NV_ENC_BUFFER_FORMAT_UNDEFINED
uint32_t   height = 0
uint32_t   ref_frames_in_dpb = 0
bool   rfi = false
uint32_t   width = 0
}	encoder_params
std::string	last_nvenc_error_string
std::shared_ptr< NV_ENCODE_API_FUNCTION_LIST >	nvenc
NV_ENC_REGISTERED_PTR	registered_input_buffer = nullptr

Detailed Description

Abstract platform-agnostic base of standalone NVENC encoder. Derived classes perform platform-specific operations.

Constructor & Destructor Documentation

nvenc_base()

nvenc::nvenc_base::nvenc_base ( NV_ENC_DEVICE_TYPE device_type )

explicit

Parameters

device_type

Underlying device type used by derived class.

Member Function Documentation

create_and_register_input_buffer()

virtual bool nvenc::nvenc_base::create_and_register_input_buffer ( )

protectedpure virtual

Required. Used for creating outside-facing input surface, registering this surface with nvenc->nvEncRegisterResource() and setting registered_input_buffer variable. Called during create_encoder().

Returns

true on success, false on error

create_encoder()

bool nvenc::nvenc_base::create_encoder	(	const nvenc_config &	config,
		const video::config_t &	client_config,
		const nvenc_colorspace_t &	colorspace,
		NV_ENC_BUFFER_FORMAT	buffer_format )

Create the encoder.

Parameters

config	NVENC encoder configuration.
client_config	Stream configuration requested by the client.
colorspace	YUV colorspace.
buffer_format	Platform-agnostic input surface format.

Returns

true on success, false on error

encode_frame()

nvenc_encoded_frame nvenc::nvenc_base::encode_frame	(	uint64_t	frame_index,
		bool	force_idr )

Encode the next frame using platform-specific input surface.

Parameters

frame_index	Frame index that uniquely identifies the frame. Afterwards serves as parameter for invalidate_ref_frames(). No restrictions on the first frame index, but later frame indexes must be subsequent.
force_idr	Whether to encode frame as forced IDR.

Returns

Encoded frame.

init_library()

virtual bool nvenc::nvenc_base::init_library ( )

protectedpure virtual

Required. Used for loading NvEnc library and setting nvenc variable with NvEncodeAPICreateInstance(). Called during create_encoder() if nvenc variable is not initialized.

Returns

true on success, false on error

Implemented in nvenc::nvenc_d3d11.

invalidate_ref_frames()

bool nvenc::nvenc_base::invalidate_ref_frames	(	uint64_t	first_frame,
		uint64_t	last_frame )

Perform reference frame invalidation (RFI) procedure.

Parameters

first_frame	First frame index of the invalidation range.
last_frame	Last frame index of the invalidation range.

Returns

true on success, false on error. After error next frame must be encoded with force_idr = true.

synchronize_input_buffer()

virtual bool nvenc::nvenc_base::synchronize_input_buffer ( )

inlineprotectedvirtual

Optional. Override if you must perform additional operations on the registered input surface in the beginning of encode_frame(). Typically used for interop copy.

Returns

true on success, false on error

wait_for_async_event()

virtual bool nvenc::nvenc_base::wait_for_async_event ( uint32_t timeout_ms )

inlineprotectedvirtual

Optional. Override if you want to create encoder in async mode. In this case must also set async_event_handle variable.

Parameters

timeout_ms

Wait timeout in milliseconds

Returns

true on success, false on timeout or error

Reimplemented in nvenc::nvenc_d3d11.

Member Data Documentation

async_event_handle

void* nvenc::nvenc_base::async_event_handle = nullptr

protected

(optional) Platform-specific handle of event object event. Can be set in constructor or init_library(), must override wait_for_async_event().

device

void* nvenc::nvenc_base::device = nullptr

protected

Platform-specific handle of encoding device. Should be set in constructor or init_library().

nvenc

std::shared_ptr<NV_ENCODE_API_FUNCTION_LIST> nvenc::nvenc_base::nvenc

protected

Function pointers list produced by NvEncodeAPICreateInstance(). Should be set in init_library().

registered_input_buffer

NV_ENC_REGISTERED_PTR nvenc::nvenc_base::registered_input_buffer = nullptr

protected

Platform-specific input surface registered with NvEncRegisterResource(). Should be set in create_and_register_input_buffer().

---

The documentation for this class was generated from the following files:

• src/nvenc/nvenc_base.h
• src/nvenc/nvenc_base.cpp