TSRPass Class Reference

Inherits from	NSObject
Declared in	TSRPass.h TSRPass.mm

Overview

The TSRPass class provides methods for performing super-resolution rendering on input images using the Metal framework.

TSRPass is responsible for initializing the super-resolution rendering process with the specified input image size and super-resolution ratio. It also provides a render method that applies the super-resolution process to the input image and returns the processed image as an MTLTexture object.

Note:

This class uses the Metal framework for performing super-resolution rendering and requires a device that supports Metal.
All methods of TSRPass must be called within the same thread.
The render:commandBuffer: and renderWithPixelBuffer: method should not be called before the initWithTSRAlgorithmType:device:inputWidth:inputHeight:srRatio:initStatusCode: method, and it should not be called after the deInit method.
Initializing the TSRPass with TSRAlgorithmTypeProfessional is only available on iOS 15.0 or newer. If the iOS version is older, it will fallback to TSRAlgorithmTypeStandard.

Usage:

Create a TSRPass instance using the initWithTSRAlgorithmType:device:inputWidth:inputHeight:srRatio:initStatusCode: method.
Call the render:commandBuffer: method with the input image’s MTLTexture and an MTLCommandBuffer to perform super-resolution rendering.
Obtain the processed image as an MTLTexture from the return value of the render:commandBuffer: method.
deInit method should be called when the TSRPass object is no longer needed, to free up the memory and other resources.

`– initWithTSRAlgorithmType:device:inputWidth:inputHeight:srRatio:initStatusCode:`

Init TSRPass object for super-resolution.

- (instancetype)initWithTSRAlgorithmType:(TSRAlgorithmType)algorithmType device:(id<MTLDevice>)device inputWidth:(int32_t)inputWidth inputHeight:(int32_t)inputHeight srRatio:(float_t)srRatio initStatusCode:(TSRInitStatusCode *)initStatusCode

Parameters

`algorithmType`	The TSRAlgorithmType enum value representing the algorithm running mode to be used. It can be either STANDARD (fast mode) or PROFESSIONAL (quality mode). STANDARD mode prioritizes better performance in terms of speed, possibly sacrificing some result accuracy. PROFESSIONAL mode prioritizes result accuracy, even if the running speed is slower.
`device`	The MTLDevice which you are using.
`inputWidth`	The width of the input texture. This value should be between 1 to 4096.
`inputHeight`	The height of the input texture. This value should be between 1 to 4096.
`srRatio`	The magnification factor for super-resolution.
`initStatusCode`	A pointer to a TSRInitStatusCode enum value that will store the result of the initialization process. If initialization is successful, the value will be TSRInitStatusCodeSuccess. If initialization fails, the value will indicate the specific error that occurred.

Discussion

Init TSRPass object for super-resolution.

Declared In

TSRPass.h

`– render:commandBuffer:`

Performs the super-resolution rendering operation on the input image.
This method applies the super-resolution rendering process to the input image, improving its quality. The processed image is rendered onto a MTLTexture within the TSRPass object. And the return is the MTLTexture which has preformed super-resolution rendering .

- (id<MTLTexture>)render:(id<MTLTexture>)texture commandBuffer:(id<MTLCommandBuffer>)commandBuffer

Parameters

`texture`	The MTLTexture of the input image that needs to be processed for super-resolution.
`commandBuffer`	The MTLCommandBuffer which you are using.

Return Value

The MTLTexture that will be performed super-resolution rendering, which is stored inside the TSRPass object. The size of the output texture is (inputWidth * srRatio, inputHeight * srRatio).

Discussion

Declared In

TSRPass.h

`– renderWithPixelBuffer:`

Performs the super-resolution rendering operation on the input pixel buffer.

- (CVPixelBufferRef)renderWithPixelBuffer:(CVPixelBufferRef)pixelBuffer

Parameters

`pixelBuffer`	The CVPixelBufferRef of the input image that needs to be processed for super-resolution. The width and height of the pixel buffer must match the inputWidth and inputHeight set during initialization, and the pixel format must be BGRA.

Return Value

The CVPixelBufferRef that has been performed super-resolution rendering. The size of the output pixel buffer is (inputWidth * srRatio, inputHeight * srRatio).

Discussion

Performs the super-resolution rendering operation on the input pixel buffer.

This method applies the super-resolution rendering process to the input pixel buffer, improving its quality. The processed pixel buffer is created and returned as a new CVPixelBufferRef.

Note: The SDK internally handles the lifecycle of the returned CVPixelBufferRef, therefore, the caller absolutely should not attempt to manually release the returned CVPixelBufferRef.

Declared In

TSRPass.h

`– setParametersWithBrightness:saturation:contrast:sharpness:`

Adjusts the parameters of the rendering operator. It needs to take effect after TSRPass#initWithDevice is called.

- (void)setParametersWithBrightness:(float)brightness saturation:(float)saturation contrast:(float)contrast sharpness:(float)sharpness

Parameters

`brightness`	The brightness level to apply. Valid values are between 0 and 100, with a default value of 50.
`saturation`	The saturation level to apply. Valid values are between 0 and 100, with a default value of 50.
`contrast`	The contrast level to apply. Valid values are between 0 and 100, with a default value of 50.
`sharpness`	The sharpness level to apply. Valid values are between 0 and 100, with a default value of 0.

Discussion

Adjusts the parameters of the rendering operator. It needs to take effect after TSRPass#initWithDevice is called.

Declared In

TSRPass.h

`– deInit`

Releases the resources.
This method should be called when the TSRPass object is no longer needed, to free up the memory and other resources.

- (void)deInit

Discussion

Releases the resources.
This method should be called when the TSRPass object is no longer needed, to free up the memory and other resources.

Declared In

TSRPass.h