Camera.java revision 4e396e063c8b0fa6201b47166f547a98abfd6038
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<Area>)
1090     * @see #getFocusAreas()
1091     * @hide
1092     */
1093    public static class Area {
1094        /**
1095         * Create an area with specified rectangle and weight.
1096         *
1097         * @param rect the rectangle of the area
1098         * @param weight the weight of the area
1099         */
1100        public Area(Rect rect, int weight) {
1101            this.rect = rect;
1102            this.weight = weight;
1103        }
1104        /**
1105         * Compares {@code obj} to this area.
1106         *
1107         * @param obj the object to compare this area with.
1108         * @return {@code true} if the rectangle and weight of {@code obj} is
1109         *         the same as those of this area. {@code false} otherwise.
1110         */
1111        @Override
1112        public boolean equals(Object obj) {
1113            if (!(obj instanceof Area)) {
1114                return false;
1115            }
1116            Area a = (Area) obj;
1117            if (rect == null) {
1118                if (a.rect != null) return false;
1119            } else {
1120                if (!rect.equals(a.rect)) return false;
1121            }
1122            return weight == a.weight;
1123        }
1124
1125        /** rectangle of the area */
1126        public Rect rect;
1127
1128        /** weight of the area */
1129        public int weight;
1130    };
1131
1132    /**
1133     * Camera service settings.
1134     *
1135     * <p>To make camera parameters take effect, applications have to call
1136     * {@link Camera#setParameters(Camera.Parameters)}. For example, after
1137     * {@link Camera.Parameters#setWhiteBalance} is called, white balance is not
1138     * actually changed until {@link Camera#setParameters(Camera.Parameters)}
1139     * is called with the changed parameters object.
1140     *
1141     * <p>Different devices may have different camera capabilities, such as
1142     * picture size or flash modes. The application should query the camera
1143     * capabilities before setting parameters. For example, the application
1144     * should call {@link Camera.Parameters#getSupportedColorEffects()} before
1145     * calling {@link Camera.Parameters#setColorEffect(String)}. If the
1146     * camera does not support color effects,
1147     * {@link Camera.Parameters#getSupportedColorEffects()} will return null.
1148     */
1149    public class Parameters {
1150        // Parameter keys to communicate with the camera driver.
1151        private static final String KEY_PREVIEW_SIZE = "preview-size";
1152        private static final String KEY_PREVIEW_FORMAT = "preview-format";
1153        private static final String KEY_PREVIEW_FRAME_RATE = "preview-frame-rate";
1154        private static final String KEY_PREVIEW_FPS_RANGE = "preview-fps-range";
1155        private static final String KEY_PICTURE_SIZE = "picture-size";
1156        private static final String KEY_PICTURE_FORMAT = "picture-format";
1157        private static final String KEY_JPEG_THUMBNAIL_SIZE = "jpeg-thumbnail-size";
1158        private static final String KEY_JPEG_THUMBNAIL_WIDTH = "jpeg-thumbnail-width";
1159        private static final String KEY_JPEG_THUMBNAIL_HEIGHT = "jpeg-thumbnail-height";
1160        private static final String KEY_JPEG_THUMBNAIL_QUALITY = "jpeg-thumbnail-quality";
1161        private static final String KEY_JPEG_QUALITY = "jpeg-quality";
1162        private static final String KEY_ROTATION = "rotation";
1163        private static final String KEY_GPS_LATITUDE = "gps-latitude";
1164        private static final String KEY_GPS_LONGITUDE = "gps-longitude";
1165        private static final String KEY_GPS_ALTITUDE = "gps-altitude";
1166        private static final String KEY_GPS_TIMESTAMP = "gps-timestamp";
1167        private static final String KEY_GPS_PROCESSING_METHOD = "gps-processing-method";
1168        private static final String KEY_WHITE_BALANCE = "whitebalance";
1169        private static final String KEY_EFFECT = "effect";
1170        private static final String KEY_ANTIBANDING = "antibanding";
1171        private static final String KEY_SCENE_MODE = "scene-mode";
1172        private static final String KEY_FLASH_MODE = "flash-mode";
1173        private static final String KEY_FOCUS_MODE = "focus-mode";
1174        private static final String KEY_FOCUS_AREAS = "focus-areas";
1175        private static final String KEY_MAX_NUM_FOCUS_AREAS = "max-num-focus-areas";
1176        private static final String KEY_FOCAL_LENGTH = "focal-length";
1177        private static final String KEY_HORIZONTAL_VIEW_ANGLE = "horizontal-view-angle";
1178        private static final String KEY_VERTICAL_VIEW_ANGLE = "vertical-view-angle";
1179        private static final String KEY_EXPOSURE_COMPENSATION = "exposure-compensation";
1180        private static final String KEY_MAX_EXPOSURE_COMPENSATION = "max-exposure-compensation";
1181        private static final String KEY_MIN_EXPOSURE_COMPENSATION = "min-exposure-compensation";
1182        private static final String KEY_EXPOSURE_COMPENSATION_STEP = "exposure-compensation-step";
1183        private static final String KEY_METERING_AREAS = "metering-areas";
1184        private static final String KEY_MAX_NUM_METERING_AREAS = "max-num-metering-areas";
1185        private static final String KEY_ZOOM = "zoom";
1186        private static final String KEY_MAX_ZOOM = "max-zoom";
1187        private static final String KEY_ZOOM_RATIOS = "zoom-ratios";
1188        private static final String KEY_ZOOM_SUPPORTED = "zoom-supported";
1189        private static final String KEY_SMOOTH_ZOOM_SUPPORTED = "smooth-zoom-supported";
1190        private static final String KEY_FOCUS_DISTANCES = "focus-distances";
1191        private static final String KEY_VIDEO_SIZE = "video-size";
1192        private static final String KEY_PREFERRED_PREVIEW_SIZE_FOR_VIDEO =
1193                                            "preferred-preview-size-for-video";
1194
1195        // Parameter key suffix for supported values.
1196        private static final String SUPPORTED_VALUES_SUFFIX = "-values";
1197
1198        private static final String TRUE = "true";
1199
1200        // Values for white balance settings.
1201        public static final String WHITE_BALANCE_AUTO = "auto";
1202        public static final String WHITE_BALANCE_INCANDESCENT = "incandescent";
1203        public static final String WHITE_BALANCE_FLUORESCENT = "fluorescent";
1204        public static final String WHITE_BALANCE_WARM_FLUORESCENT = "warm-fluorescent";
1205        public static final String WHITE_BALANCE_DAYLIGHT = "daylight";
1206        public static final String WHITE_BALANCE_CLOUDY_DAYLIGHT = "cloudy-daylight";
1207        public static final String WHITE_BALANCE_TWILIGHT = "twilight";
1208        public static final String WHITE_BALANCE_SHADE = "shade";
1209
1210        // Values for color effect settings.
1211        public static final String EFFECT_NONE = "none";
1212        public static final String EFFECT_MONO = "mono";
1213        public static final String EFFECT_NEGATIVE = "negative";
1214        public static final String EFFECT_SOLARIZE = "solarize";
1215        public static final String EFFECT_SEPIA = "sepia";
1216        public static final String EFFECT_POSTERIZE = "posterize";
1217        public static final String EFFECT_WHITEBOARD = "whiteboard";
1218        public static final String EFFECT_BLACKBOARD = "blackboard";
1219        public static final String EFFECT_AQUA = "aqua";
1220
1221        // Values for antibanding settings.
1222        public static final String ANTIBANDING_AUTO = "auto";
1223        public static final String ANTIBANDING_50HZ = "50hz";
1224        public static final String ANTIBANDING_60HZ = "60hz";
1225        public static final String ANTIBANDING_OFF = "off";
1226
1227        // Values for flash mode settings.
1228        /**
1229         * Flash will not be fired.
1230         */
1231        public static final String FLASH_MODE_OFF = "off";
1232
1233        /**
1234         * Flash will be fired automatically when required. The flash may be fired
1235         * during preview, auto-focus, or snapshot depending on the driver.
1236         */
1237        public static final String FLASH_MODE_AUTO = "auto";
1238
1239        /**
1240         * Flash will always be fired during snapshot. The flash may also be
1241         * fired during preview or auto-focus depending on the driver.
1242         */
1243        public static final String FLASH_MODE_ON = "on";
1244
1245        /**
1246         * Flash will be fired in red-eye reduction mode.
1247         */
1248        public static final String FLASH_MODE_RED_EYE = "red-eye";
1249
1250        /**
1251         * Constant emission of light during preview, auto-focus and snapshot.
1252         * This can also be used for video recording.
1253         */
1254        public static final String FLASH_MODE_TORCH = "torch";
1255
1256        /**
1257         * Scene mode is off.
1258         */
1259        public static final String SCENE_MODE_AUTO = "auto";
1260
1261        /**
1262         * Take photos of fast moving objects. Same as {@link
1263         * #SCENE_MODE_SPORTS}.
1264         */
1265        public static final String SCENE_MODE_ACTION = "action";
1266
1267        /**
1268         * Take people pictures.
1269         */
1270        public static final String SCENE_MODE_PORTRAIT = "portrait";
1271
1272        /**
1273         * Take pictures on distant objects.
1274         */
1275        public static final String SCENE_MODE_LANDSCAPE = "landscape";
1276
1277        /**
1278         * Take photos at night.
1279         */
1280        public static final String SCENE_MODE_NIGHT = "night";
1281
1282        /**
1283         * Take people pictures at night.
1284         */
1285        public static final String SCENE_MODE_NIGHT_PORTRAIT = "night-portrait";
1286
1287        /**
1288         * Take photos in a theater. Flash light is off.
1289         */
1290        public static final String SCENE_MODE_THEATRE = "theatre";
1291
1292        /**
1293         * Take pictures on the beach.
1294         */
1295        public static final String SCENE_MODE_BEACH = "beach";
1296
1297        /**
1298         * Take pictures on the snow.
1299         */
1300        public static final String SCENE_MODE_SNOW = "snow";
1301
1302        /**
1303         * Take sunset photos.
1304         */
1305        public static final String SCENE_MODE_SUNSET = "sunset";
1306
1307        /**
1308         * Avoid blurry pictures (for example, due to hand shake).
1309         */
1310        public static final String SCENE_MODE_STEADYPHOTO = "steadyphoto";
1311
1312        /**
1313         * For shooting firework displays.
1314         */
1315        public static final String SCENE_MODE_FIREWORKS = "fireworks";
1316
1317        /**
1318         * Take photos of fast moving objects. Same as {@link
1319         * #SCENE_MODE_ACTION}.
1320         */
1321        public static final String SCENE_MODE_SPORTS = "sports";
1322
1323        /**
1324         * Take indoor low-light shot.
1325         */
1326        public static final String SCENE_MODE_PARTY = "party";
1327
1328        /**
1329         * Capture the naturally warm color of scenes lit by candles.
1330         */
1331        public static final String SCENE_MODE_CANDLELIGHT = "candlelight";
1332
1333        /**
1334         * Applications are looking for a barcode. Camera driver will be
1335         * optimized for barcode reading.
1336         */
1337        public static final String SCENE_MODE_BARCODE = "barcode";
1338
1339        /**
1340         * Auto-focus mode. Applications should call {@link
1341         * #autoFocus(AutoFocusCallback)} to start the focus in this mode.
1342         */
1343        public static final String FOCUS_MODE_AUTO = "auto";
1344
1345        /**
1346         * Focus is set at infinity. Applications should not call
1347         * {@link #autoFocus(AutoFocusCallback)} in this mode.
1348         */
1349        public static final String FOCUS_MODE_INFINITY = "infinity";
1350
1351        /**
1352         * Macro (close-up) focus mode. Applications should call
1353         * {@link #autoFocus(AutoFocusCallback)} to start the focus in this
1354         * mode.
1355         */
1356        public static final String FOCUS_MODE_MACRO = "macro";
1357
1358        /**
1359         * Focus is fixed. The camera is always in this mode if the focus is not
1360         * adjustable. If the camera has auto-focus, this mode can fix the
1361         * focus, which is usually at hyperfocal distance. Applications should
1362         * not call {@link #autoFocus(AutoFocusCallback)} in this mode.
1363         */
1364        public static final String FOCUS_MODE_FIXED = "fixed";
1365
1366        /**
1367         * Extended depth of field (EDOF). Focusing is done digitally and
1368         * continuously. Applications should not call {@link
1369         * #autoFocus(AutoFocusCallback)} in this mode.
1370         */
1371        public static final String FOCUS_MODE_EDOF = "edof";
1372
1373        /**
1374         * Continuous auto focus mode intended for video recording. The camera
1375         * continuously tries to focus. This is ideal for shooting video.
1376         * Applications still can call {@link
1377         * #takePicture(Camera.ShutterCallback, Camera.PictureCallback,
1378         * Camera.PictureCallback)} in this mode but the subject may not be in
1379         * focus. Auto focus starts when the parameter is set. Applications
1380         * should not call {@link #autoFocus(AutoFocusCallback)} in this mode.
1381         * To stop continuous focus, applications should change the focus mode
1382         * to other modes.
1383         */
1384        public static final String FOCUS_MODE_CONTINUOUS_VIDEO = "continuous-video";
1385
1386        // Indices for focus distance array.
1387        /**
1388         * The array index of near focus distance for use with
1389         * {@link #getFocusDistances(float[])}.
1390         */
1391        public static final int FOCUS_DISTANCE_NEAR_INDEX = 0;
1392
1393        /**
1394         * The array index of optimal focus distance for use with
1395         * {@link #getFocusDistances(float[])}.
1396         */
1397        public static final int FOCUS_DISTANCE_OPTIMAL_INDEX = 1;
1398
1399        /**
1400         * The array index of far focus distance for use with
1401         * {@link #getFocusDistances(float[])}.
1402         */
1403        public static final int FOCUS_DISTANCE_FAR_INDEX = 2;
1404
1405        /**
1406         * The array index of minimum preview fps for use with {@link
1407         * #getPreviewFpsRange(int[])} or {@link
1408         * #getSupportedPreviewFpsRange()}.
1409         */
1410        public static final int PREVIEW_FPS_MIN_INDEX = 0;
1411
1412        /**
1413         * The array index of maximum preview fps for use with {@link
1414         * #getPreviewFpsRange(int[])} or {@link
1415         * #getSupportedPreviewFpsRange()}.
1416         */
1417        public static final int PREVIEW_FPS_MAX_INDEX = 1;
1418
1419        // Formats for setPreviewFormat and setPictureFormat.
1420        private static final String PIXEL_FORMAT_YUV422SP = "yuv422sp";
1421        private static final String PIXEL_FORMAT_YUV420SP = "yuv420sp";
1422        private static final String PIXEL_FORMAT_YUV422I = "yuv422i-yuyv";
1423        private static final String PIXEL_FORMAT_YUV420P = "yuv420p";
1424        private static final String PIXEL_FORMAT_RGB565 = "rgb565";
1425        private static final String PIXEL_FORMAT_JPEG = "jpeg";
1426
1427        private HashMap<String, String> mMap;
1428
1429        private Parameters() {
1430            mMap = new HashMap<String, String>();
1431        }
1432
1433        /**
1434         * Writes the current Parameters to the log.
1435         * @hide
1436         * @deprecated
1437         */
1438        public void dump() {
1439            Log.e(TAG, "dump: size=" + mMap.size());
1440            for (String k : mMap.keySet()) {
1441                Log.e(TAG, "dump: " + k + "=" + mMap.get(k));
1442            }
1443        }
1444
1445        /**
1446         * Creates a single string with all the parameters set in
1447         * this Parameters object.
1448         * <p>The {@link #unflatten(String)} method does the reverse.</p>
1449         *
1450         * @return a String with all values from this Parameters object, in
1451         *         semi-colon delimited key-value pairs
1452         */
1453        public String flatten() {
1454            StringBuilder flattened = new StringBuilder();
1455            for (String k : mMap.keySet()) {
1456                flattened.append(k);
1457                flattened.append("=");
1458                flattened.append(mMap.get(k));
1459                flattened.append(";");
1460            }
1461            // chop off the extra semicolon at the end
1462            flattened.deleteCharAt(flattened.length()-1);
1463            return flattened.toString();
1464        }
1465
1466        /**
1467         * Takes a flattened string of parameters and adds each one to
1468         * this Parameters object.
1469         * <p>The {@link #flatten()} method does the reverse.</p>
1470         *
1471         * @param flattened a String of parameters (key-value paired) that
1472         *                  are semi-colon delimited
1473         */
1474        public void unflatten(String flattened) {
1475            mMap.clear();
1476
1477            StringTokenizer tokenizer = new StringTokenizer(flattened, ";");
1478            while (tokenizer.hasMoreElements()) {
1479                String kv = tokenizer.nextToken();
1480                int pos = kv.indexOf('=');
1481                if (pos == -1) {
1482                    continue;
1483                }
1484                String k = kv.substring(0, pos);
1485                String v = kv.substring(pos + 1);
1486                mMap.put(k, v);
1487            }
1488        }
1489
1490        public void remove(String key) {
1491            mMap.remove(key);
1492        }
1493
1494        /**
1495         * Sets a String parameter.
1496         *
1497         * @param key   the key name for the parameter
1498         * @param value the String value of the parameter
1499         */
1500        public void set(String key, String value) {
1501            if (key.indexOf('=') != -1 || key.indexOf(';') != -1) {
1502                Log.e(TAG, "Key \"" + key + "\" contains invalid character (= or ;)");
1503                return;
1504            }
1505            if (value.indexOf('=') != -1 || value.indexOf(';') != -1) {
1506                Log.e(TAG, "Value \"" + value + "\" contains invalid character (= or ;)");
1507                return;
1508            }
1509
1510            mMap.put(key, value);
1511        }
1512
1513        /**
1514         * Sets an integer parameter.
1515         *
1516         * @param key   the key name for the parameter
1517         * @param value the int value of the parameter
1518         */
1519        public void set(String key, int value) {
1520            mMap.put(key, Integer.toString(value));
1521        }
1522
1523        private void set(String key, List<Area> areas) {
1524            StringBuilder buffer = new StringBuilder();
1525            for (int i = 0; i < areas.size(); i++) {
1526                Area area = areas.get(i);
1527                Rect rect = area.rect;
1528                buffer.append('(');
1529                buffer.append(rect.left);
1530                buffer.append(',');
1531                buffer.append(rect.top);
1532                buffer.append(',');
1533                buffer.append(rect.right);
1534                buffer.append(',');
1535                buffer.append(rect.bottom);
1536                buffer.append(',');
1537                buffer.append(area.weight);
1538                buffer.append(')');
1539                if (i != areas.size() - 1) buffer.append(',');
1540            }
1541            set(key, buffer.toString());
1542        }
1543
1544        /**
1545         * Returns the value of a String parameter.
1546         *
1547         * @param key the key name for the parameter
1548         * @return the String value of the parameter
1549         */
1550        public String get(String key) {
1551            return mMap.get(key);
1552        }
1553
1554        /**
1555         * Returns the value of an integer parameter.
1556         *
1557         * @param key the key name for the parameter
1558         * @return the int value of the parameter
1559         */
1560        public int getInt(String key) {
1561            return Integer.parseInt(mMap.get(key));
1562        }
1563
1564        /**
1565         * Sets the dimensions for preview pictures.
1566         *
1567         * The sides of width and height are based on camera orientation. That
1568         * is, the preview size is the size before it is rotated by display
1569         * orientation. So applications need to consider the display orientation
1570         * while setting preview size. For example, suppose the camera supports
1571         * both 480x320 and 320x480 preview sizes. The application wants a 3:2
1572         * preview ratio. If the display orientation is set to 0 or 180, preview
1573         * size should be set to 480x320. If the display orientation is set to
1574         * 90 or 270, preview size should be set to 320x480. The display
1575         * orientation should also be considered while setting picture size and
1576         * thumbnail size.
1577         *
1578         * @param width  the width of the pictures, in pixels
1579         * @param height the height of the pictures, in pixels
1580         * @see #setDisplayOrientation(int)
1581         * @see #getCameraInfo(int, CameraInfo)
1582         * @see #setPictureSize(int, int)
1583         * @see #setJpegThumbnailSize(int, int)
1584         */
1585        public void setPreviewSize(int width, int height) {
1586            String v = Integer.toString(width) + "x" + Integer.toString(height);
1587            set(KEY_PREVIEW_SIZE, v);
1588        }
1589
1590        /**
1591         * Returns the dimensions setting for preview pictures.
1592         *
1593         * @return a Size object with the width and height setting
1594         *          for the preview picture
1595         */
1596        public Size getPreviewSize() {
1597            String pair = get(KEY_PREVIEW_SIZE);
1598            return strToSize(pair);
1599        }
1600
1601        /**
1602         * Gets the supported preview sizes.
1603         *
1604         * @return a list of Size object. This method will always return a list
1605         *         with at least one element.
1606         */
1607        public List<Size> getSupportedPreviewSizes() {
1608            String str = get(KEY_PREVIEW_SIZE + SUPPORTED_VALUES_SUFFIX);
1609            return splitSize(str);
1610        }
1611
1612        /**
1613         * Gets the supported video frame sizes that can be used by
1614         * MediaRecorder.
1615         *
1616         * If the returned list is not null, the returned list will contain at
1617         * least one Size and one of the sizes in the returned list must be
1618         * passed to MediaRecorder.setVideoSize() for camcorder application if
1619         * camera is used as the video source. In this case, the size of the
1620         * preview can be different from the resolution of the recorded video
1621         * during video recording.
1622         *
1623         * @return a list of Size object if camera has separate preview and
1624         *         video output; otherwise, null is returned.
1625         * @see #getPreferredPreviewSizeForVideo()
1626         */
1627        public List<Size> getSupportedVideoSizes() {
1628            String str = get(KEY_VIDEO_SIZE + SUPPORTED_VALUES_SUFFIX);
1629            return splitSize(str);
1630        }
1631
1632        /**
1633         * Returns the preferred or recommended preview size (width and height)
1634         * in pixels for video recording. Camcorder applications should
1635         * set the preview size to a value that is not larger than the
1636         * preferred preview size. In other words, the product of the width
1637         * and height of the preview size should not be larger than that of
1638         * the preferred preview size. In addition, we recommend to choose a
1639         * preview size that has the same aspect ratio as the resolution of
1640         * video to be recorded.
1641         *
1642         * @return the preferred preview size (width and height) in pixels for
1643         *         video recording if getSupportedVideoSizes() does not return
1644         *         null; otherwise, null is returned.
1645         * @see #getSupportedVideoSizes()
1646         */
1647        public Size getPreferredPreviewSizeForVideo() {
1648            String pair = get(KEY_PREFERRED_PREVIEW_SIZE_FOR_VIDEO);
1649            return strToSize(pair);
1650        }
1651
1652        /**
1653         * Sets the dimensions for EXIF thumbnail in Jpeg picture. If
1654         * applications set both width and height to 0, EXIF will not contain
1655         * thumbnail.
1656         *
1657         * Applications need to consider the display orientation. See {@link
1658         * #setPreviewSize(int,int)} for reference.
1659         *
1660         * @param width  the width of the thumbnail, in pixels
1661         * @param height the height of the thumbnail, in pixels
1662         * @see #setPreviewSize(int,int)
1663         */
1664        public void setJpegThumbnailSize(int width, int height) {
1665            set(KEY_JPEG_THUMBNAIL_WIDTH, width);
1666            set(KEY_JPEG_THUMBNAIL_HEIGHT, height);
1667        }
1668
1669        /**
1670         * Returns the dimensions for EXIF thumbnail in Jpeg picture.
1671         *
1672         * @return a Size object with the height and width setting for the EXIF
1673         *         thumbnails
1674         */
1675        public Size getJpegThumbnailSize() {
1676            return new Size(getInt(KEY_JPEG_THUMBNAIL_WIDTH),
1677                            getInt(KEY_JPEG_THUMBNAIL_HEIGHT));
1678        }
1679
1680        /**
1681         * Gets the supported jpeg thumbnail sizes.
1682         *
1683         * @return a list of Size object. This method will always return a list
1684         *         with at least two elements. Size 0,0 (no thumbnail) is always
1685         *         supported.
1686         */
1687        public List<Size> getSupportedJpegThumbnailSizes() {
1688            String str = get(KEY_JPEG_THUMBNAIL_SIZE + SUPPORTED_VALUES_SUFFIX);
1689            return splitSize(str);
1690        }
1691
1692        /**
1693         * Sets the quality of the EXIF thumbnail in Jpeg picture.
1694         *
1695         * @param quality the JPEG quality of the EXIF thumbnail. The range is 1
1696         *                to 100, with 100 being the best.
1697         */
1698        public void setJpegThumbnailQuality(int quality) {
1699            set(KEY_JPEG_THUMBNAIL_QUALITY, quality);
1700        }
1701
1702        /**
1703         * Returns the quality setting for the EXIF thumbnail in Jpeg picture.
1704         *
1705         * @return the JPEG quality setting of the EXIF thumbnail.
1706         */
1707        public int getJpegThumbnailQuality() {
1708            return getInt(KEY_JPEG_THUMBNAIL_QUALITY);
1709        }
1710
1711        /**
1712         * Sets Jpeg quality of captured picture.
1713         *
1714         * @param quality the JPEG quality of captured picture. The range is 1
1715         *                to 100, with 100 being the best.
1716         */
1717        public void setJpegQuality(int quality) {
1718            set(KEY_JPEG_QUALITY, quality);
1719        }
1720
1721        /**
1722         * Returns the quality setting for the JPEG picture.
1723         *
1724         * @return the JPEG picture quality setting.
1725         */
1726        public int getJpegQuality() {
1727            return getInt(KEY_JPEG_QUALITY);
1728        }
1729
1730        /**
1731         * Sets the rate at which preview frames are received. This is the
1732         * target frame rate. The actual frame rate depends on the driver.
1733         *
1734         * @param fps the frame rate (frames per second)
1735         * @deprecated replaced by {@link #setPreviewFpsRange(int,int)}
1736         */
1737        @Deprecated
1738        public void setPreviewFrameRate(int fps) {
1739            set(KEY_PREVIEW_FRAME_RATE, fps);
1740        }
1741
1742        /**
1743         * Returns the setting for the rate at which preview frames are
1744         * received. This is the target frame rate. The actual frame rate
1745         * depends on the driver.
1746         *
1747         * @return the frame rate setting (frames per second)
1748         * @deprecated replaced by {@link #getPreviewFpsRange(int[])}
1749         */
1750        @Deprecated
1751        public int getPreviewFrameRate() {
1752            return getInt(KEY_PREVIEW_FRAME_RATE);
1753        }
1754
1755        /**
1756         * Gets the supported preview frame rates.
1757         *
1758         * @return a list of supported preview frame rates. null if preview
1759         *         frame rate setting is not supported.
1760         * @deprecated replaced by {@link #getSupportedPreviewFpsRange()}
1761         */
1762        @Deprecated
1763        public List<Integer> getSupportedPreviewFrameRates() {
1764            String str = get(KEY_PREVIEW_FRAME_RATE + SUPPORTED_VALUES_SUFFIX);
1765            return splitInt(str);
1766        }
1767
1768        /**
1769         * Sets the maximum and maximum preview fps. This controls the rate of
1770         * preview frames received in {@link PreviewCallback}. The minimum and
1771         * maximum preview fps must be one of the elements from {@link
1772         * #getSupportedPreviewFpsRange}.
1773         *
1774         * @param min the minimum preview fps (scaled by 1000).
1775         * @param max the maximum preview fps (scaled by 1000).
1776         * @throws RuntimeException if fps range is invalid.
1777         * @see #setPreviewCallbackWithBuffer(Camera.PreviewCallback)
1778         * @see #getSupportedPreviewFpsRange()
1779         */
1780        public void setPreviewFpsRange(int min, int max) {
1781            set(KEY_PREVIEW_FPS_RANGE, "" + min + "," + max);
1782        }
1783
1784        /**
1785         * Returns the current minimum and maximum preview fps. The values are
1786         * one of the elements returned by {@link #getSupportedPreviewFpsRange}.
1787         *
1788         * @return range the minimum and maximum preview fps (scaled by 1000).
1789         * @see #PREVIEW_FPS_MIN_INDEX
1790         * @see #PREVIEW_FPS_MAX_INDEX
1791         * @see #getSupportedPreviewFpsRange()
1792         */
1793        public void getPreviewFpsRange(int[] range) {
1794            if (range == null || range.length != 2) {
1795                throw new IllegalArgumentException(
1796                        "range must be an array with two elements.");
1797            }
1798            splitInt(get(KEY_PREVIEW_FPS_RANGE), range);
1799        }
1800
1801        /**
1802         * Gets the supported preview fps (frame-per-second) ranges. Each range
1803         * contains a minimum fps and maximum fps. If minimum fps equals to
1804         * maximum fps, the camera outputs frames in fixed frame rate. If not,
1805         * the camera outputs frames in auto frame rate. The actual frame rate
1806         * fluctuates between the minimum and the maximum. The values are
1807         * multiplied by 1000 and represented in integers. For example, if frame
1808         * rate is 26.623 frames per second, the value is 26623.
1809         *
1810         * @return a list of supported preview fps ranges. This method returns a
1811         *         list with at least one element. Every element is an int array
1812         *         of two values - minimum fps and maximum fps. The list is
1813         *         sorted from small to large (first by maximum fps and then
1814         *         minimum fps).
1815         * @see #PREVIEW_FPS_MIN_INDEX
1816         * @see #PREVIEW_FPS_MAX_INDEX
1817         */
1818        public List<int[]> getSupportedPreviewFpsRange() {
1819            String str = get(KEY_PREVIEW_FPS_RANGE + SUPPORTED_VALUES_SUFFIX);
1820            return splitRange(str);
1821        }
1822
1823        /**
1824         * Sets the image format for preview pictures.
1825         * <p>If this is never called, the default format will be
1826         * {@link android.graphics.ImageFormat#NV21}, which
1827         * uses the NV21 encoding format.</p>
1828         *
1829         * @param pixel_format the desired preview picture format, defined
1830         *   by one of the {@link android.graphics.ImageFormat} constants.
1831         *   (E.g., <var>ImageFormat.NV21</var> (default),
1832         *                      <var>ImageFormat.RGB_565</var>, or
1833         *                      <var>ImageFormat.JPEG</var>)
1834         * @see android.graphics.ImageFormat
1835         */
1836        public void setPreviewFormat(int pixel_format) {
1837            String s = cameraFormatForPixelFormat(pixel_format);
1838            if (s == null) {
1839                throw new IllegalArgumentException(
1840                        "Invalid pixel_format=" + pixel_format);
1841            }
1842
1843            set(KEY_PREVIEW_FORMAT, s);
1844        }
1845
1846        /**
1847         * Returns the image format for preview frames got from
1848         * {@link PreviewCallback}.
1849         *
1850         * @return the preview format.
1851         * @see android.graphics.ImageFormat
1852         */
1853        public int getPreviewFormat() {
1854            return pixelFormatForCameraFormat(get(KEY_PREVIEW_FORMAT));
1855        }
1856
1857        /**
1858         * Gets the supported preview formats. {@link android.graphics.ImageFormat#NV21}
1859         * is always supported. {@link android.graphics.ImageFormat#YV12}
1860         * is always supported since API level 12.
1861         *
1862         * @return a list of supported preview formats. This method will always
1863         *         return a list with at least one element.
1864         * @see android.graphics.ImageFormat
1865         */
1866        public List<Integer> getSupportedPreviewFormats() {
1867            String str = get(KEY_PREVIEW_FORMAT + SUPPORTED_VALUES_SUFFIX);
1868            ArrayList<Integer> formats = new ArrayList<Integer>();
1869            for (String s : split(str)) {
1870                int f = pixelFormatForCameraFormat(s);
1871                if (f == ImageFormat.UNKNOWN) continue;
1872                formats.add(f);
1873            }
1874            return formats;
1875        }
1876
1877        /**
1878         * Sets the dimensions for pictures.
1879         *
1880         * Applications need to consider the display orientation. See {@link
1881         * #setPreviewSize(int,int)} for reference.
1882         *
1883         * @param width  the width for pictures, in pixels
1884         * @param height the height for pictures, in pixels
1885         * @see #setPreviewSize(int,int)
1886         *
1887         */
1888        public void setPictureSize(int width, int height) {
1889            String v = Integer.toString(width) + "x" + Integer.toString(height);
1890            set(KEY_PICTURE_SIZE, v);
1891        }
1892
1893        /**
1894         * Returns the dimension setting for pictures.
1895         *
1896         * @return a Size object with the height and width setting
1897         *          for pictures
1898         */
1899        public Size getPictureSize() {
1900            String pair = get(KEY_PICTURE_SIZE);
1901            return strToSize(pair);
1902        }
1903
1904        /**
1905         * Gets the supported picture sizes.
1906         *
1907         * @return a list of supported picture sizes. This method will always
1908         *         return a list with at least one element.
1909         */
1910        public List<Size> getSupportedPictureSizes() {
1911            String str = get(KEY_PICTURE_SIZE + SUPPORTED_VALUES_SUFFIX);
1912            return splitSize(str);
1913        }
1914
1915        /**
1916         * Sets the image format for pictures.
1917         *
1918         * @param pixel_format the desired picture format
1919         *                     (<var>ImageFormat.NV21</var>,
1920         *                      <var>ImageFormat.RGB_565</var>, or
1921         *                      <var>ImageFormat.JPEG</var>)
1922         * @see android.graphics.ImageFormat
1923         */
1924        public void setPictureFormat(int pixel_format) {
1925            String s = cameraFormatForPixelFormat(pixel_format);
1926            if (s == null) {
1927                throw new IllegalArgumentException(
1928                        "Invalid pixel_format=" + pixel_format);
1929            }
1930
1931            set(KEY_PICTURE_FORMAT, s);
1932        }
1933
1934        /**
1935         * Returns the image format for pictures.
1936         *
1937         * @return the picture format
1938         * @see android.graphics.ImageFormat
1939         */
1940        public int getPictureFormat() {
1941            return pixelFormatForCameraFormat(get(KEY_PICTURE_FORMAT));
1942        }
1943
1944        /**
1945         * Gets the supported picture formats.
1946         *
1947         * @return supported picture formats. This method will always return a
1948         *         list with at least one element.
1949         * @see android.graphics.ImageFormat
1950         */
1951        public List<Integer> getSupportedPictureFormats() {
1952            String str = get(KEY_PICTURE_FORMAT + SUPPORTED_VALUES_SUFFIX);
1953            ArrayList<Integer> formats = new ArrayList<Integer>();
1954            for (String s : split(str)) {
1955                int f = pixelFormatForCameraFormat(s);
1956                if (f == ImageFormat.UNKNOWN) continue;
1957                formats.add(f);
1958            }
1959            return formats;
1960        }
1961
1962        private String cameraFormatForPixelFormat(int pixel_format) {
1963            switch(pixel_format) {
1964            case ImageFormat.NV16:      return PIXEL_FORMAT_YUV422SP;
1965            case ImageFormat.NV21:      return PIXEL_FORMAT_YUV420SP;
1966            case ImageFormat.YUY2:      return PIXEL_FORMAT_YUV422I;
1967            case ImageFormat.YV12:      return PIXEL_FORMAT_YUV420P;
1968            case ImageFormat.RGB_565:   return PIXEL_FORMAT_RGB565;
1969            case ImageFormat.JPEG:      return PIXEL_FORMAT_JPEG;
1970            default:                    return null;
1971            }
1972        }
1973
1974        private int pixelFormatForCameraFormat(String format) {
1975            if (format == null)
1976                return ImageFormat.UNKNOWN;
1977
1978            if (format.equals(PIXEL_FORMAT_YUV422SP))
1979                return ImageFormat.NV16;
1980
1981            if (format.equals(PIXEL_FORMAT_YUV420SP))
1982                return ImageFormat.NV21;
1983
1984            if (format.equals(PIXEL_FORMAT_YUV422I))
1985                return ImageFormat.YUY2;
1986
1987            if (format.equals(PIXEL_FORMAT_YUV420P))
1988                return ImageFormat.YV12;
1989
1990            if (format.equals(PIXEL_FORMAT_RGB565))
1991                return ImageFormat.RGB_565;
1992
1993            if (format.equals(PIXEL_FORMAT_JPEG))
1994                return ImageFormat.JPEG;
1995
1996            return ImageFormat.UNKNOWN;
1997        }
1998
1999        /**
2000         * Sets the rotation angle in degrees relative to the orientation of
2001         * the camera. This affects the pictures returned from JPEG {@link
2002         * PictureCallback}. The camera driver may set orientation in the
2003         * EXIF header without rotating the picture. Or the driver may rotate
2004         * the picture and the EXIF thumbnail. If the Jpeg picture is rotated,
2005         * the orientation in the EXIF header will be missing or 1 (row #0 is
2006         * top and column #0 is left side).
2007         *
2008         * <p>If applications want to rotate the picture to match the orientation
2009         * of what users see, apps should use {@link
2010         * android.view.OrientationEventListener} and {@link CameraInfo}.
2011         * The value from OrientationEventListener is relative to the natural
2012         * orientation of the device. CameraInfo.orientation is the angle
2013         * between camera orientation and natural device orientation. The sum
2014         * of the two is the rotation angle for back-facing camera. The
2015         * difference of the two is the rotation angle for front-facing camera.
2016         * Note that the JPEG pictures of front-facing cameras are not mirrored
2017         * as in preview display.
2018         *
2019         * <p>For example, suppose the natural orientation of the device is
2020         * portrait. The device is rotated 270 degrees clockwise, so the device
2021         * orientation is 270. Suppose a back-facing camera sensor is mounted in
2022         * landscape and the top side of the camera sensor is aligned with the
2023         * right edge of the display in natural orientation. So the camera
2024         * orientation is 90. The rotation should be set to 0 (270 + 90).
2025         *
2026         * <p>The reference code is as follows.
2027         *
2028	 * <pre>
2029         * public void public void onOrientationChanged(int orientation) {
2030         *     if (orientation == ORIENTATION_UNKNOWN) return;
2031         *     android.hardware.Camera.CameraInfo info =
2032         *            new android.hardware.Camera.CameraInfo();
2033         *     android.hardware.Camera.getCameraInfo(cameraId, info);
2034         *     orientation = (orientation + 45) / 90 * 90;
2035         *     int rotation = 0;
2036         *     if (info.facing == CameraInfo.CAMERA_FACING_FRONT) {
2037         *         rotation = (info.orientation - orientation + 360) % 360;
2038         *     } else {  // back-facing camera
2039         *         rotation = (info.orientation + orientation) % 360;
2040         *     }
2041         *     mParameters.setRotation(rotation);
2042         * }
2043	 * </pre>
2044         *
2045         * @param rotation The rotation angle in degrees relative to the
2046         *                 orientation of the camera. Rotation can only be 0,
2047         *                 90, 180 or 270.
2048         * @throws IllegalArgumentException if rotation value is invalid.
2049         * @see android.view.OrientationEventListener
2050         * @see #getCameraInfo(int, CameraInfo)
2051         */
2052        public void setRotation(int rotation) {
2053            if (rotation == 0 || rotation == 90 || rotation == 180
2054                    || rotation == 270) {
2055                set(KEY_ROTATION, Integer.toString(rotation));
2056            } else {
2057                throw new IllegalArgumentException(
2058                        "Invalid rotation=" + rotation);
2059            }
2060        }
2061
2062        /**
2063         * Sets GPS latitude coordinate. This will be stored in JPEG EXIF
2064         * header.
2065         *
2066         * @param latitude GPS latitude coordinate.
2067         */
2068        public void setGpsLatitude(double latitude) {
2069            set(KEY_GPS_LATITUDE, Double.toString(latitude));
2070        }
2071
2072        /**
2073         * Sets GPS longitude coordinate. This will be stored in JPEG EXIF
2074         * header.
2075         *
2076         * @param longitude GPS longitude coordinate.
2077         */
2078        public void setGpsLongitude(double longitude) {
2079            set(KEY_GPS_LONGITUDE, Double.toString(longitude));
2080        }
2081
2082        /**
2083         * Sets GPS altitude. This will be stored in JPEG EXIF header.
2084         *
2085         * @param altitude GPS altitude in meters.
2086         */
2087        public void setGpsAltitude(double altitude) {
2088            set(KEY_GPS_ALTITUDE, Double.toString(altitude));
2089        }
2090
2091        /**
2092         * Sets GPS timestamp. This will be stored in JPEG EXIF header.
2093         *
2094         * @param timestamp GPS timestamp (UTC in seconds since January 1,
2095         *                  1970).
2096         */
2097        public void setGpsTimestamp(long timestamp) {
2098            set(KEY_GPS_TIMESTAMP, Long.toString(timestamp));
2099        }
2100
2101        /**
2102         * Sets GPS processing method. It will store up to 32 characters
2103         * in JPEG EXIF header.
2104         *
2105         * @param processing_method The processing method to get this location.
2106         */
2107        public void setGpsProcessingMethod(String processing_method) {
2108            set(KEY_GPS_PROCESSING_METHOD, processing_method);
2109        }
2110
2111        /**
2112         * Removes GPS latitude, longitude, altitude, and timestamp from the
2113         * parameters.
2114         */
2115        public void removeGpsData() {
2116            remove(KEY_GPS_LATITUDE);
2117            remove(KEY_GPS_LONGITUDE);
2118            remove(KEY_GPS_ALTITUDE);
2119            remove(KEY_GPS_TIMESTAMP);
2120            remove(KEY_GPS_PROCESSING_METHOD);
2121        }
2122
2123        /**
2124         * Gets the current white balance setting.
2125         *
2126         * @return current white balance. null if white balance setting is not
2127         *         supported.
2128         * @see #WHITE_BALANCE_AUTO
2129         * @see #WHITE_BALANCE_INCANDESCENT
2130         * @see #WHITE_BALANCE_FLUORESCENT
2131         * @see #WHITE_BALANCE_WARM_FLUORESCENT
2132         * @see #WHITE_BALANCE_DAYLIGHT
2133         * @see #WHITE_BALANCE_CLOUDY_DAYLIGHT
2134         * @see #WHITE_BALANCE_TWILIGHT
2135         * @see #WHITE_BALANCE_SHADE
2136         *
2137         */
2138        public String getWhiteBalance() {
2139            return get(KEY_WHITE_BALANCE);
2140        }
2141
2142        /**
2143         * Sets the white balance.
2144         *
2145         * @param value new white balance.
2146         * @see #getWhiteBalance()
2147         */
2148        public void setWhiteBalance(String value) {
2149            set(KEY_WHITE_BALANCE, value);
2150        }
2151
2152        /**
2153         * Gets the supported white balance.
2154         *
2155         * @return a list of supported white balance. null if white balance
2156         *         setting is not supported.
2157         * @see #getWhiteBalance()
2158         */
2159        public List<String> getSupportedWhiteBalance() {
2160            String str = get(KEY_WHITE_BALANCE + SUPPORTED_VALUES_SUFFIX);
2161            return split(str);
2162        }
2163
2164        /**
2165         * Gets the current color effect setting.
2166         *
2167         * @return current color effect. null if color effect
2168         *         setting is not supported.
2169         * @see #EFFECT_NONE
2170         * @see #EFFECT_MONO
2171         * @see #EFFECT_NEGATIVE
2172         * @see #EFFECT_SOLARIZE
2173         * @see #EFFECT_SEPIA
2174         * @see #EFFECT_POSTERIZE
2175         * @see #EFFECT_WHITEBOARD
2176         * @see #EFFECT_BLACKBOARD
2177         * @see #EFFECT_AQUA
2178         */
2179        public String getColorEffect() {
2180            return get(KEY_EFFECT);
2181        }
2182
2183        /**
2184         * Sets the current color effect setting.
2185         *
2186         * @param value new color effect.
2187         * @see #getColorEffect()
2188         */
2189        public void setColorEffect(String value) {
2190            set(KEY_EFFECT, value);
2191        }
2192
2193        /**
2194         * Gets the supported color effects.
2195         *
2196         * @return a list of supported color effects. null if color effect
2197         *         setting is not supported.
2198         * @see #getColorEffect()
2199         */
2200        public List<String> getSupportedColorEffects() {
2201            String str = get(KEY_EFFECT + SUPPORTED_VALUES_SUFFIX);
2202            return split(str);
2203        }
2204
2205
2206        /**
2207         * Gets the current antibanding setting.
2208         *
2209         * @return current antibanding. null if antibanding setting is not
2210         *         supported.
2211         * @see #ANTIBANDING_AUTO
2212         * @see #ANTIBANDING_50HZ
2213         * @see #ANTIBANDING_60HZ
2214         * @see #ANTIBANDING_OFF
2215         */
2216        public String getAntibanding() {
2217            return get(KEY_ANTIBANDING);
2218        }
2219
2220        /**
2221         * Sets the antibanding.
2222         *
2223         * @param antibanding new antibanding value.
2224         * @see #getAntibanding()
2225         */
2226        public void setAntibanding(String antibanding) {
2227            set(KEY_ANTIBANDING, antibanding);
2228        }
2229
2230        /**
2231         * Gets the supported antibanding values.
2232         *
2233         * @return a list of supported antibanding values. null if antibanding
2234         *         setting is not supported.
2235         * @see #getAntibanding()
2236         */
2237        public List<String> getSupportedAntibanding() {
2238            String str = get(KEY_ANTIBANDING + SUPPORTED_VALUES_SUFFIX);
2239            return split(str);
2240        }
2241
2242        /**
2243         * Gets the current scene mode setting.
2244         *
2245         * @return one of SCENE_MODE_XXX string constant. null if scene mode
2246         *         setting is not supported.
2247         * @see #SCENE_MODE_AUTO
2248         * @see #SCENE_MODE_ACTION
2249         * @see #SCENE_MODE_PORTRAIT
2250         * @see #SCENE_MODE_LANDSCAPE
2251         * @see #SCENE_MODE_NIGHT
2252         * @see #SCENE_MODE_NIGHT_PORTRAIT
2253         * @see #SCENE_MODE_THEATRE
2254         * @see #SCENE_MODE_BEACH
2255         * @see #SCENE_MODE_SNOW
2256         * @see #SCENE_MODE_SUNSET
2257         * @see #SCENE_MODE_STEADYPHOTO
2258         * @see #SCENE_MODE_FIREWORKS
2259         * @see #SCENE_MODE_SPORTS
2260         * @see #SCENE_MODE_PARTY
2261         * @see #SCENE_MODE_CANDLELIGHT
2262         */
2263        public String getSceneMode() {
2264            return get(KEY_SCENE_MODE);
2265        }
2266
2267        /**
2268         * Sets the scene mode. Changing scene mode may override other
2269         * parameters (such as flash mode, focus mode, white balance). For
2270         * example, suppose originally flash mode is on and supported flash
2271         * modes are on/off. In night scene mode, both flash mode and supported
2272         * flash mode may be changed to off. After setting scene mode,
2273         * applications should call getParameters to know if some parameters are
2274         * changed.
2275         *
2276         * @param value scene mode.
2277         * @see #getSceneMode()
2278         */
2279        public void setSceneMode(String value) {
2280            set(KEY_SCENE_MODE, value);
2281        }
2282
2283        /**
2284         * Gets the supported scene modes.
2285         *
2286         * @return a list of supported scene modes. null if scene mode setting
2287         *         is not supported.
2288         * @see #getSceneMode()
2289         */
2290        public List<String> getSupportedSceneModes() {
2291            String str = get(KEY_SCENE_MODE + SUPPORTED_VALUES_SUFFIX);
2292            return split(str);
2293        }
2294
2295        /**
2296         * Gets the current flash mode setting.
2297         *
2298         * @return current flash mode. null if flash mode setting is not
2299         *         supported.
2300         * @see #FLASH_MODE_OFF
2301         * @see #FLASH_MODE_AUTO
2302         * @see #FLASH_MODE_ON
2303         * @see #FLASH_MODE_RED_EYE
2304         * @see #FLASH_MODE_TORCH
2305         */
2306        public String getFlashMode() {
2307            return get(KEY_FLASH_MODE);
2308        }
2309
2310        /**
2311         * Sets the flash mode.
2312         *
2313         * @param value flash mode.
2314         * @see #getFlashMode()
2315         */
2316        public void setFlashMode(String value) {
2317            set(KEY_FLASH_MODE, value);
2318        }
2319
2320        /**
2321         * Gets the supported flash modes.
2322         *
2323         * @return a list of supported flash modes. null if flash mode setting
2324         *         is not supported.
2325         * @see #getFlashMode()
2326         */
2327        public List<String> getSupportedFlashModes() {
2328            String str = get(KEY_FLASH_MODE + SUPPORTED_VALUES_SUFFIX);
2329            return split(str);
2330        }
2331
2332        /**
2333         * Gets the current focus mode setting.
2334         *
2335         * @return current focus mode. This method will always return a non-null
2336         *         value. Applications should call {@link
2337         *         #autoFocus(AutoFocusCallback)} to start the focus if focus
2338         *         mode is FOCUS_MODE_AUTO or FOCUS_MODE_MACRO.
2339         * @see #FOCUS_MODE_AUTO
2340         * @see #FOCUS_MODE_INFINITY
2341         * @see #FOCUS_MODE_MACRO
2342         * @see #FOCUS_MODE_FIXED
2343         * @see #FOCUS_MODE_EDOF
2344         * @see #FOCUS_MODE_CONTINUOUS_VIDEO
2345         */
2346        public String getFocusMode() {
2347            return get(KEY_FOCUS_MODE);
2348        }
2349
2350        /**
2351         * Sets the focus mode.
2352         *
2353         * @param value focus mode.
2354         * @see #getFocusMode()
2355         */
2356        public void setFocusMode(String value) {
2357            set(KEY_FOCUS_MODE, value);
2358        }
2359
2360        /**
2361         * Gets the supported focus modes.
2362         *
2363         * @return a list of supported focus modes. This method will always
2364         *         return a list with at least one element.
2365         * @see #getFocusMode()
2366         */
2367        public List<String> getSupportedFocusModes() {
2368            String str = get(KEY_FOCUS_MODE + SUPPORTED_VALUES_SUFFIX);
2369            return split(str);
2370        }
2371
2372        /**
2373         * Gets the focal length (in millimeter) of the camera.
2374         *
2375         * @return the focal length. This method will always return a valid
2376         *         value.
2377         */
2378        public float getFocalLength() {
2379            return Float.parseFloat(get(KEY_FOCAL_LENGTH));
2380        }
2381
2382        /**
2383         * Gets the horizontal angle of view in degrees.
2384         *
2385         * @return horizontal angle of view. This method will always return a
2386         *         valid value.
2387         */
2388        public float getHorizontalViewAngle() {
2389            return Float.parseFloat(get(KEY_HORIZONTAL_VIEW_ANGLE));
2390        }
2391
2392        /**
2393         * Gets the vertical angle of view in degrees.
2394         *
2395         * @return vertical angle of view. This method will always return a
2396         *         valid value.
2397         */
2398        public float getVerticalViewAngle() {
2399            return Float.parseFloat(get(KEY_VERTICAL_VIEW_ANGLE));
2400        }
2401
2402        /**
2403         * Gets the current exposure compensation index.
2404         *
2405         * @return current exposure compensation index. The range is {@link
2406         *         #getMinExposureCompensation} to {@link
2407         *         #getMaxExposureCompensation}. 0 means exposure is not
2408         *         adjusted.
2409         */
2410        public int getExposureCompensation() {
2411            return getInt(KEY_EXPOSURE_COMPENSATION, 0);
2412        }
2413
2414        /**
2415         * Sets the exposure compensation index.
2416         *
2417         * @param value exposure compensation index. The valid value range is
2418         *        from {@link #getMinExposureCompensation} (inclusive) to {@link
2419         *        #getMaxExposureCompensation} (inclusive). 0 means exposure is
2420         *        not adjusted. Application should call
2421         *        getMinExposureCompensation and getMaxExposureCompensation to
2422         *        know if exposure compensation is supported.
2423         */
2424        public void setExposureCompensation(int value) {
2425            set(KEY_EXPOSURE_COMPENSATION, value);
2426        }
2427
2428        /**
2429         * Gets the maximum exposure compensation index.
2430         *
2431         * @return maximum exposure compensation index (>=0). If both this
2432         *         method and {@link #getMinExposureCompensation} return 0,
2433         *         exposure compensation is not supported.
2434         */
2435        public int getMaxExposureCompensation() {
2436            return getInt(KEY_MAX_EXPOSURE_COMPENSATION, 0);
2437        }
2438
2439        /**
2440         * Gets the minimum exposure compensation index.
2441         *
2442         * @return minimum exposure compensation index (<=0). If both this
2443         *         method and {@link #getMaxExposureCompensation} return 0,
2444         *         exposure compensation is not supported.
2445         */
2446        public int getMinExposureCompensation() {
2447            return getInt(KEY_MIN_EXPOSURE_COMPENSATION, 0);
2448        }
2449
2450        /**
2451         * Gets the exposure compensation step.
2452         *
2453         * @return exposure compensation step. Applications can get EV by
2454         *         multiplying the exposure compensation index and step. Ex: if
2455         *         exposure compensation index is -6 and step is 0.333333333, EV
2456         *         is -2.
2457         */
2458        public float getExposureCompensationStep() {
2459            return getFloat(KEY_EXPOSURE_COMPENSATION_STEP, 0);
2460        }
2461
2462        /**
2463         * Gets current zoom value. This also works when smooth zoom is in
2464         * progress. Applications should check {@link #isZoomSupported} before
2465         * using this method.
2466         *
2467         * @return the current zoom value. The range is 0 to {@link
2468         *         #getMaxZoom}. 0 means the camera is not zoomed.
2469         */
2470        public int getZoom() {
2471            return getInt(KEY_ZOOM, 0);
2472        }
2473
2474        /**
2475         * Sets current zoom value. If the camera is zoomed (value > 0), the
2476         * actual picture size may be smaller than picture size setting.
2477         * Applications can check the actual picture size after picture is
2478         * returned from {@link PictureCallback}. The preview size remains the
2479         * same in zoom. Applications should check {@link #isZoomSupported}
2480         * before using this method.
2481         *
2482         * @param value zoom value. The valid range is 0 to {@link #getMaxZoom}.
2483         */
2484        public void setZoom(int value) {
2485            set(KEY_ZOOM, value);
2486        }
2487
2488        /**
2489         * Returns true if zoom is supported. Applications should call this
2490         * before using other zoom methods.
2491         *
2492         * @return true if zoom is supported.
2493         */
2494        public boolean isZoomSupported() {
2495            String str = get(KEY_ZOOM_SUPPORTED);
2496            return TRUE.equals(str);
2497        }
2498
2499        /**
2500         * Gets the maximum zoom value allowed for snapshot. This is the maximum
2501         * value that applications can set to {@link #setZoom(int)}.
2502         * Applications should call {@link #isZoomSupported} before using this
2503         * method. This value may change in different preview size. Applications
2504         * should call this again after setting preview size.
2505         *
2506         * @return the maximum zoom value supported by the camera.
2507         */
2508        public int getMaxZoom() {
2509            return getInt(KEY_MAX_ZOOM, 0);
2510        }
2511
2512        /**
2513         * Gets the zoom ratios of all zoom values. Applications should check
2514         * {@link #isZoomSupported} before using this method.
2515         *
2516         * @return the zoom ratios in 1/100 increments. Ex: a zoom of 3.2x is
2517         *         returned as 320. The number of elements is {@link
2518         *         #getMaxZoom} + 1. The list is sorted from small to large. The
2519         *         first element is always 100. The last element is the zoom
2520         *         ratio of the maximum zoom value.
2521         */
2522        public List<Integer> getZoomRatios() {
2523            return splitInt(get(KEY_ZOOM_RATIOS));
2524        }
2525
2526        /**
2527         * Returns true if smooth zoom is supported. Applications should call
2528         * this before using other smooth zoom methods.
2529         *
2530         * @return true if smooth zoom is supported.
2531         */
2532        public boolean isSmoothZoomSupported() {
2533            String str = get(KEY_SMOOTH_ZOOM_SUPPORTED);
2534            return TRUE.equals(str);
2535        }
2536
2537        /**
2538         * Gets the distances from the camera to where an object appears to be
2539         * in focus. The object is sharpest at the optimal focus distance. The
2540         * depth of field is the far focus distance minus near focus distance.
2541         *
2542         * Focus distances may change after calling {@link
2543         * #autoFocus(AutoFocusCallback)}, {@link #cancelAutoFocus}, or {@link
2544         * #startPreview()}. Applications can call {@link #getParameters()}
2545         * and this method anytime to get the latest focus distances. If the
2546         * focus mode is FOCUS_MODE_CONTINUOUS_VIDEO, focus distances may change
2547         * from time to time.
2548         *
2549         * This method is intended to estimate the distance between the camera
2550         * and the subject. After autofocus, the subject distance may be within
2551         * near and far focus distance. However, the precision depends on the
2552         * camera hardware, autofocus algorithm, the focus area, and the scene.
2553         * The error can be large and it should be only used as a reference.
2554         *
2555         * Far focus distance >= optimal focus distance >= near focus distance.
2556         * If the focus distance is infinity, the value will be
2557         * Float.POSITIVE_INFINITY.
2558         *
2559         * @param output focus distances in meters. output must be a float
2560         *        array with three elements. Near focus distance, optimal focus
2561         *        distance, and far focus distance will be filled in the array.
2562         * @see #FOCUS_DISTANCE_NEAR_INDEX
2563         * @see #FOCUS_DISTANCE_OPTIMAL_INDEX
2564         * @see #FOCUS_DISTANCE_FAR_INDEX
2565         */
2566        public void getFocusDistances(float[] output) {
2567            if (output == null || output.length != 3) {
2568                throw new IllegalArgumentException(
2569                        "output must be an float array with three elements.");
2570            }
2571            splitFloat(get(KEY_FOCUS_DISTANCES), output);
2572        }
2573
2574        /**
2575         * Gets the maximum number of focus areas supported. This is the maximum
2576         * length of the list in {@link #setFocusArea(List<Area>)} and
2577         * {@link #getFocusArea()}.
2578         *
2579         * @return the maximum number of focus areas supported by the camera.
2580         * @see #getFocusAreas()
2581         * @hide
2582         */
2583        public int getMaxNumFocusAreas() {
2584            return getInt(KEY_MAX_NUM_FOCUS_AREAS, 0);
2585        }
2586
2587        /**
2588         * Gets the current focus areas. Camera driver uses the areas to decide
2589         * focus.
2590         *
2591         * Before using this API or {@link #setFocusAreas(List<int>)}, apps
2592         * should call {@link #getMaxNumFocusArea()} to know the maximum number of
2593         * focus areas first. If the value is 0, focus area is not supported.
2594         *
2595         * Each focus area is a rectangle with specified weight. The direction
2596         * is relative to the sensor orientation, that is, what the sensor sees.
2597         * The direction is not affected by the rotation or mirroring of
2598         * {@link #setDisplayOrientation(int)}. Coordinates of the rectangle
2599         * range from -1000 to 1000. (-1000, -1000) is the upper left point.
2600         * (1000, 1000) is the lower right point. The length and width of focus
2601         * areas cannot be 0 or negative.
2602         *
2603         * The weight must range from 1 to 1000. The weight should be
2604         * interpreted as a per-pixel weight - all pixels in the area have the
2605         * specified weight. This means a small area with the same weight as a
2606         * larger area will have less influence on the focusing than the larger
2607         * area. Focus areas can partially overlap and the driver will add the
2608         * weights in the overlap region.
2609         *
2610         * A special case of all-zero single focus area means driver to decide
2611         * the focus area. For example, the driver may use more signals to
2612         * decide focus areas and change them dynamically. Apps can set all-zero
2613         * if they want the driver to decide focus areas.
2614         *
2615         * Focus areas are relative to the current field of view
2616         * ({@link #getZoom()}). No matter what the zoom level is, (-1000,-1000)
2617         * represents the top of the currently visible camera frame. The focus
2618         * area cannot be set to be outside the current field of view, even
2619         * when using zoom.
2620         *
2621         * Focus area only has effect if the current focus mode is
2622         * {@link #FOCUS_MODE_AUTO}, {@link #FOCUS_MODE_MACRO}, or
2623         * {@link #FOCUS_MODE_CONTINOUS_VIDEO}.
2624         *
2625         * @return a list of current focus areas
2626         * @hide
2627         */
2628        public List<Area> getFocusAreas() {
2629            return splitArea(KEY_FOCUS_AREAS);
2630        }
2631
2632        /**
2633         * Sets focus areas. See {@link #getFocusAreas()} for documentation.
2634         *
2635         * @param focusArea the focus areas
2636         * @see #getFocusAreas()
2637         * @hide
2638         */
2639        public void setFocusAreas(List<Area> focusAreas) {
2640            set(KEY_FOCUS_AREAS, focusAreas);
2641        }
2642
2643        /**
2644         * Gets the maximum number of metering areas supported. This is the
2645         * maximum length of the list in {@link #setMeteringArea(List<Area>)}
2646         * and {@link #getMeteringArea()}.
2647         *
2648         * @return the maximum number of metering areas supported by the camera.
2649         * @see #getMeteringAreas()
2650         * @hide
2651         */
2652        public int getMaxNumMeteringAreas() {
2653            return getInt(KEY_MAX_NUM_METERING_AREAS, 0);
2654        }
2655
2656        /**
2657         * Gets the current metering areas. Camera driver uses these areas to
2658         * decide exposure.
2659         *
2660         * Before using this API or {@link #setMeteringAreas(List<int>)}, apps
2661         * should call {@link #getMaxNumMeteringArea()} to know the maximum
2662         * number of metering areas first. If the value is 0, metering area is
2663         * not supported.
2664         *
2665         * Each metering area is a rectangle with specified weight. The
2666         * direction is relative to the sensor orientation, that is, what the
2667         * sensor sees. The direction is not affected by the rotation or
2668         * mirroring of {@link #setDisplayOrientation(int)}. Coordinates of the
2669         * rectangle range from -1000 to 1000. (-1000, -1000) is the upper left
2670         * point. (1000, 1000) is the lower right point. The length and width of
2671         * metering areas cannot be 0 or negative.
2672         *
2673         * The weight must range from 1 to 1000, and represents a weight for
2674         * every pixel in the area. This means that a large metering area with
2675         * the same weight as a smaller area will have more effect in the
2676         * metering result.  Metering areas can partially overlap and the driver
2677         * will add the weights in the overlap region.
2678         *
2679         * A special case of all-zero single metering area means driver to
2680         * decide the metering area. For example, the driver may use more
2681         * signals to decide metering areas and change them dynamically. Apps
2682         * can set all-zero if they want the driver to decide metering areas.
2683         *
2684         * Metering areas are relative to the current field of view
2685         * ({@link #getZoom()}). No matter what the zoom level is, (-1000,-1000)
2686         * represents the top of the currently visible camera frame. The
2687         * metering area cannot be set to be outside the current field of view,
2688         * even when using zoom.
2689         *
2690         * No matter what metering areas are, the final exposure are compensated
2691         * by {@link setExposureCompensation(int)}.
2692         *
2693         * @return a list of current metering areas
2694         * @hide
2695         */
2696        public List<Area> getMeteringAreas() {
2697            return splitArea(KEY_METERING_AREAS);
2698        }
2699
2700        /**
2701         * Sets metering areas. See {@link #getMeteringAreas()} for
2702         * documentation.
2703         *
2704         * @param meteringArea the metering areas
2705         * @see #getMeteringAreas()
2706         * @hide
2707         */
2708        public void setMeteringAreas(List<Area> meteringAreas) {
2709            set(KEY_METERING_AREAS, meteringAreas);
2710        }
2711
2712        // Splits a comma delimited string to an ArrayList of String.
2713        // Return null if the passing string is null or the size is 0.
2714        private ArrayList<String> split(String str) {
2715            if (str == null) return null;
2716
2717            // Use StringTokenizer because it is faster than split.
2718            StringTokenizer tokenizer = new StringTokenizer(str, ",");
2719            ArrayList<String> substrings = new ArrayList<String>();
2720            while (tokenizer.hasMoreElements()) {
2721                substrings.add(tokenizer.nextToken());
2722            }
2723            return substrings;
2724        }
2725
2726        // Splits a comma delimited string to an ArrayList of Integer.
2727        // Return null if the passing string is null or the size is 0.
2728        private ArrayList<Integer> splitInt(String str) {
2729            if (str == null) return null;
2730
2731            StringTokenizer tokenizer = new StringTokenizer(str, ",");
2732            ArrayList<Integer> substrings = new ArrayList<Integer>();
2733            while (tokenizer.hasMoreElements()) {
2734                String token = tokenizer.nextToken();
2735                substrings.add(Integer.parseInt(token));
2736            }
2737            if (substrings.size() == 0) return null;
2738            return substrings;
2739        }
2740
2741        private void splitInt(String str, int[] output) {
2742            if (str == null) return;
2743
2744            StringTokenizer tokenizer = new StringTokenizer(str, ",");
2745            int index = 0;
2746            while (tokenizer.hasMoreElements()) {
2747                String token = tokenizer.nextToken();
2748                output[index++] = Integer.parseInt(token);
2749            }
2750        }
2751
2752        // Splits a comma delimited string to an ArrayList of Float.
2753        private void splitFloat(String str, float[] output) {
2754            if (str == null) return;
2755
2756            StringTokenizer tokenizer = new StringTokenizer(str, ",");
2757            int index = 0;
2758            while (tokenizer.hasMoreElements()) {
2759                String token = tokenizer.nextToken();
2760                output[index++] = Float.parseFloat(token);
2761            }
2762        }
2763
2764        // Returns the value of a float parameter.
2765        private float getFloat(String key, float defaultValue) {
2766            try {
2767                return Float.parseFloat(mMap.get(key));
2768            } catch (NumberFormatException ex) {
2769                return defaultValue;
2770            }
2771        }
2772
2773        // Returns the value of a integer parameter.
2774        private int getInt(String key, int defaultValue) {
2775            try {
2776                return Integer.parseInt(mMap.get(key));
2777            } catch (NumberFormatException ex) {
2778                return defaultValue;
2779            }
2780        }
2781
2782        // Splits a comma delimited string to an ArrayList of Size.
2783        // Return null if the passing string is null or the size is 0.
2784        private ArrayList<Size> splitSize(String str) {
2785            if (str == null) return null;
2786
2787            StringTokenizer tokenizer = new StringTokenizer(str, ",");
2788            ArrayList<Size> sizeList = new ArrayList<Size>();
2789            while (tokenizer.hasMoreElements()) {
2790                Size size = strToSize(tokenizer.nextToken());
2791                if (size != null) sizeList.add(size);
2792            }
2793            if (sizeList.size() == 0) return null;
2794            return sizeList;
2795        }
2796
2797        // Parses a string (ex: "480x320") to Size object.
2798        // Return null if the passing string is null.
2799        private Size strToSize(String str) {
2800            if (str == null) return null;
2801
2802            int pos = str.indexOf('x');
2803            if (pos != -1) {
2804                String width = str.substring(0, pos);
2805                String height = str.substring(pos + 1);
2806                return new Size(Integer.parseInt(width),
2807                                Integer.parseInt(height));
2808            }
2809            Log.e(TAG, "Invalid size parameter string=" + str);
2810            return null;
2811        }
2812
2813        // Splits a comma delimited string to an ArrayList of int array.
2814        // Example string: "(10000,26623),(10000,30000)". Return null if the
2815        // passing string is null or the size is 0.
2816        private ArrayList<int[]> splitRange(String str) {
2817            if (str == null || str.charAt(0) != '('
2818                    || str.charAt(str.length() - 1) != ')') {
2819                Log.e(TAG, "Invalid range list string=" + str);
2820                return null;
2821            }
2822
2823            ArrayList<int[]> rangeList = new ArrayList<int[]>();
2824            int endIndex, fromIndex = 1;
2825            do {
2826                int[] range = new int[2];
2827                endIndex = str.indexOf("),(", fromIndex);
2828                if (endIndex == -1) endIndex = str.length() - 1;
2829                splitInt(str.substring(fromIndex, endIndex), range);
2830                rangeList.add(range);
2831                fromIndex = endIndex + 3;
2832            } while (endIndex != str.length() - 1);
2833
2834            if (rangeList.size() == 0) return null;
2835            return rangeList;
2836        }
2837
2838        // Splits a comma delimited string to an ArrayList of Area objects.
2839        // Example string: "(-10,-10,0,0,300),(0,0,10,10,700)". Return null if
2840        // the passing string is null or the size is 0.
2841        private ArrayList<Area> splitArea(String str) {
2842            if (str == null || str.charAt(0) != '('
2843                    || str.charAt(str.length() - 1) != ')') {
2844                Log.e(TAG, "Invalid area string=" + str);
2845                return null;
2846            }
2847
2848            ArrayList<Area> result = new ArrayList<Area>();
2849            int endIndex, fromIndex = 1;
2850            int[] array = new int[5];
2851            do {
2852                endIndex = str.indexOf("),(", fromIndex);
2853                if (endIndex == -1) endIndex = str.length() - 1;
2854                splitInt(str.substring(fromIndex, endIndex), array);
2855                Rect rect = new Rect(array[0], array[1], array[2], array[3]);
2856                result.add(new Area(rect, array[4]));
2857                fromIndex = endIndex + 3;
2858            } while (endIndex != str.length() - 1);
2859
2860            if (result.size() == 0) return null;
2861            return result;
2862        }
2863    };
2864}
2865