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 
17 package android.hardware;
18 
19 import android.app.ActivityThread;
20 import android.annotation.SdkConstant;
21 import android.annotation.SdkConstant.SdkConstantType;
22 import android.app.job.JobInfo;
23 import android.content.Context;
24 import android.graphics.ImageFormat;
25 import android.graphics.Point;
26 import android.graphics.Rect;
27 import android.graphics.SurfaceTexture;
28 import android.media.IAudioService;
29 import android.os.Handler;
30 import android.os.IBinder;
31 import android.os.Looper;
32 import android.os.Message;
33 import android.os.RemoteException;
34 import android.os.ServiceManager;
35 import android.renderscript.Allocation;
36 import android.renderscript.Element;
37 import android.renderscript.RenderScript;
38 import android.renderscript.RSIllegalArgumentException;
39 import android.renderscript.Type;
40 import android.util.Log;
41 import android.text.TextUtils;
42 import android.view.Surface;
43 import android.view.SurfaceHolder;
44 
45 import java.io.IOException;
46 import java.lang.ref.WeakReference;
47 import java.util.ArrayList;
48 import java.util.LinkedHashMap;
49 import java.util.List;
50 
51 import static android.system.OsConstants.*;
52 
53 /**
54  * The Camera class is used to set image capture settings, start/stop preview,
55  * snap pictures, and retrieve frames for encoding for video.  This class is a
56  * client for the Camera service, which manages the actual camera hardware.
57  *
58  * <p>To access the device camera, you must declare the
59  * {@link android.Manifest.permission#CAMERA} permission in your Android
60  * Manifest. Also be sure to include the
61  * <a href="{@docRoot}guide/topics/manifest/uses-feature-element.html">&lt;uses-feature></a>
62  * manifest element to declare camera features used by your application.
63  * For example, if you use the camera and auto-focus feature, your Manifest
64  * should include the following:</p>
65  * <pre> &lt;uses-permission android:name="android.permission.CAMERA" />
66  * &lt;uses-feature android:name="android.hardware.camera" />
67  * &lt;uses-feature android:name="android.hardware.camera.autofocus" /></pre>
68  *
69  * <p>To take pictures with this class, use the following steps:</p>
70  *
71  * <ol>
72  * <li>Obtain an instance of Camera from {@link #open(int)}.
73  *
74  * <li>Get existing (default) settings with {@link #getParameters()}.
75  *
76  * <li>If necessary, modify the returned {@link Camera.Parameters} object and call
77  * {@link #setParameters(Camera.Parameters)}.
78  *
79  * <li>Call {@link #setDisplayOrientation(int)} to ensure correct orientation of preview.
80  *
81  * <li><b>Important</b>: Pass a fully initialized {@link SurfaceHolder} to
82  * {@link #setPreviewDisplay(SurfaceHolder)}.  Without a surface, the camera
83  * will be unable to start the preview.
84  *
85  * <li><b>Important</b>: Call {@link #startPreview()} to start updating the
86  * preview surface.  Preview must be started before you can take a picture.
87  *
88  * <li>When you want, call {@link #takePicture(Camera.ShutterCallback,
89  * Camera.PictureCallback, Camera.PictureCallback, Camera.PictureCallback)} to
90  * capture a photo.  Wait for the callbacks to provide the actual image data.
91  *
92  * <li>After taking a picture, preview display will have stopped.  To take more
93  * photos, call {@link #startPreview()} again first.
94  *
95  * <li>Call {@link #stopPreview()} to stop updating the preview surface.
96  *
97  * <li><b>Important:</b> Call {@link #release()} to release the camera for
98  * use by other applications.  Applications should release the camera
99  * immediately in {@link android.app.Activity#onPause()} (and re-{@link #open()}
100  * it in {@link android.app.Activity#onResume()}).
101  * </ol>
102  *
103  * <p>To quickly switch to video recording mode, use these steps:</p>
104  *
105  * <ol>
106  * <li>Obtain and initialize a Camera and start preview as described above.
107  *
108  * <li>Call {@link #unlock()} to allow the media process to access the camera.
109  *
110  * <li>Pass the camera to {@link android.media.MediaRecorder#setCamera(Camera)}.
111  * See {@link android.media.MediaRecorder} information about video recording.
112  *
113  * <li>When finished recording, call {@link #reconnect()} to re-acquire
114  * and re-lock the camera.
115  *
116  * <li>If desired, restart preview and take more photos or videos.
117  *
118  * <li>Call {@link #stopPreview()} and {@link #release()} as described above.
119  * </ol>
120  *
121  * <p>This class is not thread-safe, and is meant for use from one event thread.
122  * Most long-running operations (preview, focus, photo capture, etc) happen
123  * asynchronously and invoke callbacks as necessary.  Callbacks will be invoked
124  * on the event thread {@link #open(int)} was called from.  This class's methods
125  * must never be called from multiple threads at once.</p>
126  *
127  * <p class="caution"><strong>Caution:</strong> Different Android-powered devices
128  * may have different hardware specifications, such as megapixel ratings and
129  * auto-focus capabilities. In order for your application to be compatible with
130  * more devices, you should not make assumptions about the device camera
131  * specifications.</p>
132  *
133  * <div class="special reference">
134  * <h3>Developer Guides</h3>
135  * <p>For more information about using cameras, read the
136  * <a href="{@docRoot}guide/topics/media/camera.html">Camera</a> developer guide.</p>
137  * </div>
138  *
139  * @deprecated We recommend using the new {@link android.hardware.camera2} API for new
140  *             applications.
141  */
142 @Deprecated
143 public class Camera {
144     private static final String TAG = "Camera";
145 
146     // These match the enums in frameworks/base/include/camera/Camera.h
147     private static final int CAMERA_MSG_ERROR            = 0x001;
148     private static final int CAMERA_MSG_SHUTTER          = 0x002;
149     private static final int CAMERA_MSG_FOCUS            = 0x004;
150     private static final int CAMERA_MSG_ZOOM             = 0x008;
151     private static final int CAMERA_MSG_PREVIEW_FRAME    = 0x010;
152     private static final int CAMERA_MSG_VIDEO_FRAME      = 0x020;
153     private static final int CAMERA_MSG_POSTVIEW_FRAME   = 0x040;
154     private static final int CAMERA_MSG_RAW_IMAGE        = 0x080;
155     private static final int CAMERA_MSG_COMPRESSED_IMAGE = 0x100;
156     private static final int CAMERA_MSG_RAW_IMAGE_NOTIFY = 0x200;
157     private static final int CAMERA_MSG_PREVIEW_METADATA = 0x400;
158     private static final int CAMERA_MSG_FOCUS_MOVE       = 0x800;
159 
160     private long mNativeContext; // accessed by native methods
161     private EventHandler mEventHandler;
162     private ShutterCallback mShutterCallback;
163     private PictureCallback mRawImageCallback;
164     private PictureCallback mJpegCallback;
165     private PreviewCallback mPreviewCallback;
166     private boolean mUsingPreviewAllocation;
167     private PictureCallback mPostviewCallback;
168     private AutoFocusCallback mAutoFocusCallback;
169     private AutoFocusMoveCallback mAutoFocusMoveCallback;
170     private OnZoomChangeListener mZoomListener;
171     private FaceDetectionListener mFaceListener;
172     private ErrorCallback mErrorCallback;
173     private boolean mOneShot;
174     private boolean mWithBuffer;
175     private boolean mFaceDetectionRunning = false;
176     private final Object mAutoFocusCallbackLock = new Object();
177 
178     private static final int NO_ERROR = 0;
179 
180     /**
181      * @deprecated This broadcast is no longer delivered by the system; use
182      * {@link android.app.job.JobInfo.Builder JobInfo.Builder}.{@link android.app.job.JobInfo.Builder#addTriggerContentUri}
183      * instead.
184      * Broadcast Action:  A new picture is taken by the camera, and the entry of
185      * the picture has been added to the media store.
186      * {@link android.content.Intent#getData} is URI of the picture.
187      */
188     @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
189     @Deprecated
190     public static final String ACTION_NEW_PICTURE = "android.hardware.action.NEW_PICTURE";
191 
192     /**
193      * @deprecated This broadcast is no longer delivered by the system; use
194      * {@link android.app.job.JobInfo.Builder JobInfo.Builder}.{@link android.app.job.JobInfo.Builder#addTriggerContentUri}
195      * instead.
196      * Broadcast Action:  A new video is recorded by the camera, and the entry
197      * of the video has been added to the media store.
198      * {@link android.content.Intent#getData} is URI of the video.
199      */
200     @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
201     @Deprecated
202     public static final String ACTION_NEW_VIDEO = "android.hardware.action.NEW_VIDEO";
203 
204     /**
205      * Camera HAL device API version 1.0
206      * @hide
207      */
208     public static final int CAMERA_HAL_API_VERSION_1_0 = 0x100;
209 
210     /**
211      * A constant meaning the normal camera connect/open will be used.
212      */
213     private static final int CAMERA_HAL_API_VERSION_NORMAL_CONNECT = -2;
214 
215     /**
216      * Used to indicate HAL version un-specified.
217      */
218     private static final int CAMERA_HAL_API_VERSION_UNSPECIFIED = -1;
219 
220     /**
221      * Hardware face detection. It does not use much CPU.
222      */
223     private static final int CAMERA_FACE_DETECTION_HW = 0;
224 
225     /**
226      * Software face detection. It uses some CPU.
227      */
228     private static final int CAMERA_FACE_DETECTION_SW = 1;
229 
230     /**
231      * Returns the number of physical cameras available on this device.
232      */
getNumberOfCameras()233     public native static int getNumberOfCameras();
234 
235     /**
236      * Returns the information about a particular camera.
237      * If {@link #getNumberOfCameras()} returns N, the valid id is 0 to N-1.
238      */
getCameraInfo(int cameraId, CameraInfo cameraInfo)239     public static void getCameraInfo(int cameraId, CameraInfo cameraInfo) {
240         _getCameraInfo(cameraId, cameraInfo);
241         IBinder b = ServiceManager.getService(Context.AUDIO_SERVICE);
242         IAudioService audioService = IAudioService.Stub.asInterface(b);
243         try {
244             if (audioService.isCameraSoundForced()) {
245                 // Only set this when sound is forced; otherwise let native code
246                 // decide.
247                 cameraInfo.canDisableShutterSound = false;
248             }
249         } catch (RemoteException e) {
250             Log.e(TAG, "Audio service is unavailable for queries");
251         }
252     }
_getCameraInfo(int cameraId, CameraInfo cameraInfo)253     private native static void _getCameraInfo(int cameraId, CameraInfo cameraInfo);
254 
255     /**
256      * Information about a camera
257      *
258      * @deprecated We recommend using the new {@link android.hardware.camera2} API for new
259      *             applications.
260      */
261     @Deprecated
262     public static class CameraInfo {
263         /**
264          * The facing of the camera is opposite to that of the screen.
265          */
266         public static final int CAMERA_FACING_BACK = 0;
267 
268         /**
269          * The facing of the camera is the same as that of the screen.
270          */
271         public static final int CAMERA_FACING_FRONT = 1;
272 
273         /**
274          * The direction that the camera faces. It should be
275          * CAMERA_FACING_BACK or CAMERA_FACING_FRONT.
276          */
277         public int facing;
278 
279         /**
280          * <p>The orientation of the camera image. The value is the angle that the
281          * camera image needs to be rotated clockwise so it shows correctly on
282          * the display in its natural orientation. It should be 0, 90, 180, or 270.</p>
283          *
284          * <p>For example, suppose a device has a naturally tall screen. The
285          * back-facing camera sensor is mounted in landscape. You are looking at
286          * the screen. If the top side of the camera sensor is aligned with the
287          * right edge of the screen in natural orientation, the value should be
288          * 90. If the top side of a front-facing camera sensor is aligned with
289          * the right of the screen, the value should be 270.</p>
290          *
291          * @see #setDisplayOrientation(int)
292          * @see Parameters#setRotation(int)
293          * @see Parameters#setPreviewSize(int, int)
294          * @see Parameters#setPictureSize(int, int)
295          * @see Parameters#setJpegThumbnailSize(int, int)
296          */
297         public int orientation;
298 
299         /**
300          * <p>Whether the shutter sound can be disabled.</p>
301          *
302          * <p>On some devices, the camera shutter sound cannot be turned off
303          * through {@link #enableShutterSound enableShutterSound}. This field
304          * can be used to determine whether a call to disable the shutter sound
305          * will succeed.</p>
306          *
307          * <p>If this field is set to true, then a call of
308          * {@code enableShutterSound(false)} will be successful. If set to
309          * false, then that call will fail, and the shutter sound will be played
310          * when {@link Camera#takePicture takePicture} is called.</p>
311          */
312         public boolean canDisableShutterSound;
313     };
314 
315     /**
316      * Creates a new Camera object to access a particular hardware camera. If
317      * the same camera is opened by other applications, this will throw a
318      * RuntimeException.
319      *
320      * <p>You must call {@link #release()} when you are done using the camera,
321      * otherwise it will remain locked and be unavailable to other applications.
322      *
323      * <p>Your application should only have one Camera object active at a time
324      * for a particular hardware camera.
325      *
326      * <p>Callbacks from other methods are delivered to the event loop of the
327      * thread which called open().  If this thread has no event loop, then
328      * callbacks are delivered to the main application event loop.  If there
329      * is no main application event loop, callbacks are not delivered.
330      *
331      * <p class="caution"><b>Caution:</b> On some devices, this method may
332      * take a long time to complete.  It is best to call this method from a
333      * worker thread (possibly using {@link android.os.AsyncTask}) to avoid
334      * blocking the main application UI thread.
335      *
336      * @param cameraId the hardware camera to access, between 0 and
337      *     {@link #getNumberOfCameras()}-1.
338      * @return a new Camera object, connected, locked and ready for use.
339      * @throws RuntimeException if opening the camera fails (for example, if the
340      *     camera is in use by another process or device policy manager has
341      *     disabled the camera).
342      * @see android.app.admin.DevicePolicyManager#getCameraDisabled(android.content.ComponentName)
343      */
open(int cameraId)344     public static Camera open(int cameraId) {
345         return new Camera(cameraId);
346     }
347 
348     /**
349      * Creates a new Camera object to access the first back-facing camera on the
350      * device. If the device does not have a back-facing camera, this returns
351      * null.
352      * @see #open(int)
353      */
open()354     public static Camera open() {
355         int numberOfCameras = getNumberOfCameras();
356         CameraInfo cameraInfo = new CameraInfo();
357         for (int i = 0; i < numberOfCameras; i++) {
358             getCameraInfo(i, cameraInfo);
359             if (cameraInfo.facing == CameraInfo.CAMERA_FACING_BACK) {
360                 return new Camera(i);
361             }
362         }
363         return null;
364     }
365 
366     /**
367      * Creates a new Camera object to access a particular hardware camera with
368      * given hal API version. If the same camera is opened by other applications
369      * or the hal API version is not supported by this device, this will throw a
370      * RuntimeException.
371      * <p>
372      * You must call {@link #release()} when you are done using the camera,
373      * otherwise it will remain locked and be unavailable to other applications.
374      * <p>
375      * Your application should only have one Camera object active at a time for
376      * a particular hardware camera.
377      * <p>
378      * Callbacks from other methods are delivered to the event loop of the
379      * thread which called open(). If this thread has no event loop, then
380      * callbacks are delivered to the main application event loop. If there is
381      * no main application event loop, callbacks are not delivered.
382      * <p class="caution">
383      * <b>Caution:</b> On some devices, this method may take a long time to
384      * complete. It is best to call this method from a worker thread (possibly
385      * using {@link android.os.AsyncTask}) to avoid blocking the main
386      * application UI thread.
387      *
388      * @param cameraId The hardware camera to access, between 0 and
389      * {@link #getNumberOfCameras()}-1.
390      * @param halVersion The HAL API version this camera device to be opened as.
391      * @return a new Camera object, connected, locked and ready for use.
392      *
393      * @throws IllegalArgumentException if the {@code halVersion} is invalid
394      *
395      * @throws RuntimeException if opening the camera fails (for example, if the
396      * camera is in use by another process or device policy manager has disabled
397      * the camera).
398      *
399      * @see android.app.admin.DevicePolicyManager#getCameraDisabled(android.content.ComponentName)
400      * @see #CAMERA_HAL_API_VERSION_1_0
401      *
402      * @hide
403      */
openLegacy(int cameraId, int halVersion)404     public static Camera openLegacy(int cameraId, int halVersion) {
405         if (halVersion < CAMERA_HAL_API_VERSION_1_0) {
406             throw new IllegalArgumentException("Invalid HAL version " + halVersion);
407         }
408 
409         return new Camera(cameraId, halVersion);
410     }
411 
412     /**
413      * Create a legacy camera object.
414      *
415      * @param cameraId The hardware camera to access, between 0 and
416      * {@link #getNumberOfCameras()}-1.
417      * @param halVersion The HAL API version this camera device to be opened as.
418      */
Camera(int cameraId, int halVersion)419     private Camera(int cameraId, int halVersion) {
420         int err = cameraInitVersion(cameraId, halVersion);
421         if (checkInitErrors(err)) {
422             if (err == -EACCES) {
423                 throw new RuntimeException("Fail to connect to camera service");
424             } else if (err == -ENODEV) {
425                 throw new RuntimeException("Camera initialization failed");
426             } else if (err == -ENOSYS) {
427                 throw new RuntimeException("Camera initialization failed because some methods"
428                         + " are not implemented");
429             } else if (err == -EOPNOTSUPP) {
430                 throw new RuntimeException("Camera initialization failed because the hal"
431                         + " version is not supported by this device");
432             } else if (err == -EINVAL) {
433                 throw new RuntimeException("Camera initialization failed because the input"
434                         + " arugments are invalid");
435             } else if (err == -EBUSY) {
436                 throw new RuntimeException("Camera initialization failed because the camera"
437                         + " device was already opened");
438             } else if (err == -EUSERS) {
439                 throw new RuntimeException("Camera initialization failed because the max"
440                         + " number of camera devices were already opened");
441             }
442             // Should never hit this.
443             throw new RuntimeException("Unknown camera error");
444         }
445     }
446 
cameraInitVersion(int cameraId, int halVersion)447     private int cameraInitVersion(int cameraId, int halVersion) {
448         mShutterCallback = null;
449         mRawImageCallback = null;
450         mJpegCallback = null;
451         mPreviewCallback = null;
452         mPostviewCallback = null;
453         mUsingPreviewAllocation = false;
454         mZoomListener = null;
455 
456         Looper looper;
457         if ((looper = Looper.myLooper()) != null) {
458             mEventHandler = new EventHandler(this, looper);
459         } else if ((looper = Looper.getMainLooper()) != null) {
460             mEventHandler = new EventHandler(this, looper);
461         } else {
462             mEventHandler = null;
463         }
464 
465         return native_setup(new WeakReference<Camera>(this), cameraId, halVersion,
466                 ActivityThread.currentOpPackageName());
467     }
468 
cameraInitNormal(int cameraId)469     private int cameraInitNormal(int cameraId) {
470         return cameraInitVersion(cameraId, CAMERA_HAL_API_VERSION_NORMAL_CONNECT);
471     }
472 
473     /**
474      * Connect to the camera service using #connectLegacy
475      *
476      * <p>
477      * This acts the same as normal except that it will return
478      * the detailed error code if open fails instead of
479      * converting everything into {@code NO_INIT}.</p>
480      *
481      * <p>Intended to use by the camera2 shim only, do <i>not</i> use this for other code.</p>
482      *
483      * @return a detailed errno error code, or {@code NO_ERROR} on success
484      *
485      * @hide
486      */
cameraInitUnspecified(int cameraId)487     public int cameraInitUnspecified(int cameraId) {
488         return cameraInitVersion(cameraId, CAMERA_HAL_API_VERSION_UNSPECIFIED);
489     }
490 
491     /** used by Camera#open, Camera#open(int) */
Camera(int cameraId)492     Camera(int cameraId) {
493         int err = cameraInitNormal(cameraId);
494         if (checkInitErrors(err)) {
495             if (err == -EACCES) {
496                 throw new RuntimeException("Fail to connect to camera service");
497             } else if (err == -ENODEV) {
498                 throw new RuntimeException("Camera initialization failed");
499             }
500             // Should never hit this.
501             throw new RuntimeException("Unknown camera error");
502         }
503     }
504 
505 
506     /**
507      * @hide
508      */
checkInitErrors(int err)509     public static boolean checkInitErrors(int err) {
510         return err != NO_ERROR;
511     }
512 
513     /**
514      * @hide
515      */
openUninitialized()516     public static Camera openUninitialized() {
517         return new Camera();
518     }
519 
520     /**
521      * An empty Camera for testing purpose.
522      */
Camera()523     Camera() {
524     }
525 
526     @Override
finalize()527     protected void finalize() {
528         release();
529     }
530 
native_setup(Object camera_this, int cameraId, int halVersion, String packageName)531     private native final int native_setup(Object camera_this, int cameraId, int halVersion,
532                                            String packageName);
533 
native_release()534     private native final void native_release();
535 
536 
537     /**
538      * Disconnects and releases the Camera object resources.
539      *
540      * <p>You must call this as soon as you're done with the Camera object.</p>
541      */
release()542     public final void release() {
543         native_release();
544         mFaceDetectionRunning = false;
545     }
546 
547     /**
548      * Unlocks the camera to allow another process to access it.
549      * Normally, the camera is locked to the process with an active Camera
550      * object until {@link #release()} is called.  To allow rapid handoff
551      * between processes, you can call this method to release the camera
552      * temporarily for another process to use; once the other process is done
553      * you can call {@link #reconnect()} to reclaim the camera.
554      *
555      * <p>This must be done before calling
556      * {@link android.media.MediaRecorder#setCamera(Camera)}. This cannot be
557      * called after recording starts.
558      *
559      * <p>If you are not recording video, you probably do not need this method.
560      *
561      * @throws RuntimeException if the camera cannot be unlocked.
562      */
unlock()563     public native final void unlock();
564 
565     /**
566      * Re-locks the camera to prevent other processes from accessing it.
567      * Camera objects are locked by default unless {@link #unlock()} is
568      * called.  Normally {@link #reconnect()} is used instead.
569      *
570      * <p>Since API level 14, camera is automatically locked for applications in
571      * {@link android.media.MediaRecorder#start()}. Applications can use the
572      * camera (ex: zoom) after recording starts. There is no need to call this
573      * after recording starts or stops.
574      *
575      * <p>If you are not recording video, you probably do not need this method.
576      *
577      * @throws RuntimeException if the camera cannot be re-locked (for
578      *     example, if the camera is still in use by another process).
579      */
lock()580     public native final void lock();
581 
582     /**
583      * Reconnects to the camera service after another process used it.
584      * After {@link #unlock()} is called, another process may use the
585      * camera; when the process is done, you must reconnect to the camera,
586      * which will re-acquire the lock and allow you to continue using the
587      * camera.
588      *
589      * <p>Since API level 14, camera is automatically locked for applications in
590      * {@link android.media.MediaRecorder#start()}. Applications can use the
591      * camera (ex: zoom) after recording starts. There is no need to call this
592      * after recording starts or stops.
593      *
594      * <p>If you are not recording video, you probably do not need this method.
595      *
596      * @throws IOException if a connection cannot be re-established (for
597      *     example, if the camera is still in use by another process).
598      */
reconnect()599     public native final void reconnect() throws IOException;
600 
601     /**
602      * Sets the {@link Surface} to be used for live preview.
603      * Either a surface or surface texture is necessary for preview, and
604      * preview is necessary to take pictures.  The same surface can be re-set
605      * without harm.  Setting a preview surface will un-set any preview surface
606      * texture that was set via {@link #setPreviewTexture}.
607      *
608      * <p>The {@link SurfaceHolder} must already contain a surface when this
609      * method is called.  If you are using {@link android.view.SurfaceView},
610      * you will need to register a {@link SurfaceHolder.Callback} with
611      * {@link SurfaceHolder#addCallback(SurfaceHolder.Callback)} and wait for
612      * {@link SurfaceHolder.Callback#surfaceCreated(SurfaceHolder)} before
613      * calling setPreviewDisplay() or starting preview.
614      *
615      * <p>This method must be called before {@link #startPreview()}.  The
616      * one exception is that if the preview surface is not set (or set to null)
617      * before startPreview() is called, then this method may be called once
618      * with a non-null parameter to set the preview surface.  (This allows
619      * camera setup and surface creation to happen in parallel, saving time.)
620      * The preview surface may not otherwise change while preview is running.
621      *
622      * @param holder containing the Surface on which to place the preview,
623      *     or null to remove the preview surface
624      * @throws IOException if the method fails (for example, if the surface
625      *     is unavailable or unsuitable).
626      */
setPreviewDisplay(SurfaceHolder holder)627     public final void setPreviewDisplay(SurfaceHolder holder) throws IOException {
628         if (holder != null) {
629             setPreviewSurface(holder.getSurface());
630         } else {
631             setPreviewSurface((Surface)null);
632         }
633     }
634 
635     /**
636      * @hide
637      */
setPreviewSurface(Surface surface)638     public native final void setPreviewSurface(Surface surface) throws IOException;
639 
640     /**
641      * Sets the {@link SurfaceTexture} to be used for live preview.
642      * Either a surface or surface texture is necessary for preview, and
643      * preview is necessary to take pictures.  The same surface texture can be
644      * re-set without harm.  Setting a preview surface texture will un-set any
645      * preview surface that was set via {@link #setPreviewDisplay}.
646      *
647      * <p>This method must be called before {@link #startPreview()}.  The
648      * one exception is that if the preview surface texture is not set (or set
649      * to null) before startPreview() is called, then this method may be called
650      * once with a non-null parameter to set the preview surface.  (This allows
651      * camera setup and surface creation to happen in parallel, saving time.)
652      * The preview surface texture may not otherwise change while preview is
653      * running.
654      *
655      * <p>The timestamps provided by {@link SurfaceTexture#getTimestamp()} for a
656      * SurfaceTexture set as the preview texture have an unspecified zero point,
657      * and cannot be directly compared between different cameras or different
658      * instances of the same camera, or across multiple runs of the same
659      * program.
660      *
661      * <p>If you are using the preview data to create video or still images,
662      * strongly consider using {@link android.media.MediaActionSound} to
663      * properly indicate image capture or recording start/stop to the user.</p>
664      *
665      * @see android.media.MediaActionSound
666      * @see android.graphics.SurfaceTexture
667      * @see android.view.TextureView
668      * @param surfaceTexture the {@link SurfaceTexture} to which the preview
669      *     images are to be sent or null to remove the current preview surface
670      *     texture
671      * @throws IOException if the method fails (for example, if the surface
672      *     texture is unavailable or unsuitable).
673      */
setPreviewTexture(SurfaceTexture surfaceTexture)674     public native final void setPreviewTexture(SurfaceTexture surfaceTexture) throws IOException;
675 
676     /**
677      * Callback interface used to deliver copies of preview frames as
678      * they are displayed.
679      *
680      * @see #setPreviewCallback(Camera.PreviewCallback)
681      * @see #setOneShotPreviewCallback(Camera.PreviewCallback)
682      * @see #setPreviewCallbackWithBuffer(Camera.PreviewCallback)
683      * @see #startPreview()
684      *
685      * @deprecated We recommend using the new {@link android.hardware.camera2} API for new
686      *             applications.
687      */
688     @Deprecated
689     public interface PreviewCallback
690     {
691         /**
692          * Called as preview frames are displayed.  This callback is invoked
693          * on the event thread {@link #open(int)} was called from.
694          *
695          * <p>If using the {@link android.graphics.ImageFormat#YV12} format,
696          * refer to the equations in {@link Camera.Parameters#setPreviewFormat}
697          * for the arrangement of the pixel data in the preview callback
698          * buffers.
699          *
700          * @param data the contents of the preview frame in the format defined
701          *  by {@link android.graphics.ImageFormat}, which can be queried
702          *  with {@link android.hardware.Camera.Parameters#getPreviewFormat()}.
703          *  If {@link android.hardware.Camera.Parameters#setPreviewFormat(int)}
704          *             is never called, the default will be the YCbCr_420_SP
705          *             (NV21) format.
706          * @param camera the Camera service object.
707          */
onPreviewFrame(byte[] data, Camera camera)708         void onPreviewFrame(byte[] data, Camera camera);
709     };
710 
711     /**
712      * Starts capturing and drawing preview frames to the screen.
713      * Preview will not actually start until a surface is supplied
714      * with {@link #setPreviewDisplay(SurfaceHolder)} or
715      * {@link #setPreviewTexture(SurfaceTexture)}.
716      *
717      * <p>If {@link #setPreviewCallback(Camera.PreviewCallback)},
718      * {@link #setOneShotPreviewCallback(Camera.PreviewCallback)}, or
719      * {@link #setPreviewCallbackWithBuffer(Camera.PreviewCallback)} were
720      * called, {@link Camera.PreviewCallback#onPreviewFrame(byte[], Camera)}
721      * will be called when preview data becomes available.
722      */
startPreview()723     public native final void startPreview();
724 
725     /**
726      * Stops capturing and drawing preview frames to the surface, and
727      * resets the camera for a future call to {@link #startPreview()}.
728      */
stopPreview()729     public final void stopPreview() {
730         _stopPreview();
731         mFaceDetectionRunning = false;
732 
733         mShutterCallback = null;
734         mRawImageCallback = null;
735         mPostviewCallback = null;
736         mJpegCallback = null;
737         synchronized (mAutoFocusCallbackLock) {
738             mAutoFocusCallback = null;
739         }
740         mAutoFocusMoveCallback = null;
741     }
742 
_stopPreview()743     private native final void _stopPreview();
744 
745     /**
746      * Return current preview state.
747      *
748      * FIXME: Unhide before release
749      * @hide
750      */
previewEnabled()751     public native final boolean previewEnabled();
752 
753     /**
754      * <p>Installs a callback to be invoked for every preview frame in addition
755      * to displaying them on the screen.  The callback will be repeatedly called
756      * for as long as preview is active.  This method can be called at any time,
757      * even while preview is live.  Any other preview callbacks are
758      * overridden.</p>
759      *
760      * <p>If you are using the preview data to create video or still images,
761      * strongly consider using {@link android.media.MediaActionSound} to
762      * properly indicate image capture or recording start/stop to the user.</p>
763      *
764      * @param cb a callback object that receives a copy of each preview frame,
765      *     or null to stop receiving callbacks.
766      * @see android.media.MediaActionSound
767      */
setPreviewCallback(PreviewCallback cb)768     public final void setPreviewCallback(PreviewCallback cb) {
769         mPreviewCallback = cb;
770         mOneShot = false;
771         mWithBuffer = false;
772         if (cb != null) {
773             mUsingPreviewAllocation = false;
774         }
775         // Always use one-shot mode. We fake camera preview mode by
776         // doing one-shot preview continuously.
777         setHasPreviewCallback(cb != null, false);
778     }
779 
780     /**
781      * <p>Installs a callback to be invoked for the next preview frame in
782      * addition to displaying it on the screen.  After one invocation, the
783      * callback is cleared. This method can be called any time, even when
784      * preview is live.  Any other preview callbacks are overridden.</p>
785      *
786      * <p>If you are using the preview data to create video or still images,
787      * strongly consider using {@link android.media.MediaActionSound} to
788      * properly indicate image capture or recording start/stop to the user.</p>
789      *
790      * @param cb a callback object that receives a copy of the next preview frame,
791      *     or null to stop receiving callbacks.
792      * @see android.media.MediaActionSound
793      */
setOneShotPreviewCallback(PreviewCallback cb)794     public final void setOneShotPreviewCallback(PreviewCallback cb) {
795         mPreviewCallback = cb;
796         mOneShot = true;
797         mWithBuffer = false;
798         if (cb != null) {
799             mUsingPreviewAllocation = false;
800         }
801         setHasPreviewCallback(cb != null, false);
802     }
803 
setHasPreviewCallback(boolean installed, boolean manualBuffer)804     private native final void setHasPreviewCallback(boolean installed, boolean manualBuffer);
805 
806     /**
807      * <p>Installs a callback to be invoked for every preview frame, using
808      * buffers supplied with {@link #addCallbackBuffer(byte[])}, in addition to
809      * displaying them on the screen.  The callback will be repeatedly called
810      * for as long as preview is active and buffers are available.  Any other
811      * preview callbacks are overridden.</p>
812      *
813      * <p>The purpose of this method is to improve preview efficiency and frame
814      * rate by allowing preview frame memory reuse.  You must call
815      * {@link #addCallbackBuffer(byte[])} at some point -- before or after
816      * calling this method -- or no callbacks will received.</p>
817      *
818      * <p>The buffer queue will be cleared if this method is called with a null
819      * callback, {@link #setPreviewCallback(Camera.PreviewCallback)} is called,
820      * or {@link #setOneShotPreviewCallback(Camera.PreviewCallback)} is
821      * called.</p>
822      *
823      * <p>If you are using the preview data to create video or still images,
824      * strongly consider using {@link android.media.MediaActionSound} to
825      * properly indicate image capture or recording start/stop to the user.</p>
826      *
827      * @param cb a callback object that receives a copy of the preview frame,
828      *     or null to stop receiving callbacks and clear the buffer queue.
829      * @see #addCallbackBuffer(byte[])
830      * @see android.media.MediaActionSound
831      */
setPreviewCallbackWithBuffer(PreviewCallback cb)832     public final void setPreviewCallbackWithBuffer(PreviewCallback cb) {
833         mPreviewCallback = cb;
834         mOneShot = false;
835         mWithBuffer = true;
836         if (cb != null) {
837             mUsingPreviewAllocation = false;
838         }
839         setHasPreviewCallback(cb != null, true);
840     }
841 
842     /**
843      * Adds a pre-allocated buffer to the preview callback buffer queue.
844      * Applications can add one or more buffers to the queue. When a preview
845      * frame arrives and there is still at least one available buffer, the
846      * buffer will be used and removed from the queue. Then preview callback is
847      * invoked with the buffer. If a frame arrives and there is no buffer left,
848      * the frame is discarded. Applications should add buffers back when they
849      * finish processing the data in them.
850      *
851      * <p>For formats besides YV12, the size of the buffer is determined by
852      * multiplying the preview image width, height, and bytes per pixel. The
853      * width and height can be read from
854      * {@link Camera.Parameters#getPreviewSize()}. Bytes per pixel can be
855      * computed from {@link android.graphics.ImageFormat#getBitsPerPixel(int)} /
856      * 8, using the image format from
857      * {@link Camera.Parameters#getPreviewFormat()}.
858      *
859      * <p>If using the {@link android.graphics.ImageFormat#YV12} format, the
860      * size can be calculated using the equations listed in
861      * {@link Camera.Parameters#setPreviewFormat}.
862      *
863      * <p>This method is only necessary when
864      * {@link #setPreviewCallbackWithBuffer(PreviewCallback)} is used. When
865      * {@link #setPreviewCallback(PreviewCallback)} or
866      * {@link #setOneShotPreviewCallback(PreviewCallback)} are used, buffers
867      * are automatically allocated. When a supplied buffer is too small to
868      * hold the preview frame data, preview callback will return null and
869      * the buffer will be removed from the buffer queue.
870      *
871      * @param callbackBuffer the buffer to add to the queue. The size of the
872      *   buffer must match the values described above.
873      * @see #setPreviewCallbackWithBuffer(PreviewCallback)
874      */
addCallbackBuffer(byte[] callbackBuffer)875     public final void addCallbackBuffer(byte[] callbackBuffer)
876     {
877         _addCallbackBuffer(callbackBuffer, CAMERA_MSG_PREVIEW_FRAME);
878     }
879 
880     /**
881      * Adds a pre-allocated buffer to the raw image callback buffer queue.
882      * Applications can add one or more buffers to the queue. When a raw image
883      * frame arrives and there is still at least one available buffer, the
884      * buffer will be used to hold the raw image data and removed from the
885      * queue. Then raw image callback is invoked with the buffer. If a raw
886      * image frame arrives but there is no buffer left, the frame is
887      * discarded. Applications should add buffers back when they finish
888      * processing the data in them by calling this method again in order
889      * to avoid running out of raw image callback buffers.
890      *
891      * <p>The size of the buffer is determined by multiplying the raw image
892      * width, height, and bytes per pixel. The width and height can be
893      * read from {@link Camera.Parameters#getPictureSize()}. Bytes per pixel
894      * can be computed from
895      * {@link android.graphics.ImageFormat#getBitsPerPixel(int)} / 8,
896      * using the image format from {@link Camera.Parameters#getPreviewFormat()}.
897      *
898      * <p>This method is only necessary when the PictureCallbck for raw image
899      * is used while calling {@link #takePicture(Camera.ShutterCallback,
900      * Camera.PictureCallback, Camera.PictureCallback, Camera.PictureCallback)}.
901      *
902      * <p>Please note that by calling this method, the mode for
903      * application-managed callback buffers is triggered. If this method has
904      * never been called, null will be returned by the raw image callback since
905      * there is no image callback buffer available. Furthermore, When a supplied
906      * buffer is too small to hold the raw image data, raw image callback will
907      * return null and the buffer will be removed from the buffer queue.
908      *
909      * @param callbackBuffer the buffer to add to the raw image callback buffer
910      *     queue. The size should be width * height * (bits per pixel) / 8. An
911      *     null callbackBuffer will be ignored and won't be added to the queue.
912      *
913      * @see #takePicture(Camera.ShutterCallback,
914      * Camera.PictureCallback, Camera.PictureCallback, Camera.PictureCallback)}.
915      *
916      * {@hide}
917      */
addRawImageCallbackBuffer(byte[] callbackBuffer)918     public final void addRawImageCallbackBuffer(byte[] callbackBuffer)
919     {
920         addCallbackBuffer(callbackBuffer, CAMERA_MSG_RAW_IMAGE);
921     }
922 
addCallbackBuffer(byte[] callbackBuffer, int msgType)923     private final void addCallbackBuffer(byte[] callbackBuffer, int msgType)
924     {
925         // CAMERA_MSG_VIDEO_FRAME may be allowed in the future.
926         if (msgType != CAMERA_MSG_PREVIEW_FRAME &&
927             msgType != CAMERA_MSG_RAW_IMAGE) {
928             throw new IllegalArgumentException(
929                             "Unsupported message type: " + msgType);
930         }
931 
932         _addCallbackBuffer(callbackBuffer, msgType);
933     }
934 
_addCallbackBuffer( byte[] callbackBuffer, int msgType)935     private native final void _addCallbackBuffer(
936                                 byte[] callbackBuffer, int msgType);
937 
938     /**
939      * <p>Create a {@link android.renderscript RenderScript}
940      * {@link android.renderscript.Allocation Allocation} to use as a
941      * destination of preview callback frames. Use
942      * {@link #setPreviewCallbackAllocation setPreviewCallbackAllocation} to use
943      * the created Allocation as a destination for camera preview frames.</p>
944      *
945      * <p>The Allocation will be created with a YUV type, and its contents must
946      * be accessed within Renderscript with the {@code rsGetElementAtYuv_*}
947      * accessor methods. Its size will be based on the current
948      * {@link Parameters#getPreviewSize preview size} configured for this
949      * camera.</p>
950      *
951      * @param rs the RenderScript context for this Allocation.
952      * @param usage additional usage flags to set for the Allocation. The usage
953      *   flag {@link android.renderscript.Allocation#USAGE_IO_INPUT} will always
954      *   be set on the created Allocation, but additional flags may be provided
955      *   here.
956      * @return a new YUV-type Allocation with dimensions equal to the current
957      *   preview size.
958      * @throws RSIllegalArgumentException if the usage flags are not compatible
959      *   with an YUV Allocation.
960      * @see #setPreviewCallbackAllocation
961      * @hide
962      */
createPreviewAllocation(RenderScript rs, int usage)963     public final Allocation createPreviewAllocation(RenderScript rs, int usage)
964             throws RSIllegalArgumentException {
965         Parameters p = getParameters();
966         Size previewSize = p.getPreviewSize();
967         Type.Builder yuvBuilder = new Type.Builder(rs,
968                 Element.createPixel(rs,
969                         Element.DataType.UNSIGNED_8,
970                         Element.DataKind.PIXEL_YUV));
971         // Use YV12 for wide compatibility. Changing this requires also
972         // adjusting camera service's format selection.
973         yuvBuilder.setYuvFormat(ImageFormat.YV12);
974         yuvBuilder.setX(previewSize.width);
975         yuvBuilder.setY(previewSize.height);
976 
977         Allocation a = Allocation.createTyped(rs, yuvBuilder.create(),
978                 usage | Allocation.USAGE_IO_INPUT);
979 
980         return a;
981     }
982 
983     /**
984      * <p>Set an {@link android.renderscript.Allocation Allocation} as the
985      * target of preview callback data. Use this method for efficient processing
986      * of camera preview data with RenderScript. The Allocation must be created
987      * with the {@link #createPreviewAllocation createPreviewAllocation }
988      * method.</p>
989      *
990      * <p>Setting a preview allocation will disable any active preview callbacks
991      * set by {@link #setPreviewCallback setPreviewCallback} or
992      * {@link #setPreviewCallbackWithBuffer setPreviewCallbackWithBuffer}, and
993      * vice versa. Using a preview allocation still requires an active standard
994      * preview target to be set, either with
995      * {@link #setPreviewTexture setPreviewTexture} or
996      * {@link #setPreviewDisplay setPreviewDisplay}.</p>
997      *
998      * <p>To be notified when new frames are available to the Allocation, use
999      * {@link android.renderscript.Allocation#setIoInputNotificationHandler Allocation.setIoInputNotificationHandler}. To
1000      * update the frame currently accessible from the Allocation to the latest
1001      * preview frame, call
1002      * {@link android.renderscript.Allocation#ioReceive Allocation.ioReceive}.</p>
1003      *
1004      * <p>To disable preview into the Allocation, call this method with a
1005      * {@code null} parameter.</p>
1006      *
1007      * <p>Once a preview allocation is set, the preview size set by
1008      * {@link Parameters#setPreviewSize setPreviewSize} cannot be changed. If
1009      * you wish to change the preview size, first remove the preview allocation
1010      * by calling {@code setPreviewCallbackAllocation(null)}, then change the
1011      * preview size, create a new preview Allocation with
1012      * {@link #createPreviewAllocation createPreviewAllocation}, and set it as
1013      * the new preview callback allocation target.</p>
1014      *
1015      * <p>If you are using the preview data to create video or still images,
1016      * strongly consider using {@link android.media.MediaActionSound} to
1017      * properly indicate image capture or recording start/stop to the user.</p>
1018      *
1019      * @param previewAllocation the allocation to use as destination for preview
1020      * @throws IOException if configuring the camera to use the Allocation for
1021      *   preview fails.
1022      * @throws IllegalArgumentException if the Allocation's dimensions or other
1023      *   parameters don't meet the requirements.
1024      * @see #createPreviewAllocation
1025      * @see #setPreviewCallback
1026      * @see #setPreviewCallbackWithBuffer
1027      * @hide
1028      */
setPreviewCallbackAllocation(Allocation previewAllocation)1029     public final void setPreviewCallbackAllocation(Allocation previewAllocation)
1030             throws IOException {
1031         Surface previewSurface = null;
1032         if (previewAllocation != null) {
1033              Parameters p = getParameters();
1034              Size previewSize = p.getPreviewSize();
1035              if (previewSize.width != previewAllocation.getType().getX() ||
1036                      previewSize.height != previewAllocation.getType().getY()) {
1037                  throw new IllegalArgumentException(
1038                      "Allocation dimensions don't match preview dimensions: " +
1039                      "Allocation is " +
1040                      previewAllocation.getType().getX() +
1041                      ", " +
1042                      previewAllocation.getType().getY() +
1043                      ". Preview is " + previewSize.width + ", " +
1044                      previewSize.height);
1045              }
1046              if ((previewAllocation.getUsage() &
1047                              Allocation.USAGE_IO_INPUT) == 0) {
1048                  throw new IllegalArgumentException(
1049                      "Allocation usage does not include USAGE_IO_INPUT");
1050              }
1051              if (previewAllocation.getType().getElement().getDataKind() !=
1052                      Element.DataKind.PIXEL_YUV) {
1053                  throw new IllegalArgumentException(
1054                      "Allocation is not of a YUV type");
1055              }
1056              previewSurface = previewAllocation.getSurface();
1057              mUsingPreviewAllocation = true;
1058          } else {
1059              mUsingPreviewAllocation = false;
1060          }
1061          setPreviewCallbackSurface(previewSurface);
1062     }
1063 
setPreviewCallbackSurface(Surface s)1064     private native final void setPreviewCallbackSurface(Surface s);
1065 
1066     private class EventHandler extends Handler
1067     {
1068         private final Camera mCamera;
1069 
EventHandler(Camera c, Looper looper)1070         public EventHandler(Camera c, Looper looper) {
1071             super(looper);
1072             mCamera = c;
1073         }
1074 
1075         @Override
handleMessage(Message msg)1076         public void handleMessage(Message msg) {
1077             switch(msg.what) {
1078             case CAMERA_MSG_SHUTTER:
1079                 if (mShutterCallback != null) {
1080                     mShutterCallback.onShutter();
1081                 }
1082                 return;
1083 
1084             case CAMERA_MSG_RAW_IMAGE:
1085                 if (mRawImageCallback != null) {
1086                     mRawImageCallback.onPictureTaken((byte[])msg.obj, mCamera);
1087                 }
1088                 return;
1089 
1090             case CAMERA_MSG_COMPRESSED_IMAGE:
1091                 if (mJpegCallback != null) {
1092                     mJpegCallback.onPictureTaken((byte[])msg.obj, mCamera);
1093                 }
1094                 return;
1095 
1096             case CAMERA_MSG_PREVIEW_FRAME:
1097                 PreviewCallback pCb = mPreviewCallback;
1098                 if (pCb != null) {
1099                     if (mOneShot) {
1100                         // Clear the callback variable before the callback
1101                         // in case the app calls setPreviewCallback from
1102                         // the callback function
1103                         mPreviewCallback = null;
1104                     } else if (!mWithBuffer) {
1105                         // We're faking the camera preview mode to prevent
1106                         // the app from being flooded with preview frames.
1107                         // Set to oneshot mode again.
1108                         setHasPreviewCallback(true, false);
1109                     }
1110                     pCb.onPreviewFrame((byte[])msg.obj, mCamera);
1111                 }
1112                 return;
1113 
1114             case CAMERA_MSG_POSTVIEW_FRAME:
1115                 if (mPostviewCallback != null) {
1116                     mPostviewCallback.onPictureTaken((byte[])msg.obj, mCamera);
1117                 }
1118                 return;
1119 
1120             case CAMERA_MSG_FOCUS:
1121                 AutoFocusCallback cb = null;
1122                 synchronized (mAutoFocusCallbackLock) {
1123                     cb = mAutoFocusCallback;
1124                 }
1125                 if (cb != null) {
1126                     boolean success = msg.arg1 == 0 ? false : true;
1127                     cb.onAutoFocus(success, mCamera);
1128                 }
1129                 return;
1130 
1131             case CAMERA_MSG_ZOOM:
1132                 if (mZoomListener != null) {
1133                     mZoomListener.onZoomChange(msg.arg1, msg.arg2 != 0, mCamera);
1134                 }
1135                 return;
1136 
1137             case CAMERA_MSG_PREVIEW_METADATA:
1138                 if (mFaceListener != null) {
1139                     mFaceListener.onFaceDetection((Face[])msg.obj, mCamera);
1140                 }
1141                 return;
1142 
1143             case CAMERA_MSG_ERROR :
1144                 Log.e(TAG, "Error " + msg.arg1);
1145                 if (mErrorCallback != null) {
1146                     mErrorCallback.onError(msg.arg1, mCamera);
1147                 }
1148                 return;
1149 
1150             case CAMERA_MSG_FOCUS_MOVE:
1151                 if (mAutoFocusMoveCallback != null) {
1152                     mAutoFocusMoveCallback.onAutoFocusMoving(msg.arg1 == 0 ? false : true, mCamera);
1153                 }
1154                 return;
1155 
1156             default:
1157                 Log.e(TAG, "Unknown message type " + msg.what);
1158                 return;
1159             }
1160         }
1161     }
1162 
postEventFromNative(Object camera_ref, int what, int arg1, int arg2, Object obj)1163     private static void postEventFromNative(Object camera_ref,
1164                                             int what, int arg1, int arg2, Object obj)
1165     {
1166         Camera c = (Camera)((WeakReference)camera_ref).get();
1167         if (c == null)
1168             return;
1169 
1170         if (c.mEventHandler != null) {
1171             Message m = c.mEventHandler.obtainMessage(what, arg1, arg2, obj);
1172             c.mEventHandler.sendMessage(m);
1173         }
1174     }
1175 
1176     /**
1177      * Callback interface used to notify on completion of camera auto focus.
1178      *
1179      * <p>Devices that do not support auto-focus will receive a "fake"
1180      * callback to this interface. If your application needs auto-focus and
1181      * should not be installed on devices <em>without</em> auto-focus, you must
1182      * declare that your app uses the
1183      * {@code android.hardware.camera.autofocus} feature, in the
1184      * <a href="{@docRoot}guide/topics/manifest/uses-feature-element.html">&lt;uses-feature></a>
1185      * manifest element.</p>
1186      *
1187      * @see #autoFocus(AutoFocusCallback)
1188      * @deprecated We recommend using the new {@link android.hardware.camera2} API for new
1189      *             applications.
1190      */
1191     @Deprecated
1192     public interface AutoFocusCallback
1193     {
1194         /**
1195          * Called when the camera auto focus completes.  If the camera
1196          * does not support auto-focus and autoFocus is called,
1197          * onAutoFocus will be called immediately with a fake value of
1198          * <code>success</code> set to <code>true</code>.
1199          *
1200          * The auto-focus routine does not lock auto-exposure and auto-white
1201          * balance after it completes.
1202          *
1203          * @param success true if focus was successful, false if otherwise
1204          * @param camera  the Camera service object
1205          * @see android.hardware.Camera.Parameters#setAutoExposureLock(boolean)
1206          * @see android.hardware.Camera.Parameters#setAutoWhiteBalanceLock(boolean)
1207          */
onAutoFocus(boolean success, Camera camera)1208         void onAutoFocus(boolean success, Camera camera);
1209     }
1210 
1211     /**
1212      * Starts camera auto-focus and registers a callback function to run when
1213      * the camera is focused.  This method is only valid when preview is active
1214      * (between {@link #startPreview()} and before {@link #stopPreview()}).
1215      *
1216      * <p>Callers should check
1217      * {@link android.hardware.Camera.Parameters#getFocusMode()} to determine if
1218      * this method should be called. If the camera does not support auto-focus,
1219      * it is a no-op and {@link AutoFocusCallback#onAutoFocus(boolean, Camera)}
1220      * callback will be called immediately.
1221      *
1222      * <p>If your application should not be installed
1223      * on devices without auto-focus, you must declare that your application
1224      * uses auto-focus with the
1225      * <a href="{@docRoot}guide/topics/manifest/uses-feature-element.html">&lt;uses-feature></a>
1226      * manifest element.</p>
1227      *
1228      * <p>If the current flash mode is not
1229      * {@link android.hardware.Camera.Parameters#FLASH_MODE_OFF}, flash may be
1230      * fired during auto-focus, depending on the driver and camera hardware.<p>
1231      *
1232      * <p>Auto-exposure lock {@link android.hardware.Camera.Parameters#getAutoExposureLock()}
1233      * and auto-white balance locks {@link android.hardware.Camera.Parameters#getAutoWhiteBalanceLock()}
1234      * do not change during and after autofocus. But auto-focus routine may stop
1235      * auto-exposure and auto-white balance transiently during focusing.
1236      *
1237      * <p>Stopping preview with {@link #stopPreview()}, or triggering still
1238      * image capture with {@link #takePicture(Camera.ShutterCallback,
1239      * Camera.PictureCallback, Camera.PictureCallback)}, will not change the
1240      * the focus position. Applications must call cancelAutoFocus to reset the
1241      * focus.</p>
1242      *
1243      * <p>If autofocus is successful, consider using
1244      * {@link android.media.MediaActionSound} to properly play back an autofocus
1245      * success sound to the user.</p>
1246      *
1247      * @param cb the callback to run
1248      * @see #cancelAutoFocus()
1249      * @see android.hardware.Camera.Parameters#setAutoExposureLock(boolean)
1250      * @see android.hardware.Camera.Parameters#setAutoWhiteBalanceLock(boolean)
1251      * @see android.media.MediaActionSound
1252      */
autoFocus(AutoFocusCallback cb)1253     public final void autoFocus(AutoFocusCallback cb)
1254     {
1255         synchronized (mAutoFocusCallbackLock) {
1256             mAutoFocusCallback = cb;
1257         }
1258         native_autoFocus();
1259     }
native_autoFocus()1260     private native final void native_autoFocus();
1261 
1262     /**
1263      * Cancels any auto-focus function in progress.
1264      * Whether or not auto-focus is currently in progress,
1265      * this function will return the focus position to the default.
1266      * If the camera does not support auto-focus, this is a no-op.
1267      *
1268      * @see #autoFocus(Camera.AutoFocusCallback)
1269      */
cancelAutoFocus()1270     public final void cancelAutoFocus()
1271     {
1272         synchronized (mAutoFocusCallbackLock) {
1273             mAutoFocusCallback = null;
1274         }
1275         native_cancelAutoFocus();
1276         // CAMERA_MSG_FOCUS should be removed here because the following
1277         // scenario can happen:
1278         // - An application uses the same thread for autoFocus, cancelAutoFocus
1279         //   and looper thread.
1280         // - The application calls autoFocus.
1281         // - HAL sends CAMERA_MSG_FOCUS, which enters the looper message queue.
1282         //   Before event handler's handleMessage() is invoked, the application
1283         //   calls cancelAutoFocus and autoFocus.
1284         // - The application gets the old CAMERA_MSG_FOCUS and thinks autofocus
1285         //   has been completed. But in fact it is not.
1286         //
1287         // As documented in the beginning of the file, apps should not use
1288         // multiple threads to call autoFocus and cancelAutoFocus at the same
1289         // time. It is HAL's responsibility not to send a CAMERA_MSG_FOCUS
1290         // message after native_cancelAutoFocus is called.
1291         mEventHandler.removeMessages(CAMERA_MSG_FOCUS);
1292     }
native_cancelAutoFocus()1293     private native final void native_cancelAutoFocus();
1294 
1295     /**
1296      * Callback interface used to notify on auto focus start and stop.
1297      *
1298      * <p>This is only supported in continuous autofocus modes -- {@link
1299      * Parameters#FOCUS_MODE_CONTINUOUS_VIDEO} and {@link
1300      * Parameters#FOCUS_MODE_CONTINUOUS_PICTURE}. Applications can show
1301      * autofocus animation based on this.</p>
1302      *
1303      * @deprecated We recommend using the new {@link android.hardware.camera2} API for new
1304      *             applications.
1305      */
1306     @Deprecated
1307     public interface AutoFocusMoveCallback
1308     {
1309         /**
1310          * Called when the camera auto focus starts or stops.
1311          *
1312          * @param start true if focus starts to move, false if focus stops to move
1313          * @param camera the Camera service object
1314          */
onAutoFocusMoving(boolean start, Camera camera)1315         void onAutoFocusMoving(boolean start, Camera camera);
1316     }
1317 
1318     /**
1319      * Sets camera auto-focus move callback.
1320      *
1321      * @param cb the callback to run
1322      */
setAutoFocusMoveCallback(AutoFocusMoveCallback cb)1323     public void setAutoFocusMoveCallback(AutoFocusMoveCallback cb) {
1324         mAutoFocusMoveCallback = cb;
1325         enableFocusMoveCallback((mAutoFocusMoveCallback != null) ? 1 : 0);
1326     }
1327 
enableFocusMoveCallback(int enable)1328     private native void enableFocusMoveCallback(int enable);
1329 
1330     /**
1331      * Callback interface used to signal the moment of actual image capture.
1332      *
1333      * @see #takePicture(ShutterCallback, PictureCallback, PictureCallback, PictureCallback)
1334      *
1335      * @deprecated We recommend using the new {@link android.hardware.camera2} API for new
1336      *             applications.
1337      */
1338     @Deprecated
1339     public interface ShutterCallback
1340     {
1341         /**
1342          * Called as near as possible to the moment when a photo is captured
1343          * from the sensor.  This is a good opportunity to play a shutter sound
1344          * or give other feedback of camera operation.  This may be some time
1345          * after the photo was triggered, but some time before the actual data
1346          * is available.
1347          */
onShutter()1348         void onShutter();
1349     }
1350 
1351     /**
1352      * Callback interface used to supply image data from a photo capture.
1353      *
1354      * @see #takePicture(ShutterCallback, PictureCallback, PictureCallback, PictureCallback)
1355      *
1356      * @deprecated We recommend using the new {@link android.hardware.camera2} API for new
1357      *             applications.
1358      */
1359     @Deprecated
1360     public interface PictureCallback {
1361         /**
1362          * Called when image data is available after a picture is taken.
1363          * The format of the data depends on the context of the callback
1364          * and {@link Camera.Parameters} settings.
1365          *
1366          * @param data   a byte array of the picture data
1367          * @param camera the Camera service object
1368          */
onPictureTaken(byte[] data, Camera camera)1369         void onPictureTaken(byte[] data, Camera camera);
1370     };
1371 
1372     /**
1373      * Equivalent to takePicture(shutter, raw, null, jpeg).
1374      *
1375      * @see #takePicture(ShutterCallback, PictureCallback, PictureCallback, PictureCallback)
1376      */
takePicture(ShutterCallback shutter, PictureCallback raw, PictureCallback jpeg)1377     public final void takePicture(ShutterCallback shutter, PictureCallback raw,
1378             PictureCallback jpeg) {
1379         takePicture(shutter, raw, null, jpeg);
1380     }
native_takePicture(int msgType)1381     private native final void native_takePicture(int msgType);
1382 
1383     /**
1384      * Triggers an asynchronous image capture. The camera service will initiate
1385      * a series of callbacks to the application as the image capture progresses.
1386      * The shutter callback occurs after the image is captured. This can be used
1387      * to trigger a sound to let the user know that image has been captured. The
1388      * raw callback occurs when the raw image data is available (NOTE: the data
1389      * will be null if there is no raw image callback buffer available or the
1390      * raw image callback buffer is not large enough to hold the raw image).
1391      * The postview callback occurs when a scaled, fully processed postview
1392      * image is available (NOTE: not all hardware supports this). The jpeg
1393      * callback occurs when the compressed image is available. If the
1394      * application does not need a particular callback, a null can be passed
1395      * instead of a callback method.
1396      *
1397      * <p>This method is only valid when preview is active (after
1398      * {@link #startPreview()}).  Preview will be stopped after the image is
1399      * taken; callers must call {@link #startPreview()} again if they want to
1400      * re-start preview or take more pictures. This should not be called between
1401      * {@link android.media.MediaRecorder#start()} and
1402      * {@link android.media.MediaRecorder#stop()}.
1403      *
1404      * <p>After calling this method, you must not call {@link #startPreview()}
1405      * or take another picture until the JPEG callback has returned.
1406      *
1407      * @param shutter   the callback for image capture moment, or null
1408      * @param raw       the callback for raw (uncompressed) image data, or null
1409      * @param postview  callback with postview image data, may be null
1410      * @param jpeg      the callback for JPEG image data, or null
1411      */
takePicture(ShutterCallback shutter, PictureCallback raw, PictureCallback postview, PictureCallback jpeg)1412     public final void takePicture(ShutterCallback shutter, PictureCallback raw,
1413             PictureCallback postview, PictureCallback jpeg) {
1414         mShutterCallback = shutter;
1415         mRawImageCallback = raw;
1416         mPostviewCallback = postview;
1417         mJpegCallback = jpeg;
1418 
1419         // If callback is not set, do not send me callbacks.
1420         int msgType = 0;
1421         if (mShutterCallback != null) {
1422             msgType |= CAMERA_MSG_SHUTTER;
1423         }
1424         if (mRawImageCallback != null) {
1425             msgType |= CAMERA_MSG_RAW_IMAGE;
1426         }
1427         if (mPostviewCallback != null) {
1428             msgType |= CAMERA_MSG_POSTVIEW_FRAME;
1429         }
1430         if (mJpegCallback != null) {
1431             msgType |= CAMERA_MSG_COMPRESSED_IMAGE;
1432         }
1433 
1434         native_takePicture(msgType);
1435         mFaceDetectionRunning = false;
1436     }
1437 
1438     /**
1439      * Zooms to the requested value smoothly. The driver will notify {@link
1440      * OnZoomChangeListener} of the zoom value and whether zoom is stopped at
1441      * the time. For example, suppose the current zoom is 0 and startSmoothZoom
1442      * is called with value 3. The
1443      * {@link Camera.OnZoomChangeListener#onZoomChange(int, boolean, Camera)}
1444      * method will be called three times with zoom values 1, 2, and 3.
1445      * Applications can call {@link #stopSmoothZoom} to stop the zoom earlier.
1446      * Applications should not call startSmoothZoom again or change the zoom
1447      * value before zoom stops. If the supplied zoom value equals to the current
1448      * zoom value, no zoom callback will be generated. This method is supported
1449      * if {@link android.hardware.Camera.Parameters#isSmoothZoomSupported}
1450      * returns true.
1451      *
1452      * @param value zoom value. The valid range is 0 to {@link
1453      *              android.hardware.Camera.Parameters#getMaxZoom}.
1454      * @throws IllegalArgumentException if the zoom value is invalid.
1455      * @throws RuntimeException if the method fails.
1456      * @see #setZoomChangeListener(OnZoomChangeListener)
1457      */
startSmoothZoom(int value)1458     public native final void startSmoothZoom(int value);
1459 
1460     /**
1461      * Stops the smooth zoom. Applications should wait for the {@link
1462      * OnZoomChangeListener} to know when the zoom is actually stopped. This
1463      * method is supported if {@link
1464      * android.hardware.Camera.Parameters#isSmoothZoomSupported} is true.
1465      *
1466      * @throws RuntimeException if the method fails.
1467      */
stopSmoothZoom()1468     public native final void stopSmoothZoom();
1469 
1470     /**
1471      * Set the clockwise rotation of preview display in degrees. This affects
1472      * the preview frames and the picture displayed after snapshot. This method
1473      * is useful for portrait mode applications. Note that preview display of
1474      * front-facing cameras is flipped horizontally before the rotation, that
1475      * is, the image is reflected along the central vertical axis of the camera
1476      * sensor. So the users can see themselves as looking into a mirror.
1477      *
1478      * <p>This does not affect the order of byte array passed in {@link
1479      * PreviewCallback#onPreviewFrame}, JPEG pictures, or recorded videos. This
1480      * method is not allowed to be called during preview.
1481      *
1482      * <p>If you want to make the camera image show in the same orientation as
1483      * the display, you can use the following code.
1484      * <pre>
1485      * public static void setCameraDisplayOrientation(Activity activity,
1486      *         int cameraId, android.hardware.Camera camera) {
1487      *     android.hardware.Camera.CameraInfo info =
1488      *             new android.hardware.Camera.CameraInfo();
1489      *     android.hardware.Camera.getCameraInfo(cameraId, info);
1490      *     int rotation = activity.getWindowManager().getDefaultDisplay()
1491      *             .getRotation();
1492      *     int degrees = 0;
1493      *     switch (rotation) {
1494      *         case Surface.ROTATION_0: degrees = 0; break;
1495      *         case Surface.ROTATION_90: degrees = 90; break;
1496      *         case Surface.ROTATION_180: degrees = 180; break;
1497      *         case Surface.ROTATION_270: degrees = 270; break;
1498      *     }
1499      *
1500      *     int result;
1501      *     if (info.facing == Camera.CameraInfo.CAMERA_FACING_FRONT) {
1502      *         result = (info.orientation + degrees) % 360;
1503      *         result = (360 - result) % 360;  // compensate the mirror
1504      *     } else {  // back-facing
1505      *         result = (info.orientation - degrees + 360) % 360;
1506      *     }
1507      *     camera.setDisplayOrientation(result);
1508      * }
1509      * </pre>
1510      *
1511      * <p>Starting from API level 14, this method can be called when preview is
1512      * active.
1513      *
1514      * <p><b>Note: </b>Before API level 24, the default value for orientation is 0. Starting in
1515      * API level 24, the default orientation will be such that applications in forced-landscape mode
1516      * will have correct preview orientation, which may be either a default of 0 or
1517      * 180. Applications that operate in portrait mode or allow for changing orientation must still
1518      * call this method after each orientation change to ensure correct preview display in all
1519      * cases.</p>
1520      *
1521      * @param degrees the angle that the picture will be rotated clockwise.
1522      *                Valid values are 0, 90, 180, and 270.
1523      * @see #setPreviewDisplay(SurfaceHolder)
1524      */
setDisplayOrientation(int degrees)1525     public native final void setDisplayOrientation(int degrees);
1526 
1527     /**
1528      * <p>Enable or disable the default shutter sound when taking a picture.</p>
1529      *
1530      * <p>By default, the camera plays the system-defined camera shutter sound
1531      * when {@link #takePicture} is called. Using this method, the shutter sound
1532      * can be disabled. It is strongly recommended that an alternative shutter
1533      * sound is played in the {@link ShutterCallback} when the system shutter
1534      * sound is disabled.</p>
1535      *
1536      * <p>Note that devices may not always allow disabling the camera shutter
1537      * sound. If the shutter sound state cannot be set to the desired value,
1538      * this method will return false. {@link CameraInfo#canDisableShutterSound}
1539      * can be used to determine whether the device will allow the shutter sound
1540      * to be disabled.</p>
1541      *
1542      * @param enabled whether the camera should play the system shutter sound
1543      *                when {@link #takePicture takePicture} is called.
1544      * @return {@code true} if the shutter sound state was successfully
1545      *         changed. {@code false} if the shutter sound state could not be
1546      *         changed. {@code true} is also returned if shutter sound playback
1547      *         is already set to the requested state.
1548      * @see #takePicture
1549      * @see CameraInfo#canDisableShutterSound
1550      * @see ShutterCallback
1551      */
enableShutterSound(boolean enabled)1552     public final boolean enableShutterSound(boolean enabled) {
1553         if (!enabled) {
1554             IBinder b = ServiceManager.getService(Context.AUDIO_SERVICE);
1555             IAudioService audioService = IAudioService.Stub.asInterface(b);
1556             try {
1557                 if (audioService.isCameraSoundForced()) return false;
1558             } catch (RemoteException e) {
1559                 Log.e(TAG, "Audio service is unavailable for queries");
1560             }
1561         }
1562         return _enableShutterSound(enabled);
1563     }
1564 
1565     /**
1566      * Disable the shutter sound unconditionally.
1567      *
1568      * <p>
1569      * This is only guaranteed to work for legacy cameras
1570      * (i.e. initialized with {@link #cameraInitUnspecified}). Trying to call this on
1571      * a regular camera will force a conditional check in the camera service.
1572      * </p>
1573      *
1574      * @return {@code true} if the shutter sound state was successfully
1575      *         changed. {@code false} if the shutter sound state could not be
1576      *         changed. {@code true} is also returned if shutter sound playback
1577      *         is already set to the requested state.
1578      *
1579      * @hide
1580      */
disableShutterSound()1581     public final boolean disableShutterSound() {
1582         return _enableShutterSound(/*enabled*/false);
1583     }
1584 
_enableShutterSound(boolean enabled)1585     private native final boolean _enableShutterSound(boolean enabled);
1586 
1587     /**
1588      * Callback interface for zoom changes during a smooth zoom operation.
1589      *
1590      * @see #setZoomChangeListener(OnZoomChangeListener)
1591      * @see #startSmoothZoom(int)
1592      *
1593      * @deprecated We recommend using the new {@link android.hardware.camera2} API for new
1594      *             applications.
1595      */
1596     @Deprecated
1597     public interface OnZoomChangeListener
1598     {
1599         /**
1600          * Called when the zoom value has changed during a smooth zoom.
1601          *
1602          * @param zoomValue the current zoom value. In smooth zoom mode, camera
1603          *                  calls this for every new zoom value.
1604          * @param stopped whether smooth zoom is stopped. If the value is true,
1605          *                this is the last zoom update for the application.
1606          * @param camera  the Camera service object
1607          */
onZoomChange(int zoomValue, boolean stopped, Camera camera)1608         void onZoomChange(int zoomValue, boolean stopped, Camera camera);
1609     };
1610 
1611     /**
1612      * Registers a listener to be notified when the zoom value is updated by the
1613      * camera driver during smooth zoom.
1614      *
1615      * @param listener the listener to notify
1616      * @see #startSmoothZoom(int)
1617      */
setZoomChangeListener(OnZoomChangeListener listener)1618     public final void setZoomChangeListener(OnZoomChangeListener listener)
1619     {
1620         mZoomListener = listener;
1621     }
1622 
1623     /**
1624      * Callback interface for face detected in the preview frame.
1625      *
1626      * @deprecated We recommend using the new {@link android.hardware.camera2} API for new
1627      *             applications.
1628      */
1629     @Deprecated
1630     public interface FaceDetectionListener
1631     {
1632         /**
1633          * Notify the listener of the detected faces in the preview frame.
1634          *
1635          * @param faces The detected faces in a list
1636          * @param camera  The {@link Camera} service object
1637          */
onFaceDetection(Face[] faces, Camera camera)1638         void onFaceDetection(Face[] faces, Camera camera);
1639     }
1640 
1641     /**
1642      * Registers a listener to be notified about the faces detected in the
1643      * preview frame.
1644      *
1645      * @param listener the listener to notify
1646      * @see #startFaceDetection()
1647      */
setFaceDetectionListener(FaceDetectionListener listener)1648     public final void setFaceDetectionListener(FaceDetectionListener listener)
1649     {
1650         mFaceListener = listener;
1651     }
1652 
1653     /**
1654      * Starts the face detection. This should be called after preview is started.
1655      * The camera will notify {@link FaceDetectionListener} of the detected
1656      * faces in the preview frame. The detected faces may be the same as the
1657      * previous ones. Applications should call {@link #stopFaceDetection} to
1658      * stop the face detection. This method is supported if {@link
1659      * Parameters#getMaxNumDetectedFaces()} returns a number larger than 0.
1660      * If the face detection has started, apps should not call this again.
1661      *
1662      * <p>When the face detection is running, {@link Parameters#setWhiteBalance(String)},
1663      * {@link Parameters#setFocusAreas(List)}, and {@link Parameters#setMeteringAreas(List)}
1664      * have no effect. The camera uses the detected faces to do auto-white balance,
1665      * auto exposure, and autofocus.
1666      *
1667      * <p>If the apps call {@link #autoFocus(AutoFocusCallback)}, the camera
1668      * will stop sending face callbacks. The last face callback indicates the
1669      * areas used to do autofocus. After focus completes, face detection will
1670      * resume sending face callbacks. If the apps call {@link
1671      * #cancelAutoFocus()}, the face callbacks will also resume.</p>
1672      *
1673      * <p>After calling {@link #takePicture(Camera.ShutterCallback, Camera.PictureCallback,
1674      * Camera.PictureCallback)} or {@link #stopPreview()}, and then resuming
1675      * preview with {@link #startPreview()}, the apps should call this method
1676      * again to resume face detection.</p>
1677      *
1678      * @throws IllegalArgumentException if the face detection is unsupported.
1679      * @throws RuntimeException if the method fails or the face detection is
1680      *         already running.
1681      * @see FaceDetectionListener
1682      * @see #stopFaceDetection()
1683      * @see Parameters#getMaxNumDetectedFaces()
1684      */
startFaceDetection()1685     public final void startFaceDetection() {
1686         if (mFaceDetectionRunning) {
1687             throw new RuntimeException("Face detection is already running");
1688         }
1689         _startFaceDetection(CAMERA_FACE_DETECTION_HW);
1690         mFaceDetectionRunning = true;
1691     }
1692 
1693     /**
1694      * Stops the face detection.
1695      *
1696      * @see #startFaceDetection()
1697      */
stopFaceDetection()1698     public final void stopFaceDetection() {
1699         _stopFaceDetection();
1700         mFaceDetectionRunning = false;
1701     }
1702 
_startFaceDetection(int type)1703     private native final void _startFaceDetection(int type);
_stopFaceDetection()1704     private native final void _stopFaceDetection();
1705 
1706     /**
1707      * Information about a face identified through camera face detection.
1708      *
1709      * <p>When face detection is used with a camera, the {@link FaceDetectionListener} returns a
1710      * list of face objects for use in focusing and metering.</p>
1711      *
1712      * @see FaceDetectionListener
1713      * @deprecated We recommend using the new {@link android.hardware.camera2} API for new
1714      *             applications.
1715      */
1716     @Deprecated
1717     public static class Face {
1718         /**
1719          * Create an empty face.
1720          */
Face()1721         public Face() {
1722         }
1723 
1724         /**
1725          * Bounds of the face. (-1000, -1000) represents the top-left of the
1726          * camera field of view, and (1000, 1000) represents the bottom-right of
1727          * the field of view. For example, suppose the size of the viewfinder UI
1728          * is 800x480. The rect passed from the driver is (-1000, -1000, 0, 0).
1729          * The corresponding viewfinder rect should be (0, 0, 400, 240). It is
1730          * guaranteed left < right and top < bottom. The coordinates can be
1731          * smaller than -1000 or bigger than 1000. But at least one vertex will
1732          * be within (-1000, -1000) and (1000, 1000).
1733          *
1734          * <p>The direction is relative to the sensor orientation, that is, what
1735          * the sensor sees. The direction is not affected by the rotation or
1736          * mirroring of {@link #setDisplayOrientation(int)}. The face bounding
1737          * rectangle does not provide any information about face orientation.</p>
1738          *
1739          * <p>Here is the matrix to convert driver coordinates to View coordinates
1740          * in pixels.</p>
1741          * <pre>
1742          * Matrix matrix = new Matrix();
1743          * CameraInfo info = CameraHolder.instance().getCameraInfo()[cameraId];
1744          * // Need mirror for front camera.
1745          * boolean mirror = (info.facing == CameraInfo.CAMERA_FACING_FRONT);
1746          * matrix.setScale(mirror ? -1 : 1, 1);
1747          * // This is the value for android.hardware.Camera.setDisplayOrientation.
1748          * matrix.postRotate(displayOrientation);
1749          * // Camera driver coordinates range from (-1000, -1000) to (1000, 1000).
1750          * // UI coordinates range from (0, 0) to (width, height).
1751          * matrix.postScale(view.getWidth() / 2000f, view.getHeight() / 2000f);
1752          * matrix.postTranslate(view.getWidth() / 2f, view.getHeight() / 2f);
1753          * </pre>
1754          *
1755          * @see #startFaceDetection()
1756          */
1757         public Rect rect;
1758 
1759         /**
1760          * <p>The confidence level for the detection of the face. The range is 1 to
1761          * 100. 100 is the highest confidence.</p>
1762          *
1763          * <p>Depending on the device, even very low-confidence faces may be
1764          * listed, so applications should filter out faces with low confidence,
1765          * depending on the use case. For a typical point-and-shoot camera
1766          * application that wishes to display rectangles around detected faces,
1767          * filtering out faces with confidence less than 50 is recommended.</p>
1768          *
1769          * @see #startFaceDetection()
1770          */
1771         public int score;
1772 
1773         /**
1774          * An unique id per face while the face is visible to the tracker. If
1775          * the face leaves the field-of-view and comes back, it will get a new
1776          * id. This is an optional field, may not be supported on all devices.
1777          * If not supported, id will always be set to -1. The optional fields
1778          * are supported as a set. Either they are all valid, or none of them
1779          * are.
1780          */
1781         public int id = -1;
1782 
1783         /**
1784          * The coordinates of the center of the left eye. The coordinates are in
1785          * the same space as the ones for {@link #rect}. This is an optional
1786          * field, may not be supported on all devices. If not supported, the
1787          * value will always be set to null. The optional fields are supported
1788          * as a set. Either they are all valid, or none of them are.
1789          */
1790         public Point leftEye = null;
1791 
1792         /**
1793          * The coordinates of the center of the right eye. The coordinates are
1794          * in the same space as the ones for {@link #rect}.This is an optional
1795          * field, may not be supported on all devices. If not supported, the
1796          * value will always be set to null. The optional fields are supported
1797          * as a set. Either they are all valid, or none of them are.
1798          */
1799         public Point rightEye = null;
1800 
1801         /**
1802          * The coordinates of the center of the mouth.  The coordinates are in
1803          * the same space as the ones for {@link #rect}. This is an optional
1804          * field, may not be supported on all devices. If not supported, the
1805          * value will always be set to null. The optional fields are supported
1806          * as a set. Either they are all valid, or none of them are.
1807          */
1808         public Point mouth = null;
1809     }
1810 
1811     /**
1812      * Unspecified camera error.
1813      * @see Camera.ErrorCallback
1814      */
1815     public static final int CAMERA_ERROR_UNKNOWN = 1;
1816 
1817     /**
1818      * Camera was disconnected due to use by higher priority user.
1819      * @see Camera.ErrorCallback
1820      */
1821     public static final int CAMERA_ERROR_EVICTED = 2;
1822 
1823     /**
1824      * Media server died. In this case, the application must release the
1825      * Camera object and instantiate a new one.
1826      * @see Camera.ErrorCallback
1827      */
1828     public static final int CAMERA_ERROR_SERVER_DIED = 100;
1829 
1830     /**
1831      * Callback interface for camera error notification.
1832      *
1833      * @see #setErrorCallback(ErrorCallback)
1834      *
1835      * @deprecated We recommend using the new {@link android.hardware.camera2} API for new
1836      *             applications.
1837      */
1838     @Deprecated
1839     public interface ErrorCallback
1840     {
1841         /**
1842          * Callback for camera errors.
1843          * @param error   error code:
1844          * <ul>
1845          * <li>{@link #CAMERA_ERROR_UNKNOWN}
1846          * <li>{@link #CAMERA_ERROR_SERVER_DIED}
1847          * </ul>
1848          * @param camera  the Camera service object
1849          */
onError(int error, Camera camera)1850         void onError(int error, Camera camera);
1851     };
1852 
1853     /**
1854      * Registers a callback to be invoked when an error occurs.
1855      * @param cb The callback to run
1856      */
setErrorCallback(ErrorCallback cb)1857     public final void setErrorCallback(ErrorCallback cb)
1858     {
1859         mErrorCallback = cb;
1860     }
1861 
native_setParameters(String params)1862     private native final void native_setParameters(String params);
native_getParameters()1863     private native final String native_getParameters();
1864 
1865     /**
1866      * Changes the settings for this Camera service.
1867      *
1868      * @param params the Parameters to use for this Camera service
1869      * @throws RuntimeException if any parameter is invalid or not supported.
1870      * @see #getParameters()
1871      */
setParameters(Parameters params)1872     public void setParameters(Parameters params) {
1873         // If using preview allocations, don't allow preview size changes
1874         if (mUsingPreviewAllocation) {
1875             Size newPreviewSize = params.getPreviewSize();
1876             Size currentPreviewSize = getParameters().getPreviewSize();
1877             if (newPreviewSize.width != currentPreviewSize.width ||
1878                     newPreviewSize.height != currentPreviewSize.height) {
1879                 throw new IllegalStateException("Cannot change preview size" +
1880                         " while a preview allocation is configured.");
1881             }
1882         }
1883 
1884         native_setParameters(params.flatten());
1885     }
1886 
1887     /**
1888      * Returns the current settings for this Camera service.
1889      * If modifications are made to the returned Parameters, they must be passed
1890      * to {@link #setParameters(Camera.Parameters)} to take effect.
1891      *
1892      * @see #setParameters(Camera.Parameters)
1893      */
getParameters()1894     public Parameters getParameters() {
1895         Parameters p = new Parameters();
1896         String s = native_getParameters();
1897         p.unflatten(s);
1898         return p;
1899     }
1900 
1901     /**
1902      * Returns an empty {@link Parameters} for testing purpose.
1903      *
1904      * @return a Parameter object.
1905      *
1906      * @hide
1907      */
getEmptyParameters()1908     public static Parameters getEmptyParameters() {
1909         Camera camera = new Camera();
1910         return camera.new Parameters();
1911     }
1912 
1913     /**
1914      * Returns a copied {@link Parameters}; for shim use only.
1915      *
1916      * @param parameters a non-{@code null} parameters
1917      * @return a Parameter object, with all the parameters copied from {@code parameters}.
1918      *
1919      * @throws NullPointerException if {@code parameters} was {@code null}
1920      * @hide
1921      */
getParametersCopy(Camera.Parameters parameters)1922     public static Parameters getParametersCopy(Camera.Parameters parameters) {
1923         if (parameters == null) {
1924             throw new NullPointerException("parameters must not be null");
1925         }
1926 
1927         Camera camera = parameters.getOuter();
1928         Parameters p = camera.new Parameters();
1929         p.copyFrom(parameters);
1930 
1931         return p;
1932     }
1933 
1934     /**
1935      * Image size (width and height dimensions).
1936      * @deprecated We recommend using the new {@link android.hardware.camera2} API for new
1937      *             applications.
1938      */
1939     @Deprecated
1940     public class Size {
1941         /**
1942          * Sets the dimensions for pictures.
1943          *
1944          * @param w the photo width (pixels)
1945          * @param h the photo height (pixels)
1946          */
Size(int w, int h)1947         public Size(int w, int h) {
1948             width = w;
1949             height = h;
1950         }
1951         /**
1952          * Compares {@code obj} to this size.
1953          *
1954          * @param obj the object to compare this size with.
1955          * @return {@code true} if the width and height of {@code obj} is the
1956          *         same as those of this size. {@code false} otherwise.
1957          */
1958         @Override
equals(Object obj)1959         public boolean equals(Object obj) {
1960             if (!(obj instanceof Size)) {
1961                 return false;
1962             }
1963             Size s = (Size) obj;
1964             return width == s.width && height == s.height;
1965         }
1966         @Override
hashCode()1967         public int hashCode() {
1968             return width * 32713 + height;
1969         }
1970         /** width of the picture */
1971         public int width;
1972         /** height of the picture */
1973         public int height;
1974     };
1975 
1976     /**
1977      * <p>The Area class is used for choosing specific metering and focus areas for
1978      * the camera to use when calculating auto-exposure, auto-white balance, and
1979      * auto-focus.</p>
1980      *
1981      * <p>To find out how many simultaneous areas a given camera supports, use
1982      * {@link Parameters#getMaxNumMeteringAreas()} and
1983      * {@link Parameters#getMaxNumFocusAreas()}. If metering or focusing area
1984      * selection is unsupported, these methods will return 0.</p>
1985      *
1986      * <p>Each Area consists of a rectangle specifying its bounds, and a weight
1987      * that determines its importance. The bounds are relative to the camera's
1988      * current field of view. The coordinates are mapped so that (-1000, -1000)
1989      * is always the top-left corner of the current field of view, and (1000,
1990      * 1000) is always the bottom-right corner of the current field of
1991      * view. Setting Areas with bounds outside that range is not allowed. Areas
1992      * with zero or negative width or height are not allowed.</p>
1993      *
1994      * <p>The weight must range from 1 to 1000, and represents a weight for
1995      * every pixel in the area. This means that a large metering area with
1996      * the same weight as a smaller area will have more effect in the
1997      * metering result.  Metering areas can overlap and the driver
1998      * will add the weights in the overlap region.</p>
1999      *
2000      * @see Parameters#setFocusAreas(List)
2001      * @see Parameters#getFocusAreas()
2002      * @see Parameters#getMaxNumFocusAreas()
2003      * @see Parameters#setMeteringAreas(List)
2004      * @see Parameters#getMeteringAreas()
2005      * @see Parameters#getMaxNumMeteringAreas()
2006      *
2007      * @deprecated We recommend using the new {@link android.hardware.camera2} API for new
2008      *             applications.
2009      */
2010     @Deprecated
2011     public static class Area {
2012         /**
2013          * Create an area with specified rectangle and weight.
2014          *
2015          * @param rect the bounds of the area.
2016          * @param weight the weight of the area.
2017          */
Area(Rect rect, int weight)2018         public Area(Rect rect, int weight) {
2019             this.rect = rect;
2020             this.weight = weight;
2021         }
2022         /**
2023          * Compares {@code obj} to this area.
2024          *
2025          * @param obj the object to compare this area with.
2026          * @return {@code true} if the rectangle and weight of {@code obj} is
2027          *         the same as those of this area. {@code false} otherwise.
2028          */
2029         @Override
equals(Object obj)2030         public boolean equals(Object obj) {
2031             if (!(obj instanceof Area)) {
2032                 return false;
2033             }
2034             Area a = (Area) obj;
2035             if (rect == null) {
2036                 if (a.rect != null) return false;
2037             } else {
2038                 if (!rect.equals(a.rect)) return false;
2039             }
2040             return weight == a.weight;
2041         }
2042 
2043         /**
2044          * Bounds of the area. (-1000, -1000) represents the top-left of the
2045          * camera field of view, and (1000, 1000) represents the bottom-right of
2046          * the field of view. Setting bounds outside that range is not
2047          * allowed. Bounds with zero or negative width or height are not
2048          * allowed.
2049          *
2050          * @see Parameters#getFocusAreas()
2051          * @see Parameters#getMeteringAreas()
2052          */
2053         public Rect rect;
2054 
2055         /**
2056          * Weight of the area. The weight must range from 1 to 1000, and
2057          * represents a weight for every pixel in the area. This means that a
2058          * large metering area with the same weight as a smaller area will have
2059          * more effect in the metering result.  Metering areas can overlap and
2060          * the driver will add the weights in the overlap region.
2061          *
2062          * @see Parameters#getFocusAreas()
2063          * @see Parameters#getMeteringAreas()
2064          */
2065         public int weight;
2066     }
2067 
2068     /**
2069      * Camera service settings.
2070      *
2071      * <p>To make camera parameters take effect, applications have to call
2072      * {@link Camera#setParameters(Camera.Parameters)}. For example, after
2073      * {@link Camera.Parameters#setWhiteBalance} is called, white balance is not
2074      * actually changed until {@link Camera#setParameters(Camera.Parameters)}
2075      * is called with the changed parameters object.
2076      *
2077      * <p>Different devices may have different camera capabilities, such as
2078      * picture size or flash modes. The application should query the camera
2079      * capabilities before setting parameters. For example, the application
2080      * should call {@link Camera.Parameters#getSupportedColorEffects()} before
2081      * calling {@link Camera.Parameters#setColorEffect(String)}. If the
2082      * camera does not support color effects,
2083      * {@link Camera.Parameters#getSupportedColorEffects()} will return null.
2084      *
2085      * @deprecated We recommend using the new {@link android.hardware.camera2} API for new
2086      *             applications.
2087      */
2088     @Deprecated
2089     public class Parameters {
2090         // Parameter keys to communicate with the camera driver.
2091         private static final String KEY_PREVIEW_SIZE = "preview-size";
2092         private static final String KEY_PREVIEW_FORMAT = "preview-format";
2093         private static final String KEY_PREVIEW_FRAME_RATE = "preview-frame-rate";
2094         private static final String KEY_PREVIEW_FPS_RANGE = "preview-fps-range";
2095         private static final String KEY_PICTURE_SIZE = "picture-size";
2096         private static final String KEY_PICTURE_FORMAT = "picture-format";
2097         private static final String KEY_JPEG_THUMBNAIL_SIZE = "jpeg-thumbnail-size";
2098         private static final String KEY_JPEG_THUMBNAIL_WIDTH = "jpeg-thumbnail-width";
2099         private static final String KEY_JPEG_THUMBNAIL_HEIGHT = "jpeg-thumbnail-height";
2100         private static final String KEY_JPEG_THUMBNAIL_QUALITY = "jpeg-thumbnail-quality";
2101         private static final String KEY_JPEG_QUALITY = "jpeg-quality";
2102         private static final String KEY_ROTATION = "rotation";
2103         private static final String KEY_GPS_LATITUDE = "gps-latitude";
2104         private static final String KEY_GPS_LONGITUDE = "gps-longitude";
2105         private static final String KEY_GPS_ALTITUDE = "gps-altitude";
2106         private static final String KEY_GPS_TIMESTAMP = "gps-timestamp";
2107         private static final String KEY_GPS_PROCESSING_METHOD = "gps-processing-method";
2108         private static final String KEY_WHITE_BALANCE = "whitebalance";
2109         private static final String KEY_EFFECT = "effect";
2110         private static final String KEY_ANTIBANDING = "antibanding";
2111         private static final String KEY_SCENE_MODE = "scene-mode";
2112         private static final String KEY_FLASH_MODE = "flash-mode";
2113         private static final String KEY_FOCUS_MODE = "focus-mode";
2114         private static final String KEY_FOCUS_AREAS = "focus-areas";
2115         private static final String KEY_MAX_NUM_FOCUS_AREAS = "max-num-focus-areas";
2116         private static final String KEY_FOCAL_LENGTH = "focal-length";
2117         private static final String KEY_HORIZONTAL_VIEW_ANGLE = "horizontal-view-angle";
2118         private static final String KEY_VERTICAL_VIEW_ANGLE = "vertical-view-angle";
2119         private static final String KEY_EXPOSURE_COMPENSATION = "exposure-compensation";
2120         private static final String KEY_MAX_EXPOSURE_COMPENSATION = "max-exposure-compensation";
2121         private static final String KEY_MIN_EXPOSURE_COMPENSATION = "min-exposure-compensation";
2122         private static final String KEY_EXPOSURE_COMPENSATION_STEP = "exposure-compensation-step";
2123         private static final String KEY_AUTO_EXPOSURE_LOCK = "auto-exposure-lock";
2124         private static final String KEY_AUTO_EXPOSURE_LOCK_SUPPORTED = "auto-exposure-lock-supported";
2125         private static final String KEY_AUTO_WHITEBALANCE_LOCK = "auto-whitebalance-lock";
2126         private static final String KEY_AUTO_WHITEBALANCE_LOCK_SUPPORTED = "auto-whitebalance-lock-supported";
2127         private static final String KEY_METERING_AREAS = "metering-areas";
2128         private static final String KEY_MAX_NUM_METERING_AREAS = "max-num-metering-areas";
2129         private static final String KEY_ZOOM = "zoom";
2130         private static final String KEY_MAX_ZOOM = "max-zoom";
2131         private static final String KEY_ZOOM_RATIOS = "zoom-ratios";
2132         private static final String KEY_ZOOM_SUPPORTED = "zoom-supported";
2133         private static final String KEY_SMOOTH_ZOOM_SUPPORTED = "smooth-zoom-supported";
2134         private static final String KEY_FOCUS_DISTANCES = "focus-distances";
2135         private static final String KEY_VIDEO_SIZE = "video-size";
2136         private static final String KEY_PREFERRED_PREVIEW_SIZE_FOR_VIDEO =
2137                                             "preferred-preview-size-for-video";
2138         private static final String KEY_MAX_NUM_DETECTED_FACES_HW = "max-num-detected-faces-hw";
2139         private static final String KEY_MAX_NUM_DETECTED_FACES_SW = "max-num-detected-faces-sw";
2140         private static final String KEY_RECORDING_HINT = "recording-hint";
2141         private static final String KEY_VIDEO_SNAPSHOT_SUPPORTED = "video-snapshot-supported";
2142         private static final String KEY_VIDEO_STABILIZATION = "video-stabilization";
2143         private static final String KEY_VIDEO_STABILIZATION_SUPPORTED = "video-stabilization-supported";
2144 
2145         // Parameter key suffix for supported values.
2146         private static final String SUPPORTED_VALUES_SUFFIX = "-values";
2147 
2148         private static final String TRUE = "true";
2149         private static final String FALSE = "false";
2150 
2151         // Values for white balance settings.
2152         public static final String WHITE_BALANCE_AUTO = "auto";
2153         public static final String WHITE_BALANCE_INCANDESCENT = "incandescent";
2154         public static final String WHITE_BALANCE_FLUORESCENT = "fluorescent";
2155         public static final String WHITE_BALANCE_WARM_FLUORESCENT = "warm-fluorescent";
2156         public static final String WHITE_BALANCE_DAYLIGHT = "daylight";
2157         public static final String WHITE_BALANCE_CLOUDY_DAYLIGHT = "cloudy-daylight";
2158         public static final String WHITE_BALANCE_TWILIGHT = "twilight";
2159         public static final String WHITE_BALANCE_SHADE = "shade";
2160 
2161         // Values for color effect settings.
2162         public static final String EFFECT_NONE = "none";
2163         public static final String EFFECT_MONO = "mono";
2164         public static final String EFFECT_NEGATIVE = "negative";
2165         public static final String EFFECT_SOLARIZE = "solarize";
2166         public static final String EFFECT_SEPIA = "sepia";
2167         public static final String EFFECT_POSTERIZE = "posterize";
2168         public static final String EFFECT_WHITEBOARD = "whiteboard";
2169         public static final String EFFECT_BLACKBOARD = "blackboard";
2170         public static final String EFFECT_AQUA = "aqua";
2171 
2172         // Values for antibanding settings.
2173         public static final String ANTIBANDING_AUTO = "auto";
2174         public static final String ANTIBANDING_50HZ = "50hz";
2175         public static final String ANTIBANDING_60HZ = "60hz";
2176         public static final String ANTIBANDING_OFF = "off";
2177 
2178         // Values for flash mode settings.
2179         /**
2180          * Flash will not be fired.
2181          */
2182         public static final String FLASH_MODE_OFF = "off";
2183 
2184         /**
2185          * Flash will be fired automatically when required. The flash may be fired
2186          * during preview, auto-focus, or snapshot depending on the driver.
2187          */
2188         public static final String FLASH_MODE_AUTO = "auto";
2189 
2190         /**
2191          * Flash will always be fired during snapshot. The flash may also be
2192          * fired during preview or auto-focus depending on the driver.
2193          */
2194         public static final String FLASH_MODE_ON = "on";
2195 
2196         /**
2197          * Flash will be fired in red-eye reduction mode.
2198          */
2199         public static final String FLASH_MODE_RED_EYE = "red-eye";
2200 
2201         /**
2202          * Constant emission of light during preview, auto-focus and snapshot.
2203          * This can also be used for video recording.
2204          */
2205         public static final String FLASH_MODE_TORCH = "torch";
2206 
2207         /**
2208          * Scene mode is off.
2209          */
2210         public static final String SCENE_MODE_AUTO = "auto";
2211 
2212         /**
2213          * Take photos of fast moving objects. Same as {@link
2214          * #SCENE_MODE_SPORTS}.
2215          */
2216         public static final String SCENE_MODE_ACTION = "action";
2217 
2218         /**
2219          * Take people pictures.
2220          */
2221         public static final String SCENE_MODE_PORTRAIT = "portrait";
2222 
2223         /**
2224          * Take pictures on distant objects.
2225          */
2226         public static final String SCENE_MODE_LANDSCAPE = "landscape";
2227 
2228         /**
2229          * Take photos at night.
2230          */
2231         public static final String SCENE_MODE_NIGHT = "night";
2232 
2233         /**
2234          * Take people pictures at night.
2235          */
2236         public static final String SCENE_MODE_NIGHT_PORTRAIT = "night-portrait";
2237 
2238         /**
2239          * Take photos in a theater. Flash light is off.
2240          */
2241         public static final String SCENE_MODE_THEATRE = "theatre";
2242 
2243         /**
2244          * Take pictures on the beach.
2245          */
2246         public static final String SCENE_MODE_BEACH = "beach";
2247 
2248         /**
2249          * Take pictures on the snow.
2250          */
2251         public static final String SCENE_MODE_SNOW = "snow";
2252 
2253         /**
2254          * Take sunset photos.
2255          */
2256         public static final String SCENE_MODE_SUNSET = "sunset";
2257 
2258         /**
2259          * Avoid blurry pictures (for example, due to hand shake).
2260          */
2261         public static final String SCENE_MODE_STEADYPHOTO = "steadyphoto";
2262 
2263         /**
2264          * For shooting firework displays.
2265          */
2266         public static final String SCENE_MODE_FIREWORKS = "fireworks";
2267 
2268         /**
2269          * Take photos of fast moving objects. Same as {@link
2270          * #SCENE_MODE_ACTION}.
2271          */
2272         public static final String SCENE_MODE_SPORTS = "sports";
2273 
2274         /**
2275          * Take indoor low-light shot.
2276          */
2277         public static final String SCENE_MODE_PARTY = "party";
2278 
2279         /**
2280          * Capture the naturally warm color of scenes lit by candles.
2281          */
2282         public static final String SCENE_MODE_CANDLELIGHT = "candlelight";
2283 
2284         /**
2285          * Applications are looking for a barcode. Camera driver will be
2286          * optimized for barcode reading.
2287          */
2288         public static final String SCENE_MODE_BARCODE = "barcode";
2289 
2290         /**
2291          * Capture a scene using high dynamic range imaging techniques. The
2292          * camera will return an image that has an extended dynamic range
2293          * compared to a regular capture. Capturing such an image may take
2294          * longer than a regular capture.
2295          */
2296         public static final String SCENE_MODE_HDR = "hdr";
2297 
2298         /**
2299          * Auto-focus mode. Applications should call {@link
2300          * #autoFocus(AutoFocusCallback)} to start the focus in this mode.
2301          */
2302         public static final String FOCUS_MODE_AUTO = "auto";
2303 
2304         /**
2305          * Focus is set at infinity. Applications should not call
2306          * {@link #autoFocus(AutoFocusCallback)} in this mode.
2307          */
2308         public static final String FOCUS_MODE_INFINITY = "infinity";
2309 
2310         /**
2311          * Macro (close-up) focus mode. Applications should call
2312          * {@link #autoFocus(AutoFocusCallback)} to start the focus in this
2313          * mode.
2314          */
2315         public static final String FOCUS_MODE_MACRO = "macro";
2316 
2317         /**
2318          * Focus is fixed. The camera is always in this mode if the focus is not
2319          * adjustable. If the camera has auto-focus, this mode can fix the
2320          * focus, which is usually at hyperfocal distance. Applications should
2321          * not call {@link #autoFocus(AutoFocusCallback)} in this mode.
2322          */
2323         public static final String FOCUS_MODE_FIXED = "fixed";
2324 
2325         /**
2326          * Extended depth of field (EDOF). Focusing is done digitally and
2327          * continuously. Applications should not call {@link
2328          * #autoFocus(AutoFocusCallback)} in this mode.
2329          */
2330         public static final String FOCUS_MODE_EDOF = "edof";
2331 
2332         /**
2333          * Continuous auto focus mode intended for video recording. The camera
2334          * continuously tries to focus. This is the best choice for video
2335          * recording because the focus changes smoothly . Applications still can
2336          * call {@link #takePicture(Camera.ShutterCallback,
2337          * Camera.PictureCallback, Camera.PictureCallback)} in this mode but the
2338          * subject may not be in focus. Auto focus starts when the parameter is
2339          * set.
2340          *
2341          * <p>Since API level 14, applications can call {@link
2342          * #autoFocus(AutoFocusCallback)} in this mode. The focus callback will
2343          * immediately return with a boolean that indicates whether the focus is
2344          * sharp or not. The focus position is locked after autoFocus call. If
2345          * applications want to resume the continuous focus, cancelAutoFocus
2346          * must be called. Restarting the preview will not resume the continuous
2347          * autofocus. To stop continuous focus, applications should change the
2348          * focus mode to other modes.
2349          *
2350          * @see #FOCUS_MODE_CONTINUOUS_PICTURE
2351          */
2352         public static final String FOCUS_MODE_CONTINUOUS_VIDEO = "continuous-video";
2353 
2354         /**
2355          * Continuous auto focus mode intended for taking pictures. The camera
2356          * continuously tries to focus. The speed of focus change is more
2357          * aggressive than {@link #FOCUS_MODE_CONTINUOUS_VIDEO}. Auto focus
2358          * starts when the parameter is set.
2359          *
2360          * <p>Applications can call {@link #autoFocus(AutoFocusCallback)} in
2361          * this mode. If the autofocus is in the middle of scanning, the focus
2362          * callback will return when it completes. If the autofocus is not
2363          * scanning, the focus callback will immediately return with a boolean
2364          * that indicates whether the focus is sharp or not. The apps can then
2365          * decide if they want to take a picture immediately or to change the
2366          * focus mode to auto, and run a full autofocus cycle. The focus
2367          * position is locked after autoFocus call. If applications want to
2368          * resume the continuous focus, cancelAutoFocus must be called.
2369          * Restarting the preview will not resume the continuous autofocus. To
2370          * stop continuous focus, applications should change the focus mode to
2371          * other modes.
2372          *
2373          * @see #FOCUS_MODE_CONTINUOUS_VIDEO
2374          */
2375         public static final String FOCUS_MODE_CONTINUOUS_PICTURE = "continuous-picture";
2376 
2377         // Indices for focus distance array.
2378         /**
2379          * The array index of near focus distance for use with
2380          * {@link #getFocusDistances(float[])}.
2381          */
2382         public static final int FOCUS_DISTANCE_NEAR_INDEX = 0;
2383 
2384         /**
2385          * The array index of optimal focus distance for use with
2386          * {@link #getFocusDistances(float[])}.
2387          */
2388         public static final int FOCUS_DISTANCE_OPTIMAL_INDEX = 1;
2389 
2390         /**
2391          * The array index of far focus distance for use with
2392          * {@link #getFocusDistances(float[])}.
2393          */
2394         public static final int FOCUS_DISTANCE_FAR_INDEX = 2;
2395 
2396         /**
2397          * The array index of minimum preview fps for use with {@link
2398          * #getPreviewFpsRange(int[])} or {@link
2399          * #getSupportedPreviewFpsRange()}.
2400          */
2401         public static final int PREVIEW_FPS_MIN_INDEX = 0;
2402 
2403         /**
2404          * The array index of maximum preview fps for use with {@link
2405          * #getPreviewFpsRange(int[])} or {@link
2406          * #getSupportedPreviewFpsRange()}.
2407          */
2408         public static final int PREVIEW_FPS_MAX_INDEX = 1;
2409 
2410         // Formats for setPreviewFormat and setPictureFormat.
2411         private static final String PIXEL_FORMAT_YUV422SP = "yuv422sp";
2412         private static final String PIXEL_FORMAT_YUV420SP = "yuv420sp";
2413         private static final String PIXEL_FORMAT_YUV422I = "yuv422i-yuyv";
2414         private static final String PIXEL_FORMAT_YUV420P = "yuv420p";
2415         private static final String PIXEL_FORMAT_RGB565 = "rgb565";
2416         private static final String PIXEL_FORMAT_JPEG = "jpeg";
2417         private static final String PIXEL_FORMAT_BAYER_RGGB = "bayer-rggb";
2418 
2419         /**
2420          * Order matters: Keys that are {@link #set(String, String) set} later
2421          * will take precedence over keys that are set earlier (if the two keys
2422          * conflict with each other).
2423          *
2424          * <p>One example is {@link #setPreviewFpsRange(int, int)} , since it
2425          * conflicts with {@link #setPreviewFrameRate(int)} whichever key is set later
2426          * is the one that will take precedence.
2427          * </p>
2428          */
2429         private final LinkedHashMap<String, String> mMap;
2430 
Parameters()2431         private Parameters() {
2432             mMap = new LinkedHashMap<String, String>(/*initialCapacity*/64);
2433         }
2434 
2435         /**
2436          * Overwrite existing parameters with a copy of the ones from {@code other}.
2437          *
2438          * <b>For use by the legacy shim only.</b>
2439          *
2440          * @hide
2441          */
copyFrom(Parameters other)2442         public void copyFrom(Parameters other) {
2443             if (other == null) {
2444                 throw new NullPointerException("other must not be null");
2445             }
2446 
2447             mMap.putAll(other.mMap);
2448         }
2449 
getOuter()2450         private Camera getOuter() {
2451             return Camera.this;
2452         }
2453 
2454 
2455         /**
2456          * Value equality check.
2457          *
2458          * @hide
2459          */
same(Parameters other)2460         public boolean same(Parameters other) {
2461             if (this == other) {
2462                 return true;
2463             }
2464             return other != null && Parameters.this.mMap.equals(other.mMap);
2465         }
2466 
2467         /**
2468          * Writes the current Parameters to the log.
2469          * @hide
2470          * @deprecated
2471          */
2472         @Deprecated
dump()2473         public void dump() {
2474             Log.e(TAG, "dump: size=" + mMap.size());
2475             for (String k : mMap.keySet()) {
2476                 Log.e(TAG, "dump: " + k + "=" + mMap.get(k));
2477             }
2478         }
2479 
2480         /**
2481          * Creates a single string with all the parameters set in
2482          * this Parameters object.
2483          * <p>The {@link #unflatten(String)} method does the reverse.</p>
2484          *
2485          * @return a String with all values from this Parameters object, in
2486          *         semi-colon delimited key-value pairs
2487          */
flatten()2488         public String flatten() {
2489             StringBuilder flattened = new StringBuilder(128);
2490             for (String k : mMap.keySet()) {
2491                 flattened.append(k);
2492                 flattened.append("=");
2493                 flattened.append(mMap.get(k));
2494                 flattened.append(";");
2495             }
2496             // chop off the extra semicolon at the end
2497             flattened.deleteCharAt(flattened.length()-1);
2498             return flattened.toString();
2499         }
2500 
2501         /**
2502          * Takes a flattened string of parameters and adds each one to
2503          * this Parameters object.
2504          * <p>The {@link #flatten()} method does the reverse.</p>
2505          *
2506          * @param flattened a String of parameters (key-value paired) that
2507          *                  are semi-colon delimited
2508          */
unflatten(String flattened)2509         public void unflatten(String flattened) {
2510             mMap.clear();
2511 
2512             TextUtils.StringSplitter splitter = new TextUtils.SimpleStringSplitter(';');
2513             splitter.setString(flattened);
2514             for (String kv : splitter) {
2515                 int pos = kv.indexOf('=');
2516                 if (pos == -1) {
2517                     continue;
2518                 }
2519                 String k = kv.substring(0, pos);
2520                 String v = kv.substring(pos + 1);
2521                 mMap.put(k, v);
2522             }
2523         }
2524 
remove(String key)2525         public void remove(String key) {
2526             mMap.remove(key);
2527         }
2528 
2529         /**
2530          * Sets a String parameter.
2531          *
2532          * @param key   the key name for the parameter
2533          * @param value the String value of the parameter
2534          */
set(String key, String value)2535         public void set(String key, String value) {
2536             if (key.indexOf('=') != -1 || key.indexOf(';') != -1 || key.indexOf(0) != -1) {
2537                 Log.e(TAG, "Key \"" + key + "\" contains invalid character (= or ; or \\0)");
2538                 return;
2539             }
2540             if (value.indexOf('=') != -1 || value.indexOf(';') != -1 || value.indexOf(0) != -1) {
2541                 Log.e(TAG, "Value \"" + value + "\" contains invalid character (= or ; or \\0)");
2542                 return;
2543             }
2544 
2545             put(key, value);
2546         }
2547 
2548         /**
2549          * Sets an integer parameter.
2550          *
2551          * @param key   the key name for the parameter
2552          * @param value the int value of the parameter
2553          */
set(String key, int value)2554         public void set(String key, int value) {
2555             put(key, Integer.toString(value));
2556         }
2557 
put(String key, String value)2558         private void put(String key, String value) {
2559             /*
2560              * Remove the key if it already exists.
2561              *
2562              * This way setting a new value for an already existing key will always move
2563              * that key to be ordered the latest in the map.
2564              */
2565             mMap.remove(key);
2566             mMap.put(key, value);
2567         }
2568 
set(String key, List<Area> areas)2569         private void set(String key, List<Area> areas) {
2570             if (areas == null) {
2571                 set(key, "(0,0,0,0,0)");
2572             } else {
2573                 StringBuilder buffer = new StringBuilder();
2574                 for (int i = 0; i < areas.size(); i++) {
2575                     Area area = areas.get(i);
2576                     Rect rect = area.rect;
2577                     buffer.append('(');
2578                     buffer.append(rect.left);
2579                     buffer.append(',');
2580                     buffer.append(rect.top);
2581                     buffer.append(',');
2582                     buffer.append(rect.right);
2583                     buffer.append(',');
2584                     buffer.append(rect.bottom);
2585                     buffer.append(',');
2586                     buffer.append(area.weight);
2587                     buffer.append(')');
2588                     if (i != areas.size() - 1) buffer.append(',');
2589                 }
2590                 set(key, buffer.toString());
2591             }
2592         }
2593 
2594         /**
2595          * Returns the value of a String parameter.
2596          *
2597          * @param key the key name for the parameter
2598          * @return the String value of the parameter
2599          */
get(String key)2600         public String get(String key) {
2601             return mMap.get(key);
2602         }
2603 
2604         /**
2605          * Returns the value of an integer parameter.
2606          *
2607          * @param key the key name for the parameter
2608          * @return the int value of the parameter
2609          */
getInt(String key)2610         public int getInt(String key) {
2611             return Integer.parseInt(mMap.get(key));
2612         }
2613 
2614         /**
2615          * Sets the dimensions for preview pictures. If the preview has already
2616          * started, applications should stop the preview first before changing
2617          * preview size.
2618          *
2619          * The sides of width and height are based on camera orientation. That
2620          * is, the preview size is the size before it is rotated by display
2621          * orientation. So applications need to consider the display orientation
2622          * while setting preview size. For example, suppose the camera supports
2623          * both 480x320 and 320x480 preview sizes. The application wants a 3:2
2624          * preview ratio. If the display orientation is set to 0 or 180, preview
2625          * size should be set to 480x320. If the display orientation is set to
2626          * 90 or 270, preview size should be set to 320x480. The display
2627          * orientation should also be considered while setting picture size and
2628          * thumbnail size.
2629          *
2630          * @param width  the width of the pictures, in pixels
2631          * @param height the height of the pictures, in pixels
2632          * @see #setDisplayOrientation(int)
2633          * @see #getCameraInfo(int, CameraInfo)
2634          * @see #setPictureSize(int, int)
2635          * @see #setJpegThumbnailSize(int, int)
2636          */
setPreviewSize(int width, int height)2637         public void setPreviewSize(int width, int height) {
2638             String v = Integer.toString(width) + "x" + Integer.toString(height);
2639             set(KEY_PREVIEW_SIZE, v);
2640         }
2641 
2642         /**
2643          * Returns the dimensions setting for preview pictures.
2644          *
2645          * @return a Size object with the width and height setting
2646          *          for the preview picture
2647          */
getPreviewSize()2648         public Size getPreviewSize() {
2649             String pair = get(KEY_PREVIEW_SIZE);
2650             return strToSize(pair);
2651         }
2652 
2653         /**
2654          * Gets the supported preview sizes.
2655          *
2656          * @return a list of Size object. This method will always return a list
2657          *         with at least one element.
2658          */
getSupportedPreviewSizes()2659         public List<Size> getSupportedPreviewSizes() {
2660             String str = get(KEY_PREVIEW_SIZE + SUPPORTED_VALUES_SUFFIX);
2661             return splitSize(str);
2662         }
2663 
2664         /**
2665          * <p>Gets the supported video frame sizes that can be used by
2666          * MediaRecorder.</p>
2667          *
2668          * <p>If the returned list is not null, the returned list will contain at
2669          * least one Size and one of the sizes in the returned list must be
2670          * passed to MediaRecorder.setVideoSize() for camcorder application if
2671          * camera is used as the video source. In this case, the size of the
2672          * preview can be different from the resolution of the recorded video
2673          * during video recording.</p>
2674          *
2675          * @return a list of Size object if camera has separate preview and
2676          *         video output; otherwise, null is returned.
2677          * @see #getPreferredPreviewSizeForVideo()
2678          */
getSupportedVideoSizes()2679         public List<Size> getSupportedVideoSizes() {
2680             String str = get(KEY_VIDEO_SIZE + SUPPORTED_VALUES_SUFFIX);
2681             return splitSize(str);
2682         }
2683 
2684         /**
2685          * Returns the preferred or recommended preview size (width and height)
2686          * in pixels for video recording. Camcorder applications should
2687          * set the preview size to a value that is not larger than the
2688          * preferred preview size. In other words, the product of the width
2689          * and height of the preview size should not be larger than that of
2690          * the preferred preview size. In addition, we recommend to choose a
2691          * preview size that has the same aspect ratio as the resolution of
2692          * video to be recorded.
2693          *
2694          * @return the preferred preview size (width and height) in pixels for
2695          *         video recording if getSupportedVideoSizes() does not return
2696          *         null; otherwise, null is returned.
2697          * @see #getSupportedVideoSizes()
2698          */
getPreferredPreviewSizeForVideo()2699         public Size getPreferredPreviewSizeForVideo() {
2700             String pair = get(KEY_PREFERRED_PREVIEW_SIZE_FOR_VIDEO);
2701             return strToSize(pair);
2702         }
2703 
2704         /**
2705          * <p>Sets the dimensions for EXIF thumbnail in Jpeg picture. If
2706          * applications set both width and height to 0, EXIF will not contain
2707          * thumbnail.</p>
2708          *
2709          * <p>Applications need to consider the display orientation. See {@link
2710          * #setPreviewSize(int,int)} for reference.</p>
2711          *
2712          * @param width  the width of the thumbnail, in pixels
2713          * @param height the height of the thumbnail, in pixels
2714          * @see #setPreviewSize(int,int)
2715          */
setJpegThumbnailSize(int width, int height)2716         public void setJpegThumbnailSize(int width, int height) {
2717             set(KEY_JPEG_THUMBNAIL_WIDTH, width);
2718             set(KEY_JPEG_THUMBNAIL_HEIGHT, height);
2719         }
2720 
2721         /**
2722          * Returns the dimensions for EXIF thumbnail in Jpeg picture.
2723          *
2724          * @return a Size object with the height and width setting for the EXIF
2725          *         thumbnails
2726          */
getJpegThumbnailSize()2727         public Size getJpegThumbnailSize() {
2728             return new Size(getInt(KEY_JPEG_THUMBNAIL_WIDTH),
2729                             getInt(KEY_JPEG_THUMBNAIL_HEIGHT));
2730         }
2731 
2732         /**
2733          * Gets the supported jpeg thumbnail sizes.
2734          *
2735          * @return a list of Size object. This method will always return a list
2736          *         with at least two elements. Size 0,0 (no thumbnail) is always
2737          *         supported.
2738          */
getSupportedJpegThumbnailSizes()2739         public List<Size> getSupportedJpegThumbnailSizes() {
2740             String str = get(KEY_JPEG_THUMBNAIL_SIZE + SUPPORTED_VALUES_SUFFIX);
2741             return splitSize(str);
2742         }
2743 
2744         /**
2745          * Sets the quality of the EXIF thumbnail in Jpeg picture.
2746          *
2747          * @param quality the JPEG quality of the EXIF thumbnail. The range is 1
2748          *                to 100, with 100 being the best.
2749          */
setJpegThumbnailQuality(int quality)2750         public void setJpegThumbnailQuality(int quality) {
2751             set(KEY_JPEG_THUMBNAIL_QUALITY, quality);
2752         }
2753 
2754         /**
2755          * Returns the quality setting for the EXIF thumbnail in Jpeg picture.
2756          *
2757          * @return the JPEG quality setting of the EXIF thumbnail.
2758          */
getJpegThumbnailQuality()2759         public int getJpegThumbnailQuality() {
2760             return getInt(KEY_JPEG_THUMBNAIL_QUALITY);
2761         }
2762 
2763         /**
2764          * Sets Jpeg quality of captured picture.
2765          *
2766          * @param quality the JPEG quality of captured picture. The range is 1
2767          *                to 100, with 100 being the best.
2768          */
setJpegQuality(int quality)2769         public void setJpegQuality(int quality) {
2770             set(KEY_JPEG_QUALITY, quality);
2771         }
2772 
2773         /**
2774          * Returns the quality setting for the JPEG picture.
2775          *
2776          * @return the JPEG picture quality setting.
2777          */
getJpegQuality()2778         public int getJpegQuality() {
2779             return getInt(KEY_JPEG_QUALITY);
2780         }
2781 
2782         /**
2783          * Sets the rate at which preview frames are received. This is the
2784          * target frame rate. The actual frame rate depends on the driver.
2785          *
2786          * @param fps the frame rate (frames per second)
2787          * @deprecated replaced by {@link #setPreviewFpsRange(int,int)}
2788          */
2789         @Deprecated
setPreviewFrameRate(int fps)2790         public void setPreviewFrameRate(int fps) {
2791             set(KEY_PREVIEW_FRAME_RATE, fps);
2792         }
2793 
2794         /**
2795          * Returns the setting for the rate at which preview frames are
2796          * received. This is the target frame rate. The actual frame rate
2797          * depends on the driver.
2798          *
2799          * @return the frame rate setting (frames per second)
2800          * @deprecated replaced by {@link #getPreviewFpsRange(int[])}
2801          */
2802         @Deprecated
getPreviewFrameRate()2803         public int getPreviewFrameRate() {
2804             return getInt(KEY_PREVIEW_FRAME_RATE);
2805         }
2806 
2807         /**
2808          * Gets the supported preview frame rates.
2809          *
2810          * @return a list of supported preview frame rates. null if preview
2811          *         frame rate setting is not supported.
2812          * @deprecated replaced by {@link #getSupportedPreviewFpsRange()}
2813          */
2814         @Deprecated
getSupportedPreviewFrameRates()2815         public List<Integer> getSupportedPreviewFrameRates() {
2816             String str = get(KEY_PREVIEW_FRAME_RATE + SUPPORTED_VALUES_SUFFIX);
2817             return splitInt(str);
2818         }
2819 
2820         /**
2821          * Sets the minimum and maximum preview fps. This controls the rate of
2822          * preview frames received in {@link PreviewCallback}. The minimum and
2823          * maximum preview fps must be one of the elements from {@link
2824          * #getSupportedPreviewFpsRange}.
2825          *
2826          * @param min the minimum preview fps (scaled by 1000).
2827          * @param max the maximum preview fps (scaled by 1000).
2828          * @throws RuntimeException if fps range is invalid.
2829          * @see #setPreviewCallbackWithBuffer(Camera.PreviewCallback)
2830          * @see #getSupportedPreviewFpsRange()
2831          */
setPreviewFpsRange(int min, int max)2832         public void setPreviewFpsRange(int min, int max) {
2833             set(KEY_PREVIEW_FPS_RANGE, "" + min + "," + max);
2834         }
2835 
2836         /**
2837          * Returns the current minimum and maximum preview fps. The values are
2838          * one of the elements returned by {@link #getSupportedPreviewFpsRange}.
2839          *
2840          * @return range the minimum and maximum preview fps (scaled by 1000).
2841          * @see #PREVIEW_FPS_MIN_INDEX
2842          * @see #PREVIEW_FPS_MAX_INDEX
2843          * @see #getSupportedPreviewFpsRange()
2844          */
getPreviewFpsRange(int[] range)2845         public void getPreviewFpsRange(int[] range) {
2846             if (range == null || range.length != 2) {
2847                 throw new IllegalArgumentException(
2848                         "range must be an array with two elements.");
2849             }
2850             splitInt(get(KEY_PREVIEW_FPS_RANGE), range);
2851         }
2852 
2853         /**
2854          * Gets the supported preview fps (frame-per-second) ranges. Each range
2855          * contains a minimum fps and maximum fps. If minimum fps equals to
2856          * maximum fps, the camera outputs frames in fixed frame rate. If not,
2857          * the camera outputs frames in auto frame rate. The actual frame rate
2858          * fluctuates between the minimum and the maximum. The values are
2859          * multiplied by 1000 and represented in integers. For example, if frame
2860          * rate is 26.623 frames per second, the value is 26623.
2861          *
2862          * @return a list of supported preview fps ranges. This method returns a
2863          *         list with at least one element. Every element is an int array
2864          *         of two values - minimum fps and maximum fps. The list is
2865          *         sorted from small to large (first by maximum fps and then
2866          *         minimum fps).
2867          * @see #PREVIEW_FPS_MIN_INDEX
2868          * @see #PREVIEW_FPS_MAX_INDEX
2869          */
getSupportedPreviewFpsRange()2870         public List<int[]> getSupportedPreviewFpsRange() {
2871             String str = get(KEY_PREVIEW_FPS_RANGE + SUPPORTED_VALUES_SUFFIX);
2872             return splitRange(str);
2873         }
2874 
2875         /**
2876          * Sets the image format for preview pictures.
2877          * <p>If this is never called, the default format will be
2878          * {@link android.graphics.ImageFormat#NV21}, which
2879          * uses the NV21 encoding format.</p>
2880          *
2881          * <p>Use {@link Parameters#getSupportedPreviewFormats} to get a list of
2882          * the available preview formats.
2883          *
2884          * <p>It is strongly recommended that either
2885          * {@link android.graphics.ImageFormat#NV21} or
2886          * {@link android.graphics.ImageFormat#YV12} is used, since
2887          * they are supported by all camera devices.</p>
2888          *
2889          * <p>For YV12, the image buffer that is received is not necessarily
2890          * tightly packed, as there may be padding at the end of each row of
2891          * pixel data, as described in
2892          * {@link android.graphics.ImageFormat#YV12}. For camera callback data,
2893          * it can be assumed that the stride of the Y and UV data is the
2894          * smallest possible that meets the alignment requirements. That is, if
2895          * the preview size is <var>width x height</var>, then the following
2896          * equations describe the buffer index for the beginning of row
2897          * <var>y</var> for the Y plane and row <var>c</var> for the U and V
2898          * planes:
2899          *
2900          * <pre>{@code
2901          * yStride   = (int) ceil(width / 16.0) * 16;
2902          * uvStride  = (int) ceil( (yStride / 2) / 16.0) * 16;
2903          * ySize     = yStride * height;
2904          * uvSize    = uvStride * height / 2;
2905          * yRowIndex = yStride * y;
2906          * uRowIndex = ySize + uvSize + uvStride * c;
2907          * vRowIndex = ySize + uvStride * c;
2908          * size      = ySize + uvSize * 2;
2909          * }
2910          *</pre>
2911          *
2912          * @param pixel_format the desired preview picture format, defined by
2913          *   one of the {@link android.graphics.ImageFormat} constants.  (E.g.,
2914          *   <var>ImageFormat.NV21</var> (default), or
2915          *   <var>ImageFormat.YV12</var>)
2916          *
2917          * @see android.graphics.ImageFormat
2918          * @see android.hardware.Camera.Parameters#getSupportedPreviewFormats
2919          */
setPreviewFormat(int pixel_format)2920         public void setPreviewFormat(int pixel_format) {
2921             String s = cameraFormatForPixelFormat(pixel_format);
2922             if (s == null) {
2923                 throw new IllegalArgumentException(
2924                         "Invalid pixel_format=" + pixel_format);
2925             }
2926 
2927             set(KEY_PREVIEW_FORMAT, s);
2928         }
2929 
2930         /**
2931          * Returns the image format for preview frames got from
2932          * {@link PreviewCallback}.
2933          *
2934          * @return the preview format.
2935          * @see android.graphics.ImageFormat
2936          * @see #setPreviewFormat
2937          */
getPreviewFormat()2938         public int getPreviewFormat() {
2939             return pixelFormatForCameraFormat(get(KEY_PREVIEW_FORMAT));
2940         }
2941 
2942         /**
2943          * Gets the supported preview formats. {@link android.graphics.ImageFormat#NV21}
2944          * is always supported. {@link android.graphics.ImageFormat#YV12}
2945          * is always supported since API level 12.
2946          *
2947          * @return a list of supported preview formats. This method will always
2948          *         return a list with at least one element.
2949          * @see android.graphics.ImageFormat
2950          * @see #setPreviewFormat
2951          */
getSupportedPreviewFormats()2952         public List<Integer> getSupportedPreviewFormats() {
2953             String str = get(KEY_PREVIEW_FORMAT + SUPPORTED_VALUES_SUFFIX);
2954             ArrayList<Integer> formats = new ArrayList<Integer>();
2955             for (String s : split(str)) {
2956                 int f = pixelFormatForCameraFormat(s);
2957                 if (f == ImageFormat.UNKNOWN) continue;
2958                 formats.add(f);
2959             }
2960             return formats;
2961         }
2962 
2963         /**
2964          * <p>Sets the dimensions for pictures.</p>
2965          *
2966          * <p>Applications need to consider the display orientation. See {@link
2967          * #setPreviewSize(int,int)} for reference.</p>
2968          *
2969          * @param width  the width for pictures, in pixels
2970          * @param height the height for pictures, in pixels
2971          * @see #setPreviewSize(int,int)
2972          *
2973          */
setPictureSize(int width, int height)2974         public void setPictureSize(int width, int height) {
2975             String v = Integer.toString(width) + "x" + Integer.toString(height);
2976             set(KEY_PICTURE_SIZE, v);
2977         }
2978 
2979         /**
2980          * Returns the dimension setting for pictures.
2981          *
2982          * @return a Size object with the height and width setting
2983          *          for pictures
2984          */
getPictureSize()2985         public Size getPictureSize() {
2986             String pair = get(KEY_PICTURE_SIZE);
2987             return strToSize(pair);
2988         }
2989 
2990         /**
2991          * Gets the supported picture sizes.
2992          *
2993          * @return a list of supported picture sizes. This method will always
2994          *         return a list with at least one element.
2995          */
getSupportedPictureSizes()2996         public List<Size> getSupportedPictureSizes() {
2997             String str = get(KEY_PICTURE_SIZE + SUPPORTED_VALUES_SUFFIX);
2998             return splitSize(str);
2999         }
3000 
3001         /**
3002          * Sets the image format for pictures.
3003          *
3004          * @param pixel_format the desired picture format
3005          *                     (<var>ImageFormat.NV21</var>,
3006          *                      <var>ImageFormat.RGB_565</var>, or
3007          *                      <var>ImageFormat.JPEG</var>)
3008          * @see android.graphics.ImageFormat
3009          */
setPictureFormat(int pixel_format)3010         public void setPictureFormat(int pixel_format) {
3011             String s = cameraFormatForPixelFormat(pixel_format);
3012             if (s == null) {
3013                 throw new IllegalArgumentException(
3014                         "Invalid pixel_format=" + pixel_format);
3015             }
3016 
3017             set(KEY_PICTURE_FORMAT, s);
3018         }
3019 
3020         /**
3021          * Returns the image format for pictures.
3022          *
3023          * @return the picture format
3024          * @see android.graphics.ImageFormat
3025          */
getPictureFormat()3026         public int getPictureFormat() {
3027             return pixelFormatForCameraFormat(get(KEY_PICTURE_FORMAT));
3028         }
3029 
3030         /**
3031          * Gets the supported picture formats.
3032          *
3033          * @return supported picture formats. This method will always return a
3034          *         list with at least one element.
3035          * @see android.graphics.ImageFormat
3036          */
getSupportedPictureFormats()3037         public List<Integer> getSupportedPictureFormats() {
3038             String str = get(KEY_PICTURE_FORMAT + SUPPORTED_VALUES_SUFFIX);
3039             ArrayList<Integer> formats = new ArrayList<Integer>();
3040             for (String s : split(str)) {
3041                 int f = pixelFormatForCameraFormat(s);
3042                 if (f == ImageFormat.UNKNOWN) continue;
3043                 formats.add(f);
3044             }
3045             return formats;
3046         }
3047 
cameraFormatForPixelFormat(int pixel_format)3048         private String cameraFormatForPixelFormat(int pixel_format) {
3049             switch(pixel_format) {
3050             case ImageFormat.NV16:      return PIXEL_FORMAT_YUV422SP;
3051             case ImageFormat.NV21:      return PIXEL_FORMAT_YUV420SP;
3052             case ImageFormat.YUY2:      return PIXEL_FORMAT_YUV422I;
3053             case ImageFormat.YV12:      return PIXEL_FORMAT_YUV420P;
3054             case ImageFormat.RGB_565:   return PIXEL_FORMAT_RGB565;
3055             case ImageFormat.JPEG:      return PIXEL_FORMAT_JPEG;
3056             default:                    return null;
3057             }
3058         }
3059 
pixelFormatForCameraFormat(String format)3060         private int pixelFormatForCameraFormat(String format) {
3061             if (format == null)
3062                 return ImageFormat.UNKNOWN;
3063 
3064             if (format.equals(PIXEL_FORMAT_YUV422SP))
3065                 return ImageFormat.NV16;
3066 
3067             if (format.equals(PIXEL_FORMAT_YUV420SP))
3068                 return ImageFormat.NV21;
3069 
3070             if (format.equals(PIXEL_FORMAT_YUV422I))
3071                 return ImageFormat.YUY2;
3072 
3073             if (format.equals(PIXEL_FORMAT_YUV420P))
3074                 return ImageFormat.YV12;
3075 
3076             if (format.equals(PIXEL_FORMAT_RGB565))
3077                 return ImageFormat.RGB_565;
3078 
3079             if (format.equals(PIXEL_FORMAT_JPEG))
3080                 return ImageFormat.JPEG;
3081 
3082             return ImageFormat.UNKNOWN;
3083         }
3084 
3085         /**
3086          * Sets the clockwise rotation angle in degrees relative to the
3087          * orientation of the camera. This affects the pictures returned from
3088          * JPEG {@link PictureCallback}. The camera driver may set orientation
3089          * in the EXIF header without rotating the picture. Or the driver may
3090          * rotate the picture and the EXIF thumbnail. If the Jpeg picture is
3091          * rotated, the orientation in the EXIF header will be missing or 1 (row
3092          * #0 is top and column #0 is left side).
3093          *
3094          * <p>
3095          * If applications want to rotate the picture to match the orientation
3096          * of what users see, apps should use
3097          * {@link android.view.OrientationEventListener} and
3098          * {@link android.hardware.Camera.CameraInfo}. The value from
3099          * OrientationEventListener is relative to the natural orientation of
3100          * the device. CameraInfo.orientation is the angle between camera
3101          * orientation and natural device orientation. The sum of the two is the
3102          * rotation angle for back-facing camera. The difference of the two is
3103          * the rotation angle for front-facing camera. Note that the JPEG
3104          * pictures of front-facing cameras are not mirrored as in preview
3105          * display.
3106          *
3107          * <p>
3108          * For example, suppose the natural orientation of the device is
3109          * portrait. The device is rotated 270 degrees clockwise, so the device
3110          * orientation is 270. Suppose a back-facing camera sensor is mounted in
3111          * landscape and the top side of the camera sensor is aligned with the
3112          * right edge of the display in natural orientation. So the camera
3113          * orientation is 90. The rotation should be set to 0 (270 + 90).
3114          *
3115          * <p>The reference code is as follows.
3116          *
3117          * <pre>
3118          * public void onOrientationChanged(int orientation) {
3119          *     if (orientation == ORIENTATION_UNKNOWN) return;
3120          *     android.hardware.Camera.CameraInfo info =
3121          *            new android.hardware.Camera.CameraInfo();
3122          *     android.hardware.Camera.getCameraInfo(cameraId, info);
3123          *     orientation = (orientation + 45) / 90 * 90;
3124          *     int rotation = 0;
3125          *     if (info.facing == CameraInfo.CAMERA_FACING_FRONT) {
3126          *         rotation = (info.orientation - orientation + 360) % 360;
3127          *     } else {  // back-facing camera
3128          *         rotation = (info.orientation + orientation) % 360;
3129          *     }
3130          *     mParameters.setRotation(rotation);
3131          * }
3132          * </pre>
3133          *
3134          * @param rotation The rotation angle in degrees relative to the
3135          *                 orientation of the camera. Rotation can only be 0,
3136          *                 90, 180 or 270.
3137          * @throws IllegalArgumentException if rotation value is invalid.
3138          * @see android.view.OrientationEventListener
3139          * @see #getCameraInfo(int, CameraInfo)
3140          */
setRotation(int rotation)3141         public void setRotation(int rotation) {
3142             if (rotation == 0 || rotation == 90 || rotation == 180
3143                     || rotation == 270) {
3144                 set(KEY_ROTATION, Integer.toString(rotation));
3145             } else {
3146                 throw new IllegalArgumentException(
3147                         "Invalid rotation=" + rotation);
3148             }
3149         }
3150 
3151         /**
3152          * Sets GPS latitude coordinate. This will be stored in JPEG EXIF
3153          * header.
3154          *
3155          * @param latitude GPS latitude coordinate.
3156          */
setGpsLatitude(double latitude)3157         public void setGpsLatitude(double latitude) {
3158             set(KEY_GPS_LATITUDE, Double.toString(latitude));
3159         }
3160 
3161         /**
3162          * Sets GPS longitude coordinate. This will be stored in JPEG EXIF
3163          * header.
3164          *
3165          * @param longitude GPS longitude coordinate.
3166          */
setGpsLongitude(double longitude)3167         public void setGpsLongitude(double longitude) {
3168             set(KEY_GPS_LONGITUDE, Double.toString(longitude));
3169         }
3170 
3171         /**
3172          * Sets GPS altitude. This will be stored in JPEG EXIF header.
3173          *
3174          * @param altitude GPS altitude in meters.
3175          */
setGpsAltitude(double altitude)3176         public void setGpsAltitude(double altitude) {
3177             set(KEY_GPS_ALTITUDE, Double.toString(altitude));
3178         }
3179 
3180         /**
3181          * Sets GPS timestamp. This will be stored in JPEG EXIF header.
3182          *
3183          * @param timestamp GPS timestamp (UTC in seconds since January 1,
3184          *                  1970).
3185          */
setGpsTimestamp(long timestamp)3186         public void setGpsTimestamp(long timestamp) {
3187             set(KEY_GPS_TIMESTAMP, Long.toString(timestamp));
3188         }
3189 
3190         /**
3191          * Sets GPS processing method. The method will be stored in a UTF-8 string up to 31 bytes
3192          * long, in the JPEG EXIF header.
3193          *
3194          * @param processing_method The processing method to get this location.
3195          */
setGpsProcessingMethod(String processing_method)3196         public void setGpsProcessingMethod(String processing_method) {
3197             set(KEY_GPS_PROCESSING_METHOD, processing_method);
3198         }
3199 
3200         /**
3201          * Removes GPS latitude, longitude, altitude, and timestamp from the
3202          * parameters.
3203          */
removeGpsData()3204         public void removeGpsData() {
3205             remove(KEY_GPS_LATITUDE);
3206             remove(KEY_GPS_LONGITUDE);
3207             remove(KEY_GPS_ALTITUDE);
3208             remove(KEY_GPS_TIMESTAMP);
3209             remove(KEY_GPS_PROCESSING_METHOD);
3210         }
3211 
3212         /**
3213          * Gets the current white balance setting.
3214          *
3215          * @return current white balance. null if white balance setting is not
3216          *         supported.
3217          * @see #WHITE_BALANCE_AUTO
3218          * @see #WHITE_BALANCE_INCANDESCENT
3219          * @see #WHITE_BALANCE_FLUORESCENT
3220          * @see #WHITE_BALANCE_WARM_FLUORESCENT
3221          * @see #WHITE_BALANCE_DAYLIGHT
3222          * @see #WHITE_BALANCE_CLOUDY_DAYLIGHT
3223          * @see #WHITE_BALANCE_TWILIGHT
3224          * @see #WHITE_BALANCE_SHADE
3225          *
3226          */
getWhiteBalance()3227         public String getWhiteBalance() {
3228             return get(KEY_WHITE_BALANCE);
3229         }
3230 
3231         /**
3232          * Sets the white balance. Changing the setting will release the
3233          * auto-white balance lock. It is recommended not to change white
3234          * balance and AWB lock at the same time.
3235          *
3236          * @param value new white balance.
3237          * @see #getWhiteBalance()
3238          * @see #setAutoWhiteBalanceLock(boolean)
3239          */
setWhiteBalance(String value)3240         public void setWhiteBalance(String value) {
3241             String oldValue = get(KEY_WHITE_BALANCE);
3242             if (same(value, oldValue)) return;
3243             set(KEY_WHITE_BALANCE, value);
3244             set(KEY_AUTO_WHITEBALANCE_LOCK, FALSE);
3245         }
3246 
3247         /**
3248          * Gets the supported white balance.
3249          *
3250          * @return a list of supported white balance. null if white balance
3251          *         setting is not supported.
3252          * @see #getWhiteBalance()
3253          */
getSupportedWhiteBalance()3254         public List<String> getSupportedWhiteBalance() {
3255             String str = get(KEY_WHITE_BALANCE + SUPPORTED_VALUES_SUFFIX);
3256             return split(str);
3257         }
3258 
3259         /**
3260          * Gets the current color effect setting.
3261          *
3262          * @return current color effect. null if color effect
3263          *         setting is not supported.
3264          * @see #EFFECT_NONE
3265          * @see #EFFECT_MONO
3266          * @see #EFFECT_NEGATIVE
3267          * @see #EFFECT_SOLARIZE
3268          * @see #EFFECT_SEPIA
3269          * @see #EFFECT_POSTERIZE
3270          * @see #EFFECT_WHITEBOARD
3271          * @see #EFFECT_BLACKBOARD
3272          * @see #EFFECT_AQUA
3273          */
getColorEffect()3274         public String getColorEffect() {
3275             return get(KEY_EFFECT);
3276         }
3277 
3278         /**
3279          * Sets the current color effect setting.
3280          *
3281          * @param value new color effect.
3282          * @see #getColorEffect()
3283          */
setColorEffect(String value)3284         public void setColorEffect(String value) {
3285             set(KEY_EFFECT, value);
3286         }
3287 
3288         /**
3289          * Gets the supported color effects.
3290          *
3291          * @return a list of supported color effects. null if color effect
3292          *         setting is not supported.
3293          * @see #getColorEffect()
3294          */
getSupportedColorEffects()3295         public List<String> getSupportedColorEffects() {
3296             String str = get(KEY_EFFECT + SUPPORTED_VALUES_SUFFIX);
3297             return split(str);
3298         }
3299 
3300 
3301         /**
3302          * Gets the current antibanding setting.
3303          *
3304          * @return current antibanding. null if antibanding setting is not
3305          *         supported.
3306          * @see #ANTIBANDING_AUTO
3307          * @see #ANTIBANDING_50HZ
3308          * @see #ANTIBANDING_60HZ
3309          * @see #ANTIBANDING_OFF
3310          */
getAntibanding()3311         public String getAntibanding() {
3312             return get(KEY_ANTIBANDING);
3313         }
3314 
3315         /**
3316          * Sets the antibanding.
3317          *
3318          * @param antibanding new antibanding value.
3319          * @see #getAntibanding()
3320          */
setAntibanding(String antibanding)3321         public void setAntibanding(String antibanding) {
3322             set(KEY_ANTIBANDING, antibanding);
3323         }
3324 
3325         /**
3326          * Gets the supported antibanding values.
3327          *
3328          * @return a list of supported antibanding values. null if antibanding
3329          *         setting is not supported.
3330          * @see #getAntibanding()
3331          */
getSupportedAntibanding()3332         public List<String> getSupportedAntibanding() {
3333             String str = get(KEY_ANTIBANDING + SUPPORTED_VALUES_SUFFIX);
3334             return split(str);
3335         }
3336 
3337         /**
3338          * Gets the current scene mode setting.
3339          *
3340          * @return one of SCENE_MODE_XXX string constant. null if scene mode
3341          *         setting is not supported.
3342          * @see #SCENE_MODE_AUTO
3343          * @see #SCENE_MODE_ACTION
3344          * @see #SCENE_MODE_PORTRAIT
3345          * @see #SCENE_MODE_LANDSCAPE
3346          * @see #SCENE_MODE_NIGHT
3347          * @see #SCENE_MODE_NIGHT_PORTRAIT
3348          * @see #SCENE_MODE_THEATRE
3349          * @see #SCENE_MODE_BEACH
3350          * @see #SCENE_MODE_SNOW
3351          * @see #SCENE_MODE_SUNSET
3352          * @see #SCENE_MODE_STEADYPHOTO
3353          * @see #SCENE_MODE_FIREWORKS
3354          * @see #SCENE_MODE_SPORTS
3355          * @see #SCENE_MODE_PARTY
3356          * @see #SCENE_MODE_CANDLELIGHT
3357          * @see #SCENE_MODE_BARCODE
3358          */
getSceneMode()3359         public String getSceneMode() {
3360             return get(KEY_SCENE_MODE);
3361         }
3362 
3363         /**
3364          * Sets the scene mode. Changing scene mode may override other
3365          * parameters (such as flash mode, focus mode, white balance). For
3366          * example, suppose originally flash mode is on and supported flash
3367          * modes are on/off. In night scene mode, both flash mode and supported
3368          * flash mode may be changed to off. After setting scene mode,
3369          * applications should call getParameters to know if some parameters are
3370          * changed.
3371          *
3372          * @param value scene mode.
3373          * @see #getSceneMode()
3374          */
setSceneMode(String value)3375         public void setSceneMode(String value) {
3376             set(KEY_SCENE_MODE, value);
3377         }
3378 
3379         /**
3380          * Gets the supported scene modes.
3381          *
3382          * @return a list of supported scene modes. null if scene mode setting
3383          *         is not supported.
3384          * @see #getSceneMode()
3385          */
getSupportedSceneModes()3386         public List<String> getSupportedSceneModes() {
3387             String str = get(KEY_SCENE_MODE + SUPPORTED_VALUES_SUFFIX);
3388             return split(str);
3389         }
3390 
3391         /**
3392          * Gets the current flash mode setting.
3393          *
3394          * @return current flash mode. null if flash mode setting is not
3395          *         supported.
3396          * @see #FLASH_MODE_OFF
3397          * @see #FLASH_MODE_AUTO
3398          * @see #FLASH_MODE_ON
3399          * @see #FLASH_MODE_RED_EYE
3400          * @see #FLASH_MODE_TORCH
3401          */
getFlashMode()3402         public String getFlashMode() {
3403             return get(KEY_FLASH_MODE);
3404         }
3405 
3406         /**
3407          * Sets the flash mode.
3408          *
3409          * @param value flash mode.
3410          * @see #getFlashMode()
3411          */
setFlashMode(String value)3412         public void setFlashMode(String value) {
3413             set(KEY_FLASH_MODE, value);
3414         }
3415 
3416         /**
3417          * Gets the supported flash modes.
3418          *
3419          * @return a list of supported flash modes. null if flash mode setting
3420          *         is not supported.
3421          * @see #getFlashMode()
3422          */
getSupportedFlashModes()3423         public List<String> getSupportedFlashModes() {
3424             String str = get(KEY_FLASH_MODE + SUPPORTED_VALUES_SUFFIX);
3425             return split(str);
3426         }
3427 
3428         /**
3429          * Gets the current focus mode setting.
3430          *
3431          * @return current focus mode. This method will always return a non-null
3432          *         value. Applications should call {@link
3433          *         #autoFocus(AutoFocusCallback)} to start the focus if focus
3434          *         mode is FOCUS_MODE_AUTO or FOCUS_MODE_MACRO.
3435          * @see #FOCUS_MODE_AUTO
3436          * @see #FOCUS_MODE_INFINITY
3437          * @see #FOCUS_MODE_MACRO
3438          * @see #FOCUS_MODE_FIXED
3439          * @see #FOCUS_MODE_EDOF
3440          * @see #FOCUS_MODE_CONTINUOUS_VIDEO
3441          */
getFocusMode()3442         public String getFocusMode() {
3443             return get(KEY_FOCUS_MODE);
3444         }
3445 
3446         /**
3447          * Sets the focus mode.
3448          *
3449          * @param value focus mode.
3450          * @see #getFocusMode()
3451          */
setFocusMode(String value)3452         public void setFocusMode(String value) {
3453             set(KEY_FOCUS_MODE, value);
3454         }
3455 
3456         /**
3457          * Gets the supported focus modes.
3458          *
3459          * @return a list of supported focus modes. This method will always
3460          *         return a list with at least one element.
3461          * @see #getFocusMode()
3462          */
getSupportedFocusModes()3463         public List<String> getSupportedFocusModes() {
3464             String str = get(KEY_FOCUS_MODE + SUPPORTED_VALUES_SUFFIX);
3465             return split(str);
3466         }
3467 
3468         /**
3469          * Gets the focal length (in millimeter) of the camera.
3470          *
3471          * @return the focal length. This method will always return a valid
3472          *         value.
3473          */
getFocalLength()3474         public float getFocalLength() {
3475             return Float.parseFloat(get(KEY_FOCAL_LENGTH));
3476         }
3477 
3478         /**
3479          * Gets the horizontal angle of view in degrees.
3480          *
3481          * @return horizontal angle of view. This method will always return a
3482          *         valid value.
3483          */
getHorizontalViewAngle()3484         public float getHorizontalViewAngle() {
3485             return Float.parseFloat(get(KEY_HORIZONTAL_VIEW_ANGLE));
3486         }
3487 
3488         /**
3489          * Gets the vertical angle of view in degrees.
3490          *
3491          * @return vertical angle of view. This method will always return a
3492          *         valid value.
3493          */
getVerticalViewAngle()3494         public float getVerticalViewAngle() {
3495             return Float.parseFloat(get(KEY_VERTICAL_VIEW_ANGLE));
3496         }
3497 
3498         /**
3499          * Gets the current exposure compensation index.
3500          *
3501          * @return current exposure compensation index. The range is {@link
3502          *         #getMinExposureCompensation} to {@link
3503          *         #getMaxExposureCompensation}. 0 means exposure is not
3504          *         adjusted.
3505          */
getExposureCompensation()3506         public int getExposureCompensation() {
3507             return getInt(KEY_EXPOSURE_COMPENSATION, 0);
3508         }
3509 
3510         /**
3511          * Sets the exposure compensation index.
3512          *
3513          * @param value exposure compensation index. The valid value range is
3514          *        from {@link #getMinExposureCompensation} (inclusive) to {@link
3515          *        #getMaxExposureCompensation} (inclusive). 0 means exposure is
3516          *        not adjusted. Application should call
3517          *        getMinExposureCompensation and getMaxExposureCompensation to
3518          *        know if exposure compensation is supported.
3519          */
setExposureCompensation(int value)3520         public void setExposureCompensation(int value) {
3521             set(KEY_EXPOSURE_COMPENSATION, value);
3522         }
3523 
3524         /**
3525          * Gets the maximum exposure compensation index.
3526          *
3527          * @return maximum exposure compensation index (>=0). If both this
3528          *         method and {@link #getMinExposureCompensation} return 0,
3529          *         exposure compensation is not supported.
3530          */
getMaxExposureCompensation()3531         public int getMaxExposureCompensation() {
3532             return getInt(KEY_MAX_EXPOSURE_COMPENSATION, 0);
3533         }
3534 
3535         /**
3536          * Gets the minimum exposure compensation index.
3537          *
3538          * @return minimum exposure compensation index (<=0). If both this
3539          *         method and {@link #getMaxExposureCompensation} return 0,
3540          *         exposure compensation is not supported.
3541          */
getMinExposureCompensation()3542         public int getMinExposureCompensation() {
3543             return getInt(KEY_MIN_EXPOSURE_COMPENSATION, 0);
3544         }
3545 
3546         /**
3547          * Gets the exposure compensation step.
3548          *
3549          * @return exposure compensation step. Applications can get EV by
3550          *         multiplying the exposure compensation index and step. Ex: if
3551          *         exposure compensation index is -6 and step is 0.333333333, EV
3552          *         is -2.
3553          */
getExposureCompensationStep()3554         public float getExposureCompensationStep() {
3555             return getFloat(KEY_EXPOSURE_COMPENSATION_STEP, 0);
3556         }
3557 
3558         /**
3559          * <p>Sets the auto-exposure lock state. Applications should check
3560          * {@link #isAutoExposureLockSupported} before using this method.</p>
3561          *
3562          * <p>If set to true, the camera auto-exposure routine will immediately
3563          * pause until the lock is set to false. Exposure compensation settings
3564          * changes will still take effect while auto-exposure is locked.</p>
3565          *
3566          * <p>If auto-exposure is already locked, setting this to true again has
3567          * no effect (the driver will not recalculate exposure values).</p>
3568          *
3569          * <p>Stopping preview with {@link #stopPreview()}, or triggering still
3570          * image capture with {@link #takePicture(Camera.ShutterCallback,
3571          * Camera.PictureCallback, Camera.PictureCallback)}, will not change the
3572          * lock.</p>
3573          *
3574          * <p>Exposure compensation, auto-exposure lock, and auto-white balance
3575          * lock can be used to capture an exposure-bracketed burst of images,
3576          * for example.</p>
3577          *
3578          * <p>Auto-exposure state, including the lock state, will not be
3579          * maintained after camera {@link #release()} is called.  Locking
3580          * auto-exposure after {@link #open()} but before the first call to
3581          * {@link #startPreview()} will not allow the auto-exposure routine to
3582          * run at all, and may result in severely over- or under-exposed
3583          * images.</p>
3584          *
3585          * @param toggle new state of the auto-exposure lock. True means that
3586          *        auto-exposure is locked, false means that the auto-exposure
3587          *        routine is free to run normally.
3588          *
3589          * @see #getAutoExposureLock()
3590          */
setAutoExposureLock(boolean toggle)3591         public void setAutoExposureLock(boolean toggle) {
3592             set(KEY_AUTO_EXPOSURE_LOCK, toggle ? TRUE : FALSE);
3593         }
3594 
3595         /**
3596          * Gets the state of the auto-exposure lock. Applications should check
3597          * {@link #isAutoExposureLockSupported} before using this method. See
3598          * {@link #setAutoExposureLock} for details about the lock.
3599          *
3600          * @return State of the auto-exposure lock. Returns true if
3601          *         auto-exposure is currently locked, and false otherwise.
3602          *
3603          * @see #setAutoExposureLock(boolean)
3604          *
3605          */
getAutoExposureLock()3606         public boolean getAutoExposureLock() {
3607             String str = get(KEY_AUTO_EXPOSURE_LOCK);
3608             return TRUE.equals(str);
3609         }
3610 
3611         /**
3612          * Returns true if auto-exposure locking is supported. Applications
3613          * should call this before trying to lock auto-exposure. See
3614          * {@link #setAutoExposureLock} for details about the lock.
3615          *
3616          * @return true if auto-exposure lock is supported.
3617          * @see #setAutoExposureLock(boolean)
3618          *
3619          */
isAutoExposureLockSupported()3620         public boolean isAutoExposureLockSupported() {
3621             String str = get(KEY_AUTO_EXPOSURE_LOCK_SUPPORTED);
3622             return TRUE.equals(str);
3623         }
3624 
3625         /**
3626          * <p>Sets the auto-white balance lock state. Applications should check
3627          * {@link #isAutoWhiteBalanceLockSupported} before using this
3628          * method.</p>
3629          *
3630          * <p>If set to true, the camera auto-white balance routine will
3631          * immediately pause until the lock is set to false.</p>
3632          *
3633          * <p>If auto-white balance is already locked, setting this to true
3634          * again has no effect (the driver will not recalculate white balance
3635          * values).</p>
3636          *
3637          * <p>Stopping preview with {@link #stopPreview()}, or triggering still
3638          * image capture with {@link #takePicture(Camera.ShutterCallback,
3639          * Camera.PictureCallback, Camera.PictureCallback)}, will not change the
3640          * the lock.</p>
3641          *
3642          * <p> Changing the white balance mode with {@link #setWhiteBalance}
3643          * will release the auto-white balance lock if it is set.</p>
3644          *
3645          * <p>Exposure compensation, AE lock, and AWB lock can be used to
3646          * capture an exposure-bracketed burst of images, for example.
3647          * Auto-white balance state, including the lock state, will not be
3648          * maintained after camera {@link #release()} is called.  Locking
3649          * auto-white balance after {@link #open()} but before the first call to
3650          * {@link #startPreview()} will not allow the auto-white balance routine
3651          * to run at all, and may result in severely incorrect color in captured
3652          * images.</p>
3653          *
3654          * @param toggle new state of the auto-white balance lock. True means
3655          *        that auto-white balance is locked, false means that the
3656          *        auto-white balance routine is free to run normally.
3657          *
3658          * @see #getAutoWhiteBalanceLock()
3659          * @see #setWhiteBalance(String)
3660          */
setAutoWhiteBalanceLock(boolean toggle)3661         public void setAutoWhiteBalanceLock(boolean toggle) {
3662             set(KEY_AUTO_WHITEBALANCE_LOCK, toggle ? TRUE : FALSE);
3663         }
3664 
3665         /**
3666          * Gets the state of the auto-white balance lock. Applications should
3667          * check {@link #isAutoWhiteBalanceLockSupported} before using this
3668          * method. See {@link #setAutoWhiteBalanceLock} for details about the
3669          * lock.
3670          *
3671          * @return State of the auto-white balance lock. Returns true if
3672          *         auto-white balance is currently locked, and false
3673          *         otherwise.
3674          *
3675          * @see #setAutoWhiteBalanceLock(boolean)
3676          *
3677          */
getAutoWhiteBalanceLock()3678         public boolean getAutoWhiteBalanceLock() {
3679             String str = get(KEY_AUTO_WHITEBALANCE_LOCK);
3680             return TRUE.equals(str);
3681         }
3682 
3683         /**
3684          * Returns true if auto-white balance locking is supported. Applications
3685          * should call this before trying to lock auto-white balance. See
3686          * {@link #setAutoWhiteBalanceLock} for details about the lock.
3687          *
3688          * @return true if auto-white balance lock is supported.
3689          * @see #setAutoWhiteBalanceLock(boolean)
3690          *
3691          */
isAutoWhiteBalanceLockSupported()3692         public boolean isAutoWhiteBalanceLockSupported() {
3693             String str = get(KEY_AUTO_WHITEBALANCE_LOCK_SUPPORTED);
3694             return TRUE.equals(str);
3695         }
3696 
3697         /**
3698          * Gets current zoom value. This also works when smooth zoom is in
3699          * progress. Applications should check {@link #isZoomSupported} before
3700          * using this method.
3701          *
3702          * @return the current zoom value. The range is 0 to {@link
3703          *         #getMaxZoom}. 0 means the camera is not zoomed.
3704          */
getZoom()3705         public int getZoom() {
3706             return getInt(KEY_ZOOM, 0);
3707         }
3708 
3709         /**
3710          * Sets current zoom value. If the camera is zoomed (value > 0), the
3711          * actual picture size may be smaller than picture size setting.
3712          * Applications can check the actual picture size after picture is
3713          * returned from {@link PictureCallback}. The preview size remains the
3714          * same in zoom. Applications should check {@link #isZoomSupported}
3715          * before using this method.
3716          *
3717          * @param value zoom value. The valid range is 0 to {@link #getMaxZoom}.
3718          */
setZoom(int value)3719         public void setZoom(int value) {
3720             set(KEY_ZOOM, value);
3721         }
3722 
3723         /**
3724          * Returns true if zoom is supported. Applications should call this
3725          * before using other zoom methods.
3726          *
3727          * @return true if zoom is supported.
3728          */
isZoomSupported()3729         public boolean isZoomSupported() {
3730             String str = get(KEY_ZOOM_SUPPORTED);
3731             return TRUE.equals(str);
3732         }
3733 
3734         /**
3735          * Gets the maximum zoom value allowed for snapshot. This is the maximum
3736          * value that applications can set to {@link #setZoom(int)}.
3737          * Applications should call {@link #isZoomSupported} before using this
3738          * method. This value may change in different preview size. Applications
3739          * should call this again after setting preview size.
3740          *
3741          * @return the maximum zoom value supported by the camera.
3742          */
getMaxZoom()3743         public int getMaxZoom() {
3744             return getInt(KEY_MAX_ZOOM, 0);
3745         }
3746 
3747         /**
3748          * Gets the zoom ratios of all zoom values. Applications should check
3749          * {@link #isZoomSupported} before using this method.
3750          *
3751          * @return the zoom ratios in 1/100 increments. Ex: a zoom of 3.2x is
3752          *         returned as 320. The number of elements is {@link
3753          *         #getMaxZoom} + 1. The list is sorted from small to large. The
3754          *         first element is always 100. The last element is the zoom
3755          *         ratio of the maximum zoom value.
3756          */
getZoomRatios()3757         public List<Integer> getZoomRatios() {
3758             return splitInt(get(KEY_ZOOM_RATIOS));
3759         }
3760 
3761         /**
3762          * Returns true if smooth zoom is supported. Applications should call
3763          * this before using other smooth zoom methods.
3764          *
3765          * @return true if smooth zoom is supported.
3766          */
isSmoothZoomSupported()3767         public boolean isSmoothZoomSupported() {
3768             String str = get(KEY_SMOOTH_ZOOM_SUPPORTED);
3769             return TRUE.equals(str);
3770         }
3771 
3772         /**
3773          * <p>Gets the distances from the camera to where an object appears to be
3774          * in focus. The object is sharpest at the optimal focus distance. The
3775          * depth of field is the far focus distance minus near focus distance.</p>
3776          *
3777          * <p>Focus distances may change after calling {@link
3778          * #autoFocus(AutoFocusCallback)}, {@link #cancelAutoFocus}, or {@link
3779          * #startPreview()}. Applications can call {@link #getParameters()}
3780          * and this method anytime to get the latest focus distances. If the
3781          * focus mode is FOCUS_MODE_CONTINUOUS_VIDEO, focus distances may change
3782          * from time to time.</p>
3783          *
3784          * <p>This method is intended to estimate the distance between the camera
3785          * and the subject. After autofocus, the subject distance may be within
3786          * near and far focus distance. However, the precision depends on the
3787          * camera hardware, autofocus algorithm, the focus area, and the scene.
3788          * The error can be large and it should be only used as a reference.</p>
3789          *
3790          * <p>Far focus distance >= optimal focus distance >= near focus distance.
3791          * If the focus distance is infinity, the value will be
3792          * {@code Float.POSITIVE_INFINITY}.</p>
3793          *
3794          * @param output focus distances in meters. output must be a float
3795          *        array with three elements. Near focus distance, optimal focus
3796          *        distance, and far focus distance will be filled in the array.
3797          * @see #FOCUS_DISTANCE_NEAR_INDEX
3798          * @see #FOCUS_DISTANCE_OPTIMAL_INDEX
3799          * @see #FOCUS_DISTANCE_FAR_INDEX
3800          */
getFocusDistances(float[] output)3801         public void getFocusDistances(float[] output) {
3802             if (output == null || output.length != 3) {
3803                 throw new IllegalArgumentException(
3804                         "output must be a float array with three elements.");
3805             }
3806             splitFloat(get(KEY_FOCUS_DISTANCES), output);
3807         }
3808 
3809         /**
3810          * Gets the maximum number of focus areas supported. This is the maximum
3811          * length of the list in {@link #setFocusAreas(List)} and
3812          * {@link #getFocusAreas()}.
3813          *
3814          * @return the maximum number of focus areas supported by the camera.
3815          * @see #getFocusAreas()
3816          */
getMaxNumFocusAreas()3817         public int getMaxNumFocusAreas() {
3818             return getInt(KEY_MAX_NUM_FOCUS_AREAS, 0);
3819         }
3820 
3821         /**
3822          * <p>Gets the current focus areas. Camera driver uses the areas to decide
3823          * focus.</p>
3824          *
3825          * <p>Before using this API or {@link #setFocusAreas(List)}, apps should
3826          * call {@link #getMaxNumFocusAreas()} to know the maximum number of
3827          * focus areas first. If the value is 0, focus area is not supported.</p>
3828          *
3829          * <p>Each focus area is a rectangle with specified weight. The direction
3830          * is relative to the sensor orientation, that is, what the sensor sees.
3831          * The direction is not affected by the rotation or mirroring of
3832          * {@link #setDisplayOrientation(int)}. Coordinates of the rectangle
3833          * range from -1000 to 1000. (-1000, -1000) is the upper left point.
3834          * (1000, 1000) is the lower right point. The width and height of focus
3835          * areas cannot be 0 or negative.</p>
3836          *
3837          * <p>The weight must range from 1 to 1000. The weight should be
3838          * interpreted as a per-pixel weight - all pixels in the area have the
3839          * specified weight. This means a small area with the same weight as a
3840          * larger area will have less influence on the focusing than the larger
3841          * area. Focus areas can partially overlap and the driver will add the
3842          * weights in the overlap region.</p>
3843          *
3844          * <p>A special case of a {@code null} focus area list means the driver is
3845          * free to select focus targets as it wants. For example, the driver may
3846          * use more signals to select focus areas and change them
3847          * dynamically. Apps can set the focus area list to {@code null} if they
3848          * want the driver to completely control focusing.</p>
3849          *
3850          * <p>Focus areas are relative to the current field of view
3851          * ({@link #getZoom()}). No matter what the zoom level is, (-1000,-1000)
3852          * represents the top of the currently visible camera frame. The focus
3853          * area cannot be set to be outside the current field of view, even
3854          * when using zoom.</p>
3855          *
3856          * <p>Focus area only has effect if the current focus mode is
3857          * {@link #FOCUS_MODE_AUTO}, {@link #FOCUS_MODE_MACRO},
3858          * {@link #FOCUS_MODE_CONTINUOUS_VIDEO}, or
3859          * {@link #FOCUS_MODE_CONTINUOUS_PICTURE}.</p>
3860          *
3861          * @return a list of current focus areas
3862          */
getFocusAreas()3863         public List<Area> getFocusAreas() {
3864             return splitArea(get(KEY_FOCUS_AREAS));
3865         }
3866 
3867         /**
3868          * Sets focus areas. See {@link #getFocusAreas()} for documentation.
3869          *
3870          * @param focusAreas the focus areas
3871          * @see #getFocusAreas()
3872          */
setFocusAreas(List<Area> focusAreas)3873         public void setFocusAreas(List<Area> focusAreas) {
3874             set(KEY_FOCUS_AREAS, focusAreas);
3875         }
3876 
3877         /**
3878          * Gets the maximum number of metering areas supported. This is the
3879          * maximum length of the list in {@link #setMeteringAreas(List)} and
3880          * {@link #getMeteringAreas()}.
3881          *
3882          * @return the maximum number of metering areas supported by the camera.
3883          * @see #getMeteringAreas()
3884          */
getMaxNumMeteringAreas()3885         public int getMaxNumMeteringAreas() {
3886             return getInt(KEY_MAX_NUM_METERING_AREAS, 0);
3887         }
3888 
3889         /**
3890          * <p>Gets the current metering areas. Camera driver uses these areas to
3891          * decide exposure.</p>
3892          *
3893          * <p>Before using this API or {@link #setMeteringAreas(List)}, apps should
3894          * call {@link #getMaxNumMeteringAreas()} to know the maximum number of
3895          * metering areas first. If the value is 0, metering area is not
3896          * supported.</p>
3897          *
3898          * <p>Each metering area is a rectangle with specified weight. The
3899          * direction is relative to the sensor orientation, that is, what the
3900          * sensor sees. The direction is not affected by the rotation or
3901          * mirroring of {@link #setDisplayOrientation(int)}. Coordinates of the
3902          * rectangle range from -1000 to 1000. (-1000, -1000) is the upper left
3903          * point. (1000, 1000) is the lower right point. The width and height of
3904          * metering areas cannot be 0 or negative.</p>
3905          *
3906          * <p>The weight must range from 1 to 1000, and represents a weight for
3907          * every pixel in the area. This means that a large metering area with
3908          * the same weight as a smaller area will have more effect in the
3909          * metering result.  Metering areas can partially overlap and the driver
3910          * will add the weights in the overlap region.</p>
3911          *
3912          * <p>A special case of a {@code null} metering area list means the driver
3913          * is free to meter as it chooses. For example, the driver may use more
3914          * signals to select metering areas and change them dynamically. Apps
3915          * can set the metering area list to {@code null} if they want the
3916          * driver to completely control metering.</p>
3917          *
3918          * <p>Metering areas are relative to the current field of view
3919          * ({@link #getZoom()}). No matter what the zoom level is, (-1000,-1000)
3920          * represents the top of the currently visible camera frame. The
3921          * metering area cannot be set to be outside the current field of view,
3922          * even when using zoom.</p>
3923          *
3924          * <p>No matter what metering areas are, the final exposure are compensated
3925          * by {@link #setExposureCompensation(int)}.</p>
3926          *
3927          * @return a list of current metering areas
3928          */
getMeteringAreas()3929         public List<Area> getMeteringAreas() {
3930             return splitArea(get(KEY_METERING_AREAS));
3931         }
3932 
3933         /**
3934          * Sets metering areas. See {@link #getMeteringAreas()} for
3935          * documentation.
3936          *
3937          * @param meteringAreas the metering areas
3938          * @see #getMeteringAreas()
3939          */
setMeteringAreas(List<Area> meteringAreas)3940         public void setMeteringAreas(List<Area> meteringAreas) {
3941             set(KEY_METERING_AREAS, meteringAreas);
3942         }
3943 
3944         /**
3945          * Gets the maximum number of detected faces supported. This is the
3946          * maximum length of the list returned from {@link FaceDetectionListener}.
3947          * If the return value is 0, face detection of the specified type is not
3948          * supported.
3949          *
3950          * @return the maximum number of detected face supported by the camera.
3951          * @see #startFaceDetection()
3952          */
getMaxNumDetectedFaces()3953         public int getMaxNumDetectedFaces() {
3954             return getInt(KEY_MAX_NUM_DETECTED_FACES_HW, 0);
3955         }
3956 
3957         /**
3958          * Sets recording mode hint. This tells the camera that the intent of
3959          * the application is to record videos {@link
3960          * android.media.MediaRecorder#start()}, not to take still pictures
3961          * {@link #takePicture(Camera.ShutterCallback, Camera.PictureCallback,
3962          * Camera.PictureCallback, Camera.PictureCallback)}. Using this hint can
3963          * allow MediaRecorder.start() to start faster or with fewer glitches on
3964          * output. This should be called before starting preview for the best
3965          * result, but can be changed while the preview is active. The default
3966          * value is false.
3967          *
3968          * The app can still call takePicture() when the hint is true or call
3969          * MediaRecorder.start() when the hint is false. But the performance may
3970          * be worse.
3971          *
3972          * @param hint true if the apps intend to record videos using
3973          *             {@link android.media.MediaRecorder}.
3974          */
setRecordingHint(boolean hint)3975         public void setRecordingHint(boolean hint) {
3976             set(KEY_RECORDING_HINT, hint ? TRUE : FALSE);
3977         }
3978 
3979         /**
3980          * <p>Returns true if video snapshot is supported. That is, applications
3981          * can call {@link #takePicture(Camera.ShutterCallback,
3982          * Camera.PictureCallback, Camera.PictureCallback,
3983          * Camera.PictureCallback)} during recording. Applications do not need
3984          * to call {@link #startPreview()} after taking a picture. The preview
3985          * will be still active. Other than that, taking a picture during
3986          * recording is identical to taking a picture normally. All settings and
3987          * methods related to takePicture work identically. Ex:
3988          * {@link #getPictureSize()}, {@link #getSupportedPictureSizes()},
3989          * {@link #setJpegQuality(int)}, {@link #setRotation(int)}, and etc. The
3990          * picture will have an EXIF header. {@link #FLASH_MODE_AUTO} and
3991          * {@link #FLASH_MODE_ON} also still work, but the video will record the
3992          * flash.</p>
3993          *
3994          * <p>Applications can set shutter callback as null to avoid the shutter
3995          * sound. It is also recommended to set raw picture and post view
3996          * callbacks to null to avoid the interrupt of preview display.</p>
3997          *
3998          * <p>Field-of-view of the recorded video may be different from that of the
3999          * captured pictures. The maximum size of a video snapshot may be
4000          * smaller than that for regular still captures. If the current picture
4001          * size is set higher than can be supported by video snapshot, the
4002          * picture will be captured at the maximum supported size instead.</p>
4003          *
4004          * @return true if video snapshot is supported.
4005          */
isVideoSnapshotSupported()4006         public boolean isVideoSnapshotSupported() {
4007             String str = get(KEY_VIDEO_SNAPSHOT_SUPPORTED);
4008             return TRUE.equals(str);
4009         }
4010 
4011         /**
4012          * <p>Enables and disables video stabilization. Use
4013          * {@link #isVideoStabilizationSupported} to determine if calling this
4014          * method is valid.</p>
4015          *
4016          * <p>Video stabilization reduces the shaking due to the motion of the
4017          * camera in both the preview stream and in recorded videos, including
4018          * data received from the preview callback. It does not reduce motion
4019          * blur in images captured with
4020          * {@link Camera#takePicture takePicture}.</p>
4021          *
4022          * <p>Video stabilization can be enabled and disabled while preview or
4023          * recording is active, but toggling it may cause a jump in the video
4024          * stream that may be undesirable in a recorded video.</p>
4025          *
4026          * @param toggle Set to true to enable video stabilization, and false to
4027          * disable video stabilization.
4028          * @see #isVideoStabilizationSupported()
4029          * @see #getVideoStabilization()
4030          */
setVideoStabilization(boolean toggle)4031         public void setVideoStabilization(boolean toggle) {
4032             set(KEY_VIDEO_STABILIZATION, toggle ? TRUE : FALSE);
4033         }
4034 
4035         /**
4036          * Get the current state of video stabilization. See
4037          * {@link #setVideoStabilization} for details of video stabilization.
4038          *
4039          * @return true if video stabilization is enabled
4040          * @see #isVideoStabilizationSupported()
4041          * @see #setVideoStabilization(boolean)
4042          */
getVideoStabilization()4043         public boolean getVideoStabilization() {
4044             String str = get(KEY_VIDEO_STABILIZATION);
4045             return TRUE.equals(str);
4046         }
4047 
4048         /**
4049          * Returns true if video stabilization is supported. See
4050          * {@link #setVideoStabilization} for details of video stabilization.
4051          *
4052          * @return true if video stabilization is supported
4053          * @see #setVideoStabilization(boolean)
4054          * @see #getVideoStabilization()
4055          */
isVideoStabilizationSupported()4056         public boolean isVideoStabilizationSupported() {
4057             String str = get(KEY_VIDEO_STABILIZATION_SUPPORTED);
4058             return TRUE.equals(str);
4059         }
4060 
4061         // Splits a comma delimited string to an ArrayList of String.
4062         // Return null if the passing string is null or the size is 0.
split(String str)4063         private ArrayList<String> split(String str) {
4064             if (str == null) return null;
4065 
4066             TextUtils.StringSplitter splitter = new TextUtils.SimpleStringSplitter(',');
4067             splitter.setString(str);
4068             ArrayList<String> substrings = new ArrayList<String>();
4069             for (String s : splitter) {
4070                 substrings.add(s);
4071             }
4072             return substrings;
4073         }
4074 
4075         // Splits a comma delimited string to an ArrayList of Integer.
4076         // Return null if the passing string is null or the size is 0.
splitInt(String str)4077         private ArrayList<Integer> splitInt(String str) {
4078             if (str == null) return null;
4079 
4080             TextUtils.StringSplitter splitter = new TextUtils.SimpleStringSplitter(',');
4081             splitter.setString(str);
4082             ArrayList<Integer> substrings = new ArrayList<Integer>();
4083             for (String s : splitter) {
4084                 substrings.add(Integer.parseInt(s));
4085             }
4086             if (substrings.size() == 0) return null;
4087             return substrings;
4088         }
4089 
splitInt(String str, int[] output)4090         private void splitInt(String str, int[] output) {
4091             if (str == null) return;
4092 
4093             TextUtils.StringSplitter splitter = new TextUtils.SimpleStringSplitter(',');
4094             splitter.setString(str);
4095             int index = 0;
4096             for (String s : splitter) {
4097                 output[index++] = Integer.parseInt(s);
4098             }
4099         }
4100 
4101         // Splits a comma delimited string to an ArrayList of Float.
splitFloat(String str, float[] output)4102         private void splitFloat(String str, float[] output) {
4103             if (str == null) return;
4104 
4105             TextUtils.StringSplitter splitter = new TextUtils.SimpleStringSplitter(',');
4106             splitter.setString(str);
4107             int index = 0;
4108             for (String s : splitter) {
4109                 output[index++] = Float.parseFloat(s);
4110             }
4111         }
4112 
4113         // Returns the value of a float parameter.
getFloat(String key, float defaultValue)4114         private float getFloat(String key, float defaultValue) {
4115             try {
4116                 return Float.parseFloat(mMap.get(key));
4117             } catch (NumberFormatException ex) {
4118                 return defaultValue;
4119             }
4120         }
4121 
4122         // Returns the value of a integer parameter.
getInt(String key, int defaultValue)4123         private int getInt(String key, int defaultValue) {
4124             try {
4125                 return Integer.parseInt(mMap.get(key));
4126             } catch (NumberFormatException ex) {
4127                 return defaultValue;
4128             }
4129         }
4130 
4131         // Splits a comma delimited string to an ArrayList of Size.
4132         // Return null if the passing string is null or the size is 0.
splitSize(String str)4133         private ArrayList<Size> splitSize(String str) {
4134             if (str == null) return null;
4135 
4136             TextUtils.StringSplitter splitter = new TextUtils.SimpleStringSplitter(',');
4137             splitter.setString(str);
4138             ArrayList<Size> sizeList = new ArrayList<Size>();
4139             for (String s : splitter) {
4140                 Size size = strToSize(s);
4141                 if (size != null) sizeList.add(size);
4142             }
4143             if (sizeList.size() == 0) return null;
4144             return sizeList;
4145         }
4146 
4147         // Parses a string (ex: "480x320") to Size object.
4148         // Return null if the passing string is null.
strToSize(String str)4149         private Size strToSize(String str) {
4150             if (str == null) return null;
4151 
4152             int pos = str.indexOf('x');
4153             if (pos != -1) {
4154                 String width = str.substring(0, pos);
4155                 String height = str.substring(pos + 1);
4156                 return new Size(Integer.parseInt(width),
4157                                 Integer.parseInt(height));
4158             }
4159             Log.e(TAG, "Invalid size parameter string=" + str);
4160             return null;
4161         }
4162 
4163         // Splits a comma delimited string to an ArrayList of int array.
4164         // Example string: "(10000,26623),(10000,30000)". Return null if the
4165         // passing string is null or the size is 0.
splitRange(String str)4166         private ArrayList<int[]> splitRange(String str) {
4167             if (str == null || str.charAt(0) != '('
4168                     || str.charAt(str.length() - 1) != ')') {
4169                 Log.e(TAG, "Invalid range list string=" + str);
4170                 return null;
4171             }
4172 
4173             ArrayList<int[]> rangeList = new ArrayList<int[]>();
4174             int endIndex, fromIndex = 1;
4175             do {
4176                 int[] range = new int[2];
4177                 endIndex = str.indexOf("),(", fromIndex);
4178                 if (endIndex == -1) endIndex = str.length() - 1;
4179                 splitInt(str.substring(fromIndex, endIndex), range);
4180                 rangeList.add(range);
4181                 fromIndex = endIndex + 3;
4182             } while (endIndex != str.length() - 1);
4183 
4184             if (rangeList.size() == 0) return null;
4185             return rangeList;
4186         }
4187 
4188         // Splits a comma delimited string to an ArrayList of Area objects.
4189         // Example string: "(-10,-10,0,0,300),(0,0,10,10,700)". Return null if
4190         // the passing string is null or the size is 0 or (0,0,0,0,0).
splitArea(String str)4191         private ArrayList<Area> splitArea(String str) {
4192             if (str == null || str.charAt(0) != '('
4193                     || str.charAt(str.length() - 1) != ')') {
4194                 Log.e(TAG, "Invalid area string=" + str);
4195                 return null;
4196             }
4197 
4198             ArrayList<Area> result = new ArrayList<Area>();
4199             int endIndex, fromIndex = 1;
4200             int[] array = new int[5];
4201             do {
4202                 endIndex = str.indexOf("),(", fromIndex);
4203                 if (endIndex == -1) endIndex = str.length() - 1;
4204                 splitInt(str.substring(fromIndex, endIndex), array);
4205                 Rect rect = new Rect(array[0], array[1], array[2], array[3]);
4206                 result.add(new Area(rect, array[4]));
4207                 fromIndex = endIndex + 3;
4208             } while (endIndex != str.length() - 1);
4209 
4210             if (result.size() == 0) return null;
4211 
4212             if (result.size() == 1) {
4213                 Area area = result.get(0);
4214                 Rect rect = area.rect;
4215                 if (rect.left == 0 && rect.top == 0 && rect.right == 0
4216                         && rect.bottom == 0 && area.weight == 0) {
4217                     return null;
4218                 }
4219             }
4220 
4221             return result;
4222         }
4223 
same(String s1, String s2)4224         private boolean same(String s1, String s2) {
4225             if (s1 == null && s2 == null) return true;
4226             if (s1 != null && s1.equals(s2)) return true;
4227             return false;
4228         }
4229     };
4230 }
4231