程序包 com.tencent.mps.tie.api

类 TIEPass

java.lang.Object
com.tencent.mps.tie.api.TIEPass
public class TIEPass extends Object
TIEPass is a class responsible for performing image enhancement rendering on input images. The class creates a TIEPass object and provides methods for initialization, rendering, reinitialization, and releasing resources.

Note:

  • All methods of TIEPass must be called within the same GLThread. Always ensure to call all methods of TIEPass within the same GLThread to guarantee correct execution and avoid potential issues.
  • The render(int) method should not be called before the init(int, int) method, and it should not be called after the deInit() method.
  • The reInit(int, int) method can be used to update the dimensions of the input image without needing to create a new TIEPass instance.

Usage:

  1. (In glThread) Create a TIEPass object using the constructor.
  2. (In glThread) Initialize the TIEPass object by calling the init(int, int) method. This method sets the input image width and height.
  3. (In glThread) If the input image dimensions change and you need to update the TIEPass configuration without creating a new instance, call the reInit(int, int) method.
  4. (In glThread) Perform image enhancement rendering on an input OpenGL texture by calling the render(int) method. This method returns the enhanced texture ID.
  5. (In glThread) Release resources when the TIEPass object is no longer needed by calling the deInit() method. This ensures proper release of OpenGL-related resources.

Example:


 // The code below must be executed in the same glThread.
 //----------------------GL Thread---------------------//

 // Create a TIEPass object using the constructor.
 TIEPass tiePass = new TIEPass(TIEPass.TIEAlgorithmType.PROFESSIONAL_HIGH_QUALITY);

 // Initialize TIEPass and set the input image width and height.
 tiePass.init(inputWidth, inputHeight);

 // If the input image dimensions change, reinitialize TIEPass with new dimensions.
 tiePass.reInit(newInputWidth, newInputHeight);

 // Perform image enhancement rendering on the input OpenGL texture and get the enhanced texture ID.
 int outputTextureId = tiePass.render(inputTextureId);

 // Release resources when the TIEPass object is no longer needed.
 tiePass.deInit();
 //----------------------GL Thread---------------------//

  • 构造器详细资料

    • TIEPass

      public TIEPass(TIEPass.TIEAlgorithmType algorithmType)
      Constructs a TIEPass object for image enhancement. This constructor should be called after TSRSdk.init(long, int, TSRSdk.TSRSdkLicenseVerifyResultCallback, TSRLogger) to ensure proper initialization. The created TIEPass object provides image enhancement functionality based on the specified TIEPass.TIEAlgorithmType.
      参数:
      algorithmType - The TIEAlgorithmType enum value representing the algorithm running mode to be used for image enhancement. It can be either PROFESSIONAL_FAST or PROFESSIONAL_HIGH_QUALITY.
      • PROFESSIONAL_FAST mode prioritizes better performance in terms of speed, possibly sacrificing some image quality.
      • PROFESSIONAL_HIGH_QUALITY mode prioritizes better image quality, even if the running speed is slower.

  • 方法详细资料

    • configureProIEMaxInputResolution

      public TIEPass.TIEInitStatusCode configureProIEMaxInputResolution(int maxInputWidth, int maxInputHeight)
      Configures the maximum input resolution for the image enhancement process. This method is used to pre-allocate memory for the underlying neural network inference framework, helping to avoid performance overhead when resetting the resolution or issues with image enhancement not taking effect during reinitialization.

      This method can be called from a non-GL thread and must be invoked before the init(int, int) and reInit(int, int) methods; otherwise, those methods will be ineffective.

      参数:
      maxInputWidth - The maximum width of the input image. This value should be between [8, 4096].
      maxInputHeight - The maximum height of the input image. This value should be between [8, 4096].
      返回:
      A TIEPass.TIEInitStatusCode enum value indicating the result of the configuration.

    • init

      public TIEPass.TIEInitStatusCode init(int inputWidth, int inputHeight)
      Initializes the TIEPass object for image enhancement. This method must be called from the same GL thread and after configureProIEMaxInputResolution(int, int) has been successfully executed. The input parameters specify the dimensions of the input image to be enhanced.
      参数:
      inputWidth - The new width of the input image to be enhanced. This value should be between [8, min(maxInputWidth, 4096)].
      inputHeight - The new height of the input image to be enhanced. This value should be between [8, min(maxInputHeight, 4096)].
      返回:
      A TIEPass.TIEInitStatusCode enum value indicating the result of the initialization.

    • reInit

      public TIEPass.TIEInitStatusCode reInit(int inputWidth, int inputHeight)
      Reinitializes the TIEPass object for image enhancement. This method must be called from the same GL thread and after configureProIEMaxInputResolution(int, int) has been successfully executed. The input parameters specify the new dimensions of the input image to be enhanced.
      参数:
      inputWidth - The new width of the input image to be enhanced. This value should be between [8, min(maxInputWidth, 4096)].
      inputHeight - The new height of the input image to be enhanced. This value should be between [8, min(maxInputHeight, 4096)].
      返回:
      A TIEPass.TIEInitStatusCode enum value indicating the result of the reinitialization.

    • render

      public int render(int textureId)
      Performs the image enhancement rendering operation on the input image. This method must be called within the GLThread.

      This method applies the image enhancement rendering process to the input image, improving its quality. The processed image is rendered onto a texture within the TIEPass object, and the texture's ID is returned.

      NOTE:

      • The type of the texture corresponding to the textureId you pass in must be texture2D.
      • The format of the input OpenGL texture must be GL_RGBA.
      • The format of the output textureId is also GL_RGBA.

      参数:
      textureId - The OpenGL textureId of the input image that needs to be processed for image enhancement. The corresponding texture is a texture2D texture with GL_RGBA format.
      返回:
      The textureId of the texture2D after image enhancement rendering, which is stored inside the TIEPass object. The format of the output texture is GL_RGBA. The size of the output texture is (inputWidth, inputHeight).

    • render

      public int render(int textureId, float[] transformMatrix)
      Performs the image enhancement rendering operation on the input image with a specified transform matrix. This method must be called within the GLThread.

      This method applies the image enhancement rendering process to the input image, improving its quality, and uses the given transform matrix to manipulate the image during the rendering process. The processed image is rendered onto a texture within the TIEPass object, and the texture's ID is returned.

      NOTE:

      • The type of the texture corresponding to the textureId you pass in must be texture2D.
      • The format of the input OpenGL texture must be GL_RGBA.
      • The format of the output textureId is also GL_RGBA.

      参数:
      textureId - The OpenGL textureId of the input image that needs to be processed for image enhancement. The corresponding texture is a texture2D texture with GL_RGBA format.
      transformMatrix - A float array representing the transform matrix to be applied to the input image during the rendering process. The matrix should be in column-major order and of size 16. The transform matrix can be used to apply various transformations, such as rotation, scaling, and translation, to the input image during the rendering process.
      返回:
      The textureId of the texture2D after image enhancement rendering and applying the transform matrix, which is stored inside the TIEPass object. The format of the output texture is GL_RGBA. The size of the output texture is (inputWidth, inputHeight).

    • deInit

      public void deInit()
      Releases the resources associated with the TIEPass object.

      This method should be called when the TIEPass object is no longer needed, to free up memory and other resources. Failing to call this method may lead to memory leaks or other issues.

      After calling this method, the TIEPass object should not be used for any further operations.