Source repositorynvenc Namespace Reference

Standalone NVENC encoder. More...

Classes
class	nvenc_base
	Abstract platform-agnostic base of standalone NVENC encoder. Derived classes perform platform-specific operations. More...
struct	nvenc_colorspace_t
	YUV colorspace and color range. More...
struct	nvenc_config
	NVENC encoder configuration. More...
class	nvenc_d3d11
	Abstract Direct3D11 NVENC encoder. Encapsulates common code used by native and interop implementations. More...
class	nvenc_d3d11_interface
	SDK-neutral Direct3D11 NVENC encoder interface. More...
class	nvenc_d3d11_native
	Native Direct3D11 NVENC encoder. More...
class	nvenc_d3d11_on_cuda
	Interop Direct3D11 on CUDA NVENC encoder. Input surface is Direct3D11, encoding is performed by CUDA. More...
class	nvenc_dynamic_factory
	Factory bound to the newest NVENC SDK supported by the installed driver. More...
struct	nvenc_encoded_frame
	Encoded NVENC output frame and metadata needed by the packetizer. More...
class	nvenc_encoder
	SDK-neutral standalone NVENC encoder interface. More...
struct	nvenc_runtime_api
	Windows runtime operations used to discover the installed NVENC API. More...
struct	shared_dll_deleter
	Release a Windows module when its final shared owner is destroyed. More...

Typedefs
using	ID3D11DevicePtr = ID3D11Device *
	COM smart pointer for ID3D11Device.
using	ID3D11Texture2DPtr = ID3D11Texture2D *
	COM smart pointer for ID3D11Texture2D.
using	IDXGIAdapterPtr = IDXGIAdapter *
	COM smart pointer for IDXGIAdapter.
using	IDXGIDevicePtr = IDXGIDevice *
	COM smart pointer for IDXGIDevice.
using	shared_dll = std::shared_ptr<std::remove_pointer_t<HMODULE>>
	Shared ownership wrapper for a loaded Windows module.

Enumerations
enum class	nvenc_sdk_version : std::uint32_t {   unsupported = 0U , sdk_11_0 = 1100U , sdk_12_0 = 1200U , sdk_13_0 = 1300U ,   sdk_13_1 = 1301U }
	NVENC SDK implementations compiled into Sunshine. More...
enum class	nvenc_split_frame_encoding { disabled , driver_decides , force_enabled }
	Enumerates supported nVENC split frame encoding options. More...
enum class	nvenc_two_pass { disabled , quarter_resolution , full_resolution }
	Enumerates supported nVENC two pass options. More...

Functions
constexpr std::uint32_t	decode_nvenc_driver_version (std::uint32_t version)
	Convert the packed driver API version to a comparable integer.
DXGI_FORMAT	dxgi_format_from_nvenc_format (NV_ENC_BUFFER_FORMAT format)
	Convert an NVENC buffer format to the matching DXGI format.
shared_dll	make_shared_dll (HMODULE dll)
	Wrap a Windows module handle in shared ownership.
nvenc_colorspace_t	nvenc_colorspace_from_sunshine_colorspace (const video::sunshine_colorspace_t &sunshine_colorspace)
	Convert Sunshine colorspace metadata to NVENC VUI metadata.
NV_ENC_BUFFER_FORMAT	nvenc_format_from_sunshine_format (platf::pix_fmt_e format)
	Convert a Sunshine pixel format to the matching NVENC buffer format.
constexpr nvenc_sdk_version	select_nvenc_sdk_version (std::uint32_t max_version)
	Select the newest compiled SDK supported by the installed driver.

Detailed Description

Standalone NVENC encoder.

Enumeration Type Documentation

nvenc_sdk_version

enum class nvenc::nvenc_sdk_version : std::uint32_t

strong

NVENC SDK implementations compiled into Sunshine.

Enumerator
unsupported	No compatible SDK implementation is available.
sdk_11_0	Video Codec SDK 11.0.
sdk_12_0	Video Codec SDK 12.0.
sdk_13_0	Video Codec SDK 13.0.
sdk_13_1	Video Codec SDK 13.1.

nvenc_split_frame_encoding

enum class nvenc::nvenc_split_frame_encoding

strong

Enumerates supported nVENC split frame encoding options.

Enumerator
disabled	Disable.
driver_decides	Let driver decide.
force_enabled	Force-enable.

nvenc_two_pass

enum class nvenc::nvenc_two_pass

strong

Enumerates supported nVENC two pass options.

Enumerator
disabled	Single pass, the fastest and no extra vram.
quarter_resolution	Larger motion vectors being caught, faster and uses less extra vram.
full_resolution	Better overall statistics, slower and uses more extra vram.

Function Documentation

decode_nvenc_driver_version()

std::uint32_t nvenc::decode_nvenc_driver_version ( std::uint32_t version )

constexpr

Convert the packed driver API version to a comparable integer.

Parameters

version

Version returned by NvEncodeAPIGetMaxSupportedVersion().

Returns

Version encoded as major * 100 + minor.

dxgi_format_from_nvenc_format()

DXGI_FORMAT nvenc::dxgi_format_from_nvenc_format

(

NV_ENC_BUFFER_FORMAT

format

)

Convert an NVENC buffer format to the matching DXGI format.

Parameters

format

Pixel, audio, or protocol format being converted.

Returns

DXGI texture format that matches the NVENC buffer format.

make_shared_dll()

shared_dll nvenc::make_shared_dll ( HMODULE dll )

inline

Wrap a Windows module handle in shared ownership.

Parameters

dll	Module handle returned by LoadLibraryEx().

Returns

Shared module handle.

nvenc_colorspace_from_sunshine_colorspace()

nvenc_colorspace_t nvenc::nvenc_colorspace_from_sunshine_colorspace

(

const video::sunshine_colorspace_t &

sunshine_colorspace

)

Convert Sunshine colorspace metadata to NVENC VUI metadata.

Parameters

sunshine_colorspace

Sunshine colorspace.

Returns

NVENC colorspace and VUI fields for the Sunshine metadata.

nvenc_format_from_sunshine_format()

NV_ENC_BUFFER_FORMAT nvenc::nvenc_format_from_sunshine_format

(

platf::pix_fmt_e

format

)

Convert a Sunshine pixel format to the matching NVENC buffer format.

Parameters

format

Pixel, audio, or protocol format being converted.

Returns

NVENC buffer format compatible with the Sunshine pixel format.

select_nvenc_sdk_version()

nvenc_sdk_version nvenc::select_nvenc_sdk_version ( std::uint32_t max_version )

constexpr

Select the newest compiled SDK supported by the installed driver.

Parameters

max_version

Maximum driver API version encoded as major * 100 + minor.

Returns

Selected SDK implementation, or unsupported when the driver is too old.