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