Camera.java revision 53b30912d3e8598c05e47308981971e958e98db2
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 14, 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 14, 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     * <p>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     * <p>Stopping preview with {@link #stopPreview()}, or triggering still
813     * image capture with {@link #takePicture(Camera.ShutterCallback,
814     * Camera.PictureCallback, Camera.PictureCallback)}, will not change the
815     * the focus position. Applications must call cancelAutoFocus to reset the
816     * focus.</p>
817     *
818     * @param cb the callback to run
819     * @see #cancelAutoFocus()
820     * @see android.hardware.Camera.Parameters#setAutoExposureLock(boolean)
821     * @see android.hardware.Camera.Parameters#setAutoWhiteBalanceLock(boolean)
822     */
823    public final void autoFocus(AutoFocusCallback cb)
824    {
825        mAutoFocusCallback = cb;
826        native_autoFocus();
827    }
828    private native final void native_autoFocus();
829
830    /**
831     * Cancels any auto-focus function in progress.
832     * Whether or not auto-focus is currently in progress,
833     * this function will return the focus position to the default.
834     * If the camera does not support auto-focus, this is a no-op.
835     *
836     * @see #autoFocus(Camera.AutoFocusCallback)
837     */
838    public final void cancelAutoFocus()
839    {
840        mAutoFocusCallback = null;
841        native_cancelAutoFocus();
842    }
843    private native final void native_cancelAutoFocus();
844
845    /**
846     * Callback interface used to signal the moment of actual image capture.
847     *
848     * @see #takePicture(ShutterCallback, PictureCallback, PictureCallback, PictureCallback)
849     */
850    public interface ShutterCallback
851    {
852        /**
853         * Called as near as possible to the moment when a photo is captured
854         * from the sensor.  This is a good opportunity to play a shutter sound
855         * or give other feedback of camera operation.  This may be some time
856         * after the photo was triggered, but some time before the actual data
857         * is available.
858         */
859        void onShutter();
860    }
861
862    /**
863     * Callback interface used to supply image data from a photo capture.
864     *
865     * @see #takePicture(ShutterCallback, PictureCallback, PictureCallback, PictureCallback)
866     */
867    public interface PictureCallback {
868        /**
869         * Called when image data is available after a picture is taken.
870         * The format of the data depends on the context of the callback
871         * and {@link Camera.Parameters} settings.
872         *
873         * @param data   a byte array of the picture data
874         * @param camera the Camera service object
875         */
876        void onPictureTaken(byte[] data, Camera camera);
877    };
878
879    /**
880     * Equivalent to takePicture(shutter, raw, null, jpeg).
881     *
882     * @see #takePicture(ShutterCallback, PictureCallback, PictureCallback, PictureCallback)
883     */
884    public final void takePicture(ShutterCallback shutter, PictureCallback raw,
885            PictureCallback jpeg) {
886        takePicture(shutter, raw, null, jpeg);
887    }
888    private native final void native_takePicture(int msgType);
889
890    /**
891     * Triggers an asynchronous image capture. The camera service will initiate
892     * a series of callbacks to the application as the image capture progresses.
893     * The shutter callback occurs after the image is captured. This can be used
894     * to trigger a sound to let the user know that image has been captured. The
895     * raw callback occurs when the raw image data is available (NOTE: the data
896     * will be null if there is no raw image callback buffer available or the
897     * raw image callback buffer is not large enough to hold the raw image).
898     * The postview callback occurs when a scaled, fully processed postview
899     * image is available (NOTE: not all hardware supports this). The jpeg
900     * callback occurs when the compressed image is available. If the
901     * application does not need a particular callback, a null can be passed
902     * instead of a callback method.
903     *
904     * <p>This method is only valid when preview is active (after
905     * {@link #startPreview()}).  Preview will be stopped after the image is
906     * taken; callers must call {@link #startPreview()} again if they want to
907     * re-start preview or take more pictures. This should not be called between
908     * {@link android.media.MediaRecorder#start()} and
909     * {@link android.media.MediaRecorder#stop()}.
910     *
911     * <p>After calling this method, you must not call {@link #startPreview()}
912     * or take another picture until the JPEG callback has returned.
913     *
914     * @param shutter   the callback for image capture moment, or null
915     * @param raw       the callback for raw (uncompressed) image data, or null
916     * @param postview  callback with postview image data, may be null
917     * @param jpeg      the callback for JPEG image data, or null
918     */
919    public final void takePicture(ShutterCallback shutter, PictureCallback raw,
920            PictureCallback postview, PictureCallback jpeg) {
921        mShutterCallback = shutter;
922        mRawImageCallback = raw;
923        mPostviewCallback = postview;
924        mJpegCallback = jpeg;
925
926        // If callback is not set, do not send me callbacks.
927        int msgType = 0;
928        if (mShutterCallback != null) {
929            msgType |= CAMERA_MSG_SHUTTER;
930        }
931        if (mRawImageCallback != null) {
932            msgType |= CAMERA_MSG_RAW_IMAGE;
933        }
934        if (mPostviewCallback != null) {
935            msgType |= CAMERA_MSG_POSTVIEW_FRAME;
936        }
937        if (mJpegCallback != null) {
938            msgType |= CAMERA_MSG_COMPRESSED_IMAGE;
939        }
940
941        native_takePicture(msgType);
942    }
943
944    /**
945     * Zooms to the requested value smoothly. The driver will notify {@link
946     * OnZoomChangeListener} of the zoom value and whether zoom is stopped at
947     * the time. For example, suppose the current zoom is 0 and startSmoothZoom
948     * is called with value 3. The
949     * {@link Camera.OnZoomChangeListener#onZoomChange(int, boolean, Camera)}
950     * method will be called three times with zoom values 1, 2, and 3.
951     * Applications can call {@link #stopSmoothZoom} to stop the zoom earlier.
952     * Applications should not call startSmoothZoom again or change the zoom
953     * value before zoom stops. If the supplied zoom value equals to the current
954     * zoom value, no zoom callback will be generated. This method is supported
955     * if {@link android.hardware.Camera.Parameters#isSmoothZoomSupported}
956     * returns true.
957     *
958     * @param value zoom value. The valid range is 0 to {@link
959     *              android.hardware.Camera.Parameters#getMaxZoom}.
960     * @throws IllegalArgumentException if the zoom value is invalid.
961     * @throws RuntimeException if the method fails.
962     * @see #setZoomChangeListener(OnZoomChangeListener)
963     */
964    public native final void startSmoothZoom(int value);
965
966    /**
967     * Stops the smooth zoom. Applications should wait for the {@link
968     * OnZoomChangeListener} to know when the zoom is actually stopped. This
969     * method is supported if {@link
970     * android.hardware.Camera.Parameters#isSmoothZoomSupported} is true.
971     *
972     * @throws RuntimeException if the method fails.
973     */
974    public native final void stopSmoothZoom();
975
976    /**
977     * Set the clockwise rotation of preview display in degrees. This affects
978     * the preview frames and the picture displayed after snapshot. This method
979     * is useful for portrait mode applications. Note that preview display of
980     * front-facing cameras is flipped horizontally before the rotation, that
981     * is, the image is reflected along the central vertical axis of the camera
982     * sensor. So the users can see themselves as looking into a mirror.
983     *
984     * <p>This does not affect the order of byte array passed in {@link
985     * PreviewCallback#onPreviewFrame}, JPEG pictures, or recorded videos. This
986     * method is not allowed to be called during preview.
987     *
988     * <p>If you want to make the camera image show in the same orientation as
989     * the display, you can use the following code.
990     * <pre>
991     * public static void setCameraDisplayOrientation(Activity activity,
992     *         int cameraId, android.hardware.Camera camera) {
993     *     android.hardware.Camera.CameraInfo info =
994     *             new android.hardware.Camera.CameraInfo();
995     *     android.hardware.Camera.getCameraInfo(cameraId, info);
996     *     int rotation = activity.getWindowManager().getDefaultDisplay()
997     *             .getRotation();
998     *     int degrees = 0;
999     *     switch (rotation) {
1000     *         case Surface.ROTATION_0: degrees = 0; break;
1001     *         case Surface.ROTATION_90: degrees = 90; break;
1002     *         case Surface.ROTATION_180: degrees = 180; break;
1003     *         case Surface.ROTATION_270: degrees = 270; break;
1004     *     }
1005     *
1006     *     int result;
1007     *     if (info.facing == Camera.CameraInfo.CAMERA_FACING_FRONT) {
1008     *         result = (info.orientation + degrees) % 360;
1009     *         result = (360 - result) % 360;  // compensate the mirror
1010     *     } else {  // back-facing
1011     *         result = (info.orientation - degrees + 360) % 360;
1012     *     }
1013     *     camera.setDisplayOrientation(result);
1014     * }
1015     * </pre>
1016     *
1017     * <p>Starting from API level 14, this method can be called when preview is
1018     * active.
1019     *
1020     * @param degrees the angle that the picture will be rotated clockwise.
1021     *                Valid values are 0, 90, 180, and 270. The starting
1022     *                position is 0 (landscape).
1023     * @see #setPreviewDisplay(SurfaceHolder)
1024     */
1025    public native final void setDisplayOrientation(int degrees);
1026
1027    /**
1028     * Callback interface for zoom changes during a smooth zoom operation.
1029     *
1030     * @see #setZoomChangeListener(OnZoomChangeListener)
1031     * @see #startSmoothZoom(int)
1032     */
1033    public interface OnZoomChangeListener
1034    {
1035        /**
1036         * Called when the zoom value has changed during a smooth zoom.
1037         *
1038         * @param zoomValue the current zoom value. In smooth zoom mode, camera
1039         *                  calls this for every new zoom value.
1040         * @param stopped whether smooth zoom is stopped. If the value is true,
1041         *                this is the last zoom update for the application.
1042         * @param camera  the Camera service object
1043         */
1044        void onZoomChange(int zoomValue, boolean stopped, Camera camera);
1045    };
1046
1047    /**
1048     * Registers a listener to be notified when the zoom value is updated by the
1049     * camera driver during smooth zoom.
1050     *
1051     * @param listener the listener to notify
1052     * @see #startSmoothZoom(int)
1053     */
1054    public final void setZoomChangeListener(OnZoomChangeListener listener)
1055    {
1056        mZoomListener = listener;
1057    }
1058
1059    /**
1060     * Callback interface for face detected in the preview frame.
1061     *
1062     */
1063    public interface FaceDetectionListener
1064    {
1065        /**
1066         * Notify the listener of the detected faces in the preview frame.
1067         *
1068         * @param faces The detected faces in a list
1069         * @param camera  The {@link Camera} service object
1070         */
1071        void onFaceDetection(Face[] faces, Camera camera);
1072    }
1073
1074    /**
1075     * Registers a listener to be notified about the faces detected in the
1076     * preview frame.
1077     *
1078     * @param listener the listener to notify
1079     * @see #startFaceDetection()
1080     */
1081    public final void setFaceDetectionListener(FaceDetectionListener listener)
1082    {
1083        mFaceListener = listener;
1084    }
1085
1086    /**
1087     * Starts the face detection. This should be called after preview is started.
1088     * The camera will notify {@link FaceDetectionListener} of the detected
1089     * faces in the preview frame. The detected faces may be the same as the
1090     * previous ones. Applications should call {@link #stopFaceDetection} to
1091     * stop the face detection. This method is supported if {@link
1092     * Parameters#getMaxNumDetectedFaces()} returns a number larger than 0.
1093     * If the face detection has started, apps should not call this again.
1094     *
1095     * When the face detection is running, {@link Parameters#setWhiteBalance(String)},
1096     * {@link Parameters#setFocusAreas(List)}, and {@link Parameters#setMeteringAreas(List)}
1097     * have no effect.
1098     *
1099     * @throws IllegalArgumentException if the face detection is unsupported.
1100     * @throws RuntimeException if the method fails or the face detection is
1101     *         already running.
1102     * @see FaceDetectionListener
1103     * @see #stopFaceDetection()
1104     * @see Parameters#getMaxNumDetectedFaces()
1105     */
1106    public final void startFaceDetection() {
1107        if (mFaceDetectionRunning) {
1108            throw new RuntimeException("Face detection is already running");
1109        }
1110        _startFaceDetection(CAMERA_FACE_DETECTION_HW);
1111        mFaceDetectionRunning = true;
1112    }
1113
1114    /**
1115     * Stops the face detection.
1116     *
1117     * @see #startFaceDetection()
1118     */
1119    public final void stopFaceDetection() {
1120        _stopFaceDetection();
1121        mFaceDetectionRunning = false;
1122    }
1123
1124    private native final void _startFaceDetection(int type);
1125    private native final void _stopFaceDetection();
1126
1127    /**
1128     * Information about a face identified through camera face detection.
1129     *
1130     * <p>When face detection is used with a camera, the {@link FaceDetectionListener} returns a
1131     * list of face objects for use in focusing and metering.</p>
1132     *
1133     * @see FaceDetectionListener
1134     */
1135    public static class Face {
1136        /**
1137         * Create an empty face.
1138         */
1139        public Face() {
1140        }
1141
1142        /**
1143         * Bounds of the face. (-1000, -1000) represents the top-left of the
1144         * camera field of view, and (1000, 1000) represents the bottom-right of
1145         * the field of view. For example, suppose the size of the viewfinder UI
1146         * is 800x480. The rect passed from the driver is (-1000, -1000, 0, 0).
1147         * The corresponding viewfinder rect should be (0, 0, 400, 240). The
1148         * width and height of the rect will not be 0 or negative. The
1149         * coordinates can be smaller than -1000 or bigger than 1000. But at
1150         * least one vertex will be within (-1000, -1000) and (1000, 1000).
1151         *
1152         * <p>The direction is relative to the sensor orientation, that is, what
1153         * the sensor sees. The direction is not affected by the rotation or
1154         * mirroring of {@link #setDisplayOrientation(int)}.</p>
1155         *
1156         * @see #startFaceDetection()
1157         */
1158        public Rect rect;
1159
1160        /**
1161         * The confidence level for the detection of the face. The range is 1 to 100. 100 is the
1162         * highest confidence.
1163         *
1164         * @see #startFaceDetection()
1165         */
1166        public int score;
1167
1168        /**
1169         * An unique id per face while the face is visible to the tracker. If
1170         * the face leaves the field-of-view and comes back, it will get a new
1171         * id. This is an optional field, may not be supported on all devices.
1172         * If not supported, id will always be set to -1. The optional fields
1173         * are supported as a set. Either they are all valid, or none of them
1174         * are.
1175         */
1176        public int id = -1;
1177
1178        /**
1179         * The coordinates of the center of the left eye. The coordinates are in
1180         * the same space as the ones for {@link #rect}. This is an optional
1181         * field, may not be supported on all devices. If not supported, the
1182         * value will always be set to null. The optional fields are supported
1183         * as a set. Either they are all valid, or none of them are.
1184         */
1185        public Point leftEye = null;
1186
1187        /**
1188         * The coordinates of the center of the right eye. The coordinates are
1189         * in the same space as the ones for {@link #rect}.This is an optional
1190         * field, may not be supported on all devices. If not supported, the
1191         * value will always be set to null. The optional fields are supported
1192         * as a set. Either they are all valid, or none of them are.
1193         */
1194        public Point rightEye = null;
1195
1196        /**
1197         * The coordinates of the center of the mouth.  The coordinates are in
1198         * the same space as the ones for {@link #rect}. This is an optional
1199         * field, may not be supported on all devices. If not supported, the
1200         * value will always be set to null. The optional fields are supported
1201         * as a set. Either they are all valid, or none of them are.
1202         */
1203        public Point mouth = null;
1204    }
1205
1206    // Error codes match the enum in include/ui/Camera.h
1207
1208    /**
1209     * Unspecified camera error.
1210     * @see Camera.ErrorCallback
1211     */
1212    public static final int CAMERA_ERROR_UNKNOWN = 1;
1213
1214    /**
1215     * Media server died. In this case, the application must release the
1216     * Camera object and instantiate a new one.
1217     * @see Camera.ErrorCallback
1218     */
1219    public static final int CAMERA_ERROR_SERVER_DIED = 100;
1220
1221    /**
1222     * Callback interface for camera error notification.
1223     *
1224     * @see #setErrorCallback(ErrorCallback)
1225     */
1226    public interface ErrorCallback
1227    {
1228        /**
1229         * Callback for camera errors.
1230         * @param error   error code:
1231         * <ul>
1232         * <li>{@link #CAMERA_ERROR_UNKNOWN}
1233         * <li>{@link #CAMERA_ERROR_SERVER_DIED}
1234         * </ul>
1235         * @param camera  the Camera service object
1236         */
1237        void onError(int error, Camera camera);
1238    };
1239
1240    /**
1241     * Registers a callback to be invoked when an error occurs.
1242     * @param cb The callback to run
1243     */
1244    public final void setErrorCallback(ErrorCallback cb)
1245    {
1246        mErrorCallback = cb;
1247    }
1248
1249    private native final void native_setParameters(String params);
1250    private native final String native_getParameters();
1251
1252    /**
1253     * Changes the settings for this Camera service.
1254     *
1255     * @param params the Parameters to use for this Camera service
1256     * @throws RuntimeException if any parameter is invalid or not supported.
1257     * @see #getParameters()
1258     */
1259    public void setParameters(Parameters params) {
1260        native_setParameters(params.flatten());
1261    }
1262
1263    /**
1264     * Returns the current settings for this Camera service.
1265     * If modifications are made to the returned Parameters, they must be passed
1266     * to {@link #setParameters(Camera.Parameters)} to take effect.
1267     *
1268     * @see #setParameters(Camera.Parameters)
1269     */
1270    public Parameters getParameters() {
1271        Parameters p = new Parameters();
1272        String s = native_getParameters();
1273        p.unflatten(s);
1274        return p;
1275    }
1276
1277    /**
1278     * Image size (width and height dimensions).
1279     */
1280    public class Size {
1281        /**
1282         * Sets the dimensions for pictures.
1283         *
1284         * @param w the photo width (pixels)
1285         * @param h the photo height (pixels)
1286         */
1287        public Size(int w, int h) {
1288            width = w;
1289            height = h;
1290        }
1291        /**
1292         * Compares {@code obj} to this size.
1293         *
1294         * @param obj the object to compare this size with.
1295         * @return {@code true} if the width and height of {@code obj} is the
1296         *         same as those of this size. {@code false} otherwise.
1297         */
1298        @Override
1299        public boolean equals(Object obj) {
1300            if (!(obj instanceof Size)) {
1301                return false;
1302            }
1303            Size s = (Size) obj;
1304            return width == s.width && height == s.height;
1305        }
1306        @Override
1307        public int hashCode() {
1308            return width * 32713 + height;
1309        }
1310        /** width of the picture */
1311        public int width;
1312        /** height of the picture */
1313        public int height;
1314    };
1315
1316    /**
1317     * <p>The Area class is used for choosing specific metering and focus areas for
1318     * the camera to use when calculating auto-exposure, auto-white balance, and
1319     * auto-focus.</p>
1320     *
1321     * <p>To find out how many simultaneous areas a given camera supports, use
1322     * {@link Parameters#getMaxNumMeteringAreas()} and
1323     * {@link Parameters#getMaxNumFocusAreas()}. If metering or focusing area
1324     * selection is unsupported, these methods will return 0.</p>
1325     *
1326     * <p>Each Area consists of a rectangle specifying its bounds, and a weight
1327     * that determines its importance. The bounds are relative to the camera's
1328     * current field of view. The coordinates are mapped so that (-1000, -1000)
1329     * is always the top-left corner of the current field of view, and (1000,
1330     * 1000) is always the bottom-right corner of the current field of
1331     * view. Setting Areas with bounds outside that range is not allowed. Areas
1332     * with zero or negative width or height are not allowed.</p>
1333     *
1334     * <p>The weight must range from 1 to 1000, and represents a weight for
1335     * every pixel in the area. This means that a large metering area with
1336     * the same weight as a smaller area will have more effect in the
1337     * metering result.  Metering areas can overlap and the driver
1338     * will add the weights in the overlap region.</p>
1339     *
1340     * @see Parameters#setFocusAreas(List)
1341     * @see Parameters#getFocusAreas()
1342     * @see Parameters#getMaxNumFocusAreas()
1343     * @see Parameters#setMeteringAreas(List)
1344     * @see Parameters#getMeteringAreas()
1345     * @see Parameters#getMaxNumMeteringAreas()
1346     */
1347    public static class Area {
1348        /**
1349         * Create an area with specified rectangle and weight.
1350         *
1351         * @param rect the bounds of the area.
1352         * @param weight the weight of the area.
1353         */
1354        public Area(Rect rect, int weight) {
1355            this.rect = rect;
1356            this.weight = weight;
1357        }
1358        /**
1359         * Compares {@code obj} to this area.
1360         *
1361         * @param obj the object to compare this area with.
1362         * @return {@code true} if the rectangle and weight of {@code obj} is
1363         *         the same as those of this area. {@code false} otherwise.
1364         */
1365        @Override
1366        public boolean equals(Object obj) {
1367            if (!(obj instanceof Area)) {
1368                return false;
1369            }
1370            Area a = (Area) obj;
1371            if (rect == null) {
1372                if (a.rect != null) return false;
1373            } else {
1374                if (!rect.equals(a.rect)) return false;
1375            }
1376            return weight == a.weight;
1377        }
1378
1379        /**
1380         * Bounds of the area. (-1000, -1000) represents the top-left of the
1381         * camera field of view, and (1000, 1000) represents the bottom-right of
1382         * the field of view. Setting bounds outside that range is not
1383         * allowed. Bounds with zero or negative width or height are not
1384         * allowed.
1385         *
1386         * @see Parameters#getFocusAreas()
1387         * @see Parameters#getMeteringAreas()
1388         */
1389        public Rect rect;
1390
1391        /**
1392         * Weight of the area. The weight must range from 1 to 1000, and
1393         * represents a weight for every pixel in the area. This means that a
1394         * large metering area with the same weight as a smaller area will have
1395         * more effect in the metering result.  Metering areas can overlap and
1396         * the driver will add the weights in the overlap region.
1397         *
1398         * @see Parameters#getFocusAreas()
1399         * @see Parameters#getMeteringAreas()
1400         */
1401        public int weight;
1402    }
1403
1404    /**
1405     * Camera service settings.
1406     *
1407     * <p>To make camera parameters take effect, applications have to call
1408     * {@link Camera#setParameters(Camera.Parameters)}. For example, after
1409     * {@link Camera.Parameters#setWhiteBalance} is called, white balance is not
1410     * actually changed until {@link Camera#setParameters(Camera.Parameters)}
1411     * is called with the changed parameters object.
1412     *
1413     * <p>Different devices may have different camera capabilities, such as
1414     * picture size or flash modes. The application should query the camera
1415     * capabilities before setting parameters. For example, the application
1416     * should call {@link Camera.Parameters#getSupportedColorEffects()} before
1417     * calling {@link Camera.Parameters#setColorEffect(String)}. If the
1418     * camera does not support color effects,
1419     * {@link Camera.Parameters#getSupportedColorEffects()} will return null.
1420     */
1421    public class Parameters {
1422        // Parameter keys to communicate with the camera driver.
1423        private static final String KEY_PREVIEW_SIZE = "preview-size";
1424        private static final String KEY_PREVIEW_FORMAT = "preview-format";
1425        private static final String KEY_PREVIEW_FRAME_RATE = "preview-frame-rate";
1426        private static final String KEY_PREVIEW_FPS_RANGE = "preview-fps-range";
1427        private static final String KEY_PICTURE_SIZE = "picture-size";
1428        private static final String KEY_PICTURE_FORMAT = "picture-format";
1429        private static final String KEY_JPEG_THUMBNAIL_SIZE = "jpeg-thumbnail-size";
1430        private static final String KEY_JPEG_THUMBNAIL_WIDTH = "jpeg-thumbnail-width";
1431        private static final String KEY_JPEG_THUMBNAIL_HEIGHT = "jpeg-thumbnail-height";
1432        private static final String KEY_JPEG_THUMBNAIL_QUALITY = "jpeg-thumbnail-quality";
1433        private static final String KEY_JPEG_QUALITY = "jpeg-quality";
1434        private static final String KEY_ROTATION = "rotation";
1435        private static final String KEY_GPS_LATITUDE = "gps-latitude";
1436        private static final String KEY_GPS_LONGITUDE = "gps-longitude";
1437        private static final String KEY_GPS_ALTITUDE = "gps-altitude";
1438        private static final String KEY_GPS_TIMESTAMP = "gps-timestamp";
1439        private static final String KEY_GPS_PROCESSING_METHOD = "gps-processing-method";
1440        private static final String KEY_WHITE_BALANCE = "whitebalance";
1441        private static final String KEY_EFFECT = "effect";
1442        private static final String KEY_ANTIBANDING = "antibanding";
1443        private static final String KEY_SCENE_MODE = "scene-mode";
1444        private static final String KEY_FLASH_MODE = "flash-mode";
1445        private static final String KEY_FOCUS_MODE = "focus-mode";
1446        private static final String KEY_FOCUS_AREAS = "focus-areas";
1447        private static final String KEY_MAX_NUM_FOCUS_AREAS = "max-num-focus-areas";
1448        private static final String KEY_FOCAL_LENGTH = "focal-length";
1449        private static final String KEY_HORIZONTAL_VIEW_ANGLE = "horizontal-view-angle";
1450        private static final String KEY_VERTICAL_VIEW_ANGLE = "vertical-view-angle";
1451        private static final String KEY_EXPOSURE_COMPENSATION = "exposure-compensation";
1452        private static final String KEY_MAX_EXPOSURE_COMPENSATION = "max-exposure-compensation";
1453        private static final String KEY_MIN_EXPOSURE_COMPENSATION = "min-exposure-compensation";
1454        private static final String KEY_EXPOSURE_COMPENSATION_STEP = "exposure-compensation-step";
1455        private static final String KEY_AUTO_EXPOSURE_LOCK = "auto-exposure-lock";
1456        private static final String KEY_AUTO_EXPOSURE_LOCK_SUPPORTED = "auto-exposure-lock-supported";
1457        private static final String KEY_AUTO_WHITEBALANCE_LOCK = "auto-whitebalance-lock";
1458        private static final String KEY_AUTO_WHITEBALANCE_LOCK_SUPPORTED = "auto-whitebalance-lock-supported";
1459        private static final String KEY_METERING_AREAS = "metering-areas";
1460        private static final String KEY_MAX_NUM_METERING_AREAS = "max-num-metering-areas";
1461        private static final String KEY_ZOOM = "zoom";
1462        private static final String KEY_MAX_ZOOM = "max-zoom";
1463        private static final String KEY_ZOOM_RATIOS = "zoom-ratios";
1464        private static final String KEY_ZOOM_SUPPORTED = "zoom-supported";
1465        private static final String KEY_SMOOTH_ZOOM_SUPPORTED = "smooth-zoom-supported";
1466        private static final String KEY_FOCUS_DISTANCES = "focus-distances";
1467        private static final String KEY_VIDEO_SIZE = "video-size";
1468        private static final String KEY_PREFERRED_PREVIEW_SIZE_FOR_VIDEO =
1469                                            "preferred-preview-size-for-video";
1470        private static final String KEY_MAX_NUM_DETECTED_FACES_HW = "max-num-detected-faces-hw";
1471        private static final String KEY_MAX_NUM_DETECTED_FACES_SW = "max-num-detected-faces-sw";
1472        private static final String KEY_RECORDING_HINT = "recording-hint";
1473        private static final String KEY_VIDEO_SNAPSHOT_SUPPORTED = "video-snapshot-supported";
1474        private static final String KEY_VIDEO_STABILIZATION = "video-stabilization";
1475        private static final String KEY_VIDEO_STABILIZATION_SUPPORTED = "video-stabilization-supported";
1476
1477        // Parameter key suffix for supported values.
1478        private static final String SUPPORTED_VALUES_SUFFIX = "-values";
1479
1480        private static final String TRUE = "true";
1481        private static final String FALSE = "false";
1482
1483        // Values for white balance settings.
1484        public static final String WHITE_BALANCE_AUTO = "auto";
1485        public static final String WHITE_BALANCE_INCANDESCENT = "incandescent";
1486        public static final String WHITE_BALANCE_FLUORESCENT = "fluorescent";
1487        public static final String WHITE_BALANCE_WARM_FLUORESCENT = "warm-fluorescent";
1488        public static final String WHITE_BALANCE_DAYLIGHT = "daylight";
1489        public static final String WHITE_BALANCE_CLOUDY_DAYLIGHT = "cloudy-daylight";
1490        public static final String WHITE_BALANCE_TWILIGHT = "twilight";
1491        public static final String WHITE_BALANCE_SHADE = "shade";
1492
1493        // Values for color effect settings.
1494        public static final String EFFECT_NONE = "none";
1495        public static final String EFFECT_MONO = "mono";
1496        public static final String EFFECT_NEGATIVE = "negative";
1497        public static final String EFFECT_SOLARIZE = "solarize";
1498        public static final String EFFECT_SEPIA = "sepia";
1499        public static final String EFFECT_POSTERIZE = "posterize";
1500        public static final String EFFECT_WHITEBOARD = "whiteboard";
1501        public static final String EFFECT_BLACKBOARD = "blackboard";
1502        public static final String EFFECT_AQUA = "aqua";
1503
1504        // Values for antibanding settings.
1505        public static final String ANTIBANDING_AUTO = "auto";
1506        public static final String ANTIBANDING_50HZ = "50hz";
1507        public static final String ANTIBANDING_60HZ = "60hz";
1508        public static final String ANTIBANDING_OFF = "off";
1509
1510        // Values for flash mode settings.
1511        /**
1512         * Flash will not be fired.
1513         */
1514        public static final String FLASH_MODE_OFF = "off";
1515
1516        /**
1517         * Flash will be fired automatically when required. The flash may be fired
1518         * during preview, auto-focus, or snapshot depending on the driver.
1519         */
1520        public static final String FLASH_MODE_AUTO = "auto";
1521
1522        /**
1523         * Flash will always be fired during snapshot. The flash may also be
1524         * fired during preview or auto-focus depending on the driver.
1525         */
1526        public static final String FLASH_MODE_ON = "on";
1527
1528        /**
1529         * Flash will be fired in red-eye reduction mode.
1530         */
1531        public static final String FLASH_MODE_RED_EYE = "red-eye";
1532
1533        /**
1534         * Constant emission of light during preview, auto-focus and snapshot.
1535         * This can also be used for video recording.
1536         */
1537        public static final String FLASH_MODE_TORCH = "torch";
1538
1539        /**
1540         * Scene mode is off.
1541         */
1542        public static final String SCENE_MODE_AUTO = "auto";
1543
1544        /**
1545         * Take photos of fast moving objects. Same as {@link
1546         * #SCENE_MODE_SPORTS}.
1547         */
1548        public static final String SCENE_MODE_ACTION = "action";
1549
1550        /**
1551         * Take people pictures.
1552         */
1553        public static final String SCENE_MODE_PORTRAIT = "portrait";
1554
1555        /**
1556         * Take pictures on distant objects.
1557         */
1558        public static final String SCENE_MODE_LANDSCAPE = "landscape";
1559
1560        /**
1561         * Take photos at night.
1562         */
1563        public static final String SCENE_MODE_NIGHT = "night";
1564
1565        /**
1566         * Take people pictures at night.
1567         */
1568        public static final String SCENE_MODE_NIGHT_PORTRAIT = "night-portrait";
1569
1570        /**
1571         * Take photos in a theater. Flash light is off.
1572         */
1573        public static final String SCENE_MODE_THEATRE = "theatre";
1574
1575        /**
1576         * Take pictures on the beach.
1577         */
1578        public static final String SCENE_MODE_BEACH = "beach";
1579
1580        /**
1581         * Take pictures on the snow.
1582         */
1583        public static final String SCENE_MODE_SNOW = "snow";
1584
1585        /**
1586         * Take sunset photos.
1587         */
1588        public static final String SCENE_MODE_SUNSET = "sunset";
1589
1590        /**
1591         * Avoid blurry pictures (for example, due to hand shake).
1592         */
1593        public static final String SCENE_MODE_STEADYPHOTO = "steadyphoto";
1594
1595        /**
1596         * For shooting firework displays.
1597         */
1598        public static final String SCENE_MODE_FIREWORKS = "fireworks";
1599
1600        /**
1601         * Take photos of fast moving objects. Same as {@link
1602         * #SCENE_MODE_ACTION}.
1603         */
1604        public static final String SCENE_MODE_SPORTS = "sports";
1605
1606        /**
1607         * Take indoor low-light shot.
1608         */
1609        public static final String SCENE_MODE_PARTY = "party";
1610
1611        /**
1612         * Capture the naturally warm color of scenes lit by candles.
1613         */
1614        public static final String SCENE_MODE_CANDLELIGHT = "candlelight";
1615
1616        /**
1617         * Applications are looking for a barcode. Camera driver will be
1618         * optimized for barcode reading.
1619         */
1620        public static final String SCENE_MODE_BARCODE = "barcode";
1621
1622        /**
1623         * Auto-focus mode. Applications should call {@link
1624         * #autoFocus(AutoFocusCallback)} to start the focus in this mode.
1625         */
1626        public static final String FOCUS_MODE_AUTO = "auto";
1627
1628        /**
1629         * Focus is set at infinity. Applications should not call
1630         * {@link #autoFocus(AutoFocusCallback)} in this mode.
1631         */
1632        public static final String FOCUS_MODE_INFINITY = "infinity";
1633
1634        /**
1635         * Macro (close-up) focus mode. Applications should call
1636         * {@link #autoFocus(AutoFocusCallback)} to start the focus in this
1637         * mode.
1638         */
1639        public static final String FOCUS_MODE_MACRO = "macro";
1640
1641        /**
1642         * Focus is fixed. The camera is always in this mode if the focus is not
1643         * adjustable. If the camera has auto-focus, this mode can fix the
1644         * focus, which is usually at hyperfocal distance. Applications should
1645         * not call {@link #autoFocus(AutoFocusCallback)} in this mode.
1646         */
1647        public static final String FOCUS_MODE_FIXED = "fixed";
1648
1649        /**
1650         * Extended depth of field (EDOF). Focusing is done digitally and
1651         * continuously. Applications should not call {@link
1652         * #autoFocus(AutoFocusCallback)} in this mode.
1653         */
1654        public static final String FOCUS_MODE_EDOF = "edof";
1655
1656        /**
1657         * Continuous auto focus mode intended for video recording. The camera
1658         * continuously tries to focus. This is the best choice for video
1659         * recording because the focus changes smoothly . Applications still can
1660         * call {@link #takePicture(Camera.ShutterCallback,
1661         * Camera.PictureCallback, Camera.PictureCallback)} in this mode but the
1662         * subject may not be in focus. Auto focus starts when the parameter is
1663         * set.
1664         *
1665         * <p>Since API level 14, applications can call {@link
1666         * #autoFocus(AutoFocusCallback)} in this mode. The focus callback will
1667         * immediately return with a boolean that indicates whether the focus is
1668         * sharp or not. The focus position is locked after autoFocus call. If
1669         * applications want to resume the continuous focus, cancelAutoFocus
1670         * must be called. Restarting the preview will not resume the continuous
1671         * autofocus. To stop continuous focus, applications should change the
1672         * focus mode to other modes.
1673         *
1674         * @see #FOCUS_MODE_CONTINUOUS_PICTURE
1675         */
1676        public static final String FOCUS_MODE_CONTINUOUS_VIDEO = "continuous-video";
1677
1678        /**
1679         * Continuous auto focus mode intended for taking pictures. The camera
1680         * continuously tries to focus. The speed of focus change is more
1681         * aggressive than {@link #FOCUS_MODE_CONTINUOUS_VIDEO}. Auto focus
1682         * starts when the parameter is set.
1683         *
1684         * <p>If applications call {@link #autoFocus(AutoFocusCallback)} in this
1685         * mode, the focus callback will immediately return with a boolean that
1686         * indicates whether the focus is sharp or not. The apps can then decide
1687         * if they want to take a picture immediately or to change the focus
1688         * mode to auto, and run a full autofocus cycle. The focus position is
1689         * locked after autoFocus call. If applications want to resume the
1690         * continuous focus, cancelAutoFocus must be called. Restarting the
1691         * preview will not resume the continuous autofocus. To stop continuous
1692         * focus, applications should change the focus mode to other modes.
1693         *
1694         * @see #FOCUS_MODE_CONTINUOUS_VIDEO
1695         */
1696        public static final String FOCUS_MODE_CONTINUOUS_PICTURE = "continuous-picture";
1697
1698        // Indices for focus distance array.
1699        /**
1700         * The array index of near focus distance for use with
1701         * {@link #getFocusDistances(float[])}.
1702         */
1703        public static final int FOCUS_DISTANCE_NEAR_INDEX = 0;
1704
1705        /**
1706         * The array index of optimal focus distance for use with
1707         * {@link #getFocusDistances(float[])}.
1708         */
1709        public static final int FOCUS_DISTANCE_OPTIMAL_INDEX = 1;
1710
1711        /**
1712         * The array index of far focus distance for use with
1713         * {@link #getFocusDistances(float[])}.
1714         */
1715        public static final int FOCUS_DISTANCE_FAR_INDEX = 2;
1716
1717        /**
1718         * The array index of minimum preview fps for use with {@link
1719         * #getPreviewFpsRange(int[])} or {@link
1720         * #getSupportedPreviewFpsRange()}.
1721         */
1722        public static final int PREVIEW_FPS_MIN_INDEX = 0;
1723
1724        /**
1725         * The array index of maximum preview fps for use with {@link
1726         * #getPreviewFpsRange(int[])} or {@link
1727         * #getSupportedPreviewFpsRange()}.
1728         */
1729        public static final int PREVIEW_FPS_MAX_INDEX = 1;
1730
1731        // Formats for setPreviewFormat and setPictureFormat.
1732        private static final String PIXEL_FORMAT_YUV422SP = "yuv422sp";
1733        private static final String PIXEL_FORMAT_YUV420SP = "yuv420sp";
1734        private static final String PIXEL_FORMAT_YUV422I = "yuv422i-yuyv";
1735        private static final String PIXEL_FORMAT_YUV420P = "yuv420p";
1736        private static final String PIXEL_FORMAT_RGB565 = "rgb565";
1737        private static final String PIXEL_FORMAT_JPEG = "jpeg";
1738        private static final String PIXEL_FORMAT_BAYER_RGGB = "bayer-rggb";
1739
1740        private HashMap<String, String> mMap;
1741
1742        private Parameters() {
1743            mMap = new HashMap<String, String>();
1744        }
1745
1746        /**
1747         * Writes the current Parameters to the log.
1748         * @hide
1749         * @deprecated
1750         */
1751        public void dump() {
1752            Log.e(TAG, "dump: size=" + mMap.size());
1753            for (String k : mMap.keySet()) {
1754                Log.e(TAG, "dump: " + k + "=" + mMap.get(k));
1755            }
1756        }
1757
1758        /**
1759         * Creates a single string with all the parameters set in
1760         * this Parameters object.
1761         * <p>The {@link #unflatten(String)} method does the reverse.</p>
1762         *
1763         * @return a String with all values from this Parameters object, in
1764         *         semi-colon delimited key-value pairs
1765         */
1766        public String flatten() {
1767            StringBuilder flattened = new StringBuilder();
1768            for (String k : mMap.keySet()) {
1769                flattened.append(k);
1770                flattened.append("=");
1771                flattened.append(mMap.get(k));
1772                flattened.append(";");
1773            }
1774            // chop off the extra semicolon at the end
1775            flattened.deleteCharAt(flattened.length()-1);
1776            return flattened.toString();
1777        }
1778
1779        /**
1780         * Takes a flattened string of parameters and adds each one to
1781         * this Parameters object.
1782         * <p>The {@link #flatten()} method does the reverse.</p>
1783         *
1784         * @param flattened a String of parameters (key-value paired) that
1785         *                  are semi-colon delimited
1786         */
1787        public void unflatten(String flattened) {
1788            mMap.clear();
1789
1790            StringTokenizer tokenizer = new StringTokenizer(flattened, ";");
1791            while (tokenizer.hasMoreElements()) {
1792                String kv = tokenizer.nextToken();
1793                int pos = kv.indexOf('=');
1794                if (pos == -1) {
1795                    continue;
1796                }
1797                String k = kv.substring(0, pos);
1798                String v = kv.substring(pos + 1);
1799                mMap.put(k, v);
1800            }
1801        }
1802
1803        public void remove(String key) {
1804            mMap.remove(key);
1805        }
1806
1807        /**
1808         * Sets a String parameter.
1809         *
1810         * @param key   the key name for the parameter
1811         * @param value the String value of the parameter
1812         */
1813        public void set(String key, String value) {
1814            if (key.indexOf('=') != -1 || key.indexOf(';') != -1) {
1815                Log.e(TAG, "Key \"" + key + "\" contains invalid character (= or ;)");
1816                return;
1817            }
1818            if (value.indexOf('=') != -1 || value.indexOf(';') != -1) {
1819                Log.e(TAG, "Value \"" + value + "\" contains invalid character (= or ;)");
1820                return;
1821            }
1822
1823            mMap.put(key, value);
1824        }
1825
1826        /**
1827         * Sets an integer parameter.
1828         *
1829         * @param key   the key name for the parameter
1830         * @param value the int value of the parameter
1831         */
1832        public void set(String key, int value) {
1833            mMap.put(key, Integer.toString(value));
1834        }
1835
1836        private void set(String key, List<Area> areas) {
1837            if (areas == null) {
1838                set(key, "(0,0,0,0,0)");
1839            } else {
1840                StringBuilder buffer = new StringBuilder();
1841                for (int i = 0; i < areas.size(); i++) {
1842                    Area area = areas.get(i);
1843                    Rect rect = area.rect;
1844                    buffer.append('(');
1845                    buffer.append(rect.left);
1846                    buffer.append(',');
1847                    buffer.append(rect.top);
1848                    buffer.append(',');
1849                    buffer.append(rect.right);
1850                    buffer.append(',');
1851                    buffer.append(rect.bottom);
1852                    buffer.append(',');
1853                    buffer.append(area.weight);
1854                    buffer.append(')');
1855                    if (i != areas.size() - 1) buffer.append(',');
1856                }
1857                set(key, buffer.toString());
1858            }
1859        }
1860
1861        /**
1862         * Returns the value of a String parameter.
1863         *
1864         * @param key the key name for the parameter
1865         * @return the String value of the parameter
1866         */
1867        public String get(String key) {
1868            return mMap.get(key);
1869        }
1870
1871        /**
1872         * Returns the value of an integer parameter.
1873         *
1874         * @param key the key name for the parameter
1875         * @return the int value of the parameter
1876         */
1877        public int getInt(String key) {
1878            return Integer.parseInt(mMap.get(key));
1879        }
1880
1881        /**
1882         * Sets the dimensions for preview pictures. If the preview has already
1883         * started, applications should stop the preview first before changing
1884         * preview size.
1885         *
1886         * The sides of width and height are based on camera orientation. That
1887         * is, the preview size is the size before it is rotated by display
1888         * orientation. So applications need to consider the display orientation
1889         * while setting preview size. For example, suppose the camera supports
1890         * both 480x320 and 320x480 preview sizes. The application wants a 3:2
1891         * preview ratio. If the display orientation is set to 0 or 180, preview
1892         * size should be set to 480x320. If the display orientation is set to
1893         * 90 or 270, preview size should be set to 320x480. The display
1894         * orientation should also be considered while setting picture size and
1895         * thumbnail size.
1896         *
1897         * @param width  the width of the pictures, in pixels
1898         * @param height the height of the pictures, in pixels
1899         * @see #setDisplayOrientation(int)
1900         * @see #getCameraInfo(int, CameraInfo)
1901         * @see #setPictureSize(int, int)
1902         * @see #setJpegThumbnailSize(int, int)
1903         */
1904        public void setPreviewSize(int width, int height) {
1905            String v = Integer.toString(width) + "x" + Integer.toString(height);
1906            set(KEY_PREVIEW_SIZE, v);
1907        }
1908
1909        /**
1910         * Returns the dimensions setting for preview pictures.
1911         *
1912         * @return a Size object with the width and height setting
1913         *          for the preview picture
1914         */
1915        public Size getPreviewSize() {
1916            String pair = get(KEY_PREVIEW_SIZE);
1917            return strToSize(pair);
1918        }
1919
1920        /**
1921         * Gets the supported preview sizes.
1922         *
1923         * @return a list of Size object. This method will always return a list
1924         *         with at least one element.
1925         */
1926        public List<Size> getSupportedPreviewSizes() {
1927            String str = get(KEY_PREVIEW_SIZE + SUPPORTED_VALUES_SUFFIX);
1928            return splitSize(str);
1929        }
1930
1931        /**
1932         * <p>Gets the supported video frame sizes that can be used by
1933         * MediaRecorder.</p>
1934         *
1935         * <p>If the returned list is not null, the returned list will contain at
1936         * least one Size and one of the sizes in the returned list must be
1937         * passed to MediaRecorder.setVideoSize() for camcorder application if
1938         * camera is used as the video source. In this case, the size of the
1939         * preview can be different from the resolution of the recorded video
1940         * during video recording.</p>
1941         *
1942         * @return a list of Size object if camera has separate preview and
1943         *         video output; otherwise, null is returned.
1944         * @see #getPreferredPreviewSizeForVideo()
1945         */
1946        public List<Size> getSupportedVideoSizes() {
1947            String str = get(KEY_VIDEO_SIZE + SUPPORTED_VALUES_SUFFIX);
1948            return splitSize(str);
1949        }
1950
1951        /**
1952         * Returns the preferred or recommended preview size (width and height)
1953         * in pixels for video recording. Camcorder applications should
1954         * set the preview size to a value that is not larger than the
1955         * preferred preview size. In other words, the product of the width
1956         * and height of the preview size should not be larger than that of
1957         * the preferred preview size. In addition, we recommend to choose a
1958         * preview size that has the same aspect ratio as the resolution of
1959         * video to be recorded.
1960         *
1961         * @return the preferred preview size (width and height) in pixels for
1962         *         video recording if getSupportedVideoSizes() does not return
1963         *         null; otherwise, null is returned.
1964         * @see #getSupportedVideoSizes()
1965         */
1966        public Size getPreferredPreviewSizeForVideo() {
1967            String pair = get(KEY_PREFERRED_PREVIEW_SIZE_FOR_VIDEO);
1968            return strToSize(pair);
1969        }
1970
1971        /**
1972         * <p>Sets the dimensions for EXIF thumbnail in Jpeg picture. If
1973         * applications set both width and height to 0, EXIF will not contain
1974         * thumbnail.</p>
1975         *
1976         * <p>Applications need to consider the display orientation. See {@link
1977         * #setPreviewSize(int,int)} for reference.</p>
1978         *
1979         * @param width  the width of the thumbnail, in pixels
1980         * @param height the height of the thumbnail, in pixels
1981         * @see #setPreviewSize(int,int)
1982         */
1983        public void setJpegThumbnailSize(int width, int height) {
1984            set(KEY_JPEG_THUMBNAIL_WIDTH, width);
1985            set(KEY_JPEG_THUMBNAIL_HEIGHT, height);
1986        }
1987
1988        /**
1989         * Returns the dimensions for EXIF thumbnail in Jpeg picture.
1990         *
1991         * @return a Size object with the height and width setting for the EXIF
1992         *         thumbnails
1993         */
1994        public Size getJpegThumbnailSize() {
1995            return new Size(getInt(KEY_JPEG_THUMBNAIL_WIDTH),
1996                            getInt(KEY_JPEG_THUMBNAIL_HEIGHT));
1997        }
1998
1999        /**
2000         * Gets the supported jpeg thumbnail sizes.
2001         *
2002         * @return a list of Size object. This method will always return a list
2003         *         with at least two elements. Size 0,0 (no thumbnail) is always
2004         *         supported.
2005         */
2006        public List<Size> getSupportedJpegThumbnailSizes() {
2007            String str = get(KEY_JPEG_THUMBNAIL_SIZE + SUPPORTED_VALUES_SUFFIX);
2008            return splitSize(str);
2009        }
2010
2011        /**
2012         * Sets the quality of the EXIF thumbnail in Jpeg picture.
2013         *
2014         * @param quality the JPEG quality of the EXIF thumbnail. The range is 1
2015         *                to 100, with 100 being the best.
2016         */
2017        public void setJpegThumbnailQuality(int quality) {
2018            set(KEY_JPEG_THUMBNAIL_QUALITY, quality);
2019        }
2020
2021        /**
2022         * Returns the quality setting for the EXIF thumbnail in Jpeg picture.
2023         *
2024         * @return the JPEG quality setting of the EXIF thumbnail.
2025         */
2026        public int getJpegThumbnailQuality() {
2027            return getInt(KEY_JPEG_THUMBNAIL_QUALITY);
2028        }
2029
2030        /**
2031         * Sets Jpeg quality of captured picture.
2032         *
2033         * @param quality the JPEG quality of captured picture. The range is 1
2034         *                to 100, with 100 being the best.
2035         */
2036        public void setJpegQuality(int quality) {
2037            set(KEY_JPEG_QUALITY, quality);
2038        }
2039
2040        /**
2041         * Returns the quality setting for the JPEG picture.
2042         *
2043         * @return the JPEG picture quality setting.
2044         */
2045        public int getJpegQuality() {
2046            return getInt(KEY_JPEG_QUALITY);
2047        }
2048
2049        /**
2050         * Sets the rate at which preview frames are received. This is the
2051         * target frame rate. The actual frame rate depends on the driver.
2052         *
2053         * @param fps the frame rate (frames per second)
2054         * @deprecated replaced by {@link #setPreviewFpsRange(int,int)}
2055         */
2056        @Deprecated
2057        public void setPreviewFrameRate(int fps) {
2058            set(KEY_PREVIEW_FRAME_RATE, fps);
2059        }
2060
2061        /**
2062         * Returns the setting for the rate at which preview frames are
2063         * received. This is the target frame rate. The actual frame rate
2064         * depends on the driver.
2065         *
2066         * @return the frame rate setting (frames per second)
2067         * @deprecated replaced by {@link #getPreviewFpsRange(int[])}
2068         */
2069        @Deprecated
2070        public int getPreviewFrameRate() {
2071            return getInt(KEY_PREVIEW_FRAME_RATE);
2072        }
2073
2074        /**
2075         * Gets the supported preview frame rates.
2076         *
2077         * @return a list of supported preview frame rates. null if preview
2078         *         frame rate setting is not supported.
2079         * @deprecated replaced by {@link #getSupportedPreviewFpsRange()}
2080         */
2081        @Deprecated
2082        public List<Integer> getSupportedPreviewFrameRates() {
2083            String str = get(KEY_PREVIEW_FRAME_RATE + SUPPORTED_VALUES_SUFFIX);
2084            return splitInt(str);
2085        }
2086
2087        /**
2088         * Sets the maximum and maximum preview fps. This controls the rate of
2089         * preview frames received in {@link PreviewCallback}. The minimum and
2090         * maximum preview fps must be one of the elements from {@link
2091         * #getSupportedPreviewFpsRange}.
2092         *
2093         * @param min the minimum preview fps (scaled by 1000).
2094         * @param max the maximum preview fps (scaled by 1000).
2095         * @throws RuntimeException if fps range is invalid.
2096         * @see #setPreviewCallbackWithBuffer(Camera.PreviewCallback)
2097         * @see #getSupportedPreviewFpsRange()
2098         */
2099        public void setPreviewFpsRange(int min, int max) {
2100            set(KEY_PREVIEW_FPS_RANGE, "" + min + "," + max);
2101        }
2102
2103        /**
2104         * Returns the current minimum and maximum preview fps. The values are
2105         * one of the elements returned by {@link #getSupportedPreviewFpsRange}.
2106         *
2107         * @return range the minimum and maximum preview fps (scaled by 1000).
2108         * @see #PREVIEW_FPS_MIN_INDEX
2109         * @see #PREVIEW_FPS_MAX_INDEX
2110         * @see #getSupportedPreviewFpsRange()
2111         */
2112        public void getPreviewFpsRange(int[] range) {
2113            if (range == null || range.length != 2) {
2114                throw new IllegalArgumentException(
2115                        "range must be an array with two elements.");
2116            }
2117            splitInt(get(KEY_PREVIEW_FPS_RANGE), range);
2118        }
2119
2120        /**
2121         * Gets the supported preview fps (frame-per-second) ranges. Each range
2122         * contains a minimum fps and maximum fps. If minimum fps equals to
2123         * maximum fps, the camera outputs frames in fixed frame rate. If not,
2124         * the camera outputs frames in auto frame rate. The actual frame rate
2125         * fluctuates between the minimum and the maximum. The values are
2126         * multiplied by 1000 and represented in integers. For example, if frame
2127         * rate is 26.623 frames per second, the value is 26623.
2128         *
2129         * @return a list of supported preview fps ranges. This method returns a
2130         *         list with at least one element. Every element is an int array
2131         *         of two values - minimum fps and maximum fps. The list is
2132         *         sorted from small to large (first by maximum fps and then
2133         *         minimum fps).
2134         * @see #PREVIEW_FPS_MIN_INDEX
2135         * @see #PREVIEW_FPS_MAX_INDEX
2136         */
2137        public List<int[]> getSupportedPreviewFpsRange() {
2138            String str = get(KEY_PREVIEW_FPS_RANGE + SUPPORTED_VALUES_SUFFIX);
2139            return splitRange(str);
2140        }
2141
2142        /**
2143         * Sets the image format for preview pictures.
2144         * <p>If this is never called, the default format will be
2145         * {@link android.graphics.ImageFormat#NV21}, which
2146         * uses the NV21 encoding format.</p>
2147         *
2148         * @param pixel_format the desired preview picture format, defined
2149         *   by one of the {@link android.graphics.ImageFormat} constants.
2150         *   (E.g., <var>ImageFormat.NV21</var> (default),
2151         *                      <var>ImageFormat.RGB_565</var>, or
2152         *                      <var>ImageFormat.JPEG</var>)
2153         * @see android.graphics.ImageFormat
2154         */
2155        public void setPreviewFormat(int pixel_format) {
2156            String s = cameraFormatForPixelFormat(pixel_format);
2157            if (s == null) {
2158                throw new IllegalArgumentException(
2159                        "Invalid pixel_format=" + pixel_format);
2160            }
2161
2162            set(KEY_PREVIEW_FORMAT, s);
2163        }
2164
2165        /**
2166         * Returns the image format for preview frames got from
2167         * {@link PreviewCallback}.
2168         *
2169         * @return the preview format.
2170         * @see android.graphics.ImageFormat
2171         */
2172        public int getPreviewFormat() {
2173            return pixelFormatForCameraFormat(get(KEY_PREVIEW_FORMAT));
2174        }
2175
2176        /**
2177         * Gets the supported preview formats. {@link android.graphics.ImageFormat#NV21}
2178         * is always supported. {@link android.graphics.ImageFormat#YV12}
2179         * is always supported since API level 12.
2180         *
2181         * @return a list of supported preview formats. This method will always
2182         *         return a list with at least one element.
2183         * @see android.graphics.ImageFormat
2184         */
2185        public List<Integer> getSupportedPreviewFormats() {
2186            String str = get(KEY_PREVIEW_FORMAT + SUPPORTED_VALUES_SUFFIX);
2187            ArrayList<Integer> formats = new ArrayList<Integer>();
2188            for (String s : split(str)) {
2189                int f = pixelFormatForCameraFormat(s);
2190                if (f == ImageFormat.UNKNOWN) continue;
2191                formats.add(f);
2192            }
2193            return formats;
2194        }
2195
2196        /**
2197         * <p>Sets the dimensions for pictures.</p>
2198         *
2199         * <p>Applications need to consider the display orientation. See {@link
2200         * #setPreviewSize(int,int)} for reference.</p>
2201         *
2202         * @param width  the width for pictures, in pixels
2203         * @param height the height for pictures, in pixels
2204         * @see #setPreviewSize(int,int)
2205         *
2206         */
2207        public void setPictureSize(int width, int height) {
2208            String v = Integer.toString(width) + "x" + Integer.toString(height);
2209            set(KEY_PICTURE_SIZE, v);
2210        }
2211
2212        /**
2213         * Returns the dimension setting for pictures.
2214         *
2215         * @return a Size object with the height and width setting
2216         *          for pictures
2217         */
2218        public Size getPictureSize() {
2219            String pair = get(KEY_PICTURE_SIZE);
2220            return strToSize(pair);
2221        }
2222
2223        /**
2224         * Gets the supported picture sizes.
2225         *
2226         * @return a list of supported picture sizes. This method will always
2227         *         return a list with at least one element.
2228         */
2229        public List<Size> getSupportedPictureSizes() {
2230            String str = get(KEY_PICTURE_SIZE + SUPPORTED_VALUES_SUFFIX);
2231            return splitSize(str);
2232        }
2233
2234        /**
2235         * Sets the image format for pictures.
2236         *
2237         * @param pixel_format the desired picture format
2238         *                     (<var>ImageFormat.NV21</var>,
2239         *                      <var>ImageFormat.RGB_565</var>, or
2240         *                      <var>ImageFormat.JPEG</var>)
2241         * @see android.graphics.ImageFormat
2242         */
2243        public void setPictureFormat(int pixel_format) {
2244            String s = cameraFormatForPixelFormat(pixel_format);
2245            if (s == null) {
2246                throw new IllegalArgumentException(
2247                        "Invalid pixel_format=" + pixel_format);
2248            }
2249
2250            set(KEY_PICTURE_FORMAT, s);
2251        }
2252
2253        /**
2254         * Returns the image format for pictures.
2255         *
2256         * @return the picture format
2257         * @see android.graphics.ImageFormat
2258         */
2259        public int getPictureFormat() {
2260            return pixelFormatForCameraFormat(get(KEY_PICTURE_FORMAT));
2261        }
2262
2263        /**
2264         * Gets the supported picture formats.
2265         *
2266         * @return supported picture formats. This method will always return a
2267         *         list with at least one element.
2268         * @see android.graphics.ImageFormat
2269         */
2270        public List<Integer> getSupportedPictureFormats() {
2271            String str = get(KEY_PICTURE_FORMAT + SUPPORTED_VALUES_SUFFIX);
2272            ArrayList<Integer> formats = new ArrayList<Integer>();
2273            for (String s : split(str)) {
2274                int f = pixelFormatForCameraFormat(s);
2275                if (f == ImageFormat.UNKNOWN) continue;
2276                formats.add(f);
2277            }
2278            return formats;
2279        }
2280
2281        private String cameraFormatForPixelFormat(int pixel_format) {
2282            switch(pixel_format) {
2283            case ImageFormat.NV16:      return PIXEL_FORMAT_YUV422SP;
2284            case ImageFormat.NV21:      return PIXEL_FORMAT_YUV420SP;
2285            case ImageFormat.YUY2:      return PIXEL_FORMAT_YUV422I;
2286            case ImageFormat.YV12:      return PIXEL_FORMAT_YUV420P;
2287            case ImageFormat.RGB_565:   return PIXEL_FORMAT_RGB565;
2288            case ImageFormat.JPEG:      return PIXEL_FORMAT_JPEG;
2289            case ImageFormat.BAYER_RGGB: return PIXEL_FORMAT_BAYER_RGGB;
2290            default:                    return null;
2291            }
2292        }
2293
2294        private int pixelFormatForCameraFormat(String format) {
2295            if (format == null)
2296                return ImageFormat.UNKNOWN;
2297
2298            if (format.equals(PIXEL_FORMAT_YUV422SP))
2299                return ImageFormat.NV16;
2300
2301            if (format.equals(PIXEL_FORMAT_YUV420SP))
2302                return ImageFormat.NV21;
2303
2304            if (format.equals(PIXEL_FORMAT_YUV422I))
2305                return ImageFormat.YUY2;
2306
2307            if (format.equals(PIXEL_FORMAT_YUV420P))
2308                return ImageFormat.YV12;
2309
2310            if (format.equals(PIXEL_FORMAT_RGB565))
2311                return ImageFormat.RGB_565;
2312
2313            if (format.equals(PIXEL_FORMAT_JPEG))
2314                return ImageFormat.JPEG;
2315
2316            return ImageFormat.UNKNOWN;
2317        }
2318
2319        /**
2320         * Sets the rotation angle in degrees relative to the orientation of
2321         * the camera. This affects the pictures returned from JPEG {@link
2322         * PictureCallback}. The camera driver may set orientation in the
2323         * EXIF header without rotating the picture. Or the driver may rotate
2324         * the picture and the EXIF thumbnail. If the Jpeg picture is rotated,
2325         * the orientation in the EXIF header will be missing or 1 (row #0 is
2326         * top and column #0 is left side).
2327         *
2328         * <p>If applications want to rotate the picture to match the orientation
2329         * of what users see, apps should use {@link
2330         * android.view.OrientationEventListener} and {@link CameraInfo}.
2331         * The value from OrientationEventListener is relative to the natural
2332         * orientation of the device. CameraInfo.orientation is the angle
2333         * between camera orientation and natural device orientation. The sum
2334         * of the two is the rotation angle for back-facing camera. The
2335         * difference of the two is the rotation angle for front-facing camera.
2336         * Note that the JPEG pictures of front-facing cameras are not mirrored
2337         * as in preview display.
2338         *
2339         * <p>For example, suppose the natural orientation of the device is
2340         * portrait. The device is rotated 270 degrees clockwise, so the device
2341         * orientation is 270. Suppose a back-facing camera sensor is mounted in
2342         * landscape and the top side of the camera sensor is aligned with the
2343         * right edge of the display in natural orientation. So the camera
2344         * orientation is 90. The rotation should be set to 0 (270 + 90).
2345         *
2346         * <p>The reference code is as follows.
2347         *
2348	 * <pre>
2349         * public void onOrientationChanged(int orientation) {
2350         *     if (orientation == ORIENTATION_UNKNOWN) return;
2351         *     android.hardware.Camera.CameraInfo info =
2352         *            new android.hardware.Camera.CameraInfo();
2353         *     android.hardware.Camera.getCameraInfo(cameraId, info);
2354         *     orientation = (orientation + 45) / 90 * 90;
2355         *     int rotation = 0;
2356         *     if (info.facing == CameraInfo.CAMERA_FACING_FRONT) {
2357         *         rotation = (info.orientation - orientation + 360) % 360;
2358         *     } else {  // back-facing camera
2359         *         rotation = (info.orientation + orientation) % 360;
2360         *     }
2361         *     mParameters.setRotation(rotation);
2362         * }
2363	 * </pre>
2364         *
2365         * @param rotation The rotation angle in degrees relative to the
2366         *                 orientation of the camera. Rotation can only be 0,
2367         *                 90, 180 or 270.
2368         * @throws IllegalArgumentException if rotation value is invalid.
2369         * @see android.view.OrientationEventListener
2370         * @see #getCameraInfo(int, CameraInfo)
2371         */
2372        public void setRotation(int rotation) {
2373            if (rotation == 0 || rotation == 90 || rotation == 180
2374                    || rotation == 270) {
2375                set(KEY_ROTATION, Integer.toString(rotation));
2376            } else {
2377                throw new IllegalArgumentException(
2378                        "Invalid rotation=" + rotation);
2379            }
2380        }
2381
2382        /**
2383         * Sets GPS latitude coordinate. This will be stored in JPEG EXIF
2384         * header.
2385         *
2386         * @param latitude GPS latitude coordinate.
2387         */
2388        public void setGpsLatitude(double latitude) {
2389            set(KEY_GPS_LATITUDE, Double.toString(latitude));
2390        }
2391
2392        /**
2393         * Sets GPS longitude coordinate. This will be stored in JPEG EXIF
2394         * header.
2395         *
2396         * @param longitude GPS longitude coordinate.
2397         */
2398        public void setGpsLongitude(double longitude) {
2399            set(KEY_GPS_LONGITUDE, Double.toString(longitude));
2400        }
2401
2402        /**
2403         * Sets GPS altitude. This will be stored in JPEG EXIF header.
2404         *
2405         * @param altitude GPS altitude in meters.
2406         */
2407        public void setGpsAltitude(double altitude) {
2408            set(KEY_GPS_ALTITUDE, Double.toString(altitude));
2409        }
2410
2411        /**
2412         * Sets GPS timestamp. This will be stored in JPEG EXIF header.
2413         *
2414         * @param timestamp GPS timestamp (UTC in seconds since January 1,
2415         *                  1970).
2416         */
2417        public void setGpsTimestamp(long timestamp) {
2418            set(KEY_GPS_TIMESTAMP, Long.toString(timestamp));
2419        }
2420
2421        /**
2422         * Sets GPS processing method. It will store up to 32 characters
2423         * in JPEG EXIF header.
2424         *
2425         * @param processing_method The processing method to get this location.
2426         */
2427        public void setGpsProcessingMethod(String processing_method) {
2428            set(KEY_GPS_PROCESSING_METHOD, processing_method);
2429        }
2430
2431        /**
2432         * Removes GPS latitude, longitude, altitude, and timestamp from the
2433         * parameters.
2434         */
2435        public void removeGpsData() {
2436            remove(KEY_GPS_LATITUDE);
2437            remove(KEY_GPS_LONGITUDE);
2438            remove(KEY_GPS_ALTITUDE);
2439            remove(KEY_GPS_TIMESTAMP);
2440            remove(KEY_GPS_PROCESSING_METHOD);
2441        }
2442
2443        /**
2444         * Gets the current white balance setting.
2445         *
2446         * @return current white balance. null if white balance setting is not
2447         *         supported.
2448         * @see #WHITE_BALANCE_AUTO
2449         * @see #WHITE_BALANCE_INCANDESCENT
2450         * @see #WHITE_BALANCE_FLUORESCENT
2451         * @see #WHITE_BALANCE_WARM_FLUORESCENT
2452         * @see #WHITE_BALANCE_DAYLIGHT
2453         * @see #WHITE_BALANCE_CLOUDY_DAYLIGHT
2454         * @see #WHITE_BALANCE_TWILIGHT
2455         * @see #WHITE_BALANCE_SHADE
2456         *
2457         */
2458        public String getWhiteBalance() {
2459            return get(KEY_WHITE_BALANCE);
2460        }
2461
2462        /**
2463         * Sets the white balance. Changing the setting will release the
2464         * auto-white balance lock.
2465         *
2466         * @param value new white balance.
2467         * @see #getWhiteBalance()
2468         * @see #setAutoWhiteBalanceLock(boolean)
2469         */
2470        public void setWhiteBalance(String value) {
2471            set(KEY_WHITE_BALANCE, value);
2472            set(KEY_AUTO_WHITEBALANCE_LOCK, FALSE);
2473        }
2474
2475        /**
2476         * Gets the supported white balance.
2477         *
2478         * @return a list of supported white balance. null if white balance
2479         *         setting is not supported.
2480         * @see #getWhiteBalance()
2481         */
2482        public List<String> getSupportedWhiteBalance() {
2483            String str = get(KEY_WHITE_BALANCE + SUPPORTED_VALUES_SUFFIX);
2484            return split(str);
2485        }
2486
2487        /**
2488         * Gets the current color effect setting.
2489         *
2490         * @return current color effect. null if color effect
2491         *         setting is not supported.
2492         * @see #EFFECT_NONE
2493         * @see #EFFECT_MONO
2494         * @see #EFFECT_NEGATIVE
2495         * @see #EFFECT_SOLARIZE
2496         * @see #EFFECT_SEPIA
2497         * @see #EFFECT_POSTERIZE
2498         * @see #EFFECT_WHITEBOARD
2499         * @see #EFFECT_BLACKBOARD
2500         * @see #EFFECT_AQUA
2501         */
2502        public String getColorEffect() {
2503            return get(KEY_EFFECT);
2504        }
2505
2506        /**
2507         * Sets the current color effect setting.
2508         *
2509         * @param value new color effect.
2510         * @see #getColorEffect()
2511         */
2512        public void setColorEffect(String value) {
2513            set(KEY_EFFECT, value);
2514        }
2515
2516        /**
2517         * Gets the supported color effects.
2518         *
2519         * @return a list of supported color effects. null if color effect
2520         *         setting is not supported.
2521         * @see #getColorEffect()
2522         */
2523        public List<String> getSupportedColorEffects() {
2524            String str = get(KEY_EFFECT + SUPPORTED_VALUES_SUFFIX);
2525            return split(str);
2526        }
2527
2528
2529        /**
2530         * Gets the current antibanding setting.
2531         *
2532         * @return current antibanding. null if antibanding setting is not
2533         *         supported.
2534         * @see #ANTIBANDING_AUTO
2535         * @see #ANTIBANDING_50HZ
2536         * @see #ANTIBANDING_60HZ
2537         * @see #ANTIBANDING_OFF
2538         */
2539        public String getAntibanding() {
2540            return get(KEY_ANTIBANDING);
2541        }
2542
2543        /**
2544         * Sets the antibanding.
2545         *
2546         * @param antibanding new antibanding value.
2547         * @see #getAntibanding()
2548         */
2549        public void setAntibanding(String antibanding) {
2550            set(KEY_ANTIBANDING, antibanding);
2551        }
2552
2553        /**
2554         * Gets the supported antibanding values.
2555         *
2556         * @return a list of supported antibanding values. null if antibanding
2557         *         setting is not supported.
2558         * @see #getAntibanding()
2559         */
2560        public List<String> getSupportedAntibanding() {
2561            String str = get(KEY_ANTIBANDING + SUPPORTED_VALUES_SUFFIX);
2562            return split(str);
2563        }
2564
2565        /**
2566         * Gets the current scene mode setting.
2567         *
2568         * @return one of SCENE_MODE_XXX string constant. null if scene mode
2569         *         setting is not supported.
2570         * @see #SCENE_MODE_AUTO
2571         * @see #SCENE_MODE_ACTION
2572         * @see #SCENE_MODE_PORTRAIT
2573         * @see #SCENE_MODE_LANDSCAPE
2574         * @see #SCENE_MODE_NIGHT
2575         * @see #SCENE_MODE_NIGHT_PORTRAIT
2576         * @see #SCENE_MODE_THEATRE
2577         * @see #SCENE_MODE_BEACH
2578         * @see #SCENE_MODE_SNOW
2579         * @see #SCENE_MODE_SUNSET
2580         * @see #SCENE_MODE_STEADYPHOTO
2581         * @see #SCENE_MODE_FIREWORKS
2582         * @see #SCENE_MODE_SPORTS
2583         * @see #SCENE_MODE_PARTY
2584         * @see #SCENE_MODE_CANDLELIGHT
2585         */
2586        public String getSceneMode() {
2587            return get(KEY_SCENE_MODE);
2588        }
2589
2590        /**
2591         * Sets the scene mode. Changing scene mode may override other
2592         * parameters (such as flash mode, focus mode, white balance). For
2593         * example, suppose originally flash mode is on and supported flash
2594         * modes are on/off. In night scene mode, both flash mode and supported
2595         * flash mode may be changed to off. After setting scene mode,
2596         * applications should call getParameters to know if some parameters are
2597         * changed.
2598         *
2599         * @param value scene mode.
2600         * @see #getSceneMode()
2601         */
2602        public void setSceneMode(String value) {
2603            set(KEY_SCENE_MODE, value);
2604        }
2605
2606        /**
2607         * Gets the supported scene modes.
2608         *
2609         * @return a list of supported scene modes. null if scene mode setting
2610         *         is not supported.
2611         * @see #getSceneMode()
2612         */
2613        public List<String> getSupportedSceneModes() {
2614            String str = get(KEY_SCENE_MODE + SUPPORTED_VALUES_SUFFIX);
2615            return split(str);
2616        }
2617
2618        /**
2619         * Gets the current flash mode setting.
2620         *
2621         * @return current flash mode. null if flash mode setting is not
2622         *         supported.
2623         * @see #FLASH_MODE_OFF
2624         * @see #FLASH_MODE_AUTO
2625         * @see #FLASH_MODE_ON
2626         * @see #FLASH_MODE_RED_EYE
2627         * @see #FLASH_MODE_TORCH
2628         */
2629        public String getFlashMode() {
2630            return get(KEY_FLASH_MODE);
2631        }
2632
2633        /**
2634         * Sets the flash mode.
2635         *
2636         * @param value flash mode.
2637         * @see #getFlashMode()
2638         */
2639        public void setFlashMode(String value) {
2640            set(KEY_FLASH_MODE, value);
2641        }
2642
2643        /**
2644         * Gets the supported flash modes.
2645         *
2646         * @return a list of supported flash modes. null if flash mode setting
2647         *         is not supported.
2648         * @see #getFlashMode()
2649         */
2650        public List<String> getSupportedFlashModes() {
2651            String str = get(KEY_FLASH_MODE + SUPPORTED_VALUES_SUFFIX);
2652            return split(str);
2653        }
2654
2655        /**
2656         * Gets the current focus mode setting.
2657         *
2658         * @return current focus mode. This method will always return a non-null
2659         *         value. Applications should call {@link
2660         *         #autoFocus(AutoFocusCallback)} to start the focus if focus
2661         *         mode is FOCUS_MODE_AUTO or FOCUS_MODE_MACRO.
2662         * @see #FOCUS_MODE_AUTO
2663         * @see #FOCUS_MODE_INFINITY
2664         * @see #FOCUS_MODE_MACRO
2665         * @see #FOCUS_MODE_FIXED
2666         * @see #FOCUS_MODE_EDOF
2667         * @see #FOCUS_MODE_CONTINUOUS_VIDEO
2668         */
2669        public String getFocusMode() {
2670            return get(KEY_FOCUS_MODE);
2671        }
2672
2673        /**
2674         * Sets the focus mode.
2675         *
2676         * @param value focus mode.
2677         * @see #getFocusMode()
2678         */
2679        public void setFocusMode(String value) {
2680            set(KEY_FOCUS_MODE, value);
2681        }
2682
2683        /**
2684         * Gets the supported focus modes.
2685         *
2686         * @return a list of supported focus modes. This method will always
2687         *         return a list with at least one element.
2688         * @see #getFocusMode()
2689         */
2690        public List<String> getSupportedFocusModes() {
2691            String str = get(KEY_FOCUS_MODE + SUPPORTED_VALUES_SUFFIX);
2692            return split(str);
2693        }
2694
2695        /**
2696         * Gets the focal length (in millimeter) of the camera.
2697         *
2698         * @return the focal length. This method will always return a valid
2699         *         value.
2700         */
2701        public float getFocalLength() {
2702            return Float.parseFloat(get(KEY_FOCAL_LENGTH));
2703        }
2704
2705        /**
2706         * Gets the horizontal angle of view in degrees.
2707         *
2708         * @return horizontal angle of view. This method will always return a
2709         *         valid value.
2710         */
2711        public float getHorizontalViewAngle() {
2712            return Float.parseFloat(get(KEY_HORIZONTAL_VIEW_ANGLE));
2713        }
2714
2715        /**
2716         * Gets the vertical angle of view in degrees.
2717         *
2718         * @return vertical angle of view. This method will always return a
2719         *         valid value.
2720         */
2721        public float getVerticalViewAngle() {
2722            return Float.parseFloat(get(KEY_VERTICAL_VIEW_ANGLE));
2723        }
2724
2725        /**
2726         * Gets the current exposure compensation index.
2727         *
2728         * @return current exposure compensation index. The range is {@link
2729         *         #getMinExposureCompensation} to {@link
2730         *         #getMaxExposureCompensation}. 0 means exposure is not
2731         *         adjusted.
2732         */
2733        public int getExposureCompensation() {
2734            return getInt(KEY_EXPOSURE_COMPENSATION, 0);
2735        }
2736
2737        /**
2738         * Sets the exposure compensation index.
2739         *
2740         * @param value exposure compensation index. The valid value range is
2741         *        from {@link #getMinExposureCompensation} (inclusive) to {@link
2742         *        #getMaxExposureCompensation} (inclusive). 0 means exposure is
2743         *        not adjusted. Application should call
2744         *        getMinExposureCompensation and getMaxExposureCompensation to
2745         *        know if exposure compensation is supported.
2746         */
2747        public void setExposureCompensation(int value) {
2748            set(KEY_EXPOSURE_COMPENSATION, value);
2749        }
2750
2751        /**
2752         * Gets the maximum exposure compensation index.
2753         *
2754         * @return maximum exposure compensation index (>=0). If both this
2755         *         method and {@link #getMinExposureCompensation} return 0,
2756         *         exposure compensation is not supported.
2757         */
2758        public int getMaxExposureCompensation() {
2759            return getInt(KEY_MAX_EXPOSURE_COMPENSATION, 0);
2760        }
2761
2762        /**
2763         * Gets the minimum exposure compensation index.
2764         *
2765         * @return minimum exposure compensation index (<=0). If both this
2766         *         method and {@link #getMaxExposureCompensation} return 0,
2767         *         exposure compensation is not supported.
2768         */
2769        public int getMinExposureCompensation() {
2770            return getInt(KEY_MIN_EXPOSURE_COMPENSATION, 0);
2771        }
2772
2773        /**
2774         * Gets the exposure compensation step.
2775         *
2776         * @return exposure compensation step. Applications can get EV by
2777         *         multiplying the exposure compensation index and step. Ex: if
2778         *         exposure compensation index is -6 and step is 0.333333333, EV
2779         *         is -2.
2780         */
2781        public float getExposureCompensationStep() {
2782            return getFloat(KEY_EXPOSURE_COMPENSATION_STEP, 0);
2783        }
2784
2785        /**
2786         * <p>Sets the auto-exposure lock state. Applications should check
2787         * {@link #isAutoExposureLockSupported} before using this method.</p>
2788         *
2789         * <p>If set to true, the camera auto-exposure routine will immediately
2790         * pause until the lock is set to false. Exposure compensation settings
2791         * changes will still take effect while auto-exposure is locked.</p>
2792         *
2793         * <p>If auto-exposure is already locked, setting this to true again has
2794         * no effect (the driver will not recalculate exposure values).</p>
2795         *
2796         * <p>Stopping preview with {@link #stopPreview()}, or triggering still
2797         * image capture with {@link #takePicture(Camera.ShutterCallback,
2798         * Camera.PictureCallback, Camera.PictureCallback)}, will not change the
2799         * lock.</p>
2800         *
2801         * <p>Exposure compensation, auto-exposure lock, and auto-white balance
2802         * lock can be used to capture an exposure-bracketed burst of images,
2803         * for example.</p>
2804         *
2805         * <p>Auto-exposure state, including the lock state, will not be
2806         * maintained after camera {@link #release()} is called.  Locking
2807         * auto-exposure after {@link #open()} but before the first call to
2808         * {@link #startPreview()} will not allow the auto-exposure routine to
2809         * run at all, and may result in severely over- or under-exposed
2810         * images.</p>
2811         *
2812         * @param toggle new state of the auto-exposure lock. True means that
2813         *        auto-exposure is locked, false means that the auto-exposure
2814         *        routine is free to run normally.
2815         *
2816         * @see #getAutoExposureLock()
2817         */
2818        public void setAutoExposureLock(boolean toggle) {
2819            set(KEY_AUTO_EXPOSURE_LOCK, toggle ? TRUE : FALSE);
2820        }
2821
2822        /**
2823         * Gets the state of the auto-exposure lock. Applications should check
2824         * {@link #isAutoExposureLockSupported} before using this method. See
2825         * {@link #setAutoExposureLock} for details about the lock.
2826         *
2827         * @return State of the auto-exposure lock. Returns true if
2828         *         auto-exposure is currently locked, and false otherwise.
2829         *
2830         * @see #setAutoExposureLock(boolean)
2831         *
2832         */
2833        public boolean getAutoExposureLock() {
2834            String str = get(KEY_AUTO_EXPOSURE_LOCK);
2835            return TRUE.equals(str);
2836        }
2837
2838        /**
2839         * Returns true if auto-exposure locking is supported. Applications
2840         * should call this before trying to lock auto-exposure. See
2841         * {@link #setAutoExposureLock} for details about the lock.
2842         *
2843         * @return true if auto-exposure lock is supported.
2844         * @see #setAutoExposureLock(boolean)
2845         *
2846         */
2847        public boolean isAutoExposureLockSupported() {
2848            String str = get(KEY_AUTO_EXPOSURE_LOCK_SUPPORTED);
2849            return TRUE.equals(str);
2850        }
2851
2852        /**
2853         * <p>Sets the auto-white balance lock state. Applications should check
2854         * {@link #isAutoWhiteBalanceLockSupported} before using this
2855         * method.</p>
2856         *
2857         * <p>If set to true, the camera auto-white balance routine will
2858         * immediately pause until the lock is set to false.</p>
2859         *
2860         * <p>If auto-white balance is already locked, setting this to true
2861         * again has no effect (the driver will not recalculate white balance
2862         * values).</p>
2863         *
2864         * <p>Stopping preview with {@link #stopPreview()}, or triggering still
2865         * image capture with {@link #takePicture(Camera.ShutterCallback,
2866         * Camera.PictureCallback, Camera.PictureCallback)}, will not change the
2867         * the lock.</p>
2868         *
2869         * <p> Changing the white balance mode with {@link #setWhiteBalance}
2870         * will release the auto-white balance lock if it is set.</p>
2871         *
2872         * <p>Exposure compensation, AE lock, and AWB lock can be used to
2873         * capture an exposure-bracketed burst of images, for example.
2874         * Auto-white balance state, including the lock state, will not be
2875         * maintained after camera {@link #release()} is called.  Locking
2876         * auto-white balance after {@link #open()} but before the first call to
2877         * {@link #startPreview()} will not allow the auto-white balance routine
2878         * to run at all, and may result in severely incorrect color in captured
2879         * images.</p>
2880         *
2881         * @param toggle new state of the auto-white balance lock. True means
2882         *        that auto-white balance is locked, false means that the
2883         *        auto-white balance routine is free to run normally.
2884         *
2885         * @see #getAutoWhiteBalanceLock()
2886         * @see #setWhiteBalance(String)
2887         */
2888        public void setAutoWhiteBalanceLock(boolean toggle) {
2889            set(KEY_AUTO_WHITEBALANCE_LOCK, toggle ? TRUE : FALSE);
2890        }
2891
2892        /**
2893         * Gets the state of the auto-white balance lock. Applications should
2894         * check {@link #isAutoWhiteBalanceLockSupported} before using this
2895         * method. See {@link #setAutoWhiteBalanceLock} for details about the
2896         * lock.
2897         *
2898         * @return State of the auto-white balance lock. Returns true if
2899         *         auto-white balance is currently locked, and false
2900         *         otherwise.
2901         *
2902         * @see #setAutoWhiteBalanceLock(boolean)
2903         *
2904         */
2905        public boolean getAutoWhiteBalanceLock() {
2906            String str = get(KEY_AUTO_WHITEBALANCE_LOCK);
2907            return TRUE.equals(str);
2908        }
2909
2910        /**
2911         * Returns true if auto-white balance locking is supported. Applications
2912         * should call this before trying to lock auto-white balance. See
2913         * {@link #setAutoWhiteBalanceLock} for details about the lock.
2914         *
2915         * @return true if auto-white balance lock is supported.
2916         * @see #setAutoWhiteBalanceLock(boolean)
2917         *
2918         */
2919        public boolean isAutoWhiteBalanceLockSupported() {
2920            String str = get(KEY_AUTO_WHITEBALANCE_LOCK_SUPPORTED);
2921            return TRUE.equals(str);
2922        }
2923
2924        /**
2925         * Gets current zoom value. This also works when smooth zoom is in
2926         * progress. Applications should check {@link #isZoomSupported} before
2927         * using this method.
2928         *
2929         * @return the current zoom value. The range is 0 to {@link
2930         *         #getMaxZoom}. 0 means the camera is not zoomed.
2931         */
2932        public int getZoom() {
2933            return getInt(KEY_ZOOM, 0);
2934        }
2935
2936        /**
2937         * Sets current zoom value. If the camera is zoomed (value > 0), the
2938         * actual picture size may be smaller than picture size setting.
2939         * Applications can check the actual picture size after picture is
2940         * returned from {@link PictureCallback}. The preview size remains the
2941         * same in zoom. Applications should check {@link #isZoomSupported}
2942         * before using this method.
2943         *
2944         * @param value zoom value. The valid range is 0 to {@link #getMaxZoom}.
2945         */
2946        public void setZoom(int value) {
2947            set(KEY_ZOOM, value);
2948        }
2949
2950        /**
2951         * Returns true if zoom is supported. Applications should call this
2952         * before using other zoom methods.
2953         *
2954         * @return true if zoom is supported.
2955         */
2956        public boolean isZoomSupported() {
2957            String str = get(KEY_ZOOM_SUPPORTED);
2958            return TRUE.equals(str);
2959        }
2960
2961        /**
2962         * Gets the maximum zoom value allowed for snapshot. This is the maximum
2963         * value that applications can set to {@link #setZoom(int)}.
2964         * Applications should call {@link #isZoomSupported} before using this
2965         * method. This value may change in different preview size. Applications
2966         * should call this again after setting preview size.
2967         *
2968         * @return the maximum zoom value supported by the camera.
2969         */
2970        public int getMaxZoom() {
2971            return getInt(KEY_MAX_ZOOM, 0);
2972        }
2973
2974        /**
2975         * Gets the zoom ratios of all zoom values. Applications should check
2976         * {@link #isZoomSupported} before using this method.
2977         *
2978         * @return the zoom ratios in 1/100 increments. Ex: a zoom of 3.2x is
2979         *         returned as 320. The number of elements is {@link
2980         *         #getMaxZoom} + 1. The list is sorted from small to large. The
2981         *         first element is always 100. The last element is the zoom
2982         *         ratio of the maximum zoom value.
2983         */
2984        public List<Integer> getZoomRatios() {
2985            return splitInt(get(KEY_ZOOM_RATIOS));
2986        }
2987
2988        /**
2989         * Returns true if smooth zoom is supported. Applications should call
2990         * this before using other smooth zoom methods.
2991         *
2992         * @return true if smooth zoom is supported.
2993         */
2994        public boolean isSmoothZoomSupported() {
2995            String str = get(KEY_SMOOTH_ZOOM_SUPPORTED);
2996            return TRUE.equals(str);
2997        }
2998
2999        /**
3000         * <p>Gets the distances from the camera to where an object appears to be
3001         * in focus. The object is sharpest at the optimal focus distance. The
3002         * depth of field is the far focus distance minus near focus distance.</p>
3003         *
3004         * <p>Focus distances may change after calling {@link
3005         * #autoFocus(AutoFocusCallback)}, {@link #cancelAutoFocus}, or {@link
3006         * #startPreview()}. Applications can call {@link #getParameters()}
3007         * and this method anytime to get the latest focus distances. If the
3008         * focus mode is FOCUS_MODE_CONTINUOUS_VIDEO, focus distances may change
3009         * from time to time.</p>
3010         *
3011         * <p>This method is intended to estimate the distance between the camera
3012         * and the subject. After autofocus, the subject distance may be within
3013         * near and far focus distance. However, the precision depends on the
3014         * camera hardware, autofocus algorithm, the focus area, and the scene.
3015         * The error can be large and it should be only used as a reference.</p>
3016         *
3017         * <p>Far focus distance >= optimal focus distance >= near focus distance.
3018         * If the focus distance is infinity, the value will be
3019         * {@code Float.POSITIVE_INFINITY}.</p>
3020         *
3021         * @param output focus distances in meters. output must be a float
3022         *        array with three elements. Near focus distance, optimal focus
3023         *        distance, and far focus distance will be filled in the array.
3024         * @see #FOCUS_DISTANCE_NEAR_INDEX
3025         * @see #FOCUS_DISTANCE_OPTIMAL_INDEX
3026         * @see #FOCUS_DISTANCE_FAR_INDEX
3027         */
3028        public void getFocusDistances(float[] output) {
3029            if (output == null || output.length != 3) {
3030                throw new IllegalArgumentException(
3031                        "output must be an float array with three elements.");
3032            }
3033            splitFloat(get(KEY_FOCUS_DISTANCES), output);
3034        }
3035
3036        /**
3037         * Gets the maximum number of focus areas supported. This is the maximum
3038         * length of the list in {@link #setFocusAreas(List)} and
3039         * {@link #getFocusAreas()}.
3040         *
3041         * @return the maximum number of focus areas supported by the camera.
3042         * @see #getFocusAreas()
3043         */
3044        public int getMaxNumFocusAreas() {
3045            return getInt(KEY_MAX_NUM_FOCUS_AREAS, 0);
3046        }
3047
3048        /**
3049         * <p>Gets the current focus areas. Camera driver uses the areas to decide
3050         * focus.</p>
3051         *
3052         * <p>Before using this API or {@link #setFocusAreas(List)}, apps should
3053         * call {@link #getMaxNumFocusAreas()} to know the maximum number of
3054         * focus areas first. If the value is 0, focus area is not supported.</p>
3055         *
3056         * <p>Each focus area is a rectangle with specified weight. The direction
3057         * is relative to the sensor orientation, that is, what the sensor sees.
3058         * The direction is not affected by the rotation or mirroring of
3059         * {@link #setDisplayOrientation(int)}. Coordinates of the rectangle
3060         * range from -1000 to 1000. (-1000, -1000) is the upper left point.
3061         * (1000, 1000) is the lower right point. The width and height of focus
3062         * areas cannot be 0 or negative.</p>
3063         *
3064         * <p>The weight must range from 1 to 1000. The weight should be
3065         * interpreted as a per-pixel weight - all pixels in the area have the
3066         * specified weight. This means a small area with the same weight as a
3067         * larger area will have less influence on the focusing than the larger
3068         * area. Focus areas can partially overlap and the driver will add the
3069         * weights in the overlap region.</p>
3070         *
3071         * <p>A special case of a {@code null} focus area list means the driver is
3072         * free to select focus targets as it wants. For example, the driver may
3073         * use more signals to select focus areas and change them
3074         * dynamically. Apps can set the focus area list to {@code null} if they
3075         * want the driver to completely control focusing.</p>
3076         *
3077         * <p>Focus areas are relative to the current field of view
3078         * ({@link #getZoom()}). No matter what the zoom level is, (-1000,-1000)
3079         * represents the top of the currently visible camera frame. The focus
3080         * area cannot be set to be outside the current field of view, even
3081         * when using zoom.</p>
3082         *
3083         * <p>Focus area only has effect if the current focus mode is
3084         * {@link #FOCUS_MODE_AUTO}, {@link #FOCUS_MODE_MACRO},
3085         * {@link #FOCUS_MODE_CONTINUOUS_VIDEO}, or
3086         * {@link #FOCUS_MODE_CONTINUOUS_PICTURE}.</p>
3087         *
3088         * @return a list of current focus areas
3089         */
3090        public List<Area> getFocusAreas() {
3091            return splitArea(get(KEY_FOCUS_AREAS));
3092        }
3093
3094        /**
3095         * Sets focus areas. See {@link #getFocusAreas()} for documentation.
3096         *
3097         * @param focusAreas the focus areas
3098         * @see #getFocusAreas()
3099         */
3100        public void setFocusAreas(List<Area> focusAreas) {
3101            set(KEY_FOCUS_AREAS, focusAreas);
3102        }
3103
3104        /**
3105         * Gets the maximum number of metering areas supported. This is the
3106         * maximum length of the list in {@link #setMeteringAreas(List)} and
3107         * {@link #getMeteringAreas()}.
3108         *
3109         * @return the maximum number of metering areas supported by the camera.
3110         * @see #getMeteringAreas()
3111         */
3112        public int getMaxNumMeteringAreas() {
3113            return getInt(KEY_MAX_NUM_METERING_AREAS, 0);
3114        }
3115
3116        /**
3117         * <p>Gets the current metering areas. Camera driver uses these areas to
3118         * decide exposure.</p>
3119         *
3120         * <p>Before using this API or {@link #setMeteringAreas(List)}, apps should
3121         * call {@link #getMaxNumMeteringAreas()} to know the maximum number of
3122         * metering areas first. If the value is 0, metering area is not
3123         * supported.</p>
3124         *
3125         * <p>Each metering area is a rectangle with specified weight. The
3126         * direction is relative to the sensor orientation, that is, what the
3127         * sensor sees. The direction is not affected by the rotation or
3128         * mirroring of {@link #setDisplayOrientation(int)}. Coordinates of the
3129         * rectangle range from -1000 to 1000. (-1000, -1000) is the upper left
3130         * point. (1000, 1000) is the lower right point. The width and height of
3131         * metering areas cannot be 0 or negative.</p>
3132         *
3133         * <p>The weight must range from 1 to 1000, and represents a weight for
3134         * every pixel in the area. This means that a large metering area with
3135         * the same weight as a smaller area will have more effect in the
3136         * metering result.  Metering areas can partially overlap and the driver
3137         * will add the weights in the overlap region.</p>
3138         *
3139         * <p>A special case of a {@code null} metering area list means the driver
3140         * is free to meter as it chooses. For example, the driver may use more
3141         * signals to select metering areas and change them dynamically. Apps
3142         * can set the metering area list to {@code null} if they want the
3143         * driver to completely control metering.</p>
3144         *
3145         * <p>Metering areas are relative to the current field of view
3146         * ({@link #getZoom()}). No matter what the zoom level is, (-1000,-1000)
3147         * represents the top of the currently visible camera frame. The
3148         * metering area cannot be set to be outside the current field of view,
3149         * even when using zoom.</p>
3150         *
3151         * <p>No matter what metering areas are, the final exposure are compensated
3152         * by {@link #setExposureCompensation(int)}.</p>
3153         *
3154         * @return a list of current metering areas
3155         */
3156        public List<Area> getMeteringAreas() {
3157            return splitArea(get(KEY_METERING_AREAS));
3158        }
3159
3160        /**
3161         * Sets metering areas. See {@link #getMeteringAreas()} for
3162         * documentation.
3163         *
3164         * @param meteringAreas the metering areas
3165         * @see #getMeteringAreas()
3166         */
3167        public void setMeteringAreas(List<Area> meteringAreas) {
3168            set(KEY_METERING_AREAS, meteringAreas);
3169        }
3170
3171        /**
3172         * Gets the maximum number of detected faces supported. This is the
3173         * maximum length of the list returned from {@link FaceDetectionListener}.
3174         * If the return value is 0, face detection of the specified type is not
3175         * supported.
3176         *
3177         * @return the maximum number of detected face supported by the camera.
3178         * @see #startFaceDetection()
3179         */
3180        public int getMaxNumDetectedFaces() {
3181            return getInt(KEY_MAX_NUM_DETECTED_FACES_HW, 0);
3182        }
3183
3184        /**
3185         * Sets recording mode hint. This tells the camera that the intent of
3186         * the application is to record videos {@link
3187         * android.media.MediaRecorder#start()}, not to take still pictures
3188         * {@link #takePicture(Camera.ShutterCallback, Camera.PictureCallback,
3189         * Camera.PictureCallback, Camera.PictureCallback)}. Using this hint can
3190         * allow MediaRecorder.start() to start faster or with fewer glitches on
3191         * output. This should be called before starting preview for the best
3192         * result, but can be changed while the preview is active. The default
3193         * value is false.
3194         *
3195         * The app can still call takePicture() when the hint is true or call
3196         * MediaRecorder.start() when the hint is false. But the performance may
3197         * be worse.
3198         *
3199         * @param hint true if the apps intend to record videos using
3200         *             {@link android.media.MediaRecorder}.
3201         */
3202        public void setRecordingHint(boolean hint) {
3203            set(KEY_RECORDING_HINT, hint ? TRUE : FALSE);
3204        }
3205
3206        /**
3207         * Returns true if video snapshot is supported. That is, applications
3208         * can call {@link #takePicture(Camera.ShutterCallback,
3209         * Camera.PictureCallback, Camera.PictureCallback, Camera.PictureCallback)}
3210         * during recording. Applications do not need to call {@link
3211         * #startPreview()} after taking a picture. The preview will be still
3212         * active. Other than that, taking a picture during recording is
3213         * identical to taking a picture normally. All settings and methods
3214         * related to takePicture work identically. Ex: {@link
3215         * #getPictureSize()}, {@link #getSupportedPictureSizes()}, {@link
3216         * #setJpegQuality(int)}, {@link #setRotation(int)}, and etc. The
3217         * picture will have an EXIF header. {@link #FLASH_MODE_AUTO} and {@link
3218         * #FLASH_MODE_ON} also still work, but the video will record the flash.
3219         *
3220         * Applications can set shutter callback as null to avoid the shutter
3221         * sound. It is also recommended to set raw picture and post view
3222         * callbacks to null to avoid the interrupt of preview display.
3223         *
3224         * Field-of-view of the recorded video may be different from that of the
3225         * captured pictures.
3226         *
3227         * @return true if video snapshot is supported.
3228         */
3229        public boolean isVideoSnapshotSupported() {
3230            String str = get(KEY_VIDEO_SNAPSHOT_SUPPORTED);
3231            return TRUE.equals(str);
3232        }
3233
3234        /**
3235         * <p>Enables and disables video stabilization. Use
3236         * {@link #isVideoStabilizationSupported} to determine if calling this
3237         * method is valid.</p>
3238         *
3239         * <p>Video stabilization reduces the shaking due to the motion of the
3240         * camera in both the preview stream and in recorded videos, including
3241         * data received from the preview callback. It does not reduce motion
3242         * blur in images captured with
3243         * {@link Camera#takePicture takePicture}.</p>
3244         *
3245         * <p>Video stabilization can be enabled and disabled while preview or
3246         * recording is active, but toggling it may cause a jump in the video
3247         * stream that may be undesirable in a recorded video.</p>
3248         *
3249         * @param toggle Set to true to enable video stabilization, and false to
3250         * disable video stabilization.
3251         * @see #isVideoStabilizationSupported()
3252         * @see #getVideoStabilization()
3253         * @hide
3254         */
3255        public void setVideoStabilization(boolean toggle) {
3256            set(KEY_VIDEO_STABILIZATION, toggle ? TRUE : FALSE);
3257        }
3258
3259        /**
3260         * Get the current state of video stabilization. See
3261         * {@link #setVideoStabilization} for details of video stabilization.
3262         *
3263         * @return true if video stabilization is enabled
3264         * @see #isVideoStabilizationSupported()
3265         * @see #setVideoStabilization(boolean)
3266         * @hide
3267         */
3268        public boolean getVideoStabilization() {
3269            String str = get(KEY_VIDEO_STABILIZATION);
3270            return TRUE.equals(str);
3271        }
3272
3273        /**
3274         * Returns true if video stabilization is supported. See
3275         * {@link #setVideoStabilization} for details of video stabilization.
3276         *
3277         * @return true if video stabilization is supported
3278         * @see #setVideoStabilization(boolean)
3279         * @see #getVideoStabilization()
3280         * @hide
3281         */
3282        public boolean isVideoStabilizationSupported() {
3283            String str = get(KEY_VIDEO_STABILIZATION_SUPPORTED);
3284            return TRUE.equals(str);
3285        }
3286
3287        // Splits a comma delimited string to an ArrayList of String.
3288        // Return null if the passing string is null or the size is 0.
3289        private ArrayList<String> split(String str) {
3290            if (str == null) return null;
3291
3292            // Use StringTokenizer because it is faster than split.
3293            StringTokenizer tokenizer = new StringTokenizer(str, ",");
3294            ArrayList<String> substrings = new ArrayList<String>();
3295            while (tokenizer.hasMoreElements()) {
3296                substrings.add(tokenizer.nextToken());
3297            }
3298            return substrings;
3299        }
3300
3301        // Splits a comma delimited string to an ArrayList of Integer.
3302        // Return null if the passing string is null or the size is 0.
3303        private ArrayList<Integer> splitInt(String str) {
3304            if (str == null) return null;
3305
3306            StringTokenizer tokenizer = new StringTokenizer(str, ",");
3307            ArrayList<Integer> substrings = new ArrayList<Integer>();
3308            while (tokenizer.hasMoreElements()) {
3309                String token = tokenizer.nextToken();
3310                substrings.add(Integer.parseInt(token));
3311            }
3312            if (substrings.size() == 0) return null;
3313            return substrings;
3314        }
3315
3316        private void splitInt(String str, int[] output) {
3317            if (str == null) return;
3318
3319            StringTokenizer tokenizer = new StringTokenizer(str, ",");
3320            int index = 0;
3321            while (tokenizer.hasMoreElements()) {
3322                String token = tokenizer.nextToken();
3323                output[index++] = Integer.parseInt(token);
3324            }
3325        }
3326
3327        // Splits a comma delimited string to an ArrayList of Float.
3328        private void splitFloat(String str, float[] output) {
3329            if (str == null) return;
3330
3331            StringTokenizer tokenizer = new StringTokenizer(str, ",");
3332            int index = 0;
3333            while (tokenizer.hasMoreElements()) {
3334                String token = tokenizer.nextToken();
3335                output[index++] = Float.parseFloat(token);
3336            }
3337        }
3338
3339        // Returns the value of a float parameter.
3340        private float getFloat(String key, float defaultValue) {
3341            try {
3342                return Float.parseFloat(mMap.get(key));
3343            } catch (NumberFormatException ex) {
3344                return defaultValue;
3345            }
3346        }
3347
3348        // Returns the value of a integer parameter.
3349        private int getInt(String key, int defaultValue) {
3350            try {
3351                return Integer.parseInt(mMap.get(key));
3352            } catch (NumberFormatException ex) {
3353                return defaultValue;
3354            }
3355        }
3356
3357        // Splits a comma delimited string to an ArrayList of Size.
3358        // Return null if the passing string is null or the size is 0.
3359        private ArrayList<Size> splitSize(String str) {
3360            if (str == null) return null;
3361
3362            StringTokenizer tokenizer = new StringTokenizer(str, ",");
3363            ArrayList<Size> sizeList = new ArrayList<Size>();
3364            while (tokenizer.hasMoreElements()) {
3365                Size size = strToSize(tokenizer.nextToken());
3366                if (size != null) sizeList.add(size);
3367            }
3368            if (sizeList.size() == 0) return null;
3369            return sizeList;
3370        }
3371
3372        // Parses a string (ex: "480x320") to Size object.
3373        // Return null if the passing string is null.
3374        private Size strToSize(String str) {
3375            if (str == null) return null;
3376
3377            int pos = str.indexOf('x');
3378            if (pos != -1) {
3379                String width = str.substring(0, pos);
3380                String height = str.substring(pos + 1);
3381                return new Size(Integer.parseInt(width),
3382                                Integer.parseInt(height));
3383            }
3384            Log.e(TAG, "Invalid size parameter string=" + str);
3385            return null;
3386        }
3387
3388        // Splits a comma delimited string to an ArrayList of int array.
3389        // Example string: "(10000,26623),(10000,30000)". Return null if the
3390        // passing string is null or the size is 0.
3391        private ArrayList<int[]> splitRange(String str) {
3392            if (str == null || str.charAt(0) != '('
3393                    || str.charAt(str.length() - 1) != ')') {
3394                Log.e(TAG, "Invalid range list string=" + str);
3395                return null;
3396            }
3397
3398            ArrayList<int[]> rangeList = new ArrayList<int[]>();
3399            int endIndex, fromIndex = 1;
3400            do {
3401                int[] range = new int[2];
3402                endIndex = str.indexOf("),(", fromIndex);
3403                if (endIndex == -1) endIndex = str.length() - 1;
3404                splitInt(str.substring(fromIndex, endIndex), range);
3405                rangeList.add(range);
3406                fromIndex = endIndex + 3;
3407            } while (endIndex != str.length() - 1);
3408
3409            if (rangeList.size() == 0) return null;
3410            return rangeList;
3411        }
3412
3413        // Splits a comma delimited string to an ArrayList of Area objects.
3414        // Example string: "(-10,-10,0,0,300),(0,0,10,10,700)". Return null if
3415        // the passing string is null or the size is 0 or (0,0,0,0,0).
3416        private ArrayList<Area> splitArea(String str) {
3417            if (str == null || str.charAt(0) != '('
3418                    || str.charAt(str.length() - 1) != ')') {
3419                Log.e(TAG, "Invalid area string=" + str);
3420                return null;
3421            }
3422
3423            ArrayList<Area> result = new ArrayList<Area>();
3424            int endIndex, fromIndex = 1;
3425            int[] array = new int[5];
3426            do {
3427                endIndex = str.indexOf("),(", fromIndex);
3428                if (endIndex == -1) endIndex = str.length() - 1;
3429                splitInt(str.substring(fromIndex, endIndex), array);
3430                Rect rect = new Rect(array[0], array[1], array[2], array[3]);
3431                result.add(new Area(rect, array[4]));
3432                fromIndex = endIndex + 3;
3433            } while (endIndex != str.length() - 1);
3434
3435            if (result.size() == 0) return null;
3436
3437            if (result.size() == 1) {
3438                Area area = result.get(0);
3439                Rect rect = area.rect;
3440                if (rect.left == 0 && rect.top == 0 && rect.right == 0
3441                        && rect.bottom == 0 && area.weight == 0) {
3442                    return null;
3443                }
3444            }
3445
3446            return result;
3447        }
3448    };
3449}
3450