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