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