Fix a hardware acceleration bug, disable SurfaceViewPreview features (#54)

* Layout changes

* SurfaceView onSurfaceCreated is too early. Fix

* Add logs

* Refactor some classes, fix hardware acceleration bug, disable cropping for SurfaceView

* Update README with known limitations

Author: natario1

README.md

@@ -57,6 +57,7 @@ compile 'com.otaliastudios:cameraview:1.2.1'
 - [Permissions Behavior](#permissions-behavior)
 - [Manifest file](#manifest-file)
 - [Roadmap](#roadmap)
+- [Device-specific issues](#device-specific-issues)
 
 ## Usage
 
@@ -526,3 +527,11 @@ These are still things that need to be done, off the top of my head:
 - [ ] add onRequestPermissionResults for easy permission callback
 - [ ] better error handling, maybe with a onError(e) method in the public listener, or have each public method return a boolean
 - [ ] decent code coverage
+
+## Device-specific issues
+
+There are a couple of known issues if you are working with certain devices. The emulator is one of
+the most tricky in this sense.
+
+- Devices, or activities, with hardware acceleration turned off: this can be the case with emulators. In this case we will use SurfaceView as our surface provider. That is intrinsically flawed and can't deal with all we want to do here (runtime layout changes, scaling, etc.). So, nothing to do in this case.
+- Devices with no support for MediaRecorder: the emulator does not support it, officially. This means that video/audio recording is flawed. Again, not our fault.

cameraview/src/androidTest/java/com/otaliastudios/cameraview/CameraCallbacksTest.java

@@ -4,10 +4,7 @@
 import android.content.Context;
 import android.graphics.Bitmap;
 import android.graphics.BitmapFactory;
-import android.graphics.Color;
 import android.graphics.PointF;
-import android.graphics.Rect;
-import android.graphics.YuvImage;
 import android.support.test.filters.MediumTest;
 import android.support.test.runner.AndroidJUnit4;
 import android.view.ViewGroup;
@@ -18,9 +15,7 @@
 import org.junit.runner.RunWith;
 import org.mockito.invocation.InvocationOnMock;
 import org.mockito.stubbing.Answer;
-
-import java.io.ByteArrayOutputStream;
-import java.io.OutputStream;
+import org.mockito.stubbing.Stubber;
 
 import static junit.framework.Assert.assertNotNull;
 import static org.junit.Assert.assertEquals;
@@ -33,19 +28,18 @@
 import static org.mockito.Mockito.doAnswer;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.never;
+import static org.mockito.Mockito.reset;
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
-import static org.mockito.Mockito.when;
 
 @RunWith(AndroidJUnit4.class)
 @MediumTest
 public class CameraCallbacksTest extends BaseTest {
 
     private CameraView camera;
-    private CameraView.CameraCallbacks callbacks;
     private CameraListener listener;
     private MockCameraController mockController;
-    private MockPreview mockPreview;
+    private MockCameraPreview mockPreview;
     private Task<Boolean> task;
 
 
@@ -58,14 +52,14 @@ public void run() {
                 listener = mock(CameraListener.class);
                 camera = new CameraView(context) {
                     @Override
-                    protected CameraController instantiateCameraController(CameraCallbacks callbacks, Preview preview) {
-                        mockController = new MockCameraController(callbacks, preview);
+                    protected CameraController instantiateCameraController(CameraCallbacks callbacks) {
+                        mockController = new MockCameraController(callbacks);
                         return mockController;
                     }
 
                     @Override
-                    protected Preview instantiatePreview(Context context, ViewGroup container) {
-                        mockPreview = new MockPreview(context, container);
+                    protected CameraPreview instantiatePreview(Context context, ViewGroup container) {
+                        mockPreview = new MockCameraPreview(context, container);
                         return mockPreview;
                     }
 
@@ -74,8 +68,8 @@ protected boolean checkPermissions(SessionType sessionType, Audio audio) {
                         return true;
                     }
                 };
+                camera.instantiatePreview();
                 camera.addCameraListener(listener);
-                callbacks = camera.mCameraCallbacks;
                 task = new Task<>();
                 task.listen();
             }
@@ -87,26 +81,25 @@ public void tearDown() {
         camera = null;
         mockController = null;
         mockPreview = null;
-        callbacks = null;
         listener = null;
     }
 
     // Completes our task.
-    private Answer completeTask() {
-        return new Answer() {
+    private Stubber completeTask() {
+        return doAnswer(new Answer() {
             @Override
             public Object answer(InvocationOnMock invocation) throws Throwable {
                 task.end(true);
                 return null;
             }
-        };
+        });
     }
 
     @Test
     public void testDontDispatchIfRemoved() {
         camera.removeCameraListener(listener);
-        doAnswer(completeTask()).when(listener).onCameraOpened(null);
-        callbacks.dispatchOnCameraOpened(null);
+        completeTask().when(listener).onCameraOpened(null);
+        camera.mCameraCallbacks.dispatchOnCameraOpened(null);
 
         assertNull(task.await(200));
         verify(listener, never()).onCameraOpened(null);
@@ -115,53 +108,53 @@ public void testDontDispatchIfRemoved() {
     @Test
     public void testDontDispatchIfCleared() {
         camera.clearCameraListeners();
-        doAnswer(completeTask()).when(listener).onCameraOpened(null);
-        callbacks.dispatchOnCameraOpened(null);
+        completeTask().when(listener).onCameraOpened(null);
+        camera.mCameraCallbacks.dispatchOnCameraOpened(null);
 
         assertNull(task.await(200));
         verify(listener, never()).onCameraOpened(null);
     }
 
     @Test
     public void testDispatchOnCameraOpened() {
-        doAnswer(completeTask()).when(listener).onCameraOpened(null);
-        callbacks.dispatchOnCameraOpened(null);
+        completeTask().when(listener).onCameraOpened(null);
+        camera.mCameraCallbacks.dispatchOnCameraOpened(null);
 
         assertNotNull(task.await(200));
         verify(listener, times(1)).onCameraOpened(null);
     }
 
     @Test
     public void testDispatchOnCameraClosed() {
-        doAnswer(completeTask()).when(listener).onCameraClosed();
-        callbacks.dispatchOnCameraClosed();
+        completeTask().when(listener).onCameraClosed();
+        camera.mCameraCallbacks.dispatchOnCameraClosed();
 
         assertNotNull(task.await(200));
         verify(listener, times(1)).onCameraClosed();
     }
 
     @Test
     public void testDispatchOnVideoTaken() {
-        doAnswer(completeTask()).when(listener).onVideoTaken(null);
-        callbacks.dispatchOnVideoTaken(null);
+        completeTask().when(listener).onVideoTaken(null);
+        camera.mCameraCallbacks.dispatchOnVideoTaken(null);
 
         assertNotNull(task.await(200));
         verify(listener, times(1)).onVideoTaken(null);
     }
 
     @Test
     public void testDispatchOnZoomChanged() {
-        doAnswer(completeTask()).when(listener).onZoomChanged(anyFloat(), any(float[].class), any(PointF[].class));
-        callbacks.dispatchOnZoomChanged(0f, null);
+        completeTask().when(listener).onZoomChanged(anyFloat(), any(float[].class), any(PointF[].class));
+        camera.mCameraCallbacks.dispatchOnZoomChanged(0f, null);
 
         assertNotNull(task.await(200));
         verify(listener, times(1)).onZoomChanged(anyFloat(), any(float[].class), any(PointF[].class));
     }
 
     @Test
     public void testDispatchOnExposureCorrectionChanged() {
-        doAnswer(completeTask()).when(listener).onExposureCorrectionChanged(0f, null, null);
-        callbacks.dispatchOnExposureCorrectionChanged(0f, null, null);
+        completeTask().when(listener).onExposureCorrectionChanged(0f, null, null);
+        camera.mCameraCallbacks.dispatchOnExposureCorrectionChanged(0f, null, null);
 
         assertNotNull(task.await(200));
         verify(listener, times(1)).onExposureCorrectionChanged(0f, null, null);
@@ -174,8 +167,8 @@ public void testDispatchOnFocusStart() {
         camera.mapGesture(Gesture.TAP, GestureAction.FOCUS_WITH_MARKER);
 
         PointF point = new PointF();
-        doAnswer(completeTask()).when(listener).onFocusStart(point);
-        callbacks.dispatchOnFocusStart(Gesture.TAP, point);
+        completeTask().when(listener).onFocusStart(point);
+        camera.mCameraCallbacks.dispatchOnFocusStart(Gesture.TAP, point);
 
         assertNotNull(task.await(200));
         verify(listener, times(1)).onFocusStart(point);
@@ -190,8 +183,8 @@ public void testDispatchOnFocusEnd() {
 
         PointF point = new PointF();
         boolean success = true;
-        doAnswer(completeTask()).when(listener).onFocusEnd(success, point);
-        callbacks.dispatchOnFocusEnd(Gesture.TAP, success, point);
+        completeTask().when(listener).onFocusEnd(success, point);
+        camera.mCameraCallbacks.dispatchOnFocusEnd(Gesture.TAP, success, point);
 
         assertNotNull(task.await(200));
         verify(listener, times(1)).onFocusEnd(success, point);
@@ -200,31 +193,31 @@ public void testDispatchOnFocusEnd() {
 
     @Test
     public void testOrientationCallbacks_deviceOnly() {
-        doAnswer(completeTask()).when(listener).onOrientationChanged(anyInt());
+        completeTask().when(listener).onOrientationChanged(anyInt());
 
         // Assert not called. Both methods must be called.
-        callbacks.onDeviceOrientationChanged(0);
+        camera.mCameraCallbacks.onDeviceOrientationChanged(0);
         assertNull(task.await(200));
         verify(listener, never()).onOrientationChanged(anyInt());
     }
 
     @Test
     public void testOrientationCallbacks_displayOnly() {
-        doAnswer(completeTask()).when(listener).onOrientationChanged(anyInt());
+        completeTask().when(listener).onOrientationChanged(anyInt());
 
         // Assert not called. Both methods must be called.
-        callbacks.onDisplayOffsetChanged(0);
+        camera.mCameraCallbacks.onDisplayOffsetChanged(0);
         assertNull(task.await(200));
         verify(listener, never()).onOrientationChanged(anyInt());
     }
 
     @Test
     public void testOrientationCallbacks_both() {
-        doAnswer(completeTask()).when(listener).onOrientationChanged(anyInt());
+        completeTask().when(listener).onOrientationChanged(anyInt());
 
         // Assert called.
-        callbacks.onDisplayOffsetChanged(0);
-        callbacks.onDeviceOrientationChanged(90);
+        camera.mCameraCallbacks.onDisplayOffsetChanged(0);
+        camera.mCameraCallbacks.onDeviceOrientationChanged(90);
         assertNotNull(task.await(200));
         verify(listener, times(1)).onOrientationChanged(anyInt());
     }
@@ -290,9 +283,9 @@ public Object answer(InvocationOnMock invocation) throws Throwable {
 
         // Create fake JPEG array and trigger the process.
         if (jpeg) {
-            callbacks.processImage(mockJpeg(imageDim[0], imageDim[1]), true, false);
+            camera.mCameraCallbacks.processImage(mockJpeg(imageDim[0], imageDim[1]), true, false);
         } else {
-            callbacks.processSnapshot(mockYuv(imageDim[0], imageDim[1]), true, false);
+            camera.mCameraCallbacks.processSnapshot(mockYuv(imageDim[0], imageDim[1]), true, false);
         }
 
         // Wait for result and get out dimensions.

cameraview/src/androidTest/java/com/otaliastudios/cameraview/CameraViewTest.java

@@ -26,7 +26,7 @@ public class CameraViewTest extends BaseTest {
 
     private CameraView cameraView;
     private MockCameraController mockController;
-    private Preview mockPreview;
+    private CameraPreview mockPreview;
     private boolean hasPermissions;
 
     @Before
@@ -37,14 +37,14 @@ public void run() {
                 Context context = context();
                 cameraView = new CameraView(context) {
                     @Override
-                    protected CameraController instantiateCameraController(CameraCallbacks callbacks, Preview preview) {
-                        mockController = new MockCameraController(callbacks, preview);
+                    protected CameraController instantiateCameraController(CameraCallbacks callbacks) {
+                        mockController = new MockCameraController(callbacks);
                         return mockController;
                     }
 
                     @Override
-                    protected Preview instantiatePreview(Context context, ViewGroup container) {
-                        mockPreview = new MockPreview(context, container);
+                    protected CameraPreview instantiatePreview(Context context, ViewGroup container) {
+                        mockPreview = new MockCameraPreview(context, container);
                         return mockPreview;
                     }
 
@@ -53,6 +53,8 @@ protected boolean checkPermissions(SessionType sessionType, Audio audio) {
                         return hasPermissions;
                     }
                 };
+                // Instantiate preview now.
+                cameraView.instantiatePreview();
             }
         });
     }

cameraview/src/androidTest/java/com/otaliastudios/cameraview/IntegrationTest.java

@@ -56,8 +56,8 @@ public void setUp() {
             public void run() {
                 camera = new CameraView(rule.getActivity()) {
                     @Override
-                    protected CameraController instantiateCameraController(CameraCallbacks callbacks, Preview preview) {
-                        controller = new Camera1(callbacks, preview);
+                    protected CameraController instantiateCameraController(CameraCallbacks callbacks) {
+                        controller = new Camera1(callbacks);
                         return controller;
                     }
                 };

cameraview/src/androidTest/java/com/otaliastudios/cameraview/MockCameraController.java

@@ -15,8 +15,8 @@ public class MockCameraController extends CameraController {
     boolean mZoomChanged;
     boolean mExposureCorrectionChanged;
 
-    MockCameraController(CameraView.CameraCallbacks callback, Preview preview) {
-        super(callback, preview);
+    MockCameraController(CameraView.CameraCallbacks callback) {
+        super(callback);
     }
 
     void setMockCameraOptions(CameraOptions options) {

…taliastudios/cameraview/MockPreview.java …tudios/cameraview/MockCameraPreview.javacameraview/src/androidTest/java/com/otaliastudios/cameraview/MockPreview.java renamed to cameraview/src/androidTest/java/com/otaliastudios/cameraview/MockCameraPreview.java cameraview/src/androidTest/java/com/otaliastudios/cameraview/MockPreview.java renamed to cameraview/src/androidTest/java/com/otaliastudios/cameraview/MockCameraPreview.java

@@ -7,15 +7,21 @@
 import android.view.View;
 import android.view.ViewGroup;
 
-public class MockPreview extends Preview<View, Void> {
+public class MockCameraPreview extends CameraPreview<View, Void> {
 
-    MockPreview(Context context, ViewGroup parent) {
+    MockCameraPreview(Context context, ViewGroup parent) {
         super(context, parent, null);
     }
 
+    private boolean mCropping = false;
+
     public void setIsCropping(boolean crop) {
-        getView().setScaleX(crop ? 2 : 1);
-        getView().setScaleY(crop ? 2 : 1);
+        mCropping = crop;
+    }
+
+    @Override
+    boolean isCropping() {
+        return mCropping;
     }
 
     @NonNull

cameraview/src/androidTest/java/com/otaliastudios/cameraview/PreviewTest.java

@@ -19,14 +19,14 @@
 
 public abstract class PreviewTest extends BaseTest {
 
-    protected abstract Preview createPreview(Context context, ViewGroup parent, Preview.SurfaceCallback callback);
+    protected abstract CameraPreview createPreview(Context context, ViewGroup parent, CameraPreview.SurfaceCallback callback);
 
     @Rule
     public ActivityTestRule<TestActivity> rule = new ActivityTestRule<>(TestActivity.class);
 
-    protected Preview preview;
+    protected CameraPreview preview;
     protected Size surfaceSize;
-    private Preview.SurfaceCallback callback;
+    private CameraPreview.SurfaceCallback callback;
     private Task<Boolean> availability;
 
     @Before
@@ -40,7 +40,7 @@ public void run() {
                 TestActivity a = rule.getActivity();
                 surfaceSize = a.getContentSize();
 
-                callback = mock(Preview.SurfaceCallback.class);
+                callback = mock(CameraPreview.SurfaceCallback.class);
                 doAnswer(new Answer() {
                     @Override
                     public Object answer(InvocationOnMock invocation) throws Throwable {
@@ -121,8 +121,10 @@ public void testCropCenter() throws Exception {
 
         // If we apply a different aspect ratio, there should be cropping.
         float desired = view * 1.2f;
-        setDesiredAspectRatio(desired);
-        assertTrue(preview.isCropping());
+        if (preview.supportsCropping()) {
+            setDesiredAspectRatio(desired);
+            assertTrue(preview.isCropping());
+        }
 
         // Since desired is 'desired', let's fake a new view size that is consistent with it.
         // Ensure crop is not happening anymore.