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