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