Camera.java revision ca099614841bc619f217dfa088da630a7eb1ab65
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 java.lang.ref.WeakReference; 20import java.util.ArrayList; 21import java.util.HashMap; 22import java.util.List; 23import java.util.StringTokenizer; 24import java.io.IOException; 25 26import android.util.Log; 27import android.view.Surface; 28import android.view.SurfaceHolder; 29import android.graphics.ImageFormat; 30import android.os.Handler; 31import android.os.Looper; 32import android.os.Message; 33 34/** 35 * The Camera class is used to connect/disconnect with the camera service, 36 * set capture settings, start/stop preview, snap a picture, and retrieve 37 * frames for encoding for video. 38 * <p>There is no default constructor for this class. Use {@link #open()} to 39 * get a Camera object.</p> 40 * 41 * <p>In order to use the device camera, you must declare the 42 * {@link android.Manifest.permission#CAMERA} permission in your Android 43 * Manifest. Also be sure to include the 44 * <a href="{@docRoot}guide/topics/manifest/uses-feature-element.html"><uses-feature></a> 45 * manifest element in order to declare camera features used by your application. 46 * For example, if you use the camera and auto-focus feature, your Manifest 47 * should include the following:</p> 48 * <pre> <uses-permission android:name="android.permission.CAMERA" /> 49 * <uses-feature android:name="android.hardware.camera" /> 50 * <uses-feature android:name="android.hardware.camera.autofocus" /></pre> 51 * 52 * <p class="caution"><strong>Caution:</strong> Different Android-powered devices 53 * may have different hardware specifications, such as megapixel ratings and 54 * auto-focus capabilities. In order for your application to be compatible with 55 * more devices, you should not make assumptions about the device camera 56 * specifications.</p> 57 */ 58public class Camera { 59 private static final String TAG = "Camera"; 60 61 // These match the enums in frameworks/base/include/ui/Camera.h 62 private static final int CAMERA_MSG_ERROR = 0x001; 63 private static final int CAMERA_MSG_SHUTTER = 0x002; 64 private static final int CAMERA_MSG_FOCUS = 0x004; 65 private static final int CAMERA_MSG_ZOOM = 0x008; 66 private static final int CAMERA_MSG_PREVIEW_FRAME = 0x010; 67 private static final int CAMERA_MSG_VIDEO_FRAME = 0x020; 68 private static final int CAMERA_MSG_POSTVIEW_FRAME = 0x040; 69 private static final int CAMERA_MSG_RAW_IMAGE = 0x080; 70 private static final int CAMERA_MSG_COMPRESSED_IMAGE = 0x100; 71 private static final int CAMERA_MSG_ALL_MSGS = 0x1FF; 72 73 private int mNativeContext; // accessed by native methods 74 private EventHandler mEventHandler; 75 private ShutterCallback mShutterCallback; 76 private PictureCallback mRawImageCallback; 77 private PictureCallback mJpegCallback; 78 private PreviewCallback mPreviewCallback; 79 private PictureCallback mPostviewCallback; 80 private AutoFocusCallback mAutoFocusCallback; 81 private OnZoomChangeListener mZoomListener; 82 private ErrorCallback mErrorCallback; 83 private boolean mOneShot; 84 private boolean mWithBuffer; 85 86 /** 87 * Returns the number of Cameras available. 88 * @hide 89 */ 90 public native static int getNumberOfCameras(); 91 92 /** 93 * Returns a new Camera object. 94 * If {@link #getNumberOfCameras()} returns N, the valid is is 0 to N-1. 95 * The id 0 is the default camera. 96 * @hide 97 */ 98 public static Camera open(int cameraId) { 99 return new Camera(cameraId); 100 } 101 102 /** 103 * Returns a new Camera object. This returns the default camera. 104 */ 105 public static Camera open() { 106 return new Camera(0); 107 } 108 109 Camera(int cameraId) { 110 mShutterCallback = null; 111 mRawImageCallback = null; 112 mJpegCallback = null; 113 mPreviewCallback = null; 114 mPostviewCallback = null; 115 mZoomListener = null; 116 117 Looper looper; 118 if ((looper = Looper.myLooper()) != null) { 119 mEventHandler = new EventHandler(this, looper); 120 } else if ((looper = Looper.getMainLooper()) != null) { 121 mEventHandler = new EventHandler(this, looper); 122 } else { 123 mEventHandler = null; 124 } 125 126 native_setup(new WeakReference<Camera>(this), cameraId); 127 } 128 129 protected void finalize() { 130 native_release(); 131 } 132 133 private native final void native_setup(Object camera_this, int cameraId); 134 private native final void native_release(); 135 136 137 /** 138 * Disconnects and releases the Camera object resources. 139 * <p>It is recommended that you call this as soon as you're done with the 140 * Camera object.</p> 141 */ 142 public final void release() { 143 native_release(); 144 } 145 146 /** 147 * Reconnect to the camera after passing it to MediaRecorder. To save 148 * setup/teardown time, a client of Camera can pass an initialized Camera 149 * object to a MediaRecorder to use for video recording. Once the 150 * MediaRecorder is done with the Camera, this method can be used to 151 * re-establish a connection with the camera hardware. NOTE: The Camera 152 * object must first be unlocked by the process that owns it before it 153 * can be connected to another process. 154 * 155 * @throws IOException if the method fails. 156 */ 157 public native final void reconnect() throws IOException; 158 159 /** 160 * Lock the camera to prevent other processes from accessing it. To save 161 * setup/teardown time, a client of Camera can pass an initialized Camera 162 * object to another process. This method is used to re-lock the Camera 163 * object prevent other processes from accessing it. By default, the 164 * Camera object is locked. Locking it again from the same process will 165 * have no effect. Attempting to lock it from another process if it has 166 * not been unlocked will fail. 167 * 168 * @throws RuntimeException if the method fails. 169 */ 170 public native final void lock(); 171 172 /** 173 * Unlock the camera to allow another process to access it. To save 174 * setup/teardown time, a client of Camera can pass an initialized Camera 175 * object to another process. This method is used to unlock the Camera 176 * object before handing off the Camera object to the other process. 177 * 178 * @throws RuntimeException if the method fails. 179 */ 180 public native final void unlock(); 181 182 /** 183 * Sets the SurfaceHolder to be used for a picture preview. If the surface 184 * changed since the last call, the screen will blank. Nothing happens 185 * if the same surface is re-set. 186 * 187 * @param holder the SurfaceHolder upon which to place the picture preview 188 * @throws IOException if the method fails. 189 */ 190 public final void setPreviewDisplay(SurfaceHolder holder) throws IOException { 191 if (holder != null) { 192 setPreviewDisplay(holder.getSurface()); 193 } else { 194 setPreviewDisplay((Surface)null); 195 } 196 } 197 198 private native final void setPreviewDisplay(Surface surface); 199 200 /** 201 * Used to get a copy of each preview frame. 202 */ 203 public interface PreviewCallback 204 { 205 /** 206 * The callback that delivers the preview frames. 207 * 208 * @param data The contents of the preview frame in the format defined 209 * by {@link android.graphics.ImageFormat}, which can be queried 210 * with {@link android.hardware.Camera.Parameters#getPreviewFormat()}. 211 * If {@link android.hardware.Camera.Parameters#setPreviewFormat(int)} 212 * is never called, the default will be the YCbCr_420_SP 213 * (NV21) format. 214 * @param camera The Camera service object. 215 */ 216 void onPreviewFrame(byte[] data, Camera camera); 217 }; 218 219 /** 220 * Start drawing preview frames to the surface. 221 */ 222 public native final void startPreview(); 223 224 /** 225 * Stop drawing preview frames to the surface. 226 */ 227 public native final void stopPreview(); 228 229 /** 230 * Return current preview state. 231 * 232 * FIXME: Unhide before release 233 * @hide 234 */ 235 public native final boolean previewEnabled(); 236 237 /** 238 * Can be called at any time to instruct the camera to use a callback for 239 * each preview frame in addition to displaying it. 240 * 241 * @param cb A callback object that receives a copy of each preview frame. 242 * Pass null to stop receiving callbacks at any time. 243 */ 244 public final void setPreviewCallback(PreviewCallback cb) { 245 mPreviewCallback = cb; 246 mOneShot = false; 247 mWithBuffer = false; 248 // Always use one-shot mode. We fake camera preview mode by 249 // doing one-shot preview continuously. 250 setHasPreviewCallback(cb != null, false); 251 } 252 253 /** 254 * Installs a callback to retrieve a single preview frame, after which the 255 * callback is cleared. 256 * 257 * @param cb A callback object that receives a copy of the preview frame. 258 */ 259 public final void setOneShotPreviewCallback(PreviewCallback cb) { 260 mPreviewCallback = cb; 261 mOneShot = true; 262 mWithBuffer = false; 263 setHasPreviewCallback(cb != null, false); 264 } 265 266 private native final void setHasPreviewCallback(boolean installed, boolean manualBuffer); 267 268 /** 269 * Installs a callback which will get called as long as there are buffers in the 270 * preview buffer queue, which minimizes dynamic allocation of preview buffers. 271 * 272 * Apps must call addCallbackBuffer to explicitly register the buffers to use, or no callbacks 273 * will be received. addCallbackBuffer may be safely called before or after 274 * a call to setPreviewCallbackWithBuffer with a non-null callback parameter. 275 * 276 * The buffer queue will be cleared upon any calls to setOneShotPreviewCallback, 277 * setPreviewCallback, or to this method with a null callback parameter. 278 * 279 * @param cb A callback object that receives a copy of the preview frame. A null value will clear the queue. 280 */ 281 public final void setPreviewCallbackWithBuffer(PreviewCallback cb) { 282 mPreviewCallback = cb; 283 mOneShot = false; 284 mWithBuffer = true; 285 setHasPreviewCallback(cb != null, true); 286 } 287 288 /** 289 * Adds a pre-allocated buffer to the preview callback buffer queue. 290 * Applications can add one or more buffers to the queue. When a preview 291 * frame arrives and there is still available buffer, buffer will be filled 292 * and it is removed from the queue. Then preview callback is invoked with 293 * the buffer. If a frame arrives and there is no buffer left, the frame is 294 * discarded. Applications should add the buffers back when they finish the 295 * processing. 296 * 297 * The image format of the callback buffer can be read from {@link 298 * android.hardware.Camera.Parameters#getPreviewFormat()}. bitsPerPixel can 299 * be read from {@link android.graphics.ImageFormat#getBitsPerPixel(int)}. 300 * Preview width and height can be determined from getPreviewSize. 301 * 302 * Alternatively, a buffer from a previous callback may be passed in or used 303 * to determine the size of new preview frame buffers. 304 * 305 * @param callbackBuffer The buffer to register. Size should be width * height * bitsPerPixel / 8. 306 * @see #setPreviewCallbackWithBuffer(PreviewCallback) 307 */ 308 public native final void addCallbackBuffer(byte[] callbackBuffer); 309 310 private class EventHandler extends Handler 311 { 312 private Camera mCamera; 313 314 public EventHandler(Camera c, Looper looper) { 315 super(looper); 316 mCamera = c; 317 } 318 319 @Override 320 public void handleMessage(Message msg) { 321 switch(msg.what) { 322 case CAMERA_MSG_SHUTTER: 323 if (mShutterCallback != null) { 324 mShutterCallback.onShutter(); 325 } 326 return; 327 328 case CAMERA_MSG_RAW_IMAGE: 329 if (mRawImageCallback != null) { 330 mRawImageCallback.onPictureTaken((byte[])msg.obj, mCamera); 331 } 332 return; 333 334 case CAMERA_MSG_COMPRESSED_IMAGE: 335 if (mJpegCallback != null) { 336 mJpegCallback.onPictureTaken((byte[])msg.obj, mCamera); 337 } 338 return; 339 340 case CAMERA_MSG_PREVIEW_FRAME: 341 if (mPreviewCallback != null) { 342 PreviewCallback cb = mPreviewCallback; 343 if (mOneShot) { 344 // Clear the callback variable before the callback 345 // in case the app calls setPreviewCallback from 346 // the callback function 347 mPreviewCallback = null; 348 } else if (!mWithBuffer) { 349 // We're faking the camera preview mode to prevent 350 // the app from being flooded with preview frames. 351 // Set to oneshot mode again. 352 setHasPreviewCallback(true, false); 353 } 354 cb.onPreviewFrame((byte[])msg.obj, mCamera); 355 } 356 return; 357 358 case CAMERA_MSG_POSTVIEW_FRAME: 359 if (mPostviewCallback != null) { 360 mPostviewCallback.onPictureTaken((byte[])msg.obj, mCamera); 361 } 362 return; 363 364 case CAMERA_MSG_FOCUS: 365 if (mAutoFocusCallback != null) { 366 mAutoFocusCallback.onAutoFocus(msg.arg1 == 0 ? false : true, mCamera); 367 } 368 return; 369 370 case CAMERA_MSG_ZOOM: 371 if (mZoomListener != null) { 372 mZoomListener.onZoomChange(msg.arg1, msg.arg2 != 0, mCamera); 373 } 374 return; 375 376 case CAMERA_MSG_ERROR : 377 Log.e(TAG, "Error " + msg.arg1); 378 if (mErrorCallback != null) { 379 mErrorCallback.onError(msg.arg1, mCamera); 380 } 381 return; 382 383 default: 384 Log.e(TAG, "Unknown message type " + msg.what); 385 return; 386 } 387 } 388 } 389 390 private static void postEventFromNative(Object camera_ref, 391 int what, int arg1, int arg2, Object obj) 392 { 393 Camera c = (Camera)((WeakReference)camera_ref).get(); 394 if (c == null) 395 return; 396 397 if (c.mEventHandler != null) { 398 Message m = c.mEventHandler.obtainMessage(what, arg1, arg2, obj); 399 c.mEventHandler.sendMessage(m); 400 } 401 } 402 403 /** 404 * Handles the callback for the camera auto focus. 405 * <p>Devices that do not support auto-focus will receive a "fake" 406 * callback to this interface. If your application needs auto-focus and 407 * should not be installed on devices <em>without</em> auto-focus, you must 408 * declare that your app uses the 409 * {@code android.hardware.camera.autofocus} feature, in the 410 * <a href="{@docRoot}guide/topics/manifest/uses-feature-element.html"><uses-feature></a> 411 * manifest element.</p> 412 */ 413 public interface AutoFocusCallback 414 { 415 /** 416 * Callback for the camera auto focus. If the camera does not support 417 * auto-focus and autoFocus is called, onAutoFocus will be called 418 * immediately with success. 419 * 420 * @param success true if focus was successful, false if otherwise 421 * @param camera the Camera service object 422 */ 423 void onAutoFocus(boolean success, Camera camera); 424 }; 425 426 /** 427 * Starts auto-focus function and registers a callback function to run when 428 * camera is focused. Only valid after startPreview() has been called. 429 * Applications should call {@link 430 * android.hardware.Camera.Parameters#getFocusMode()} to determine if this 431 * method should be called. If the camera does not support auto-focus, it is 432 * a no-op and {@link AutoFocusCallback#onAutoFocus(boolean, Camera)} 433 * callback will be called immediately. 434 * <p>If your application should not be installed 435 * on devices without auto-focus, you must declare that your application 436 * uses auto-focus with the 437 * <a href="{@docRoot}guide/topics/manifest/uses-feature-element.html"><uses-feature></a> 438 * manifest element.</p> 439 * <p>If the current flash mode is not 440 * {@link android.hardware.Camera.Parameters#FLASH_MODE_OFF}, flash may be 441 * fired during auto-focus depending on the driver.<p> 442 * 443 * @param cb the callback to run 444 */ 445 public final void autoFocus(AutoFocusCallback cb) 446 { 447 mAutoFocusCallback = cb; 448 native_autoFocus(); 449 } 450 private native final void native_autoFocus(); 451 452 /** 453 * Cancels auto-focus function. If the auto-focus is still in progress, 454 * this function will cancel it. Whether the auto-focus is in progress 455 * or not, this function will return the focus position to the default. 456 * If the camera does not support auto-focus, this is a no-op. 457 */ 458 public final void cancelAutoFocus() 459 { 460 mAutoFocusCallback = null; 461 native_cancelAutoFocus(); 462 } 463 private native final void native_cancelAutoFocus(); 464 465 /** 466 * An interface which contains a callback for the shutter closing after taking a picture. 467 */ 468 public interface ShutterCallback 469 { 470 /** 471 * Can be used to play a shutter sound as soon as the image has been captured, but before 472 * the data is available. 473 */ 474 void onShutter(); 475 } 476 477 /** 478 * Handles the callback for when a picture is taken. 479 */ 480 public interface PictureCallback { 481 /** 482 * Callback for when a picture is taken. 483 * 484 * @param data a byte array of the picture data 485 * @param camera the Camera service object 486 */ 487 void onPictureTaken(byte[] data, Camera camera); 488 }; 489 490 /** 491 * Triggers an asynchronous image capture. The camera service will initiate 492 * a series of callbacks to the application as the image capture progresses. 493 * The shutter callback occurs after the image is captured. This can be used 494 * to trigger a sound to let the user know that image has been captured. The 495 * raw callback occurs when the raw image data is available (NOTE: the data 496 * may be null if the hardware does not have enough memory to make a copy). 497 * The jpeg callback occurs when the compressed image is available. If the 498 * application does not need a particular callback, a null can be passed 499 * instead of a callback method. 500 * 501 * This method will stop the preview. Applications should not call {@link 502 * #stopPreview()} before this. After jpeg callback is received, 503 * applications can call {@link #startPreview()} to restart the preview. 504 * 505 * @param shutter callback after the image is captured, may be null 506 * @param raw callback with raw image data, may be null 507 * @param jpeg callback with jpeg image data, may be null 508 */ 509 public final void takePicture(ShutterCallback shutter, PictureCallback raw, 510 PictureCallback jpeg) { 511 takePicture(shutter, raw, null, jpeg); 512 } 513 private native final void native_takePicture(); 514 515 /** 516 * Triggers an asynchronous image capture. The camera service will initiate 517 * a series of callbacks to the application as the image capture progresses. 518 * The shutter callback occurs after the image is captured. This can be used 519 * to trigger a sound to let the user know that image has been captured. The 520 * raw callback occurs when the raw image data is available (NOTE: the data 521 * may be null if the hardware does not have enough memory to make a copy). 522 * The postview callback occurs when a scaled, fully processed postview 523 * image is available (NOTE: not all hardware supports this). The jpeg 524 * callback occurs when the compressed image is available. If the 525 * application does not need a particular callback, a null can be passed 526 * instead of a callback method. 527 * 528 * This method will stop the preview. Applications should not call {@link 529 * #stopPreview()} before this. After jpeg callback is received, 530 * applications can call {@link #startPreview()} to restart the preview. 531 * 532 * @param shutter callback after the image is captured, may be null 533 * @param raw callback with raw image data, may be null 534 * @param postview callback with postview image data, may be null 535 * @param jpeg callback with jpeg image data, may be null 536 */ 537 public final void takePicture(ShutterCallback shutter, PictureCallback raw, 538 PictureCallback postview, PictureCallback jpeg) { 539 mShutterCallback = shutter; 540 mRawImageCallback = raw; 541 mPostviewCallback = postview; 542 mJpegCallback = jpeg; 543 native_takePicture(); 544 } 545 546 /** 547 * Zooms to the requested value smoothly. Driver will notify {@link 548 * OnZoomChangeListener} of the zoom value and whether zoom is stopped at 549 * the time. For example, suppose the current zoom is 0 and startSmoothZoom 550 * is called with value 3. Method onZoomChange will be called three times 551 * with zoom value 1, 2, and 3. The applications can call {@link 552 * #stopSmoothZoom} to stop the zoom earlier. The applications should not 553 * call startSmoothZoom again or change the zoom value before zoom stops. If 554 * the passing zoom value equals to the current zoom value, no zoom callback 555 * will be generated. This method is supported if {@link 556 * android.hardware.Camera.Parameters#isSmoothZoomSupported} is true. 557 * 558 * @param value zoom value. The valid range is 0 to {@link 559 * android.hardware.Camera.Parameters#getMaxZoom}. 560 * @throws IllegalArgumentException if the zoom value is invalid. 561 * @throws RuntimeException if the method fails. 562 */ 563 public native final void startSmoothZoom(int value); 564 565 /** 566 * Stops the smooth zoom. The applications should wait for the {@link 567 * OnZoomChangeListener} to know when the zoom is actually stopped. This 568 * method is supported if {@link 569 * android.hardware.Camera.Parameters#isSmoothZoomSupported} is true. 570 * 571 * @throws RuntimeException if the method fails. 572 */ 573 public native final void stopSmoothZoom(); 574 575 /** 576 * Set the display orientation. This affects the preview frames and the 577 * picture displayed after snapshot. This method is useful for portrait 578 * mode applications. 579 * 580 * This does not affect the order of byte array passed in 581 * {@link PreviewCallback#onPreviewFrame}. This method is not allowed to 582 * be called during preview. 583 * 584 * @param degrees the angle that the picture will be rotated clockwise. 585 * Valid values are 0, 90, 180, and 270. The starting 586 * position is 0 (landscape). 587 */ 588 public native final void setDisplayOrientation(int degrees); 589 590 /** 591 * Interface for a callback to be invoked when zoom value changes. 592 */ 593 public interface OnZoomChangeListener 594 { 595 /** 596 * Called when the zoom value has changed. 597 * 598 * @param zoomValue the current zoom value. In smooth zoom mode, camera 599 * calls this for every new zoom value. 600 * @param stopped whether smooth zoom is stopped. If the value is true, 601 * this is the last zoom update for the application. 602 * 603 * @param camera the Camera service object 604 * @see #startSmoothZoom(int) 605 */ 606 void onZoomChange(int zoomValue, boolean stopped, Camera camera); 607 }; 608 609 /** 610 * Registers a listener to be notified when the zoom value is updated by the 611 * camera driver during smooth zoom. 612 * 613 * @param listener the listener to notify 614 * @see #startSmoothZoom(int) 615 */ 616 public final void setZoomChangeListener(OnZoomChangeListener listener) 617 { 618 mZoomListener = listener; 619 } 620 621 // These match the enum in include/ui/Camera.h 622 /** Unspecified camerar error. @see #ErrorCallback */ 623 public static final int CAMERA_ERROR_UNKNOWN = 1; 624 /** Media server died. In this case, the application must release the 625 * Camera object and instantiate a new one. @see #ErrorCallback */ 626 public static final int CAMERA_ERROR_SERVER_DIED = 100; 627 628 /** 629 * Handles the camera error callback. 630 */ 631 public interface ErrorCallback 632 { 633 /** 634 * Callback for camera errors. 635 * @param error error code: 636 * <ul> 637 * <li>{@link #CAMERA_ERROR_UNKNOWN} 638 * <li>{@link #CAMERA_ERROR_SERVER_DIED} 639 * </ul> 640 * @param camera the Camera service object 641 */ 642 void onError(int error, Camera camera); 643 }; 644 645 /** 646 * Registers a callback to be invoked when an error occurs. 647 * @param cb the callback to run 648 */ 649 public final void setErrorCallback(ErrorCallback cb) 650 { 651 mErrorCallback = cb; 652 } 653 654 private native final void native_setParameters(String params); 655 private native final String native_getParameters(); 656 657 /** 658 * Sets the Parameters for pictures from this Camera service. 659 * 660 * @param params the Parameters to use for this Camera service 661 */ 662 public void setParameters(Parameters params) { 663 native_setParameters(params.flatten()); 664 } 665 666 /** 667 * Returns the picture Parameters for this Camera service. 668 */ 669 public Parameters getParameters() { 670 Parameters p = new Parameters(); 671 String s = native_getParameters(); 672 p.unflatten(s); 673 return p; 674 } 675 676 /** 677 * Handles the picture size (dimensions). 678 */ 679 public class Size { 680 /** 681 * Sets the dimensions for pictures. 682 * 683 * @param w the photo width (pixels) 684 * @param h the photo height (pixels) 685 */ 686 public Size(int w, int h) { 687 width = w; 688 height = h; 689 } 690 /** 691 * Compares {@code obj} to this size. 692 * 693 * @param obj the object to compare this size with. 694 * @return {@code true} if the width and height of {@code obj} is the 695 * same as those of this size. {@code false} otherwise. 696 */ 697 @Override 698 public boolean equals(Object obj) { 699 if (!(obj instanceof Size)) { 700 return false; 701 } 702 Size s = (Size) obj; 703 return width == s.width && height == s.height; 704 } 705 @Override 706 public int hashCode() { 707 return width * 32713 + height; 708 } 709 /** width of the picture */ 710 public int width; 711 /** height of the picture */ 712 public int height; 713 }; 714 715 /** 716 * Handles the parameters for pictures created by a Camera service. 717 * 718 * <p>To make camera parameters take effect, applications have to call 719 * Camera.setParameters. For example, after setWhiteBalance is called, white 720 * balance is not changed until Camera.setParameters() is called. 721 * 722 * <p>Different devices may have different camera capabilities, such as 723 * picture size or flash modes. The application should query the camera 724 * capabilities before setting parameters. For example, the application 725 * should call getSupportedColorEffects before calling setEffect. If the 726 * camera does not support color effects, getSupportedColorEffects will 727 * return null. 728 */ 729 public class Parameters { 730 // Parameter keys to communicate with the camera driver. 731 private static final String KEY_PREVIEW_SIZE = "preview-size"; 732 private static final String KEY_PREVIEW_FORMAT = "preview-format"; 733 private static final String KEY_PREVIEW_FRAME_RATE = "preview-frame-rate"; 734 private static final String KEY_PICTURE_SIZE = "picture-size"; 735 private static final String KEY_PICTURE_FORMAT = "picture-format"; 736 private static final String KEY_JPEG_THUMBNAIL_SIZE = "jpeg-thumbnail-size"; 737 private static final String KEY_JPEG_THUMBNAIL_WIDTH = "jpeg-thumbnail-width"; 738 private static final String KEY_JPEG_THUMBNAIL_HEIGHT = "jpeg-thumbnail-height"; 739 private static final String KEY_JPEG_THUMBNAIL_QUALITY = "jpeg-thumbnail-quality"; 740 private static final String KEY_JPEG_QUALITY = "jpeg-quality"; 741 private static final String KEY_ROTATION = "rotation"; 742 private static final String KEY_GPS_LATITUDE = "gps-latitude"; 743 private static final String KEY_GPS_LONGITUDE = "gps-longitude"; 744 private static final String KEY_GPS_ALTITUDE = "gps-altitude"; 745 private static final String KEY_GPS_TIMESTAMP = "gps-timestamp"; 746 private static final String KEY_GPS_PROCESSING_METHOD = "gps-processing-method"; 747 private static final String KEY_WHITE_BALANCE = "whitebalance"; 748 private static final String KEY_EFFECT = "effect"; 749 private static final String KEY_ANTIBANDING = "antibanding"; 750 private static final String KEY_SCENE_MODE = "scene-mode"; 751 private static final String KEY_FLASH_MODE = "flash-mode"; 752 private static final String KEY_FOCUS_MODE = "focus-mode"; 753 private static final String KEY_FOCAL_LENGTH = "focal-length"; 754 private static final String KEY_HORIZONTAL_VIEW_ANGLE = "horizontal-view-angle"; 755 private static final String KEY_VERTICAL_VIEW_ANGLE = "vertical-view-angle"; 756 private static final String KEY_EXPOSURE_COMPENSATION = "exposure-compensation"; 757 private static final String KEY_MAX_EXPOSURE_COMPENSATION = "max-exposure-compensation"; 758 private static final String KEY_MIN_EXPOSURE_COMPENSATION = "min-exposure-compensation"; 759 private static final String KEY_EXPOSURE_COMPENSATION_STEP = "exposure-compensation-step"; 760 private static final String KEY_ZOOM = "zoom"; 761 private static final String KEY_MAX_ZOOM = "max-zoom"; 762 private static final String KEY_ZOOM_RATIOS = "zoom-ratios"; 763 private static final String KEY_ZOOM_SUPPORTED = "zoom-supported"; 764 private static final String KEY_SMOOTH_ZOOM_SUPPORTED = "smooth-zoom-supported"; 765 // Parameter key suffix for supported values. 766 private static final String SUPPORTED_VALUES_SUFFIX = "-values"; 767 768 private static final String TRUE = "true"; 769 770 // Values for white balance settings. 771 public static final String WHITE_BALANCE_AUTO = "auto"; 772 public static final String WHITE_BALANCE_INCANDESCENT = "incandescent"; 773 public static final String WHITE_BALANCE_FLUORESCENT = "fluorescent"; 774 public static final String WHITE_BALANCE_WARM_FLUORESCENT = "warm-fluorescent"; 775 public static final String WHITE_BALANCE_DAYLIGHT = "daylight"; 776 public static final String WHITE_BALANCE_CLOUDY_DAYLIGHT = "cloudy-daylight"; 777 public static final String WHITE_BALANCE_TWILIGHT = "twilight"; 778 public static final String WHITE_BALANCE_SHADE = "shade"; 779 780 // Values for color effect settings. 781 public static final String EFFECT_NONE = "none"; 782 public static final String EFFECT_MONO = "mono"; 783 public static final String EFFECT_NEGATIVE = "negative"; 784 public static final String EFFECT_SOLARIZE = "solarize"; 785 public static final String EFFECT_SEPIA = "sepia"; 786 public static final String EFFECT_POSTERIZE = "posterize"; 787 public static final String EFFECT_WHITEBOARD = "whiteboard"; 788 public static final String EFFECT_BLACKBOARD = "blackboard"; 789 public static final String EFFECT_AQUA = "aqua"; 790 791 // Values for antibanding settings. 792 public static final String ANTIBANDING_AUTO = "auto"; 793 public static final String ANTIBANDING_50HZ = "50hz"; 794 public static final String ANTIBANDING_60HZ = "60hz"; 795 public static final String ANTIBANDING_OFF = "off"; 796 797 // Values for flash mode settings. 798 /** 799 * Flash will not be fired. 800 */ 801 public static final String FLASH_MODE_OFF = "off"; 802 803 /** 804 * Flash will be fired automatically when required. The flash may be fired 805 * during preview, auto-focus, or snapshot depending on the driver. 806 */ 807 public static final String FLASH_MODE_AUTO = "auto"; 808 809 /** 810 * Flash will always be fired during snapshot. The flash may also be 811 * fired during preview or auto-focus depending on the driver. 812 */ 813 public static final String FLASH_MODE_ON = "on"; 814 815 /** 816 * Flash will be fired in red-eye reduction mode. 817 */ 818 public static final String FLASH_MODE_RED_EYE = "red-eye"; 819 820 /** 821 * Constant emission of light during preview, auto-focus and snapshot. 822 * This can also be used for video recording. 823 */ 824 public static final String FLASH_MODE_TORCH = "torch"; 825 826 // Values for scene mode settings. 827 public static final String SCENE_MODE_AUTO = "auto"; 828 public static final String SCENE_MODE_ACTION = "action"; 829 public static final String SCENE_MODE_PORTRAIT = "portrait"; 830 public static final String SCENE_MODE_LANDSCAPE = "landscape"; 831 public static final String SCENE_MODE_NIGHT = "night"; 832 public static final String SCENE_MODE_NIGHT_PORTRAIT = "night-portrait"; 833 public static final String SCENE_MODE_THEATRE = "theatre"; 834 public static final String SCENE_MODE_BEACH = "beach"; 835 public static final String SCENE_MODE_SNOW = "snow"; 836 public static final String SCENE_MODE_SUNSET = "sunset"; 837 public static final String SCENE_MODE_STEADYPHOTO = "steadyphoto"; 838 public static final String SCENE_MODE_FIREWORKS = "fireworks"; 839 public static final String SCENE_MODE_SPORTS = "sports"; 840 public static final String SCENE_MODE_PARTY = "party"; 841 public static final String SCENE_MODE_CANDLELIGHT = "candlelight"; 842 843 /** 844 * Applications are looking for a barcode. Camera driver will be 845 * optimized for barcode reading. 846 */ 847 public static final String SCENE_MODE_BARCODE = "barcode"; 848 849 // Values for focus mode settings. 850 /** 851 * Auto-focus mode. 852 */ 853 public static final String FOCUS_MODE_AUTO = "auto"; 854 855 /** 856 * Focus is set at infinity. Applications should not call 857 * {@link #autoFocus(AutoFocusCallback)} in this mode. 858 */ 859 public static final String FOCUS_MODE_INFINITY = "infinity"; 860 public static final String FOCUS_MODE_MACRO = "macro"; 861 862 /** 863 * Focus is fixed. The camera is always in this mode if the focus is not 864 * adjustable. If the camera has auto-focus, this mode can fix the 865 * focus, which is usually at hyperfocal distance. Applications should 866 * not call {@link #autoFocus(AutoFocusCallback)} in this mode. 867 */ 868 public static final String FOCUS_MODE_FIXED = "fixed"; 869 870 /** 871 * Extended depth of field (EDOF). Focusing is done digitally and 872 * continuously. Applications should not call {@link 873 * #autoFocus(AutoFocusCallback)} in this mode. 874 */ 875 public static final String FOCUS_MODE_EDOF = "edof"; 876 877 /** 878 * Continuous focus mode. The camera continuously tries to focus. This 879 * is ideal for shooting video or shooting photo of moving object. 880 * Continuous focus starts when {@link #autoFocus(AutoFocusCallback)} is 881 * called. AutoFocusCallback will be only called once as soon as the 882 * picture is in focus. 883 */ 884 public static final String FOCUS_MODE_CONTINUOUS = "continuous"; 885 886 887 // Formats for setPreviewFormat and setPictureFormat. 888 private static final String PIXEL_FORMAT_YUV422SP = "yuv422sp"; 889 private static final String PIXEL_FORMAT_YUV420SP = "yuv420sp"; 890 private static final String PIXEL_FORMAT_YUV422I = "yuv422i-yuyv"; 891 private static final String PIXEL_FORMAT_RGB565 = "rgb565"; 892 private static final String PIXEL_FORMAT_JPEG = "jpeg"; 893 894 private HashMap<String, String> mMap; 895 896 private Parameters() { 897 mMap = new HashMap<String, String>(); 898 } 899 900 /** 901 * Writes the current Parameters to the log. 902 * @hide 903 * @deprecated 904 */ 905 public void dump() { 906 Log.e(TAG, "dump: size=" + mMap.size()); 907 for (String k : mMap.keySet()) { 908 Log.e(TAG, "dump: " + k + "=" + mMap.get(k)); 909 } 910 } 911 912 /** 913 * Creates a single string with all the parameters set in 914 * this Parameters object. 915 * <p>The {@link #unflatten(String)} method does the reverse.</p> 916 * 917 * @return a String with all values from this Parameters object, in 918 * semi-colon delimited key-value pairs 919 */ 920 public String flatten() { 921 StringBuilder flattened = new StringBuilder(); 922 for (String k : mMap.keySet()) { 923 flattened.append(k); 924 flattened.append("="); 925 flattened.append(mMap.get(k)); 926 flattened.append(";"); 927 } 928 // chop off the extra semicolon at the end 929 flattened.deleteCharAt(flattened.length()-1); 930 return flattened.toString(); 931 } 932 933 /** 934 * Takes a flattened string of parameters and adds each one to 935 * this Parameters object. 936 * <p>The {@link #flatten()} method does the reverse.</p> 937 * 938 * @param flattened a String of parameters (key-value paired) that 939 * are semi-colon delimited 940 */ 941 public void unflatten(String flattened) { 942 mMap.clear(); 943 944 StringTokenizer tokenizer = new StringTokenizer(flattened, ";"); 945 while (tokenizer.hasMoreElements()) { 946 String kv = tokenizer.nextToken(); 947 int pos = kv.indexOf('='); 948 if (pos == -1) { 949 continue; 950 } 951 String k = kv.substring(0, pos); 952 String v = kv.substring(pos + 1); 953 mMap.put(k, v); 954 } 955 } 956 957 public void remove(String key) { 958 mMap.remove(key); 959 } 960 961 /** 962 * Sets a String parameter. 963 * 964 * @param key the key name for the parameter 965 * @param value the String value of the parameter 966 */ 967 public void set(String key, String value) { 968 if (key.indexOf('=') != -1 || key.indexOf(';') != -1) { 969 Log.e(TAG, "Key \"" + key + "\" contains invalid character (= or ;)"); 970 return; 971 } 972 if (value.indexOf('=') != -1 || value.indexOf(';') != -1) { 973 Log.e(TAG, "Value \"" + value + "\" contains invalid character (= or ;)"); 974 return; 975 } 976 977 mMap.put(key, value); 978 } 979 980 /** 981 * Sets an integer parameter. 982 * 983 * @param key the key name for the parameter 984 * @param value the int value of the parameter 985 */ 986 public void set(String key, int value) { 987 mMap.put(key, Integer.toString(value)); 988 } 989 990 /** 991 * Returns the value of a String parameter. 992 * 993 * @param key the key name for the parameter 994 * @return the String value of the parameter 995 */ 996 public String get(String key) { 997 return mMap.get(key); 998 } 999 1000 /** 1001 * Returns the value of an integer parameter. 1002 * 1003 * @param key the key name for the parameter 1004 * @return the int value of the parameter 1005 */ 1006 public int getInt(String key) { 1007 return Integer.parseInt(mMap.get(key)); 1008 } 1009 1010 /** 1011 * Sets the dimensions for preview pictures. 1012 * 1013 * @param width the width of the pictures, in pixels 1014 * @param height the height of the pictures, in pixels 1015 */ 1016 public void setPreviewSize(int width, int height) { 1017 String v = Integer.toString(width) + "x" + Integer.toString(height); 1018 set(KEY_PREVIEW_SIZE, v); 1019 } 1020 1021 /** 1022 * Returns the dimensions setting for preview pictures. 1023 * 1024 * @return a Size object with the height and width setting 1025 * for the preview picture 1026 */ 1027 public Size getPreviewSize() { 1028 String pair = get(KEY_PREVIEW_SIZE); 1029 return strToSize(pair); 1030 } 1031 1032 /** 1033 * Gets the supported preview sizes. 1034 * 1035 * @return a list of Size object. This method will always return a list 1036 * with at least one element. 1037 */ 1038 public List<Size> getSupportedPreviewSizes() { 1039 String str = get(KEY_PREVIEW_SIZE + SUPPORTED_VALUES_SUFFIX); 1040 return splitSize(str); 1041 } 1042 1043 /** 1044 * Sets the dimensions for EXIF thumbnail in Jpeg picture. If 1045 * applications set both width and height to 0, EXIF will not contain 1046 * thumbnail. 1047 * 1048 * @param width the width of the thumbnail, in pixels 1049 * @param height the height of the thumbnail, in pixels 1050 */ 1051 public void setJpegThumbnailSize(int width, int height) { 1052 set(KEY_JPEG_THUMBNAIL_WIDTH, width); 1053 set(KEY_JPEG_THUMBNAIL_HEIGHT, height); 1054 } 1055 1056 /** 1057 * Returns the dimensions for EXIF thumbnail in Jpeg picture. 1058 * 1059 * @return a Size object with the height and width setting for the EXIF 1060 * thumbnails 1061 */ 1062 public Size getJpegThumbnailSize() { 1063 return new Size(getInt(KEY_JPEG_THUMBNAIL_WIDTH), 1064 getInt(KEY_JPEG_THUMBNAIL_HEIGHT)); 1065 } 1066 1067 /** 1068 * Gets the supported jpeg thumbnail sizes. 1069 * 1070 * @return a list of Size object. This method will always return a list 1071 * with at least two elements. Size 0,0 (no thumbnail) is always 1072 * supported. 1073 */ 1074 public List<Size> getSupportedJpegThumbnailSizes() { 1075 String str = get(KEY_JPEG_THUMBNAIL_SIZE + SUPPORTED_VALUES_SUFFIX); 1076 return splitSize(str); 1077 } 1078 1079 /** 1080 * Sets the quality of the EXIF thumbnail in Jpeg picture. 1081 * 1082 * @param quality the JPEG quality of the EXIF thumbnail. The range is 1 1083 * to 100, with 100 being the best. 1084 */ 1085 public void setJpegThumbnailQuality(int quality) { 1086 set(KEY_JPEG_THUMBNAIL_QUALITY, quality); 1087 } 1088 1089 /** 1090 * Returns the quality setting for the EXIF thumbnail in Jpeg picture. 1091 * 1092 * @return the JPEG quality setting of the EXIF thumbnail. 1093 */ 1094 public int getJpegThumbnailQuality() { 1095 return getInt(KEY_JPEG_THUMBNAIL_QUALITY); 1096 } 1097 1098 /** 1099 * Sets Jpeg quality of captured picture. 1100 * 1101 * @param quality the JPEG quality of captured picture. The range is 1 1102 * to 100, with 100 being the best. 1103 */ 1104 public void setJpegQuality(int quality) { 1105 set(KEY_JPEG_QUALITY, quality); 1106 } 1107 1108 /** 1109 * Returns the quality setting for the JPEG picture. 1110 * 1111 * @return the JPEG picture quality setting. 1112 */ 1113 public int getJpegQuality() { 1114 return getInt(KEY_JPEG_QUALITY); 1115 } 1116 1117 /** 1118 * Sets the rate at which preview frames are received. This is the 1119 * target frame rate. The actual frame rate depends on the driver. 1120 * 1121 * @param fps the frame rate (frames per second) 1122 */ 1123 public void setPreviewFrameRate(int fps) { 1124 set(KEY_PREVIEW_FRAME_RATE, fps); 1125 } 1126 1127 /** 1128 * Returns the setting for the rate at which preview frames are 1129 * received. This is the target frame rate. The actual frame rate 1130 * depends on the driver. 1131 * 1132 * @return the frame rate setting (frames per second) 1133 */ 1134 public int getPreviewFrameRate() { 1135 return getInt(KEY_PREVIEW_FRAME_RATE); 1136 } 1137 1138 /** 1139 * Gets the supported preview frame rates. 1140 * 1141 * @return a list of supported preview frame rates. null if preview 1142 * frame rate setting is not supported. 1143 */ 1144 public List<Integer> getSupportedPreviewFrameRates() { 1145 String str = get(KEY_PREVIEW_FRAME_RATE + SUPPORTED_VALUES_SUFFIX); 1146 return splitInt(str); 1147 } 1148 1149 /** 1150 * Sets the image format for preview pictures. 1151 * <p>If this is never called, the default format will be 1152 * {@link android.graphics.ImageFormat#NV21}, which 1153 * uses the NV21 encoding format.</p> 1154 * 1155 * @param pixel_format the desired preview picture format, defined 1156 * by one of the {@link android.graphics.ImageFormat} constants. 1157 * (E.g., <var>ImageFormat.NV21</var> (default), 1158 * <var>ImageFormat.RGB_565</var>, or 1159 * <var>ImageFormat.JPEG</var>) 1160 * @see android.graphics.ImageFormat 1161 */ 1162 public void setPreviewFormat(int pixel_format) { 1163 String s = cameraFormatForPixelFormat(pixel_format); 1164 if (s == null) { 1165 throw new IllegalArgumentException( 1166 "Invalid pixel_format=" + pixel_format); 1167 } 1168 1169 set(KEY_PREVIEW_FORMAT, s); 1170 } 1171 1172 /** 1173 * Returns the image format for preview frames got from 1174 * {@link PreviewCallback}. 1175 * 1176 * @return the preview format. 1177 * @see android.graphics.ImageFormat 1178 */ 1179 public int getPreviewFormat() { 1180 return pixelFormatForCameraFormat(get(KEY_PREVIEW_FORMAT)); 1181 } 1182 1183 /** 1184 * Gets the supported preview formats. 1185 * 1186 * @return a list of supported preview formats. This method will always 1187 * return a list with at least one element. 1188 * @see android.graphics.ImageFormat 1189 */ 1190 public List<Integer> getSupportedPreviewFormats() { 1191 String str = get(KEY_PREVIEW_FORMAT + SUPPORTED_VALUES_SUFFIX); 1192 ArrayList<Integer> formats = new ArrayList<Integer>(); 1193 for (String s : split(str)) { 1194 int f = pixelFormatForCameraFormat(s); 1195 if (f == ImageFormat.UNKNOWN) continue; 1196 formats.add(f); 1197 } 1198 return formats; 1199 } 1200 1201 /** 1202 * Sets the dimensions for pictures. 1203 * 1204 * @param width the width for pictures, in pixels 1205 * @param height the height for pictures, in pixels 1206 */ 1207 public void setPictureSize(int width, int height) { 1208 String v = Integer.toString(width) + "x" + Integer.toString(height); 1209 set(KEY_PICTURE_SIZE, v); 1210 } 1211 1212 /** 1213 * Returns the dimension setting for pictures. 1214 * 1215 * @return a Size object with the height and width setting 1216 * for pictures 1217 */ 1218 public Size getPictureSize() { 1219 String pair = get(KEY_PICTURE_SIZE); 1220 return strToSize(pair); 1221 } 1222 1223 /** 1224 * Gets the supported picture sizes. 1225 * 1226 * @return a list of supported picture sizes. This method will always 1227 * return a list with at least one element. 1228 */ 1229 public List<Size> getSupportedPictureSizes() { 1230 String str = get(KEY_PICTURE_SIZE + SUPPORTED_VALUES_SUFFIX); 1231 return splitSize(str); 1232 } 1233 1234 /** 1235 * Sets the image format for pictures. 1236 * 1237 * @param pixel_format the desired picture format 1238 * (<var>ImageFormat.NV21</var>, 1239 * <var>ImageFormat.RGB_565</var>, or 1240 * <var>ImageFormat.JPEG</var>) 1241 * @see android.graphics.ImageFormat 1242 */ 1243 public void setPictureFormat(int pixel_format) { 1244 String s = cameraFormatForPixelFormat(pixel_format); 1245 if (s == null) { 1246 throw new IllegalArgumentException( 1247 "Invalid pixel_format=" + pixel_format); 1248 } 1249 1250 set(KEY_PICTURE_FORMAT, s); 1251 } 1252 1253 /** 1254 * Returns the image format for pictures. 1255 * 1256 * @return the picture format 1257 * @see android.graphics.ImageFormat 1258 */ 1259 public int getPictureFormat() { 1260 return pixelFormatForCameraFormat(get(KEY_PICTURE_FORMAT)); 1261 } 1262 1263 /** 1264 * Gets the supported picture formats. 1265 * 1266 * @return supported picture formats. This method will always return a 1267 * list with at least one element. 1268 * @see android.graphics.ImageFormat 1269 */ 1270 public List<Integer> getSupportedPictureFormats() { 1271 String str = get(KEY_PICTURE_FORMAT + SUPPORTED_VALUES_SUFFIX); 1272 ArrayList<Integer> formats = new ArrayList<Integer>(); 1273 for (String s : split(str)) { 1274 int f = pixelFormatForCameraFormat(s); 1275 if (f == ImageFormat.UNKNOWN) continue; 1276 formats.add(f); 1277 } 1278 return formats; 1279 } 1280 1281 private String cameraFormatForPixelFormat(int pixel_format) { 1282 switch(pixel_format) { 1283 case ImageFormat.NV16: return PIXEL_FORMAT_YUV422SP; 1284 case ImageFormat.NV21: return PIXEL_FORMAT_YUV420SP; 1285 case ImageFormat.YUY2: return PIXEL_FORMAT_YUV422I; 1286 case ImageFormat.RGB_565: return PIXEL_FORMAT_RGB565; 1287 case ImageFormat.JPEG: return PIXEL_FORMAT_JPEG; 1288 default: return null; 1289 } 1290 } 1291 1292 private int pixelFormatForCameraFormat(String format) { 1293 if (format == null) 1294 return ImageFormat.UNKNOWN; 1295 1296 if (format.equals(PIXEL_FORMAT_YUV422SP)) 1297 return ImageFormat.NV16; 1298 1299 if (format.equals(PIXEL_FORMAT_YUV420SP)) 1300 return ImageFormat.NV21; 1301 1302 if (format.equals(PIXEL_FORMAT_YUV422I)) 1303 return ImageFormat.YUY2; 1304 1305 if (format.equals(PIXEL_FORMAT_RGB565)) 1306 return ImageFormat.RGB_565; 1307 1308 if (format.equals(PIXEL_FORMAT_JPEG)) 1309 return ImageFormat.JPEG; 1310 1311 return ImageFormat.UNKNOWN; 1312 } 1313 1314 /** 1315 * Sets the orientation of the device in degrees. For example, suppose 1316 * the natural position of the device is landscape. If the user takes a 1317 * picture in landscape mode in 2048x1536 resolution, the rotation 1318 * should be set to 0. If the user rotates the phone 90 degrees 1319 * clockwise, the rotation should be set to 90. Applications can use 1320 * {@link android.view.OrientationEventListener} to set this parameter. 1321 * 1322 * The camera driver may set orientation in the EXIF header without 1323 * rotating the picture. Or the driver may rotate the picture and 1324 * the EXIF thumbnail. If the Jpeg picture is rotated, the orientation 1325 * in the EXIF header will be missing or 1 (row #0 is top and column #0 1326 * is left side). 1327 * 1328 * @param rotation The orientation of the device in degrees. Rotation 1329 * can only be 0, 90, 180 or 270. 1330 * @throws IllegalArgumentException if rotation value is invalid. 1331 * @see android.view.OrientationEventListener 1332 */ 1333 public void setRotation(int rotation) { 1334 if (rotation == 0 || rotation == 90 || rotation == 180 1335 || rotation == 270) { 1336 set(KEY_ROTATION, Integer.toString(rotation)); 1337 } else { 1338 throw new IllegalArgumentException( 1339 "Invalid rotation=" + rotation); 1340 } 1341 } 1342 1343 /** 1344 * Sets GPS latitude coordinate. This will be stored in JPEG EXIF 1345 * header. 1346 * 1347 * @param latitude GPS latitude coordinate. 1348 */ 1349 public void setGpsLatitude(double latitude) { 1350 set(KEY_GPS_LATITUDE, Double.toString(latitude)); 1351 } 1352 1353 /** 1354 * Sets GPS longitude coordinate. This will be stored in JPEG EXIF 1355 * header. 1356 * 1357 * @param longitude GPS longitude coordinate. 1358 */ 1359 public void setGpsLongitude(double longitude) { 1360 set(KEY_GPS_LONGITUDE, Double.toString(longitude)); 1361 } 1362 1363 /** 1364 * Sets GPS altitude. This will be stored in JPEG EXIF header. 1365 * 1366 * @param altitude GPS altitude in meters. 1367 */ 1368 public void setGpsAltitude(double altitude) { 1369 set(KEY_GPS_ALTITUDE, Double.toString(altitude)); 1370 } 1371 1372 /** 1373 * Sets GPS timestamp. This will be stored in JPEG EXIF header. 1374 * 1375 * @param timestamp GPS timestamp (UTC in seconds since January 1, 1376 * 1970). 1377 */ 1378 public void setGpsTimestamp(long timestamp) { 1379 set(KEY_GPS_TIMESTAMP, Long.toString(timestamp)); 1380 } 1381 1382 /** 1383 * Sets GPS processing method. It will store up to 32 characters 1384 * in JPEG EXIF header. 1385 * 1386 * @param processing_method The processing method to get this location. 1387 */ 1388 public void setGpsProcessingMethod(String processing_method) { 1389 set(KEY_GPS_PROCESSING_METHOD, processing_method); 1390 } 1391 1392 /** 1393 * Removes GPS latitude, longitude, altitude, and timestamp from the 1394 * parameters. 1395 */ 1396 public void removeGpsData() { 1397 remove(KEY_GPS_LATITUDE); 1398 remove(KEY_GPS_LONGITUDE); 1399 remove(KEY_GPS_ALTITUDE); 1400 remove(KEY_GPS_TIMESTAMP); 1401 remove(KEY_GPS_PROCESSING_METHOD); 1402 } 1403 1404 /** 1405 * Gets the current white balance setting. 1406 * 1407 * @return current white balance. null if white balance setting is not 1408 * supported. 1409 * @see #WHITE_BALANCE_AUTO 1410 * @see #WHITE_BALANCE_INCANDESCENT 1411 * @see #WHITE_BALANCE_FLUORESCENT 1412 * @see #WHITE_BALANCE_WARM_FLUORESCENT 1413 * @see #WHITE_BALANCE_DAYLIGHT 1414 * @see #WHITE_BALANCE_CLOUDY_DAYLIGHT 1415 * @see #WHITE_BALANCE_TWILIGHT 1416 * @see #WHITE_BALANCE_SHADE 1417 * 1418 */ 1419 public String getWhiteBalance() { 1420 return get(KEY_WHITE_BALANCE); 1421 } 1422 1423 /** 1424 * Sets the white balance. 1425 * 1426 * @param value new white balance. 1427 * @see #getWhiteBalance() 1428 */ 1429 public void setWhiteBalance(String value) { 1430 set(KEY_WHITE_BALANCE, value); 1431 } 1432 1433 /** 1434 * Gets the supported white balance. 1435 * 1436 * @return a list of supported white balance. null if white balance 1437 * setting is not supported. 1438 * @see #getWhiteBalance() 1439 */ 1440 public List<String> getSupportedWhiteBalance() { 1441 String str = get(KEY_WHITE_BALANCE + SUPPORTED_VALUES_SUFFIX); 1442 return split(str); 1443 } 1444 1445 /** 1446 * Gets the current color effect setting. 1447 * 1448 * @return current color effect. null if color effect 1449 * setting is not supported. 1450 * @see #EFFECT_NONE 1451 * @see #EFFECT_MONO 1452 * @see #EFFECT_NEGATIVE 1453 * @see #EFFECT_SOLARIZE 1454 * @see #EFFECT_SEPIA 1455 * @see #EFFECT_POSTERIZE 1456 * @see #EFFECT_WHITEBOARD 1457 * @see #EFFECT_BLACKBOARD 1458 * @see #EFFECT_AQUA 1459 */ 1460 public String getColorEffect() { 1461 return get(KEY_EFFECT); 1462 } 1463 1464 /** 1465 * Sets the current color effect setting. 1466 * 1467 * @param value new color effect. 1468 * @see #getColorEffect() 1469 */ 1470 public void setColorEffect(String value) { 1471 set(KEY_EFFECT, value); 1472 } 1473 1474 /** 1475 * Gets the supported color effects. 1476 * 1477 * @return a list of supported color effects. null if color effect 1478 * setting is not supported. 1479 * @see #getColorEffect() 1480 */ 1481 public List<String> getSupportedColorEffects() { 1482 String str = get(KEY_EFFECT + SUPPORTED_VALUES_SUFFIX); 1483 return split(str); 1484 } 1485 1486 1487 /** 1488 * Gets the current antibanding setting. 1489 * 1490 * @return current antibanding. null if antibanding setting is not 1491 * supported. 1492 * @see #ANTIBANDING_AUTO 1493 * @see #ANTIBANDING_50HZ 1494 * @see #ANTIBANDING_60HZ 1495 * @see #ANTIBANDING_OFF 1496 */ 1497 public String getAntibanding() { 1498 return get(KEY_ANTIBANDING); 1499 } 1500 1501 /** 1502 * Sets the antibanding. 1503 * 1504 * @param antibanding new antibanding value. 1505 * @see #getAntibanding() 1506 */ 1507 public void setAntibanding(String antibanding) { 1508 set(KEY_ANTIBANDING, antibanding); 1509 } 1510 1511 /** 1512 * Gets the supported antibanding values. 1513 * 1514 * @return a list of supported antibanding values. null if antibanding 1515 * setting is not supported. 1516 * @see #getAntibanding() 1517 */ 1518 public List<String> getSupportedAntibanding() { 1519 String str = get(KEY_ANTIBANDING + SUPPORTED_VALUES_SUFFIX); 1520 return split(str); 1521 } 1522 1523 /** 1524 * Gets the current scene mode setting. 1525 * 1526 * @return one of SCENE_MODE_XXX string constant. null if scene mode 1527 * setting is not supported. 1528 * @see #SCENE_MODE_AUTO 1529 * @see #SCENE_MODE_ACTION 1530 * @see #SCENE_MODE_PORTRAIT 1531 * @see #SCENE_MODE_LANDSCAPE 1532 * @see #SCENE_MODE_NIGHT 1533 * @see #SCENE_MODE_NIGHT_PORTRAIT 1534 * @see #SCENE_MODE_THEATRE 1535 * @see #SCENE_MODE_BEACH 1536 * @see #SCENE_MODE_SNOW 1537 * @see #SCENE_MODE_SUNSET 1538 * @see #SCENE_MODE_STEADYPHOTO 1539 * @see #SCENE_MODE_FIREWORKS 1540 * @see #SCENE_MODE_SPORTS 1541 * @see #SCENE_MODE_PARTY 1542 * @see #SCENE_MODE_CANDLELIGHT 1543 */ 1544 public String getSceneMode() { 1545 return get(KEY_SCENE_MODE); 1546 } 1547 1548 /** 1549 * Sets the scene mode. Changing scene mode may override other 1550 * parameters (such as flash mode, focus mode, white balance). For 1551 * example, suppose originally flash mode is on and supported flash 1552 * modes are on/off. In night scene mode, both flash mode and supported 1553 * flash mode may be changed to off. After setting scene mode, 1554 * applications should call getParameters to know if some parameters are 1555 * changed. 1556 * 1557 * @param value scene mode. 1558 * @see #getSceneMode() 1559 */ 1560 public void setSceneMode(String value) { 1561 set(KEY_SCENE_MODE, value); 1562 } 1563 1564 /** 1565 * Gets the supported scene modes. 1566 * 1567 * @return a list of supported scene modes. null if scene mode setting 1568 * is not supported. 1569 * @see #getSceneMode() 1570 */ 1571 public List<String> getSupportedSceneModes() { 1572 String str = get(KEY_SCENE_MODE + SUPPORTED_VALUES_SUFFIX); 1573 return split(str); 1574 } 1575 1576 /** 1577 * Gets the current flash mode setting. 1578 * 1579 * @return current flash mode. null if flash mode setting is not 1580 * supported. 1581 * @see #FLASH_MODE_OFF 1582 * @see #FLASH_MODE_AUTO 1583 * @see #FLASH_MODE_ON 1584 * @see #FLASH_MODE_RED_EYE 1585 * @see #FLASH_MODE_TORCH 1586 */ 1587 public String getFlashMode() { 1588 return get(KEY_FLASH_MODE); 1589 } 1590 1591 /** 1592 * Sets the flash mode. 1593 * 1594 * @param value flash mode. 1595 * @see #getFlashMode() 1596 */ 1597 public void setFlashMode(String value) { 1598 set(KEY_FLASH_MODE, value); 1599 } 1600 1601 /** 1602 * Gets the supported flash modes. 1603 * 1604 * @return a list of supported flash modes. null if flash mode setting 1605 * is not supported. 1606 * @see #getFlashMode() 1607 */ 1608 public List<String> getSupportedFlashModes() { 1609 String str = get(KEY_FLASH_MODE + SUPPORTED_VALUES_SUFFIX); 1610 return split(str); 1611 } 1612 1613 /** 1614 * Gets the current focus mode setting. 1615 * 1616 * @return current focus mode. If the camera does not support 1617 * auto-focus, this should return {@link #FOCUS_MODE_FIXED}. If 1618 * the focus mode is not FOCUS_MODE_FIXED or {@link 1619 * #FOCUS_MODE_INFINITY}, applications should call {@link 1620 * #autoFocus(AutoFocusCallback)} to start the focus. 1621 * @see #FOCUS_MODE_AUTO 1622 * @see #FOCUS_MODE_INFINITY 1623 * @see #FOCUS_MODE_MACRO 1624 * @see #FOCUS_MODE_FIXED 1625 */ 1626 public String getFocusMode() { 1627 return get(KEY_FOCUS_MODE); 1628 } 1629 1630 /** 1631 * Sets the focus mode. 1632 * 1633 * @param value focus mode. 1634 * @see #getFocusMode() 1635 */ 1636 public void setFocusMode(String value) { 1637 set(KEY_FOCUS_MODE, value); 1638 } 1639 1640 /** 1641 * Gets the supported focus modes. 1642 * 1643 * @return a list of supported focus modes. This method will always 1644 * return a list with at least one element. 1645 * @see #getFocusMode() 1646 */ 1647 public List<String> getSupportedFocusModes() { 1648 String str = get(KEY_FOCUS_MODE + SUPPORTED_VALUES_SUFFIX); 1649 return split(str); 1650 } 1651 1652 /** 1653 * Gets the focal length (in millimeter) of the camera. 1654 * 1655 * @return the focal length. This method will always return a valid 1656 * value. 1657 */ 1658 public float getFocalLength() { 1659 return Float.parseFloat(get(KEY_FOCAL_LENGTH)); 1660 } 1661 1662 /** 1663 * Gets the horizontal angle of view in degrees. 1664 * 1665 * @return horizontal angle of view. This method will always return a 1666 * valid value. 1667 */ 1668 public float getHorizontalViewAngle() { 1669 return Float.parseFloat(get(KEY_HORIZONTAL_VIEW_ANGLE)); 1670 } 1671 1672 /** 1673 * Gets the vertical angle of view in degrees. 1674 * 1675 * @return vertical angle of view. This method will always return a 1676 * valid value. 1677 */ 1678 public float getVerticalViewAngle() { 1679 return Float.parseFloat(get(KEY_VERTICAL_VIEW_ANGLE)); 1680 } 1681 1682 /** 1683 * Gets the current exposure compensation index. 1684 * 1685 * @return current exposure compensation index. The range is {@link 1686 * #getMinExposureCompensation} to {@link 1687 * #getMaxExposureCompensation}. 0 means exposure is not 1688 * adjusted. 1689 */ 1690 public int getExposureCompensation() { 1691 return getInt(KEY_EXPOSURE_COMPENSATION, 0); 1692 } 1693 1694 /** 1695 * Sets the exposure compensation index. 1696 * 1697 * @param value exposure compensation index. The valid value range is 1698 * from {@link #getMinExposureCompensation} (inclusive) to {@link 1699 * #getMaxExposureCompensation} (inclusive). 0 means exposure is 1700 * not adjusted. Application should call 1701 * getMinExposureCompensation and getMaxExposureCompensation to 1702 * know if exposure compensation is supported. 1703 */ 1704 public void setExposureCompensation(int value) { 1705 set(KEY_EXPOSURE_COMPENSATION, value); 1706 } 1707 1708 /** 1709 * Gets the maximum exposure compensation index. 1710 * 1711 * @return maximum exposure compensation index (>=0). If both this 1712 * method and {@link #getMinExposureCompensation} return 0, 1713 * exposure compensation is not supported. 1714 */ 1715 public int getMaxExposureCompensation() { 1716 return getInt(KEY_MAX_EXPOSURE_COMPENSATION, 0); 1717 } 1718 1719 /** 1720 * Gets the minimum exposure compensation index. 1721 * 1722 * @return minimum exposure compensation index (<=0). If both this 1723 * method and {@link #getMaxExposureCompensation} return 0, 1724 * exposure compensation is not supported. 1725 */ 1726 public int getMinExposureCompensation() { 1727 return getInt(KEY_MIN_EXPOSURE_COMPENSATION, 0); 1728 } 1729 1730 /** 1731 * Gets the exposure compensation step. 1732 * 1733 * @return exposure compensation step. Applications can get EV by 1734 * multiplying the exposure compensation index and step. Ex: if 1735 * exposure compensation index is -6 and step is 0.333333333, EV 1736 * is -2. 1737 */ 1738 public float getExposureCompensationStep() { 1739 return getFloat(KEY_EXPOSURE_COMPENSATION_STEP, 0); 1740 } 1741 1742 /** 1743 * Gets current zoom value. This also works when smooth zoom is in 1744 * progress. Applications should check {@link #isZoomSupported} before 1745 * using this method. 1746 * 1747 * @return the current zoom value. The range is 0 to {@link 1748 * #getMaxZoom}. 0 means the camera is not zoomed. 1749 */ 1750 public int getZoom() { 1751 return getInt(KEY_ZOOM, 0); 1752 } 1753 1754 /** 1755 * Sets current zoom value. If the camera is zoomed (value > 0), the 1756 * actual picture size may be smaller than picture size setting. 1757 * Applications can check the actual picture size after picture is 1758 * returned from {@link PictureCallback}. The preview size remains the 1759 * same in zoom. Applications should check {@link #isZoomSupported} 1760 * before using this method. 1761 * 1762 * @param value zoom value. The valid range is 0 to {@link #getMaxZoom}. 1763 */ 1764 public void setZoom(int value) { 1765 set(KEY_ZOOM, value); 1766 } 1767 1768 /** 1769 * Returns true if zoom is supported. Applications should call this 1770 * before using other zoom methods. 1771 * 1772 * @return true if zoom is supported. 1773 */ 1774 public boolean isZoomSupported() { 1775 String str = get(KEY_ZOOM_SUPPORTED); 1776 return TRUE.equals(str); 1777 } 1778 1779 /** 1780 * Gets the maximum zoom value allowed for snapshot. This is the maximum 1781 * value that applications can set to {@link #setZoom(int)}. 1782 * Applications should call {@link #isZoomSupported} before using this 1783 * method. This value may change in different preview size. Applications 1784 * should call this again after setting preview size. 1785 * 1786 * @return the maximum zoom value supported by the camera. 1787 */ 1788 public int getMaxZoom() { 1789 return getInt(KEY_MAX_ZOOM, 0); 1790 } 1791 1792 /** 1793 * Gets the zoom ratios of all zoom values. Applications should check 1794 * {@link #isZoomSupported} before using this method. 1795 * 1796 * @return the zoom ratios in 1/100 increments. Ex: a zoom of 3.2x is 1797 * returned as 320. The number of elements is {@link 1798 * #getMaxZoom} + 1. The list is sorted from small to large. The 1799 * first element is always 100. The last element is the zoom 1800 * ratio of the maximum zoom value. 1801 */ 1802 public List<Integer> getZoomRatios() { 1803 return splitInt(get(KEY_ZOOM_RATIOS)); 1804 } 1805 1806 /** 1807 * Returns true if smooth zoom is supported. Applications should call 1808 * this before using other smooth zoom methods. 1809 * 1810 * @return true if smooth zoom is supported. 1811 */ 1812 public boolean isSmoothZoomSupported() { 1813 String str = get(KEY_SMOOTH_ZOOM_SUPPORTED); 1814 return TRUE.equals(str); 1815 } 1816 1817 // Splits a comma delimited string to an ArrayList of String. 1818 // Return null if the passing string is null or the size is 0. 1819 private ArrayList<String> split(String str) { 1820 if (str == null) return null; 1821 1822 // Use StringTokenizer because it is faster than split. 1823 StringTokenizer tokenizer = new StringTokenizer(str, ","); 1824 ArrayList<String> substrings = new ArrayList<String>(); 1825 while (tokenizer.hasMoreElements()) { 1826 substrings.add(tokenizer.nextToken()); 1827 } 1828 return substrings; 1829 } 1830 1831 // Splits a comma delimited string to an ArrayList of Integer. 1832 // Return null if the passing string is null or the size is 0. 1833 private ArrayList<Integer> splitInt(String str) { 1834 if (str == null) return null; 1835 1836 StringTokenizer tokenizer = new StringTokenizer(str, ","); 1837 ArrayList<Integer> substrings = new ArrayList<Integer>(); 1838 while (tokenizer.hasMoreElements()) { 1839 String token = tokenizer.nextToken(); 1840 substrings.add(Integer.parseInt(token)); 1841 } 1842 if (substrings.size() == 0) return null; 1843 return substrings; 1844 } 1845 1846 // Returns the value of a float parameter. 1847 private float getFloat(String key, float defaultValue) { 1848 try { 1849 return Float.parseFloat(mMap.get(key)); 1850 } catch (NumberFormatException ex) { 1851 return defaultValue; 1852 } 1853 } 1854 1855 // Returns the value of a integer parameter. 1856 private int getInt(String key, int defaultValue) { 1857 try { 1858 return Integer.parseInt(mMap.get(key)); 1859 } catch (NumberFormatException ex) { 1860 return defaultValue; 1861 } 1862 } 1863 1864 // Splits a comma delimited string to an ArrayList of Size. 1865 // Return null if the passing string is null or the size is 0. 1866 private ArrayList<Size> splitSize(String str) { 1867 if (str == null) return null; 1868 1869 StringTokenizer tokenizer = new StringTokenizer(str, ","); 1870 ArrayList<Size> sizeList = new ArrayList<Size>(); 1871 while (tokenizer.hasMoreElements()) { 1872 Size size = strToSize(tokenizer.nextToken()); 1873 if (size != null) sizeList.add(size); 1874 } 1875 if (sizeList.size() == 0) return null; 1876 return sizeList; 1877 } 1878 1879 // Parses a string (ex: "480x320") to Size object. 1880 // Return null if the passing string is null. 1881 private Size strToSize(String str) { 1882 if (str == null) return null; 1883 1884 int pos = str.indexOf('x'); 1885 if (pos != -1) { 1886 String width = str.substring(0, pos); 1887 String height = str.substring(pos + 1); 1888 return new Size(Integer.parseInt(width), 1889 Integer.parseInt(height)); 1890 } 1891 Log.e(TAG, "Invalid size parameter string=" + str); 1892 return null; 1893 } 1894 }; 1895} 1896