Camera.java revision 40057ce749c8c4d274db0352a2af4344bda92dba
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.PixelFormat;
30import android.os.Handler;
31import android.os.Looper;
32import android.os.Message;
33
34/**
35 * The Camera class is used to connect/disconnect with the camera service,
36 * set capture settings, start/stop preview, snap a picture, and retrieve
37 * frames for encoding for video.
38 * <p>There is no default constructor for this class. Use {@link #open()} to
39 * get a Camera object.</p>
40 *
41 * <p>In order to use 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 in order 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 class="caution"><strong>Caution:</strong> Different Android-powered devices
53 * may have different hardware specifications, such as megapixel ratings and
54 * auto-focus capabilities. In order for your application to be compatible with
55 * more devices, you should not make assumptions about the device camera
56 * specifications.</p>
57 */
58public class Camera {
59    private static final String TAG = "Camera";
60
61    // These match the enums in frameworks/base/include/ui/Camera.h
62    private static final int CAMERA_MSG_ERROR            = 0x001;
63    private static final int CAMERA_MSG_SHUTTER          = 0x002;
64    private static final int CAMERA_MSG_FOCUS            = 0x004;
65    private static final int CAMERA_MSG_ZOOM             = 0x008;
66    private static final int CAMERA_MSG_PREVIEW_FRAME    = 0x010;
67    private static final int CAMERA_MSG_VIDEO_FRAME      = 0x020;
68    private static final int CAMERA_MSG_POSTVIEW_FRAME   = 0x040;
69    private static final int CAMERA_MSG_RAW_IMAGE        = 0x080;
70    private static final int CAMERA_MSG_COMPRESSED_IMAGE = 0x100;
71    private static final int CAMERA_MSG_ALL_MSGS         = 0x1FF;
72
73    private int mNativeContext; // accessed by native methods
74    private EventHandler mEventHandler;
75    private ShutterCallback mShutterCallback;
76    private PictureCallback mRawImageCallback;
77    private PictureCallback mJpegCallback;
78    private PreviewCallback mPreviewCallback;
79    private PictureCallback mPostviewCallback;
80    private AutoFocusCallback mAutoFocusCallback;
81    private ZoomCallback mZoomCallback;
82    private ErrorCallback mErrorCallback;
83    private boolean mOneShot;
84    private boolean mWithBuffer;
85
86    /**
87     * Returns a new Camera object.
88     */
89    public static Camera open() {
90        return new Camera();
91    }
92
93    Camera() {
94        mShutterCallback = null;
95        mRawImageCallback = null;
96        mJpegCallback = null;
97        mPreviewCallback = null;
98        mPostviewCallback = null;
99        mZoomCallback = null;
100
101        Looper looper;
102        if ((looper = Looper.myLooper()) != null) {
103            mEventHandler = new EventHandler(this, looper);
104        } else if ((looper = Looper.getMainLooper()) != null) {
105            mEventHandler = new EventHandler(this, looper);
106        } else {
107            mEventHandler = null;
108        }
109
110        native_setup(new WeakReference<Camera>(this));
111    }
112
113    protected void finalize() {
114        native_release();
115    }
116
117    private native final void native_setup(Object camera_this);
118    private native final void native_release();
119
120
121    /**
122     * Disconnects and releases the Camera object resources.
123     * <p>It is recommended that you call this as soon as you're done with the
124     * Camera object.</p>
125     */
126    public final void release() {
127        native_release();
128    }
129
130    /**
131     * Reconnect to the camera after passing it to MediaRecorder. To save
132     * setup/teardown time, a client of Camera can pass an initialized Camera
133     * object to a MediaRecorder to use for video recording. Once the
134     * MediaRecorder is done with the Camera, this method can be used to
135     * re-establish a connection with the camera hardware. NOTE: The Camera
136     * object must first be unlocked by the process that owns it before it
137     * can be connected to another process.
138     *
139     * @throws IOException if the method fails.
140     *
141     * @hide
142     */
143    public native final void reconnect() throws IOException;
144
145    /**
146     * Lock the camera to prevent other processes from accessing it. To save
147     * setup/teardown time, a client of Camera can pass an initialized Camera
148     * object to another process. This method is used to re-lock the Camera
149     * object prevent other processes from accessing it. By default, the
150     * Camera object is locked. Locking it again from the same process will
151     * have no effect. Attempting to lock it from another process if it has
152     * not been unlocked will fail.
153     *
154     * @throws RuntimeException if the method fails.
155     */
156    public native final void lock();
157
158    /**
159     * Unlock the camera to allow another process to access it. To save
160     * setup/teardown time, a client of Camera can pass an initialized Camera
161     * object to another process. This method is used to unlock the Camera
162     * object before handing off the Camera object to the other process.
163     *
164     * @throws RuntimeException if the method fails.
165     */
166    public native final void unlock();
167
168    /**
169     * Sets the SurfaceHolder to be used for a picture preview. If the surface
170     * changed since the last call, the screen will blank. Nothing happens
171     * if the same surface is re-set.
172     *
173     * @param holder the SurfaceHolder upon which to place the picture preview
174     * @throws IOException if the method fails.
175     */
176    public final void setPreviewDisplay(SurfaceHolder holder) throws IOException {
177        if (holder != null) {
178            setPreviewDisplay(holder.getSurface());
179        } else {
180            setPreviewDisplay((Surface)null);
181        }
182    }
183
184    private native final void setPreviewDisplay(Surface surface);
185
186    /**
187     * Used to get a copy of each preview frame.
188     */
189    public interface PreviewCallback
190    {
191        /**
192         * The callback that delivers the preview frames.
193         *
194         * @param data The contents of the preview frame in the format defined
195         *  by {@link android.graphics.PixelFormat}, which can be queried
196         *  with {@link android.hardware.Camera.Parameters#getPreviewFormat()}.
197         *  If {@link android.hardware.Camera.Parameters#setPreviewFormat(int)}
198         *             is never called, the default will be the YCbCr_420_SP
199         *             (NV21) format.
200         * @param camera The Camera service object.
201         */
202        void onPreviewFrame(byte[] data, Camera camera);
203    };
204
205    /**
206     * Start drawing preview frames to the surface.
207     */
208    public native final void startPreview();
209
210    /**
211     * Stop drawing preview frames to the surface.
212     */
213    public native final void stopPreview();
214
215    /**
216     * Return current preview state.
217     *
218     * FIXME: Unhide before release
219     * @hide
220     */
221    public native final boolean previewEnabled();
222
223    /**
224     * Can be called at any time to instruct the camera to use a callback for
225     * each preview frame in addition to displaying it.
226     *
227     * @param cb A callback object that receives a copy of each preview frame.
228     *           Pass null to stop receiving callbacks at any time.
229     */
230    public final void setPreviewCallback(PreviewCallback cb) {
231        mPreviewCallback = cb;
232        mOneShot = false;
233        mWithBuffer = false;
234        // Always use one-shot mode. We fake camera preview mode by
235        // doing one-shot preview continuously.
236        setHasPreviewCallback(cb != null, false);
237    }
238
239    /**
240     * Installs a callback to retrieve a single preview frame, after which the
241     * callback is cleared.
242     *
243     * @param cb A callback object that receives a copy of the preview frame.
244     */
245    public final void setOneShotPreviewCallback(PreviewCallback cb) {
246        mPreviewCallback = cb;
247        mOneShot = true;
248        mWithBuffer = false;
249        setHasPreviewCallback(cb != null, false);
250    }
251
252    private native final void setHasPreviewCallback(boolean installed, boolean manualBuffer);
253
254    /**
255     * Installs a callback which will get called as long as there are buffers in the
256     * preview buffer queue, which minimizes dynamic allocation of preview buffers.
257     *
258     * Apps must call addCallbackBuffer to explicitly register the buffers to use, or no callbacks
259     * will be received. addCallbackBuffer may be safely called before or after
260     * a call to setPreviewCallbackWithBuffer with a non-null callback parameter.
261     *
262     * The buffer queue will be cleared upon any calls to setOneShotPreviewCallback,
263     * setPreviewCallback, or to this method with a null callback parameter.
264     *
265     * @param cb A callback object that receives a copy of the preview frame.  A null value will clear the queue.
266     * @hide
267     */
268    public final void setPreviewCallbackWithBuffer(PreviewCallback cb) {
269        mPreviewCallback = cb;
270        mOneShot = false;
271        mWithBuffer = true;
272        setHasPreviewCallback(cb != null, true);
273    }
274
275    /**
276     * Adds a pre-allocated buffer to the callback buffer queue.
277     * Preview width and height can be determined from getPreviewSize, and bitsPerPixel can be
278     * found from from  {@link android.hardware.Camera.Parameters#getPreviewFormat()} and
279     * {@link android.graphics.PixelFormat#getPixelFormatInfo(int, PixelFormat)}
280     *
281     * Alternatively, a buffer from a previous callback may be passed in or used
282     * to determine the size of new preview frame buffers.
283     *
284     * @param callbackBuffer The buffer to register. Size should be width * height * bitsPerPixel / 8.
285     * @hide
286     */
287    public native final void addCallbackBuffer(byte[] callbackBuffer);
288
289    private class EventHandler extends Handler
290    {
291        private Camera mCamera;
292
293        public EventHandler(Camera c, Looper looper) {
294            super(looper);
295            mCamera = c;
296        }
297
298        @Override
299        public void handleMessage(Message msg) {
300            switch(msg.what) {
301            case CAMERA_MSG_SHUTTER:
302                if (mShutterCallback != null) {
303                    mShutterCallback.onShutter();
304                }
305                return;
306
307            case CAMERA_MSG_RAW_IMAGE:
308                if (mRawImageCallback != null) {
309                    mRawImageCallback.onPictureTaken((byte[])msg.obj, mCamera);
310                }
311                return;
312
313            case CAMERA_MSG_COMPRESSED_IMAGE:
314                if (mJpegCallback != null) {
315                    mJpegCallback.onPictureTaken((byte[])msg.obj, mCamera);
316                }
317                return;
318
319            case CAMERA_MSG_PREVIEW_FRAME:
320                if (mPreviewCallback != null) {
321                    PreviewCallback cb = mPreviewCallback;
322                    if (mOneShot) {
323                        // Clear the callback variable before the callback
324                        // in case the app calls setPreviewCallback from
325                        // the callback function
326                        mPreviewCallback = null;
327                    } else if (!mWithBuffer) {
328                        // We're faking the camera preview mode to prevent
329                        // the app from being flooded with preview frames.
330                        // Set to oneshot mode again.
331                        setHasPreviewCallback(true, false);
332                    }
333                    cb.onPreviewFrame((byte[])msg.obj, mCamera);
334                }
335                return;
336
337            case CAMERA_MSG_POSTVIEW_FRAME:
338                if (mPostviewCallback != null) {
339                    mPostviewCallback.onPictureTaken((byte[])msg.obj, mCamera);
340                }
341                return;
342
343            case CAMERA_MSG_FOCUS:
344                if (mAutoFocusCallback != null) {
345                    mAutoFocusCallback.onAutoFocus(msg.arg1 == 0 ? false : true, mCamera);
346                }
347                return;
348
349            case CAMERA_MSG_ZOOM:
350                if (mZoomCallback != null) {
351                    mZoomCallback.onZoomUpdate(msg.arg1, msg.arg2 != 0, mCamera);
352                }
353                return;
354
355            case CAMERA_MSG_ERROR :
356                Log.e(TAG, "Error " + msg.arg1);
357                if (mErrorCallback != null) {
358                    mErrorCallback.onError(msg.arg1, mCamera);
359                }
360                return;
361
362            default:
363                Log.e(TAG, "Unknown message type " + msg.what);
364                return;
365            }
366        }
367    }
368
369    private static void postEventFromNative(Object camera_ref,
370                                            int what, int arg1, int arg2, Object obj)
371    {
372        Camera c = (Camera)((WeakReference)camera_ref).get();
373        if (c == null)
374            return;
375
376        if (c.mEventHandler != null) {
377            Message m = c.mEventHandler.obtainMessage(what, arg1, arg2, obj);
378            c.mEventHandler.sendMessage(m);
379        }
380    }
381
382    /**
383     * Handles the callback for the camera auto focus.
384     * <p>Devices that do not support auto-focus will receive a "fake"
385     * callback to this interface. If your application needs auto-focus and
386     * should not be installed on devices <em>without</em> auto-focus, you must
387     * declare that your app uses the
388     * {@code android.hardware.camera.autofocus} feature, in the
389     * <a href="{@docRoot}guide/topics/manifest/uses-feature-element.html">&lt;uses-feature></a>
390     * manifest element.</p>
391     */
392    public interface AutoFocusCallback
393    {
394        /**
395         * Callback for the camera auto focus. If the camera does not support
396         * auto-focus and autoFocus is called, onAutoFocus will be called
397         * immediately with success.
398         *
399         * @param success true if focus was successful, false if otherwise
400         * @param camera  the Camera service object
401         */
402        void onAutoFocus(boolean success, Camera camera);
403    };
404
405    /**
406     * Starts auto-focus function and registers a callback function to run when
407     * camera is focused. Only valid after startPreview() has been called.
408     * Applications should call {@link
409     * android.hardware.Camera.Parameters#getFocusMode()} to determine if this
410     * method should be called. If the camera does not support auto-focus, it is
411     * a no-op and {@link AutoFocusCallback#onAutoFocus(boolean, Camera)}
412     * callback will be called immediately.
413     * <p>If your application should not be installed
414     * on devices without auto-focus, you must declare that your application
415     * uses auto-focus with the
416     * <a href="{@docRoot}guide/topics/manifest/uses-feature-element.html">&lt;uses-feature></a>
417     * manifest element.</p>
418     * <p>If the current flash mode is not
419     * {@link android.hardware.Camera.Parameters#FLASH_MODE_OFF}, flash may be
420     * fired during auto-focus depending on the driver.<p>
421     *
422     * @param cb the callback to run
423     */
424    public final void autoFocus(AutoFocusCallback cb)
425    {
426        mAutoFocusCallback = cb;
427        native_autoFocus();
428    }
429    private native final void native_autoFocus();
430
431    /**
432     * Cancels auto-focus function. If the auto-focus is still in progress,
433     * this function will cancel it. Whether the auto-focus is in progress
434     * or not, this function will return the focus position to the default.
435     * If the camera does not support auto-focus, this is a no-op.
436     */
437    public final void cancelAutoFocus()
438    {
439        mAutoFocusCallback = null;
440        native_cancelAutoFocus();
441    }
442    private native final void native_cancelAutoFocus();
443
444    /**
445     * An interface which contains a callback for the shutter closing after taking a picture.
446     */
447    public interface ShutterCallback
448    {
449        /**
450         * Can be used to play a shutter sound as soon as the image has been captured, but before
451         * the data is available.
452         */
453        void onShutter();
454    }
455
456    /**
457     * Handles the callback for when a picture is taken.
458     */
459    public interface PictureCallback {
460        /**
461         * Callback for when a picture is taken.
462         *
463         * @param data   a byte array of the picture data
464         * @param camera the Camera service object
465         */
466        void onPictureTaken(byte[] data, Camera camera);
467    };
468
469    /**
470     * Triggers an asynchronous image capture. The camera service will initiate
471     * a series of callbacks to the application as the image capture progresses.
472     * The shutter callback occurs after the image is captured. This can be used
473     * to trigger a sound to let the user know that image has been captured. The
474     * raw callback occurs when the raw image data is available (NOTE: the data
475     * may be null if the hardware does not have enough memory to make a copy).
476     * The jpeg callback occurs when the compressed image is available. If the
477     * application does not need a particular callback, a null can be passed
478     * instead of a callback method.
479     *
480     * This method will stop the preview. Applications should not call {@link
481     * #stopPreview()} before this. After jpeg callback is received,
482     * applications can call {@link #startPreview()} to restart the preview.
483     *
484     * @param shutter   callback after the image is captured, may be null
485     * @param raw       callback with raw image data, may be null
486     * @param jpeg      callback with jpeg image data, may be null
487     */
488    public final void takePicture(ShutterCallback shutter, PictureCallback raw,
489            PictureCallback jpeg) {
490        takePicture(shutter, raw, null, jpeg);
491    }
492    private native final void native_takePicture();
493
494    /**
495     * Triggers an asynchronous image capture. The camera service will initiate
496     * a series of callbacks to the application as the image capture progresses.
497     * The shutter callback occurs after the image is captured. This can be used
498     * to trigger a sound to let the user know that image has been captured. The
499     * raw callback occurs when the raw image data is available (NOTE: the data
500     * may be null if the hardware does not have enough memory to make a copy).
501     * The postview callback occurs when a scaled, fully processed postview
502     * image is available (NOTE: not all hardware supports this). The jpeg
503     * callback occurs when the compressed image is available. If the
504     * application does not need a particular callback, a null can be passed
505     * instead of a callback method.
506     *
507     * This method will stop the preview. Applications should not call {@link
508     * #stopPreview()} before this. After jpeg callback is received,
509     * applications can call {@link #startPreview()} to restart the preview.
510     *
511     * @param shutter   callback after the image is captured, may be null
512     * @param raw       callback with raw image data, may be null
513     * @param postview  callback with postview image data, may be null
514     * @param jpeg      callback with jpeg image data, may be null
515     */
516    public final void takePicture(ShutterCallback shutter, PictureCallback raw,
517            PictureCallback postview, PictureCallback jpeg) {
518        mShutterCallback = shutter;
519        mRawImageCallback = raw;
520        mPostviewCallback = postview;
521        mJpegCallback = jpeg;
522        native_takePicture();
523    }
524
525    /**
526     * Zooms to the requested value smoothly. Driver will generate {@link
527     * #ZoomCallback} for the current zoom value and whether zoom is stopped.
528     * The applications can call {@link #stopSmoothZoom} to stop the zoom
529     * earlier. The applications should not call startSmoothZoom again or {@link
530     * android.hardware.Camera.Parameters#setZoom(int)} before the zoom stops.
531     *
532     * @param value zoom value. The valid range is 0 to {@link
533     *              android.hardware.Camera.Parameters#getMaxZoom}.
534     * @hide
535     */
536    public native final void startSmoothZoom(int value);
537
538    /**
539     * Stops the smooth zoom. The applications should wait for the {@link
540     * #ZoomCallback} to know when the zoom is actually stopped.
541     * @hide
542     */
543    public native final void stopSmoothZoom();
544
545    /**
546     * Handles the zoom callback.
547     *
548     * @hide
549     */
550    public interface ZoomCallback
551    {
552        /**
553         * Callback for zoom updates
554         *
555         * @param zoomValue the current zoom value. In smooth zoom mode, camera
556         *                  generates this callback for every new zoom value.
557         * @param stopped whether smooth zoom is stopped. If the value is true,
558         *                this is the last zoom update for the application.
559         *
560         * @param camera  the Camera service object
561         * @see android.hardware.Camera.Parameters#startSmoothZoom
562         */
563        void onZoomUpdate(int zoomValue, boolean stopped, Camera camera);
564    };
565
566    /**
567     * Registers a callback to be invoked when the zoom value is updated by the
568     * camera driver during smooth zoom.
569     * @param cb the callback to run
570     * @hide
571     */
572    public final void setZoomCallback(ZoomCallback cb)
573    {
574        mZoomCallback = cb;
575    }
576
577    // These match the enum in include/ui/Camera.h
578    /** Unspecified camerar error.  @see #ErrorCallback */
579    public static final int CAMERA_ERROR_UNKNOWN = 1;
580    /** Media server died. In this case, the application must release the
581     * Camera object and instantiate a new one. @see #ErrorCallback */
582    public static final int CAMERA_ERROR_SERVER_DIED = 100;
583
584    /**
585     * Handles the camera error callback.
586     */
587    public interface ErrorCallback
588    {
589        /**
590         * Callback for camera errors.
591         * @param error   error code:
592         * <ul>
593         * <li>{@link #CAMERA_ERROR_UNKNOWN}
594         * <li>{@link #CAMERA_ERROR_SERVER_DIED}
595         * </ul>
596         * @param camera  the Camera service object
597         */
598        void onError(int error, Camera camera);
599    };
600
601    /**
602     * Registers a callback to be invoked when an error occurs.
603     * @param cb the callback to run
604     */
605    public final void setErrorCallback(ErrorCallback cb)
606    {
607        mErrorCallback = cb;
608    }
609
610    private native final void native_setParameters(String params);
611    private native final String native_getParameters();
612
613    /**
614     * Sets the Parameters for pictures from this Camera service.
615     *
616     * @param params the Parameters to use for this Camera service
617     */
618    public void setParameters(Parameters params) {
619        native_setParameters(params.flatten());
620    }
621
622    /**
623     * Returns the picture Parameters for this Camera service.
624     */
625    public Parameters getParameters() {
626        Parameters p = new Parameters();
627        String s = native_getParameters();
628        p.unflatten(s);
629        return p;
630    }
631
632    /**
633     * Handles the picture size (dimensions).
634     */
635    public class Size {
636        /**
637         * Sets the dimensions for pictures.
638         *
639         * @param w the photo width (pixels)
640         * @param h the photo height (pixels)
641         */
642        public Size(int w, int h) {
643            width = w;
644            height = h;
645        }
646        /** width of the picture */
647        public int width;
648        /** height of the picture */
649        public int height;
650    };
651
652    /**
653     * Handles the parameters for pictures created by a Camera service.
654     *
655     * <p>To make camera parameters take effect, applications have to call
656     * Camera.setParameters. For example, after setWhiteBalance is called, white
657     * balance is not changed until Camera.setParameters() is called.
658     *
659     * <p>Different devices may have different camera capabilities, such as
660     * picture size or flash modes. The application should query the camera
661     * capabilities before setting parameters. For example, the application
662     * should call getSupportedColorEffects before calling setEffect. If the
663     * camera does not support color effects, getSupportedColorEffects will
664     * return null.
665     */
666    public class Parameters {
667        // Parameter keys to communicate with the camera driver.
668        private static final String KEY_PREVIEW_SIZE = "preview-size";
669        private static final String KEY_PREVIEW_FORMAT = "preview-format";
670        private static final String KEY_PREVIEW_FRAME_RATE = "preview-frame-rate";
671        private static final String KEY_PICTURE_SIZE = "picture-size";
672        private static final String KEY_PICTURE_FORMAT = "picture-format";
673        private static final String KEY_JPEG_THUMBNAIL_WIDTH = "jpeg-thumbnail-width";
674        private static final String KEY_JPEG_THUMBNAIL_HEIGHT = "jpeg-thumbnail-height";
675        private static final String KEY_JPEG_THUMBNAIL_QUALITY = "jpeg-thumbnail-quality";
676        private static final String KEY_JPEG_QUALITY = "jpeg-quality";
677        private static final String KEY_ROTATION = "rotation";
678        private static final String KEY_GPS_LATITUDE = "gps-latitude";
679        private static final String KEY_GPS_LONGITUDE = "gps-longitude";
680        private static final String KEY_GPS_ALTITUDE = "gps-altitude";
681        private static final String KEY_GPS_TIMESTAMP = "gps-timestamp";
682        private static final String KEY_WHITE_BALANCE = "whitebalance";
683        private static final String KEY_EFFECT = "effect";
684        private static final String KEY_ANTIBANDING = "antibanding";
685        private static final String KEY_SCENE_MODE = "scene-mode";
686        private static final String KEY_FLASH_MODE = "flash-mode";
687        private static final String KEY_FOCUS_MODE = "focus-mode";
688        // Parameter key suffix for supported values.
689        private static final String SUPPORTED_VALUES_SUFFIX = "-values";
690
691        // Values for white balance settings.
692        public static final String WHITE_BALANCE_AUTO = "auto";
693        public static final String WHITE_BALANCE_INCANDESCENT = "incandescent";
694        public static final String WHITE_BALANCE_FLUORESCENT = "fluorescent";
695        public static final String WHITE_BALANCE_WARM_FLUORESCENT = "warm-fluorescent";
696        public static final String WHITE_BALANCE_DAYLIGHT = "daylight";
697        public static final String WHITE_BALANCE_CLOUDY_DAYLIGHT = "cloudy-daylight";
698        public static final String WHITE_BALANCE_TWILIGHT = "twilight";
699        public static final String WHITE_BALANCE_SHADE = "shade";
700
701        // Values for color effect settings.
702        public static final String EFFECT_NONE = "none";
703        public static final String EFFECT_MONO = "mono";
704        public static final String EFFECT_NEGATIVE = "negative";
705        public static final String EFFECT_SOLARIZE = "solarize";
706        public static final String EFFECT_SEPIA = "sepia";
707        public static final String EFFECT_POSTERIZE = "posterize";
708        public static final String EFFECT_WHITEBOARD = "whiteboard";
709        public static final String EFFECT_BLACKBOARD = "blackboard";
710        public static final String EFFECT_AQUA = "aqua";
711
712        // Values for antibanding settings.
713        public static final String ANTIBANDING_AUTO = "auto";
714        public static final String ANTIBANDING_50HZ = "50hz";
715        public static final String ANTIBANDING_60HZ = "60hz";
716        public static final String ANTIBANDING_OFF = "off";
717
718        // Values for flash mode settings.
719        /**
720         * Flash will not be fired.
721         */
722        public static final String FLASH_MODE_OFF = "off";
723
724        /**
725         * Flash will be fired automatically when required. The flash may be fired
726         * during preview, auto-focus, or snapshot depending on the driver.
727         */
728        public static final String FLASH_MODE_AUTO = "auto";
729
730        /**
731         * Flash will always be fired during snapshot. The flash may also be
732         * fired during preview or auto-focus depending on the driver.
733         */
734        public static final String FLASH_MODE_ON = "on";
735
736        /**
737         * Flash will be fired in red-eye reduction mode.
738         */
739        public static final String FLASH_MODE_RED_EYE = "red-eye";
740
741        /**
742         * Constant emission of light during preview, auto-focus and snapshot.
743         * This can also be used for video recording.
744         */
745        public static final String FLASH_MODE_TORCH = "torch";
746
747        // Values for scene mode settings.
748        public static final String SCENE_MODE_AUTO = "auto";
749        public static final String SCENE_MODE_ACTION = "action";
750        public static final String SCENE_MODE_PORTRAIT = "portrait";
751        public static final String SCENE_MODE_LANDSCAPE = "landscape";
752        public static final String SCENE_MODE_NIGHT = "night";
753        public static final String SCENE_MODE_NIGHT_PORTRAIT = "night-portrait";
754        public static final String SCENE_MODE_THEATRE = "theatre";
755        public static final String SCENE_MODE_BEACH = "beach";
756        public static final String SCENE_MODE_SNOW = "snow";
757        public static final String SCENE_MODE_SUNSET = "sunset";
758        public static final String SCENE_MODE_STEADYPHOTO = "steadyphoto";
759        public static final String SCENE_MODE_FIREWORKS = "fireworks";
760        public static final String SCENE_MODE_SPORTS = "sports";
761        public static final String SCENE_MODE_PARTY = "party";
762        public static final String SCENE_MODE_CANDLELIGHT = "candlelight";
763
764        // Values for focus mode settings.
765        /**
766         * Auto-focus mode.
767         */
768        public static final String FOCUS_MODE_AUTO = "auto";
769
770        /**
771         * Focus is set at infinity. Applications should not call
772         * {@link #autoFocus(AutoFocusCallback)} in this mode.
773         */
774        public static final String FOCUS_MODE_INFINITY = "infinity";
775        public static final String FOCUS_MODE_MACRO = "macro";
776
777        /**
778         * Focus is fixed. The camera is always in this mode if the focus is not
779         * adjustable. If the camera has auto-focus, this mode can fix the
780         * focus, which is usually at hyperfocal distance. Applications should
781         * not call {@link #autoFocus(AutoFocusCallback)} in this mode.
782         */
783        public static final String FOCUS_MODE_FIXED = "fixed";
784
785        // Formats for setPreviewFormat and setPictureFormat.
786        private static final String PIXEL_FORMAT_YUV422SP = "yuv422sp";
787        private static final String PIXEL_FORMAT_YUV420SP = "yuv420sp";
788        private static final String PIXEL_FORMAT_YUV422I = "yuv422i-yuyv";
789        private static final String PIXEL_FORMAT_RGB565 = "rgb565";
790        private static final String PIXEL_FORMAT_JPEG = "jpeg";
791
792        private HashMap<String, String> mMap;
793
794        private Parameters() {
795            mMap = new HashMap<String, String>();
796        }
797
798        /**
799         * Writes the current Parameters to the log.
800         * @hide
801         * @deprecated
802         */
803        public void dump() {
804            Log.e(TAG, "dump: size=" + mMap.size());
805            for (String k : mMap.keySet()) {
806                Log.e(TAG, "dump: " + k + "=" + mMap.get(k));
807            }
808        }
809
810        /**
811         * Creates a single string with all the parameters set in
812         * this Parameters object.
813         * <p>The {@link #unflatten(String)} method does the reverse.</p>
814         *
815         * @return a String with all values from this Parameters object, in
816         *         semi-colon delimited key-value pairs
817         */
818        public String flatten() {
819            StringBuilder flattened = new StringBuilder();
820            for (String k : mMap.keySet()) {
821                flattened.append(k);
822                flattened.append("=");
823                flattened.append(mMap.get(k));
824                flattened.append(";");
825            }
826            // chop off the extra semicolon at the end
827            flattened.deleteCharAt(flattened.length()-1);
828            return flattened.toString();
829        }
830
831        /**
832         * Takes a flattened string of parameters and adds each one to
833         * this Parameters object.
834         * <p>The {@link #flatten()} method does the reverse.</p>
835         *
836         * @param flattened a String of parameters (key-value paired) that
837         *                  are semi-colon delimited
838         */
839        public void unflatten(String flattened) {
840            mMap.clear();
841
842            StringTokenizer tokenizer = new StringTokenizer(flattened, ";");
843            while (tokenizer.hasMoreElements()) {
844                String kv = tokenizer.nextToken();
845                int pos = kv.indexOf('=');
846                if (pos == -1) {
847                    continue;
848                }
849                String k = kv.substring(0, pos);
850                String v = kv.substring(pos + 1);
851                mMap.put(k, v);
852            }
853        }
854
855        public void remove(String key) {
856            mMap.remove(key);
857        }
858
859        /**
860         * Sets a String parameter.
861         *
862         * @param key   the key name for the parameter
863         * @param value the String value of the parameter
864         */
865        public void set(String key, String value) {
866            if (key.indexOf('=') != -1 || key.indexOf(';') != -1) {
867                Log.e(TAG, "Key \"" + key + "\" contains invalid character (= or ;)");
868                return;
869            }
870            if (value.indexOf('=') != -1 || value.indexOf(';') != -1) {
871                Log.e(TAG, "Value \"" + value + "\" contains invalid character (= or ;)");
872                return;
873            }
874
875            mMap.put(key, value);
876        }
877
878        /**
879         * Sets an integer parameter.
880         *
881         * @param key   the key name for the parameter
882         * @param value the int value of the parameter
883         */
884        public void set(String key, int value) {
885            mMap.put(key, Integer.toString(value));
886        }
887
888        /**
889         * Returns the value of a String parameter.
890         *
891         * @param key the key name for the parameter
892         * @return the String value of the parameter
893         */
894        public String get(String key) {
895            return mMap.get(key);
896        }
897
898        /**
899         * Returns the value of an integer parameter.
900         *
901         * @param key the key name for the parameter
902         * @return the int value of the parameter
903         */
904        public int getInt(String key) {
905            return Integer.parseInt(mMap.get(key));
906        }
907
908        /**
909         * Sets the dimensions for preview pictures.
910         *
911         * @param width  the width of the pictures, in pixels
912         * @param height the height of the pictures, in pixels
913         */
914        public void setPreviewSize(int width, int height) {
915            String v = Integer.toString(width) + "x" + Integer.toString(height);
916            set(KEY_PREVIEW_SIZE, v);
917        }
918
919        /**
920         * Returns the dimensions setting for preview pictures.
921         *
922         * @return a Size object with the height and width setting
923         *          for the preview picture
924         */
925        public Size getPreviewSize() {
926            String pair = get(KEY_PREVIEW_SIZE);
927            return strToSize(pair);
928        }
929
930        /**
931         * Gets the supported preview sizes.
932         *
933         * @return a List of Size object. null if preview size setting is not
934         *         supported.
935         */
936        public List<Size> getSupportedPreviewSizes() {
937            String str = get(KEY_PREVIEW_SIZE + SUPPORTED_VALUES_SUFFIX);
938            return splitSize(str);
939        }
940
941        /**
942         * Sets the dimensions for EXIF thumbnail in Jpeg picture.
943         *
944         * @param width  the width of the thumbnail, in pixels
945         * @param height the height of the thumbnail, in pixels
946         */
947        public void setJpegThumbnailSize(int width, int height) {
948            set(KEY_JPEG_THUMBNAIL_WIDTH, width);
949            set(KEY_JPEG_THUMBNAIL_HEIGHT, height);
950        }
951
952        /**
953         * Returns the dimensions for EXIF thumbnail in Jpeg picture.
954         *
955         * @return a Size object with the height and width setting for the EXIF
956         *         thumbnails
957         */
958        public Size getJpegThumbnailSize() {
959            return new Size(getInt(KEY_JPEG_THUMBNAIL_WIDTH),
960                            getInt(KEY_JPEG_THUMBNAIL_HEIGHT));
961        }
962
963        /**
964         * Sets the quality of the EXIF thumbnail in Jpeg picture.
965         *
966         * @param quality the JPEG quality of the EXIF thumbnail. The range is 1
967         *                to 100, with 100 being the best.
968         */
969        public void setJpegThumbnailQuality(int quality) {
970            set(KEY_JPEG_THUMBNAIL_QUALITY, quality);
971        }
972
973        /**
974         * Returns the quality setting for the EXIF thumbnail in Jpeg picture.
975         *
976         * @return the JPEG quality setting of the EXIF thumbnail.
977         */
978        public int getJpegThumbnailQuality() {
979            return getInt(KEY_JPEG_THUMBNAIL_QUALITY);
980        }
981
982        /**
983         * Sets Jpeg quality of captured picture.
984         *
985         * @param quality the JPEG quality of captured picture. The range is 1
986         *                to 100, with 100 being the best.
987         */
988        public void setJpegQuality(int quality) {
989            set(KEY_JPEG_QUALITY, quality);
990        }
991
992        /**
993         * Returns the quality setting for the JPEG picture.
994         *
995         * @return the JPEG picture quality setting.
996         */
997        public int getJpegQuality() {
998            return getInt(KEY_JPEG_QUALITY);
999        }
1000
1001        /**
1002         * Sets the rate at which preview frames are received.
1003         *
1004         * @param fps the frame rate (frames per second)
1005         */
1006        public void setPreviewFrameRate(int fps) {
1007            set(KEY_PREVIEW_FRAME_RATE, fps);
1008        }
1009
1010        /**
1011         * Returns the setting for the rate at which preview frames
1012         * are received.
1013         *
1014         * @return the frame rate setting (frames per second)
1015         */
1016        public int getPreviewFrameRate() {
1017            return getInt(KEY_PREVIEW_FRAME_RATE);
1018        }
1019
1020        /**
1021         * Gets the supported preview frame rates.
1022         *
1023         * @return a List of Integer objects (preview frame rates). null if
1024         *         preview frame rate setting is not supported.
1025         */
1026        public List<Integer> getSupportedPreviewFrameRates() {
1027            String str = get(KEY_PREVIEW_FRAME_RATE + SUPPORTED_VALUES_SUFFIX);
1028            return splitInt(str);
1029        }
1030
1031        /**
1032         * Sets the image format for preview pictures.
1033         * <p>If this is never called, the default format will be
1034         * {@link android.graphics.PixelFormat#YCbCr_420_SP}, which
1035         * uses the NV21 encoding format.</p>
1036         *
1037         * @param pixel_format the desired preview picture format, defined
1038         *   by one of the {@link android.graphics.PixelFormat} constants.
1039         *   (E.g., <var>PixelFormat.YCbCr_420_SP</var> (default),
1040         *                      <var>PixelFormat.RGB_565</var>, or
1041         *                      <var>PixelFormat.JPEG</var>)
1042         * @see android.graphics.PixelFormat
1043         */
1044        public void setPreviewFormat(int pixel_format) {
1045            String s = cameraFormatForPixelFormat(pixel_format);
1046            if (s == null) {
1047                throw new IllegalArgumentException(
1048                        "Invalid pixel_format=" + pixel_format);
1049            }
1050
1051            set(KEY_PREVIEW_FORMAT, s);
1052        }
1053
1054        /**
1055         * Returns the image format for preview pictures got from
1056         * {@link PreviewCallback}.
1057         *
1058         * @return the {@link android.graphics.PixelFormat} int representing
1059         *         the preview picture format.
1060         */
1061        public int getPreviewFormat() {
1062            return pixelFormatForCameraFormat(get(KEY_PREVIEW_FORMAT));
1063        }
1064
1065        /**
1066         * Gets the supported preview formats.
1067         *
1068         * @return a List of Integer objects. null if preview format setting is
1069         *         not supported.
1070         */
1071        public List<Integer> getSupportedPreviewFormats() {
1072            String str = get(KEY_PREVIEW_FORMAT + SUPPORTED_VALUES_SUFFIX);
1073            ArrayList<Integer> formats = new ArrayList<Integer>();
1074            for (String s : split(str)) {
1075                int f = pixelFormatForCameraFormat(s);
1076                if (f == PixelFormat.UNKNOWN) continue;
1077                formats.add(f);
1078            }
1079            return formats;
1080        }
1081
1082        /**
1083         * Sets the dimensions for pictures.
1084         *
1085         * @param width  the width for pictures, in pixels
1086         * @param height the height for pictures, in pixels
1087         */
1088        public void setPictureSize(int width, int height) {
1089            String v = Integer.toString(width) + "x" + Integer.toString(height);
1090            set(KEY_PICTURE_SIZE, v);
1091        }
1092
1093        /**
1094         * Returns the dimension setting for pictures.
1095         *
1096         * @return a Size object with the height and width setting
1097         *          for pictures
1098         */
1099        public Size getPictureSize() {
1100            String pair = get(KEY_PICTURE_SIZE);
1101            return strToSize(pair);
1102        }
1103
1104        /**
1105         * Gets the supported picture sizes.
1106         *
1107         * @return a List of Size objects. null if picture size setting is not
1108         *         supported.
1109         */
1110        public List<Size> getSupportedPictureSizes() {
1111            String str = get(KEY_PICTURE_SIZE + SUPPORTED_VALUES_SUFFIX);
1112            return splitSize(str);
1113        }
1114
1115        /**
1116         * Sets the image format for pictures.
1117         *
1118         * @param pixel_format the desired picture format
1119         *                     (<var>PixelFormat.YCbCr_420_SP (NV21)</var>,
1120         *                      <var>PixelFormat.RGB_565</var>, or
1121         *                      <var>PixelFormat.JPEG</var>)
1122         * @see android.graphics.PixelFormat
1123         */
1124        public void setPictureFormat(int pixel_format) {
1125            String s = cameraFormatForPixelFormat(pixel_format);
1126            if (s == null) {
1127                throw new IllegalArgumentException(
1128                        "Invalid pixel_format=" + pixel_format);
1129            }
1130
1131            set(KEY_PICTURE_FORMAT, s);
1132        }
1133
1134        /**
1135         * Returns the image format for pictures.
1136         *
1137         * @return the PixelFormat int representing the picture format
1138         */
1139        public int getPictureFormat() {
1140            return pixelFormatForCameraFormat(get(KEY_PICTURE_FORMAT));
1141        }
1142
1143        /**
1144         * Gets the supported picture formats.
1145         *
1146         * @return a List of Integer objects (values are PixelFormat.XXX). null
1147         *         if picture setting is not supported.
1148         */
1149        public List<Integer> getSupportedPictureFormats() {
1150            String str = get(KEY_PICTURE_SIZE + SUPPORTED_VALUES_SUFFIX);
1151            return splitInt(str);
1152        }
1153
1154        private String cameraFormatForPixelFormat(int pixel_format) {
1155            switch(pixel_format) {
1156            case PixelFormat.YCbCr_422_SP: return PIXEL_FORMAT_YUV422SP;
1157            case PixelFormat.YCbCr_420_SP: return PIXEL_FORMAT_YUV420SP;
1158            case PixelFormat.YCbCr_422_I:  return PIXEL_FORMAT_YUV422I;
1159            case PixelFormat.RGB_565:      return PIXEL_FORMAT_RGB565;
1160            case PixelFormat.JPEG:         return PIXEL_FORMAT_JPEG;
1161            default:                       return null;
1162            }
1163        }
1164
1165        private int pixelFormatForCameraFormat(String format) {
1166            if (format == null)
1167                return PixelFormat.UNKNOWN;
1168
1169            if (format.equals(PIXEL_FORMAT_YUV422SP))
1170                return PixelFormat.YCbCr_422_SP;
1171
1172            if (format.equals(PIXEL_FORMAT_YUV420SP))
1173                return PixelFormat.YCbCr_420_SP;
1174
1175            if (format.equals(PIXEL_FORMAT_YUV422I))
1176                return PixelFormat.YCbCr_422_I;
1177
1178            if (format.equals(PIXEL_FORMAT_RGB565))
1179                return PixelFormat.RGB_565;
1180
1181            if (format.equals(PIXEL_FORMAT_JPEG))
1182                return PixelFormat.JPEG;
1183
1184            return PixelFormat.UNKNOWN;
1185        }
1186
1187        /**
1188         * Sets the orientation of the device in degrees. For example, suppose
1189         * the natural position of the device is landscape. If the user takes a
1190         * picture in landscape mode in 2048x1536 resolution, the rotation
1191         * should be set to 0. If the user rotates the phone 90 degrees
1192         * clockwise, the rotation should be set to 90. Applications can use
1193         * {@link android.view.OrientationEventListener} to set this parameter.
1194         *
1195         * The camera driver may set orientation in the EXIF header without
1196         * rotating the picture. Or the driver may rotate the picture and
1197         * the EXIF thumbnail. If the Jpeg picture is rotated, the orientation
1198         * in the EXIF header will be missing or 1 (row #0 is top and column #0
1199         * is left side).
1200         *
1201         * @param rotation The orientation of the device in degrees. Rotation
1202         *                 can only be 0, 90, 180 or 270.
1203         * @throws IllegalArgumentException if rotation value is invalid.
1204         * @see android.view.OrientationEventListener
1205         */
1206        public void setRotation(int rotation) {
1207            if (rotation == 0 || rotation == 90 || rotation == 180
1208                    || rotation == 270) {
1209                set(KEY_ROTATION, Integer.toString(rotation));
1210            } else {
1211                throw new IllegalArgumentException(
1212                        "Invalid rotation=" + rotation);
1213            }
1214        }
1215
1216        /**
1217         * Sets GPS latitude coordinate. This will be stored in JPEG EXIF
1218         * header.
1219         *
1220         * @param latitude GPS latitude coordinate.
1221         */
1222        public void setGpsLatitude(double latitude) {
1223            set(KEY_GPS_LATITUDE, Double.toString(latitude));
1224        }
1225
1226        /**
1227         * Sets GPS longitude coordinate. This will be stored in JPEG EXIF
1228         * header.
1229         *
1230         * @param longitude GPS longitude coordinate.
1231         */
1232        public void setGpsLongitude(double longitude) {
1233            set(KEY_GPS_LONGITUDE, Double.toString(longitude));
1234        }
1235
1236        /**
1237         * Sets GPS altitude. This will be stored in JPEG EXIF header.
1238         *
1239         * @param altitude GPS altitude in meters.
1240         */
1241        public void setGpsAltitude(double altitude) {
1242            set(KEY_GPS_ALTITUDE, Double.toString(altitude));
1243        }
1244
1245        /**
1246         * Sets GPS timestamp. This will be stored in JPEG EXIF header.
1247         *
1248         * @param timestamp GPS timestamp (UTC in seconds since January 1,
1249         *                  1970).
1250         */
1251        public void setGpsTimestamp(long timestamp) {
1252            set(KEY_GPS_TIMESTAMP, Long.toString(timestamp));
1253        }
1254
1255        /**
1256         * Removes GPS latitude, longitude, altitude, and timestamp from the
1257         * parameters.
1258         */
1259        public void removeGpsData() {
1260            remove(KEY_GPS_LATITUDE);
1261            remove(KEY_GPS_LONGITUDE);
1262            remove(KEY_GPS_ALTITUDE);
1263            remove(KEY_GPS_TIMESTAMP);
1264        }
1265
1266        /**
1267         * Gets the current white balance setting.
1268         *
1269         * @return one of WHITE_BALANCE_XXX string constant. null if white
1270         *         balance setting is not supported.
1271         */
1272        public String getWhiteBalance() {
1273            return get(KEY_WHITE_BALANCE);
1274        }
1275
1276        /**
1277         * Sets the white balance.
1278         *
1279         * @param value WHITE_BALANCE_XXX string constant.
1280         */
1281        public void setWhiteBalance(String value) {
1282            set(KEY_WHITE_BALANCE, value);
1283        }
1284
1285        /**
1286         * Gets the supported white balance.
1287         *
1288         * @return a List of WHITE_BALANCE_XXX string constants. null if white
1289         *         balance setting is not supported.
1290         */
1291        public List<String> getSupportedWhiteBalance() {
1292            String str = get(KEY_WHITE_BALANCE + SUPPORTED_VALUES_SUFFIX);
1293            return split(str);
1294        }
1295
1296        /**
1297         * Gets the current color effect setting.
1298         *
1299         * @return one of EFFECT_XXX string constant. null if color effect
1300         *         setting is not supported.
1301         */
1302        public String getColorEffect() {
1303            return get(KEY_EFFECT);
1304        }
1305
1306        /**
1307         * Sets the current color effect setting.
1308         *
1309         * @param value EFFECT_XXX string constants.
1310         */
1311        public void setColorEffect(String value) {
1312            set(KEY_EFFECT, value);
1313        }
1314
1315        /**
1316         * Gets the supported color effects.
1317         *
1318         * @return a List of EFFECT_XXX string constants. null if color effect
1319         *         setting is not supported.
1320         */
1321        public List<String> getSupportedColorEffects() {
1322            String str = get(KEY_EFFECT + SUPPORTED_VALUES_SUFFIX);
1323            return split(str);
1324        }
1325
1326
1327        /**
1328         * Gets the current antibanding setting.
1329         *
1330         * @return one of ANTIBANDING_XXX string constant. null if antibanding
1331         *         setting is not supported.
1332         */
1333        public String getAntibanding() {
1334            return get(KEY_ANTIBANDING);
1335        }
1336
1337        /**
1338         * Sets the antibanding.
1339         *
1340         * @param antibanding ANTIBANDING_XXX string constant.
1341         */
1342        public void setAntibanding(String antibanding) {
1343            set(KEY_ANTIBANDING, antibanding);
1344        }
1345
1346        /**
1347         * Gets the supported antibanding values.
1348         *
1349         * @return a List of ANTIBANDING_XXX string constants. null if
1350         *         antibanding setting is not supported.
1351         */
1352        public List<String> getSupportedAntibanding() {
1353            String str = get(KEY_ANTIBANDING + SUPPORTED_VALUES_SUFFIX);
1354            return split(str);
1355        }
1356
1357        /**
1358         * Gets the current scene mode setting.
1359         *
1360         * @return one of SCENE_MODE_XXX string constant. null if scene mode
1361         *         setting is not supported.
1362         */
1363        public String getSceneMode() {
1364            return get(KEY_SCENE_MODE);
1365        }
1366
1367        /**
1368         * Sets the scene mode. Other parameters may be changed after changing
1369         * scene mode. For example, flash and supported flash mode may be
1370         * changed to "off" in night scene mode. After setting scene mode,
1371         * applications should call getParameters to know if some parameters are
1372         * changed.
1373         *
1374         * @param value SCENE_MODE_XXX string constants.
1375         */
1376        public void setSceneMode(String value) {
1377            set(KEY_SCENE_MODE, value);
1378        }
1379
1380        /**
1381         * Gets the supported scene modes.
1382         *
1383         * @return a List of SCENE_MODE_XXX string constant. null if scene mode
1384         *         setting is not supported.
1385         */
1386        public List<String> getSupportedSceneModes() {
1387            String str = get(KEY_SCENE_MODE + SUPPORTED_VALUES_SUFFIX);
1388            return split(str);
1389        }
1390
1391        /**
1392         * Gets the current flash mode setting.
1393         *
1394         * @return one of FLASH_MODE_XXX string constant. null if flash mode
1395         *         setting is not supported.
1396         */
1397        public String getFlashMode() {
1398            return get(KEY_FLASH_MODE);
1399        }
1400
1401        /**
1402         * Sets the flash mode.
1403         *
1404         * @param value FLASH_MODE_XXX string constants.
1405         */
1406        public void setFlashMode(String value) {
1407            set(KEY_FLASH_MODE, value);
1408        }
1409
1410        /**
1411         * Gets the supported flash modes.
1412         *
1413         * @return a List of FLASH_MODE_XXX string constants. null if flash mode
1414         *         setting is not supported.
1415         */
1416        public List<String> getSupportedFlashModes() {
1417            String str = get(KEY_FLASH_MODE + SUPPORTED_VALUES_SUFFIX);
1418            return split(str);
1419        }
1420
1421        /**
1422         * Gets the current focus mode setting.
1423         *
1424         * @return one of FOCUS_MODE_XXX string constant. If the camera does not
1425         *         support auto-focus, this should return {@link
1426         *         #FOCUS_MODE_FIXED}. If the focus mode is not FOCUS_MODE_FIXED
1427         *         or {@link #FOCUS_MODE_INFINITY}, applications should call
1428         *         {@link #autoFocus(AutoFocusCallback)} to start the focus.
1429         */
1430        public String getFocusMode() {
1431            return get(KEY_FOCUS_MODE);
1432        }
1433
1434        /**
1435         * Sets the focus mode.
1436         *
1437         * @param value FOCUS_MODE_XXX string constants.
1438         */
1439        public void setFocusMode(String value) {
1440            set(KEY_FOCUS_MODE, value);
1441        }
1442
1443        /**
1444         * Gets the supported focus modes.
1445         *
1446         * @return a List of FOCUS_MODE_XXX string constants. null if focus mode
1447         *         setting is not supported.
1448         */
1449        public List<String> getSupportedFocusModes() {
1450            String str = get(KEY_FOCUS_MODE + SUPPORTED_VALUES_SUFFIX);
1451            return split(str);
1452        }
1453
1454        /**
1455         * Gets current zoom value. This also works when smooth zoom is in
1456         * progress.
1457         *
1458         * @return the current zoom value. The range is 0 to {@link
1459         *          #getMaxZoom}.
1460         * @hide
1461         */
1462        public int getZoom() {
1463            return getInt("zoom");
1464        }
1465
1466        /**
1467         * Sets current zoom value. If {@link #startSmoothZoom(int)} has been
1468         * called and zoom is not stopped yet, applications should not call this
1469         * method.
1470         *
1471         * @param value zoom value. The valid range is 0 to {@link #getMaxZoom}.
1472         * @hide
1473         */
1474        public void setZoom(int value) {
1475            set("zoom", value);
1476        }
1477
1478        /**
1479         * Returns true if zoom is supported. Applications should call this
1480         * before using other zoom methods.
1481         *
1482         * @return true if zoom is supported.
1483         * @hide
1484         */
1485        public boolean isZoomSupported() {
1486            String str = get("zoom-supported");
1487            return "true".equals(str);
1488        }
1489
1490        /**
1491         * Gets the maximum zoom value allowed for snapshot. This is the maximum
1492         * value that applications can set to {@link #setZoom(int)}.
1493         *
1494         * @return the maximum zoom value supported by the camera.
1495         * @hide
1496         */
1497        public int getMaxZoom() {
1498            return getInt("max-zoom");
1499        }
1500
1501        /**
1502         * Gets the zoom factors of all zoom values.
1503         *
1504         * @return the zoom factors in 1/100 increments. Ex: a zoom of 3.2x is
1505         *         returned as 320. Accuracy of the value is dependent on the
1506         *         hardware implementation. The first element of the list is the
1507         *         zoom factor of first zoom value. If the first zoom value is
1508         *         0, the zoom factor should be 100. The last element is the
1509         *         zoom factor of zoom value {@link #getMaxZoom}.
1510         * @hide
1511         */
1512        public List<Integer> getZoomFactors() {
1513            return splitInt(get("zoom-factors"));
1514        }
1515
1516        /**
1517         * Returns true if smooth zoom is supported. Applications should call
1518         * this before using other smooth zoom methods.
1519         *
1520         * @return true if smooth zoom is supported.
1521         * @hide
1522         */
1523        public boolean isSmoothZoomSupported() {
1524            String str = get("smooth-zoom-supported");
1525            return "true".equals(str);
1526        }
1527
1528        // Splits a comma delimited string to an ArrayList of String.
1529        // Return null if the passing string is null or the size is 0.
1530        private ArrayList<String> split(String str) {
1531            if (str == null) return null;
1532
1533            // Use StringTokenizer because it is faster than split.
1534            StringTokenizer tokenizer = new StringTokenizer(str, ",");
1535            ArrayList<String> substrings = new ArrayList<String>();
1536            while (tokenizer.hasMoreElements()) {
1537                substrings.add(tokenizer.nextToken());
1538            }
1539            return substrings;
1540        }
1541
1542        // Splits a comma delimited string to an ArrayList of Integer.
1543        // Return null if the passing string is null or the size is 0.
1544        private ArrayList<Integer> splitInt(String str) {
1545            if (str == null) return null;
1546
1547            StringTokenizer tokenizer = new StringTokenizer(str, ",");
1548            ArrayList<Integer> substrings = new ArrayList<Integer>();
1549            while (tokenizer.hasMoreElements()) {
1550                String token = tokenizer.nextToken();
1551                substrings.add(Integer.parseInt(token));
1552            }
1553            if (substrings.size() == 0) return null;
1554            return substrings;
1555        }
1556
1557        // Splits a comma delimited string to an ArrayList of Size.
1558        // Return null if the passing string is null or the size is 0.
1559        private ArrayList<Size> splitSize(String str) {
1560            if (str == null) return null;
1561
1562            StringTokenizer tokenizer = new StringTokenizer(str, ",");
1563            ArrayList<Size> sizeList = new ArrayList<Size>();
1564            while (tokenizer.hasMoreElements()) {
1565                Size size = strToSize(tokenizer.nextToken());
1566                if (size != null) sizeList.add(size);
1567            }
1568            if (sizeList.size() == 0) return null;
1569            return sizeList;
1570        }
1571
1572        // Parses a string (ex: "480x320") to Size object.
1573        // Return null if the passing string is null.
1574        private Size strToSize(String str) {
1575            if (str == null) return null;
1576
1577            int pos = str.indexOf('x');
1578            if (pos != -1) {
1579                String width = str.substring(0, pos);
1580                String height = str.substring(pos + 1);
1581                return new Size(Integer.parseInt(width),
1582                                Integer.parseInt(height));
1583            }
1584            Log.e(TAG, "Invalid size parameter string=" + str);
1585            return null;
1586        }
1587    };
1588}
1589