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