Camera.java revision ffe1cf251a4f8469695b8acfa37270684dc1b70c
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, 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. If 361 * the camera does not support auto-focus, it is a no-op and {@link 362 * AutoFocusCallback#onAutoFocus(boolean, Camera)} callback will be called 363 * immediately. 364 * <p>If your application should not be installed 365 * on devices without auto-focus, you must declare that your application 366 * uses auto-focus with the 367 * <a href="{@docRoot}guide/topics/manifest/uses-feature-element.html"><uses-feature></a> 368 * manifest element.</p> 369 * 370 * @param cb the callback to run 371 */ 372 public final void autoFocus(AutoFocusCallback cb) 373 { 374 mAutoFocusCallback = cb; 375 native_autoFocus(); 376 } 377 private native final void native_autoFocus(); 378 379 /** 380 * Cancels auto-focus function. If the auto-focus is still in progress, 381 * this function will cancel it. Whether the auto-focus is in progress 382 * or not, this function will return the focus position to the default. 383 * If the camera does not support auto-focus, this is a no-op. 384 */ 385 public final void cancelAutoFocus() 386 { 387 mAutoFocusCallback = null; 388 native_cancelAutoFocus(); 389 } 390 private native final void native_cancelAutoFocus(); 391 392 /** 393 * An interface which contains a callback for the shutter closing after taking a picture. 394 */ 395 public interface ShutterCallback 396 { 397 /** 398 * Can be used to play a shutter sound as soon as the image has been captured, but before 399 * the data is available. 400 */ 401 void onShutter(); 402 } 403 404 /** 405 * Handles the callback for when a picture is taken. 406 */ 407 public interface PictureCallback { 408 /** 409 * Callback for when a picture is taken. 410 * 411 * @param data a byte array of the picture data 412 * @param camera the Camera service object 413 */ 414 void onPictureTaken(byte[] data, Camera camera); 415 }; 416 417 /** 418 * Triggers an asynchronous image capture. The camera service will initiate 419 * a series of callbacks to the application as the image capture progresses. 420 * The shutter callback occurs after the image is captured. This can be used 421 * to trigger a sound to let the user know that image has been captured. The 422 * raw callback occurs when the raw image data is available (NOTE: the data 423 * may be null if the hardware does not have enough memory to make a copy). 424 * The jpeg callback occurs when the compressed image is available. If the 425 * application does not need a particular callback, a null can be passed 426 * instead of a callback method. 427 * 428 * @param shutter callback after the image is captured, may be null 429 * @param raw callback with raw image data, may be null 430 * @param jpeg callback with jpeg image data, may be null 431 */ 432 public final void takePicture(ShutterCallback shutter, PictureCallback raw, 433 PictureCallback jpeg) { 434 takePicture(shutter, raw, null, jpeg); 435 } 436 private native final void native_takePicture(); 437 438 /** 439 * Triggers an asynchronous image capture. The camera service will initiate 440 * a series of callbacks to the application as the image capture progresses. 441 * The shutter callback occurs after the image is captured. This can be used 442 * to trigger a sound to let the user know that image has been captured. The 443 * raw callback occurs when the raw image data is available (NOTE: the data 444 * may be null if the hardware does not have enough memory to make a copy). 445 * The postview callback occurs when a scaled, fully processed postview 446 * image is available (NOTE: not all hardware supports this). The jpeg 447 * callback occurs when the compressed image is available. If the 448 * application does not need a particular callback, a null can be passed 449 * instead of a callback method. 450 * 451 * @param shutter callback after the image is captured, may be null 452 * @param raw callback with raw image data, may be null 453 * @param postview callback with postview image data, may be null 454 * @param jpeg callback with jpeg image data, may be null 455 */ 456 public final void takePicture(ShutterCallback shutter, PictureCallback raw, 457 PictureCallback postview, PictureCallback jpeg) { 458 mShutterCallback = shutter; 459 mRawImageCallback = raw; 460 mPostviewCallback = postview; 461 mJpegCallback = jpeg; 462 native_takePicture(); 463 } 464 465 /** 466 * Handles the zoom callback. 467 */ 468 public interface ZoomCallback 469 { 470 /** 471 * Callback for zoom updates 472 * @param zoomLevel new zoom level in 1/1000 increments, 473 * e.g. a zoom of 3.2x is stored as 3200. Accuracy of the 474 * value is dependent on the hardware implementation. Not 475 * all devices will generate this callback. 476 * @param camera the Camera service object 477 */ 478 void onZoomUpdate(int zoomLevel, Camera camera); 479 }; 480 481 /** 482 * Registers a callback to be invoked when the zoom 483 * level is updated by the camera driver. 484 * @param cb the callback to run 485 */ 486 public final void setZoomCallback(ZoomCallback cb) 487 { 488 mZoomCallback = cb; 489 } 490 491 // These match the enum in include/ui/Camera.h 492 /** Unspecified camerar error. @see #ErrorCallback */ 493 public static final int CAMERA_ERROR_UNKNOWN = 1; 494 /** Media server died. In this case, the application must release the 495 * Camera object and instantiate a new one. @see #ErrorCallback */ 496 public static final int CAMERA_ERROR_SERVER_DIED = 100; 497 498 /** 499 * Handles the camera error callback. 500 */ 501 public interface ErrorCallback 502 { 503 /** 504 * Callback for camera errors. 505 * @param error error code: 506 * <ul> 507 * <li>{@link #CAMERA_ERROR_UNKNOWN} 508 * <li>{@link #CAMERA_ERROR_SERVER_DIED} 509 * </ul> 510 * @param camera the Camera service object 511 */ 512 void onError(int error, Camera camera); 513 }; 514 515 /** 516 * Registers a callback to be invoked when an error occurs. 517 * @param cb the callback to run 518 */ 519 public final void setErrorCallback(ErrorCallback cb) 520 { 521 mErrorCallback = cb; 522 } 523 524 private native final void native_setParameters(String params); 525 private native final String native_getParameters(); 526 527 /** 528 * Sets the Parameters for pictures from this Camera service. 529 * 530 * @param params the Parameters to use for this Camera service 531 */ 532 public void setParameters(Parameters params) { 533 native_setParameters(params.flatten()); 534 } 535 536 /** 537 * Returns the picture Parameters for this Camera service. 538 */ 539 public Parameters getParameters() { 540 Parameters p = new Parameters(); 541 String s = native_getParameters(); 542 p.unflatten(s); 543 return p; 544 } 545 546 /** 547 * Handles the picture size (dimensions). 548 */ 549 public class Size { 550 /** 551 * Sets the dimensions for pictures. 552 * 553 * @param w the photo width (pixels) 554 * @param h the photo height (pixels) 555 */ 556 public Size(int w, int h) { 557 width = w; 558 height = h; 559 } 560 /** width of the picture */ 561 public int width; 562 /** height of the picture */ 563 public int height; 564 }; 565 566 /** 567 * Handles the parameters for pictures created by a Camera service. 568 * 569 * <p>To make camera parameters take effect, applications have to call 570 * Camera.setParameters. For example, after setWhiteBalance is called, white 571 * balance is not changed until Camera.setParameters() is called. 572 * 573 * <p>Different devices may have different camera capabilities, such as 574 * picture size or flash modes. The application should query the camera 575 * capabilities before setting parameters. For example, the application 576 * should call getSupportedColorEffects before calling setEffect. If the 577 * camera does not support color effects, getSupportedColorEffects will 578 * return null. 579 */ 580 public class Parameters { 581 // Parameter keys to communicate with the camera driver. 582 private static final String KEY_PREVIEW_SIZE = "preview-size"; 583 private static final String KEY_PREVIEW_FORMAT = "preview-format"; 584 private static final String KEY_PREVIEW_FRAME_RATE = "preview-frame-rate"; 585 private static final String KEY_PICTURE_SIZE = "picture-size"; 586 private static final String KEY_PICTURE_FORMAT = "picture-format"; 587 private static final String KEY_JPEG_THUMBNAIL_WIDTH = "jpeg-thumbnail-width"; 588 private static final String KEY_JPEG_THUMBNAIL_HEIGHT = "jpeg-thumbnail-height"; 589 private static final String KEY_JPEG_THUMBNAIL_QUALITY = "jpeg-thumbnail-quality"; 590 private static final String KEY_JPEG_QUALITY = "jpeg-quality"; 591 private static final String KEY_ROTATION = "rotation"; 592 private static final String KEY_GPS_LATITUDE = "gps-latitude"; 593 private static final String KEY_GPS_LONGITUDE = "gps-longitude"; 594 private static final String KEY_GPS_ALTITUDE = "gps-altitude"; 595 private static final String KEY_GPS_TIMESTAMP = "gps-timestamp"; 596 private static final String KEY_WHITE_BALANCE = "whitebalance"; 597 private static final String KEY_EFFECT = "effect"; 598 private static final String KEY_ANTIBANDING = "antibanding"; 599 private static final String KEY_SCENE_MODE = "scene-mode"; 600 private static final String KEY_FLASH_MODE = "flash-mode"; 601 // Parameter key suffix for supported values. 602 private static final String SUPPORTED_VALUES_SUFFIX = "-values"; 603 604 // Values for white balance settings. 605 public static final String WHITE_BALANCE_AUTO = "auto"; 606 public static final String WHITE_BALANCE_INCANDESCENT = "incandescent"; 607 public static final String WHITE_BALANCE_FLUORESCENT = "fluorescent"; 608 public static final String WHITE_BALANCE_WARM_FLUORESCENT = "warm-fluorescent"; 609 public static final String WHITE_BALANCE_DAYLIGHT = "daylight"; 610 public static final String WHITE_BALANCE_CLOUDY_DAYLIGHT = "cloudy-daylight"; 611 public static final String WHITE_BALANCE_TWILIGHT = "twilight"; 612 public static final String WHITE_BALANCE_SHADE = "shade"; 613 614 // Values for color effect settings. 615 public static final String EFFECT_NONE = "none"; 616 public static final String EFFECT_MONO = "mono"; 617 public static final String EFFECT_NEGATIVE = "negative"; 618 public static final String EFFECT_SOLARIZE = "solarize"; 619 public static final String EFFECT_SEPIA = "sepia"; 620 public static final String EFFECT_POSTERIZE = "posterize"; 621 public static final String EFFECT_WHITEBOARD = "whiteboard"; 622 public static final String EFFECT_BLACKBOARD = "blackboard"; 623 public static final String EFFECT_AQUA = "aqua"; 624 625 // Values for antibanding settings. 626 public static final String ANTIBANDING_AUTO = "auto"; 627 public static final String ANTIBANDING_50HZ = "50hz"; 628 public static final String ANTIBANDING_60HZ = "60hz"; 629 public static final String ANTIBANDING_OFF = "off"; 630 631 // Values for flash mode settings. 632 /** 633 * Flash will not be fired. 634 */ 635 public static final String FLASH_MODE_OFF = "off"; 636 /** 637 * Flash will be fired automatically when required. The timing is 638 * decided by camera driver. 639 */ 640 public static final String FLASH_MODE_AUTO = "auto"; 641 /** 642 * Flash will always be fired. The timing is decided by camera driver. 643 */ 644 public static final String FLASH_MODE_ON = "on"; 645 /** 646 * Flash will be fired in red-eye reduction mode. 647 */ 648 public static final String FLASH_MODE_RED_EYE = "red-eye"; 649 650 // Values for scene mode settings. 651 public static final String SCENE_MODE_AUTO = "auto"; 652 public static final String SCENE_MODE_ACTION = "action"; 653 public static final String SCENE_MODE_PORTRAIT = "portrait"; 654 public static final String SCENE_MODE_LANDSCAPE = "landscape"; 655 public static final String SCENE_MODE_NIGHT = "night"; 656 public static final String SCENE_MODE_NIGHT_PORTRAIT = "night-portrait"; 657 public static final String SCENE_MODE_THEATRE = "theatre"; 658 public static final String SCENE_MODE_BEACH = "beach"; 659 public static final String SCENE_MODE_SNOW = "snow"; 660 public static final String SCENE_MODE_SUNSET = "sunset"; 661 public static final String SCENE_MODE_STEADYPHOTO = "steadyphoto"; 662 public static final String SCENE_MODE_FIREWORKS = "fireworks"; 663 public static final String SCENE_MODE_SPORTS = "sports"; 664 public static final String SCENE_MODE_PARTY = "party"; 665 public static final String SCENE_MODE_CANDLELIGHT = "candlelight"; 666 667 // Formats for setPreviewFormat and setPictureFormat. 668 private static final String PIXEL_FORMAT_YUV422SP = "yuv422sp"; 669 private static final String PIXEL_FORMAT_YUV420SP = "yuv420sp"; 670 private static final String PIXEL_FORMAT_YUV422I = "yuv422i-yuyv"; 671 private static final String PIXEL_FORMAT_RGB565 = "rgb565"; 672 private static final String PIXEL_FORMAT_JPEG = "jpeg"; 673 674 private HashMap<String, String> mMap; 675 676 private Parameters() { 677 mMap = new HashMap<String, String>(); 678 } 679 680 /** 681 * Writes the current Parameters to the log. 682 * @hide 683 * @deprecated 684 */ 685 public void dump() { 686 Log.e(TAG, "dump: size=" + mMap.size()); 687 for (String k : mMap.keySet()) { 688 Log.e(TAG, "dump: " + k + "=" + mMap.get(k)); 689 } 690 } 691 692 /** 693 * Creates a single string with all the parameters set in 694 * this Parameters object. 695 * <p>The {@link #unflatten(String)} method does the reverse.</p> 696 * 697 * @return a String with all values from this Parameters object, in 698 * semi-colon delimited key-value pairs 699 */ 700 public String flatten() { 701 StringBuilder flattened = new StringBuilder(); 702 for (String k : mMap.keySet()) { 703 flattened.append(k); 704 flattened.append("="); 705 flattened.append(mMap.get(k)); 706 flattened.append(";"); 707 } 708 // chop off the extra semicolon at the end 709 flattened.deleteCharAt(flattened.length()-1); 710 return flattened.toString(); 711 } 712 713 /** 714 * Takes a flattened string of parameters and adds each one to 715 * this Parameters object. 716 * <p>The {@link #flatten()} method does the reverse.</p> 717 * 718 * @param flattened a String of parameters (key-value paired) that 719 * are semi-colon delimited 720 */ 721 public void unflatten(String flattened) { 722 mMap.clear(); 723 724 StringTokenizer tokenizer = new StringTokenizer(flattened, ";"); 725 while (tokenizer.hasMoreElements()) { 726 String kv = tokenizer.nextToken(); 727 int pos = kv.indexOf('='); 728 if (pos == -1) { 729 continue; 730 } 731 String k = kv.substring(0, pos); 732 String v = kv.substring(pos + 1); 733 mMap.put(k, v); 734 } 735 } 736 737 public void remove(String key) { 738 mMap.remove(key); 739 } 740 741 /** 742 * Sets a String parameter. 743 * 744 * @param key the key name for the parameter 745 * @param value the String value of the parameter 746 */ 747 public void set(String key, String value) { 748 if (key.indexOf('=') != -1 || key.indexOf(';') != -1) { 749 Log.e(TAG, "Key \"" + key + "\" contains invalid character (= or ;)"); 750 return; 751 } 752 if (value.indexOf('=') != -1 || value.indexOf(';') != -1) { 753 Log.e(TAG, "Value \"" + value + "\" contains invalid character (= or ;)"); 754 return; 755 } 756 757 mMap.put(key, value); 758 } 759 760 /** 761 * Sets an integer parameter. 762 * 763 * @param key the key name for the parameter 764 * @param value the int value of the parameter 765 */ 766 public void set(String key, int value) { 767 mMap.put(key, Integer.toString(value)); 768 } 769 770 /** 771 * Returns the value of a String parameter. 772 * 773 * @param key the key name for the parameter 774 * @return the String value of the parameter 775 */ 776 public String get(String key) { 777 return mMap.get(key); 778 } 779 780 /** 781 * Returns the value of an integer parameter. 782 * 783 * @param key the key name for the parameter 784 * @return the int value of the parameter 785 */ 786 public int getInt(String key) { 787 return Integer.parseInt(mMap.get(key)); 788 } 789 790 /** 791 * Sets the dimensions for preview pictures. 792 * 793 * @param width the width of the pictures, in pixels 794 * @param height the height of the pictures, in pixels 795 */ 796 public void setPreviewSize(int width, int height) { 797 String v = Integer.toString(width) + "x" + Integer.toString(height); 798 set(KEY_PREVIEW_SIZE, v); 799 } 800 801 /** 802 * Returns the dimensions setting for preview pictures. 803 * 804 * @return a Size object with the height and width setting 805 * for the preview picture 806 */ 807 public Size getPreviewSize() { 808 String pair = get(KEY_PREVIEW_SIZE); 809 return strToSize(pair); 810 } 811 812 /** 813 * Gets the supported preview sizes. 814 * 815 * @return a List of Size object. null if preview size setting is not 816 * supported. 817 */ 818 public List<Size> getSupportedPreviewSizes() { 819 String str = get(KEY_PREVIEW_SIZE + SUPPORTED_VALUES_SUFFIX); 820 return splitSize(str); 821 } 822 823 /** 824 * Sets the dimensions for EXIF thumbnail in Jpeg picture. 825 * 826 * @param width the width of the thumbnail, in pixels 827 * @param height the height of the thumbnail, in pixels 828 */ 829 public void setJpegThumbnailSize(int width, int height) { 830 set(KEY_JPEG_THUMBNAIL_WIDTH, width); 831 set(KEY_JPEG_THUMBNAIL_HEIGHT, height); 832 } 833 834 /** 835 * Returns the dimensions for EXIF thumbnail in Jpeg picture. 836 * 837 * @return a Size object with the height and width setting for the EXIF 838 * thumbnails 839 */ 840 public Size getJpegThumbnailSize() { 841 return new Size(getInt(KEY_JPEG_THUMBNAIL_WIDTH), 842 getInt(KEY_JPEG_THUMBNAIL_HEIGHT)); 843 } 844 845 /** 846 * Sets the quality of the EXIF thumbnail in Jpeg picture. 847 * 848 * @param quality the JPEG quality of the EXIF thumbnail. The range is 1 849 * to 100, with 100 being the best. 850 */ 851 public void setJpegThumbnailQuality(int quality) { 852 set(KEY_JPEG_THUMBNAIL_QUALITY, quality); 853 } 854 855 /** 856 * Returns the quality setting for the EXIF thumbnail in Jpeg picture. 857 * 858 * @return the JPEG quality setting of the EXIF thumbnail. 859 */ 860 public int getJpegThumbnailQuality() { 861 return getInt(KEY_JPEG_THUMBNAIL_QUALITY); 862 } 863 864 /** 865 * Sets Jpeg quality of captured picture. 866 * 867 * @param quality the JPEG quality of captured picture. The range is 1 868 * to 100, with 100 being the best. 869 */ 870 public void setJpegQuality(int quality) { 871 set(KEY_JPEG_QUALITY, quality); 872 } 873 874 /** 875 * Returns the quality setting for the JPEG picture. 876 * 877 * @return the JPEG picture quality setting. 878 */ 879 public int getJpegQuality() { 880 return getInt(KEY_JPEG_QUALITY); 881 } 882 883 /** 884 * Sets the rate at which preview frames are received. 885 * 886 * @param fps the frame rate (frames per second) 887 */ 888 public void setPreviewFrameRate(int fps) { 889 set(KEY_PREVIEW_FRAME_RATE, fps); 890 } 891 892 /** 893 * Returns the setting for the rate at which preview frames 894 * are received. 895 * 896 * @return the frame rate setting (frames per second) 897 */ 898 public int getPreviewFrameRate() { 899 return getInt(KEY_PREVIEW_FRAME_RATE); 900 } 901 902 /** 903 * Gets the supported preview frame rates. 904 * 905 * @return a List of Integer objects (preview frame rates). null if 906 * preview frame rate setting is not supported. 907 */ 908 public List<Integer> getSupportedPreviewFrameRates() { 909 String str = get(KEY_PREVIEW_FRAME_RATE + SUPPORTED_VALUES_SUFFIX); 910 return splitInt(str); 911 } 912 913 /** 914 * Sets the image format for preview pictures. 915 * <p>If this is never called, the default format will be 916 * {@link android.graphics.PixelFormat#YCbCr_420_SP}, which 917 * uses the NV21 encoding format.</p> 918 * 919 * @param pixel_format the desired preview picture format, defined 920 * by one of the {@link android.graphics.PixelFormat} constants. 921 * (E.g., <var>PixelFormat.YCbCr_420_SP</var> (default), 922 * <var>PixelFormat.RGB_565</var>, or 923 * <var>PixelFormat.JPEG</var>) 924 * @see android.graphics.PixelFormat 925 */ 926 public void setPreviewFormat(int pixel_format) { 927 String s = cameraFormatForPixelFormat(pixel_format); 928 if (s == null) { 929 throw new IllegalArgumentException( 930 "Invalid pixel_format=" + pixel_format); 931 } 932 933 set(KEY_PREVIEW_FORMAT, s); 934 } 935 936 /** 937 * Returns the image format for preview pictures got from 938 * {@link PreviewCallback}. 939 * 940 * @return the {@link android.graphics.PixelFormat} int representing 941 * the preview picture format. 942 */ 943 public int getPreviewFormat() { 944 return pixelFormatForCameraFormat(get(KEY_PREVIEW_FORMAT)); 945 } 946 947 /** 948 * Gets the supported preview formats. 949 * 950 * @return a List of Integer objects. null if preview format setting is 951 * not supported. 952 */ 953 public List<Integer> getSupportedPreviewFormats() { 954 String str = get(KEY_PREVIEW_FORMAT + SUPPORTED_VALUES_SUFFIX); 955 ArrayList<Integer> formats = new ArrayList<Integer>(); 956 for (String s : split(str)) { 957 int f = pixelFormatForCameraFormat(s); 958 if (f == PixelFormat.UNKNOWN) continue; 959 formats.add(f); 960 } 961 return formats; 962 } 963 964 /** 965 * Sets the dimensions for pictures. 966 * 967 * @param width the width for pictures, in pixels 968 * @param height the height for pictures, in pixels 969 */ 970 public void setPictureSize(int width, int height) { 971 String v = Integer.toString(width) + "x" + Integer.toString(height); 972 set(KEY_PICTURE_SIZE, v); 973 } 974 975 /** 976 * Returns the dimension setting for pictures. 977 * 978 * @return a Size object with the height and width setting 979 * for pictures 980 */ 981 public Size getPictureSize() { 982 String pair = get(KEY_PICTURE_SIZE); 983 return strToSize(pair); 984 } 985 986 /** 987 * Gets the supported picture sizes. 988 * 989 * @return a List of Size objects. null if picture size setting is not 990 * supported. 991 */ 992 public List<Size> getSupportedPictureSizes() { 993 String str = get(KEY_PICTURE_SIZE + SUPPORTED_VALUES_SUFFIX); 994 return splitSize(str); 995 } 996 997 /** 998 * Sets the image format for pictures. 999 * 1000 * @param pixel_format the desired picture format 1001 * (<var>PixelFormat.YCbCr_420_SP (NV21)</var>, 1002 * <var>PixelFormat.RGB_565</var>, or 1003 * <var>PixelFormat.JPEG</var>) 1004 * @see android.graphics.PixelFormat 1005 */ 1006 public void setPictureFormat(int pixel_format) { 1007 String s = cameraFormatForPixelFormat(pixel_format); 1008 if (s == null) { 1009 throw new IllegalArgumentException( 1010 "Invalid pixel_format=" + pixel_format); 1011 } 1012 1013 set(KEY_PICTURE_FORMAT, s); 1014 } 1015 1016 /** 1017 * Returns the image format for pictures. 1018 * 1019 * @return the PixelFormat int representing the picture format 1020 */ 1021 public int getPictureFormat() { 1022 return pixelFormatForCameraFormat(get(KEY_PICTURE_FORMAT)); 1023 } 1024 1025 /** 1026 * Gets the supported picture formats. 1027 * 1028 * @return a List of Integer objects (values are PixelFormat.XXX). null 1029 * if picture setting is not supported. 1030 */ 1031 public List<Integer> getSupportedPictureFormats() { 1032 String str = get(KEY_PICTURE_SIZE + SUPPORTED_VALUES_SUFFIX); 1033 return splitInt(str); 1034 } 1035 1036 private String cameraFormatForPixelFormat(int pixel_format) { 1037 switch(pixel_format) { 1038 case PixelFormat.YCbCr_422_SP: return PIXEL_FORMAT_YUV422SP; 1039 case PixelFormat.YCbCr_420_SP: return PIXEL_FORMAT_YUV420SP; 1040 case PixelFormat.YCbCr_422_I: return PIXEL_FORMAT_YUV422I; 1041 case PixelFormat.RGB_565: return PIXEL_FORMAT_RGB565; 1042 case PixelFormat.JPEG: return PIXEL_FORMAT_JPEG; 1043 default: return null; 1044 } 1045 } 1046 1047 private int pixelFormatForCameraFormat(String format) { 1048 if (format == null) 1049 return PixelFormat.UNKNOWN; 1050 1051 if (format.equals(PIXEL_FORMAT_YUV422SP)) 1052 return PixelFormat.YCbCr_422_SP; 1053 1054 if (format.equals(PIXEL_FORMAT_YUV420SP)) 1055 return PixelFormat.YCbCr_420_SP; 1056 1057 if (format.equals(PIXEL_FORMAT_YUV422I)) 1058 return PixelFormat.YCbCr_422_I; 1059 1060 if (format.equals(PIXEL_FORMAT_RGB565)) 1061 return PixelFormat.RGB_565; 1062 1063 if (format.equals(PIXEL_FORMAT_JPEG)) 1064 return PixelFormat.JPEG; 1065 1066 return PixelFormat.UNKNOWN; 1067 } 1068 1069 /** 1070 * Sets the orientation of the device in degrees, which instructs the 1071 * camera driver to rotate the picture and thumbnail, in order to match 1072 * what the user sees from the viewfinder. For example, suppose the 1073 * natural position of the device is landscape. If the user takes a 1074 * picture in landscape mode in 2048x1536 resolution, the rotation 1075 * should be set to 0. If the user rotates the phone 90 degrees 1076 * clockwise, the rotation should be set to 90. Applications can use 1077 * {@link android.view.OrientationEventListener} to set this parameter. 1078 * 1079 * Since the picture is rotated, the orientation in the EXIF header is 1080 * missing or always 1 (row #0 is top and column #0 is left side). 1081 * 1082 * @param rotation The orientation of the device in degrees. Rotation 1083 * can only be 0, 90, 180 or 270. 1084 * @throws IllegalArgumentException if rotation value is invalid. 1085 * @see android.view.OrientationEventListener 1086 */ 1087 public void setRotation(int rotation) { 1088 if (rotation == 0 || rotation == 90 || rotation == 180 1089 || rotation == 270) { 1090 set(KEY_ROTATION, Integer.toString(rotation)); 1091 } else { 1092 throw new IllegalArgumentException( 1093 "Invalid rotation=" + rotation); 1094 } 1095 } 1096 1097 /** 1098 * Sets GPS latitude coordinate. This will be stored in JPEG EXIF 1099 * header. 1100 * 1101 * @param latitude GPS latitude coordinate. 1102 */ 1103 public void setGpsLatitude(double latitude) { 1104 set(KEY_GPS_LATITUDE, Double.toString(latitude)); 1105 } 1106 1107 /** 1108 * Sets GPS longitude coordinate. This will be stored in JPEG EXIF 1109 * header. 1110 * 1111 * @param longitude GPS longitude coordinate. 1112 */ 1113 public void setGpsLongitude(double longitude) { 1114 set(KEY_GPS_LONGITUDE, Double.toString(longitude)); 1115 } 1116 1117 /** 1118 * Sets GPS altitude. This will be stored in JPEG EXIF header. 1119 * 1120 * @param altitude GPS altitude in meters. 1121 */ 1122 public void setGpsAltitude(double altitude) { 1123 set(KEY_GPS_ALTITUDE, Double.toString(altitude)); 1124 } 1125 1126 /** 1127 * Sets GPS timestamp. This will be stored in JPEG EXIF header. 1128 * 1129 * @param timestamp GPS timestamp (UTC in seconds since January 1, 1130 * 1970). 1131 */ 1132 public void setGpsTimestamp(long timestamp) { 1133 set(KEY_GPS_TIMESTAMP, Long.toString(timestamp)); 1134 } 1135 1136 /** 1137 * Removes GPS latitude, longitude, altitude, and timestamp from the 1138 * parameters. 1139 */ 1140 public void removeGpsData() { 1141 remove(KEY_GPS_LATITUDE); 1142 remove(KEY_GPS_LONGITUDE); 1143 remove(KEY_GPS_ALTITUDE); 1144 remove(KEY_GPS_TIMESTAMP); 1145 } 1146 1147 /** 1148 * Gets the current white balance setting. 1149 * 1150 * @return one of WHITE_BALANCE_XXX string constant. null if white 1151 * balance setting is not supported. 1152 */ 1153 public String getWhiteBalance() { 1154 return get(KEY_WHITE_BALANCE); 1155 } 1156 1157 /** 1158 * Sets the white balance. 1159 * 1160 * @param value WHITE_BALANCE_XXX string constant. 1161 */ 1162 public void setWhiteBalance(String value) { 1163 set(KEY_WHITE_BALANCE, value); 1164 } 1165 1166 /** 1167 * Gets the supported white balance. 1168 * 1169 * @return a List of WHITE_BALANCE_XXX string constants. null if white 1170 * balance setting is not supported. 1171 */ 1172 public List<String> getSupportedWhiteBalance() { 1173 String str = get(KEY_WHITE_BALANCE + SUPPORTED_VALUES_SUFFIX); 1174 return split(str); 1175 } 1176 1177 /** 1178 * Gets the current color effect setting. 1179 * 1180 * @return one of EFFECT_XXX string constant. null if color effect 1181 * setting is not supported. 1182 */ 1183 public String getColorEffect() { 1184 return get(KEY_EFFECT); 1185 } 1186 1187 /** 1188 * Sets the current color effect setting. 1189 * 1190 * @param value EFFECT_XXX string constants. 1191 */ 1192 public void setColorEffect(String value) { 1193 set(KEY_EFFECT, value); 1194 } 1195 1196 /** 1197 * Gets the supported color effects. 1198 * 1199 * @return a List of EFFECT_XXX string constants. null if color effect 1200 * setting is not supported. 1201 */ 1202 public List<String> getSupportedColorEffects() { 1203 String str = get(KEY_EFFECT + SUPPORTED_VALUES_SUFFIX); 1204 return split(str); 1205 } 1206 1207 1208 /** 1209 * Gets the current antibanding setting. 1210 * 1211 * @return one of ANTIBANDING_XXX string constant. null if antibanding 1212 * setting is not supported. 1213 */ 1214 public String getAntibanding() { 1215 return get(KEY_ANTIBANDING); 1216 } 1217 1218 /** 1219 * Sets the antibanding. 1220 * 1221 * @param antibanding ANTIBANDING_XXX string constant. 1222 */ 1223 public void setAntibanding(String antibanding) { 1224 set(KEY_ANTIBANDING, antibanding); 1225 } 1226 1227 /** 1228 * Gets the supported antibanding values. 1229 * 1230 * @return a List of ANTIBANDING_XXX string constants. null if 1231 * antibanding setting is not supported. 1232 */ 1233 public List<String> getSupportedAntibanding() { 1234 String str = get(KEY_ANTIBANDING + SUPPORTED_VALUES_SUFFIX); 1235 return split(str); 1236 } 1237 1238 /** 1239 * Gets the current scene mode setting. 1240 * 1241 * @return one of SCENE_MODE_XXX string constant. null if scene mode 1242 * setting is not supported. 1243 */ 1244 public String getSceneMode() { 1245 return get(KEY_SCENE_MODE); 1246 } 1247 1248 /** 1249 * Sets the scene mode. 1250 * 1251 * @param value SCENE_MODE_XXX string constants. 1252 */ 1253 public void setSceneMode(String value) { 1254 set(KEY_SCENE_MODE, value); 1255 } 1256 1257 /** 1258 * Gets the supported scene modes. 1259 * 1260 * @return a List of SCENE_MODE_XXX string constant. null if scene mode 1261 * setting is not supported. 1262 */ 1263 public List<String> getSupportedSceneModes() { 1264 String str = get(KEY_SCENE_MODE + SUPPORTED_VALUES_SUFFIX); 1265 return split(str); 1266 } 1267 1268 /** 1269 * Gets the current flash mode setting. 1270 * 1271 * @return one of FLASH_MODE_XXX string constant. null if flash mode 1272 * setting is not supported. 1273 */ 1274 public String getFlashMode() { 1275 return get(KEY_FLASH_MODE); 1276 } 1277 1278 /** 1279 * Sets the flash mode. 1280 * 1281 * @param value FLASH_MODE_XXX string constants. 1282 */ 1283 public void setFlashMode(String value) { 1284 set(KEY_FLASH_MODE, value); 1285 } 1286 1287 /** 1288 * Gets the supported flash modes. 1289 * 1290 * @return a List of FLASH_MODE_XXX string constants. null if flash mode 1291 * setting is not supported. 1292 */ 1293 public List<String> getSupportedFlashModes() { 1294 String str = get(KEY_FLASH_MODE + SUPPORTED_VALUES_SUFFIX); 1295 return split(str); 1296 } 1297 1298 // Splits a comma delimited string to an ArrayList of String. 1299 // Return null if the passing string is null or the size is 0. 1300 private ArrayList<String> split(String str) { 1301 if (str == null) return null; 1302 1303 // Use StringTokenizer because it is faster than split. 1304 StringTokenizer tokenizer = new StringTokenizer(str, ","); 1305 ArrayList<String> substrings = new ArrayList<String>(); 1306 while (tokenizer.hasMoreElements()) { 1307 substrings.add(tokenizer.nextToken()); 1308 } 1309 return substrings; 1310 } 1311 1312 // Splits a comma delimited string to an ArrayList of Integer. 1313 // Return null if the passing string is null or the size is 0. 1314 private ArrayList<Integer> splitInt(String str) { 1315 if (str == null) return null; 1316 1317 StringTokenizer tokenizer = new StringTokenizer(str, ","); 1318 ArrayList<Integer> substrings = new ArrayList<Integer>(); 1319 while (tokenizer.hasMoreElements()) { 1320 String token = tokenizer.nextToken(); 1321 substrings.add(Integer.parseInt(token)); 1322 } 1323 if (substrings.size() == 0) return null; 1324 return substrings; 1325 } 1326 1327 // Splits a comma delimited string to an ArrayList of Size. 1328 // Return null if the passing string is null or the size is 0. 1329 private ArrayList<Size> splitSize(String str) { 1330 if (str == null) return null; 1331 1332 StringTokenizer tokenizer = new StringTokenizer(str, ","); 1333 ArrayList<Size> sizeList = new ArrayList<Size>(); 1334 while (tokenizer.hasMoreElements()) { 1335 Size size = strToSize(tokenizer.nextToken()); 1336 if (size != null) sizeList.add(size); 1337 } 1338 if (sizeList.size() == 0) return null; 1339 return sizeList; 1340 } 1341 1342 // Parses a string (ex: "480x320") to Size object. 1343 // Return null if the passing string is null. 1344 private Size strToSize(String str) { 1345 if (str == null) return null; 1346 1347 int pos = str.indexOf('x'); 1348 if (pos != -1) { 1349 String width = str.substring(0, pos); 1350 String height = str.substring(pos + 1); 1351 return new Size(Integer.parseInt(width), 1352 Integer.parseInt(height)); 1353 } 1354 Log.e(TAG, "Invalid size parameter string=" + str); 1355 return null; 1356 } 1357 }; 1358} 1359