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