blob: 7edf6b4562ff3881a055f088d00a65355e8e0c03 [file] [log] [blame]
Mathias Agopian3cf61352010-02-09 17:46:37 -08001/*
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#ifndef ANDROID_HARDWARE_CAMERA_PARAMETERS_H
18#define ANDROID_HARDWARE_CAMERA_PARAMETERS_H
19
20#include <utils/KeyedVector.h>
21#include <utils/String8.h>
22
23namespace android {
24
Nipun Kwatra34c91a32010-07-30 13:40:14 -070025struct Size {
26 int width;
27 int height;
28
29 Size() {
30 width = 0;
31 height = 0;
32 }
33
34 Size(int w, int h) {
35 width = w;
36 height = h;
37 }
38};
39
Mathias Agopian3cf61352010-02-09 17:46:37 -080040class CameraParameters
41{
42public:
43 CameraParameters();
44 CameraParameters(const String8 &params) { unflatten(params); }
45 ~CameraParameters();
46
47 String8 flatten() const;
48 void unflatten(const String8 &params);
49
50 void set(const char *key, const char *value);
51 void set(const char *key, int value);
52 void setFloat(const char *key, float value);
53 const char *get(const char *key) const;
54 int getInt(const char *key) const;
55 float getFloat(const char *key) const;
56
Wu-cheng Liadbda962010-05-11 12:11:56 +080057 void remove(const char *key);
58
Mathias Agopian3cf61352010-02-09 17:46:37 -080059 void setPreviewSize(int width, int height);
60 void getPreviewSize(int *width, int *height) const;
Nipun Kwatrae44607e2010-08-04 14:04:07 -070061 void getSupportedPreviewSizes(Vector<Size> &sizes) const;
James Dong0d14c252010-09-30 10:50:51 -070062
63 // Set the dimensions in pixels to the given width and height
64 // for video frames. The given width and height must be one
65 // of the supported dimensions returned from
66 // getSupportedVideoSizes(). Must not be called if
67 // getSupportedVideoSizes() returns an empty Vector of Size.
68 void setVideoSize(int width, int height);
69 // Retrieve the current dimensions (width and height)
70 // in pixels for video frames, which must be one of the
71 // supported dimensions returned from getSupportedVideoSizes().
72 // Must not be called if getSupportedVideoSizes() returns an
73 // empty Vector of Size.
74 void getVideoSize(int *width, int *height) const;
75 // Retrieve a Vector of supported dimensions (width and height)
76 // in pixels for video frames. If sizes returned from the method
77 // is empty, the camera does not support calls to setVideoSize()
78 // or getVideoSize(). In adddition, it also indicates that
79 // the camera only has a single output, and does not have
80 // separate output for video frames and preview frame.
81 void getSupportedVideoSizes(Vector<Size> &sizes) const;
James Dong0f5a6f92010-11-29 16:51:55 -080082 // Retrieve the preferred preview size (width and height) in pixels
83 // for video recording. The given width and height must be one of
84 // supported preview sizes returned from getSupportedPreviewSizes().
85 // Must not be called if getSupportedVideoSizes() returns an empty
86 // Vector of Size. If getSupportedVideoSizes() returns an empty
87 // Vector of Size, the width and height returned from this method
88 // is invalid, and is "-1x-1".
89 void getPreferredPreviewSizeForVideo(int *width, int *height) const;
James Dong0d14c252010-09-30 10:50:51 -070090
Mathias Agopian3cf61352010-02-09 17:46:37 -080091 void setPreviewFrameRate(int fps);
92 int getPreviewFrameRate() const;
Wu-cheng Li04379fa2010-08-11 16:48:05 -070093 void getPreviewFpsRange(int *min_fps, int *max_fps) const;
Mathias Agopian3cf61352010-02-09 17:46:37 -080094 void setPreviewFormat(const char *format);
95 const char *getPreviewFormat() const;
Mathias Agopian3cf61352010-02-09 17:46:37 -080096 void setPictureSize(int width, int height);
97 void getPictureSize(int *width, int *height) const;
Nipun Kwatra34c91a32010-07-30 13:40:14 -070098 void getSupportedPictureSizes(Vector<Size> &sizes) const;
Mathias Agopian3cf61352010-02-09 17:46:37 -080099 void setPictureFormat(const char *format);
100 const char *getPictureFormat() const;
101
102 void dump() const;
103 status_t dump(int fd, const Vector<String16>& args) const;
104
105 // Parameter keys to communicate between camera application and driver.
106 // The access (read/write, read only, or write only) is viewed from the
107 // perspective of applications, not driver.
108
109 // Preview frame size in pixels (width x height).
110 // Example value: "480x320". Read/Write.
111 static const char KEY_PREVIEW_SIZE[];
112 // Supported preview frame sizes in pixels.
113 // Example value: "800x600,480x320". Read only.
114 static const char KEY_SUPPORTED_PREVIEW_SIZES[];
Wu-cheng Li04379fa2010-08-11 16:48:05 -0700115 // The current minimum and maximum preview fps. This controls the rate of
116 // preview frames received (CAMERA_MSG_PREVIEW_FRAME). The minimum and
117 // maximum fps must be one of the elements from
118 // KEY_SUPPORTED_PREVIEW_FPS_RANGE parameter.
119 // Example value: "10500,26623"
120 static const char KEY_PREVIEW_FPS_RANGE[];
121 // The supported preview fps (frame-per-second) ranges. Each range contains
122 // a minimum fps and maximum fps. If minimum fps equals to maximum fps, the
123 // camera outputs frames in fixed frame rate. If not, the camera outputs
124 // frames in auto frame rate. The actual frame rate fluctuates between the
125 // minimum and the maximum. The list has at least one element. The list is
126 // sorted from small to large (first by maximum fps and then minimum fps).
127 // Example value: "(10500,26623),(15000,26623),(30000,30000)"
128 static const char KEY_SUPPORTED_PREVIEW_FPS_RANGE[];
Wu-cheng Li0b0279e2010-05-28 17:32:41 +0800129 // The image format for preview frames. See CAMERA_MSG_PREVIEW_FRAME in
130 // frameworks/base/include/camera/Camera.h.
Mathias Agopian3cf61352010-02-09 17:46:37 -0800131 // Example value: "yuv420sp" or PIXEL_FORMAT_XXX constants. Read/write.
132 static const char KEY_PREVIEW_FORMAT[];
133 // Supported image formats for preview frames.
134 // Example value: "yuv420sp,yuv422i-yuyv". Read only.
135 static const char KEY_SUPPORTED_PREVIEW_FORMATS[];
Wu-cheng Li0b0279e2010-05-28 17:32:41 +0800136 // Number of preview frames per second. This is the target frame rate. The
137 // actual frame rate depends on the driver.
Mathias Agopian3cf61352010-02-09 17:46:37 -0800138 // Example value: "15". Read/write.
139 static const char KEY_PREVIEW_FRAME_RATE[];
140 // Supported number of preview frames per second.
141 // Example value: "24,15,10". Read.
142 static const char KEY_SUPPORTED_PREVIEW_FRAME_RATES[];
143 // The dimensions for captured pictures in pixels (width x height).
144 // Example value: "1024x768". Read/write.
145 static const char KEY_PICTURE_SIZE[];
146 // Supported dimensions for captured pictures in pixels.
147 // Example value: "2048x1536,1024x768". Read only.
148 static const char KEY_SUPPORTED_PICTURE_SIZES[];
Wu-cheng Li0b0279e2010-05-28 17:32:41 +0800149 // The image format for captured pictures. See CAMERA_MSG_COMPRESSED_IMAGE
150 // in frameworks/base/include/camera/Camera.h.
Mathias Agopian3cf61352010-02-09 17:46:37 -0800151 // Example value: "jpeg" or PIXEL_FORMAT_XXX constants. Read/write.
152 static const char KEY_PICTURE_FORMAT[];
153 // Supported image formats for captured pictures.
154 // Example value: "jpeg,rgb565". Read only.
155 static const char KEY_SUPPORTED_PICTURE_FORMATS[];
156 // The width (in pixels) of EXIF thumbnail in Jpeg picture.
157 // Example value: "512". Read/write.
158 static const char KEY_JPEG_THUMBNAIL_WIDTH[];
159 // The height (in pixels) of EXIF thumbnail in Jpeg picture.
160 // Example value: "384". Read/write.
161 static const char KEY_JPEG_THUMBNAIL_HEIGHT[];
162 // Supported EXIF thumbnail sizes (width x height). 0x0 means not thumbnail
163 // in EXIF.
164 // Example value: "512x384,320x240,0x0". Read only.
165 static const char KEY_SUPPORTED_JPEG_THUMBNAIL_SIZES[];
166 // The quality of the EXIF thumbnail in Jpeg picture. The range is 1 to 100,
167 // with 100 being the best.
168 // Example value: "90". Read/write.
169 static const char KEY_JPEG_THUMBNAIL_QUALITY[];
170 // Jpeg quality of captured picture. The range is 1 to 100, with 100 being
171 // the best.
172 // Example value: "90". Read/write.
173 static const char KEY_JPEG_QUALITY[];
Wu-cheng Lic2c88682010-11-19 15:56:16 +0800174 // The rotation angle in degrees relative to the orientation of the camera.
175 // This affects the pictures returned from CAMERA_MSG_COMPRESSED_IMAGE. The
176 // camera driver may set orientation in the EXIF header without rotating the
177 // picture. Or the driver may rotate the picture and the EXIF thumbnail. If
178 // the Jpeg picture is rotated, the orientation in the EXIF header will be
179 // missing or 1 (row #0 is top and column #0 is left side).
180 //
181 // Note that the JPEG pictures of front-facing cameras are not mirrored
182 // as in preview display.
183 //
184 // For example, suppose the natural orientation of the device is portrait.
185 // The device is rotated 270 degrees clockwise, so the device orientation is
186 // 270. Suppose a back-facing camera sensor is mounted in landscape and the
187 // top side of the camera sensor is aligned with the right edge of the
188 // display in natural orientation. So the camera orientation is 90. The
189 // rotation should be set to 0 (270 + 90).
190 //
Mathias Agopian3cf61352010-02-09 17:46:37 -0800191 // Example value: "0" or "90" or "180" or "270". Write only.
192 static const char KEY_ROTATION[];
Wu-cheng Li6b19fac2010-05-21 17:52:42 +0800193 // GPS latitude coordinate. GPSLatitude and GPSLatitudeRef will be stored in
194 // JPEG EXIF header.
195 // Example value: "25.032146" or "-33.462809". Write only.
Mathias Agopian3cf61352010-02-09 17:46:37 -0800196 static const char KEY_GPS_LATITUDE[];
Wu-cheng Li6b19fac2010-05-21 17:52:42 +0800197 // GPS longitude coordinate. GPSLongitude and GPSLongitudeRef will be stored
198 // in JPEG EXIF header.
199 // Example value: "121.564448" or "-70.660286". Write only.
Mathias Agopian3cf61352010-02-09 17:46:37 -0800200 static const char KEY_GPS_LONGITUDE[];
Wu-cheng Li6b19fac2010-05-21 17:52:42 +0800201 // GPS altitude. GPSAltitude and GPSAltitudeRef will be stored in JPEG EXIF
202 // header.
203 // Example value: "21.0" or "-5". Write only.
Mathias Agopian3cf61352010-02-09 17:46:37 -0800204 static const char KEY_GPS_ALTITUDE[];
205 // GPS timestamp (UTC in seconds since January 1, 1970). This should be
206 // stored in JPEG EXIF header.
207 // Example value: "1251192757". Write only.
208 static const char KEY_GPS_TIMESTAMP[];
Ray Chenc0170bc2010-02-23 10:45:42 +0800209 // GPS Processing Method
210 // Example value: "GPS" or "NETWORK". Write only.
211 static const char KEY_GPS_PROCESSING_METHOD[];
Mathias Agopian3cf61352010-02-09 17:46:37 -0800212 // Current white balance setting.
213 // Example value: "auto" or WHITE_BALANCE_XXX constants. Read/write.
214 static const char KEY_WHITE_BALANCE[];
215 // Supported white balance settings.
216 // Example value: "auto,incandescent,daylight". Read only.
217 static const char KEY_SUPPORTED_WHITE_BALANCE[];
218 // Current color effect setting.
219 // Example value: "none" or EFFECT_XXX constants. Read/write.
220 static const char KEY_EFFECT[];
221 // Supported color effect settings.
222 // Example value: "none,mono,sepia". Read only.
223 static const char KEY_SUPPORTED_EFFECTS[];
224 // Current antibanding setting.
225 // Example value: "auto" or ANTIBANDING_XXX constants. Read/write.
226 static const char KEY_ANTIBANDING[];
227 // Supported antibanding settings.
228 // Example value: "auto,50hz,60hz,off". Read only.
229 static const char KEY_SUPPORTED_ANTIBANDING[];
230 // Current scene mode.
231 // Example value: "auto" or SCENE_MODE_XXX constants. Read/write.
232 static const char KEY_SCENE_MODE[];
233 // Supported scene mode settings.
234 // Example value: "auto,night,fireworks". Read only.
235 static const char KEY_SUPPORTED_SCENE_MODES[];
236 // Current flash mode.
237 // Example value: "auto" or FLASH_MODE_XXX constants. Read/write.
238 static const char KEY_FLASH_MODE[];
239 // Supported flash modes.
240 // Example value: "auto,on,off". Read only.
241 static const char KEY_SUPPORTED_FLASH_MODES[];
Wu-cheng Lic6e88fd2010-08-05 11:50:25 -0700242 // Current focus mode. This will not be empty. Applications should call
243 // CameraHardwareInterface.autoFocus to start the focus if focus mode is
244 // FOCUS_MODE_AUTO or FOCUS_MODE_MACRO.
Mathias Agopian3cf61352010-02-09 17:46:37 -0800245 // Example value: "auto" or FOCUS_MODE_XXX constants. Read/write.
246 static const char KEY_FOCUS_MODE[];
247 // Supported focus modes.
248 // Example value: "auto,macro,fixed". Read only.
249 static const char KEY_SUPPORTED_FOCUS_MODES[];
Wu-cheng Lia1c3d372011-04-02 06:19:46 +0800250 // The maximum number of focus areas supported. This is the maximum length
251 // of KEY_FOCUS_AREAS.
252 // Example value: "0" or "2". Read only.
253 static const char KEY_MAX_NUM_FOCUS_AREAS[];
254 // Current focus areas.
255 //
256 // Before accessing this parameter, apps should check
257 // KEY_MAX_NUM_FOCUS_AREAS first to know the maximum number of focus areas
258 // first. If the value is 0, focus area is not supported.
259 //
260 // Each focus area is a five-element int array. The first four elements are
261 // the rectangle of the area (left, top, right, bottom). The direction is
262 // relative to the sensor orientation, that is, what the sensor sees. The
263 // direction is not affected by the rotation or mirroring of
264 // CAMERA_CMD_SET_DISPLAY_ORIENTATION. Coordinates range from -1000 to 1000.
265 // (-1000,-1000) is the upper left point. (1000, 1000) is the lower right
Wu-cheng Li0c083252011-06-07 18:23:14 +0800266 // point. The width and height of focus areas cannot be 0 or negative.
Wu-cheng Lia1c3d372011-04-02 06:19:46 +0800267 //
Eino-Ville Talvala44ada652011-04-21 09:23:15 -0700268 // The fifth element is the weight. Values for weight must range from 1 to
269 // 1000. The weight should be interpreted as a per-pixel weight - all
270 // pixels in the area have the specified weight. This means a small area
271 // with the same weight as a larger area will have less influence on the
272 // focusing than the larger area. Focus areas can partially overlap and the
273 // driver will add the weights in the overlap region.
Wu-cheng Lia1c3d372011-04-02 06:19:46 +0800274 //
275 // A special case of single focus area (0,0,0,0,0) means driver to decide
276 // the focus area. For example, the driver may use more signals to decide
277 // focus areas and change them dynamically. Apps can set (0,0,0,0,0) if they
278 // want the driver to decide focus areas.
279 //
280 // Focus areas are relative to the current field of view (KEY_ZOOM). No
281 // matter what the zoom level is, (-1000,-1000) represents the top of the
282 // currently visible camera frame. The focus area cannot be set to be
283 // outside the current field of view, even when using zoom.
284 //
285 // Focus area only has effect if the current focus mode is FOCUS_MODE_AUTO,
Wu-cheng Libbdb4122011-10-12 19:43:51 +0800286 // FOCUS_MODE_MACRO, FOCUS_MODE_CONTINUOUS_VIDEO, or
287 // FOCUS_MODE_CONTINUOUS_PICTURE.
Wu-cheng Lia1c3d372011-04-02 06:19:46 +0800288 // Example value: "(-10,-10,0,0,300),(0,0,10,10,700)". Read/write.
289 static const char KEY_FOCUS_AREAS[];
Mathias Agopian3cf61352010-02-09 17:46:37 -0800290 // Focal length in millimeter.
291 // Example value: "4.31". Read only.
292 static const char KEY_FOCAL_LENGTH[];
293 // Horizontal angle of view in degrees.
294 // Example value: "54.8". Read only.
295 static const char KEY_HORIZONTAL_VIEW_ANGLE[];
296 // Vertical angle of view in degrees.
297 // Example value: "42.5". Read only.
298 static const char KEY_VERTICAL_VIEW_ANGLE[];
Wu-cheng Li4f1bff92010-02-20 17:47:04 +0800299 // Exposure compensation index. 0 means exposure is not adjusted.
300 // Example value: "0" or "5". Read/write.
Mathias Agopian3cf61352010-02-09 17:46:37 -0800301 static const char KEY_EXPOSURE_COMPENSATION[];
Wu-cheng Li4f1bff92010-02-20 17:47:04 +0800302 // The maximum exposure compensation index (>=0).
303 // Example value: "6". Read only.
304 static const char KEY_MAX_EXPOSURE_COMPENSATION[];
305 // The minimum exposure compensation index (<=0).
306 // Example value: "-6". Read only.
307 static const char KEY_MIN_EXPOSURE_COMPENSATION[];
308 // The exposure compensation step. Exposure compensation index multiply by
309 // step eqals to EV. Ex: if exposure compensation index is 6 and step is
310 // 0.3333, EV is -2.
311 // Example value: "0.333333333" or "0.5". Read only.
312 static const char KEY_EXPOSURE_COMPENSATION_STEP[];
Eino-Ville Talvalafd99e1d2011-05-13 10:19:59 -0700313 // The state of the auto-exposure lock. "true" means that
314 // auto-exposure is locked to its current value and will not
315 // change. "false" means the auto-exposure routine is free to
316 // change exposure values. If auto-exposure is already locked,
317 // setting this to true again has no effect (the driver will not
318 // recalculate exposure values). Changing exposure compensation
319 // settings will still affect the exposure settings while
320 // auto-exposure is locked. Stopping preview or taking a still
Wu-cheng Lica1d5392011-09-22 11:43:28 +0800321 // image will not change the lock. In conjunction with
Eino-Ville Talvalafd99e1d2011-05-13 10:19:59 -0700322 // exposure compensation, this allows for capturing multi-exposure
323 // brackets with known relative exposure values. Locking
324 // auto-exposure after open but before the first call to
325 // startPreview may result in severely over- or under-exposed
Wu-cheng Lica1d5392011-09-22 11:43:28 +0800326 // images. The driver will not change the AE lock after
327 // auto-focus completes.
Eino-Ville Talvala95fbf2c2011-04-15 13:51:42 -0700328 static const char KEY_AUTO_EXPOSURE_LOCK[];
329 // Whether locking the auto-exposure is supported. "true" means it is, and
330 // "false" or this key not existing means it is not supported.
331 static const char KEY_AUTO_EXPOSURE_LOCK_SUPPORTED[];
Eino-Ville Talvalafd99e1d2011-05-13 10:19:59 -0700332 // The state of the auto-white balance lock. "true" means that
333 // auto-white balance is locked to its current value and will not
334 // change. "false" means the auto-white balance routine is free to
335 // change white balance values. If auto-white balance is already
336 // locked, setting this to true again has no effect (the driver
337 // will not recalculate white balance values). Stopping preview or
Wu-cheng Lica1d5392011-09-22 11:43:28 +0800338 // taking a still image will not change the lock. In conjunction
Eino-Ville Talvalafd99e1d2011-05-13 10:19:59 -0700339 // with exposure compensation, this allows for capturing
340 // multi-exposure brackets with fixed white balance. Locking
341 // auto-white balance after open but before the first call to
342 // startPreview may result in severely incorrect color. The
Wu-cheng Lica1d5392011-09-22 11:43:28 +0800343 // driver will not change the AWB lock after auto-focus
344 // completes.
Eino-Ville Talvalafd99e1d2011-05-13 10:19:59 -0700345 static const char KEY_AUTO_WHITEBALANCE_LOCK[];
346 // Whether locking the auto-white balance is supported. "true"
347 // means it is, and "false" or this key not existing means it is
348 // not supported.
349 static const char KEY_AUTO_WHITEBALANCE_LOCK_SUPPORTED[];
350
Wu-cheng Li38ecadb2011-04-12 19:34:29 +0800351 // The maximum number of metering areas supported. This is the maximum
352 // length of KEY_METERING_AREAS.
353 // Example value: "0" or "2". Read only.
354 static const char KEY_MAX_NUM_METERING_AREAS[];
355 // Current metering areas. Camera driver uses these areas to decide
356 // exposure.
357 //
358 // Before accessing this parameter, apps should check
359 // KEY_MAX_NUM_METERING_AREAS first to know the maximum number of metering
360 // areas first. If the value is 0, metering area is not supported.
361 //
362 // Each metering area is a rectangle with specified weight. The direction is
363 // relative to the sensor orientation, that is, what the sensor sees. The
364 // direction is not affected by the rotation or mirroring of
365 // CAMERA_CMD_SET_DISPLAY_ORIENTATION. Coordinates of the rectangle range
366 // from -1000 to 1000. (-1000, -1000) is the upper left point. (1000, 1000)
Wu-cheng Li0c083252011-06-07 18:23:14 +0800367 // is the lower right point. The width and height of metering areas cannot
Wu-cheng Li38ecadb2011-04-12 19:34:29 +0800368 // be 0 or negative.
369 //
Eino-Ville Talvala44ada652011-04-21 09:23:15 -0700370 // The fifth element is the weight. Values for weight must range from 1 to
371 // 1000. The weight should be interpreted as a per-pixel weight - all
372 // pixels in the area have the specified weight. This means a small area
373 // with the same weight as a larger area will have less influence on the
374 // metering than the larger area. Metering areas can partially overlap and
375 // the driver will add the weights in the overlap region.
Wu-cheng Li38ecadb2011-04-12 19:34:29 +0800376 //
377 // A special case of all-zero single metering area means driver to decide
378 // the metering area. For example, the driver may use more signals to decide
379 // metering areas and change them dynamically. Apps can set all-zero if they
380 // want the driver to decide metering areas.
381 //
382 // Metering areas are relative to the current field of view (KEY_ZOOM).
383 // No matter what the zoom level is, (-1000,-1000) represents the top of the
384 // currently visible camera frame. The metering area cannot be set to be
385 // outside the current field of view, even when using zoom.
386 //
387 // No matter what metering areas are, the final exposure are compensated
388 // by KEY_EXPOSURE_COMPENSATION.
389 // Example value: "(-10,-10,0,0,300),(0,0,10,10,700)". Read/write.
390 static const char KEY_METERING_AREAS[];
Wu-cheng Li949c5032010-02-28 23:19:55 -0800391 // Current zoom value.
392 // Example value: "0" or "6". Read/write.
393 static const char KEY_ZOOM[];
394 // Maximum zoom value.
395 // Example value: "6". Read only.
396 static const char KEY_MAX_ZOOM[];
397 // The zoom ratios of all zoom values. The zoom ratio is in 1/100
398 // increments. Ex: a zoom of 3.2x is returned as 320. The number of list
399 // elements is KEY_MAX_ZOOM + 1. The first element is always 100. The last
400 // element is the zoom ratio of zoom value KEY_MAX_ZOOM.
401 // Example value: "100,150,200,250,300,350,400". Read only.
402 static const char KEY_ZOOM_RATIOS[];
403 // Whether zoom is supported. Zoom is supported if the value is "true". Zoom
404 // is not supported if the value is not "true" or the key does not exist.
405 // Example value: "true". Read only.
406 static const char KEY_ZOOM_SUPPORTED[];
407 // Whether if smooth zoom is supported. Smooth zoom is supported if the
408 // value is "true". It is not supported if the value is not "true" or the
409 // key does not exist.
410 // See CAMERA_CMD_START_SMOOTH_ZOOM, CAMERA_CMD_STOP_SMOOTH_ZOOM, and
411 // CAMERA_MSG_ZOOM in frameworks/base/include/camera/Camera.h.
412 // Example value: "true". Read only.
413 static const char KEY_SMOOTH_ZOOM_SUPPORTED[];
Mathias Agopian3cf61352010-02-09 17:46:37 -0800414
Wu-cheng Li09a2ab92010-05-13 19:31:02 +0800415 // The distances (in meters) from the camera to where an object appears to
416 // be in focus. The object is sharpest at the optimal focus distance. The
417 // depth of field is the far focus distance minus near focus distance.
418 //
Wu-cheng Lic6e88fd2010-08-05 11:50:25 -0700419 // Focus distances may change after starting auto focus, canceling auto
420 // focus, or starting the preview. Applications can read this anytime to get
421 // the latest focus distances. If the focus mode is FOCUS_MODE_CONTINUOUS,
422 // focus distances may change from time to time.
423 //
424 // This is intended to estimate the distance between the camera and the
425 // subject. After autofocus, the subject distance may be within near and far
426 // focus distance. However, the precision depends on the camera hardware,
427 // autofocus algorithm, the focus area, and the scene. The error can be
428 // large and it should be only used as a reference.
Wu-cheng Li09a2ab92010-05-13 19:31:02 +0800429 //
430 // Far focus distance > optimal focus distance > near focus distance. If
431 // the far focus distance is infinity, the value should be "Infinity" (case
432 // sensitive). The format is three float values separated by commas. The
433 // first is near focus distance. The second is optimal focus distance. The
434 // third is far focus distance.
435 // Example value: "0.95,1.9,Infinity" or "0.049,0.05,0.051". Read only.
436 static const char KEY_FOCUS_DISTANCES[];
437
James Dong0d14c252010-09-30 10:50:51 -0700438 // The current dimensions in pixels (width x height) for video frames.
439 // The width and height must be one of the supported sizes retrieved
440 // via KEY_SUPPORTED_VIDEO_SIZES.
441 // Example value: "1280x720". Read/write.
442 static const char KEY_VIDEO_SIZE[];
443 // A list of the supported dimensions in pixels (width x height)
444 // for video frames. See CAMERA_MSG_VIDEO_FRAME for details in
445 // frameworks/base/include/camera/Camera.h.
446 // Example: "176x144,1280x720". Read only.
447 static const char KEY_SUPPORTED_VIDEO_SIZES[];
James Dong0f5a6f92010-11-29 16:51:55 -0800448
Wu-cheng Li7fc25dd2011-07-22 02:37:11 +0800449 // The maximum number of detected faces supported by hardware face
450 // detection. If the value is 0, hardware face detection is not supported.
451 // Example: "5". Read only
452 static const char KEY_MAX_NUM_DETECTED_FACES_HW[];
453
454 // The maximum number of detected faces supported by software face
455 // detection. If the value is 0, software face detection is not supported.
456 // Example: "5". Read only
457 static const char KEY_MAX_NUM_DETECTED_FACES_SW[];
458
James Dong0f5a6f92010-11-29 16:51:55 -0800459 // Preferred preview frame size in pixels for video recording.
460 // The width and height must be one of the supported sizes retrieved
461 // via KEY_SUPPORTED_PREVIEW_SIZES. This key can be used only when
462 // getSupportedVideoSizes() does not return an empty Vector of Size.
463 // Camcorder applications are recommended to set the preview size
464 // to a value that is not larger than the preferred preview size.
465 // In other words, the product of the width and height of the
466 // preview size should not be larger than that of the preferred
467 // preview size. In addition, we recommend to choos a preview size
468 // that has the same aspect ratio as the resolution of video to be
469 // recorded.
470 // Example value: "800x600". Read only.
471 static const char KEY_PREFERRED_PREVIEW_SIZE_FOR_VIDEO[];
472
Wu-cheng Li0b0279e2010-05-28 17:32:41 +0800473 // The image format for video frames. See CAMERA_MSG_VIDEO_FRAME in
474 // frameworks/base/include/camera/Camera.h.
475 // Example value: "yuv420sp" or PIXEL_FORMAT_XXX constants. Read only.
476 static const char KEY_VIDEO_FRAME_FORMAT[];
477
Wu-cheng Li40cdc562011-08-02 13:20:36 +0800478 // Sets the hint of the recording mode. If this is true, MediaRecorder.start
479 // may be faster or has less glitches. This should be called before starting
480 // the preview for the best result. But it is allowed to change the hint
481 // while the preview is active. The default value is false.
482 //
483 // The apps can still call Camera.takePicture when the hint is true. The
484 // apps can call MediaRecorder.start when the hint is false. But the
485 // performance may be worse.
486 // Example value: "true" or "false". Read/write.
487 static const char KEY_RECORDING_HINT[];
488
Wu-cheng Lia8e409f2011-08-30 21:33:10 +0800489 // Returns true if video snapshot is supported. That is, applications
490 // can call Camera.takePicture during recording. Applications do not need to
491 // call Camera.startPreview after taking a picture. The preview will be
492 // still active. Other than that, taking a picture during recording is
493 // identical to taking a picture normally. All settings and methods related
494 // to takePicture work identically. Ex: KEY_PICTURE_SIZE,
495 // KEY_SUPPORTED_PICTURE_SIZES, KEY_JPEG_QUALITY, KEY_ROTATION, and etc.
496 // The picture will have an EXIF header. FLASH_MODE_AUTO and FLASH_MODE_ON
497 // also still work, but the video will record the flash.
498 //
499 // Applications can set shutter callback as null to avoid the shutter
500 // sound. It is also recommended to set raw picture and post view callbacks
501 // to null to avoid the interrupt of preview display.
502 //
503 // Field-of-view of the recorded video may be different from that of the
504 // captured pictures.
505 // Example value: "true" or "false". Read only.
506 static const char KEY_VIDEO_SNAPSHOT_SUPPORTED[];
507
Eino-Ville Talvala7019d222011-10-11 12:41:58 -0700508 // The state of the video stabilization. If set to true, both the
509 // preview stream and the recorded video stream are stabilized by
510 // the camera. Only valid to set if KEY_VIDEO_STABILIZATION_SUPPORTED is
511 // set to true.
512 //
513 // The value of this key can be changed any time the camera is
514 // open. If preview or recording is active, it is acceptable for
515 // there to be a slight video glitch when video stabilization is
516 // toggled on and off.
517 //
518 // This only stabilizes video streams (between-frames stabilization), and
519 // has no effect on still image capture.
520 static const char KEY_VIDEO_STABILIZATION[];
521
522 // Returns true if video stabilization is supported. That is, applications
523 // can set KEY_VIDEO_STABILIZATION to true and have a stabilized preview
524 // stream and record stabilized videos.
525 static const char KEY_VIDEO_STABILIZATION_SUPPORTED[];
526
Wu-cheng Lid8d888e2010-03-08 15:28:48 -0800527 // Value for KEY_ZOOM_SUPPORTED or KEY_SMOOTH_ZOOM_SUPPORTED.
528 static const char TRUE[];
Eino-Ville Talvala95fbf2c2011-04-15 13:51:42 -0700529 static const char FALSE[];
Wu-cheng Lid8d888e2010-03-08 15:28:48 -0800530
Wu-cheng Li09a2ab92010-05-13 19:31:02 +0800531 // Value for KEY_FOCUS_DISTANCES.
Wu-cheng Liae77ffa2010-05-15 13:05:04 +0800532 static const char FOCUS_DISTANCE_INFINITY[];
Wu-cheng Li09a2ab92010-05-13 19:31:02 +0800533
Wu-cheng Li4f1bff92010-02-20 17:47:04 +0800534 // Values for white balance settings.
Mathias Agopian3cf61352010-02-09 17:46:37 -0800535 static const char WHITE_BALANCE_AUTO[];
536 static const char WHITE_BALANCE_INCANDESCENT[];
537 static const char WHITE_BALANCE_FLUORESCENT[];
538 static const char WHITE_BALANCE_WARM_FLUORESCENT[];
539 static const char WHITE_BALANCE_DAYLIGHT[];
540 static const char WHITE_BALANCE_CLOUDY_DAYLIGHT[];
541 static const char WHITE_BALANCE_TWILIGHT[];
542 static const char WHITE_BALANCE_SHADE[];
543
544 // Values for effect settings.
545 static const char EFFECT_NONE[];
546 static const char EFFECT_MONO[];
547 static const char EFFECT_NEGATIVE[];
548 static const char EFFECT_SOLARIZE[];
549 static const char EFFECT_SEPIA[];
550 static const char EFFECT_POSTERIZE[];
551 static const char EFFECT_WHITEBOARD[];
552 static const char EFFECT_BLACKBOARD[];
553 static const char EFFECT_AQUA[];
554
555 // Values for antibanding settings.
556 static const char ANTIBANDING_AUTO[];
557 static const char ANTIBANDING_50HZ[];
558 static const char ANTIBANDING_60HZ[];
559 static const char ANTIBANDING_OFF[];
560
561 // Values for flash mode settings.
562 // Flash will not be fired.
563 static const char FLASH_MODE_OFF[];
564 // Flash will be fired automatically when required. The flash may be fired
565 // during preview, auto-focus, or snapshot depending on the driver.
566 static const char FLASH_MODE_AUTO[];
567 // Flash will always be fired during snapshot. The flash may also be
568 // fired during preview or auto-focus depending on the driver.
569 static const char FLASH_MODE_ON[];
570 // Flash will be fired in red-eye reduction mode.
571 static const char FLASH_MODE_RED_EYE[];
572 // Constant emission of light during preview, auto-focus and snapshot.
573 // This can also be used for video recording.
574 static const char FLASH_MODE_TORCH[];
575
576 // Values for scene mode settings.
577 static const char SCENE_MODE_AUTO[];
578 static const char SCENE_MODE_ACTION[];
579 static const char SCENE_MODE_PORTRAIT[];
580 static const char SCENE_MODE_LANDSCAPE[];
581 static const char SCENE_MODE_NIGHT[];
582 static const char SCENE_MODE_NIGHT_PORTRAIT[];
583 static const char SCENE_MODE_THEATRE[];
584 static const char SCENE_MODE_BEACH[];
585 static const char SCENE_MODE_SNOW[];
586 static const char SCENE_MODE_SUNSET[];
587 static const char SCENE_MODE_STEADYPHOTO[];
588 static const char SCENE_MODE_FIREWORKS[];
589 static const char SCENE_MODE_SPORTS[];
590 static const char SCENE_MODE_PARTY[];
591 static const char SCENE_MODE_CANDLELIGHT[];
Wu-cheng Li465d5a72010-03-29 17:21:28 +0800592 // Applications are looking for a barcode. Camera driver will be optimized
593 // for barcode reading.
594 static const char SCENE_MODE_BARCODE[];
Mathias Agopian3cf61352010-02-09 17:46:37 -0800595
James Donge2d8ba82010-09-15 16:52:51 -0700596 // Pixel color formats for KEY_PREVIEW_FORMAT, KEY_PICTURE_FORMAT,
597 // and KEY_VIDEO_FRAME_FORMAT
Mathias Agopian3cf61352010-02-09 17:46:37 -0800598 static const char PIXEL_FORMAT_YUV422SP[];
599 static const char PIXEL_FORMAT_YUV420SP[]; // NV21
600 static const char PIXEL_FORMAT_YUV422I[]; // YUY2
Wu-cheng Lid42c6e82011-02-22 15:49:25 +0800601 static const char PIXEL_FORMAT_YUV420P[]; // YV12
Mathias Agopian3cf61352010-02-09 17:46:37 -0800602 static const char PIXEL_FORMAT_RGB565[];
Iliyan Malchev5e7271d2011-06-06 16:36:05 -0700603 static const char PIXEL_FORMAT_RGBA8888[];
Mathias Agopian3cf61352010-02-09 17:46:37 -0800604 static const char PIXEL_FORMAT_JPEG[];
Wu-cheng Li79e2ab42011-08-02 17:49:50 +0800605 // Raw bayer format used for images, which is 10 bit precision samples
606 // stored in 16 bit words. The filter pattern is RGGB.
607 static const char PIXEL_FORMAT_BAYER_RGGB[];
Mathias Agopian3cf61352010-02-09 17:46:37 -0800608
609 // Values for focus mode settings.
Wu-cheng Li85b6e162010-08-17 13:44:35 -0700610 // Auto-focus mode. Applications should call
611 // CameraHardwareInterface.autoFocus to start the focus in this mode.
Mathias Agopian3cf61352010-02-09 17:46:37 -0800612 static const char FOCUS_MODE_AUTO[];
613 // Focus is set at infinity. Applications should not call
614 // CameraHardwareInterface.autoFocus in this mode.
615 static const char FOCUS_MODE_INFINITY[];
Wu-cheng Li85b6e162010-08-17 13:44:35 -0700616 // Macro (close-up) focus mode. Applications should call
617 // CameraHardwareInterface.autoFocus to start the focus in this mode.
Mathias Agopian3cf61352010-02-09 17:46:37 -0800618 static const char FOCUS_MODE_MACRO[];
619 // Focus is fixed. The camera is always in this mode if the focus is not
620 // adjustable. If the camera has auto-focus, this mode can fix the
621 // focus, which is usually at hyperfocal distance. Applications should
622 // not call CameraHardwareInterface.autoFocus in this mode.
623 static const char FOCUS_MODE_FIXED[];
Wu-cheng Li465d5a72010-03-29 17:21:28 +0800624 // Extended depth of field (EDOF). Focusing is done digitally and
625 // continuously. Applications should not call
626 // CameraHardwareInterface.autoFocus in this mode.
627 static const char FOCUS_MODE_EDOF[];
Wu-cheng Liac4205c2010-09-20 16:15:32 -0700628 // Continuous auto focus mode intended for video recording. The camera
Wu-cheng Liab3f1382011-08-16 21:14:16 +0800629 // continuously tries to focus. This is the best choice for video
630 // recording because the focus changes smoothly . Applications still can
631 // call CameraHardwareInterface.takePicture in this mode but the subject may
632 // not be in focus. Auto focus starts when the parameter is set.
Wu-cheng Libbdb4122011-10-12 19:43:51 +0800633 //
634 // Applications can call CameraHardwareInterface.autoFocus in this mode. The
635 // focus callback will immediately return with a boolean that indicates
636 // whether the focus is sharp or not. The focus position is locked after
637 // autoFocus call. If applications want to resume the continuous focus,
638 // cancelAutoFocus must be called. Restarting the preview will not resume
639 // the continuous autofocus. To stop continuous focus, applications should
640 // change the focus mode to other modes.
Wu-cheng Liac4205c2010-09-20 16:15:32 -0700641 static const char FOCUS_MODE_CONTINUOUS_VIDEO[];
Wu-cheng Liab3f1382011-08-16 21:14:16 +0800642 // Continuous auto focus mode intended for taking pictures. The camera
643 // continuously tries to focus. The speed of focus change is more aggressive
644 // than FOCUS_MODE_CONTINUOUS_VIDEO. Auto focus starts when the parameter is
Wu-cheng Libbdb4122011-10-12 19:43:51 +0800645 // set.
646 //
Wu-cheng Li597f4052011-10-27 18:07:01 +0800647 // Applications can call CameraHardwareInterface.autoFocus in this mode. If
648 // the autofocus is in the middle of scanning, the focus callback will
649 // return when it completes. If the autofocus is not scanning, focus
650 // callback will immediately return with a boolean that indicates whether
651 // the focus is sharp or not. The apps can then decide if they want to take
652 // a picture immediately or to change the focus mode to auto, and run a full
653 // autofocus cycle. The focus position is locked after autoFocus call. If
654 // applications want to resume the continuous focus, cancelAutoFocus must be
655 // called. Restarting the preview will not resume the continuous autofocus.
656 // To stop continuous focus, applications should change the focus mode to
657 // other modes.
Wu-cheng Liab3f1382011-08-16 21:14:16 +0800658 static const char FOCUS_MODE_CONTINUOUS_PICTURE[];
Wu-cheng Li4bf7ace2010-05-06 16:47:30 +0800659
Mathias Agopian3cf61352010-02-09 17:46:37 -0800660private:
661 DefaultKeyedVector<String8,String8> mMap;
662};
663
664}; // namespace android
665
666#endif