CameraBinderDecorator.java revision 6462be7fa0234ca1a285f4f40089f9be1fed8316
1e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin/* 2e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * Copyright (C) 2013 The Android Open Source Project 3e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * 4e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * Licensed under the Apache License, Version 2.0 (the "License"); 5e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * you may not use this file except in compliance with the License. 6e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * You may obtain a copy of the License at 7e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * 8e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * http://www.apache.org/licenses/LICENSE-2.0 9e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * 10e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * Unless required by applicable law or agreed to in writing, software 11e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * distributed under the License is distributed on an "AS IS" BASIS, 12e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * See the License for the specific language governing permissions and 14e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * limitations under the License. 15e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin */ 16e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 172f1a2e423e0fbb64467d6fcfa4e82c6384f31210Eino-Ville Talvalapackage android.hardware.camera2.utils; 18e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 192f1a2e423e0fbb64467d6fcfa4e82c6384f31210Eino-Ville Talvalaimport static android.hardware.camera2.CameraAccessException.CAMERA_DISABLED; 202f1a2e423e0fbb64467d6fcfa4e82c6384f31210Eino-Ville Talvalaimport static android.hardware.camera2.CameraAccessException.CAMERA_DISCONNECTED; 212f1a2e423e0fbb64467d6fcfa4e82c6384f31210Eino-Ville Talvalaimport static android.hardware.camera2.CameraAccessException.CAMERA_IN_USE; 2266ef64514464a1bb9c7931993cc8db3d7539f39aRuben Brunkimport static android.hardware.camera2.CameraAccessException.CAMERA_DEPRECATED_HAL; 23e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 24e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkinimport android.os.DeadObjectException; 25e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkinimport android.os.RemoteException; 26e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 27e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkinimport java.lang.reflect.Method; 28e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 29e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin/** 30e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * Translate camera service status_t return values into exceptions. 31e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * 322f1a2e423e0fbb64467d6fcfa4e82c6384f31210Eino-Ville Talvala * @see android.hardware.camera2.utils.CameraBinderDecorator#newInstance 33e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * @hide 34e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin */ 35e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkinpublic class CameraBinderDecorator { 36e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 37e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin public static final int NO_ERROR = 0; 38e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin public static final int PERMISSION_DENIED = -1; 39e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin public static final int ALREADY_EXISTS = -17; 40e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin public static final int BAD_VALUE = -22; 41e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin public static final int DEAD_OBJECT = -32; 42e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 43e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin /** 44e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * TODO: add as error codes in Errors.h 45e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * - POLICY_PROHIBITS 46e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * - RESOURCE_BUSY 47e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * - NO_SUCH_DEVICE 48e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin */ 49e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin public static final int EACCES = -13; 50e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin public static final int EBUSY = -16; 51e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin public static final int ENODEV = -19; 526462be7fa0234ca1a285f4f40089f9be1fed8316Ruben Brunk public static final int EOPNOTSUPP = -95; 53e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 54e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin private static class CameraBinderDecoratorListener implements Decorator.DecoratorListener { 55e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 56e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin @Override 57e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin public void onBeforeInvocation(Method m, Object[] args) { 58e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin } 59e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 60e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin @Override 61e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin public void onAfterInvocation(Method m, Object[] args, Object result) { 62e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin // int return type => status_t => convert to exception 63e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin if (m.getReturnType() == Integer.TYPE) { 64e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin int returnValue = (Integer) result; 65e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 66e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin switch (returnValue) { 67e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin case NO_ERROR: 68e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin return; 69e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin case PERMISSION_DENIED: 70e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin throw new SecurityException("Lacking privileges to access camera service"); 71e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin case ALREADY_EXISTS: 7270725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin // This should be handled at the call site. Typically this isn't bad, 7370725500dcf3b666b43d50563d64705aab58d2d3Igor Murashkin // just means we tried to do an operation that already completed. 74e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin return; 75e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin case BAD_VALUE: 76e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin throw new IllegalArgumentException("Bad argument passed to camera service"); 77e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin case DEAD_OBJECT: 78e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin UncheckedThrow.throwAnyException(new CameraRuntimeException( 79e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin CAMERA_DISCONNECTED)); 80e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin case EACCES: 81e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin UncheckedThrow.throwAnyException(new CameraRuntimeException( 82e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin CAMERA_DISABLED)); 83e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin case EBUSY: 84e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin UncheckedThrow.throwAnyException(new CameraRuntimeException( 85e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin CAMERA_IN_USE)); 86e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin case ENODEV: 87e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin UncheckedThrow.throwAnyException(new CameraRuntimeException( 88e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin CAMERA_DISCONNECTED)); 896462be7fa0234ca1a285f4f40089f9be1fed8316Ruben Brunk case EOPNOTSUPP: 9066ef64514464a1bb9c7931993cc8db3d7539f39aRuben Brunk UncheckedThrow.throwAnyException(new CameraRuntimeException( 9166ef64514464a1bb9c7931993cc8db3d7539f39aRuben Brunk CAMERA_DEPRECATED_HAL)); 92e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin } 93e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 94e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin /** 95e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * Trap the rest of the negative return values. If we have known 96e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * error codes i.e. ALREADY_EXISTS that aren't really runtime 97e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * errors, then add them to the top switch statement 98e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin */ 99e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin if (returnValue < 0) { 100e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin throw new UnsupportedOperationException(String.format("Unknown error %d", 101e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin returnValue)); 102e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin } 103e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin } 104e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin } 105e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 106e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin @Override 107e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin public boolean onCatchException(Method m, Object[] args, Throwable t) { 108e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 109e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin if (t instanceof DeadObjectException) { 110e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin UncheckedThrow.throwAnyException(new CameraRuntimeException( 111e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin CAMERA_DISCONNECTED, 112e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin "Process hosting the camera service has died unexpectedly", 113e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin t)); 114e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin } else if (t instanceof RemoteException) { 115e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin throw new UnsupportedOperationException("An unknown RemoteException was thrown" + 116e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin " which should never happen.", t); 117e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin } 118e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 119e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin return false; 120e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin } 121e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 122e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin @Override 123e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin public void onFinally(Method m, Object[] args) { 124e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin } 125e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 126e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin } 127e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 128e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin /** 129e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * <p> 130e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * Wraps the type T with a proxy that will check 'status_t' return codes 131e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * from the native side of the camera service, and throw Java exceptions 132e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * automatically based on the code. 133e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * </p> 134e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * <p> 135e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * In addition it also rewrites binder's RemoteException into either a 136e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * CameraAccessException or an UnsupportedOperationException. 137e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * </p> 138e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * <p> 139e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * As a result of calling any method on the proxy, RemoteException is 140e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * guaranteed never to be thrown. 141e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * </p> 142e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * 143e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * @param obj object that will serve as the target for all method calls 144e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * @param <T> the type of the element you want to wrap. This must be an interface. 145e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * @return a proxy that will intercept all invocations to obj 146e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin */ 147e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin public static <T> T newInstance(T obj) { 148e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin return Decorator.<T> newInstance(obj, new CameraBinderDecoratorListener()); 149e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin } 150e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin} 151