Overview

Transformation associated the preview output.

The SurfaceRequest.TransformationInfo can be used transform the provided via SurfaceRequest.provideSurface(Surface, Executor, Consumer). The info is based on the camera sensor rotation, preview target rotation and the ViewPort associated with the Preview. The application of the info depends on the source of the . For detailed example, please check out the source code of PreviewView in androidx.camera.view artifact.

The info is also needed to transform coordinates across use cases. In a face detection example, one common scenario is running a face detection algorithm against a ImageAnalysis use case, and highlight the detected face in the preview. Below is a code sample to get the transformation based on the ImageProxy from ImageAnalysis and the SurfaceRequest.TransformationInfo from Preview:

     // Get rotation transformation.
     val transformation = Matrix()
     transformation.setRotate(info.getRotationDegrees())

     // Get rotated crop rect and cropping transformation.
     val rotatedRect = new RectF()
     rotation.mapRect(rotatedRect, RectF(imageProxy.getCropRect()))
     rotatedRect.sort()
     val cropTransformation = Matrix()
     cropTransformation.setRectToRect(
          RectF(imageProxy.getCropRect()), rotatedRect, ScaleToFit.FILL)

     // Concatenate the rotation and cropping transformations.
     transformation.postConcat(cropTransformation)
 

Summary

Methods

Returns the crop rect rectangle.

The returned value dictates how the provided in SurfaceRequest.provideSurface(Surface, Executor, Consumer) should be displayed. The crop rectangle specifies the region of valid pixels in the buffer, using coordinates from (0, 0) to the (width, height) of SurfaceRequest.getResolution(). The caller should arrange the UI so that only the valid region is visible to app users.

If Preview is configured with a ViewPort, this value is calculated based on the configuration of ViewPort; if not, it returns the full rect of the buffer. For code sample on how to apply the crop rect, please see ViewPort.FIT.

See also: ViewPort

Returns the rotation needed to transform the output from sensor to the target rotation.

This is a clockwise rotation in degrees that needs to be applied to the sensor buffer. The rotation will be determined by CameraCharacteristics, Preview.setTargetRotation(int) and Preview.Builder.setTargetRotation(int). This value is useful for transforming coordinates across use cases.

This value is most useful for transforming coordinates across use cases, e.g. in preview, highlighting a pattern detected in image analysis. For correcting the preview itself, usually the source of the handles the rotation without needing this value. For , it automatically corrects the preview to match the display rotation. For TextureView, the only additional rotation needed is the display rotation. For detailed example, please check out the source code of PreviewView in androidx.camera .view artifact.

Returns:

The rotation in degrees which will be a value in {0, 90, 180, 270}.

See also: Preview.setTargetRotation(int), Preview.getTargetRotation(), ViewPort

The target rotation of the Preview.

Used to correct preview for TextureView. SurfaceRequest.TransformationInfo.getRotationDegrees() is a function of 1) CameraCharacteristics, 2) camera lens facing direction and 3) target rotation. TextureView handles 1) & 2) automatically, while still needs the target rotation to correct the display.This is used when apps need to rotate the preview to non-display orientation.

The API is internal for PreviewView to use. For external users, the value is usually Display in practice. If that's not the case, they can always obtain the value from Preview.getTargetRotation().

Please note that if the value is ImageOutputConfig which means targetRotation is not specified for Preview, the user should always get up-to-date display rotation and re-calculate the rotationDegrees to correct the display.

See also: CameraCharacteristics

Whether the contains the camera transform.

When the Surface is connected to the camera directly, camera writes the camera orientation value to the Surface. For example, the value can be retrieved via SurfaceTexture. Android components such as TextureView and use the value to transform the output. When the Surface is not connect to the camera directly, for example, when it was copied with OpenGL, the Surface will not contain the camera orientation value.

The app may need to transform the UI differently based on this flag. If this value is true, the app only needs to apply the Surface transformation; otherwise, the app needs to apply the value of SurfaceRequest.TransformationInfo.getRotationDegrees(). For example, if the preview is displayed in a TextureView:

 int rotationDegrees;
 if (surfaceRequest.hasCameraTransform()) {
   switch (textureView.getDisplay().getRotation()) {
     case Surface.ROTATION_0:
       rotationDegrees = 0;
       break;
     case Surface.ROTATION_90:
       rotationDegrees = 90;
       break;
     case Surface.ROTATION_180:
       rotationDegrees = 180;
       break;
     case Surface.ROTATION_270:
       rotationDegrees = 270;
       break;
     }
 } else {
   rotationDegrees = transformationInfo.getRotationDegrees();
 }
 Matrix textureViewTransform = new Matrix();
 textureViewTransform.postRotate(rotationDegrees);
 textureView.setTransform(textureViewTransform);
 

Returns:

true if the contains the camera transformation.

Returns the sensor to image buffer transform matrix.

The value is a mapping from sensor coordinates to buffer coordinates, which is, from the rect of CameraCharacteristics to the rect defined by (0, 0, #getResolution#getWidth(), #getResolution#getHeight()). The matrix can be used to map the coordinates from one UseCase to another. For example, detecting face with ImageAnalysis, and then highlighting the face in Preview.

Code sample

  // Get the transformation from sensor to effect input.
  Matrix sensorToEffect = surfaceRequest.getSensorToBufferTransform();
  // Get the transformation from sensor to ImageAnalysis.
  Matrix sensorToAnalysis = imageProxy.getSensorToBufferTransform();
  // Concatenate the two matrices to get the transformation from ImageAnalysis to effect.
  Matrix analysisToEffect = Matrix()
  sensorToAnalysis.invert(analysisToEffect);
  analysisToEffect.postConcat(sensorToEffect);
 

Returns whether the buffer should be mirrored.

This flag indicates whether the buffer needs to be mirrored across the vertical axis. For example, for front camera preview, the buffer should usually be mirrored. The mirroring should be applied after the SurfaceRequest.TransformationInfo.getRotationDegrees() is applied.

Creates new SurfaceRequest.TransformationInfo

Internally public to be used in view artifact tests.