Camera.java revision 36f68b8f24df906c969581b0b8e1a47f95dc03cb
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.PixelFormat; 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 ZoomCallback mZoomCallback; 82 private ErrorCallback mErrorCallback; 83 private boolean mOneShot; 84 85 /** 86 * Returns a new Camera object. 87 */ 88 public static Camera open() { 89 return new Camera(); 90 } 91 92 Camera() { 93 mShutterCallback = null; 94 mRawImageCallback = null; 95 mJpegCallback = null; 96 mPreviewCallback = null; 97 mPostviewCallback = null; 98 mZoomCallback = null; 99 100 Looper looper; 101 if ((looper = Looper.myLooper()) != null) { 102 mEventHandler = new EventHandler(this, looper); 103 } else if ((looper = Looper.getMainLooper()) != null) { 104 mEventHandler = new EventHandler(this, looper); 105 } else { 106 mEventHandler = null; 107 } 108 109 native_setup(new WeakReference<Camera>(this)); 110 } 111 112 protected void finalize() { 113 native_release(); 114 } 115 116 private native final void native_setup(Object camera_this); 117 private native final void native_release(); 118 119 120 /** 121 * Disconnects and releases the Camera object resources. 122 * <p>It is recommended that you call this as soon as you're done with the 123 * Camera object.</p> 124 */ 125 public final void release() { 126 native_release(); 127 } 128 129 /** 130 * Reconnect to the camera after passing it to MediaRecorder. To save 131 * setup/teardown time, a client of Camera can pass an initialized Camera 132 * object to a MediaRecorder to use for video recording. Once the 133 * MediaRecorder is done with the Camera, this method can be used to 134 * re-establish a connection with the camera hardware. NOTE: The Camera 135 * object must first be unlocked by the process that owns it before it 136 * can be connected to another process. 137 * 138 * @throws IOException if the method fails. 139 * 140 * @hide 141 */ 142 public native final void reconnect() throws IOException; 143 144 /** 145 * Lock the camera to prevent other processes from accessing it. To save 146 * setup/teardown time, a client of Camera can pass an initialized Camera 147 * object to another process. This method is used to re-lock the Camera 148 * object prevent other processes from accessing it. By default, the 149 * Camera object is locked. Locking it again from the same process will 150 * have no effect. Attempting to lock it from another process if it has 151 * not been unlocked will fail. 152 * 153 * @throws RuntimeException if the method fails. 154 */ 155 public native final void lock(); 156 157 /** 158 * Unlock the camera to allow another process to access it. To save 159 * setup/teardown time, a client of Camera can pass an initialized Camera 160 * object to another process. This method is used to unlock the Camera 161 * object before handing off the Camera object to the other process. 162 * 163 * @throws RuntimeException if the method fails. 164 */ 165 public native final void unlock(); 166 167 /** 168 * Sets the SurfaceHolder to be used for a picture preview. If the surface 169 * changed since the last call, the screen will blank. Nothing happens 170 * if the same surface is re-set. 171 * 172 * @param holder the SurfaceHolder upon which to place the picture preview 173 * @throws IOException if the method fails. 174 */ 175 public final void setPreviewDisplay(SurfaceHolder holder) throws IOException { 176 if (holder != null) { 177 setPreviewDisplay(holder.getSurface()); 178 } else { 179 setPreviewDisplay((Surface)null); 180 } 181 } 182 183 private native final void setPreviewDisplay(Surface surface); 184 185 /** 186 * Used to get a copy of each preview frame. 187 */ 188 public interface PreviewCallback 189 { 190 /** 191 * The callback that delivers the preview frames. 192 * 193 * @param data The contents of the preview frame in the format defined 194 * by {@link android.graphics.PixelFormat}, which can be queried 195 * with {@link android.hardware.Camera.Parameters#getPreviewFormat()}. 196 * If {@link android.hardware.Camera.Parameters#setPreviewFormat(int)} 197 * is never called, the default will be the YCbCr_420_SP 198 * (NV21) format. 199 * @param camera The Camera service object. 200 */ 201 void onPreviewFrame(byte[] data, Camera camera); 202 }; 203 204 /** 205 * Start drawing preview frames to the surface. 206 */ 207 public native final void startPreview(); 208 209 /** 210 * Stop drawing preview frames to the surface. 211 */ 212 public native final void stopPreview(); 213 214 /** 215 * Return current preview state. 216 * 217 * FIXME: Unhide before release 218 * @hide 219 */ 220 public native final boolean previewEnabled(); 221 222 /** 223 * Can be called at any time to instruct the camera to use a callback for 224 * each preview frame in addition to displaying it. 225 * 226 * @param cb A callback object that receives a copy of each preview frame. 227 * Pass null to stop receiving callbacks at any time. 228 */ 229 public final void setPreviewCallback(PreviewCallback cb) { 230 mPreviewCallback = cb; 231 mOneShot = false; 232 setHasPreviewCallback(cb != null, false); 233 } 234 235 /** 236 * Installs a callback to retrieve a single preview frame, after which the 237 * callback is cleared. 238 * 239 * @param cb A callback object that receives a copy of the preview frame. 240 */ 241 public final void setOneShotPreviewCallback(PreviewCallback cb) { 242 if (cb != null) { 243 mPreviewCallback = cb; 244 mOneShot = true; 245 setHasPreviewCallback(true, true); 246 } 247 } 248 249 private native final void setHasPreviewCallback(boolean installed, boolean oneshot); 250 251 private class EventHandler extends Handler 252 { 253 private Camera mCamera; 254 255 public EventHandler(Camera c, Looper looper) { 256 super(looper); 257 mCamera = c; 258 } 259 260 @Override 261 public void handleMessage(Message msg) { 262 switch(msg.what) { 263 case CAMERA_MSG_SHUTTER: 264 if (mShutterCallback != null) { 265 mShutterCallback.onShutter(); 266 } 267 return; 268 269 case CAMERA_MSG_RAW_IMAGE: 270 if (mRawImageCallback != null) { 271 mRawImageCallback.onPictureTaken((byte[])msg.obj, mCamera); 272 } 273 return; 274 275 case CAMERA_MSG_COMPRESSED_IMAGE: 276 if (mJpegCallback != null) { 277 mJpegCallback.onPictureTaken((byte[])msg.obj, mCamera); 278 } 279 return; 280 281 case CAMERA_MSG_PREVIEW_FRAME: 282 if (mPreviewCallback != null) { 283 mPreviewCallback.onPreviewFrame((byte[])msg.obj, mCamera); 284 if (mOneShot) { 285 mPreviewCallback = null; 286 } 287 } 288 return; 289 290 case CAMERA_MSG_POSTVIEW_FRAME: 291 if (mPostviewCallback != null) { 292 mPostviewCallback.onPictureTaken((byte[])msg.obj, mCamera); 293 } 294 return; 295 296 case CAMERA_MSG_FOCUS: 297 if (mAutoFocusCallback != null) { 298 mAutoFocusCallback.onAutoFocus(msg.arg1 == 0 ? false : true, mCamera); 299 } 300 return; 301 302 case CAMERA_MSG_ZOOM: 303 if (mZoomCallback != null) { 304 mZoomCallback.onZoomUpdate(msg.arg1, msg.arg2 != 0, mCamera); 305 } 306 return; 307 308 case CAMERA_MSG_ERROR : 309 Log.e(TAG, "Error " + msg.arg1); 310 if (mErrorCallback != null) { 311 mErrorCallback.onError(msg.arg1, mCamera); 312 } 313 return; 314 315 default: 316 Log.e(TAG, "Unknown message type " + msg.what); 317 return; 318 } 319 } 320 } 321 322 private static void postEventFromNative(Object camera_ref, 323 int what, int arg1, int arg2, Object obj) 324 { 325 Camera c = (Camera)((WeakReference)camera_ref).get(); 326 if (c == null) 327 return; 328 329 if (c.mEventHandler != null) { 330 Message m = c.mEventHandler.obtainMessage(what, arg1, arg2, obj); 331 c.mEventHandler.sendMessage(m); 332 } 333 } 334 335 /** 336 * Handles the callback for the camera auto focus. 337 * <p>Devices that do not support auto-focus will receive a "fake" 338 * callback to this interface. If your application needs auto-focus and 339 * should not be installed on devices <em>without</em> auto-focus, you must 340 * declare that your app uses the 341 * {@code android.hardware.camera.autofocus} feature, in the 342 * <a href="{@docRoot}guide/topics/manifest/uses-feature-element.html"><uses-feature></a> 343 * manifest element.</p> 344 */ 345 public interface AutoFocusCallback 346 { 347 /** 348 * Callback for the camera auto focus. If the camera does not support 349 * auto-focus and autoFocus is called, onAutoFocus will be called 350 * immediately with success. 351 * 352 * @param success true if focus was successful, false if otherwise 353 * @param camera the Camera service object 354 */ 355 void onAutoFocus(boolean success, Camera camera); 356 }; 357 358 /** 359 * Starts auto-focus function and registers a callback function to run when 360 * camera is focused. Only valid after startPreview() has been called. 361 * Applications should call {@link 362 * android.hardware.Camera.Parameters#getFocusMode()} to determine if this 363 * method should be called. If the camera does not support auto-focus, it is 364 * a no-op and {@link AutoFocusCallback#onAutoFocus(boolean, Camera)} 365 * callback will be called immediately. 366 * <p>If your application should not be installed 367 * on devices without auto-focus, you must declare that your application 368 * uses auto-focus with the 369 * <a href="{@docRoot}guide/topics/manifest/uses-feature-element.html"><uses-feature></a> 370 * manifest element.</p> 371 * <p>If the current flash mode is not 372 * {@link android.hardware.Camera.Parameters#FLASH_MODE_OFF}, flash may be 373 * fired during auto-focus depending on the driver.<p> 374 * 375 * @param cb the callback to run 376 */ 377 public final void autoFocus(AutoFocusCallback cb) 378 { 379 mAutoFocusCallback = cb; 380 native_autoFocus(); 381 } 382 private native final void native_autoFocus(); 383 384 /** 385 * Cancels auto-focus function. If the auto-focus is still in progress, 386 * this function will cancel it. Whether the auto-focus is in progress 387 * or not, this function will return the focus position to the default. 388 * If the camera does not support auto-focus, this is a no-op. 389 */ 390 public final void cancelAutoFocus() 391 { 392 mAutoFocusCallback = null; 393 native_cancelAutoFocus(); 394 } 395 private native final void native_cancelAutoFocus(); 396 397 /** 398 * An interface which contains a callback for the shutter closing after taking a picture. 399 */ 400 public interface ShutterCallback 401 { 402 /** 403 * Can be used to play a shutter sound as soon as the image has been captured, but before 404 * the data is available. 405 */ 406 void onShutter(); 407 } 408 409 /** 410 * Handles the callback for when a picture is taken. 411 */ 412 public interface PictureCallback { 413 /** 414 * Callback for when a picture is taken. 415 * 416 * @param data a byte array of the picture data 417 * @param camera the Camera service object 418 */ 419 void onPictureTaken(byte[] data, Camera camera); 420 }; 421 422 /** 423 * Triggers an asynchronous image capture. The camera service will initiate 424 * a series of callbacks to the application as the image capture progresses. 425 * The shutter callback occurs after the image is captured. This can be used 426 * to trigger a sound to let the user know that image has been captured. The 427 * raw callback occurs when the raw image data is available (NOTE: the data 428 * may be null if the hardware does not have enough memory to make a copy). 429 * The jpeg callback occurs when the compressed image is available. If the 430 * application does not need a particular callback, a null can be passed 431 * instead of a callback method. 432 * 433 * @param shutter callback after the image is captured, may be null 434 * @param raw callback with raw image data, may be null 435 * @param jpeg callback with jpeg image data, may be null 436 */ 437 public final void takePicture(ShutterCallback shutter, PictureCallback raw, 438 PictureCallback jpeg) { 439 takePicture(shutter, raw, null, jpeg); 440 } 441 private native final void native_takePicture(); 442 443 /** 444 * Triggers an asynchronous image capture. The camera service will initiate 445 * a series of callbacks to the application as the image capture progresses. 446 * The shutter callback occurs after the image is captured. This can be used 447 * to trigger a sound to let the user know that image has been captured. The 448 * raw callback occurs when the raw image data is available (NOTE: the data 449 * may be null if the hardware does not have enough memory to make a copy). 450 * The postview callback occurs when a scaled, fully processed postview 451 * image is available (NOTE: not all hardware supports this). The jpeg 452 * callback occurs when the compressed image is available. If the 453 * application does not need a particular callback, a null can be passed 454 * instead of a callback method. 455 * 456 * @param shutter callback after the image is captured, may be null 457 * @param raw callback with raw image data, may be null 458 * @param postview callback with postview image data, may be null 459 * @param jpeg callback with jpeg image data, may be null 460 */ 461 public final void takePicture(ShutterCallback shutter, PictureCallback raw, 462 PictureCallback postview, PictureCallback jpeg) { 463 mShutterCallback = shutter; 464 mRawImageCallback = raw; 465 mPostviewCallback = postview; 466 mJpegCallback = jpeg; 467 native_takePicture(); 468 } 469 470 /** 471 * Zooms to the requested value smoothly. Driver will generate {@link 472 * #ZoomCallback} for the current zoom value and whether zoom is stopped. 473 * The applications can call {@link #stopSmoothZoom} to stop the zoom 474 * earlier. The applications should not call startSmoothZoom again or {@link 475 * android.hardware.Camera.Parameters#setZoom(int)} before the zoom stops. 476 * 477 * @param value zoom value. The valid range is 0 to {@link 478 * android.hardware.Camera.Parameters#getMaxZoom}. 479 * @hide 480 */ 481 public native final void startSmoothZoom(int value); 482 483 /** 484 * Stops the smooth zoom. The applications should wait for the {@link 485 * #ZoomCallback} to know when the zoom is actually stopped. 486 * @hide 487 */ 488 public native final void stopSmoothZoom(); 489 490 /** 491 * Handles the zoom callback. 492 * 493 * @hide 494 */ 495 public interface ZoomCallback 496 { 497 /** 498 * Callback for zoom updates 499 * 500 * @param zoomValue the current zoom value. In smooth zoom mode, camera 501 * generates this callback for every new zoom value. 502 * @param stopped whether smooth zoom is stopped. If the value is true, 503 * this is the last zoom update for the application. 504 * 505 * @param camera the Camera service object 506 * @see android.hardware.Camera.Parameters#startSmoothZoom 507 */ 508 void onZoomUpdate(int zoomValue, boolean stopped, Camera camera); 509 }; 510 511 /** 512 * Registers a callback to be invoked when the zoom value is updated by the 513 * camera driver during smooth zoom. 514 * @param cb the callback to run 515 * @hide 516 */ 517 public final void setZoomCallback(ZoomCallback cb) 518 { 519 mZoomCallback = cb; 520 } 521 522 // These match the enum in include/ui/Camera.h 523 /** Unspecified camerar error. @see #ErrorCallback */ 524 public static final int CAMERA_ERROR_UNKNOWN = 1; 525 /** Media server died. In this case, the application must release the 526 * Camera object and instantiate a new one. @see #ErrorCallback */ 527 public static final int CAMERA_ERROR_SERVER_DIED = 100; 528 529 /** 530 * Handles the camera error callback. 531 */ 532 public interface ErrorCallback 533 { 534 /** 535 * Callback for camera errors. 536 * @param error error code: 537 * <ul> 538 * <li>{@link #CAMERA_ERROR_UNKNOWN} 539 * <li>{@link #CAMERA_ERROR_SERVER_DIED} 540 * </ul> 541 * @param camera the Camera service object 542 */ 543 void onError(int error, Camera camera); 544 }; 545 546 /** 547 * Registers a callback to be invoked when an error occurs. 548 * @param cb the callback to run 549 */ 550 public final void setErrorCallback(ErrorCallback cb) 551 { 552 mErrorCallback = cb; 553 } 554 555 private native final void native_setParameters(String params); 556 private native final String native_getParameters(); 557 558 /** 559 * Sets the Parameters for pictures from this Camera service. 560 * 561 * @param params the Parameters to use for this Camera service 562 */ 563 public void setParameters(Parameters params) { 564 native_setParameters(params.flatten()); 565 } 566 567 /** 568 * Returns the picture Parameters for this Camera service. 569 */ 570 public Parameters getParameters() { 571 Parameters p = new Parameters(); 572 String s = native_getParameters(); 573 p.unflatten(s); 574 return p; 575 } 576 577 /** 578 * Handles the picture size (dimensions). 579 */ 580 public class Size { 581 /** 582 * Sets the dimensions for pictures. 583 * 584 * @param w the photo width (pixels) 585 * @param h the photo height (pixels) 586 */ 587 public Size(int w, int h) { 588 width = w; 589 height = h; 590 } 591 /** width of the picture */ 592 public int width; 593 /** height of the picture */ 594 public int height; 595 }; 596 597 /** 598 * Handles the parameters for pictures created by a Camera service. 599 * 600 * <p>To make camera parameters take effect, applications have to call 601 * Camera.setParameters. For example, after setWhiteBalance is called, white 602 * balance is not changed until Camera.setParameters() is called. 603 * 604 * <p>Different devices may have different camera capabilities, such as 605 * picture size or flash modes. The application should query the camera 606 * capabilities before setting parameters. For example, the application 607 * should call getSupportedColorEffects before calling setEffect. If the 608 * camera does not support color effects, getSupportedColorEffects will 609 * return null. 610 */ 611 public class Parameters { 612 // Parameter keys to communicate with the camera driver. 613 private static final String KEY_PREVIEW_SIZE = "preview-size"; 614 private static final String KEY_PREVIEW_FORMAT = "preview-format"; 615 private static final String KEY_PREVIEW_FRAME_RATE = "preview-frame-rate"; 616 private static final String KEY_PICTURE_SIZE = "picture-size"; 617 private static final String KEY_PICTURE_FORMAT = "picture-format"; 618 private static final String KEY_JPEG_THUMBNAIL_WIDTH = "jpeg-thumbnail-width"; 619 private static final String KEY_JPEG_THUMBNAIL_HEIGHT = "jpeg-thumbnail-height"; 620 private static final String KEY_JPEG_THUMBNAIL_QUALITY = "jpeg-thumbnail-quality"; 621 private static final String KEY_JPEG_QUALITY = "jpeg-quality"; 622 private static final String KEY_ROTATION = "rotation"; 623 private static final String KEY_GPS_LATITUDE = "gps-latitude"; 624 private static final String KEY_GPS_LONGITUDE = "gps-longitude"; 625 private static final String KEY_GPS_ALTITUDE = "gps-altitude"; 626 private static final String KEY_GPS_TIMESTAMP = "gps-timestamp"; 627 private static final String KEY_WHITE_BALANCE = "whitebalance"; 628 private static final String KEY_EFFECT = "effect"; 629 private static final String KEY_ANTIBANDING = "antibanding"; 630 private static final String KEY_SCENE_MODE = "scene-mode"; 631 private static final String KEY_FLASH_MODE = "flash-mode"; 632 private static final String KEY_FOCUS_MODE = "focus-mode"; 633 // Parameter key suffix for supported values. 634 private static final String SUPPORTED_VALUES_SUFFIX = "-values"; 635 636 // Values for white balance settings. 637 public static final String WHITE_BALANCE_AUTO = "auto"; 638 public static final String WHITE_BALANCE_INCANDESCENT = "incandescent"; 639 public static final String WHITE_BALANCE_FLUORESCENT = "fluorescent"; 640 public static final String WHITE_BALANCE_WARM_FLUORESCENT = "warm-fluorescent"; 641 public static final String WHITE_BALANCE_DAYLIGHT = "daylight"; 642 public static final String WHITE_BALANCE_CLOUDY_DAYLIGHT = "cloudy-daylight"; 643 public static final String WHITE_BALANCE_TWILIGHT = "twilight"; 644 public static final String WHITE_BALANCE_SHADE = "shade"; 645 646 // Values for color effect settings. 647 public static final String EFFECT_NONE = "none"; 648 public static final String EFFECT_MONO = "mono"; 649 public static final String EFFECT_NEGATIVE = "negative"; 650 public static final String EFFECT_SOLARIZE = "solarize"; 651 public static final String EFFECT_SEPIA = "sepia"; 652 public static final String EFFECT_POSTERIZE = "posterize"; 653 public static final String EFFECT_WHITEBOARD = "whiteboard"; 654 public static final String EFFECT_BLACKBOARD = "blackboard"; 655 public static final String EFFECT_AQUA = "aqua"; 656 657 // Values for antibanding settings. 658 public static final String ANTIBANDING_AUTO = "auto"; 659 public static final String ANTIBANDING_50HZ = "50hz"; 660 public static final String ANTIBANDING_60HZ = "60hz"; 661 public static final String ANTIBANDING_OFF = "off"; 662 663 // Values for flash mode settings. 664 /** 665 * Flash will not be fired. 666 */ 667 public static final String FLASH_MODE_OFF = "off"; 668 669 /** 670 * Flash will be fired automatically when required. The flash may be fired 671 * during preview, auto-focus, or snapshot depending on the driver. 672 */ 673 public static final String FLASH_MODE_AUTO = "auto"; 674 675 /** 676 * Flash will always be fired during snapshot. The flash may also be 677 * fired during preview or auto-focus depending on the driver. 678 */ 679 public static final String FLASH_MODE_ON = "on"; 680 681 /** 682 * Flash will be fired in red-eye reduction mode. 683 */ 684 public static final String FLASH_MODE_RED_EYE = "red-eye"; 685 686 /** 687 * Constant emission of light during preview, auto-focus and snapshot. 688 * This can also be used for video recording. 689 */ 690 public static final String FLASH_MODE_TORCH = "torch"; 691 692 // Values for scene mode settings. 693 public static final String SCENE_MODE_AUTO = "auto"; 694 public static final String SCENE_MODE_ACTION = "action"; 695 public static final String SCENE_MODE_PORTRAIT = "portrait"; 696 public static final String SCENE_MODE_LANDSCAPE = "landscape"; 697 public static final String SCENE_MODE_NIGHT = "night"; 698 public static final String SCENE_MODE_NIGHT_PORTRAIT = "night-portrait"; 699 public static final String SCENE_MODE_THEATRE = "theatre"; 700 public static final String SCENE_MODE_BEACH = "beach"; 701 public static final String SCENE_MODE_SNOW = "snow"; 702 public static final String SCENE_MODE_SUNSET = "sunset"; 703 public static final String SCENE_MODE_STEADYPHOTO = "steadyphoto"; 704 public static final String SCENE_MODE_FIREWORKS = "fireworks"; 705 public static final String SCENE_MODE_SPORTS = "sports"; 706 public static final String SCENE_MODE_PARTY = "party"; 707 public static final String SCENE_MODE_CANDLELIGHT = "candlelight"; 708 709 // Values for focus mode settings. 710 /** 711 * Auto-focus mode. 712 */ 713 public static final String FOCUS_MODE_AUTO = "auto"; 714 715 /** 716 * Focus is set at infinity. Applications should not call 717 * {@link #autoFocus(AutoFocusCallback)} in this mode. 718 */ 719 public static final String FOCUS_MODE_INFINITY = "infinity"; 720 public static final String FOCUS_MODE_MACRO = "macro"; 721 722 /** 723 * Focus is fixed. The camera is always in this mode if the focus is not 724 * adjustable. If the camera has auto-focus, this mode can fix the 725 * focus, which is usually at hyperfocal distance. Applications should 726 * not call {@link #autoFocus(AutoFocusCallback)} in this mode. 727 */ 728 public static final String FOCUS_MODE_FIXED = "fixed"; 729 730 // Formats for setPreviewFormat and setPictureFormat. 731 private static final String PIXEL_FORMAT_YUV422SP = "yuv422sp"; 732 private static final String PIXEL_FORMAT_YUV420SP = "yuv420sp"; 733 private static final String PIXEL_FORMAT_YUV422I = "yuv422i-yuyv"; 734 private static final String PIXEL_FORMAT_RGB565 = "rgb565"; 735 private static final String PIXEL_FORMAT_JPEG = "jpeg"; 736 737 private HashMap<String, String> mMap; 738 739 private Parameters() { 740 mMap = new HashMap<String, String>(); 741 } 742 743 /** 744 * Writes the current Parameters to the log. 745 * @hide 746 * @deprecated 747 */ 748 public void dump() { 749 Log.e(TAG, "dump: size=" + mMap.size()); 750 for (String k : mMap.keySet()) { 751 Log.e(TAG, "dump: " + k + "=" + mMap.get(k)); 752 } 753 } 754 755 /** 756 * Creates a single string with all the parameters set in 757 * this Parameters object. 758 * <p>The {@link #unflatten(String)} method does the reverse.</p> 759 * 760 * @return a String with all values from this Parameters object, in 761 * semi-colon delimited key-value pairs 762 */ 763 public String flatten() { 764 StringBuilder flattened = new StringBuilder(); 765 for (String k : mMap.keySet()) { 766 flattened.append(k); 767 flattened.append("="); 768 flattened.append(mMap.get(k)); 769 flattened.append(";"); 770 } 771 // chop off the extra semicolon at the end 772 flattened.deleteCharAt(flattened.length()-1); 773 return flattened.toString(); 774 } 775 776 /** 777 * Takes a flattened string of parameters and adds each one to 778 * this Parameters object. 779 * <p>The {@link #flatten()} method does the reverse.</p> 780 * 781 * @param flattened a String of parameters (key-value paired) that 782 * are semi-colon delimited 783 */ 784 public void unflatten(String flattened) { 785 mMap.clear(); 786 787 StringTokenizer tokenizer = new StringTokenizer(flattened, ";"); 788 while (tokenizer.hasMoreElements()) { 789 String kv = tokenizer.nextToken(); 790 int pos = kv.indexOf('='); 791 if (pos == -1) { 792 continue; 793 } 794 String k = kv.substring(0, pos); 795 String v = kv.substring(pos + 1); 796 mMap.put(k, v); 797 } 798 } 799 800 public void remove(String key) { 801 mMap.remove(key); 802 } 803 804 /** 805 * Sets a String parameter. 806 * 807 * @param key the key name for the parameter 808 * @param value the String value of the parameter 809 */ 810 public void set(String key, String value) { 811 if (key.indexOf('=') != -1 || key.indexOf(';') != -1) { 812 Log.e(TAG, "Key \"" + key + "\" contains invalid character (= or ;)"); 813 return; 814 } 815 if (value.indexOf('=') != -1 || value.indexOf(';') != -1) { 816 Log.e(TAG, "Value \"" + value + "\" contains invalid character (= or ;)"); 817 return; 818 } 819 820 mMap.put(key, value); 821 } 822 823 /** 824 * Sets an integer parameter. 825 * 826 * @param key the key name for the parameter 827 * @param value the int value of the parameter 828 */ 829 public void set(String key, int value) { 830 mMap.put(key, Integer.toString(value)); 831 } 832 833 /** 834 * Returns the value of a String parameter. 835 * 836 * @param key the key name for the parameter 837 * @return the String value of the parameter 838 */ 839 public String get(String key) { 840 return mMap.get(key); 841 } 842 843 /** 844 * Returns the value of an integer parameter. 845 * 846 * @param key the key name for the parameter 847 * @return the int value of the parameter 848 */ 849 public int getInt(String key) { 850 return Integer.parseInt(mMap.get(key)); 851 } 852 853 /** 854 * Sets the dimensions for preview pictures. 855 * 856 * @param width the width of the pictures, in pixels 857 * @param height the height of the pictures, in pixels 858 */ 859 public void setPreviewSize(int width, int height) { 860 String v = Integer.toString(width) + "x" + Integer.toString(height); 861 set(KEY_PREVIEW_SIZE, v); 862 } 863 864 /** 865 * Returns the dimensions setting for preview pictures. 866 * 867 * @return a Size object with the height and width setting 868 * for the preview picture 869 */ 870 public Size getPreviewSize() { 871 String pair = get(KEY_PREVIEW_SIZE); 872 return strToSize(pair); 873 } 874 875 /** 876 * Gets the supported preview sizes. 877 * 878 * @return a List of Size object. null if preview size setting is not 879 * supported. 880 */ 881 public List<Size> getSupportedPreviewSizes() { 882 String str = get(KEY_PREVIEW_SIZE + SUPPORTED_VALUES_SUFFIX); 883 return splitSize(str); 884 } 885 886 /** 887 * Sets the dimensions for EXIF thumbnail in Jpeg picture. 888 * 889 * @param width the width of the thumbnail, in pixels 890 * @param height the height of the thumbnail, in pixels 891 */ 892 public void setJpegThumbnailSize(int width, int height) { 893 set(KEY_JPEG_THUMBNAIL_WIDTH, width); 894 set(KEY_JPEG_THUMBNAIL_HEIGHT, height); 895 } 896 897 /** 898 * Returns the dimensions for EXIF thumbnail in Jpeg picture. 899 * 900 * @return a Size object with the height and width setting for the EXIF 901 * thumbnails 902 */ 903 public Size getJpegThumbnailSize() { 904 return new Size(getInt(KEY_JPEG_THUMBNAIL_WIDTH), 905 getInt(KEY_JPEG_THUMBNAIL_HEIGHT)); 906 } 907 908 /** 909 * Sets the quality of the EXIF thumbnail in Jpeg picture. 910 * 911 * @param quality the JPEG quality of the EXIF thumbnail. The range is 1 912 * to 100, with 100 being the best. 913 */ 914 public void setJpegThumbnailQuality(int quality) { 915 set(KEY_JPEG_THUMBNAIL_QUALITY, quality); 916 } 917 918 /** 919 * Returns the quality setting for the EXIF thumbnail in Jpeg picture. 920 * 921 * @return the JPEG quality setting of the EXIF thumbnail. 922 */ 923 public int getJpegThumbnailQuality() { 924 return getInt(KEY_JPEG_THUMBNAIL_QUALITY); 925 } 926 927 /** 928 * Sets Jpeg quality of captured picture. 929 * 930 * @param quality the JPEG quality of captured picture. The range is 1 931 * to 100, with 100 being the best. 932 */ 933 public void setJpegQuality(int quality) { 934 set(KEY_JPEG_QUALITY, quality); 935 } 936 937 /** 938 * Returns the quality setting for the JPEG picture. 939 * 940 * @return the JPEG picture quality setting. 941 */ 942 public int getJpegQuality() { 943 return getInt(KEY_JPEG_QUALITY); 944 } 945 946 /** 947 * Sets the rate at which preview frames are received. 948 * 949 * @param fps the frame rate (frames per second) 950 */ 951 public void setPreviewFrameRate(int fps) { 952 set(KEY_PREVIEW_FRAME_RATE, fps); 953 } 954 955 /** 956 * Returns the setting for the rate at which preview frames 957 * are received. 958 * 959 * @return the frame rate setting (frames per second) 960 */ 961 public int getPreviewFrameRate() { 962 return getInt(KEY_PREVIEW_FRAME_RATE); 963 } 964 965 /** 966 * Gets the supported preview frame rates. 967 * 968 * @return a List of Integer objects (preview frame rates). null if 969 * preview frame rate setting is not supported. 970 */ 971 public List<Integer> getSupportedPreviewFrameRates() { 972 String str = get(KEY_PREVIEW_FRAME_RATE + SUPPORTED_VALUES_SUFFIX); 973 return splitInt(str); 974 } 975 976 /** 977 * Sets the image format for preview pictures. 978 * <p>If this is never called, the default format will be 979 * {@link android.graphics.PixelFormat#YCbCr_420_SP}, which 980 * uses the NV21 encoding format.</p> 981 * 982 * @param pixel_format the desired preview picture format, defined 983 * by one of the {@link android.graphics.PixelFormat} constants. 984 * (E.g., <var>PixelFormat.YCbCr_420_SP</var> (default), 985 * <var>PixelFormat.RGB_565</var>, or 986 * <var>PixelFormat.JPEG</var>) 987 * @see android.graphics.PixelFormat 988 */ 989 public void setPreviewFormat(int pixel_format) { 990 String s = cameraFormatForPixelFormat(pixel_format); 991 if (s == null) { 992 throw new IllegalArgumentException( 993 "Invalid pixel_format=" + pixel_format); 994 } 995 996 set(KEY_PREVIEW_FORMAT, s); 997 } 998 999 /** 1000 * Returns the image format for preview pictures got from 1001 * {@link PreviewCallback}. 1002 * 1003 * @return the {@link android.graphics.PixelFormat} int representing 1004 * the preview picture format. 1005 */ 1006 public int getPreviewFormat() { 1007 return pixelFormatForCameraFormat(get(KEY_PREVIEW_FORMAT)); 1008 } 1009 1010 /** 1011 * Gets the supported preview formats. 1012 * 1013 * @return a List of Integer objects. null if preview format setting is 1014 * not supported. 1015 */ 1016 public List<Integer> getSupportedPreviewFormats() { 1017 String str = get(KEY_PREVIEW_FORMAT + SUPPORTED_VALUES_SUFFIX); 1018 ArrayList<Integer> formats = new ArrayList<Integer>(); 1019 for (String s : split(str)) { 1020 int f = pixelFormatForCameraFormat(s); 1021 if (f == PixelFormat.UNKNOWN) continue; 1022 formats.add(f); 1023 } 1024 return formats; 1025 } 1026 1027 /** 1028 * Sets the dimensions for pictures. 1029 * 1030 * @param width the width for pictures, in pixels 1031 * @param height the height for pictures, in pixels 1032 */ 1033 public void setPictureSize(int width, int height) { 1034 String v = Integer.toString(width) + "x" + Integer.toString(height); 1035 set(KEY_PICTURE_SIZE, v); 1036 } 1037 1038 /** 1039 * Returns the dimension setting for pictures. 1040 * 1041 * @return a Size object with the height and width setting 1042 * for pictures 1043 */ 1044 public Size getPictureSize() { 1045 String pair = get(KEY_PICTURE_SIZE); 1046 return strToSize(pair); 1047 } 1048 1049 /** 1050 * Gets the supported picture sizes. 1051 * 1052 * @return a List of Size objects. null if picture size setting is not 1053 * supported. 1054 */ 1055 public List<Size> getSupportedPictureSizes() { 1056 String str = get(KEY_PICTURE_SIZE + SUPPORTED_VALUES_SUFFIX); 1057 return splitSize(str); 1058 } 1059 1060 /** 1061 * Sets the image format for pictures. 1062 * 1063 * @param pixel_format the desired picture format 1064 * (<var>PixelFormat.YCbCr_420_SP (NV21)</var>, 1065 * <var>PixelFormat.RGB_565</var>, or 1066 * <var>PixelFormat.JPEG</var>) 1067 * @see android.graphics.PixelFormat 1068 */ 1069 public void setPictureFormat(int pixel_format) { 1070 String s = cameraFormatForPixelFormat(pixel_format); 1071 if (s == null) { 1072 throw new IllegalArgumentException( 1073 "Invalid pixel_format=" + pixel_format); 1074 } 1075 1076 set(KEY_PICTURE_FORMAT, s); 1077 } 1078 1079 /** 1080 * Returns the image format for pictures. 1081 * 1082 * @return the PixelFormat int representing the picture format 1083 */ 1084 public int getPictureFormat() { 1085 return pixelFormatForCameraFormat(get(KEY_PICTURE_FORMAT)); 1086 } 1087 1088 /** 1089 * Gets the supported picture formats. 1090 * 1091 * @return a List of Integer objects (values are PixelFormat.XXX). null 1092 * if picture setting is not supported. 1093 */ 1094 public List<Integer> getSupportedPictureFormats() { 1095 String str = get(KEY_PICTURE_SIZE + SUPPORTED_VALUES_SUFFIX); 1096 return splitInt(str); 1097 } 1098 1099 private String cameraFormatForPixelFormat(int pixel_format) { 1100 switch(pixel_format) { 1101 case PixelFormat.YCbCr_422_SP: return PIXEL_FORMAT_YUV422SP; 1102 case PixelFormat.YCbCr_420_SP: return PIXEL_FORMAT_YUV420SP; 1103 case PixelFormat.YCbCr_422_I: return PIXEL_FORMAT_YUV422I; 1104 case PixelFormat.RGB_565: return PIXEL_FORMAT_RGB565; 1105 case PixelFormat.JPEG: return PIXEL_FORMAT_JPEG; 1106 default: return null; 1107 } 1108 } 1109 1110 private int pixelFormatForCameraFormat(String format) { 1111 if (format == null) 1112 return PixelFormat.UNKNOWN; 1113 1114 if (format.equals(PIXEL_FORMAT_YUV422SP)) 1115 return PixelFormat.YCbCr_422_SP; 1116 1117 if (format.equals(PIXEL_FORMAT_YUV420SP)) 1118 return PixelFormat.YCbCr_420_SP; 1119 1120 if (format.equals(PIXEL_FORMAT_YUV422I)) 1121 return PixelFormat.YCbCr_422_I; 1122 1123 if (format.equals(PIXEL_FORMAT_RGB565)) 1124 return PixelFormat.RGB_565; 1125 1126 if (format.equals(PIXEL_FORMAT_JPEG)) 1127 return PixelFormat.JPEG; 1128 1129 return PixelFormat.UNKNOWN; 1130 } 1131 1132 /** 1133 * Sets the orientation of the device in degrees. For example, suppose 1134 * the natural position of the device is landscape. If the user takes a 1135 * picture in landscape mode in 2048x1536 resolution, the rotation 1136 * should be set to 0. If the user rotates the phone 90 degrees 1137 * clockwise, the rotation should be set to 90. Applications can use 1138 * {@link android.view.OrientationEventListener} to set this parameter. 1139 * 1140 * The camera driver may set orientation in the EXIF header without 1141 * rotating the picture. Or the driver may rotate the picture and 1142 * the EXIF thumbnail. If the Jpeg picture is rotated, the orientation 1143 * in the EXIF header will be missing or 1 (row #0 is top and column #0 1144 * is left side). 1145 * 1146 * @param rotation The orientation of the device in degrees. Rotation 1147 * can only be 0, 90, 180 or 270. 1148 * @throws IllegalArgumentException if rotation value is invalid. 1149 * @see android.view.OrientationEventListener 1150 */ 1151 public void setRotation(int rotation) { 1152 if (rotation == 0 || rotation == 90 || rotation == 180 1153 || rotation == 270) { 1154 set(KEY_ROTATION, Integer.toString(rotation)); 1155 } else { 1156 throw new IllegalArgumentException( 1157 "Invalid rotation=" + rotation); 1158 } 1159 } 1160 1161 /** 1162 * Sets GPS latitude coordinate. This will be stored in JPEG EXIF 1163 * header. 1164 * 1165 * @param latitude GPS latitude coordinate. 1166 */ 1167 public void setGpsLatitude(double latitude) { 1168 set(KEY_GPS_LATITUDE, Double.toString(latitude)); 1169 } 1170 1171 /** 1172 * Sets GPS longitude coordinate. This will be stored in JPEG EXIF 1173 * header. 1174 * 1175 * @param longitude GPS longitude coordinate. 1176 */ 1177 public void setGpsLongitude(double longitude) { 1178 set(KEY_GPS_LONGITUDE, Double.toString(longitude)); 1179 } 1180 1181 /** 1182 * Sets GPS altitude. This will be stored in JPEG EXIF header. 1183 * 1184 * @param altitude GPS altitude in meters. 1185 */ 1186 public void setGpsAltitude(double altitude) { 1187 set(KEY_GPS_ALTITUDE, Double.toString(altitude)); 1188 } 1189 1190 /** 1191 * Sets GPS timestamp. This will be stored in JPEG EXIF header. 1192 * 1193 * @param timestamp GPS timestamp (UTC in seconds since January 1, 1194 * 1970). 1195 */ 1196 public void setGpsTimestamp(long timestamp) { 1197 set(KEY_GPS_TIMESTAMP, Long.toString(timestamp)); 1198 } 1199 1200 /** 1201 * Removes GPS latitude, longitude, altitude, and timestamp from the 1202 * parameters. 1203 */ 1204 public void removeGpsData() { 1205 remove(KEY_GPS_LATITUDE); 1206 remove(KEY_GPS_LONGITUDE); 1207 remove(KEY_GPS_ALTITUDE); 1208 remove(KEY_GPS_TIMESTAMP); 1209 } 1210 1211 /** 1212 * Gets the current white balance setting. 1213 * 1214 * @return one of WHITE_BALANCE_XXX string constant. null if white 1215 * balance setting is not supported. 1216 */ 1217 public String getWhiteBalance() { 1218 return get(KEY_WHITE_BALANCE); 1219 } 1220 1221 /** 1222 * Sets the white balance. 1223 * 1224 * @param value WHITE_BALANCE_XXX string constant. 1225 */ 1226 public void setWhiteBalance(String value) { 1227 set(KEY_WHITE_BALANCE, value); 1228 } 1229 1230 /** 1231 * Gets the supported white balance. 1232 * 1233 * @return a List of WHITE_BALANCE_XXX string constants. null if white 1234 * balance setting is not supported. 1235 */ 1236 public List<String> getSupportedWhiteBalance() { 1237 String str = get(KEY_WHITE_BALANCE + SUPPORTED_VALUES_SUFFIX); 1238 return split(str); 1239 } 1240 1241 /** 1242 * Gets the current color effect setting. 1243 * 1244 * @return one of EFFECT_XXX string constant. null if color effect 1245 * setting is not supported. 1246 */ 1247 public String getColorEffect() { 1248 return get(KEY_EFFECT); 1249 } 1250 1251 /** 1252 * Sets the current color effect setting. 1253 * 1254 * @param value EFFECT_XXX string constants. 1255 */ 1256 public void setColorEffect(String value) { 1257 set(KEY_EFFECT, value); 1258 } 1259 1260 /** 1261 * Gets the supported color effects. 1262 * 1263 * @return a List of EFFECT_XXX string constants. null if color effect 1264 * setting is not supported. 1265 */ 1266 public List<String> getSupportedColorEffects() { 1267 String str = get(KEY_EFFECT + SUPPORTED_VALUES_SUFFIX); 1268 return split(str); 1269 } 1270 1271 1272 /** 1273 * Gets the current antibanding setting. 1274 * 1275 * @return one of ANTIBANDING_XXX string constant. null if antibanding 1276 * setting is not supported. 1277 */ 1278 public String getAntibanding() { 1279 return get(KEY_ANTIBANDING); 1280 } 1281 1282 /** 1283 * Sets the antibanding. 1284 * 1285 * @param antibanding ANTIBANDING_XXX string constant. 1286 */ 1287 public void setAntibanding(String antibanding) { 1288 set(KEY_ANTIBANDING, antibanding); 1289 } 1290 1291 /** 1292 * Gets the supported antibanding values. 1293 * 1294 * @return a List of ANTIBANDING_XXX string constants. null if 1295 * antibanding setting is not supported. 1296 */ 1297 public List<String> getSupportedAntibanding() { 1298 String str = get(KEY_ANTIBANDING + SUPPORTED_VALUES_SUFFIX); 1299 return split(str); 1300 } 1301 1302 /** 1303 * Gets the current scene mode setting. 1304 * 1305 * @return one of SCENE_MODE_XXX string constant. null if scene mode 1306 * setting is not supported. 1307 */ 1308 public String getSceneMode() { 1309 return get(KEY_SCENE_MODE); 1310 } 1311 1312 /** 1313 * Sets the scene mode. Other parameters may be changed after changing 1314 * scene mode. For example, flash and supported flash mode may be 1315 * changed to "off" in night scene mode. After setting scene mode, 1316 * applications should call getParameters to know if some parameters are 1317 * changed. 1318 * 1319 * @param value SCENE_MODE_XXX string constants. 1320 */ 1321 public void setSceneMode(String value) { 1322 set(KEY_SCENE_MODE, value); 1323 } 1324 1325 /** 1326 * Gets the supported scene modes. 1327 * 1328 * @return a List of SCENE_MODE_XXX string constant. null if scene mode 1329 * setting is not supported. 1330 */ 1331 public List<String> getSupportedSceneModes() { 1332 String str = get(KEY_SCENE_MODE + SUPPORTED_VALUES_SUFFIX); 1333 return split(str); 1334 } 1335 1336 /** 1337 * Gets the current flash mode setting. 1338 * 1339 * @return one of FLASH_MODE_XXX string constant. null if flash mode 1340 * setting is not supported. 1341 */ 1342 public String getFlashMode() { 1343 return get(KEY_FLASH_MODE); 1344 } 1345 1346 /** 1347 * Sets the flash mode. 1348 * 1349 * @param value FLASH_MODE_XXX string constants. 1350 */ 1351 public void setFlashMode(String value) { 1352 set(KEY_FLASH_MODE, value); 1353 } 1354 1355 /** 1356 * Gets the supported flash modes. 1357 * 1358 * @return a List of FLASH_MODE_XXX string constants. null if flash mode 1359 * setting is not supported. 1360 */ 1361 public List<String> getSupportedFlashModes() { 1362 String str = get(KEY_FLASH_MODE + SUPPORTED_VALUES_SUFFIX); 1363 return split(str); 1364 } 1365 1366 /** 1367 * Gets the current focus mode setting. 1368 * 1369 * @return one of FOCUS_MODE_XXX string constant. If the camera does not 1370 * support auto-focus, this should return {@link 1371 * #FOCUS_MODE_FIXED}. If the focus mode is not FOCUS_MODE_FIXED 1372 * or {@link #FOCUS_MODE_INFINITY}, applications should call 1373 * {@link #autoFocus(AutoFocusCallback)} to start the focus. 1374 */ 1375 public String getFocusMode() { 1376 return get(KEY_FOCUS_MODE); 1377 } 1378 1379 /** 1380 * Sets the focus mode. 1381 * 1382 * @param value FOCUS_MODE_XXX string constants. 1383 */ 1384 public void setFocusMode(String value) { 1385 set(KEY_FOCUS_MODE, value); 1386 } 1387 1388 /** 1389 * Gets the supported focus modes. 1390 * 1391 * @return a List of FOCUS_MODE_XXX string constants. null if focus mode 1392 * setting is not supported. 1393 */ 1394 public List<String> getSupportedFocusModes() { 1395 String str = get(KEY_FOCUS_MODE + SUPPORTED_VALUES_SUFFIX); 1396 return split(str); 1397 } 1398 1399 /** 1400 * Gets current zoom value. This also works when smooth zoom is in 1401 * progress. 1402 * 1403 * @return the current zoom value. The range is 0 to {@link 1404 * #getMaxZoom}. 1405 * @hide 1406 */ 1407 public int getZoom() { 1408 return getInt("zoom"); 1409 } 1410 1411 /** 1412 * Sets current zoom value. If {@link #startSmoothZoom(int)} has been 1413 * called and zoom is not stopped yet, applications should not call this 1414 * method. 1415 * 1416 * @param value zoom value. The valid range is 0 to {@link #getMaxZoom}. 1417 * @hide 1418 */ 1419 public void setZoom(int value) { 1420 set("zoom", value); 1421 } 1422 1423 /** 1424 * Returns true if zoom is supported. Applications should call this 1425 * before using other zoom methods. 1426 * 1427 * @return true if zoom is supported. 1428 * @hide 1429 */ 1430 public boolean isZoomSupported() { 1431 String str = get("zoom-supported"); 1432 return "true".equals(str); 1433 } 1434 1435 /** 1436 * Gets the maximum zoom value allowed for snapshot. This is the maximum 1437 * value that applications can set to {@link #setZoom(int)}. 1438 * 1439 * @return the maximum zoom value supported by the camera. 1440 * @hide 1441 */ 1442 public int getMaxZoom() { 1443 return getInt("max-zoom"); 1444 } 1445 1446 /** 1447 * Gets the zoom factors of all zoom values. 1448 * 1449 * @return the zoom factors in 1/100 increments. Ex: a zoom of 3.2x is 1450 * returned as 320. Accuracy of the value is dependent on the 1451 * hardware implementation. The first element of the list is the 1452 * zoom factor of first zoom value. If the first zoom value is 1453 * 0, the zoom factor should be 100. The last element is the 1454 * zoom factor of zoom value {@link #getMaxZoom}. 1455 * @hide 1456 */ 1457 public List<Integer> getZoomFactors() { 1458 return splitInt(get("zoom-factors")); 1459 } 1460 1461 /** 1462 * Returns true if smooth zoom is supported. Applications should call 1463 * this before using other smooth zoom methods. 1464 * 1465 * @return true if smooth zoom is supported. 1466 * @hide 1467 */ 1468 public boolean isSmoothZoomSupported() { 1469 String str = get("smooth-zoom-supported"); 1470 return "true".equals(str); 1471 } 1472 1473 // Splits a comma delimited string to an ArrayList of String. 1474 // Return null if the passing string is null or the size is 0. 1475 private ArrayList<String> split(String str) { 1476 if (str == null) return null; 1477 1478 // Use StringTokenizer because it is faster than split. 1479 StringTokenizer tokenizer = new StringTokenizer(str, ","); 1480 ArrayList<String> substrings = new ArrayList<String>(); 1481 while (tokenizer.hasMoreElements()) { 1482 substrings.add(tokenizer.nextToken()); 1483 } 1484 return substrings; 1485 } 1486 1487 // Splits a comma delimited string to an ArrayList of Integer. 1488 // Return null if the passing string is null or the size is 0. 1489 private ArrayList<Integer> splitInt(String str) { 1490 if (str == null) return null; 1491 1492 StringTokenizer tokenizer = new StringTokenizer(str, ","); 1493 ArrayList<Integer> substrings = new ArrayList<Integer>(); 1494 while (tokenizer.hasMoreElements()) { 1495 String token = tokenizer.nextToken(); 1496 substrings.add(Integer.parseInt(token)); 1497 } 1498 if (substrings.size() == 0) return null; 1499 return substrings; 1500 } 1501 1502 // Splits a comma delimited string to an ArrayList of Size. 1503 // Return null if the passing string is null or the size is 0. 1504 private ArrayList<Size> splitSize(String str) { 1505 if (str == null) return null; 1506 1507 StringTokenizer tokenizer = new StringTokenizer(str, ","); 1508 ArrayList<Size> sizeList = new ArrayList<Size>(); 1509 while (tokenizer.hasMoreElements()) { 1510 Size size = strToSize(tokenizer.nextToken()); 1511 if (size != null) sizeList.add(size); 1512 } 1513 if (sizeList.size() == 0) return null; 1514 return sizeList; 1515 } 1516 1517 // Parses a string (ex: "480x320") to Size object. 1518 // Return null if the passing string is null. 1519 private Size strToSize(String str) { 1520 if (str == null) return null; 1521 1522 int pos = str.indexOf('x'); 1523 if (pos != -1) { 1524 String width = str.substring(0, pos); 1525 String height = str.substring(pos + 1); 1526 return new Size(Integer.parseInt(width), 1527 Integer.parseInt(height)); 1528 } 1529 Log.e(TAG, "Invalid size parameter string=" + str); 1530 return null; 1531 } 1532 }; 1533} 1534