CameraBinderDecorator.java revision bd9b106806f9792be210cc2d9848d8b1f4b9664d
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; 2268ebc1a7b4c18d587612891250f17f36edfe1bc1Zhijun Heimport static android.hardware.camera2.CameraAccessException.MAX_CAMERAS_IN_USE; 2366ef64514464a1bb9c7931993cc8db3d7539f39aRuben Brunkimport static android.hardware.camera2.CameraAccessException.CAMERA_DEPRECATED_HAL; 24e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 25e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkinimport android.os.DeadObjectException; 26e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkinimport android.os.RemoteException; 27e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 28e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkinimport java.lang.reflect.Method; 29e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 30e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin/** 31bd9b106806f9792be210cc2d9848d8b1f4b9664dEino-Ville Talvala * Translate camera device status_t return values into exceptions. 32e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * 332f1a2e423e0fbb64467d6fcfa4e82c6384f31210Eino-Ville Talvala * @see android.hardware.camera2.utils.CameraBinderDecorator#newInstance 34e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * @hide 35e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin */ 36e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkinpublic class CameraBinderDecorator { 37e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 38e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin public static final int NO_ERROR = 0; 39e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin public static final int PERMISSION_DENIED = -1; 40e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin public static final int ALREADY_EXISTS = -17; 41e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin public static final int BAD_VALUE = -22; 42e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin public static final int DEAD_OBJECT = -32; 43feb50af361e4305a25758966b6b5df2738c00259Ruben Brunk public static final int INVALID_OPERATION = -38; 44e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 45e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin /** 46e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * TODO: add as error codes in Errors.h 47e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * - POLICY_PROHIBITS 48e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * - RESOURCE_BUSY 49e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * - NO_SUCH_DEVICE 504961bc88d7bab869a5296789d26fcfa31ad5f644Igor Murashkin * - NOT_SUPPORTED 514961bc88d7bab869a5296789d26fcfa31ad5f644Igor Murashkin * - TOO_MANY_USERS 52e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin */ 53e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin public static final int EACCES = -13; 54e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin public static final int EBUSY = -16; 55e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin public static final int ENODEV = -19; 566462be7fa0234ca1a285f4f40089f9be1fed8316Ruben Brunk public static final int EOPNOTSUPP = -95; 579bd5f1e6dff31e2299c065157ba3a43bc79a9d48Zhijun He public static final int EUSERS = -87; 58e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 59feb50af361e4305a25758966b6b5df2738c00259Ruben Brunk 60bd9b106806f9792be210cc2d9848d8b1f4b9664dEino-Ville Talvala static class CameraBinderDecoratorListener implements Decorator.DecoratorListener { 61e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 62e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin @Override 63e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin public void onBeforeInvocation(Method m, Object[] args) { 64e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin } 65e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 66e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin @Override 67e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin public void onAfterInvocation(Method m, Object[] args, Object result) { 68e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin // int return type => status_t => convert to exception 69e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin if (m.getReturnType() == Integer.TYPE) { 70e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin int returnValue = (Integer) result; 7185c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk throwOnError(returnValue); 72e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin } 73e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin } 74e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 75e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin @Override 76e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin public boolean onCatchException(Method m, Object[] args, Throwable t) { 77e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 78e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin if (t instanceof DeadObjectException) { 79bd9b106806f9792be210cc2d9848d8b1f4b9664dEino-Ville Talvala throw new CameraRuntimeException(CAMERA_DISCONNECTED, 80e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin "Process hosting the camera service has died unexpectedly", 81bd9b106806f9792be210cc2d9848d8b1f4b9664dEino-Ville Talvala t); 82e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin } else if (t instanceof RemoteException) { 83e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin throw new UnsupportedOperationException("An unknown RemoteException was thrown" + 84e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin " which should never happen.", t); 85e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin } 86e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 87e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin return false; 88e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin } 89e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 90e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin @Override 91e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin public void onFinally(Method m, Object[] args) { 92e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin } 93e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 94e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin } 95e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin 96e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin /** 9785c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk * Throw error codes returned by the camera service as exceptions. 9885c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk * 9985c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk * @param errorFlag error to throw as an exception. 10085c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk */ 10185c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk public static void throwOnError(int errorFlag) { 10285c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk switch (errorFlag) { 10385c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk case NO_ERROR: 10485c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk return; 10585c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk case PERMISSION_DENIED: 10685c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk throw new SecurityException("Lacking privileges to access camera service"); 10785c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk case ALREADY_EXISTS: 10885c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk // This should be handled at the call site. Typically this isn't bad, 10985c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk // just means we tried to do an operation that already completed. 11085c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk return; 11185c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk case BAD_VALUE: 11285c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk throw new IllegalArgumentException("Bad argument passed to camera service"); 11385c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk case DEAD_OBJECT: 114bd9b106806f9792be210cc2d9848d8b1f4b9664dEino-Ville Talvala throw new CameraRuntimeException(CAMERA_DISCONNECTED); 11585c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk case EACCES: 116bd9b106806f9792be210cc2d9848d8b1f4b9664dEino-Ville Talvala throw new CameraRuntimeException(CAMERA_DISABLED); 11785c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk case EBUSY: 118bd9b106806f9792be210cc2d9848d8b1f4b9664dEino-Ville Talvala throw new CameraRuntimeException(CAMERA_IN_USE); 11985c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk case EUSERS: 120bd9b106806f9792be210cc2d9848d8b1f4b9664dEino-Ville Talvala throw new CameraRuntimeException(MAX_CAMERAS_IN_USE); 12185c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk case ENODEV: 122bd9b106806f9792be210cc2d9848d8b1f4b9664dEino-Ville Talvala throw new CameraRuntimeException(CAMERA_DISCONNECTED); 12385c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk case EOPNOTSUPP: 124bd9b106806f9792be210cc2d9848d8b1f4b9664dEino-Ville Talvala throw new CameraRuntimeException(CAMERA_DEPRECATED_HAL); 125feb50af361e4305a25758966b6b5df2738c00259Ruben Brunk case INVALID_OPERATION: 126bd9b106806f9792be210cc2d9848d8b1f4b9664dEino-Ville Talvala throw new IllegalStateException( 127bd9b106806f9792be210cc2d9848d8b1f4b9664dEino-Ville Talvala "Illegal state encountered in camera service."); 12885c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk } 12985c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk 13085c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk /** 13185c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk * Trap the rest of the negative return values. If we have known 13285c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk * error codes i.e. ALREADY_EXISTS that aren't really runtime 13385c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk * errors, then add them to the top switch statement 13485c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk */ 13585c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk if (errorFlag < 0) { 13685c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk throw new UnsupportedOperationException(String.format("Unknown error %d", 13785c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk errorFlag)); 13885c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk } 13985c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk } 14085c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk 14185c4388de1fea3d45783f07895c2b113c4cc1ba5Ruben Brunk /** 142e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * <p> 143e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * Wraps the type T with a proxy that will check 'status_t' return codes 144e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * from the native side of the camera service, and throw Java exceptions 145e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * automatically based on the code. 146e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * </p> 147e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * <p> 148e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * In addition it also rewrites binder's RemoteException into either a 149e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * CameraAccessException or an UnsupportedOperationException. 150e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * </p> 151e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * <p> 152e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * As a result of calling any method on the proxy, RemoteException is 153e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * guaranteed never to be thrown. 154e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * </p> 155e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * 156e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * @param obj object that will serve as the target for all method calls 157e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * @param <T> the type of the element you want to wrap. This must be an interface. 158e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin * @return a proxy that will intercept all invocations to obj 159e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin */ 160e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin public static <T> T newInstance(T obj) { 161e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin return Decorator.<T> newInstance(obj, new CameraBinderDecoratorListener()); 162e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin } 163e363fbb2647aeb5ef4c87160d84c6b9ae8d45598Igor Murashkin} 164