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