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