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