Add supporting functionality for android refactor

packages/camera/camera/android/src/main/java/io/flutter/plugins/camera/CameraCaptureCallback.java

@@ -0,0 +1,142 @@
+// Copyright 2019 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+package io.flutter.plugins.camera;
+
+import android.hardware.camera2.CameraCaptureSession;
+import android.hardware.camera2.CameraCaptureSession.CaptureCallback;
+import android.hardware.camera2.CaptureRequest;
+import android.hardware.camera2.CaptureResult;
+import android.hardware.camera2.TotalCaptureResult;
+import android.util.Log;
+import androidx.annotation.NonNull;
+import io.flutter.plugins.camera.types.CaptureTimeoutsWrapper;
+
+class CameraCaptureCallback extends CaptureCallback {
+  private final CameraCaptureStateListener cameraStateListener;
+  private CameraState cameraState;
+  private final CaptureTimeoutsWrapper captureTimeouts;
+
+  private CameraCaptureCallback(
+      @NonNull CameraCaptureStateListener cameraStateListener,
+      @NonNull CaptureTimeoutsWrapper captureTimeouts) {
+    cameraState = CameraState.STATE_PREVIEW;
+    this.cameraStateListener = cameraStateListener;
+    this.captureTimeouts = captureTimeouts;
+  }
+
+  public static CameraCaptureCallback create(
+      @NonNull CameraCaptureStateListener cameraStateListener,
+      @NonNull CaptureTimeoutsWrapper captureTimeouts) {
+    return new CameraCaptureCallback(cameraStateListener, captureTimeouts);
+  }
+
+  public CameraState getCameraState() {
+    return cameraState;
+  }
+
+  public void setCameraState(@NonNull CameraState state) {
+    cameraState = state;
+  }
+
+  private void process(CaptureResult result) {
+    Integer aeState = result.get(CaptureResult.CONTROL_AE_STATE);
+    Integer afState = result.get(CaptureResult.CONTROL_AF_STATE);
+
+    if (cameraState != CameraState.STATE_PREVIEW) {
+      Log.i(
+          "Camera",
+          "CameraCaptureCallback | state: "
+              + cameraState
+              + " | afState: "
+              + afState
+              + " | aeState: "
+              + aeState);
+    }
+
+    switch (cameraState) {
+      case STATE_PREVIEW:
+        {
+          // We have nothing to do when the camera preview is working normally.
+          break;
+        }
+      case STATE_WAITING_FOCUS:
+        {
+          if (afState == null) {
+            return;
+          } else if (afState == CaptureResult.CONTROL_AF_STATE_FOCUSED_LOCKED
+              || afState == CaptureResult.CONTROL_AF_STATE_NOT_FOCUSED_LOCKED) {
+            handleWaitingFocusState(aeState);
+          } else if (captureTimeouts.getPreCaptureFocusing().getIsExpired()) {
+            Log.w("Camera", "Focus timeout, moving on with capture");
+            handleWaitingFocusState(aeState);
+          }
+
+          break;
+        }
+      case STATE_WAITING_PRECAPTURE_START:
+        {
+          // CONTROL_AE_STATE can be null on some devices
+          if (aeState == null
+              || aeState == CaptureResult.CONTROL_AE_STATE_CONVERGED
+              || aeState == CaptureResult.CONTROL_AE_STATE_PRECAPTURE
+              || aeState == CaptureResult.CONTROL_AE_STATE_FLASH_REQUIRED) {
+            setCameraState(CameraState.STATE_WAITING_PRECAPTURE_DONE);
+          } else if (captureTimeouts.getPreCaptureMetering().getIsExpired()) {
+            Log.w(
+                "Camera",
+                "Metering timeout waiting for pre-capture to start, moving on with capture");
+
+            setCameraState(CameraState.STATE_WAITING_PRECAPTURE_DONE);
+          }
+          break;
+        }
+      case STATE_WAITING_PRECAPTURE_DONE:
+        {
+          // CONTROL_AE_STATE can be null on some devices
+          if (aeState == null || aeState != CaptureResult.CONTROL_AE_STATE_PRECAPTURE) {
+            cameraStateListener.onConverged();
+          } else if (captureTimeouts.getPreCaptureMetering().getIsExpired()) {
+            Log.w(
+                "Camera",
+                "Metering timeout waiting for pre-capture to finish, moving on with capture");
+            cameraStateListener.onConverged();
+          }
+
+          break;
+        }
+    }
+  }
+
+  private void handleWaitingFocusState(Integer aeState) {
+    // CONTROL_AE_STATE can be null on some devices
+    if (aeState == null || aeState == CaptureRequest.CONTROL_AE_STATE_CONVERGED) {
+      cameraStateListener.onConverged();
+    } else {
+      cameraStateListener.onPrecapture();
+    }
+  }
+
+  @Override
+  public void onCaptureProgressed(
+      @NonNull CameraCaptureSession session,
+      @NonNull CaptureRequest request,
+      @NonNull CaptureResult partialResult) {
+    process(partialResult);
+  }
+
+  @Override
+  public void onCaptureCompleted(
+      @NonNull CameraCaptureSession session,
+      @NonNull CaptureRequest request,
+      @NonNull TotalCaptureResult result) {
+    process(result);
+  }
+
+  interface CameraCaptureStateListener {
+    void onConverged();
+
+    void onPrecapture();
+  }
+}

