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