Table of Contents

Class MaxineSuperResSettings

Namespace
VisioForge.Core.Types
Assembly
VisioForge.Core.dll

Configures the NVIDIA Maxine Super Resolution effect, which uses AI to upscale video with enhanced quality.

public class MaxineSuperResSettings : IVideoResizeSettings

Inheritance

Implements

Inherited Members

Remarks

The VisioForge.Core.Types.MaxineSuperResSettings class provides configuration for NVIDIA's Maxine Super Resolution technology, which leverages deep learning models to intelligently upscale video content while preserving and enhancing details. This AI-powered approach produces superior results compared to traditional interpolation methods.

This class allows you to specify the target height for upscaling, the directory containing the Maxine SDK models, and the desired quality mode. The width is calculated automatically to maintain the aspect ratio.

Requirements:

  • NVIDIA GPU with Tensor Cores (RTX series or newer recommended)
  • NVIDIA Maxine SDK installed with appropriate models
  • Sufficient GPU memory for the selected resolution and mode

Constructors

MaxineSuperResSettings(string, int)

Initializes a new instance of the VisioForge.Core.Types.MaxineSuperResSettings class.

public MaxineSuperResSettings(string modelsDir, int height)

Parameters

modelsDir string

The directory path containing the NVIDIA Maxine SDK models. This must be a valid directory containing the required super resolution model files.

height int

The target height for the upscaled video in pixels. Must be a positive value greater than the source video height for upscaling to occur.

Exceptions

ArgumentNullException

Thrown when modelsDir is null or empty.

ArgumentOutOfRangeException

Thrown when height is less than or equal to zero.

Properties

Height

Gets the target height for the super resolution upscaling.

public int Height { get; }

Property Value

int

Remarks

The height value should be greater than the source video height for upscaling to occur. The maximum supported height depends on the GPU memory and the selected mode.

Mode

Gets or sets the quality mode for the super resolution effect.

public MaxineSuperResolutionEffectMode Mode { get; set; }

Property Value

MaxineSuperResolutionEffectMode

Remarks

Different modes offer various trade-offs between processing speed and output quality. Higher quality modes require more GPU resources and may impact real-time performance. Choose the mode based on your specific requirements for quality versus performance.

ModelsDir

Gets or sets the directory path where the NVIDIA Maxine SDK models are located.

public string ModelsDir { get; set; }

Property Value

string

Remarks

Ensure the models directory contains the appropriate model files for the selected mode. Different modes may require different model files. The path should be accessible and have read permissions for the application.

Example: @"C:\Program Files\NVIDIA Corporation\Maxine SDK\models"

Methods

CalculateWidth(Size)

Calculates the output width required to maintain the original aspect ratio based on the target height.

public int CalculateWidth(Size sourceSize)

Parameters

sourceSize Size

The size of the original source video, containing both width and height dimensions.

Returns

int

The calculated width for the upscaled video, rounded to the nearest integer pixel value. This ensures the aspect ratio is preserved during the upscaling process.

ToString()

Returns a string that represents the current super resolution settings.

public override string ToString()

Returns

string

A string formatted as "Super resolution (Nvidia Maxine) - [Height]p", where [Height] is the target resolution height. For example: "Super resolution (Nvidia Maxine) - 1080p".

See Also