packages/camera/camera/android/src/main/java/io/flutter/plugins/camera/CameraState.java

@@ -0,0 +1,27 @@
+// Copyright 2019 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+package io.flutter.plugins.camera;
+
+/**
+ * These are the states that the camera can be in. The camera can only take one photo at a time so
+ * this state describes the state of the camera itself. The camera works like a pipeline where we
+ * feed it requests through. It can only process one tasks at a time.
+ */
+public enum CameraState {
+  /** Idle, showing preview and not capturing anything. */
+  STATE_PREVIEW,
+
+  /** Starting and waiting for autofocus to complete. */
+  STATE_WAITING_FOCUS,
+
+  /** Start performing autoexposure. */
+  STATE_WAITING_PRECAPTURE_START,
+
+  /** waiting for autoexposure to complete. */
+  STATE_WAITING_PRECAPTURE_DONE,
+
+  /** Capturing an image. */
+  STATE_CAPTURING,
+}

packages/camera/camera/android/src/main/java/io/flutter/plugins/camera/ImageSaver.java

@@ -0,0 +1,83 @@
+// Copyright 2019 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+package io.flutter.plugins.camera;
+
+import android.media.Image;
+import androidx.annotation.NonNull;
+import androidx.annotation.VisibleForTesting;
+import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.nio.ByteBuffer;
+
+/** Saves a JPEG {@link Image} into the specified {@link File}. */
+public class ImageSaver implements Runnable {
+
+  /** The JPEG image */
+  private final Image mImage;
+
+  /** The file we save the image into. */
+  private final File mFile;
+
+  /** Used to report the status of the save action. */
+  private final Callback mCallback;
+
+  ImageSaver(@NonNull Image image, @NonNull File file, @NonNull Callback callback) {
+    mImage = image;
+    mFile = file;
+    mCallback = callback;
+  }
+
+  @Override
+  public void run() {
+    ByteBuffer buffer = mImage.getPlanes()[0].getBuffer();
+    byte[] bytes = new byte[buffer.remaining()];
+    buffer.get(bytes);
+    FileOutputStream output = null;
+    try {
+      output = FileOutputStreamFactory.create(mFile);
+      output.write(bytes);
+
+      mCallback.onComplete(mFile.getAbsolutePath());
+
+    } catch (IOException e) {
+      mCallback.onError("IOError", "Failed saving image");
+    } finally {
+      mImage.close();
+      if (null != output) {
+        try {
+          output.close();
+        } catch (IOException e) {
+          mCallback.onError("cameraAccess", e.getMessage());
+        }
+      }
+    }
+  }
+
+  public interface Callback {
+    void onComplete(String absolutePath);
+
+    void onError(String errorCode, String errorMessage);
+  }
+
+  /** Factory class that assists in creating a {@link FileOutputStream} instance. */
+  static class FileOutputStreamFactory {
+    /**
+     * Creates a new instance of the {@link FileOutputStream} class.
+     *
+     * <p>This method is visible for testing purposes only and should never be used outside this *
+     * class.
+     *
+     * @param file - The file to create the output stream for
+     * @return new instance of the {@link FileOutputStream} class.
+     * @throws FileNotFoundException when the supplied file could not be found.
+     */
+    @VisibleForTesting
+    public static FileOutputStream create(File file) throws FileNotFoundException {
+      return new FileOutputStream(file);
+    }
+  }
+}

packages/camera/camera/android/src/main/java/io/flutter/plugins/camera/features/CameraFeatureFactory.java

