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