Camera.java revision e059e45b053454deb1044123a5a65ba725fb952c
1/* 2 * Copyright (C) 2008 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17package android.hardware; 18 19import static android.system.OsConstants.*; 20 21import android.annotation.Nullable; 22import android.annotation.SdkConstant; 23import android.annotation.SdkConstant.SdkConstantType; 24import android.app.ActivityThread; 25import android.app.AppOpsManager; 26import android.content.Context; 27import android.graphics.ImageFormat; 28import android.graphics.Point; 29import android.graphics.Rect; 30import android.graphics.SurfaceTexture; 31import android.media.AudioAttributes; 32import android.media.IAudioService; 33import android.os.Handler; 34import android.os.IBinder; 35import android.os.Looper; 36import android.os.Message; 37import android.os.Process; 38import android.os.RemoteException; 39import android.os.ServiceManager; 40import android.renderscript.Allocation; 41import android.renderscript.Element; 42import android.renderscript.RSIllegalArgumentException; 43import android.renderscript.RenderScript; 44import android.renderscript.Type; 45import android.text.TextUtils; 46import android.util.Log; 47import android.view.Surface; 48import android.view.SurfaceHolder; 49 50import com.android.internal.annotations.GuardedBy; 51import com.android.internal.app.IAppOpsCallback; 52import com.android.internal.app.IAppOpsService; 53 54import java.io.IOException; 55import java.lang.ref.WeakReference; 56import java.util.ArrayList; 57import java.util.LinkedHashMap; 58import java.util.List; 59 60/** 61 * The Camera class is used to set image capture settings, start/stop preview, 62 * snap pictures, and retrieve frames for encoding for video. This class is a 63 * client for the Camera service, which manages the actual camera hardware. 64 * 65 * <p>To access the device camera, you must declare the 66 * {@link android.Manifest.permission#CAMERA} permission in your Android 67 * Manifest. Also be sure to include the 68 * <a href="{@docRoot}guide/topics/manifest/uses-feature-element.html"><uses-feature></a> 69 * manifest element to declare camera features used by your application. 70 * For example, if you use the camera and auto-focus feature, your Manifest 71 * should include the following:</p> 72 * <pre> <uses-permission android:name="android.permission.CAMERA" /> 73 * <uses-feature android:name="android.hardware.camera" /> 74 * <uses-feature android:name="android.hardware.camera.autofocus" /></pre> 75 * 76 * <p>To take pictures with this class, use the following steps:</p> 77 * 78 * <ol> 79 * <li>Obtain an instance of Camera from {@link #open(int)}. 80 * 81 * <li>Get existing (default) settings with {@link #getParameters()}. 82 * 83 * <li>If necessary, modify the returned {@link Camera.Parameters} object and call 84 * {@link #setParameters(Camera.Parameters)}. 85 * 86 * <li>Call {@link #setDisplayOrientation(int)} to ensure correct orientation of preview. 87 * 88 * <li><b>Important</b>: Pass a fully initialized {@link SurfaceHolder} to 89 * {@link #setPreviewDisplay(SurfaceHolder)}. Without a surface, the camera 90 * will be unable to start the preview. 91 * 92 * <li><b>Important</b>: Call {@link #startPreview()} to start updating the 93 * preview surface. Preview must be started before you can take a picture. 94 * 95 * <li>When you want, call {@link #takePicture(Camera.ShutterCallback, 96 * Camera.PictureCallback, Camera.PictureCallback, Camera.PictureCallback)} to 97 * capture a photo. Wait for the callbacks to provide the actual image data. 98 * 99 * <li>After taking a picture, preview display will have stopped. To take more 100 * photos, call {@link #startPreview()} again first. 101 * 102 * <li>Call {@link #stopPreview()} to stop updating the preview surface. 103 * 104 * <li><b>Important:</b> Call {@link #release()} to release the camera for 105 * use by other applications. Applications should release the camera 106 * immediately in {@link android.app.Activity#onPause()} (and re-{@link #open()} 107 * it in {@link android.app.Activity#onResume()}). 108 * </ol> 109 * 110 * <p>To quickly switch to video recording mode, use these steps:</p> 111 * 112 * <ol> 113 * <li>Obtain and initialize a Camera and start preview as described above. 114 * 115 * <li>Call {@link #unlock()} to allow the media process to access the camera. 116 * 117 * <li>Pass the camera to {@link android.media.MediaRecorder#setCamera(Camera)}. 118 * See {@link android.media.MediaRecorder} information about video recording. 119 * 120 * <li>When finished recording, call {@link #reconnect()} to re-acquire 121 * and re-lock the camera. 122 * 123 * <li>If desired, restart preview and take more photos or videos. 124 * 125 * <li>Call {@link #stopPreview()} and {@link #release()} as described above. 126 * </ol> 127 * 128 * <p>This class is not thread-safe, and is meant for use from one event thread. 129 * Most long-running operations (preview, focus, photo capture, etc) happen 130 * asynchronously and invoke callbacks as necessary. Callbacks will be invoked 131 * on the event thread {@link #open(int)} was called from. This class's methods 132 * must never be called from multiple threads at once.</p> 133 * 134 * <p class="caution"><strong>Caution:</strong> Different Android-powered devices 135 * may have different hardware specifications, such as megapixel ratings and 136 * auto-focus capabilities. In order for your application to be compatible with 137 * more devices, you should not make assumptions about the device camera 138 * specifications.</p> 139 * 140 * <div class="special reference"> 141 * <h3>Developer Guides</h3> 142 * <p>For more information about using cameras, read the 143 * <a href="{@docRoot}guide/topics/media/camera.html">Camera</a> developer guide.</p> 144 * </div> 145 * 146 * @deprecated We recommend using the new {@link android.hardware.camera2} API for new 147 * applications. 148 */ 149@Deprecated 150public class Camera { 151 private static final String TAG = "Camera"; 152 153 // These match the enums in frameworks/base/include/camera/Camera.h 154 private static final int CAMERA_MSG_ERROR = 0x001; 155 private static final int CAMERA_MSG_SHUTTER = 0x002; 156 private static final int CAMERA_MSG_FOCUS = 0x004; 157 private static final int CAMERA_MSG_ZOOM = 0x008; 158 private static final int CAMERA_MSG_PREVIEW_FRAME = 0x010; 159 private static final int CAMERA_MSG_VIDEO_FRAME = 0x020; 160 private static final int CAMERA_MSG_POSTVIEW_FRAME = 0x040; 161 private static final int CAMERA_MSG_RAW_IMAGE = 0x080; 162 private static final int CAMERA_MSG_COMPRESSED_IMAGE = 0x100; 163 private static final int CAMERA_MSG_RAW_IMAGE_NOTIFY = 0x200; 164 private static final int CAMERA_MSG_PREVIEW_METADATA = 0x400; 165 private static final int CAMERA_MSG_FOCUS_MOVE = 0x800; 166 167 private long mNativeContext; // accessed by native methods 168 private EventHandler mEventHandler; 169 private ShutterCallback mShutterCallback; 170 private PictureCallback mRawImageCallback; 171 private PictureCallback mJpegCallback; 172 private PreviewCallback mPreviewCallback; 173 private boolean mUsingPreviewAllocation; 174 private PictureCallback mPostviewCallback; 175 private AutoFocusCallback mAutoFocusCallback; 176 private AutoFocusMoveCallback mAutoFocusMoveCallback; 177 private OnZoomChangeListener mZoomListener; 178 private FaceDetectionListener mFaceListener; 179 private ErrorCallback mErrorCallback; 180 private boolean mOneShot; 181 private boolean mWithBuffer; 182 private boolean mFaceDetectionRunning = false; 183 private final Object mAutoFocusCallbackLock = new Object(); 184 185 private final Object mShutterSoundLock = new Object(); 186 // for AppOps 187 private @Nullable IAppOpsService mAppOps; 188 private IAppOpsCallback mAppOpsCallback; 189 @GuardedBy("mShutterSoundLock") 190 private boolean mHasAppOpsPlayAudio = true; 191 @GuardedBy("mShutterSoundLock") 192 private boolean mShutterSoundEnabledFromApp = true; 193 194 private static final int NO_ERROR = 0; 195 196 /** 197 * Broadcast Action: A new picture is taken by the camera, and the entry of 198 * the picture has been added to the media store. 199 * {@link android.content.Intent#getData} is URI of the picture. 200 * 201 * <p>In {@link android.os.Build.VERSION_CODES#N Android N} this broadcast was removed, and 202 * applications are recommended to use 203 * {@link android.app.job.JobInfo.Builder JobInfo.Builder}.{@link android.app.job.JobInfo.Builder#addTriggerContentUri} 204 * instead.</p> 205 * 206 * <p>In {@link android.os.Build.VERSION_CODES#O Android O} this broadcast has been brought 207 * back, but only for <em>registered</em> receivers. Apps that are actively running can 208 * again listen to the broadcast if they want an immediate clear signal about a picture 209 * being taken, however anything doing heavy work (or needing to be launched) as a result of 210 * this should still use JobScheduler.</p> 211 */ 212 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) 213 public static final String ACTION_NEW_PICTURE = "android.hardware.action.NEW_PICTURE"; 214 215 /** 216 * Broadcast Action: A new video is recorded by the camera, and the entry 217 * of the video has been added to the media store. 218 * {@link android.content.Intent#getData} is URI of the video. 219 * 220 * <p>In {@link android.os.Build.VERSION_CODES#N Android N} this broadcast was removed, and 221 * applications are recommended to use 222 * {@link android.app.job.JobInfo.Builder JobInfo.Builder}.{@link android.app.job.JobInfo.Builder#addTriggerContentUri} 223 * instead.</p> 224 * 225 * <p>In {@link android.os.Build.VERSION_CODES#O Android O} this broadcast has been brought 226 * back, but only for <em>registered</em> receivers. Apps that are actively running can 227 * again listen to the broadcast if they want an immediate clear signal about a video 228 * being taken, however anything doing heavy work (or needing to be launched) as a result of 229 * this should still use JobScheduler.</p> 230 */ 231 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) 232 public static final String ACTION_NEW_VIDEO = "android.hardware.action.NEW_VIDEO"; 233 234 /** 235 * Camera HAL device API version 1.0 236 * @hide 237 */ 238 public static final int CAMERA_HAL_API_VERSION_1_0 = 0x100; 239 240 /** 241 * A constant meaning the normal camera connect/open will be used. 242 */ 243 private static final int CAMERA_HAL_API_VERSION_NORMAL_CONNECT = -2; 244 245 /** 246 * Used to indicate HAL version un-specified. 247 */ 248 private static final int CAMERA_HAL_API_VERSION_UNSPECIFIED = -1; 249 250 /** 251 * Hardware face detection. It does not use much CPU. 252 */ 253 private static final int CAMERA_FACE_DETECTION_HW = 0; 254 255 /** 256 * Software face detection. It uses some CPU. 257 */ 258 private static final int CAMERA_FACE_DETECTION_SW = 1; 259 260 /** 261 * Returns the number of physical cameras available on this device. 262 * The return value of this method might change dynamically if the device 263 * supports external cameras and an external camera is connected or 264 * disconnected. 265 * 266 * @return total number of accessible camera devices, or 0 if there are no 267 * cameras or an error was encountered enumerating them. 268 */ 269 public native static int getNumberOfCameras(); 270 271 /** 272 * Returns the information about a particular camera. 273 * If {@link #getNumberOfCameras()} returns N, the valid id is 0 to N-1. 274 * 275 * @throws RuntimeException if an invalid ID is provided, or if there is an 276 * error retrieving the information (generally due to a hardware or other 277 * low-level failure). 278 */ 279 public static void getCameraInfo(int cameraId, CameraInfo cameraInfo) { 280 _getCameraInfo(cameraId, cameraInfo); 281 IBinder b = ServiceManager.getService(Context.AUDIO_SERVICE); 282 IAudioService audioService = IAudioService.Stub.asInterface(b); 283 try { 284 if (audioService.isCameraSoundForced()) { 285 // Only set this when sound is forced; otherwise let native code 286 // decide. 287 cameraInfo.canDisableShutterSound = false; 288 } 289 } catch (RemoteException e) { 290 Log.e(TAG, "Audio service is unavailable for queries"); 291 } 292 } 293 private native static void _getCameraInfo(int cameraId, CameraInfo cameraInfo); 294 295 /** 296 * Information about a camera 297 * 298 * @deprecated We recommend using the new {@link android.hardware.camera2} API for new 299 * applications. 300 */ 301 @Deprecated 302 public static class CameraInfo { 303 /** 304 * The facing of the camera is opposite to that of the screen. 305 */ 306 public static final int CAMERA_FACING_BACK = 0; 307 308 /** 309 * The facing of the camera is the same as that of the screen. 310 */ 311 public static final int CAMERA_FACING_FRONT = 1; 312 313 /** 314 * The direction that the camera faces. It should be 315 * CAMERA_FACING_BACK or CAMERA_FACING_FRONT. 316 */ 317 public int facing; 318 319 /** 320 * <p>The orientation of the camera image. The value is the angle that the 321 * camera image needs to be rotated clockwise so it shows correctly on 322 * the display in its natural orientation. It should be 0, 90, 180, or 270.</p> 323 * 324 * <p>For example, suppose a device has a naturally tall screen. The 325 * back-facing camera sensor is mounted in landscape. You are looking at 326 * the screen. If the top side of the camera sensor is aligned with the 327 * right edge of the screen in natural orientation, the value should be 328 * 90. If the top side of a front-facing camera sensor is aligned with 329 * the right of the screen, the value should be 270.</p> 330 * 331 * @see #setDisplayOrientation(int) 332 * @see Parameters#setRotation(int) 333 * @see Parameters#setPreviewSize(int, int) 334 * @see Parameters#setPictureSize(int, int) 335 * @see Parameters#setJpegThumbnailSize(int, int) 336 */ 337 public int orientation; 338 339 /** 340 * <p>Whether the shutter sound can be disabled.</p> 341 * 342 * <p>On some devices, the camera shutter sound cannot be turned off 343 * through {@link #enableShutterSound enableShutterSound}. This field 344 * can be used to determine whether a call to disable the shutter sound 345 * will succeed.</p> 346 * 347 * <p>If this field is set to true, then a call of 348 * {@code enableShutterSound(false)} will be successful. If set to 349 * false, then that call will fail, and the shutter sound will be played 350 * when {@link Camera#takePicture takePicture} is called.</p> 351 */ 352 public boolean canDisableShutterSound; 353 }; 354 355 /** 356 * Creates a new Camera object to access a particular hardware camera. If 357 * the same camera is opened by other applications, this will throw a 358 * RuntimeException. 359 * 360 * <p>You must call {@link #release()} when you are done using the camera, 361 * otherwise it will remain locked and be unavailable to other applications. 362 * 363 * <p>Your application should only have one Camera object active at a time 364 * for a particular hardware camera. 365 * 366 * <p>Callbacks from other methods are delivered to the event loop of the 367 * thread which called open(). If this thread has no event loop, then 368 * callbacks are delivered to the main application event loop. If there 369 * is no main application event loop, callbacks are not delivered. 370 * 371 * <p class="caution"><b>Caution:</b> On some devices, this method may 372 * take a long time to complete. It is best to call this method from a 373 * worker thread (possibly using {@link android.os.AsyncTask}) to avoid 374 * blocking the main application UI thread. 375 * 376 * @param cameraId the hardware camera to access, between 0 and 377 * {@link #getNumberOfCameras()}-1. 378 * @return a new Camera object, connected, locked and ready for use. 379 * @throws RuntimeException if opening the camera fails (for example, if the 380 * camera is in use by another process or device policy manager has 381 * disabled the camera). 382 * @see android.app.admin.DevicePolicyManager#getCameraDisabled(android.content.ComponentName) 383 */ 384 public static Camera open(int cameraId) { 385 return new Camera(cameraId); 386 } 387 388 /** 389 * Creates a new Camera object to access the first back-facing camera on the 390 * device. If the device does not have a back-facing camera, this returns 391 * null. Otherwise acts like the {@link #open(int)} call. 392 * 393 * @return a new Camera object for the first back-facing camera, or null if there is no 394 * backfacing camera 395 * @see #open(int) 396 */ 397 public static Camera open() { 398 int numberOfCameras = getNumberOfCameras(); 399 CameraInfo cameraInfo = new CameraInfo(); 400 for (int i = 0; i < numberOfCameras; i++) { 401 getCameraInfo(i, cameraInfo); 402 if (cameraInfo.facing == CameraInfo.CAMERA_FACING_BACK) { 403 return new Camera(i); 404 } 405 } 406 return null; 407 } 408 409 /** 410 * Creates a new Camera object to access a particular hardware camera with 411 * given hal API version. If the same camera is opened by other applications 412 * or the hal API version is not supported by this device, this will throw a 413 * RuntimeException. 414 * <p> 415 * You must call {@link #release()} when you are done using the camera, 416 * otherwise it will remain locked and be unavailable to other applications. 417 * <p> 418 * Your application should only have one Camera object active at a time for 419 * a particular hardware camera. 420 * <p> 421 * Callbacks from other methods are delivered to the event loop of the 422 * thread which called open(). If this thread has no event loop, then 423 * callbacks are delivered to the main application event loop. If there is 424 * no main application event loop, callbacks are not delivered. 425 * <p class="caution"> 426 * <b>Caution:</b> On some devices, this method may take a long time to 427 * complete. It is best to call this method from a worker thread (possibly 428 * using {@link android.os.AsyncTask}) to avoid blocking the main 429 * application UI thread. 430 * 431 * @param cameraId The hardware camera to access, between 0 and 432 * {@link #getNumberOfCameras()}-1. 433 * @param halVersion The HAL API version this camera device to be opened as. 434 * @return a new Camera object, connected, locked and ready for use. 435 * 436 * @throws IllegalArgumentException if the {@code halVersion} is invalid 437 * 438 * @throws RuntimeException if opening the camera fails (for example, if the 439 * camera is in use by another process or device policy manager has disabled 440 * the camera). 441 * 442 * @see android.app.admin.DevicePolicyManager#getCameraDisabled(android.content.ComponentName) 443 * @see #CAMERA_HAL_API_VERSION_1_0 444 * 445 * @hide 446 */ 447 public static Camera openLegacy(int cameraId, int halVersion) { 448 if (halVersion < CAMERA_HAL_API_VERSION_1_0) { 449 throw new IllegalArgumentException("Invalid HAL version " + halVersion); 450 } 451 452 return new Camera(cameraId, halVersion); 453 } 454 455 /** 456 * Create a legacy camera object. 457 * 458 * @param cameraId The hardware camera to access, between 0 and 459 * {@link #getNumberOfCameras()}-1. 460 * @param halVersion The HAL API version this camera device to be opened as. 461 */ 462 private Camera(int cameraId, int halVersion) { 463 int err = cameraInitVersion(cameraId, halVersion); 464 if (checkInitErrors(err)) { 465 if (err == -EACCES) { 466 throw new RuntimeException("Fail to connect to camera service"); 467 } else if (err == -ENODEV) { 468 throw new RuntimeException("Camera initialization failed"); 469 } else if (err == -ENOSYS) { 470 throw new RuntimeException("Camera initialization failed because some methods" 471 + " are not implemented"); 472 } else if (err == -EOPNOTSUPP) { 473 throw new RuntimeException("Camera initialization failed because the hal" 474 + " version is not supported by this device"); 475 } else if (err == -EINVAL) { 476 throw new RuntimeException("Camera initialization failed because the input" 477 + " arugments are invalid"); 478 } else if (err == -EBUSY) { 479 throw new RuntimeException("Camera initialization failed because the camera" 480 + " device was already opened"); 481 } else if (err == -EUSERS) { 482 throw new RuntimeException("Camera initialization failed because the max" 483 + " number of camera devices were already opened"); 484 } 485 // Should never hit this. 486 throw new RuntimeException("Unknown camera error"); 487 } 488 } 489 490 private int cameraInitVersion(int cameraId, int halVersion) { 491 mShutterCallback = null; 492 mRawImageCallback = null; 493 mJpegCallback = null; 494 mPreviewCallback = null; 495 mPostviewCallback = null; 496 mUsingPreviewAllocation = false; 497 mZoomListener = null; 498 499 Looper looper; 500 if ((looper = Looper.myLooper()) != null) { 501 mEventHandler = new EventHandler(this, looper); 502 } else if ((looper = Looper.getMainLooper()) != null) { 503 mEventHandler = new EventHandler(this, looper); 504 } else { 505 mEventHandler = null; 506 } 507 508 return native_setup(new WeakReference<Camera>(this), cameraId, halVersion, 509 ActivityThread.currentOpPackageName()); 510 } 511 512 private int cameraInitNormal(int cameraId) { 513 return cameraInitVersion(cameraId, CAMERA_HAL_API_VERSION_NORMAL_CONNECT); 514 } 515 516 /** 517 * Connect to the camera service using #connectLegacy 518 * 519 * <p> 520 * This acts the same as normal except that it will return 521 * the detailed error code if open fails instead of 522 * converting everything into {@code NO_INIT}.</p> 523 * 524 * <p>Intended to use by the camera2 shim only, do <i>not</i> use this for other code.</p> 525 * 526 * @return a detailed errno error code, or {@code NO_ERROR} on success 527 * 528 * @hide 529 */ 530 public int cameraInitUnspecified(int cameraId) { 531 return cameraInitVersion(cameraId, CAMERA_HAL_API_VERSION_UNSPECIFIED); 532 } 533 534 /** used by Camera#open, Camera#open(int) */ 535 Camera(int cameraId) { 536 int err = cameraInitNormal(cameraId); 537 if (checkInitErrors(err)) { 538 if (err == -EACCES) { 539 throw new RuntimeException("Fail to connect to camera service"); 540 } else if (err == -ENODEV) { 541 throw new RuntimeException("Camera initialization failed"); 542 } 543 // Should never hit this. 544 throw new RuntimeException("Unknown camera error"); 545 } 546 initAppOps(); 547 } 548 549 550 /** 551 * @hide 552 */ 553 public static boolean checkInitErrors(int err) { 554 return err != NO_ERROR; 555 } 556 557 /** 558 * @hide 559 */ 560 public static Camera openUninitialized() { 561 return new Camera(); 562 } 563 564 /** 565 * An empty Camera for testing purpose. 566 */ 567 Camera() { 568 initAppOps(); 569 } 570 571 private void initAppOps() { 572 IBinder b = ServiceManager.getService(Context.APP_OPS_SERVICE); 573 mAppOps = IAppOpsService.Stub.asInterface(b); 574 // initialize mHasAppOpsPlayAudio 575 updateAppOpsPlayAudio(); 576 // register a callback to monitor whether the OP_PLAY_AUDIO is still allowed 577 mAppOpsCallback = new IAppOpsCallbackWrapper(this); 578 try { 579 mAppOps.startWatchingMode(AppOpsManager.OP_PLAY_AUDIO, 580 ActivityThread.currentPackageName(), mAppOpsCallback); 581 } catch (RemoteException e) { 582 Log.e(TAG, "Error registering appOps callback", e); 583 mHasAppOpsPlayAudio = false; 584 } 585 } 586 587 private void releaseAppOps() { 588 try { 589 if (mAppOps != null) { 590 mAppOps.stopWatchingMode(mAppOpsCallback); 591 } 592 } catch (Exception e) { 593 // nothing to do here, the object is supposed to be released anyway 594 } 595 } 596 597 @Override 598 protected void finalize() { 599 release(); 600 } 601 602 private native final int native_setup(Object camera_this, int cameraId, int halVersion, 603 String packageName); 604 605 private native final void native_release(); 606 607 608 /** 609 * Disconnects and releases the Camera object resources. 610 * 611 * <p>You must call this as soon as you're done with the Camera object.</p> 612 */ 613 public final void release() { 614 native_release(); 615 mFaceDetectionRunning = false; 616 releaseAppOps(); 617 } 618 619 /** 620 * Unlocks the camera to allow another process to access it. 621 * Normally, the camera is locked to the process with an active Camera 622 * object until {@link #release()} is called. To allow rapid handoff 623 * between processes, you can call this method to release the camera 624 * temporarily for another process to use; once the other process is done 625 * you can call {@link #reconnect()} to reclaim the camera. 626 * 627 * <p>This must be done before calling 628 * {@link android.media.MediaRecorder#setCamera(Camera)}. This cannot be 629 * called after recording starts. 630 * 631 * <p>If you are not recording video, you probably do not need this method. 632 * 633 * @throws RuntimeException if the camera cannot be unlocked. 634 */ 635 public native final void unlock(); 636 637 /** 638 * Re-locks the camera to prevent other processes from accessing it. 639 * Camera objects are locked by default unless {@link #unlock()} is 640 * called. Normally {@link #reconnect()} is used instead. 641 * 642 * <p>Since API level 14, camera is automatically locked for applications in 643 * {@link android.media.MediaRecorder#start()}. Applications can use the 644 * camera (ex: zoom) after recording starts. There is no need to call this 645 * after recording starts or stops. 646 * 647 * <p>If you are not recording video, you probably do not need this method. 648 * 649 * @throws RuntimeException if the camera cannot be re-locked (for 650 * example, if the camera is still in use by another process). 651 */ 652 public native final void lock(); 653 654 /** 655 * Reconnects to the camera service after another process used it. 656 * After {@link #unlock()} is called, another process may use the 657 * camera; when the process is done, you must reconnect to the camera, 658 * which will re-acquire the lock and allow you to continue using the 659 * camera. 660 * 661 * <p>Since API level 14, camera is automatically locked for applications in 662 * {@link android.media.MediaRecorder#start()}. Applications can use the 663 * camera (ex: zoom) after recording starts. There is no need to call this 664 * after recording starts or stops. 665 * 666 * <p>If you are not recording video, you probably do not need this method. 667 * 668 * @throws IOException if a connection cannot be re-established (for 669 * example, if the camera is still in use by another process). 670 * @throws RuntimeException if release() has been called on this Camera 671 * instance. 672 */ 673 public native final void reconnect() throws IOException; 674 675 /** 676 * Sets the {@link Surface} to be used for live preview. 677 * Either a surface or surface texture is necessary for preview, and 678 * preview is necessary to take pictures. The same surface can be re-set 679 * without harm. Setting a preview surface will un-set any preview surface 680 * texture that was set via {@link #setPreviewTexture}. 681 * 682 * <p>The {@link SurfaceHolder} must already contain a surface when this 683 * method is called. If you are using {@link android.view.SurfaceView}, 684 * you will need to register a {@link SurfaceHolder.Callback} with 685 * {@link SurfaceHolder#addCallback(SurfaceHolder.Callback)} and wait for 686 * {@link SurfaceHolder.Callback#surfaceCreated(SurfaceHolder)} before 687 * calling setPreviewDisplay() or starting preview. 688 * 689 * <p>This method must be called before {@link #startPreview()}. The 690 * one exception is that if the preview surface is not set (or set to null) 691 * before startPreview() is called, then this method may be called once 692 * with a non-null parameter to set the preview surface. (This allows 693 * camera setup and surface creation to happen in parallel, saving time.) 694 * The preview surface may not otherwise change while preview is running. 695 * 696 * @param holder containing the Surface on which to place the preview, 697 * or null to remove the preview surface 698 * @throws IOException if the method fails (for example, if the surface 699 * is unavailable or unsuitable). 700 * @throws RuntimeException if release() has been called on this Camera 701 * instance. 702 */ 703 public final void setPreviewDisplay(SurfaceHolder holder) throws IOException { 704 if (holder != null) { 705 setPreviewSurface(holder.getSurface()); 706 } else { 707 setPreviewSurface((Surface)null); 708 } 709 } 710 711 /** 712 * @hide 713 */ 714 public native final void setPreviewSurface(Surface surface) throws IOException; 715 716 /** 717 * Sets the {@link SurfaceTexture} to be used for live preview. 718 * Either a surface or surface texture is necessary for preview, and 719 * preview is necessary to take pictures. The same surface texture can be 720 * re-set without harm. Setting a preview surface texture will un-set any 721 * preview surface that was set via {@link #setPreviewDisplay}. 722 * 723 * <p>This method must be called before {@link #startPreview()}. The 724 * one exception is that if the preview surface texture is not set (or set 725 * to null) before startPreview() is called, then this method may be called 726 * once with a non-null parameter to set the preview surface. (This allows 727 * camera setup and surface creation to happen in parallel, saving time.) 728 * The preview surface texture may not otherwise change while preview is 729 * running. 730 * 731 * <p>The timestamps provided by {@link SurfaceTexture#getTimestamp()} for a 732 * SurfaceTexture set as the preview texture have an unspecified zero point, 733 * and cannot be directly compared between different cameras or different 734 * instances of the same camera, or across multiple runs of the same 735 * program. 736 * 737 * <p>If you are using the preview data to create video or still images, 738 * strongly consider using {@link android.media.MediaActionSound} to 739 * properly indicate image capture or recording start/stop to the user.</p> 740 * 741 * @see android.media.MediaActionSound 742 * @see android.graphics.SurfaceTexture 743 * @see android.view.TextureView 744 * @param surfaceTexture the {@link SurfaceTexture} to which the preview 745 * images are to be sent or null to remove the current preview surface 746 * texture 747 * @throws IOException if the method fails (for example, if the surface 748 * texture is unavailable or unsuitable). 749 * @throws RuntimeException if release() has been called on this Camera 750 * instance. 751 */ 752 public native final void setPreviewTexture(SurfaceTexture surfaceTexture) throws IOException; 753 754 /** 755 * Callback interface used to deliver copies of preview frames as 756 * they are displayed. 757 * 758 * @see #setPreviewCallback(Camera.PreviewCallback) 759 * @see #setOneShotPreviewCallback(Camera.PreviewCallback) 760 * @see #setPreviewCallbackWithBuffer(Camera.PreviewCallback) 761 * @see #startPreview() 762 * 763 * @deprecated We recommend using the new {@link android.hardware.camera2} API for new 764 * applications. 765 */ 766 @Deprecated 767 public interface PreviewCallback 768 { 769 /** 770 * Called as preview frames are displayed. This callback is invoked 771 * on the event thread {@link #open(int)} was called from. 772 * 773 * <p>If using the {@link android.graphics.ImageFormat#YV12} format, 774 * refer to the equations in {@link Camera.Parameters#setPreviewFormat} 775 * for the arrangement of the pixel data in the preview callback 776 * buffers. 777 * 778 * @param data the contents of the preview frame in the format defined 779 * by {@link android.graphics.ImageFormat}, which can be queried 780 * with {@link android.hardware.Camera.Parameters#getPreviewFormat()}. 781 * If {@link android.hardware.Camera.Parameters#setPreviewFormat(int)} 782 * is never called, the default will be the YCbCr_420_SP 783 * (NV21) format. 784 * @param camera the Camera service object. 785 */ 786 void onPreviewFrame(byte[] data, Camera camera); 787 }; 788 789 /** 790 * Starts capturing and drawing preview frames to the screen. 791 * Preview will not actually start until a surface is supplied 792 * with {@link #setPreviewDisplay(SurfaceHolder)} or 793 * {@link #setPreviewTexture(SurfaceTexture)}. 794 * 795 * <p>If {@link #setPreviewCallback(Camera.PreviewCallback)}, 796 * {@link #setOneShotPreviewCallback(Camera.PreviewCallback)}, or 797 * {@link #setPreviewCallbackWithBuffer(Camera.PreviewCallback)} were 798 * called, {@link Camera.PreviewCallback#onPreviewFrame(byte[], Camera)} 799 * will be called when preview data becomes available. 800 * 801 * @throws RuntimeException if starting preview fails; usually this would be 802 * because of a hardware or other low-level error, or because release() 803 * has been called on this Camera instance. 804 */ 805 public native final void startPreview(); 806 807 /** 808 * Stops capturing and drawing preview frames to the surface, and 809 * resets the camera for a future call to {@link #startPreview()}. 810 * 811 * @throws RuntimeException if stopping preview fails; usually this would be 812 * because of a hardware or other low-level error, or because release() 813 * has been called on this Camera instance. 814 */ 815 public final void stopPreview() { 816 _stopPreview(); 817 mFaceDetectionRunning = false; 818 819 mShutterCallback = null; 820 mRawImageCallback = null; 821 mPostviewCallback = null; 822 mJpegCallback = null; 823 synchronized (mAutoFocusCallbackLock) { 824 mAutoFocusCallback = null; 825 } 826 mAutoFocusMoveCallback = null; 827 } 828 829 private native final void _stopPreview(); 830 831 /** 832 * Return current preview state. 833 * 834 * FIXME: Unhide before release 835 * @hide 836 */ 837 public native final boolean previewEnabled(); 838 839 /** 840 * <p>Installs a callback to be invoked for every preview frame in addition 841 * to displaying them on the screen. The callback will be repeatedly called 842 * for as long as preview is active. This method can be called at any time, 843 * even while preview is live. Any other preview callbacks are 844 * overridden.</p> 845 * 846 * <p>If you are using the preview data to create video or still images, 847 * strongly consider using {@link android.media.MediaActionSound} to 848 * properly indicate image capture or recording start/stop to the user.</p> 849 * 850 * @param cb a callback object that receives a copy of each preview frame, 851 * or null to stop receiving callbacks. 852 * @throws RuntimeException if release() has been called on this Camera 853 * instance. 854 * @see android.media.MediaActionSound 855 */ 856 public final void setPreviewCallback(PreviewCallback cb) { 857 mPreviewCallback = cb; 858 mOneShot = false; 859 mWithBuffer = false; 860 if (cb != null) { 861 mUsingPreviewAllocation = false; 862 } 863 // Always use one-shot mode. We fake camera preview mode by 864 // doing one-shot preview continuously. 865 setHasPreviewCallback(cb != null, false); 866 } 867 868 /** 869 * <p>Installs a callback to be invoked for the next preview frame in 870 * addition to displaying it on the screen. After one invocation, the 871 * callback is cleared. This method can be called any time, even when 872 * preview is live. Any other preview callbacks are overridden.</p> 873 * 874 * <p>If you are using the preview data to create video or still images, 875 * strongly consider using {@link android.media.MediaActionSound} to 876 * properly indicate image capture or recording start/stop to the user.</p> 877 * 878 * @param cb a callback object that receives a copy of the next preview frame, 879 * or null to stop receiving callbacks. 880 * @throws RuntimeException if release() has been called on this Camera 881 * instance. 882 * @see android.media.MediaActionSound 883 */ 884 public final void setOneShotPreviewCallback(PreviewCallback cb) { 885 mPreviewCallback = cb; 886 mOneShot = true; 887 mWithBuffer = false; 888 if (cb != null) { 889 mUsingPreviewAllocation = false; 890 } 891 setHasPreviewCallback(cb != null, false); 892 } 893 894 private native final void setHasPreviewCallback(boolean installed, boolean manualBuffer); 895 896 /** 897 * <p>Installs a callback to be invoked for every preview frame, using 898 * buffers supplied with {@link #addCallbackBuffer(byte[])}, in addition to 899 * displaying them on the screen. The callback will be repeatedly called 900 * for as long as preview is active and buffers are available. Any other 901 * preview callbacks are overridden.</p> 902 * 903 * <p>The purpose of this method is to improve preview efficiency and frame 904 * rate by allowing preview frame memory reuse. You must call 905 * {@link #addCallbackBuffer(byte[])} at some point -- before or after 906 * calling this method -- or no callbacks will received.</p> 907 * 908 * <p>The buffer queue will be cleared if this method is called with a null 909 * callback, {@link #setPreviewCallback(Camera.PreviewCallback)} is called, 910 * or {@link #setOneShotPreviewCallback(Camera.PreviewCallback)} is 911 * called.</p> 912 * 913 * <p>If you are using the preview data to create video or still images, 914 * strongly consider using {@link android.media.MediaActionSound} to 915 * properly indicate image capture or recording start/stop to the user.</p> 916 * 917 * @param cb a callback object that receives a copy of the preview frame, 918 * or null to stop receiving callbacks and clear the buffer queue. 919 * @throws RuntimeException if release() has been called on this Camera 920 * instance. 921 * @see #addCallbackBuffer(byte[]) 922 * @see android.media.MediaActionSound 923 */ 924 public final void setPreviewCallbackWithBuffer(PreviewCallback cb) { 925 mPreviewCallback = cb; 926 mOneShot = false; 927 mWithBuffer = true; 928 if (cb != null) { 929 mUsingPreviewAllocation = false; 930 } 931 setHasPreviewCallback(cb != null, true); 932 } 933 934 /** 935 * Adds a pre-allocated buffer to the preview callback buffer queue. 936 * Applications can add one or more buffers to the queue. When a preview 937 * frame arrives and there is still at least one available buffer, the 938 * buffer will be used and removed from the queue. Then preview callback is 939 * invoked with the buffer. If a frame arrives and there is no buffer left, 940 * the frame is discarded. Applications should add buffers back when they 941 * finish processing the data in them. 942 * 943 * <p>For formats besides YV12, the size of the buffer is determined by 944 * multiplying the preview image width, height, and bytes per pixel. The 945 * width and height can be read from 946 * {@link Camera.Parameters#getPreviewSize()}. Bytes per pixel can be 947 * computed from {@link android.graphics.ImageFormat#getBitsPerPixel(int)} / 948 * 8, using the image format from 949 * {@link Camera.Parameters#getPreviewFormat()}. 950 * 951 * <p>If using the {@link android.graphics.ImageFormat#YV12} format, the 952 * size can be calculated using the equations listed in 953 * {@link Camera.Parameters#setPreviewFormat}. 954 * 955 * <p>This method is only necessary when 956 * {@link #setPreviewCallbackWithBuffer(PreviewCallback)} is used. When 957 * {@link #setPreviewCallback(PreviewCallback)} or 958 * {@link #setOneShotPreviewCallback(PreviewCallback)} are used, buffers 959 * are automatically allocated. When a supplied buffer is too small to 960 * hold the preview frame data, preview callback will return null and 961 * the buffer will be removed from the buffer queue. 962 * 963 * @param callbackBuffer the buffer to add to the queue. The size of the 964 * buffer must match the values described above. 965 * @see #setPreviewCallbackWithBuffer(PreviewCallback) 966 */ 967 public final void addCallbackBuffer(byte[] callbackBuffer) 968 { 969 _addCallbackBuffer(callbackBuffer, CAMERA_MSG_PREVIEW_FRAME); 970 } 971 972 /** 973 * Adds a pre-allocated buffer to the raw image callback buffer queue. 974 * Applications can add one or more buffers to the queue. When a raw image 975 * frame arrives and there is still at least one available buffer, the 976 * buffer will be used to hold the raw image data and removed from the 977 * queue. Then raw image callback is invoked with the buffer. If a raw 978 * image frame arrives but there is no buffer left, the frame is 979 * discarded. Applications should add buffers back when they finish 980 * processing the data in them by calling this method again in order 981 * to avoid running out of raw image callback buffers. 982 * 983 * <p>The size of the buffer is determined by multiplying the raw image 984 * width, height, and bytes per pixel. The width and height can be 985 * read from {@link Camera.Parameters#getPictureSize()}. Bytes per pixel 986 * can be computed from 987 * {@link android.graphics.ImageFormat#getBitsPerPixel(int)} / 8, 988 * using the image format from {@link Camera.Parameters#getPreviewFormat()}. 989 * 990 * <p>This method is only necessary when the PictureCallbck for raw image 991 * is used while calling {@link #takePicture(Camera.ShutterCallback, 992 * Camera.PictureCallback, Camera.PictureCallback, Camera.PictureCallback)}. 993 * 994 * <p>Please note that by calling this method, the mode for 995 * application-managed callback buffers is triggered. If this method has 996 * never been called, null will be returned by the raw image callback since 997 * there is no image callback buffer available. Furthermore, When a supplied 998 * buffer is too small to hold the raw image data, raw image callback will 999 * return null and the buffer will be removed from the buffer queue. 1000 * 1001 * @param callbackBuffer the buffer to add to the raw image callback buffer 1002 * queue. The size should be width * height * (bits per pixel) / 8. An 1003 * null callbackBuffer will be ignored and won't be added to the queue. 1004 * 1005 * @see #takePicture(Camera.ShutterCallback, 1006 * Camera.PictureCallback, Camera.PictureCallback, Camera.PictureCallback)}. 1007 * 1008 * {@hide} 1009 */ 1010 public final void addRawImageCallbackBuffer(byte[] callbackBuffer) 1011 { 1012 addCallbackBuffer(callbackBuffer, CAMERA_MSG_RAW_IMAGE); 1013 } 1014 1015 private final void addCallbackBuffer(byte[] callbackBuffer, int msgType) 1016 { 1017 // CAMERA_MSG_VIDEO_FRAME may be allowed in the future. 1018 if (msgType != CAMERA_MSG_PREVIEW_FRAME && 1019 msgType != CAMERA_MSG_RAW_IMAGE) { 1020 throw new IllegalArgumentException( 1021 "Unsupported message type: " + msgType); 1022 } 1023 1024 _addCallbackBuffer(callbackBuffer, msgType); 1025 } 1026 1027 private native final void _addCallbackBuffer( 1028 byte[] callbackBuffer, int msgType); 1029 1030 /** 1031 * <p>Create a {@link android.renderscript RenderScript} 1032 * {@link android.renderscript.Allocation Allocation} to use as a 1033 * destination of preview callback frames. Use 1034 * {@link #setPreviewCallbackAllocation setPreviewCallbackAllocation} to use 1035 * the created Allocation as a destination for camera preview frames.</p> 1036 * 1037 * <p>The Allocation will be created with a YUV type, and its contents must 1038 * be accessed within Renderscript with the {@code rsGetElementAtYuv_*} 1039 * accessor methods. Its size will be based on the current 1040 * {@link Parameters#getPreviewSize preview size} configured for this 1041 * camera.</p> 1042 * 1043 * @param rs the RenderScript context for this Allocation. 1044 * @param usage additional usage flags to set for the Allocation. The usage 1045 * flag {@link android.renderscript.Allocation#USAGE_IO_INPUT} will always 1046 * be set on the created Allocation, but additional flags may be provided 1047 * here. 1048 * @return a new YUV-type Allocation with dimensions equal to the current 1049 * preview size. 1050 * @throws RSIllegalArgumentException if the usage flags are not compatible 1051 * with an YUV Allocation. 1052 * @see #setPreviewCallbackAllocation 1053 * @hide 1054 */ 1055 public final Allocation createPreviewAllocation(RenderScript rs, int usage) 1056 throws RSIllegalArgumentException { 1057 Parameters p = getParameters(); 1058 Size previewSize = p.getPreviewSize(); 1059 Type.Builder yuvBuilder = new Type.Builder(rs, 1060 Element.createPixel(rs, 1061 Element.DataType.UNSIGNED_8, 1062 Element.DataKind.PIXEL_YUV)); 1063 // Use YV12 for wide compatibility. Changing this requires also 1064 // adjusting camera service's format selection. 1065 yuvBuilder.setYuvFormat(ImageFormat.YV12); 1066 yuvBuilder.setX(previewSize.width); 1067 yuvBuilder.setY(previewSize.height); 1068 1069 Allocation a = Allocation.createTyped(rs, yuvBuilder.create(), 1070 usage | Allocation.USAGE_IO_INPUT); 1071 1072 return a; 1073 } 1074 1075 /** 1076 * <p>Set an {@link android.renderscript.Allocation Allocation} as the 1077 * target of preview callback data. Use this method for efficient processing 1078 * of camera preview data with RenderScript. The Allocation must be created 1079 * with the {@link #createPreviewAllocation createPreviewAllocation } 1080 * method.</p> 1081 * 1082 * <p>Setting a preview allocation will disable any active preview callbacks 1083 * set by {@link #setPreviewCallback setPreviewCallback} or 1084 * {@link #setPreviewCallbackWithBuffer setPreviewCallbackWithBuffer}, and 1085 * vice versa. Using a preview allocation still requires an active standard 1086 * preview target to be set, either with 1087 * {@link #setPreviewTexture setPreviewTexture} or 1088 * {@link #setPreviewDisplay setPreviewDisplay}.</p> 1089 * 1090 * <p>To be notified when new frames are available to the Allocation, use 1091 * {@link android.renderscript.Allocation#setIoInputNotificationHandler Allocation.setIoInputNotificationHandler}. To 1092 * update the frame currently accessible from the Allocation to the latest 1093 * preview frame, call 1094 * {@link android.renderscript.Allocation#ioReceive Allocation.ioReceive}.</p> 1095 * 1096 * <p>To disable preview into the Allocation, call this method with a 1097 * {@code null} parameter.</p> 1098 * 1099 * <p>Once a preview allocation is set, the preview size set by 1100 * {@link Parameters#setPreviewSize setPreviewSize} cannot be changed. If 1101 * you wish to change the preview size, first remove the preview allocation 1102 * by calling {@code setPreviewCallbackAllocation(null)}, then change the 1103 * preview size, create a new preview Allocation with 1104 * {@link #createPreviewAllocation createPreviewAllocation}, and set it as 1105 * the new preview callback allocation target.</p> 1106 * 1107 * <p>If you are using the preview data to create video or still images, 1108 * strongly consider using {@link android.media.MediaActionSound} to 1109 * properly indicate image capture or recording start/stop to the user.</p> 1110 * 1111 * @param previewAllocation the allocation to use as destination for preview 1112 * @throws IOException if configuring the camera to use the Allocation for 1113 * preview fails. 1114 * @throws IllegalArgumentException if the Allocation's dimensions or other 1115 * parameters don't meet the requirements. 1116 * @see #createPreviewAllocation 1117 * @see #setPreviewCallback 1118 * @see #setPreviewCallbackWithBuffer 1119 * @hide 1120 */ 1121 public final void setPreviewCallbackAllocation(Allocation previewAllocation) 1122 throws IOException { 1123 Surface previewSurface = null; 1124 if (previewAllocation != null) { 1125 Parameters p = getParameters(); 1126 Size previewSize = p.getPreviewSize(); 1127 if (previewSize.width != previewAllocation.getType().getX() || 1128 previewSize.height != previewAllocation.getType().getY()) { 1129 throw new IllegalArgumentException( 1130 "Allocation dimensions don't match preview dimensions: " + 1131 "Allocation is " + 1132 previewAllocation.getType().getX() + 1133 ", " + 1134 previewAllocation.getType().getY() + 1135 ". Preview is " + previewSize.width + ", " + 1136 previewSize.height); 1137 } 1138 if ((previewAllocation.getUsage() & 1139 Allocation.USAGE_IO_INPUT) == 0) { 1140 throw new IllegalArgumentException( 1141 "Allocation usage does not include USAGE_IO_INPUT"); 1142 } 1143 if (previewAllocation.getType().getElement().getDataKind() != 1144 Element.DataKind.PIXEL_YUV) { 1145 throw new IllegalArgumentException( 1146 "Allocation is not of a YUV type"); 1147 } 1148 previewSurface = previewAllocation.getSurface(); 1149 mUsingPreviewAllocation = true; 1150 } else { 1151 mUsingPreviewAllocation = false; 1152 } 1153 setPreviewCallbackSurface(previewSurface); 1154 } 1155 1156 private native final void setPreviewCallbackSurface(Surface s); 1157 1158 private class EventHandler extends Handler 1159 { 1160 private final Camera mCamera; 1161 1162 public EventHandler(Camera c, Looper looper) { 1163 super(looper); 1164 mCamera = c; 1165 } 1166 1167 @Override 1168 public void handleMessage(Message msg) { 1169 switch(msg.what) { 1170 case CAMERA_MSG_SHUTTER: 1171 if (mShutterCallback != null) { 1172 mShutterCallback.onShutter(); 1173 } 1174 return; 1175 1176 case CAMERA_MSG_RAW_IMAGE: 1177 if (mRawImageCallback != null) { 1178 mRawImageCallback.onPictureTaken((byte[])msg.obj, mCamera); 1179 } 1180 return; 1181 1182 case CAMERA_MSG_COMPRESSED_IMAGE: 1183 if (mJpegCallback != null) { 1184 mJpegCallback.onPictureTaken((byte[])msg.obj, mCamera); 1185 } 1186 return; 1187 1188 case CAMERA_MSG_PREVIEW_FRAME: 1189 PreviewCallback pCb = mPreviewCallback; 1190 if (pCb != null) { 1191 if (mOneShot) { 1192 // Clear the callback variable before the callback 1193 // in case the app calls setPreviewCallback from 1194 // the callback function 1195 mPreviewCallback = null; 1196 } else if (!mWithBuffer) { 1197 // We're faking the camera preview mode to prevent 1198 // the app from being flooded with preview frames. 1199 // Set to oneshot mode again. 1200 setHasPreviewCallback(true, false); 1201 } 1202 pCb.onPreviewFrame((byte[])msg.obj, mCamera); 1203 } 1204 return; 1205 1206 case CAMERA_MSG_POSTVIEW_FRAME: 1207 if (mPostviewCallback != null) { 1208 mPostviewCallback.onPictureTaken((byte[])msg.obj, mCamera); 1209 } 1210 return; 1211 1212 case CAMERA_MSG_FOCUS: 1213 AutoFocusCallback cb = null; 1214 synchronized (mAutoFocusCallbackLock) { 1215 cb = mAutoFocusCallback; 1216 } 1217 if (cb != null) { 1218 boolean success = msg.arg1 == 0 ? false : true; 1219 cb.onAutoFocus(success, mCamera); 1220 } 1221 return; 1222 1223 case CAMERA_MSG_ZOOM: 1224 if (mZoomListener != null) { 1225 mZoomListener.onZoomChange(msg.arg1, msg.arg2 != 0, mCamera); 1226 } 1227 return; 1228 1229 case CAMERA_MSG_PREVIEW_METADATA: 1230 if (mFaceListener != null) { 1231 mFaceListener.onFaceDetection((Face[])msg.obj, mCamera); 1232 } 1233 return; 1234 1235 case CAMERA_MSG_ERROR : 1236 Log.e(TAG, "Error " + msg.arg1); 1237 if (mErrorCallback != null) { 1238 mErrorCallback.onError(msg.arg1, mCamera); 1239 } 1240 return; 1241 1242 case CAMERA_MSG_FOCUS_MOVE: 1243 if (mAutoFocusMoveCallback != null) { 1244 mAutoFocusMoveCallback.onAutoFocusMoving(msg.arg1 == 0 ? false : true, mCamera); 1245 } 1246 return; 1247 1248 default: 1249 Log.e(TAG, "Unknown message type " + msg.what); 1250 return; 1251 } 1252 } 1253 } 1254 1255 private static void postEventFromNative(Object camera_ref, 1256 int what, int arg1, int arg2, Object obj) 1257 { 1258 Camera c = (Camera)((WeakReference)camera_ref).get(); 1259 if (c == null) 1260 return; 1261 1262 if (c.mEventHandler != null) { 1263 Message m = c.mEventHandler.obtainMessage(what, arg1, arg2, obj); 1264 c.mEventHandler.sendMessage(m); 1265 } 1266 } 1267 1268 /** 1269 * Callback interface used to notify on completion of camera auto focus. 1270 * 1271 * <p>Devices that do not support auto-focus will receive a "fake" 1272 * callback to this interface. If your application needs auto-focus and 1273 * should not be installed on devices <em>without</em> auto-focus, you must 1274 * declare that your app uses the 1275 * {@code android.hardware.camera.autofocus} feature, in the 1276 * <a href="{@docRoot}guide/topics/manifest/uses-feature-element.html"><uses-feature></a> 1277 * manifest element.</p> 1278 * 1279 * @see #autoFocus(AutoFocusCallback) 1280 * @deprecated We recommend using the new {@link android.hardware.camera2} API for new 1281 * applications. 1282 */ 1283 @Deprecated 1284 public interface AutoFocusCallback 1285 { 1286 /** 1287 * Called when the camera auto focus completes. If the camera 1288 * does not support auto-focus and autoFocus is called, 1289 * onAutoFocus will be called immediately with a fake value of 1290 * <code>success</code> set to <code>true</code>. 1291 * 1292 * The auto-focus routine does not lock auto-exposure and auto-white 1293 * balance after it completes. 1294 * 1295 * @param success true if focus was successful, false if otherwise 1296 * @param camera the Camera service object 1297 * @see android.hardware.Camera.Parameters#setAutoExposureLock(boolean) 1298 * @see android.hardware.Camera.Parameters#setAutoWhiteBalanceLock(boolean) 1299 */ 1300 void onAutoFocus(boolean success, Camera camera); 1301 } 1302 1303 /** 1304 * Starts camera auto-focus and registers a callback function to run when 1305 * the camera is focused. This method is only valid when preview is active 1306 * (between {@link #startPreview()} and before {@link #stopPreview()}). 1307 * 1308 * <p>Callers should check 1309 * {@link android.hardware.Camera.Parameters#getFocusMode()} to determine if 1310 * this method should be called. If the camera does not support auto-focus, 1311 * it is a no-op and {@link AutoFocusCallback#onAutoFocus(boolean, Camera)} 1312 * callback will be called immediately. 1313 * 1314 * <p>If your application should not be installed 1315 * on devices without auto-focus, you must declare that your application 1316 * uses auto-focus with the 1317 * <a href="{@docRoot}guide/topics/manifest/uses-feature-element.html"><uses-feature></a> 1318 * manifest element.</p> 1319 * 1320 * <p>If the current flash mode is not 1321 * {@link android.hardware.Camera.Parameters#FLASH_MODE_OFF}, flash may be 1322 * fired during auto-focus, depending on the driver and camera hardware.<p> 1323 * 1324 * <p>Auto-exposure lock {@link android.hardware.Camera.Parameters#getAutoExposureLock()} 1325 * and auto-white balance locks {@link android.hardware.Camera.Parameters#getAutoWhiteBalanceLock()} 1326 * do not change during and after autofocus. But auto-focus routine may stop 1327 * auto-exposure and auto-white balance transiently during focusing. 1328 * 1329 * <p>Stopping preview with {@link #stopPreview()}, or triggering still 1330 * image capture with {@link #takePicture(Camera.ShutterCallback, 1331 * Camera.PictureCallback, Camera.PictureCallback)}, will not change the 1332 * the focus position. Applications must call cancelAutoFocus to reset the 1333 * focus.</p> 1334 * 1335 * <p>If autofocus is successful, consider using 1336 * {@link android.media.MediaActionSound} to properly play back an autofocus 1337 * success sound to the user.</p> 1338 * 1339 * @param cb the callback to run 1340 * @throws RuntimeException if starting autofocus fails; usually this would 1341 * be because of a hardware or other low-level error, or because 1342 * release() has been called on this Camera instance. 1343 * @see #cancelAutoFocus() 1344 * @see android.hardware.Camera.Parameters#setAutoExposureLock(boolean) 1345 * @see android.hardware.Camera.Parameters#setAutoWhiteBalanceLock(boolean) 1346 * @see android.media.MediaActionSound 1347 */ 1348 public final void autoFocus(AutoFocusCallback cb) 1349 { 1350 synchronized (mAutoFocusCallbackLock) { 1351 mAutoFocusCallback = cb; 1352 } 1353 native_autoFocus(); 1354 } 1355 private native final void native_autoFocus(); 1356 1357 /** 1358 * Cancels any auto-focus function in progress. 1359 * Whether or not auto-focus is currently in progress, 1360 * this function will return the focus position to the default. 1361 * If the camera does not support auto-focus, this is a no-op. 1362 * 1363 * @throws RuntimeException if canceling autofocus fails; usually this would 1364 * be because of a hardware or other low-level error, or because 1365 * release() has been called on this Camera instance. 1366 * @see #autoFocus(Camera.AutoFocusCallback) 1367 */ 1368 public final void cancelAutoFocus() 1369 { 1370 synchronized (mAutoFocusCallbackLock) { 1371 mAutoFocusCallback = null; 1372 } 1373 native_cancelAutoFocus(); 1374 // CAMERA_MSG_FOCUS should be removed here because the following 1375 // scenario can happen: 1376 // - An application uses the same thread for autoFocus, cancelAutoFocus 1377 // and looper thread. 1378 // - The application calls autoFocus. 1379 // - HAL sends CAMERA_MSG_FOCUS, which enters the looper message queue. 1380 // Before event handler's handleMessage() is invoked, the application 1381 // calls cancelAutoFocus and autoFocus. 1382 // - The application gets the old CAMERA_MSG_FOCUS and thinks autofocus 1383 // has been completed. But in fact it is not. 1384 // 1385 // As documented in the beginning of the file, apps should not use 1386 // multiple threads to call autoFocus and cancelAutoFocus at the same 1387 // time. It is HAL's responsibility not to send a CAMERA_MSG_FOCUS 1388 // message after native_cancelAutoFocus is called. 1389 mEventHandler.removeMessages(CAMERA_MSG_FOCUS); 1390 } 1391 private native final void native_cancelAutoFocus(); 1392 1393 /** 1394 * Callback interface used to notify on auto focus start and stop. 1395 * 1396 * <p>This is only supported in continuous autofocus modes -- {@link 1397 * Parameters#FOCUS_MODE_CONTINUOUS_VIDEO} and {@link 1398 * Parameters#FOCUS_MODE_CONTINUOUS_PICTURE}. Applications can show 1399 * autofocus animation based on this.</p> 1400 * 1401 * @deprecated We recommend using the new {@link android.hardware.camera2} API for new 1402 * applications. 1403 */ 1404 @Deprecated 1405 public interface AutoFocusMoveCallback 1406 { 1407 /** 1408 * Called when the camera auto focus starts or stops. 1409 * 1410 * @param start true if focus starts to move, false if focus stops to move 1411 * @param camera the Camera service object 1412 */ 1413 void onAutoFocusMoving(boolean start, Camera camera); 1414 } 1415 1416 /** 1417 * Sets camera auto-focus move callback. 1418 * 1419 * @param cb the callback to run 1420 * @throws RuntimeException if enabling the focus move callback fails; 1421 * usually this would be because of a hardware or other low-level error, 1422 * or because release() has been called on this Camera instance. 1423 */ 1424 public void setAutoFocusMoveCallback(AutoFocusMoveCallback cb) { 1425 mAutoFocusMoveCallback = cb; 1426 enableFocusMoveCallback((mAutoFocusMoveCallback != null) ? 1 : 0); 1427 } 1428 1429 private native void enableFocusMoveCallback(int enable); 1430 1431 /** 1432 * Callback interface used to signal the moment of actual image capture. 1433 * 1434 * @see #takePicture(ShutterCallback, PictureCallback, PictureCallback, PictureCallback) 1435 * 1436 * @deprecated We recommend using the new {@link android.hardware.camera2} API for new 1437 * applications. 1438 */ 1439 @Deprecated 1440 public interface ShutterCallback 1441 { 1442 /** 1443 * Called as near as possible to the moment when a photo is captured 1444 * from the sensor. This is a good opportunity to play a shutter sound 1445 * or give other feedback of camera operation. This may be some time 1446 * after the photo was triggered, but some time before the actual data 1447 * is available. 1448 */ 1449 void onShutter(); 1450 } 1451 1452 /** 1453 * Callback interface used to supply image data from a photo capture. 1454 * 1455 * @see #takePicture(ShutterCallback, PictureCallback, PictureCallback, PictureCallback) 1456 * 1457 * @deprecated We recommend using the new {@link android.hardware.camera2} API for new 1458 * applications. 1459 */ 1460 @Deprecated 1461 public interface PictureCallback { 1462 /** 1463 * Called when image data is available after a picture is taken. 1464 * The format of the data depends on the context of the callback 1465 * and {@link Camera.Parameters} settings. 1466 * 1467 * @param data a byte array of the picture data 1468 * @param camera the Camera service object 1469 */ 1470 void onPictureTaken(byte[] data, Camera camera); 1471 }; 1472 1473 /** 1474 * Equivalent to <pre>takePicture(Shutter, raw, null, jpeg)</pre>. 1475 * 1476 * @see #takePicture(ShutterCallback, PictureCallback, PictureCallback, PictureCallback) 1477 */ 1478 public final void takePicture(ShutterCallback shutter, PictureCallback raw, 1479 PictureCallback jpeg) { 1480 takePicture(shutter, raw, null, jpeg); 1481 } 1482 private native final void native_takePicture(int msgType); 1483 1484 /** 1485 * Triggers an asynchronous image capture. The camera service will initiate 1486 * a series of callbacks to the application as the image capture progresses. 1487 * The shutter callback occurs after the image is captured. This can be used 1488 * to trigger a sound to let the user know that image has been captured. The 1489 * raw callback occurs when the raw image data is available (NOTE: the data 1490 * will be null if there is no raw image callback buffer available or the 1491 * raw image callback buffer is not large enough to hold the raw image). 1492 * The postview callback occurs when a scaled, fully processed postview 1493 * image is available (NOTE: not all hardware supports this). The jpeg 1494 * callback occurs when the compressed image is available. If the 1495 * application does not need a particular callback, a null can be passed 1496 * instead of a callback method. 1497 * 1498 * <p>This method is only valid when preview is active (after 1499 * {@link #startPreview()}). Preview will be stopped after the image is 1500 * taken; callers must call {@link #startPreview()} again if they want to 1501 * re-start preview or take more pictures. This should not be called between 1502 * {@link android.media.MediaRecorder#start()} and 1503 * {@link android.media.MediaRecorder#stop()}. 1504 * 1505 * <p>After calling this method, you must not call {@link #startPreview()} 1506 * or take another picture until the JPEG callback has returned. 1507 * 1508 * @param shutter the callback for image capture moment, or null 1509 * @param raw the callback for raw (uncompressed) image data, or null 1510 * @param postview callback with postview image data, may be null 1511 * @param jpeg the callback for JPEG image data, or null 1512 * @throws RuntimeException if starting picture capture fails; usually this 1513 * would be because of a hardware or other low-level error, or because 1514 * release() has been called on this Camera instance. 1515 */ 1516 public final void takePicture(ShutterCallback shutter, PictureCallback raw, 1517 PictureCallback postview, PictureCallback jpeg) { 1518 mShutterCallback = shutter; 1519 mRawImageCallback = raw; 1520 mPostviewCallback = postview; 1521 mJpegCallback = jpeg; 1522 1523 // If callback is not set, do not send me callbacks. 1524 int msgType = 0; 1525 if (mShutterCallback != null) { 1526 msgType |= CAMERA_MSG_SHUTTER; 1527 } 1528 if (mRawImageCallback != null) { 1529 msgType |= CAMERA_MSG_RAW_IMAGE; 1530 } 1531 if (mPostviewCallback != null) { 1532 msgType |= CAMERA_MSG_POSTVIEW_FRAME; 1533 } 1534 if (mJpegCallback != null) { 1535 msgType |= CAMERA_MSG_COMPRESSED_IMAGE; 1536 } 1537 1538 native_takePicture(msgType); 1539 mFaceDetectionRunning = false; 1540 } 1541 1542 /** 1543 * Zooms to the requested value smoothly. The driver will notify {@link 1544 * OnZoomChangeListener} of the zoom value and whether zoom is stopped at 1545 * the time. For example, suppose the current zoom is 0 and startSmoothZoom 1546 * is called with value 3. The 1547 * {@link Camera.OnZoomChangeListener#onZoomChange(int, boolean, Camera)} 1548 * method will be called three times with zoom values 1, 2, and 3. 1549 * Applications can call {@link #stopSmoothZoom} to stop the zoom earlier. 1550 * Applications should not call startSmoothZoom again or change the zoom 1551 * value before zoom stops. If the supplied zoom value equals to the current 1552 * zoom value, no zoom callback will be generated. This method is supported 1553 * if {@link android.hardware.Camera.Parameters#isSmoothZoomSupported} 1554 * returns true. 1555 * 1556 * @param value zoom value. The valid range is 0 to {@link 1557 * android.hardware.Camera.Parameters#getMaxZoom}. 1558 * @throws IllegalArgumentException if the zoom value is invalid. 1559 * @throws RuntimeException if the method fails. 1560 * @see #setZoomChangeListener(OnZoomChangeListener) 1561 */ 1562 public native final void startSmoothZoom(int value); 1563 1564 /** 1565 * Stops the smooth zoom. Applications should wait for the {@link 1566 * OnZoomChangeListener} to know when the zoom is actually stopped. This 1567 * method is supported if {@link 1568 * android.hardware.Camera.Parameters#isSmoothZoomSupported} is true. 1569 * 1570 * @throws RuntimeException if the method fails. 1571 */ 1572 public native final void stopSmoothZoom(); 1573 1574 /** 1575 * Set the clockwise rotation of preview display in degrees. This affects 1576 * the preview frames and the picture displayed after snapshot. This method 1577 * is useful for portrait mode applications. Note that preview display of 1578 * front-facing cameras is flipped horizontally before the rotation, that 1579 * is, the image is reflected along the central vertical axis of the camera 1580 * sensor. So the users can see themselves as looking into a mirror. 1581 * 1582 * <p>This does not affect the order of byte array passed in {@link 1583 * PreviewCallback#onPreviewFrame}, JPEG pictures, or recorded videos. This 1584 * method is not allowed to be called during preview. 1585 * 1586 * <p>If you want to make the camera image show in the same orientation as 1587 * the display, you can use the following code. 1588 * <pre> 1589 * public static void setCameraDisplayOrientation(Activity activity, 1590 * int cameraId, android.hardware.Camera camera) { 1591 * android.hardware.Camera.CameraInfo info = 1592 * new android.hardware.Camera.CameraInfo(); 1593 * android.hardware.Camera.getCameraInfo(cameraId, info); 1594 * int rotation = activity.getWindowManager().getDefaultDisplay() 1595 * .getRotation(); 1596 * int degrees = 0; 1597 * switch (rotation) { 1598 * case Surface.ROTATION_0: degrees = 0; break; 1599 * case Surface.ROTATION_90: degrees = 90; break; 1600 * case Surface.ROTATION_180: degrees = 180; break; 1601 * case Surface.ROTATION_270: degrees = 270; break; 1602 * } 1603 * 1604 * int result; 1605 * if (info.facing == Camera.CameraInfo.CAMERA_FACING_FRONT) { 1606 * result = (info.orientation + degrees) % 360; 1607 * result = (360 - result) % 360; // compensate the mirror 1608 * } else { // back-facing 1609 * result = (info.orientation - degrees + 360) % 360; 1610 * } 1611 * camera.setDisplayOrientation(result); 1612 * } 1613 * </pre> 1614 * 1615 * <p>Starting from API level 14, this method can be called when preview is 1616 * active. 1617 * 1618 * <p><b>Note: </b>Before API level 24, the default value for orientation is 0. Starting in 1619 * API level 24, the default orientation will be such that applications in forced-landscape mode 1620 * will have correct preview orientation, which may be either a default of 0 or 1621 * 180. Applications that operate in portrait mode or allow for changing orientation must still 1622 * call this method after each orientation change to ensure correct preview display in all 1623 * cases.</p> 1624 * 1625 * @param degrees the angle that the picture will be rotated clockwise. 1626 * Valid values are 0, 90, 180, and 270. 1627 * @throws RuntimeException if setting orientation fails; usually this would 1628 * be because of a hardware or other low-level error, or because 1629 * release() has been called on this Camera instance. 1630 * @see #setPreviewDisplay(SurfaceHolder) 1631 */ 1632 public native final void setDisplayOrientation(int degrees); 1633 1634 /** 1635 * <p>Enable or disable the default shutter sound when taking a picture.</p> 1636 * 1637 * <p>By default, the camera plays the system-defined camera shutter sound 1638 * when {@link #takePicture} is called. Using this method, the shutter sound 1639 * can be disabled. It is strongly recommended that an alternative shutter 1640 * sound is played in the {@link ShutterCallback} when the system shutter 1641 * sound is disabled.</p> 1642 * 1643 * <p>Note that devices may not always allow disabling the camera shutter 1644 * sound. If the shutter sound state cannot be set to the desired value, 1645 * this method will return false. {@link CameraInfo#canDisableShutterSound} 1646 * can be used to determine whether the device will allow the shutter sound 1647 * to be disabled.</p> 1648 * 1649 * @param enabled whether the camera should play the system shutter sound 1650 * when {@link #takePicture takePicture} is called. 1651 * @return {@code true} if the shutter sound state was successfully 1652 * changed. {@code false} if the shutter sound state could not be 1653 * changed. {@code true} is also returned if shutter sound playback 1654 * is already set to the requested state. 1655 * @throws RuntimeException if the call fails; usually this would be because 1656 * of a hardware or other low-level error, or because release() has been 1657 * called on this Camera instance. 1658 * @see #takePicture 1659 * @see CameraInfo#canDisableShutterSound 1660 * @see ShutterCallback 1661 */ 1662 public final boolean enableShutterSound(boolean enabled) { 1663 boolean canDisableShutterSound = true; 1664 IBinder b = ServiceManager.getService(Context.AUDIO_SERVICE); 1665 IAudioService audioService = IAudioService.Stub.asInterface(b); 1666 try { 1667 if (audioService.isCameraSoundForced()) { 1668 canDisableShutterSound = false; 1669 } 1670 } catch (RemoteException e) { 1671 Log.e(TAG, "Audio service is unavailable for queries"); 1672 } 1673 if (!enabled && !canDisableShutterSound) { 1674 return false; 1675 } 1676 synchronized (mShutterSoundLock) { 1677 mShutterSoundEnabledFromApp = enabled; 1678 // Return the result of _enableShutterSound(enabled) in all cases. 1679 // If the shutter sound can be disabled, disable it when the device is in DnD mode. 1680 boolean ret = _enableShutterSound(enabled); 1681 if (enabled && !mHasAppOpsPlayAudio) { 1682 Log.i(TAG, "Shutter sound is not allowed by AppOpsManager"); 1683 if (canDisableShutterSound) { 1684 _enableShutterSound(false); 1685 } 1686 } 1687 return ret; 1688 } 1689 } 1690 1691 /** 1692 * Disable the shutter sound unconditionally. 1693 * 1694 * <p> 1695 * This is only guaranteed to work for legacy cameras 1696 * (i.e. initialized with {@link #cameraInitUnspecified}). Trying to call this on 1697 * a regular camera will force a conditional check in the camera service. 1698 * </p> 1699 * 1700 * @return {@code true} if the shutter sound state was successfully 1701 * changed. {@code false} if the shutter sound state could not be 1702 * changed. {@code true} is also returned if shutter sound playback 1703 * is already set to the requested state. 1704 * 1705 * @hide 1706 */ 1707 public final boolean disableShutterSound() { 1708 return _enableShutterSound(/*enabled*/false); 1709 } 1710 1711 private native final boolean _enableShutterSound(boolean enabled); 1712 1713 private static class IAppOpsCallbackWrapper extends IAppOpsCallback.Stub { 1714 private final WeakReference<Camera> mWeakCamera; 1715 1716 IAppOpsCallbackWrapper(Camera camera) { 1717 mWeakCamera = new WeakReference<Camera>(camera); 1718 } 1719 1720 @Override 1721 public void opChanged(int op, int uid, String packageName) { 1722 if (op == AppOpsManager.OP_PLAY_AUDIO) { 1723 final Camera camera = mWeakCamera.get(); 1724 if (camera != null) { 1725 camera.updateAppOpsPlayAudio(); 1726 } 1727 } 1728 } 1729 } 1730 1731 private void updateAppOpsPlayAudio() { 1732 synchronized (mShutterSoundLock) { 1733 boolean oldHasAppOpsPlayAudio = mHasAppOpsPlayAudio; 1734 try { 1735 int mode = AppOpsManager.MODE_IGNORED; 1736 if (mAppOps != null) { 1737 mode = mAppOps.checkAudioOperation(AppOpsManager.OP_PLAY_AUDIO, 1738 AudioAttributes.USAGE_ASSISTANCE_SONIFICATION, 1739 Process.myUid(), ActivityThread.currentPackageName()); 1740 } 1741 mHasAppOpsPlayAudio = mode == AppOpsManager.MODE_ALLOWED; 1742 } catch (RemoteException e) { 1743 Log.e(TAG, "AppOpsService check audio operation failed"); 1744 mHasAppOpsPlayAudio = false; 1745 } 1746 if (oldHasAppOpsPlayAudio != mHasAppOpsPlayAudio) { 1747 if (!mHasAppOpsPlayAudio) { 1748 IBinder b = ServiceManager.getService(Context.AUDIO_SERVICE); 1749 IAudioService audioService = IAudioService.Stub.asInterface(b); 1750 try { 1751 if (audioService.isCameraSoundForced()) { 1752 return; 1753 } 1754 } catch (RemoteException e) { 1755 Log.e(TAG, "Audio service is unavailable for queries"); 1756 } 1757 _enableShutterSound(false); 1758 } else { 1759 enableShutterSound(mShutterSoundEnabledFromApp); 1760 } 1761 } 1762 } 1763 } 1764 1765 /** 1766 * Callback interface for zoom changes during a smooth zoom operation. 1767 * 1768 * @see #setZoomChangeListener(OnZoomChangeListener) 1769 * @see #startSmoothZoom(int) 1770 * 1771 * @deprecated We recommend using the new {@link android.hardware.camera2} API for new 1772 * applications. 1773 */ 1774 @Deprecated 1775 public interface OnZoomChangeListener 1776 { 1777 /** 1778 * Called when the zoom value has changed during a smooth zoom. 1779 * 1780 * @param zoomValue the current zoom value. In smooth zoom mode, camera 1781 * calls this for every new zoom value. 1782 * @param stopped whether smooth zoom is stopped. If the value is true, 1783 * this is the last zoom update for the application. 1784 * @param camera the Camera service object 1785 */ 1786 void onZoomChange(int zoomValue, boolean stopped, Camera camera); 1787 }; 1788 1789 /** 1790 * Registers a listener to be notified when the zoom value is updated by the 1791 * camera driver during smooth zoom. 1792 * 1793 * @param listener the listener to notify 1794 * @see #startSmoothZoom(int) 1795 */ 1796 public final void setZoomChangeListener(OnZoomChangeListener listener) 1797 { 1798 mZoomListener = listener; 1799 } 1800 1801 /** 1802 * Callback interface for face detected in the preview frame. 1803 * 1804 * @deprecated We recommend using the new {@link android.hardware.camera2} API for new 1805 * applications. 1806 */ 1807 @Deprecated 1808 public interface FaceDetectionListener 1809 { 1810 /** 1811 * Notify the listener of the detected faces in the preview frame. 1812 * 1813 * @param faces The detected faces in a list 1814 * @param camera The {@link Camera} service object 1815 */ 1816 void onFaceDetection(Face[] faces, Camera camera); 1817 } 1818 1819 /** 1820 * Registers a listener to be notified about the faces detected in the 1821 * preview frame. 1822 * 1823 * @param listener the listener to notify 1824 * @see #startFaceDetection() 1825 */ 1826 public final void setFaceDetectionListener(FaceDetectionListener listener) 1827 { 1828 mFaceListener = listener; 1829 } 1830 1831 /** 1832 * Starts the face detection. This should be called after preview is started. 1833 * The camera will notify {@link FaceDetectionListener} of the detected 1834 * faces in the preview frame. The detected faces may be the same as the 1835 * previous ones. Applications should call {@link #stopFaceDetection} to 1836 * stop the face detection. This method is supported if {@link 1837 * Parameters#getMaxNumDetectedFaces()} returns a number larger than 0. 1838 * If the face detection has started, apps should not call this again. 1839 * 1840 * <p>When the face detection is running, {@link Parameters#setWhiteBalance(String)}, 1841 * {@link Parameters#setFocusAreas(List)}, and {@link Parameters#setMeteringAreas(List)} 1842 * have no effect. The camera uses the detected faces to do auto-white balance, 1843 * auto exposure, and autofocus. 1844 * 1845 * <p>If the apps call {@link #autoFocus(AutoFocusCallback)}, the camera 1846 * will stop sending face callbacks. The last face callback indicates the 1847 * areas used to do autofocus. After focus completes, face detection will 1848 * resume sending face callbacks. If the apps call {@link 1849 * #cancelAutoFocus()}, the face callbacks will also resume.</p> 1850 * 1851 * <p>After calling {@link #takePicture(Camera.ShutterCallback, Camera.PictureCallback, 1852 * Camera.PictureCallback)} or {@link #stopPreview()}, and then resuming 1853 * preview with {@link #startPreview()}, the apps should call this method 1854 * again to resume face detection.</p> 1855 * 1856 * @throws IllegalArgumentException if the face detection is unsupported. 1857 * @throws RuntimeException if the method fails or the face detection is 1858 * already running. 1859 * @see FaceDetectionListener 1860 * @see #stopFaceDetection() 1861 * @see Parameters#getMaxNumDetectedFaces() 1862 */ 1863 public final void startFaceDetection() { 1864 if (mFaceDetectionRunning) { 1865 throw new RuntimeException("Face detection is already running"); 1866 } 1867 _startFaceDetection(CAMERA_FACE_DETECTION_HW); 1868 mFaceDetectionRunning = true; 1869 } 1870 1871 /** 1872 * Stops the face detection. 1873 * 1874 * @see #startFaceDetection() 1875 */ 1876 public final void stopFaceDetection() { 1877 _stopFaceDetection(); 1878 mFaceDetectionRunning = false; 1879 } 1880 1881 private native final void _startFaceDetection(int type); 1882 private native final void _stopFaceDetection(); 1883 1884 /** 1885 * Information about a face identified through camera face detection. 1886 * 1887 * <p>When face detection is used with a camera, the {@link FaceDetectionListener} returns a 1888 * list of face objects for use in focusing and metering.</p> 1889 * 1890 * @see FaceDetectionListener 1891 * @deprecated We recommend using the new {@link android.hardware.camera2} API for new 1892 * applications. 1893 */ 1894 @Deprecated 1895 public static class Face { 1896 /** 1897 * Create an empty face. 1898 */ 1899 public Face() { 1900 } 1901 1902 /** 1903 * Bounds of the face. (-1000, -1000) represents the top-left of the 1904 * camera field of view, and (1000, 1000) represents the bottom-right of 1905 * the field of view. For example, suppose the size of the viewfinder UI 1906 * is 800x480. The rect passed from the driver is (-1000, -1000, 0, 0). 1907 * The corresponding viewfinder rect should be (0, 0, 400, 240). It is 1908 * guaranteed left < right and top < bottom. The coordinates can be 1909 * smaller than -1000 or bigger than 1000. But at least one vertex will 1910 * be within (-1000, -1000) and (1000, 1000). 1911 * 1912 * <p>The direction is relative to the sensor orientation, that is, what 1913 * the sensor sees. The direction is not affected by the rotation or 1914 * mirroring of {@link #setDisplayOrientation(int)}. The face bounding 1915 * rectangle does not provide any information about face orientation.</p> 1916 * 1917 * <p>Here is the matrix to convert driver coordinates to View coordinates 1918 * in pixels.</p> 1919 * <pre> 1920 * Matrix matrix = new Matrix(); 1921 * CameraInfo info = CameraHolder.instance().getCameraInfo()[cameraId]; 1922 * // Need mirror for front camera. 1923 * boolean mirror = (info.facing == CameraInfo.CAMERA_FACING_FRONT); 1924 * matrix.setScale(mirror ? -1 : 1, 1); 1925 * // This is the value for android.hardware.Camera.setDisplayOrientation. 1926 * matrix.postRotate(displayOrientation); 1927 * // Camera driver coordinates range from (-1000, -1000) to (1000, 1000). 1928 * // UI coordinates range from (0, 0) to (width, height). 1929 * matrix.postScale(view.getWidth() / 2000f, view.getHeight() / 2000f); 1930 * matrix.postTranslate(view.getWidth() / 2f, view.getHeight() / 2f); 1931 * </pre> 1932 * 1933 * @see #startFaceDetection() 1934 */ 1935 public Rect rect; 1936 1937 /** 1938 * <p>The confidence level for the detection of the face. The range is 1 to 1939 * 100. 100 is the highest confidence.</p> 1940 * 1941 * <p>Depending on the device, even very low-confidence faces may be 1942 * listed, so applications should filter out faces with low confidence, 1943 * depending on the use case. For a typical point-and-shoot camera 1944 * application that wishes to display rectangles around detected faces, 1945 * filtering out faces with confidence less than 50 is recommended.</p> 1946 * 1947 * @see #startFaceDetection() 1948 */ 1949 public int score; 1950 1951 /** 1952 * An unique id per face while the face is visible to the tracker. If 1953 * the face leaves the field-of-view and comes back, it will get a new 1954 * id. This is an optional field, may not be supported on all devices. 1955 * If not supported, id will always be set to -1. The optional fields 1956 * are supported as a set. Either they are all valid, or none of them 1957 * are. 1958 */ 1959 public int id = -1; 1960 1961 /** 1962 * The coordinates of the center of the left eye. The coordinates are in 1963 * the same space as the ones for {@link #rect}. This is an optional 1964 * field, may not be supported on all devices. If not supported, the 1965 * value will always be set to null. The optional fields are supported 1966 * as a set. Either they are all valid, or none of them are. 1967 */ 1968 public Point leftEye = null; 1969 1970 /** 1971 * The coordinates of the center of the right eye. The coordinates are 1972 * in the same space as the ones for {@link #rect}.This is an optional 1973 * field, may not be supported on all devices. If not supported, the 1974 * value will always be set to null. The optional fields are supported 1975 * as a set. Either they are all valid, or none of them are. 1976 */ 1977 public Point rightEye = null; 1978 1979 /** 1980 * The coordinates of the center of the mouth. The coordinates are in 1981 * the same space as the ones for {@link #rect}. This is an optional 1982 * field, may not be supported on all devices. If not supported, the 1983 * value will always be set to null. The optional fields are supported 1984 * as a set. Either they are all valid, or none of them are. 1985 */ 1986 public Point mouth = null; 1987 } 1988 1989 /** 1990 * Unspecified camera error. 1991 * @see Camera.ErrorCallback 1992 */ 1993 public static final int CAMERA_ERROR_UNKNOWN = 1; 1994 1995 /** 1996 * Camera was disconnected due to use by higher priority user. 1997 * @see Camera.ErrorCallback 1998 */ 1999 public static final int CAMERA_ERROR_EVICTED = 2; 2000 2001 /** 2002 * Media server died. In this case, the application must release the 2003 * Camera object and instantiate a new one. 2004 * @see Camera.ErrorCallback 2005 */ 2006 public static final int CAMERA_ERROR_SERVER_DIED = 100; 2007 2008 /** 2009 * Callback interface for camera error notification. 2010 * 2011 * @see #setErrorCallback(ErrorCallback) 2012 * 2013 * @deprecated We recommend using the new {@link android.hardware.camera2} API for new 2014 * applications. 2015 */ 2016 @Deprecated 2017 public interface ErrorCallback 2018 { 2019 /** 2020 * Callback for camera errors. 2021 * @param error error code: 2022 * <ul> 2023 * <li>{@link #CAMERA_ERROR_UNKNOWN} 2024 * <li>{@link #CAMERA_ERROR_SERVER_DIED} 2025 * </ul> 2026 * @param camera the Camera service object 2027 */ 2028 void onError(int error, Camera camera); 2029 }; 2030 2031 /** 2032 * Registers a callback to be invoked when an error occurs. 2033 * @param cb The callback to run 2034 */ 2035 public final void setErrorCallback(ErrorCallback cb) 2036 { 2037 mErrorCallback = cb; 2038 } 2039 2040 private native final void native_setParameters(String params); 2041 private native final String native_getParameters(); 2042 2043 /** 2044 * Changes the settings for this Camera service. 2045 * 2046 * @param params the Parameters to use for this Camera service 2047 * @throws RuntimeException if any parameter is invalid or not supported. 2048 * @see #getParameters() 2049 */ 2050 public void setParameters(Parameters params) { 2051 // If using preview allocations, don't allow preview size changes 2052 if (mUsingPreviewAllocation) { 2053 Size newPreviewSize = params.getPreviewSize(); 2054 Size currentPreviewSize = getParameters().getPreviewSize(); 2055 if (newPreviewSize.width != currentPreviewSize.width || 2056 newPreviewSize.height != currentPreviewSize.height) { 2057 throw new IllegalStateException("Cannot change preview size" + 2058 " while a preview allocation is configured."); 2059 } 2060 } 2061 2062 native_setParameters(params.flatten()); 2063 } 2064 2065 /** 2066 * Returns the current settings for this Camera service. 2067 * If modifications are made to the returned Parameters, they must be passed 2068 * to {@link #setParameters(Camera.Parameters)} to take effect. 2069 * 2070 * @throws RuntimeException if reading parameters fails; usually this would 2071 * be because of a hardware or other low-level error, or because 2072 * release() has been called on this Camera instance. 2073 * @see #setParameters(Camera.Parameters) 2074 */ 2075 public Parameters getParameters() { 2076 Parameters p = new Parameters(); 2077 String s = native_getParameters(); 2078 p.unflatten(s); 2079 return p; 2080 } 2081 2082 /** 2083 * Returns an empty {@link Parameters} for testing purpose. 2084 * 2085 * @return a Parameter object. 2086 * 2087 * @hide 2088 */ 2089 public static Parameters getEmptyParameters() { 2090 Camera camera = new Camera(); 2091 return camera.new Parameters(); 2092 } 2093 2094 /** 2095 * Returns a copied {@link Parameters}; for shim use only. 2096 * 2097 * @param parameters a non-{@code null} parameters 2098 * @return a Parameter object, with all the parameters copied from {@code parameters}. 2099 * 2100 * @throws NullPointerException if {@code parameters} was {@code null} 2101 * @hide 2102 */ 2103 public static Parameters getParametersCopy(Camera.Parameters parameters) { 2104 if (parameters == null) { 2105 throw new NullPointerException("parameters must not be null"); 2106 } 2107 2108 Camera camera = parameters.getOuter(); 2109 Parameters p = camera.new Parameters(); 2110 p.copyFrom(parameters); 2111 2112 return p; 2113 } 2114 2115 /** 2116 * Image size (width and height dimensions). 2117 * @deprecated We recommend using the new {@link android.hardware.camera2} API for new 2118 * applications. 2119 */ 2120 @Deprecated 2121 public class Size { 2122 /** 2123 * Sets the dimensions for pictures. 2124 * 2125 * @param w the photo width (pixels) 2126 * @param h the photo height (pixels) 2127 */ 2128 public Size(int w, int h) { 2129 width = w; 2130 height = h; 2131 } 2132 /** 2133 * Compares {@code obj} to this size. 2134 * 2135 * @param obj the object to compare this size with. 2136 * @return {@code true} if the width and height of {@code obj} is the 2137 * same as those of this size. {@code false} otherwise. 2138 */ 2139 @Override 2140 public boolean equals(Object obj) { 2141 if (!(obj instanceof Size)) { 2142 return false; 2143 } 2144 Size s = (Size) obj; 2145 return width == s.width && height == s.height; 2146 } 2147 @Override 2148 public int hashCode() { 2149 return width * 32713 + height; 2150 } 2151 /** width of the picture */ 2152 public int width; 2153 /** height of the picture */ 2154 public int height; 2155 }; 2156 2157 /** 2158 * <p>The Area class is used for choosing specific metering and focus areas for 2159 * the camera to use when calculating auto-exposure, auto-white balance, and 2160 * auto-focus.</p> 2161 * 2162 * <p>To find out how many simultaneous areas a given camera supports, use 2163 * {@link Parameters#getMaxNumMeteringAreas()} and 2164 * {@link Parameters#getMaxNumFocusAreas()}. If metering or focusing area 2165 * selection is unsupported, these methods will return 0.</p> 2166 * 2167 * <p>Each Area consists of a rectangle specifying its bounds, and a weight 2168 * that determines its importance. The bounds are relative to the camera's 2169 * current field of view. The coordinates are mapped so that (-1000, -1000) 2170 * is always the top-left corner of the current field of view, and (1000, 2171 * 1000) is always the bottom-right corner of the current field of 2172 * view. Setting Areas with bounds outside that range is not allowed. Areas 2173 * with zero or negative width or height are not allowed.</p> 2174 * 2175 * <p>The weight must range from 1 to 1000, and represents a weight for 2176 * every pixel in the area. This means that a large metering area with 2177 * the same weight as a smaller area will have more effect in the 2178 * metering result. Metering areas can overlap and the driver 2179 * will add the weights in the overlap region.</p> 2180 * 2181 * @see Parameters#setFocusAreas(List) 2182 * @see Parameters#getFocusAreas() 2183 * @see Parameters#getMaxNumFocusAreas() 2184 * @see Parameters#setMeteringAreas(List) 2185 * @see Parameters#getMeteringAreas() 2186 * @see Parameters#getMaxNumMeteringAreas() 2187 * 2188 * @deprecated We recommend using the new {@link android.hardware.camera2} API for new 2189 * applications. 2190 */ 2191 @Deprecated 2192 public static class Area { 2193 /** 2194 * Create an area with specified rectangle and weight. 2195 * 2196 * @param rect the bounds of the area. 2197 * @param weight the weight of the area. 2198 */ 2199 public Area(Rect rect, int weight) { 2200 this.rect = rect; 2201 this.weight = weight; 2202 } 2203 /** 2204 * Compares {@code obj} to this area. 2205 * 2206 * @param obj the object to compare this area with. 2207 * @return {@code true} if the rectangle and weight of {@code obj} is 2208 * the same as those of this area. {@code false} otherwise. 2209 */ 2210 @Override 2211 public boolean equals(Object obj) { 2212 if (!(obj instanceof Area)) { 2213 return false; 2214 } 2215 Area a = (Area) obj; 2216 if (rect == null) { 2217 if (a.rect != null) return false; 2218 } else { 2219 if (!rect.equals(a.rect)) return false; 2220 } 2221 return weight == a.weight; 2222 } 2223 2224 /** 2225 * Bounds of the area. (-1000, -1000) represents the top-left of the 2226 * camera field of view, and (1000, 1000) represents the bottom-right of 2227 * the field of view. Setting bounds outside that range is not 2228 * allowed. Bounds with zero or negative width or height are not 2229 * allowed. 2230 * 2231 * @see Parameters#getFocusAreas() 2232 * @see Parameters#getMeteringAreas() 2233 */ 2234 public Rect rect; 2235 2236 /** 2237 * Weight of the area. The weight must range from 1 to 1000, and 2238 * represents a weight for every pixel in the area. This means that a 2239 * large metering area with the same weight as a smaller area will have 2240 * more effect in the metering result. Metering areas can overlap and 2241 * the driver will add the weights in the overlap region. 2242 * 2243 * @see Parameters#getFocusAreas() 2244 * @see Parameters#getMeteringAreas() 2245 */ 2246 public int weight; 2247 } 2248 2249 /** 2250 * Camera service settings. 2251 * 2252 * <p>To make camera parameters take effect, applications have to call 2253 * {@link Camera#setParameters(Camera.Parameters)}. For example, after 2254 * {@link Camera.Parameters#setWhiteBalance} is called, white balance is not 2255 * actually changed until {@link Camera#setParameters(Camera.Parameters)} 2256 * is called with the changed parameters object. 2257 * 2258 * <p>Different devices may have different camera capabilities, such as 2259 * picture size or flash modes. The application should query the camera 2260 * capabilities before setting parameters. For example, the application 2261 * should call {@link Camera.Parameters#getSupportedColorEffects()} before 2262 * calling {@link Camera.Parameters#setColorEffect(String)}. If the 2263 * camera does not support color effects, 2264 * {@link Camera.Parameters#getSupportedColorEffects()} will return null. 2265 * 2266 * @deprecated We recommend using the new {@link android.hardware.camera2} API for new 2267 * applications. 2268 */ 2269 @Deprecated 2270 public class Parameters { 2271 // Parameter keys to communicate with the camera driver. 2272 private static final String KEY_PREVIEW_SIZE = "preview-size"; 2273 private static final String KEY_PREVIEW_FORMAT = "preview-format"; 2274 private static final String KEY_PREVIEW_FRAME_RATE = "preview-frame-rate"; 2275 private static final String KEY_PREVIEW_FPS_RANGE = "preview-fps-range"; 2276 private static final String KEY_PICTURE_SIZE = "picture-size"; 2277 private static final String KEY_PICTURE_FORMAT = "picture-format"; 2278 private static final String KEY_JPEG_THUMBNAIL_SIZE = "jpeg-thumbnail-size"; 2279 private static final String KEY_JPEG_THUMBNAIL_WIDTH = "jpeg-thumbnail-width"; 2280 private static final String KEY_JPEG_THUMBNAIL_HEIGHT = "jpeg-thumbnail-height"; 2281 private static final String KEY_JPEG_THUMBNAIL_QUALITY = "jpeg-thumbnail-quality"; 2282 private static final String KEY_JPEG_QUALITY = "jpeg-quality"; 2283 private static final String KEY_ROTATION = "rotation"; 2284 private static final String KEY_GPS_LATITUDE = "gps-latitude"; 2285 private static final String KEY_GPS_LONGITUDE = "gps-longitude"; 2286 private static final String KEY_GPS_ALTITUDE = "gps-altitude"; 2287 private static final String KEY_GPS_TIMESTAMP = "gps-timestamp"; 2288 private static final String KEY_GPS_PROCESSING_METHOD = "gps-processing-method"; 2289 private static final String KEY_WHITE_BALANCE = "whitebalance"; 2290 private static final String KEY_EFFECT = "effect"; 2291 private static final String KEY_ANTIBANDING = "antibanding"; 2292 private static final String KEY_SCENE_MODE = "scene-mode"; 2293 private static final String KEY_FLASH_MODE = "flash-mode"; 2294 private static final String KEY_FOCUS_MODE = "focus-mode"; 2295 private static final String KEY_FOCUS_AREAS = "focus-areas"; 2296 private static final String KEY_MAX_NUM_FOCUS_AREAS = "max-num-focus-areas"; 2297 private static final String KEY_FOCAL_LENGTH = "focal-length"; 2298 private static final String KEY_HORIZONTAL_VIEW_ANGLE = "horizontal-view-angle"; 2299 private static final String KEY_VERTICAL_VIEW_ANGLE = "vertical-view-angle"; 2300 private static final String KEY_EXPOSURE_COMPENSATION = "exposure-compensation"; 2301 private static final String KEY_MAX_EXPOSURE_COMPENSATION = "max-exposure-compensation"; 2302 private static final String KEY_MIN_EXPOSURE_COMPENSATION = "min-exposure-compensation"; 2303 private static final String KEY_EXPOSURE_COMPENSATION_STEP = "exposure-compensation-step"; 2304 private static final String KEY_AUTO_EXPOSURE_LOCK = "auto-exposure-lock"; 2305 private static final String KEY_AUTO_EXPOSURE_LOCK_SUPPORTED = "auto-exposure-lock-supported"; 2306 private static final String KEY_AUTO_WHITEBALANCE_LOCK = "auto-whitebalance-lock"; 2307 private static final String KEY_AUTO_WHITEBALANCE_LOCK_SUPPORTED = "auto-whitebalance-lock-supported"; 2308 private static final String KEY_METERING_AREAS = "metering-areas"; 2309 private static final String KEY_MAX_NUM_METERING_AREAS = "max-num-metering-areas"; 2310 private static final String KEY_ZOOM = "zoom"; 2311 private static final String KEY_MAX_ZOOM = "max-zoom"; 2312 private static final String KEY_ZOOM_RATIOS = "zoom-ratios"; 2313 private static final String KEY_ZOOM_SUPPORTED = "zoom-supported"; 2314 private static final String KEY_SMOOTH_ZOOM_SUPPORTED = "smooth-zoom-supported"; 2315 private static final String KEY_FOCUS_DISTANCES = "focus-distances"; 2316 private static final String KEY_VIDEO_SIZE = "video-size"; 2317 private static final String KEY_PREFERRED_PREVIEW_SIZE_FOR_VIDEO = 2318 "preferred-preview-size-for-video"; 2319 private static final String KEY_MAX_NUM_DETECTED_FACES_HW = "max-num-detected-faces-hw"; 2320 private static final String KEY_MAX_NUM_DETECTED_FACES_SW = "max-num-detected-faces-sw"; 2321 private static final String KEY_RECORDING_HINT = "recording-hint"; 2322 private static final String KEY_VIDEO_SNAPSHOT_SUPPORTED = "video-snapshot-supported"; 2323 private static final String KEY_VIDEO_STABILIZATION = "video-stabilization"; 2324 private static final String KEY_VIDEO_STABILIZATION_SUPPORTED = "video-stabilization-supported"; 2325 2326 // Parameter key suffix for supported values. 2327 private static final String SUPPORTED_VALUES_SUFFIX = "-values"; 2328 2329 private static final String TRUE = "true"; 2330 private static final String FALSE = "false"; 2331 2332 // Values for white balance settings. 2333 public static final String WHITE_BALANCE_AUTO = "auto"; 2334 public static final String WHITE_BALANCE_INCANDESCENT = "incandescent"; 2335 public static final String WHITE_BALANCE_FLUORESCENT = "fluorescent"; 2336 public static final String WHITE_BALANCE_WARM_FLUORESCENT = "warm-fluorescent"; 2337 public static final String WHITE_BALANCE_DAYLIGHT = "daylight"; 2338 public static final String WHITE_BALANCE_CLOUDY_DAYLIGHT = "cloudy-daylight"; 2339 public static final String WHITE_BALANCE_TWILIGHT = "twilight"; 2340 public static final String WHITE_BALANCE_SHADE = "shade"; 2341 2342 // Values for color effect settings. 2343 public static final String EFFECT_NONE = "none"; 2344 public static final String EFFECT_MONO = "mono"; 2345 public static final String EFFECT_NEGATIVE = "negative"; 2346 public static final String EFFECT_SOLARIZE = "solarize"; 2347 public static final String EFFECT_SEPIA = "sepia"; 2348 public static final String EFFECT_POSTERIZE = "posterize"; 2349 public static final String EFFECT_WHITEBOARD = "whiteboard"; 2350 public static final String EFFECT_BLACKBOARD = "blackboard"; 2351 public static final String EFFECT_AQUA = "aqua"; 2352 2353 // Values for antibanding settings. 2354 public static final String ANTIBANDING_AUTO = "auto"; 2355 public static final String ANTIBANDING_50HZ = "50hz"; 2356 public static final String ANTIBANDING_60HZ = "60hz"; 2357 public static final String ANTIBANDING_OFF = "off"; 2358 2359 // Values for flash mode settings. 2360 /** 2361 * Flash will not be fired. 2362 */ 2363 public static final String FLASH_MODE_OFF = "off"; 2364 2365 /** 2366 * Flash will be fired automatically when required. The flash may be fired 2367 * during preview, auto-focus, or snapshot depending on the driver. 2368 */ 2369 public static final String FLASH_MODE_AUTO = "auto"; 2370 2371 /** 2372 * Flash will always be fired during snapshot. The flash may also be 2373 * fired during preview or auto-focus depending on the driver. 2374 */ 2375 public static final String FLASH_MODE_ON = "on"; 2376 2377 /** 2378 * Flash will be fired in red-eye reduction mode. 2379 */ 2380 public static final String FLASH_MODE_RED_EYE = "red-eye"; 2381 2382 /** 2383 * Constant emission of light during preview, auto-focus and snapshot. 2384 * This can also be used for video recording. 2385 */ 2386 public static final String FLASH_MODE_TORCH = "torch"; 2387 2388 /** 2389 * Scene mode is off. 2390 */ 2391 public static final String SCENE_MODE_AUTO = "auto"; 2392 2393 /** 2394 * Take photos of fast moving objects. Same as {@link 2395 * #SCENE_MODE_SPORTS}. 2396 */ 2397 public static final String SCENE_MODE_ACTION = "action"; 2398 2399 /** 2400 * Take people pictures. 2401 */ 2402 public static final String SCENE_MODE_PORTRAIT = "portrait"; 2403 2404 /** 2405 * Take pictures on distant objects. 2406 */ 2407 public static final String SCENE_MODE_LANDSCAPE = "landscape"; 2408 2409 /** 2410 * Take photos at night. 2411 */ 2412 public static final String SCENE_MODE_NIGHT = "night"; 2413 2414 /** 2415 * Take people pictures at night. 2416 */ 2417 public static final String SCENE_MODE_NIGHT_PORTRAIT = "night-portrait"; 2418 2419 /** 2420 * Take photos in a theater. Flash light is off. 2421 */ 2422 public static final String SCENE_MODE_THEATRE = "theatre"; 2423 2424 /** 2425 * Take pictures on the beach. 2426 */ 2427 public static final String SCENE_MODE_BEACH = "beach"; 2428 2429 /** 2430 * Take pictures on the snow. 2431 */ 2432 public static final String SCENE_MODE_SNOW = "snow"; 2433 2434 /** 2435 * Take sunset photos. 2436 */ 2437 public static final String SCENE_MODE_SUNSET = "sunset"; 2438 2439 /** 2440 * Avoid blurry pictures (for example, due to hand shake). 2441 */ 2442 public static final String SCENE_MODE_STEADYPHOTO = "steadyphoto"; 2443 2444 /** 2445 * For shooting firework displays. 2446 */ 2447 public static final String SCENE_MODE_FIREWORKS = "fireworks"; 2448 2449 /** 2450 * Take photos of fast moving objects. Same as {@link 2451 * #SCENE_MODE_ACTION}. 2452 */ 2453 public static final String SCENE_MODE_SPORTS = "sports"; 2454 2455 /** 2456 * Take indoor low-light shot. 2457 */ 2458 public static final String SCENE_MODE_PARTY = "party"; 2459 2460 /** 2461 * Capture the naturally warm color of scenes lit by candles. 2462 */ 2463 public static final String SCENE_MODE_CANDLELIGHT = "candlelight"; 2464 2465 /** 2466 * Applications are looking for a barcode. Camera driver will be 2467 * optimized for barcode reading. 2468 */ 2469 public static final String SCENE_MODE_BARCODE = "barcode"; 2470 2471 /** 2472 * Capture a scene using high dynamic range imaging techniques. The 2473 * camera will return an image that has an extended dynamic range 2474 * compared to a regular capture. Capturing such an image may take 2475 * longer than a regular capture. 2476 */ 2477 public static final String SCENE_MODE_HDR = "hdr"; 2478 2479 /** 2480 * Auto-focus mode. Applications should call {@link 2481 * #autoFocus(AutoFocusCallback)} to start the focus in this mode. 2482 */ 2483 public static final String FOCUS_MODE_AUTO = "auto"; 2484 2485 /** 2486 * Focus is set at infinity. Applications should not call 2487 * {@link #autoFocus(AutoFocusCallback)} in this mode. 2488 */ 2489 public static final String FOCUS_MODE_INFINITY = "infinity"; 2490 2491 /** 2492 * Macro (close-up) focus mode. Applications should call 2493 * {@link #autoFocus(AutoFocusCallback)} to start the focus in this 2494 * mode. 2495 */ 2496 public static final String FOCUS_MODE_MACRO = "macro"; 2497 2498 /** 2499 * Focus is fixed. The camera is always in this mode if the focus is not 2500 * adjustable. If the camera has auto-focus, this mode can fix the 2501 * focus, which is usually at hyperfocal distance. Applications should 2502 * not call {@link #autoFocus(AutoFocusCallback)} in this mode. 2503 */ 2504 public static final String FOCUS_MODE_FIXED = "fixed"; 2505 2506 /** 2507 * Extended depth of field (EDOF). Focusing is done digitally and 2508 * continuously. Applications should not call {@link 2509 * #autoFocus(AutoFocusCallback)} in this mode. 2510 */ 2511 public static final String FOCUS_MODE_EDOF = "edof"; 2512 2513 /** 2514 * Continuous auto focus mode intended for video recording. The camera 2515 * continuously tries to focus. This is the best choice for video 2516 * recording because the focus changes smoothly . Applications still can 2517 * call {@link #takePicture(Camera.ShutterCallback, 2518 * Camera.PictureCallback, Camera.PictureCallback)} in this mode but the 2519 * subject may not be in focus. Auto focus starts when the parameter is 2520 * set. 2521 * 2522 * <p>Since API level 14, applications can call {@link 2523 * #autoFocus(AutoFocusCallback)} in this mode. The focus callback will 2524 * immediately return with a boolean that indicates whether the focus is 2525 * sharp or not. The focus position is locked after autoFocus call. If 2526 * applications want to resume the continuous focus, cancelAutoFocus 2527 * must be called. Restarting the preview will not resume the continuous 2528 * autofocus. To stop continuous focus, applications should change the 2529 * focus mode to other modes. 2530 * 2531 * @see #FOCUS_MODE_CONTINUOUS_PICTURE 2532 */ 2533 public static final String FOCUS_MODE_CONTINUOUS_VIDEO = "continuous-video"; 2534 2535 /** 2536 * Continuous auto focus mode intended for taking pictures. The camera 2537 * continuously tries to focus. The speed of focus change is more 2538 * aggressive than {@link #FOCUS_MODE_CONTINUOUS_VIDEO}. Auto focus 2539 * starts when the parameter is set. 2540 * 2541 * <p>Applications can call {@link #autoFocus(AutoFocusCallback)} in 2542 * this mode. If the autofocus is in the middle of scanning, the focus 2543 * callback will return when it completes. If the autofocus is not 2544 * scanning, the focus callback will immediately return with a boolean 2545 * that indicates whether the focus is sharp or not. The apps can then 2546 * decide if they want to take a picture immediately or to change the 2547 * focus mode to auto, and run a full autofocus cycle. The focus 2548 * position is locked after autoFocus call. If applications want to 2549 * resume the continuous focus, cancelAutoFocus must be called. 2550 * Restarting the preview will not resume the continuous autofocus. To 2551 * stop continuous focus, applications should change the focus mode to 2552 * other modes. 2553 * 2554 * @see #FOCUS_MODE_CONTINUOUS_VIDEO 2555 */ 2556 public static final String FOCUS_MODE_CONTINUOUS_PICTURE = "continuous-picture"; 2557 2558 // Indices for focus distance array. 2559 /** 2560 * The array index of near focus distance for use with 2561 * {@link #getFocusDistances(float[])}. 2562 */ 2563 public static final int FOCUS_DISTANCE_NEAR_INDEX = 0; 2564 2565 /** 2566 * The array index of optimal focus distance for use with 2567 * {@link #getFocusDistances(float[])}. 2568 */ 2569 public static final int FOCUS_DISTANCE_OPTIMAL_INDEX = 1; 2570 2571 /** 2572 * The array index of far focus distance for use with 2573 * {@link #getFocusDistances(float[])}. 2574 */ 2575 public static final int FOCUS_DISTANCE_FAR_INDEX = 2; 2576 2577 /** 2578 * The array index of minimum preview fps for use with {@link 2579 * #getPreviewFpsRange(int[])} or {@link 2580 * #getSupportedPreviewFpsRange()}. 2581 */ 2582 public static final int PREVIEW_FPS_MIN_INDEX = 0; 2583 2584 /** 2585 * The array index of maximum preview fps for use with {@link 2586 * #getPreviewFpsRange(int[])} or {@link 2587 * #getSupportedPreviewFpsRange()}. 2588 */ 2589 public static final int PREVIEW_FPS_MAX_INDEX = 1; 2590 2591 // Formats for setPreviewFormat and setPictureFormat. 2592 private static final String PIXEL_FORMAT_YUV422SP = "yuv422sp"; 2593 private static final String PIXEL_FORMAT_YUV420SP = "yuv420sp"; 2594 private static final String PIXEL_FORMAT_YUV422I = "yuv422i-yuyv"; 2595 private static final String PIXEL_FORMAT_YUV420P = "yuv420p"; 2596 private static final String PIXEL_FORMAT_RGB565 = "rgb565"; 2597 private static final String PIXEL_FORMAT_JPEG = "jpeg"; 2598 private static final String PIXEL_FORMAT_BAYER_RGGB = "bayer-rggb"; 2599 2600 /** 2601 * Order matters: Keys that are {@link #set(String, String) set} later 2602 * will take precedence over keys that are set earlier (if the two keys 2603 * conflict with each other). 2604 * 2605 * <p>One example is {@link #setPreviewFpsRange(int, int)} , since it 2606 * conflicts with {@link #setPreviewFrameRate(int)} whichever key is set later 2607 * is the one that will take precedence. 2608 * </p> 2609 */ 2610 private final LinkedHashMap<String, String> mMap; 2611 2612 private Parameters() { 2613 mMap = new LinkedHashMap<String, String>(/*initialCapacity*/64); 2614 } 2615 2616 /** 2617 * Overwrite existing parameters with a copy of the ones from {@code other}. 2618 * 2619 * <b>For use by the legacy shim only.</b> 2620 * 2621 * @hide 2622 */ 2623 public void copyFrom(Parameters other) { 2624 if (other == null) { 2625 throw new NullPointerException("other must not be null"); 2626 } 2627 2628 mMap.putAll(other.mMap); 2629 } 2630 2631 private Camera getOuter() { 2632 return Camera.this; 2633 } 2634 2635 2636 /** 2637 * Value equality check. 2638 * 2639 * @hide 2640 */ 2641 public boolean same(Parameters other) { 2642 if (this == other) { 2643 return true; 2644 } 2645 return other != null && Parameters.this.mMap.equals(other.mMap); 2646 } 2647 2648 /** 2649 * Writes the current Parameters to the log. 2650 * @hide 2651 * @deprecated 2652 */ 2653 @Deprecated 2654 public void dump() { 2655 Log.e(TAG, "dump: size=" + mMap.size()); 2656 for (String k : mMap.keySet()) { 2657 Log.e(TAG, "dump: " + k + "=" + mMap.get(k)); 2658 } 2659 } 2660 2661 /** 2662 * Creates a single string with all the parameters set in 2663 * this Parameters object. 2664 * <p>The {@link #unflatten(String)} method does the reverse.</p> 2665 * 2666 * @return a String with all values from this Parameters object, in 2667 * semi-colon delimited key-value pairs 2668 */ 2669 public String flatten() { 2670 StringBuilder flattened = new StringBuilder(128); 2671 for (String k : mMap.keySet()) { 2672 flattened.append(k); 2673 flattened.append("="); 2674 flattened.append(mMap.get(k)); 2675 flattened.append(";"); 2676 } 2677 // chop off the extra semicolon at the end 2678 flattened.deleteCharAt(flattened.length()-1); 2679 return flattened.toString(); 2680 } 2681 2682 /** 2683 * Takes a flattened string of parameters and adds each one to 2684 * this Parameters object. 2685 * <p>The {@link #flatten()} method does the reverse.</p> 2686 * 2687 * @param flattened a String of parameters (key-value paired) that 2688 * are semi-colon delimited 2689 */ 2690 public void unflatten(String flattened) { 2691 mMap.clear(); 2692 2693 TextUtils.StringSplitter splitter = new TextUtils.SimpleStringSplitter(';'); 2694 splitter.setString(flattened); 2695 for (String kv : splitter) { 2696 int pos = kv.indexOf('='); 2697 if (pos == -1) { 2698 continue; 2699 } 2700 String k = kv.substring(0, pos); 2701 String v = kv.substring(pos + 1); 2702 mMap.put(k, v); 2703 } 2704 } 2705 2706 public void remove(String key) { 2707 mMap.remove(key); 2708 } 2709 2710 /** 2711 * Sets a String parameter. 2712 * 2713 * @param key the key name for the parameter 2714 * @param value the String value of the parameter 2715 */ 2716 public void set(String key, String value) { 2717 if (key.indexOf('=') != -1 || key.indexOf(';') != -1 || key.indexOf(0) != -1) { 2718 Log.e(TAG, "Key \"" + key + "\" contains invalid character (= or ; or \\0)"); 2719 return; 2720 } 2721 if (value.indexOf('=') != -1 || value.indexOf(';') != -1 || value.indexOf(0) != -1) { 2722 Log.e(TAG, "Value \"" + value + "\" contains invalid character (= or ; or \\0)"); 2723 return; 2724 } 2725 2726 put(key, value); 2727 } 2728 2729 /** 2730 * Sets an integer parameter. 2731 * 2732 * @param key the key name for the parameter 2733 * @param value the int value of the parameter 2734 */ 2735 public void set(String key, int value) { 2736 put(key, Integer.toString(value)); 2737 } 2738 2739 private void put(String key, String value) { 2740 /* 2741 * Remove the key if it already exists. 2742 * 2743 * This way setting a new value for an already existing key will always move 2744 * that key to be ordered the latest in the map. 2745 */ 2746 mMap.remove(key); 2747 mMap.put(key, value); 2748 } 2749 2750 private void set(String key, List<Area> areas) { 2751 if (areas == null) { 2752 set(key, "(0,0,0,0,0)"); 2753 } else { 2754 StringBuilder buffer = new StringBuilder(); 2755 for (int i = 0; i < areas.size(); i++) { 2756 Area area = areas.get(i); 2757 Rect rect = area.rect; 2758 buffer.append('('); 2759 buffer.append(rect.left); 2760 buffer.append(','); 2761 buffer.append(rect.top); 2762 buffer.append(','); 2763 buffer.append(rect.right); 2764 buffer.append(','); 2765 buffer.append(rect.bottom); 2766 buffer.append(','); 2767 buffer.append(area.weight); 2768 buffer.append(')'); 2769 if (i != areas.size() - 1) buffer.append(','); 2770 } 2771 set(key, buffer.toString()); 2772 } 2773 } 2774 2775 /** 2776 * Returns the value of a String parameter. 2777 * 2778 * @param key the key name for the parameter 2779 * @return the String value of the parameter 2780 */ 2781 public String get(String key) { 2782 return mMap.get(key); 2783 } 2784 2785 /** 2786 * Returns the value of an integer parameter. 2787 * 2788 * @param key the key name for the parameter 2789 * @return the int value of the parameter 2790 */ 2791 public int getInt(String key) { 2792 return Integer.parseInt(mMap.get(key)); 2793 } 2794 2795 /** 2796 * Sets the dimensions for preview pictures. If the preview has already 2797 * started, applications should stop the preview first before changing 2798 * preview size. 2799 * 2800 * The sides of width and height are based on camera orientation. That 2801 * is, the preview size is the size before it is rotated by display 2802 * orientation. So applications need to consider the display orientation 2803 * while setting preview size. For example, suppose the camera supports 2804 * both 480x320 and 320x480 preview sizes. The application wants a 3:2 2805 * preview ratio. If the display orientation is set to 0 or 180, preview 2806 * size should be set to 480x320. If the display orientation is set to 2807 * 90 or 270, preview size should be set to 320x480. The display 2808 * orientation should also be considered while setting picture size and 2809 * thumbnail size. 2810 * 2811 * @param width the width of the pictures, in pixels 2812 * @param height the height of the pictures, in pixels 2813 * @see #setDisplayOrientation(int) 2814 * @see #getCameraInfo(int, CameraInfo) 2815 * @see #setPictureSize(int, int) 2816 * @see #setJpegThumbnailSize(int, int) 2817 */ 2818 public void setPreviewSize(int width, int height) { 2819 String v = Integer.toString(width) + "x" + Integer.toString(height); 2820 set(KEY_PREVIEW_SIZE, v); 2821 } 2822 2823 /** 2824 * Returns the dimensions setting for preview pictures. 2825 * 2826 * @return a Size object with the width and height setting 2827 * for the preview picture 2828 */ 2829 public Size getPreviewSize() { 2830 String pair = get(KEY_PREVIEW_SIZE); 2831 return strToSize(pair); 2832 } 2833 2834 /** 2835 * Gets the supported preview sizes. 2836 * 2837 * @return a list of Size object. This method will always return a list 2838 * with at least one element. 2839 */ 2840 public List<Size> getSupportedPreviewSizes() { 2841 String str = get(KEY_PREVIEW_SIZE + SUPPORTED_VALUES_SUFFIX); 2842 return splitSize(str); 2843 } 2844 2845 /** 2846 * <p>Gets the supported video frame sizes that can be used by 2847 * MediaRecorder.</p> 2848 * 2849 * <p>If the returned list is not null, the returned list will contain at 2850 * least one Size and one of the sizes in the returned list must be 2851 * passed to MediaRecorder.setVideoSize() for camcorder application if 2852 * camera is used as the video source. In this case, the size of the 2853 * preview can be different from the resolution of the recorded video 2854 * during video recording.</p> 2855 * 2856 * @return a list of Size object if camera has separate preview and 2857 * video output; otherwise, null is returned. 2858 * @see #getPreferredPreviewSizeForVideo() 2859 */ 2860 public List<Size> getSupportedVideoSizes() { 2861 String str = get(KEY_VIDEO_SIZE + SUPPORTED_VALUES_SUFFIX); 2862 return splitSize(str); 2863 } 2864 2865 /** 2866 * Returns the preferred or recommended preview size (width and height) 2867 * in pixels for video recording. Camcorder applications should 2868 * set the preview size to a value that is not larger than the 2869 * preferred preview size. In other words, the product of the width 2870 * and height of the preview size should not be larger than that of 2871 * the preferred preview size. In addition, we recommend to choose a 2872 * preview size that has the same aspect ratio as the resolution of 2873 * video to be recorded. 2874 * 2875 * @return the preferred preview size (width and height) in pixels for 2876 * video recording if getSupportedVideoSizes() does not return 2877 * null; otherwise, null is returned. 2878 * @see #getSupportedVideoSizes() 2879 */ 2880 public Size getPreferredPreviewSizeForVideo() { 2881 String pair = get(KEY_PREFERRED_PREVIEW_SIZE_FOR_VIDEO); 2882 return strToSize(pair); 2883 } 2884 2885 /** 2886 * <p>Sets the dimensions for EXIF thumbnail in Jpeg picture. If 2887 * applications set both width and height to 0, EXIF will not contain 2888 * thumbnail.</p> 2889 * 2890 * <p>Applications need to consider the display orientation. See {@link 2891 * #setPreviewSize(int,int)} for reference.</p> 2892 * 2893 * @param width the width of the thumbnail, in pixels 2894 * @param height the height of the thumbnail, in pixels 2895 * @see #setPreviewSize(int,int) 2896 */ 2897 public void setJpegThumbnailSize(int width, int height) { 2898 set(KEY_JPEG_THUMBNAIL_WIDTH, width); 2899 set(KEY_JPEG_THUMBNAIL_HEIGHT, height); 2900 } 2901 2902 /** 2903 * Returns the dimensions for EXIF thumbnail in Jpeg picture. 2904 * 2905 * @return a Size object with the height and width setting for the EXIF 2906 * thumbnails 2907 */ 2908 public Size getJpegThumbnailSize() { 2909 return new Size(getInt(KEY_JPEG_THUMBNAIL_WIDTH), 2910 getInt(KEY_JPEG_THUMBNAIL_HEIGHT)); 2911 } 2912 2913 /** 2914 * Gets the supported jpeg thumbnail sizes. 2915 * 2916 * @return a list of Size object. This method will always return a list 2917 * with at least two elements. Size 0,0 (no thumbnail) is always 2918 * supported. 2919 */ 2920 public List<Size> getSupportedJpegThumbnailSizes() { 2921 String str = get(KEY_JPEG_THUMBNAIL_SIZE + SUPPORTED_VALUES_SUFFIX); 2922 return splitSize(str); 2923 } 2924 2925 /** 2926 * Sets the quality of the EXIF thumbnail in Jpeg picture. 2927 * 2928 * @param quality the JPEG quality of the EXIF thumbnail. The range is 1 2929 * to 100, with 100 being the best. 2930 */ 2931 public void setJpegThumbnailQuality(int quality) { 2932 set(KEY_JPEG_THUMBNAIL_QUALITY, quality); 2933 } 2934 2935 /** 2936 * Returns the quality setting for the EXIF thumbnail in Jpeg picture. 2937 * 2938 * @return the JPEG quality setting of the EXIF thumbnail. 2939 */ 2940 public int getJpegThumbnailQuality() { 2941 return getInt(KEY_JPEG_THUMBNAIL_QUALITY); 2942 } 2943 2944 /** 2945 * Sets Jpeg quality of captured picture. 2946 * 2947 * @param quality the JPEG quality of captured picture. The range is 1 2948 * to 100, with 100 being the best. 2949 */ 2950 public void setJpegQuality(int quality) { 2951 set(KEY_JPEG_QUALITY, quality); 2952 } 2953 2954 /** 2955 * Returns the quality setting for the JPEG picture. 2956 * 2957 * @return the JPEG picture quality setting. 2958 */ 2959 public int getJpegQuality() { 2960 return getInt(KEY_JPEG_QUALITY); 2961 } 2962 2963 /** 2964 * Sets the rate at which preview frames are received. This is the 2965 * target frame rate. The actual frame rate depends on the driver. 2966 * 2967 * @param fps the frame rate (frames per second) 2968 * @deprecated replaced by {@link #setPreviewFpsRange(int,int)} 2969 */ 2970 @Deprecated 2971 public void setPreviewFrameRate(int fps) { 2972 set(KEY_PREVIEW_FRAME_RATE, fps); 2973 } 2974 2975 /** 2976 * Returns the setting for the rate at which preview frames are 2977 * received. This is the target frame rate. The actual frame rate 2978 * depends on the driver. 2979 * 2980 * @return the frame rate setting (frames per second) 2981 * @deprecated replaced by {@link #getPreviewFpsRange(int[])} 2982 */ 2983 @Deprecated 2984 public int getPreviewFrameRate() { 2985 return getInt(KEY_PREVIEW_FRAME_RATE); 2986 } 2987 2988 /** 2989 * Gets the supported preview frame rates. 2990 * 2991 * @return a list of supported preview frame rates. null if preview 2992 * frame rate setting is not supported. 2993 * @deprecated replaced by {@link #getSupportedPreviewFpsRange()} 2994 */ 2995 @Deprecated 2996 public List<Integer> getSupportedPreviewFrameRates() { 2997 String str = get(KEY_PREVIEW_FRAME_RATE + SUPPORTED_VALUES_SUFFIX); 2998 return splitInt(str); 2999 } 3000 3001 /** 3002 * Sets the minimum and maximum preview fps. This controls the rate of 3003 * preview frames received in {@link PreviewCallback}. The minimum and 3004 * maximum preview fps must be one of the elements from {@link 3005 * #getSupportedPreviewFpsRange}. 3006 * 3007 * @param min the minimum preview fps (scaled by 1000). 3008 * @param max the maximum preview fps (scaled by 1000). 3009 * @throws RuntimeException if fps range is invalid. 3010 * @see #setPreviewCallbackWithBuffer(Camera.PreviewCallback) 3011 * @see #getSupportedPreviewFpsRange() 3012 */ 3013 public void setPreviewFpsRange(int min, int max) { 3014 set(KEY_PREVIEW_FPS_RANGE, "" + min + "," + max); 3015 } 3016 3017 /** 3018 * Returns the current minimum and maximum preview fps. The values are 3019 * one of the elements returned by {@link #getSupportedPreviewFpsRange}. 3020 * 3021 * @return range the minimum and maximum preview fps (scaled by 1000). 3022 * @see #PREVIEW_FPS_MIN_INDEX 3023 * @see #PREVIEW_FPS_MAX_INDEX 3024 * @see #getSupportedPreviewFpsRange() 3025 */ 3026 public void getPreviewFpsRange(int[] range) { 3027 if (range == null || range.length != 2) { 3028 throw new IllegalArgumentException( 3029 "range must be an array with two elements."); 3030 } 3031 splitInt(get(KEY_PREVIEW_FPS_RANGE), range); 3032 } 3033 3034 /** 3035 * Gets the supported preview fps (frame-per-second) ranges. Each range 3036 * contains a minimum fps and maximum fps. If minimum fps equals to 3037 * maximum fps, the camera outputs frames in fixed frame rate. If not, 3038 * the camera outputs frames in auto frame rate. The actual frame rate 3039 * fluctuates between the minimum and the maximum. The values are 3040 * multiplied by 1000 and represented in integers. For example, if frame 3041 * rate is 26.623 frames per second, the value is 26623. 3042 * 3043 * @return a list of supported preview fps ranges. This method returns a 3044 * list with at least one element. Every element is an int array 3045 * of two values - minimum fps and maximum fps. The list is 3046 * sorted from small to large (first by maximum fps and then 3047 * minimum fps). 3048 * @see #PREVIEW_FPS_MIN_INDEX 3049 * @see #PREVIEW_FPS_MAX_INDEX 3050 */ 3051 public List<int[]> getSupportedPreviewFpsRange() { 3052 String str = get(KEY_PREVIEW_FPS_RANGE + SUPPORTED_VALUES_SUFFIX); 3053 return splitRange(str); 3054 } 3055 3056 /** 3057 * Sets the image format for preview pictures. 3058 * <p>If this is never called, the default format will be 3059 * {@link android.graphics.ImageFormat#NV21}, which 3060 * uses the NV21 encoding format.</p> 3061 * 3062 * <p>Use {@link Parameters#getSupportedPreviewFormats} to get a list of 3063 * the available preview formats. 3064 * 3065 * <p>It is strongly recommended that either 3066 * {@link android.graphics.ImageFormat#NV21} or 3067 * {@link android.graphics.ImageFormat#YV12} is used, since 3068 * they are supported by all camera devices.</p> 3069 * 3070 * <p>For YV12, the image buffer that is received is not necessarily 3071 * tightly packed, as there may be padding at the end of each row of 3072 * pixel data, as described in 3073 * {@link android.graphics.ImageFormat#YV12}. For camera callback data, 3074 * it can be assumed that the stride of the Y and UV data is the 3075 * smallest possible that meets the alignment requirements. That is, if 3076 * the preview size is <var>width x height</var>, then the following 3077 * equations describe the buffer index for the beginning of row 3078 * <var>y</var> for the Y plane and row <var>c</var> for the U and V 3079 * planes: 3080 * 3081 * <pre>{@code 3082 * yStride = (int) ceil(width / 16.0) * 16; 3083 * uvStride = (int) ceil( (yStride / 2) / 16.0) * 16; 3084 * ySize = yStride * height; 3085 * uvSize = uvStride * height / 2; 3086 * yRowIndex = yStride * y; 3087 * uRowIndex = ySize + uvSize + uvStride * c; 3088 * vRowIndex = ySize + uvStride * c; 3089 * size = ySize + uvSize * 2; 3090 * } 3091 *</pre> 3092 * 3093 * @param pixel_format the desired preview picture format, defined by 3094 * one of the {@link android.graphics.ImageFormat} constants. (E.g., 3095 * <var>ImageFormat.NV21</var> (default), or 3096 * <var>ImageFormat.YV12</var>) 3097 * 3098 * @see android.graphics.ImageFormat 3099 * @see android.hardware.Camera.Parameters#getSupportedPreviewFormats 3100 */ 3101 public void setPreviewFormat(int pixel_format) { 3102 String s = cameraFormatForPixelFormat(pixel_format); 3103 if (s == null) { 3104 throw new IllegalArgumentException( 3105 "Invalid pixel_format=" + pixel_format); 3106 } 3107 3108 set(KEY_PREVIEW_FORMAT, s); 3109 } 3110 3111 /** 3112 * Returns the image format for preview frames got from 3113 * {@link PreviewCallback}. 3114 * 3115 * @return the preview format. 3116 * @see android.graphics.ImageFormat 3117 * @see #setPreviewFormat 3118 */ 3119 public int getPreviewFormat() { 3120 return pixelFormatForCameraFormat(get(KEY_PREVIEW_FORMAT)); 3121 } 3122 3123 /** 3124 * Gets the supported preview formats. {@link android.graphics.ImageFormat#NV21} 3125 * is always supported. {@link android.graphics.ImageFormat#YV12} 3126 * is always supported since API level 12. 3127 * 3128 * @return a list of supported preview formats. This method will always 3129 * return a list with at least one element. 3130 * @see android.graphics.ImageFormat 3131 * @see #setPreviewFormat 3132 */ 3133 public List<Integer> getSupportedPreviewFormats() { 3134 String str = get(KEY_PREVIEW_FORMAT + SUPPORTED_VALUES_SUFFIX); 3135 ArrayList<Integer> formats = new ArrayList<Integer>(); 3136 for (String s : split(str)) { 3137 int f = pixelFormatForCameraFormat(s); 3138 if (f == ImageFormat.UNKNOWN) continue; 3139 formats.add(f); 3140 } 3141 return formats; 3142 } 3143 3144 /** 3145 * <p>Sets the dimensions for pictures.</p> 3146 * 3147 * <p>Applications need to consider the display orientation. See {@link 3148 * #setPreviewSize(int,int)} for reference.</p> 3149 * 3150 * @param width the width for pictures, in pixels 3151 * @param height the height for pictures, in pixels 3152 * @see #setPreviewSize(int,int) 3153 * 3154 */ 3155 public void setPictureSize(int width, int height) { 3156 String v = Integer.toString(width) + "x" + Integer.toString(height); 3157 set(KEY_PICTURE_SIZE, v); 3158 } 3159 3160 /** 3161 * Returns the dimension setting for pictures. 3162 * 3163 * @return a Size object with the height and width setting 3164 * for pictures 3165 */ 3166 public Size getPictureSize() { 3167 String pair = get(KEY_PICTURE_SIZE); 3168 return strToSize(pair); 3169 } 3170 3171 /** 3172 * Gets the supported picture sizes. 3173 * 3174 * @return a list of supported picture sizes. This method will always 3175 * return a list with at least one element. 3176 */ 3177 public List<Size> getSupportedPictureSizes() { 3178 String str = get(KEY_PICTURE_SIZE + SUPPORTED_VALUES_SUFFIX); 3179 return splitSize(str); 3180 } 3181 3182 /** 3183 * Sets the image format for pictures. 3184 * 3185 * @param pixel_format the desired picture format 3186 * (<var>ImageFormat.NV21</var>, 3187 * <var>ImageFormat.RGB_565</var>, or 3188 * <var>ImageFormat.JPEG</var>) 3189 * @see android.graphics.ImageFormat 3190 */ 3191 public void setPictureFormat(int pixel_format) { 3192 String s = cameraFormatForPixelFormat(pixel_format); 3193 if (s == null) { 3194 throw new IllegalArgumentException( 3195 "Invalid pixel_format=" + pixel_format); 3196 } 3197 3198 set(KEY_PICTURE_FORMAT, s); 3199 } 3200 3201 /** 3202 * Returns the image format for pictures. 3203 * 3204 * @return the picture format 3205 * @see android.graphics.ImageFormat 3206 */ 3207 public int getPictureFormat() { 3208 return pixelFormatForCameraFormat(get(KEY_PICTURE_FORMAT)); 3209 } 3210 3211 /** 3212 * Gets the supported picture formats. 3213 * 3214 * @return supported picture formats. This method will always return a 3215 * list with at least one element. 3216 * @see android.graphics.ImageFormat 3217 */ 3218 public List<Integer> getSupportedPictureFormats() { 3219 String str = get(KEY_PICTURE_FORMAT + SUPPORTED_VALUES_SUFFIX); 3220 ArrayList<Integer> formats = new ArrayList<Integer>(); 3221 for (String s : split(str)) { 3222 int f = pixelFormatForCameraFormat(s); 3223 if (f == ImageFormat.UNKNOWN) continue; 3224 formats.add(f); 3225 } 3226 return formats; 3227 } 3228 3229 private String cameraFormatForPixelFormat(int pixel_format) { 3230 switch(pixel_format) { 3231 case ImageFormat.NV16: return PIXEL_FORMAT_YUV422SP; 3232 case ImageFormat.NV21: return PIXEL_FORMAT_YUV420SP; 3233 case ImageFormat.YUY2: return PIXEL_FORMAT_YUV422I; 3234 case ImageFormat.YV12: return PIXEL_FORMAT_YUV420P; 3235 case ImageFormat.RGB_565: return PIXEL_FORMAT_RGB565; 3236 case ImageFormat.JPEG: return PIXEL_FORMAT_JPEG; 3237 default: return null; 3238 } 3239 } 3240 3241 private int pixelFormatForCameraFormat(String format) { 3242 if (format == null) 3243 return ImageFormat.UNKNOWN; 3244 3245 if (format.equals(PIXEL_FORMAT_YUV422SP)) 3246 return ImageFormat.NV16; 3247 3248 if (format.equals(PIXEL_FORMAT_YUV420SP)) 3249 return ImageFormat.NV21; 3250 3251 if (format.equals(PIXEL_FORMAT_YUV422I)) 3252 return ImageFormat.YUY2; 3253 3254 if (format.equals(PIXEL_FORMAT_YUV420P)) 3255 return ImageFormat.YV12; 3256 3257 if (format.equals(PIXEL_FORMAT_RGB565)) 3258 return ImageFormat.RGB_565; 3259 3260 if (format.equals(PIXEL_FORMAT_JPEG)) 3261 return ImageFormat.JPEG; 3262 3263 return ImageFormat.UNKNOWN; 3264 } 3265 3266 /** 3267 * Sets the clockwise rotation angle in degrees relative to the 3268 * orientation of the camera. This affects the pictures returned from 3269 * JPEG {@link PictureCallback}. The camera driver may set orientation 3270 * in the EXIF header without rotating the picture. Or the driver may 3271 * rotate the picture and the EXIF thumbnail. If the Jpeg picture is 3272 * rotated, the orientation in the EXIF header will be missing or 1 (row 3273 * #0 is top and column #0 is left side). 3274 * 3275 * <p> 3276 * If applications want to rotate the picture to match the orientation 3277 * of what users see, apps should use 3278 * {@link android.view.OrientationEventListener} and 3279 * {@link android.hardware.Camera.CameraInfo}. The value from 3280 * OrientationEventListener is relative to the natural orientation of 3281 * the device. CameraInfo.orientation is the angle between camera 3282 * orientation and natural device orientation. The sum of the two is the 3283 * rotation angle for back-facing camera. The difference of the two is 3284 * the rotation angle for front-facing camera. Note that the JPEG 3285 * pictures of front-facing cameras are not mirrored as in preview 3286 * display. 3287 * 3288 * <p> 3289 * For example, suppose the natural orientation of the device is 3290 * portrait. The device is rotated 270 degrees clockwise, so the device 3291 * orientation is 270. Suppose a back-facing camera sensor is mounted in 3292 * landscape and the top side of the camera sensor is aligned with the 3293 * right edge of the display in natural orientation. So the camera 3294 * orientation is 90. The rotation should be set to 0 (270 + 90). 3295 * 3296 * <p>The reference code is as follows. 3297 * 3298 * <pre> 3299 * public void onOrientationChanged(int orientation) { 3300 * if (orientation == ORIENTATION_UNKNOWN) return; 3301 * android.hardware.Camera.CameraInfo info = 3302 * new android.hardware.Camera.CameraInfo(); 3303 * android.hardware.Camera.getCameraInfo(cameraId, info); 3304 * orientation = (orientation + 45) / 90 * 90; 3305 * int rotation = 0; 3306 * if (info.facing == CameraInfo.CAMERA_FACING_FRONT) { 3307 * rotation = (info.orientation - orientation + 360) % 360; 3308 * } else { // back-facing camera 3309 * rotation = (info.orientation + orientation) % 360; 3310 * } 3311 * mParameters.setRotation(rotation); 3312 * } 3313 * </pre> 3314 * 3315 * @param rotation The rotation angle in degrees relative to the 3316 * orientation of the camera. Rotation can only be 0, 3317 * 90, 180 or 270. 3318 * @throws IllegalArgumentException if rotation value is invalid. 3319 * @see android.view.OrientationEventListener 3320 * @see #getCameraInfo(int, CameraInfo) 3321 */ 3322 public void setRotation(int rotation) { 3323 if (rotation == 0 || rotation == 90 || rotation == 180 3324 || rotation == 270) { 3325 set(KEY_ROTATION, Integer.toString(rotation)); 3326 } else { 3327 throw new IllegalArgumentException( 3328 "Invalid rotation=" + rotation); 3329 } 3330 } 3331 3332 /** 3333 * Sets GPS latitude coordinate. This will be stored in JPEG EXIF 3334 * header. 3335 * 3336 * @param latitude GPS latitude coordinate. 3337 */ 3338 public void setGpsLatitude(double latitude) { 3339 set(KEY_GPS_LATITUDE, Double.toString(latitude)); 3340 } 3341 3342 /** 3343 * Sets GPS longitude coordinate. This will be stored in JPEG EXIF 3344 * header. 3345 * 3346 * @param longitude GPS longitude coordinate. 3347 */ 3348 public void setGpsLongitude(double longitude) { 3349 set(KEY_GPS_LONGITUDE, Double.toString(longitude)); 3350 } 3351 3352 /** 3353 * Sets GPS altitude. This will be stored in JPEG EXIF header. 3354 * 3355 * @param altitude GPS altitude in meters. 3356 */ 3357 public void setGpsAltitude(double altitude) { 3358 set(KEY_GPS_ALTITUDE, Double.toString(altitude)); 3359 } 3360 3361 /** 3362 * Sets GPS timestamp. This will be stored in JPEG EXIF header. 3363 * 3364 * @param timestamp GPS timestamp (UTC in seconds since January 1, 3365 * 1970). 3366 */ 3367 public void setGpsTimestamp(long timestamp) { 3368 set(KEY_GPS_TIMESTAMP, Long.toString(timestamp)); 3369 } 3370 3371 /** 3372 * Sets GPS processing method. The method will be stored in a UTF-8 string up to 31 bytes 3373 * long, in the JPEG EXIF header. 3374 * 3375 * @param processing_method The processing method to get this location. 3376 */ 3377 public void setGpsProcessingMethod(String processing_method) { 3378 set(KEY_GPS_PROCESSING_METHOD, processing_method); 3379 } 3380 3381 /** 3382 * Removes GPS latitude, longitude, altitude, and timestamp from the 3383 * parameters. 3384 */ 3385 public void removeGpsData() { 3386 remove(KEY_GPS_LATITUDE); 3387 remove(KEY_GPS_LONGITUDE); 3388 remove(KEY_GPS_ALTITUDE); 3389 remove(KEY_GPS_TIMESTAMP); 3390 remove(KEY_GPS_PROCESSING_METHOD); 3391 } 3392 3393 /** 3394 * Gets the current white balance setting. 3395 * 3396 * @return current white balance. null if white balance setting is not 3397 * supported. 3398 * @see #WHITE_BALANCE_AUTO 3399 * @see #WHITE_BALANCE_INCANDESCENT 3400 * @see #WHITE_BALANCE_FLUORESCENT 3401 * @see #WHITE_BALANCE_WARM_FLUORESCENT 3402 * @see #WHITE_BALANCE_DAYLIGHT 3403 * @see #WHITE_BALANCE_CLOUDY_DAYLIGHT 3404 * @see #WHITE_BALANCE_TWILIGHT 3405 * @see #WHITE_BALANCE_SHADE 3406 * 3407 */ 3408 public String getWhiteBalance() { 3409 return get(KEY_WHITE_BALANCE); 3410 } 3411 3412 /** 3413 * Sets the white balance. Changing the setting will release the 3414 * auto-white balance lock. It is recommended not to change white 3415 * balance and AWB lock at the same time. 3416 * 3417 * @param value new white balance. 3418 * @see #getWhiteBalance() 3419 * @see #setAutoWhiteBalanceLock(boolean) 3420 */ 3421 public void setWhiteBalance(String value) { 3422 String oldValue = get(KEY_WHITE_BALANCE); 3423 if (same(value, oldValue)) return; 3424 set(KEY_WHITE_BALANCE, value); 3425 set(KEY_AUTO_WHITEBALANCE_LOCK, FALSE); 3426 } 3427 3428 /** 3429 * Gets the supported white balance. 3430 * 3431 * @return a list of supported white balance. null if white balance 3432 * setting is not supported. 3433 * @see #getWhiteBalance() 3434 */ 3435 public List<String> getSupportedWhiteBalance() { 3436 String str = get(KEY_WHITE_BALANCE + SUPPORTED_VALUES_SUFFIX); 3437 return split(str); 3438 } 3439 3440 /** 3441 * Gets the current color effect setting. 3442 * 3443 * @return current color effect. null if color effect 3444 * setting is not supported. 3445 * @see #EFFECT_NONE 3446 * @see #EFFECT_MONO 3447 * @see #EFFECT_NEGATIVE 3448 * @see #EFFECT_SOLARIZE 3449 * @see #EFFECT_SEPIA 3450 * @see #EFFECT_POSTERIZE 3451 * @see #EFFECT_WHITEBOARD 3452 * @see #EFFECT_BLACKBOARD 3453 * @see #EFFECT_AQUA 3454 */ 3455 public String getColorEffect() { 3456 return get(KEY_EFFECT); 3457 } 3458 3459 /** 3460 * Sets the current color effect setting. 3461 * 3462 * @param value new color effect. 3463 * @see #getColorEffect() 3464 */ 3465 public void setColorEffect(String value) { 3466 set(KEY_EFFECT, value); 3467 } 3468 3469 /** 3470 * Gets the supported color effects. 3471 * 3472 * @return a list of supported color effects. null if color effect 3473 * setting is not supported. 3474 * @see #getColorEffect() 3475 */ 3476 public List<String> getSupportedColorEffects() { 3477 String str = get(KEY_EFFECT + SUPPORTED_VALUES_SUFFIX); 3478 return split(str); 3479 } 3480 3481 3482 /** 3483 * Gets the current antibanding setting. 3484 * 3485 * @return current antibanding. null if antibanding setting is not 3486 * supported. 3487 * @see #ANTIBANDING_AUTO 3488 * @see #ANTIBANDING_50HZ 3489 * @see #ANTIBANDING_60HZ 3490 * @see #ANTIBANDING_OFF 3491 */ 3492 public String getAntibanding() { 3493 return get(KEY_ANTIBANDING); 3494 } 3495 3496 /** 3497 * Sets the antibanding. 3498 * 3499 * @param antibanding new antibanding value. 3500 * @see #getAntibanding() 3501 */ 3502 public void setAntibanding(String antibanding) { 3503 set(KEY_ANTIBANDING, antibanding); 3504 } 3505 3506 /** 3507 * Gets the supported antibanding values. 3508 * 3509 * @return a list of supported antibanding values. null if antibanding 3510 * setting is not supported. 3511 * @see #getAntibanding() 3512 */ 3513 public List<String> getSupportedAntibanding() { 3514 String str = get(KEY_ANTIBANDING + SUPPORTED_VALUES_SUFFIX); 3515 return split(str); 3516 } 3517 3518 /** 3519 * Gets the current scene mode setting. 3520 * 3521 * @return one of SCENE_MODE_XXX string constant. null if scene mode 3522 * setting is not supported. 3523 * @see #SCENE_MODE_AUTO 3524 * @see #SCENE_MODE_ACTION 3525 * @see #SCENE_MODE_PORTRAIT 3526 * @see #SCENE_MODE_LANDSCAPE 3527 * @see #SCENE_MODE_NIGHT 3528 * @see #SCENE_MODE_NIGHT_PORTRAIT 3529 * @see #SCENE_MODE_THEATRE 3530 * @see #SCENE_MODE_BEACH 3531 * @see #SCENE_MODE_SNOW 3532 * @see #SCENE_MODE_SUNSET 3533 * @see #SCENE_MODE_STEADYPHOTO 3534 * @see #SCENE_MODE_FIREWORKS 3535 * @see #SCENE_MODE_SPORTS 3536 * @see #SCENE_MODE_PARTY 3537 * @see #SCENE_MODE_CANDLELIGHT 3538 * @see #SCENE_MODE_BARCODE 3539 */ 3540 public String getSceneMode() { 3541 return get(KEY_SCENE_MODE); 3542 } 3543 3544 /** 3545 * Sets the scene mode. Changing scene mode may override other 3546 * parameters (such as flash mode, focus mode, white balance). For 3547 * example, suppose originally flash mode is on and supported flash 3548 * modes are on/off. In night scene mode, both flash mode and supported 3549 * flash mode may be changed to off. After setting scene mode, 3550 * applications should call getParameters to know if some parameters are 3551 * changed. 3552 * 3553 * @param value scene mode. 3554 * @see #getSceneMode() 3555 */ 3556 public void setSceneMode(String value) { 3557 set(KEY_SCENE_MODE, value); 3558 } 3559 3560 /** 3561 * Gets the supported scene modes. 3562 * 3563 * @return a list of supported scene modes. null if scene mode setting 3564 * is not supported. 3565 * @see #getSceneMode() 3566 */ 3567 public List<String> getSupportedSceneModes() { 3568 String str = get(KEY_SCENE_MODE + SUPPORTED_VALUES_SUFFIX); 3569 return split(str); 3570 } 3571 3572 /** 3573 * Gets the current flash mode setting. 3574 * 3575 * @return current flash mode. null if flash mode setting is not 3576 * supported. 3577 * @see #FLASH_MODE_OFF 3578 * @see #FLASH_MODE_AUTO 3579 * @see #FLASH_MODE_ON 3580 * @see #FLASH_MODE_RED_EYE 3581 * @see #FLASH_MODE_TORCH 3582 */ 3583 public String getFlashMode() { 3584 return get(KEY_FLASH_MODE); 3585 } 3586 3587 /** 3588 * Sets the flash mode. 3589 * 3590 * @param value flash mode. 3591 * @see #getFlashMode() 3592 */ 3593 public void setFlashMode(String value) { 3594 set(KEY_FLASH_MODE, value); 3595 } 3596 3597 /** 3598 * Gets the supported flash modes. 3599 * 3600 * @return a list of supported flash modes. null if flash mode setting 3601 * is not supported. 3602 * @see #getFlashMode() 3603 */ 3604 public List<String> getSupportedFlashModes() { 3605 String str = get(KEY_FLASH_MODE + SUPPORTED_VALUES_SUFFIX); 3606 return split(str); 3607 } 3608 3609 /** 3610 * Gets the current focus mode setting. 3611 * 3612 * @return current focus mode. This method will always return a non-null 3613 * value. Applications should call {@link 3614 * #autoFocus(AutoFocusCallback)} to start the focus if focus 3615 * mode is FOCUS_MODE_AUTO or FOCUS_MODE_MACRO. 3616 * @see #FOCUS_MODE_AUTO 3617 * @see #FOCUS_MODE_INFINITY 3618 * @see #FOCUS_MODE_MACRO 3619 * @see #FOCUS_MODE_FIXED 3620 * @see #FOCUS_MODE_EDOF 3621 * @see #FOCUS_MODE_CONTINUOUS_VIDEO 3622 */ 3623 public String getFocusMode() { 3624 return get(KEY_FOCUS_MODE); 3625 } 3626 3627 /** 3628 * Sets the focus mode. 3629 * 3630 * @param value focus mode. 3631 * @see #getFocusMode() 3632 */ 3633 public void setFocusMode(String value) { 3634 set(KEY_FOCUS_MODE, value); 3635 } 3636 3637 /** 3638 * Gets the supported focus modes. 3639 * 3640 * @return a list of supported focus modes. This method will always 3641 * return a list with at least one element. 3642 * @see #getFocusMode() 3643 */ 3644 public List<String> getSupportedFocusModes() { 3645 String str = get(KEY_FOCUS_MODE + SUPPORTED_VALUES_SUFFIX); 3646 return split(str); 3647 } 3648 3649 /** 3650 * Gets the focal length (in millimeter) of the camera. 3651 * 3652 * @return the focal length. Returns -1.0 when the device 3653 * doesn't report focal length information. 3654 */ 3655 public float getFocalLength() { 3656 return Float.parseFloat(get(KEY_FOCAL_LENGTH)); 3657 } 3658 3659 /** 3660 * Gets the horizontal angle of view in degrees. 3661 * 3662 * @return horizontal angle of view. Returns -1.0 when the device 3663 * doesn't report view angle information. 3664 */ 3665 public float getHorizontalViewAngle() { 3666 return Float.parseFloat(get(KEY_HORIZONTAL_VIEW_ANGLE)); 3667 } 3668 3669 /** 3670 * Gets the vertical angle of view in degrees. 3671 * 3672 * @return vertical angle of view. Returns -1.0 when the device 3673 * doesn't report view angle information. 3674 */ 3675 public float getVerticalViewAngle() { 3676 return Float.parseFloat(get(KEY_VERTICAL_VIEW_ANGLE)); 3677 } 3678 3679 /** 3680 * Gets the current exposure compensation index. 3681 * 3682 * @return current exposure compensation index. The range is {@link 3683 * #getMinExposureCompensation} to {@link 3684 * #getMaxExposureCompensation}. 0 means exposure is not 3685 * adjusted. 3686 */ 3687 public int getExposureCompensation() { 3688 return getInt(KEY_EXPOSURE_COMPENSATION, 0); 3689 } 3690 3691 /** 3692 * Sets the exposure compensation index. 3693 * 3694 * @param value exposure compensation index. The valid value range is 3695 * from {@link #getMinExposureCompensation} (inclusive) to {@link 3696 * #getMaxExposureCompensation} (inclusive). 0 means exposure is 3697 * not adjusted. Application should call 3698 * getMinExposureCompensation and getMaxExposureCompensation to 3699 * know if exposure compensation is supported. 3700 */ 3701 public void setExposureCompensation(int value) { 3702 set(KEY_EXPOSURE_COMPENSATION, value); 3703 } 3704 3705 /** 3706 * Gets the maximum exposure compensation index. 3707 * 3708 * @return maximum exposure compensation index (>=0). If both this 3709 * method and {@link #getMinExposureCompensation} return 0, 3710 * exposure compensation is not supported. 3711 */ 3712 public int getMaxExposureCompensation() { 3713 return getInt(KEY_MAX_EXPOSURE_COMPENSATION, 0); 3714 } 3715 3716 /** 3717 * Gets the minimum exposure compensation index. 3718 * 3719 * @return minimum exposure compensation index (<=0). If both this 3720 * method and {@link #getMaxExposureCompensation} return 0, 3721 * exposure compensation is not supported. 3722 */ 3723 public int getMinExposureCompensation() { 3724 return getInt(KEY_MIN_EXPOSURE_COMPENSATION, 0); 3725 } 3726 3727 /** 3728 * Gets the exposure compensation step. 3729 * 3730 * @return exposure compensation step. Applications can get EV by 3731 * multiplying the exposure compensation index and step. Ex: if 3732 * exposure compensation index is -6 and step is 0.333333333, EV 3733 * is -2. 3734 */ 3735 public float getExposureCompensationStep() { 3736 return getFloat(KEY_EXPOSURE_COMPENSATION_STEP, 0); 3737 } 3738 3739 /** 3740 * <p>Sets the auto-exposure lock state. Applications should check 3741 * {@link #isAutoExposureLockSupported} before using this method.</p> 3742 * 3743 * <p>If set to true, the camera auto-exposure routine will immediately 3744 * pause until the lock is set to false. Exposure compensation settings 3745 * changes will still take effect while auto-exposure is locked.</p> 3746 * 3747 * <p>If auto-exposure is already locked, setting this to true again has 3748 * no effect (the driver will not recalculate exposure values).</p> 3749 * 3750 * <p>Stopping preview with {@link #stopPreview()}, or triggering still 3751 * image capture with {@link #takePicture(Camera.ShutterCallback, 3752 * Camera.PictureCallback, Camera.PictureCallback)}, will not change the 3753 * lock.</p> 3754 * 3755 * <p>Exposure compensation, auto-exposure lock, and auto-white balance 3756 * lock can be used to capture an exposure-bracketed burst of images, 3757 * for example.</p> 3758 * 3759 * <p>Auto-exposure state, including the lock state, will not be 3760 * maintained after camera {@link #release()} is called. Locking 3761 * auto-exposure after {@link #open()} but before the first call to 3762 * {@link #startPreview()} will not allow the auto-exposure routine to 3763 * run at all, and may result in severely over- or under-exposed 3764 * images.</p> 3765 * 3766 * @param toggle new state of the auto-exposure lock. True means that 3767 * auto-exposure is locked, false means that the auto-exposure 3768 * routine is free to run normally. 3769 * 3770 * @see #getAutoExposureLock() 3771 */ 3772 public void setAutoExposureLock(boolean toggle) { 3773 set(KEY_AUTO_EXPOSURE_LOCK, toggle ? TRUE : FALSE); 3774 } 3775 3776 /** 3777 * Gets the state of the auto-exposure lock. Applications should check 3778 * {@link #isAutoExposureLockSupported} before using this method. See 3779 * {@link #setAutoExposureLock} for details about the lock. 3780 * 3781 * @return State of the auto-exposure lock. Returns true if 3782 * auto-exposure is currently locked, and false otherwise. 3783 * 3784 * @see #setAutoExposureLock(boolean) 3785 * 3786 */ 3787 public boolean getAutoExposureLock() { 3788 String str = get(KEY_AUTO_EXPOSURE_LOCK); 3789 return TRUE.equals(str); 3790 } 3791 3792 /** 3793 * Returns true if auto-exposure locking is supported. Applications 3794 * should call this before trying to lock auto-exposure. See 3795 * {@link #setAutoExposureLock} for details about the lock. 3796 * 3797 * @return true if auto-exposure lock is supported. 3798 * @see #setAutoExposureLock(boolean) 3799 * 3800 */ 3801 public boolean isAutoExposureLockSupported() { 3802 String str = get(KEY_AUTO_EXPOSURE_LOCK_SUPPORTED); 3803 return TRUE.equals(str); 3804 } 3805 3806 /** 3807 * <p>Sets the auto-white balance lock state. Applications should check 3808 * {@link #isAutoWhiteBalanceLockSupported} before using this 3809 * method.</p> 3810 * 3811 * <p>If set to true, the camera auto-white balance routine will 3812 * immediately pause until the lock is set to false.</p> 3813 * 3814 * <p>If auto-white balance is already locked, setting this to true 3815 * again has no effect (the driver will not recalculate white balance 3816 * values).</p> 3817 * 3818 * <p>Stopping preview with {@link #stopPreview()}, or triggering still 3819 * image capture with {@link #takePicture(Camera.ShutterCallback, 3820 * Camera.PictureCallback, Camera.PictureCallback)}, will not change the 3821 * the lock.</p> 3822 * 3823 * <p> Changing the white balance mode with {@link #setWhiteBalance} 3824 * will release the auto-white balance lock if it is set.</p> 3825 * 3826 * <p>Exposure compensation, AE lock, and AWB lock can be used to 3827 * capture an exposure-bracketed burst of images, for example. 3828 * Auto-white balance state, including the lock state, will not be 3829 * maintained after camera {@link #release()} is called. Locking 3830 * auto-white balance after {@link #open()} but before the first call to 3831 * {@link #startPreview()} will not allow the auto-white balance routine 3832 * to run at all, and may result in severely incorrect color in captured 3833 * images.</p> 3834 * 3835 * @param toggle new state of the auto-white balance lock. True means 3836 * that auto-white balance is locked, false means that the 3837 * auto-white balance routine is free to run normally. 3838 * 3839 * @see #getAutoWhiteBalanceLock() 3840 * @see #setWhiteBalance(String) 3841 */ 3842 public void setAutoWhiteBalanceLock(boolean toggle) { 3843 set(KEY_AUTO_WHITEBALANCE_LOCK, toggle ? TRUE : FALSE); 3844 } 3845 3846 /** 3847 * Gets the state of the auto-white balance lock. Applications should 3848 * check {@link #isAutoWhiteBalanceLockSupported} before using this 3849 * method. See {@link #setAutoWhiteBalanceLock} for details about the 3850 * lock. 3851 * 3852 * @return State of the auto-white balance lock. Returns true if 3853 * auto-white balance is currently locked, and false 3854 * otherwise. 3855 * 3856 * @see #setAutoWhiteBalanceLock(boolean) 3857 * 3858 */ 3859 public boolean getAutoWhiteBalanceLock() { 3860 String str = get(KEY_AUTO_WHITEBALANCE_LOCK); 3861 return TRUE.equals(str); 3862 } 3863 3864 /** 3865 * Returns true if auto-white balance locking is supported. Applications 3866 * should call this before trying to lock auto-white balance. See 3867 * {@link #setAutoWhiteBalanceLock} for details about the lock. 3868 * 3869 * @return true if auto-white balance lock is supported. 3870 * @see #setAutoWhiteBalanceLock(boolean) 3871 * 3872 */ 3873 public boolean isAutoWhiteBalanceLockSupported() { 3874 String str = get(KEY_AUTO_WHITEBALANCE_LOCK_SUPPORTED); 3875 return TRUE.equals(str); 3876 } 3877 3878 /** 3879 * Gets current zoom value. This also works when smooth zoom is in 3880 * progress. Applications should check {@link #isZoomSupported} before 3881 * using this method. 3882 * 3883 * @return the current zoom value. The range is 0 to {@link 3884 * #getMaxZoom}. 0 means the camera is not zoomed. 3885 */ 3886 public int getZoom() { 3887 return getInt(KEY_ZOOM, 0); 3888 } 3889 3890 /** 3891 * Sets current zoom value. If the camera is zoomed (value > 0), the 3892 * actual picture size may be smaller than picture size setting. 3893 * Applications can check the actual picture size after picture is 3894 * returned from {@link PictureCallback}. The preview size remains the 3895 * same in zoom. Applications should check {@link #isZoomSupported} 3896 * before using this method. 3897 * 3898 * @param value zoom value. The valid range is 0 to {@link #getMaxZoom}. 3899 */ 3900 public void setZoom(int value) { 3901 set(KEY_ZOOM, value); 3902 } 3903 3904 /** 3905 * Returns true if zoom is supported. Applications should call this 3906 * before using other zoom methods. 3907 * 3908 * @return true if zoom is supported. 3909 */ 3910 public boolean isZoomSupported() { 3911 String str = get(KEY_ZOOM_SUPPORTED); 3912 return TRUE.equals(str); 3913 } 3914 3915 /** 3916 * Gets the maximum zoom value allowed for snapshot. This is the maximum 3917 * value that applications can set to {@link #setZoom(int)}. 3918 * Applications should call {@link #isZoomSupported} before using this 3919 * method. This value may change in different preview size. Applications 3920 * should call this again after setting preview size. 3921 * 3922 * @return the maximum zoom value supported by the camera. 3923 */ 3924 public int getMaxZoom() { 3925 return getInt(KEY_MAX_ZOOM, 0); 3926 } 3927 3928 /** 3929 * Gets the zoom ratios of all zoom values. Applications should check 3930 * {@link #isZoomSupported} before using this method. 3931 * 3932 * @return the zoom ratios in 1/100 increments. Ex: a zoom of 3.2x is 3933 * returned as 320. The number of elements is {@link 3934 * #getMaxZoom} + 1. The list is sorted from small to large. The 3935 * first element is always 100. The last element is the zoom 3936 * ratio of the maximum zoom value. 3937 */ 3938 public List<Integer> getZoomRatios() { 3939 return splitInt(get(KEY_ZOOM_RATIOS)); 3940 } 3941 3942 /** 3943 * Returns true if smooth zoom is supported. Applications should call 3944 * this before using other smooth zoom methods. 3945 * 3946 * @return true if smooth zoom is supported. 3947 */ 3948 public boolean isSmoothZoomSupported() { 3949 String str = get(KEY_SMOOTH_ZOOM_SUPPORTED); 3950 return TRUE.equals(str); 3951 } 3952 3953 /** 3954 * <p>Gets the distances from the camera to where an object appears to be 3955 * in focus. The object is sharpest at the optimal focus distance. The 3956 * depth of field is the far focus distance minus near focus distance.</p> 3957 * 3958 * <p>Focus distances may change after calling {@link 3959 * #autoFocus(AutoFocusCallback)}, {@link #cancelAutoFocus}, or {@link 3960 * #startPreview()}. Applications can call {@link #getParameters()} 3961 * and this method anytime to get the latest focus distances. If the 3962 * focus mode is FOCUS_MODE_CONTINUOUS_VIDEO, focus distances may change 3963 * from time to time.</p> 3964 * 3965 * <p>This method is intended to estimate the distance between the camera 3966 * and the subject. After autofocus, the subject distance may be within 3967 * near and far focus distance. However, the precision depends on the 3968 * camera hardware, autofocus algorithm, the focus area, and the scene. 3969 * The error can be large and it should be only used as a reference.</p> 3970 * 3971 * <p>Far focus distance >= optimal focus distance >= near focus distance. 3972 * If the focus distance is infinity, the value will be 3973 * {@code Float.POSITIVE_INFINITY}.</p> 3974 * 3975 * @param output focus distances in meters. output must be a float 3976 * array with three elements. Near focus distance, optimal focus 3977 * distance, and far focus distance will be filled in the array. 3978 * @see #FOCUS_DISTANCE_NEAR_INDEX 3979 * @see #FOCUS_DISTANCE_OPTIMAL_INDEX 3980 * @see #FOCUS_DISTANCE_FAR_INDEX 3981 */ 3982 public void getFocusDistances(float[] output) { 3983 if (output == null || output.length != 3) { 3984 throw new IllegalArgumentException( 3985 "output must be a float array with three elements."); 3986 } 3987 splitFloat(get(KEY_FOCUS_DISTANCES), output); 3988 } 3989 3990 /** 3991 * Gets the maximum number of focus areas supported. This is the maximum 3992 * length of the list in {@link #setFocusAreas(List)} and 3993 * {@link #getFocusAreas()}. 3994 * 3995 * @return the maximum number of focus areas supported by the camera. 3996 * @see #getFocusAreas() 3997 */ 3998 public int getMaxNumFocusAreas() { 3999 return getInt(KEY_MAX_NUM_FOCUS_AREAS, 0); 4000 } 4001 4002 /** 4003 * <p>Gets the current focus areas. Camera driver uses the areas to decide 4004 * focus.</p> 4005 * 4006 * <p>Before using this API or {@link #setFocusAreas(List)}, apps should 4007 * call {@link #getMaxNumFocusAreas()} to know the maximum number of 4008 * focus areas first. If the value is 0, focus area is not supported.</p> 4009 * 4010 * <p>Each focus area is a rectangle with specified weight. The direction 4011 * is relative to the sensor orientation, that is, what the sensor sees. 4012 * The direction is not affected by the rotation or mirroring of 4013 * {@link #setDisplayOrientation(int)}. Coordinates of the rectangle 4014 * range from -1000 to 1000. (-1000, -1000) is the upper left point. 4015 * (1000, 1000) is the lower right point. The width and height of focus 4016 * areas cannot be 0 or negative.</p> 4017 * 4018 * <p>The weight must range from 1 to 1000. The weight should be 4019 * interpreted as a per-pixel weight - all pixels in the area have the 4020 * specified weight. This means a small area with the same weight as a 4021 * larger area will have less influence on the focusing than the larger 4022 * area. Focus areas can partially overlap and the driver will add the 4023 * weights in the overlap region.</p> 4024 * 4025 * <p>A special case of a {@code null} focus area list means the driver is 4026 * free to select focus targets as it wants. For example, the driver may 4027 * use more signals to select focus areas and change them 4028 * dynamically. Apps can set the focus area list to {@code null} if they 4029 * want the driver to completely control focusing.</p> 4030 * 4031 * <p>Focus areas are relative to the current field of view 4032 * ({@link #getZoom()}). No matter what the zoom level is, (-1000,-1000) 4033 * represents the top of the currently visible camera frame. The focus 4034 * area cannot be set to be outside the current field of view, even 4035 * when using zoom.</p> 4036 * 4037 * <p>Focus area only has effect if the current focus mode is 4038 * {@link #FOCUS_MODE_AUTO}, {@link #FOCUS_MODE_MACRO}, 4039 * {@link #FOCUS_MODE_CONTINUOUS_VIDEO}, or 4040 * {@link #FOCUS_MODE_CONTINUOUS_PICTURE}.</p> 4041 * 4042 * @return a list of current focus areas 4043 */ 4044 public List<Area> getFocusAreas() { 4045 return splitArea(get(KEY_FOCUS_AREAS)); 4046 } 4047 4048 /** 4049 * Sets focus areas. See {@link #getFocusAreas()} for documentation. 4050 * 4051 * @param focusAreas the focus areas 4052 * @see #getFocusAreas() 4053 */ 4054 public void setFocusAreas(List<Area> focusAreas) { 4055 set(KEY_FOCUS_AREAS, focusAreas); 4056 } 4057 4058 /** 4059 * Gets the maximum number of metering areas supported. This is the 4060 * maximum length of the list in {@link #setMeteringAreas(List)} and 4061 * {@link #getMeteringAreas()}. 4062 * 4063 * @return the maximum number of metering areas supported by the camera. 4064 * @see #getMeteringAreas() 4065 */ 4066 public int getMaxNumMeteringAreas() { 4067 return getInt(KEY_MAX_NUM_METERING_AREAS, 0); 4068 } 4069 4070 /** 4071 * <p>Gets the current metering areas. Camera driver uses these areas to 4072 * decide exposure.</p> 4073 * 4074 * <p>Before using this API or {@link #setMeteringAreas(List)}, apps should 4075 * call {@link #getMaxNumMeteringAreas()} to know the maximum number of 4076 * metering areas first. If the value is 0, metering area is not 4077 * supported.</p> 4078 * 4079 * <p>Each metering area is a rectangle with specified weight. The 4080 * direction is relative to the sensor orientation, that is, what the 4081 * sensor sees. The direction is not affected by the rotation or 4082 * mirroring of {@link #setDisplayOrientation(int)}. Coordinates of the 4083 * rectangle range from -1000 to 1000. (-1000, -1000) is the upper left 4084 * point. (1000, 1000) is the lower right point. The width and height of 4085 * metering areas cannot be 0 or negative.</p> 4086 * 4087 * <p>The weight must range from 1 to 1000, and represents a weight for 4088 * every pixel in the area. This means that a large metering area with 4089 * the same weight as a smaller area will have more effect in the 4090 * metering result. Metering areas can partially overlap and the driver 4091 * will add the weights in the overlap region.</p> 4092 * 4093 * <p>A special case of a {@code null} metering area list means the driver 4094 * is free to meter as it chooses. For example, the driver may use more 4095 * signals to select metering areas and change them dynamically. Apps 4096 * can set the metering area list to {@code null} if they want the 4097 * driver to completely control metering.</p> 4098 * 4099 * <p>Metering areas are relative to the current field of view 4100 * ({@link #getZoom()}). No matter what the zoom level is, (-1000,-1000) 4101 * represents the top of the currently visible camera frame. The 4102 * metering area cannot be set to be outside the current field of view, 4103 * even when using zoom.</p> 4104 * 4105 * <p>No matter what metering areas are, the final exposure are compensated 4106 * by {@link #setExposureCompensation(int)}.</p> 4107 * 4108 * @return a list of current metering areas 4109 */ 4110 public List<Area> getMeteringAreas() { 4111 return splitArea(get(KEY_METERING_AREAS)); 4112 } 4113 4114 /** 4115 * Sets metering areas. See {@link #getMeteringAreas()} for 4116 * documentation. 4117 * 4118 * @param meteringAreas the metering areas 4119 * @see #getMeteringAreas() 4120 */ 4121 public void setMeteringAreas(List<Area> meteringAreas) { 4122 set(KEY_METERING_AREAS, meteringAreas); 4123 } 4124 4125 /** 4126 * Gets the maximum number of detected faces supported. This is the 4127 * maximum length of the list returned from {@link FaceDetectionListener}. 4128 * If the return value is 0, face detection of the specified type is not 4129 * supported. 4130 * 4131 * @return the maximum number of detected face supported by the camera. 4132 * @see #startFaceDetection() 4133 */ 4134 public int getMaxNumDetectedFaces() { 4135 return getInt(KEY_MAX_NUM_DETECTED_FACES_HW, 0); 4136 } 4137 4138 /** 4139 * Sets recording mode hint. This tells the camera that the intent of 4140 * the application is to record videos {@link 4141 * android.media.MediaRecorder#start()}, not to take still pictures 4142 * {@link #takePicture(Camera.ShutterCallback, Camera.PictureCallback, 4143 * Camera.PictureCallback, Camera.PictureCallback)}. Using this hint can 4144 * allow MediaRecorder.start() to start faster or with fewer glitches on 4145 * output. This should be called before starting preview for the best 4146 * result, but can be changed while the preview is active. The default 4147 * value is false. 4148 * 4149 * The app can still call takePicture() when the hint is true or call 4150 * MediaRecorder.start() when the hint is false. But the performance may 4151 * be worse. 4152 * 4153 * @param hint true if the apps intend to record videos using 4154 * {@link android.media.MediaRecorder}. 4155 */ 4156 public void setRecordingHint(boolean hint) { 4157 set(KEY_RECORDING_HINT, hint ? TRUE : FALSE); 4158 } 4159 4160 /** 4161 * <p>Returns true if video snapshot is supported. That is, applications 4162 * can call {@link #takePicture(Camera.ShutterCallback, 4163 * Camera.PictureCallback, Camera.PictureCallback, 4164 * Camera.PictureCallback)} during recording. Applications do not need 4165 * to call {@link #startPreview()} after taking a picture. The preview 4166 * will be still active. Other than that, taking a picture during 4167 * recording is identical to taking a picture normally. All settings and 4168 * methods related to takePicture work identically. Ex: 4169 * {@link #getPictureSize()}, {@link #getSupportedPictureSizes()}, 4170 * {@link #setJpegQuality(int)}, {@link #setRotation(int)}, and etc. The 4171 * picture will have an EXIF header. {@link #FLASH_MODE_AUTO} and 4172 * {@link #FLASH_MODE_ON} also still work, but the video will record the 4173 * flash.</p> 4174 * 4175 * <p>Applications can set shutter callback as null to avoid the shutter 4176 * sound. It is also recommended to set raw picture and post view 4177 * callbacks to null to avoid the interrupt of preview display.</p> 4178 * 4179 * <p>Field-of-view of the recorded video may be different from that of the 4180 * captured pictures. The maximum size of a video snapshot may be 4181 * smaller than that for regular still captures. If the current picture 4182 * size is set higher than can be supported by video snapshot, the 4183 * picture will be captured at the maximum supported size instead.</p> 4184 * 4185 * @return true if video snapshot is supported. 4186 */ 4187 public boolean isVideoSnapshotSupported() { 4188 String str = get(KEY_VIDEO_SNAPSHOT_SUPPORTED); 4189 return TRUE.equals(str); 4190 } 4191 4192 /** 4193 * <p>Enables and disables video stabilization. Use 4194 * {@link #isVideoStabilizationSupported} to determine if calling this 4195 * method is valid.</p> 4196 * 4197 * <p>Video stabilization reduces the shaking due to the motion of the 4198 * camera in both the preview stream and in recorded videos, including 4199 * data received from the preview callback. It does not reduce motion 4200 * blur in images captured with 4201 * {@link Camera#takePicture takePicture}.</p> 4202 * 4203 * <p>Video stabilization can be enabled and disabled while preview or 4204 * recording is active, but toggling it may cause a jump in the video 4205 * stream that may be undesirable in a recorded video.</p> 4206 * 4207 * @param toggle Set to true to enable video stabilization, and false to 4208 * disable video stabilization. 4209 * @see #isVideoStabilizationSupported() 4210 * @see #getVideoStabilization() 4211 */ 4212 public void setVideoStabilization(boolean toggle) { 4213 set(KEY_VIDEO_STABILIZATION, toggle ? TRUE : FALSE); 4214 } 4215 4216 /** 4217 * Get the current state of video stabilization. See 4218 * {@link #setVideoStabilization} for details of video stabilization. 4219 * 4220 * @return true if video stabilization is enabled 4221 * @see #isVideoStabilizationSupported() 4222 * @see #setVideoStabilization(boolean) 4223 */ 4224 public boolean getVideoStabilization() { 4225 String str = get(KEY_VIDEO_STABILIZATION); 4226 return TRUE.equals(str); 4227 } 4228 4229 /** 4230 * Returns true if video stabilization is supported. See 4231 * {@link #setVideoStabilization} for details of video stabilization. 4232 * 4233 * @return true if video stabilization is supported 4234 * @see #setVideoStabilization(boolean) 4235 * @see #getVideoStabilization() 4236 */ 4237 public boolean isVideoStabilizationSupported() { 4238 String str = get(KEY_VIDEO_STABILIZATION_SUPPORTED); 4239 return TRUE.equals(str); 4240 } 4241 4242 // Splits a comma delimited string to an ArrayList of String. 4243 // Return null if the passing string is null or the size is 0. 4244 private ArrayList<String> split(String str) { 4245 if (str == null) return null; 4246 4247 TextUtils.StringSplitter splitter = new TextUtils.SimpleStringSplitter(','); 4248 splitter.setString(str); 4249 ArrayList<String> substrings = new ArrayList<String>(); 4250 for (String s : splitter) { 4251 substrings.add(s); 4252 } 4253 return substrings; 4254 } 4255 4256 // Splits a comma delimited string to an ArrayList of Integer. 4257 // Return null if the passing string is null or the size is 0. 4258 private ArrayList<Integer> splitInt(String str) { 4259 if (str == null) return null; 4260 4261 TextUtils.StringSplitter splitter = new TextUtils.SimpleStringSplitter(','); 4262 splitter.setString(str); 4263 ArrayList<Integer> substrings = new ArrayList<Integer>(); 4264 for (String s : splitter) { 4265 substrings.add(Integer.parseInt(s)); 4266 } 4267 if (substrings.size() == 0) return null; 4268 return substrings; 4269 } 4270 4271 private void splitInt(String str, int[] output) { 4272 if (str == null) return; 4273 4274 TextUtils.StringSplitter splitter = new TextUtils.SimpleStringSplitter(','); 4275 splitter.setString(str); 4276 int index = 0; 4277 for (String s : splitter) { 4278 output[index++] = Integer.parseInt(s); 4279 } 4280 } 4281 4282 // Splits a comma delimited string to an ArrayList of Float. 4283 private void splitFloat(String str, float[] output) { 4284 if (str == null) return; 4285 4286 TextUtils.StringSplitter splitter = new TextUtils.SimpleStringSplitter(','); 4287 splitter.setString(str); 4288 int index = 0; 4289 for (String s : splitter) { 4290 output[index++] = Float.parseFloat(s); 4291 } 4292 } 4293 4294 // Returns the value of a float parameter. 4295 private float getFloat(String key, float defaultValue) { 4296 try { 4297 return Float.parseFloat(mMap.get(key)); 4298 } catch (NumberFormatException ex) { 4299 return defaultValue; 4300 } 4301 } 4302 4303 // Returns the value of a integer parameter. 4304 private int getInt(String key, int defaultValue) { 4305 try { 4306 return Integer.parseInt(mMap.get(key)); 4307 } catch (NumberFormatException ex) { 4308 return defaultValue; 4309 } 4310 } 4311 4312 // Splits a comma delimited string to an ArrayList of Size. 4313 // Return null if the passing string is null or the size is 0. 4314 private ArrayList<Size> splitSize(String str) { 4315 if (str == null) return null; 4316 4317 TextUtils.StringSplitter splitter = new TextUtils.SimpleStringSplitter(','); 4318 splitter.setString(str); 4319 ArrayList<Size> sizeList = new ArrayList<Size>(); 4320 for (String s : splitter) { 4321 Size size = strToSize(s); 4322 if (size != null) sizeList.add(size); 4323 } 4324 if (sizeList.size() == 0) return null; 4325 return sizeList; 4326 } 4327 4328 // Parses a string (ex: "480x320") to Size object. 4329 // Return null if the passing string is null. 4330 private Size strToSize(String str) { 4331 if (str == null) return null; 4332 4333 int pos = str.indexOf('x'); 4334 if (pos != -1) { 4335 String width = str.substring(0, pos); 4336 String height = str.substring(pos + 1); 4337 return new Size(Integer.parseInt(width), 4338 Integer.parseInt(height)); 4339 } 4340 Log.e(TAG, "Invalid size parameter string=" + str); 4341 return null; 4342 } 4343 4344 // Splits a comma delimited string to an ArrayList of int array. 4345 // Example string: "(10000,26623),(10000,30000)". Return null if the 4346 // passing string is null or the size is 0. 4347 private ArrayList<int[]> splitRange(String str) { 4348 if (str == null || str.charAt(0) != '(' 4349 || str.charAt(str.length() - 1) != ')') { 4350 Log.e(TAG, "Invalid range list string=" + str); 4351 return null; 4352 } 4353 4354 ArrayList<int[]> rangeList = new ArrayList<int[]>(); 4355 int endIndex, fromIndex = 1; 4356 do { 4357 int[] range = new int[2]; 4358 endIndex = str.indexOf("),(", fromIndex); 4359 if (endIndex == -1) endIndex = str.length() - 1; 4360 splitInt(str.substring(fromIndex, endIndex), range); 4361 rangeList.add(range); 4362 fromIndex = endIndex + 3; 4363 } while (endIndex != str.length() - 1); 4364 4365 if (rangeList.size() == 0) return null; 4366 return rangeList; 4367 } 4368 4369 // Splits a comma delimited string to an ArrayList of Area objects. 4370 // Example string: "(-10,-10,0,0,300),(0,0,10,10,700)". Return null if 4371 // the passing string is null or the size is 0 or (0,0,0,0,0). 4372 private ArrayList<Area> splitArea(String str) { 4373 if (str == null || str.charAt(0) != '(' 4374 || str.charAt(str.length() - 1) != ')') { 4375 Log.e(TAG, "Invalid area string=" + str); 4376 return null; 4377 } 4378 4379 ArrayList<Area> result = new ArrayList<Area>(); 4380 int endIndex, fromIndex = 1; 4381 int[] array = new int[5]; 4382 do { 4383 endIndex = str.indexOf("),(", fromIndex); 4384 if (endIndex == -1) endIndex = str.length() - 1; 4385 splitInt(str.substring(fromIndex, endIndex), array); 4386 Rect rect = new Rect(array[0], array[1], array[2], array[3]); 4387 result.add(new Area(rect, array[4])); 4388 fromIndex = endIndex + 3; 4389 } while (endIndex != str.length() - 1); 4390 4391 if (result.size() == 0) return null; 4392 4393 if (result.size() == 1) { 4394 Area area = result.get(0); 4395 Rect rect = area.rect; 4396 if (rect.left == 0 && rect.top == 0 && rect.right == 0 4397 && rect.bottom == 0 && area.weight == 0) { 4398 return null; 4399 } 4400 } 4401 4402 return result; 4403 } 4404 4405 private boolean same(String s1, String s2) { 4406 if (s1 == null && s2 == null) return true; 4407 if (s1 != null && s1.equals(s2)) return true; 4408 return false; 4409 } 4410 }; 4411} 4412