@@ -0,0 +1,135 @@
+// Copyright 2019 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+package io.flutter.plugins.camera.features;
+
+import android.app.Activity;
+import androidx.annotation.NonNull;
+import io.flutter.plugins.camera.CameraProperties;
+import io.flutter.plugins.camera.DartMessenger;
+import io.flutter.plugins.camera.features.autofocus.AutoFocusFeature;
+import io.flutter.plugins.camera.features.exposurelock.ExposureLockFeature;
+import io.flutter.plugins.camera.features.exposureoffset.ExposureOffsetFeature;
+import io.flutter.plugins.camera.features.exposurepoint.ExposurePointFeature;
+import io.flutter.plugins.camera.features.flash.FlashFeature;
+import io.flutter.plugins.camera.features.focuspoint.FocusPointFeature;
+import io.flutter.plugins.camera.features.fpsrange.FpsRangeFeature;
+import io.flutter.plugins.camera.features.noisereduction.NoiseReductionFeature;
+import io.flutter.plugins.camera.features.resolution.ResolutionFeature;
+import io.flutter.plugins.camera.features.resolution.ResolutionPreset;
+import io.flutter.plugins.camera.features.sensororientation.SensorOrientationFeature;
+import io.flutter.plugins.camera.features.zoomlevel.ZoomLevelFeature;
+
+public interface CameraFeatureFactory {
+
+  /**
+   * Creates a new instance of the auto focus feature.
+   *
+   * @param cameraProperties instance of the CameraProperties class containing information about the
+   *     cameras features.
+   * @param recordingVideo indicates if the camera is currently recording.
+   * @return newly created instance of the AutoFocusFeature class.
+   */
+  AutoFocusFeature createAutoFocusFeature(
+      @NonNull CameraProperties cameraProperties, boolean recordingVideo);
+
+  /**
+   * Creates a new instance of the exposure lock feature.
+   *
+   * @param cameraProperties instance of the CameraProperties class containing information about the
+   *     cameras features.
+   * @return newly created instance of the ExposureLockFeature class.
+   */
+  ExposureLockFeature createExposureLockFeature(@NonNull CameraProperties cameraProperties);
+
+  /**
+   * Creates a new instance of the exposure offset feature.
+   *
+   * @param cameraProperties instance of the CameraProperties class containing information about the
+   *     cameras features.
+   * @return newly created instance of the ExposureOffsetFeature class.
+   */
+  ExposureOffsetFeature createExposureOffsetFeature(@NonNull CameraProperties cameraProperties);
+
+  /**
+   * Creates a new instance of the flash feature.
+   *
+   * @param cameraProperties instance of the CameraProperties class containing information about the
+   *     cameras features.
+   * @return newly created instance of the FlashFeature class.
+   */
+  FlashFeature createFlashFeature(@NonNull CameraProperties cameraProperties);
+
+  /**
+   * Creates a new instance of the resolution feature.
+   *
+   * @param cameraProperties instance of the CameraProperties class containing information about the
+   *     cameras features.
+   * @param initialSetting initial resolution preset.
+   * @param cameraId - the id of the camera which can be used to identify the camera device.
+   * @return newly created instance of the ResolutionFeature class.
+   */
+  ResolutionFeature createResolutionFeature(
+      @NonNull CameraProperties cameraProperties, ResolutionPreset initialSetting, int cameraId);
+
+  /**
+   * Creates a new instance of the focus point feature.
+   *
+   * @param cameraProperties instance of the CameraProperties class containing information about the
+   *     cameras features.
+   * @return newly created instance of the FocusPointFeature class.
+   */
+  FocusPointFeature createFocusPointFeature(@NonNull CameraProperties cameraProperties);
+
+  /**
+   * Creates a new instance of the FPS range feature.
+   *
+   * @param cameraProperties instance of the CameraProperties class containing information about the
+   *     cameras features.
+   * @return newly created instance of the FpsRangeFeature class.
+   */
+  FpsRangeFeature createFpsRangeFeature(@NonNull CameraProperties cameraProperties);
+
+  /**
+   * Creates a new instance of the sensor orientation feature.
+   *
+   * @param cameraProperties instance of the CameraProperties class containing information about the
+   *     cameras features.
+   * @param activity current activity associated with the camera plugin.
+   * @param dartMessenger instance of the DartMessenger class, used to send state updates back to
+   *     Dart.
+   * @return newly created instance of the SensorOrientationFeature class.
+   */
+  SensorOrientationFeature createSensorOrientationFeature(
+      @NonNull CameraProperties cameraProperties,
+      @NonNull Activity activity,
+      @NonNull DartMessenger dartMessenger);
+
+  /**
+   * Creates a new instance of the zoom level feature.
+   *
+   * @param cameraProperties instance of the CameraProperties class containing information about the
+   *     cameras features.
+   * @return newly created instance of the ZoomLevelFeature class.
+   */
+  ZoomLevelFeature createZoomLevelFeature(@NonNull CameraProperties cameraProperties);
+
+  /**
+   * Creates a new instance of the exposure point feature.
+   *
+   * @param cameraProperties instance of the CameraProperties class containing information about the
+   *     cameras features.
+   * @return newly created instance of the ExposurePointFeature class.
+   */
+  ExposurePointFeature createExposurePointFeature(@NonNull CameraProperties cameraProperties);
+
+  /**
+   * Creates a new instance of the noise reduction feature.
+   *
+   * @param cameraProperties instance of the CameraProperties class containing information about the
+   *     cameras features.
+   * @return newly created instance of the NoiseReductionFeature class.
+   */
+  NoiseReductionFeature createNoiseReductionFeature(@NonNull CameraProperties cameraProperties);
+}