blob: d52154390921f84a6b1677f1e96e2f192fb02aae [file] [log] [blame]
Eino-Ville Talvalac2d64272012-05-15 15:38:27 -07001/*
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
25struct 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
40class 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
57 void remove(const char *key);
58
59 void setPreviewSize(int width, int height);
60 void getPreviewSize(int *width, int *height) const;
61 void getSupportedPreviewSizes(Vector<Size> &sizes) const;
62
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;
82 // 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;
90
91 void setPreviewFrameRate(int fps);
92 int getPreviewFrameRate() const;
93 void getPreviewFpsRange(int *min_fps, int *max_fps) const;
94 void setPreviewFormat(const char *format);
95 const char *getPreviewFormat() const;
96 void setPictureSize(int width, int height);
97 void getPictureSize(int *width, int *height) const;
98 void getSupportedPictureSizes(Vector<Size> &sizes) const;
99 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[];
115 // 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[];
129 // The image format for preview frames. See CAMERA_MSG_PREVIEW_FRAME in
130 // frameworks/av/include/camera/Camera.h. The default is
131 // PIXEL_FORMAT_YUV420SP. Example value: "yuv420sp" or PIXEL_FORMAT_XXX
132 // constants. Read/write.
133 static const char KEY_PREVIEW_FORMAT[];
134 // Supported image formats for preview frames.
135 // Example value: "yuv420sp,yuv422i-yuyv". Read only.
136 static const char KEY_SUPPORTED_PREVIEW_FORMATS[];
137 // Number of preview frames per second. This is the target frame rate. The
138 // actual frame rate depends on the driver.
139 // Example value: "15". Read/write.
140 static const char KEY_PREVIEW_FRAME_RATE[];
141 // Supported number of preview frames per second.
142 // Example value: "24,15,10". Read.
143 static const char KEY_SUPPORTED_PREVIEW_FRAME_RATES[];
144 // The dimensions for captured pictures in pixels (width x height).
145 // Example value: "1024x768". Read/write.
146 static const char KEY_PICTURE_SIZE[];
147 // Supported dimensions for captured pictures in pixels.
148 // Example value: "2048x1536,1024x768". Read only.
149 static const char KEY_SUPPORTED_PICTURE_SIZES[];
150 // The image format for captured pictures. See CAMERA_MSG_COMPRESSED_IMAGE
151 // in frameworks/base/include/camera/Camera.h.
152 // Example value: "jpeg" or PIXEL_FORMAT_XXX constants. Read/write.
153 static const char KEY_PICTURE_FORMAT[];
154 // Supported image formats for captured pictures.
155 // Example value: "jpeg,rgb565". Read only.
156 static const char KEY_SUPPORTED_PICTURE_FORMATS[];
157 // The width (in pixels) of EXIF thumbnail in Jpeg picture.
158 // Example value: "512". Read/write.
159 static const char KEY_JPEG_THUMBNAIL_WIDTH[];
160 // The height (in pixels) of EXIF thumbnail in Jpeg picture.
161 // Example value: "384". Read/write.
162 static const char KEY_JPEG_THUMBNAIL_HEIGHT[];
163 // Supported EXIF thumbnail sizes (width x height). 0x0 means not thumbnail
164 // in EXIF.
165 // Example value: "512x384,320x240,0x0". Read only.
166 static const char KEY_SUPPORTED_JPEG_THUMBNAIL_SIZES[];
167 // The quality of the EXIF thumbnail in Jpeg picture. The range is 1 to 100,
168 // with 100 being the best.
169 // Example value: "90". Read/write.
170 static const char KEY_JPEG_THUMBNAIL_QUALITY[];
171 // Jpeg quality of captured picture. The range is 1 to 100, with 100 being
172 // the best.
173 // Example value: "90". Read/write.
174 static const char KEY_JPEG_QUALITY[];
175 // The rotation angle in degrees relative to the orientation of the camera.
176 // This affects the pictures returned from CAMERA_MSG_COMPRESSED_IMAGE. The
177 // camera driver may set orientation in the EXIF header without rotating the
178 // picture. Or the driver may rotate the picture and the EXIF thumbnail. If
179 // the Jpeg picture is rotated, the orientation in the EXIF header will be
180 // missing or 1 (row #0 is top and column #0 is left side).
181 //
182 // Note that the JPEG pictures of front-facing cameras are not mirrored
183 // as in preview display.
184 //
185 // For example, suppose the natural orientation of the device is portrait.
186 // The device is rotated 270 degrees clockwise, so the device orientation is
187 // 270. Suppose a back-facing camera sensor is mounted in landscape and the
188 // top side of the camera sensor is aligned with the right edge of the
189 // display in natural orientation. So the camera orientation is 90. The
190 // rotation should be set to 0 (270 + 90).
191 //
192 // Example value: "0" or "90" or "180" or "270". Write only.
193 static const char KEY_ROTATION[];
194 // GPS latitude coordinate. GPSLatitude and GPSLatitudeRef will be stored in
195 // JPEG EXIF header.
196 // Example value: "25.032146" or "-33.462809". Write only.
197 static const char KEY_GPS_LATITUDE[];
198 // GPS longitude coordinate. GPSLongitude and GPSLongitudeRef will be stored
199 // in JPEG EXIF header.
200 // Example value: "121.564448" or "-70.660286". Write only.
201 static const char KEY_GPS_LONGITUDE[];
202 // GPS altitude. GPSAltitude and GPSAltitudeRef will be stored in JPEG EXIF
203 // header.
204 // Example value: "21.0" or "-5". Write only.
205 static const char KEY_GPS_ALTITUDE[];
206 // GPS timestamp (UTC in seconds since January 1, 1970). This should be
207 // stored in JPEG EXIF header.
208 // Example value: "1251192757". Write only.
209 static const char KEY_GPS_TIMESTAMP[];
210 // GPS Processing Method
211 // Example value: "GPS" or "NETWORK". Write only.
212 static const char KEY_GPS_PROCESSING_METHOD[];
213 // Current white balance setting.
214 // Example value: "auto" or WHITE_BALANCE_XXX constants. Read/write.
215 static const char KEY_WHITE_BALANCE[];
216 // Supported white balance settings.
217 // Example value: "auto,incandescent,daylight". Read only.
218 static const char KEY_SUPPORTED_WHITE_BALANCE[];
219 // Current color effect setting.
220 // Example value: "none" or EFFECT_XXX constants. Read/write.
221 static const char KEY_EFFECT[];
222 // Supported color effect settings.
223 // Example value: "none,mono,sepia". Read only.
224 static const char KEY_SUPPORTED_EFFECTS[];
225 // Current antibanding setting.
226 // Example value: "auto" or ANTIBANDING_XXX constants. Read/write.
227 static const char KEY_ANTIBANDING[];
228 // Supported antibanding settings.
229 // Example value: "auto,50hz,60hz,off". Read only.
230 static const char KEY_SUPPORTED_ANTIBANDING[];
231 // Current scene mode.
232 // Example value: "auto" or SCENE_MODE_XXX constants. Read/write.
233 static const char KEY_SCENE_MODE[];
234 // Supported scene mode settings.
235 // Example value: "auto,night,fireworks". Read only.
236 static const char KEY_SUPPORTED_SCENE_MODES[];
237 // Current flash mode.
238 // Example value: "auto" or FLASH_MODE_XXX constants. Read/write.
239 static const char KEY_FLASH_MODE[];
240 // Supported flash modes.
241 // Example value: "auto,on,off". Read only.
242 static const char KEY_SUPPORTED_FLASH_MODES[];
243 // Current focus mode. This will not be empty. Applications should call
244 // CameraHardwareInterface.autoFocus to start the focus if focus mode is
245 // FOCUS_MODE_AUTO or FOCUS_MODE_MACRO.
246 // Example value: "auto" or FOCUS_MODE_XXX constants. Read/write.
247 static const char KEY_FOCUS_MODE[];
248 // Supported focus modes.
249 // Example value: "auto,macro,fixed". Read only.
250 static const char KEY_SUPPORTED_FOCUS_MODES[];
251 // The maximum number of focus areas supported. This is the maximum length
252 // of KEY_FOCUS_AREAS.
253 // Example value: "0" or "2". Read only.
254 static const char KEY_MAX_NUM_FOCUS_AREAS[];
255 // Current focus areas.
256 //
257 // Before accessing this parameter, apps should check
258 // KEY_MAX_NUM_FOCUS_AREAS first to know the maximum number of focus areas
259 // first. If the value is 0, focus area is not supported.
260 //
261 // Each focus area is a five-element int array. The first four elements are
262 // the rectangle of the area (left, top, right, bottom). The direction is
263 // relative to the sensor orientation, that is, what the sensor sees. The
264 // direction is not affected by the rotation or mirroring of
265 // CAMERA_CMD_SET_DISPLAY_ORIENTATION. Coordinates range from -1000 to 1000.
266 // (-1000,-1000) is the upper left point. (1000, 1000) is the lower right
267 // point. The width and height of focus areas cannot be 0 or negative.
268 //
269 // The fifth element is the weight. Values for weight must range from 1 to
270 // 1000. The weight should be interpreted as a per-pixel weight - all
271 // pixels in the area have the specified weight. This means a small area
272 // with the same weight as a larger area will have less influence on the
273 // focusing than the larger area. Focus areas can partially overlap and the
274 // driver will add the weights in the overlap region.
275 //
276 // A special case of single focus area (0,0,0,0,0) means driver to decide
277 // the focus area. For example, the driver may use more signals to decide
278 // focus areas and change them dynamically. Apps can set (0,0,0,0,0) if they
279 // want the driver to decide focus areas.
280 //
281 // Focus areas are relative to the current field of view (KEY_ZOOM). No
282 // matter what the zoom level is, (-1000,-1000) represents the top of the
283 // currently visible camera frame. The focus area cannot be set to be
284 // outside the current field of view, even when using zoom.
285 //
286 // Focus area only has effect if the current focus mode is FOCUS_MODE_AUTO,
287 // FOCUS_MODE_MACRO, FOCUS_MODE_CONTINUOUS_VIDEO, or
288 // FOCUS_MODE_CONTINUOUS_PICTURE.
289 // Example value: "(-10,-10,0,0,300),(0,0,10,10,700)". Read/write.
290 static const char KEY_FOCUS_AREAS[];
291 // Focal length in millimeter.
292 // Example value: "4.31". Read only.
293 static const char KEY_FOCAL_LENGTH[];
294 // Horizontal angle of view in degrees.
295 // Example value: "54.8". Read only.
296 static const char KEY_HORIZONTAL_VIEW_ANGLE[];
297 // Vertical angle of view in degrees.
298 // Example value: "42.5". Read only.
299 static const char KEY_VERTICAL_VIEW_ANGLE[];
300 // Exposure compensation index. 0 means exposure is not adjusted.
James Paintere5382062012-09-05 18:02:32 -0700301 // Example value: "-5" or "5". Read/write.
Eino-Ville Talvalac2d64272012-05-15 15:38:27 -0700302 static const char KEY_EXPOSURE_COMPENSATION[];
303 // The maximum exposure compensation index (>=0).
304 // Example value: "6". Read only.
305 static const char KEY_MAX_EXPOSURE_COMPENSATION[];
306 // The minimum exposure compensation index (<=0).
307 // Example value: "-6". Read only.
308 static const char KEY_MIN_EXPOSURE_COMPENSATION[];
309 // The exposure compensation step. Exposure compensation index multiply by
James Paintere5382062012-09-05 18:02:32 -0700310 // step eqals to EV. Ex: if exposure compensation index is -6 and step is
Eino-Ville Talvalac2d64272012-05-15 15:38:27 -0700311 // 0.3333, EV is -2.
312 // Example value: "0.333333333" or "0.5". Read only.
313 static const char KEY_EXPOSURE_COMPENSATION_STEP[];
314 // The state of the auto-exposure lock. "true" means that
315 // auto-exposure is locked to its current value and will not
316 // change. "false" means the auto-exposure routine is free to
317 // change exposure values. If auto-exposure is already locked,
318 // setting this to true again has no effect (the driver will not
319 // recalculate exposure values). Changing exposure compensation
320 // settings will still affect the exposure settings while
321 // auto-exposure is locked. Stopping preview or taking a still
322 // image will not change the lock. In conjunction with
323 // exposure compensation, this allows for capturing multi-exposure
324 // brackets with known relative exposure values. Locking
325 // auto-exposure after open but before the first call to
326 // startPreview may result in severely over- or under-exposed
327 // images. The driver will not change the AE lock after
328 // auto-focus completes.
329 static const char KEY_AUTO_EXPOSURE_LOCK[];
330 // Whether locking the auto-exposure is supported. "true" means it is, and
331 // "false" or this key not existing means it is not supported.
332 static const char KEY_AUTO_EXPOSURE_LOCK_SUPPORTED[];
333 // The state of the auto-white balance lock. "true" means that
334 // auto-white balance is locked to its current value and will not
335 // change. "false" means the auto-white balance routine is free to
336 // change white balance values. If auto-white balance is already
337 // locked, setting this to true again has no effect (the driver
338 // will not recalculate white balance values). Stopping preview or
339 // taking a still image will not change the lock. In conjunction
340 // with exposure compensation, this allows for capturing
341 // multi-exposure brackets with fixed white balance. Locking
342 // auto-white balance after open but before the first call to
343 // startPreview may result in severely incorrect color. The
344 // driver will not change the AWB lock after auto-focus
345 // completes.
346 static const char KEY_AUTO_WHITEBALANCE_LOCK[];
347 // Whether locking the auto-white balance is supported. "true"
348 // means it is, and "false" or this key not existing means it is
349 // not supported.
350 static const char KEY_AUTO_WHITEBALANCE_LOCK_SUPPORTED[];
351
352 // The maximum number of metering areas supported. This is the maximum
353 // length of KEY_METERING_AREAS.
354 // Example value: "0" or "2". Read only.
355 static const char KEY_MAX_NUM_METERING_AREAS[];
356 // Current metering areas. Camera driver uses these areas to decide
357 // exposure.
358 //
359 // Before accessing this parameter, apps should check
360 // KEY_MAX_NUM_METERING_AREAS first to know the maximum number of metering
361 // areas first. If the value is 0, metering area is not supported.
362 //
363 // Each metering area is a rectangle with specified weight. The direction is
364 // relative to the sensor orientation, that is, what the sensor sees. The
365 // direction is not affected by the rotation or mirroring of
366 // CAMERA_CMD_SET_DISPLAY_ORIENTATION. Coordinates of the rectangle range
367 // from -1000 to 1000. (-1000, -1000) is the upper left point. (1000, 1000)
368 // is the lower right point. The width and height of metering areas cannot
369 // be 0 or negative.
370 //
371 // The fifth element is the weight. Values for weight must range from 1 to
372 // 1000. The weight should be interpreted as a per-pixel weight - all
373 // pixels in the area have the specified weight. This means a small area
374 // with the same weight as a larger area will have less influence on the
375 // metering than the larger area. Metering areas can partially overlap and
376 // the driver will add the weights in the overlap region.
377 //
378 // A special case of all-zero single metering area means driver to decide
379 // the metering area. For example, the driver may use more signals to decide
380 // metering areas and change them dynamically. Apps can set all-zero if they
381 // want the driver to decide metering areas.
382 //
383 // Metering areas are relative to the current field of view (KEY_ZOOM).
384 // No matter what the zoom level is, (-1000,-1000) represents the top of the
385 // currently visible camera frame. The metering area cannot be set to be
386 // outside the current field of view, even when using zoom.
387 //
388 // No matter what metering areas are, the final exposure are compensated
389 // by KEY_EXPOSURE_COMPENSATION.
390 // Example value: "(-10,-10,0,0,300),(0,0,10,10,700)". Read/write.
391 static const char KEY_METERING_AREAS[];
392 // Current zoom value.
393 // Example value: "0" or "6". Read/write.
394 static const char KEY_ZOOM[];
395 // Maximum zoom value.
396 // Example value: "6". Read only.
397 static const char KEY_MAX_ZOOM[];
398 // The zoom ratios of all zoom values. The zoom ratio is in 1/100
399 // increments. Ex: a zoom of 3.2x is returned as 320. The number of list
400 // elements is KEY_MAX_ZOOM + 1. The first element is always 100. The last
401 // element is the zoom ratio of zoom value KEY_MAX_ZOOM.
402 // Example value: "100,150,200,250,300,350,400". Read only.
403 static const char KEY_ZOOM_RATIOS[];
404 // Whether zoom is supported. Zoom is supported if the value is "true". Zoom
405 // is not supported if the value is not "true" or the key does not exist.
406 // Example value: "true". Read only.
407 static const char KEY_ZOOM_SUPPORTED[];
408 // Whether if smooth zoom is supported. Smooth zoom is supported if the
409 // value is "true". It is not supported if the value is not "true" or the
410 // key does not exist.
411 // See CAMERA_CMD_START_SMOOTH_ZOOM, CAMERA_CMD_STOP_SMOOTH_ZOOM, and
412 // CAMERA_MSG_ZOOM in frameworks/base/include/camera/Camera.h.
413 // Example value: "true". Read only.
414 static const char KEY_SMOOTH_ZOOM_SUPPORTED[];
415
416 // The distances (in meters) from the camera to where an object appears to
417 // be in focus. The object is sharpest at the optimal focus distance. The
418 // depth of field is the far focus distance minus near focus distance.
419 //
420 // Focus distances may change after starting auto focus, canceling auto
421 // focus, or starting the preview. Applications can read this anytime to get
422 // the latest focus distances. If the focus mode is FOCUS_MODE_CONTINUOUS,
423 // focus distances may change from time to time.
424 //
425 // This is intended to estimate the distance between the camera and the
426 // subject. After autofocus, the subject distance may be within near and far
427 // focus distance. However, the precision depends on the camera hardware,
428 // autofocus algorithm, the focus area, and the scene. The error can be
429 // large and it should be only used as a reference.
430 //
431 // Far focus distance > optimal focus distance > near focus distance. If
432 // the far focus distance is infinity, the value should be "Infinity" (case
433 // sensitive). The format is three float values separated by commas. The
434 // first is near focus distance. The second is optimal focus distance. The
435 // third is far focus distance.
436 // Example value: "0.95,1.9,Infinity" or "0.049,0.05,0.051". Read only.
437 static const char KEY_FOCUS_DISTANCES[];
438
439 // The current dimensions in pixels (width x height) for video frames.
440 // The width and height must be one of the supported sizes retrieved
441 // via KEY_SUPPORTED_VIDEO_SIZES.
442 // Example value: "1280x720". Read/write.
443 static const char KEY_VIDEO_SIZE[];
444 // A list of the supported dimensions in pixels (width x height)
445 // for video frames. See CAMERA_MSG_VIDEO_FRAME for details in
446 // frameworks/base/include/camera/Camera.h.
447 // Example: "176x144,1280x720". Read only.
448 static const char KEY_SUPPORTED_VIDEO_SIZES[];
449
450 // The maximum number of detected faces supported by hardware face
451 // detection. If the value is 0, hardware face detection is not supported.
452 // Example: "5". Read only
453 static const char KEY_MAX_NUM_DETECTED_FACES_HW[];
454
455 // The maximum number of detected faces supported by software face
456 // detection. If the value is 0, software face detection is not supported.
457 // Example: "5". Read only
458 static const char KEY_MAX_NUM_DETECTED_FACES_SW[];
459
460 // Preferred preview frame size in pixels for video recording.
461 // The width and height must be one of the supported sizes retrieved
462 // via KEY_SUPPORTED_PREVIEW_SIZES. This key can be used only when
463 // getSupportedVideoSizes() does not return an empty Vector of Size.
464 // Camcorder applications are recommended to set the preview size
465 // to a value that is not larger than the preferred preview size.
466 // In other words, the product of the width and height of the
467 // preview size should not be larger than that of the preferred
468 // preview size. In addition, we recommend to choos a preview size
469 // that has the same aspect ratio as the resolution of video to be
470 // recorded.
471 // Example value: "800x600". Read only.
472 static const char KEY_PREFERRED_PREVIEW_SIZE_FOR_VIDEO[];
473
474 // The image format for video frames. See CAMERA_MSG_VIDEO_FRAME in
475 // frameworks/base/include/camera/Camera.h.
476 // Example value: "yuv420sp" or PIXEL_FORMAT_XXX constants. Read only.
477 static const char KEY_VIDEO_FRAME_FORMAT[];
478
479 // Sets the hint of the recording mode. If this is true, MediaRecorder.start
480 // may be faster or has less glitches. This should be called before starting
481 // the preview for the best result. But it is allowed to change the hint
482 // while the preview is active. The default value is false.
483 //
484 // The apps can still call Camera.takePicture when the hint is true. The
485 // apps can call MediaRecorder.start when the hint is false. But the
486 // performance may be worse.
487 // Example value: "true" or "false". Read/write.
488 static const char KEY_RECORDING_HINT[];
489
490 // Returns true if video snapshot is supported. That is, applications
491 // can call Camera.takePicture during recording. Applications do not need to
492 // call Camera.startPreview after taking a picture. The preview will be
493 // still active. Other than that, taking a picture during recording is
494 // identical to taking a picture normally. All settings and methods related
495 // to takePicture work identically. Ex: KEY_PICTURE_SIZE,
496 // KEY_SUPPORTED_PICTURE_SIZES, KEY_JPEG_QUALITY, KEY_ROTATION, and etc.
497 // The picture will have an EXIF header. FLASH_MODE_AUTO and FLASH_MODE_ON
498 // also still work, but the video will record the flash.
499 //
500 // Applications can set shutter callback as null to avoid the shutter
501 // sound. It is also recommended to set raw picture and post view callbacks
502 // to null to avoid the interrupt of preview display.
503 //
504 // Field-of-view of the recorded video may be different from that of the
505 // captured pictures.
506 // Example value: "true" or "false". Read only.
507 static const char KEY_VIDEO_SNAPSHOT_SUPPORTED[];
508
509 // The state of the video stabilization. If set to true, both the
510 // preview stream and the recorded video stream are stabilized by
511 // the camera. Only valid to set if KEY_VIDEO_STABILIZATION_SUPPORTED is
512 // set to true.
513 //
514 // The value of this key can be changed any time the camera is
515 // open. If preview or recording is active, it is acceptable for
516 // there to be a slight video glitch when video stabilization is
517 // toggled on and off.
518 //
519 // This only stabilizes video streams (between-frames stabilization), and
520 // has no effect on still image capture.
521 static const char KEY_VIDEO_STABILIZATION[];
522
523 // Returns true if video stabilization is supported. That is, applications
524 // can set KEY_VIDEO_STABILIZATION to true and have a stabilized preview
525 // stream and record stabilized videos.
526 static const char KEY_VIDEO_STABILIZATION_SUPPORTED[];
527
James Paintere5382062012-09-05 18:02:32 -0700528 // Supported modes for special effects with light.
529 // Example values: "lowlight,hdr".
530 static const char KEY_LIGHTFX[];
531
Eino-Ville Talvalac2d64272012-05-15 15:38:27 -0700532 // Value for KEY_ZOOM_SUPPORTED or KEY_SMOOTH_ZOOM_SUPPORTED.
533 static const char TRUE[];
534 static const char FALSE[];
535
536 // Value for KEY_FOCUS_DISTANCES.
537 static const char FOCUS_DISTANCE_INFINITY[];
538
539 // Values for white balance settings.
540 static const char WHITE_BALANCE_AUTO[];
541 static const char WHITE_BALANCE_INCANDESCENT[];
542 static const char WHITE_BALANCE_FLUORESCENT[];
543 static const char WHITE_BALANCE_WARM_FLUORESCENT[];
544 static const char WHITE_BALANCE_DAYLIGHT[];
545 static const char WHITE_BALANCE_CLOUDY_DAYLIGHT[];
546 static const char WHITE_BALANCE_TWILIGHT[];
547 static const char WHITE_BALANCE_SHADE[];
548
549 // Values for effect settings.
550 static const char EFFECT_NONE[];
551 static const char EFFECT_MONO[];
552 static const char EFFECT_NEGATIVE[];
553 static const char EFFECT_SOLARIZE[];
554 static const char EFFECT_SEPIA[];
555 static const char EFFECT_POSTERIZE[];
556 static const char EFFECT_WHITEBOARD[];
557 static const char EFFECT_BLACKBOARD[];
558 static const char EFFECT_AQUA[];
559
560 // Values for antibanding settings.
561 static const char ANTIBANDING_AUTO[];
562 static const char ANTIBANDING_50HZ[];
563 static const char ANTIBANDING_60HZ[];
564 static const char ANTIBANDING_OFF[];
565
566 // Values for flash mode settings.
567 // Flash will not be fired.
568 static const char FLASH_MODE_OFF[];
569 // Flash will be fired automatically when required. The flash may be fired
570 // during preview, auto-focus, or snapshot depending on the driver.
571 static const char FLASH_MODE_AUTO[];
572 // Flash will always be fired during snapshot. The flash may also be
573 // fired during preview or auto-focus depending on the driver.
574 static const char FLASH_MODE_ON[];
575 // Flash will be fired in red-eye reduction mode.
576 static const char FLASH_MODE_RED_EYE[];
577 // Constant emission of light during preview, auto-focus and snapshot.
578 // This can also be used for video recording.
579 static const char FLASH_MODE_TORCH[];
580
581 // Values for scene mode settings.
582 static const char SCENE_MODE_AUTO[];
583 static const char SCENE_MODE_ACTION[];
584 static const char SCENE_MODE_PORTRAIT[];
585 static const char SCENE_MODE_LANDSCAPE[];
586 static const char SCENE_MODE_NIGHT[];
587 static const char SCENE_MODE_NIGHT_PORTRAIT[];
588 static const char SCENE_MODE_THEATRE[];
589 static const char SCENE_MODE_BEACH[];
590 static const char SCENE_MODE_SNOW[];
591 static const char SCENE_MODE_SUNSET[];
592 static const char SCENE_MODE_STEADYPHOTO[];
593 static const char SCENE_MODE_FIREWORKS[];
594 static const char SCENE_MODE_SPORTS[];
595 static const char SCENE_MODE_PARTY[];
596 static const char SCENE_MODE_CANDLELIGHT[];
597 // Applications are looking for a barcode. Camera driver will be optimized
598 // for barcode reading.
599 static const char SCENE_MODE_BARCODE[];
Eino-Ville Talvalac61b2aa2012-09-10 11:59:12 -0700600 // A high-dynamic range mode. In this mode, the HAL module will use a
601 // capture strategy that extends the dynamic range of the captured
602 // image in some fashion. Only the final image is returned.
603 static const char SCENE_MODE_HDR[];
Eino-Ville Talvalac2d64272012-05-15 15:38:27 -0700604
605 // Pixel color formats for KEY_PREVIEW_FORMAT, KEY_PICTURE_FORMAT,
606 // and KEY_VIDEO_FRAME_FORMAT
607 static const char PIXEL_FORMAT_YUV422SP[];
608 static const char PIXEL_FORMAT_YUV420SP[]; // NV21
609 static const char PIXEL_FORMAT_YUV422I[]; // YUY2
610 static const char PIXEL_FORMAT_YUV420P[]; // YV12
611 static const char PIXEL_FORMAT_RGB565[];
612 static const char PIXEL_FORMAT_RGBA8888[];
613 static const char PIXEL_FORMAT_JPEG[];
614 // Raw bayer format used for images, which is 10 bit precision samples
615 // stored in 16 bit words. The filter pattern is RGGB.
616 static const char PIXEL_FORMAT_BAYER_RGGB[];
Eino-Ville Talvalaf6d96962012-07-18 17:50:46 -0700617 // Pixel format is not known to the framework
618 static const char PIXEL_FORMAT_ANDROID_OPAQUE[];
Eino-Ville Talvalac2d64272012-05-15 15:38:27 -0700619
620 // Values for focus mode settings.
621 // Auto-focus mode. Applications should call
622 // CameraHardwareInterface.autoFocus to start the focus in this mode.
623 static const char FOCUS_MODE_AUTO[];
624 // Focus is set at infinity. Applications should not call
625 // CameraHardwareInterface.autoFocus in this mode.
626 static const char FOCUS_MODE_INFINITY[];
627 // Macro (close-up) focus mode. Applications should call
628 // CameraHardwareInterface.autoFocus to start the focus in this mode.
629 static const char FOCUS_MODE_MACRO[];
630 // Focus is fixed. The camera is always in this mode if the focus is not
631 // adjustable. If the camera has auto-focus, this mode can fix the
632 // focus, which is usually at hyperfocal distance. Applications should
633 // not call CameraHardwareInterface.autoFocus in this mode.
634 static const char FOCUS_MODE_FIXED[];
635 // Extended depth of field (EDOF). Focusing is done digitally and
636 // continuously. Applications should not call
637 // CameraHardwareInterface.autoFocus in this mode.
638 static const char FOCUS_MODE_EDOF[];
639 // Continuous auto focus mode intended for video recording. The camera
640 // continuously tries to focus. This is the best choice for video
641 // recording because the focus changes smoothly . Applications still can
642 // call CameraHardwareInterface.takePicture in this mode but the subject may
643 // not be in focus. Auto focus starts when the parameter is set.
644 //
645 // Applications can call CameraHardwareInterface.autoFocus in this mode. The
646 // focus callback will immediately return with a boolean that indicates
647 // whether the focus is sharp or not. The focus position is locked after
648 // autoFocus call. If applications want to resume the continuous focus,
649 // cancelAutoFocus must be called. Restarting the preview will not resume
650 // the continuous autofocus. To stop continuous focus, applications should
651 // change the focus mode to other modes.
652 static const char FOCUS_MODE_CONTINUOUS_VIDEO[];
653 // Continuous auto focus mode intended for taking pictures. The camera
654 // continuously tries to focus. The speed of focus change is more aggressive
655 // than FOCUS_MODE_CONTINUOUS_VIDEO. Auto focus starts when the parameter is
656 // set.
657 //
658 // Applications can call CameraHardwareInterface.autoFocus in this mode. If
659 // the autofocus is in the middle of scanning, the focus callback will
660 // return when it completes. If the autofocus is not scanning, focus
661 // callback will immediately return with a boolean that indicates whether
662 // the focus is sharp or not. The apps can then decide if they want to take
663 // a picture immediately or to change the focus mode to auto, and run a full
664 // autofocus cycle. The focus position is locked after autoFocus call. If
665 // applications want to resume the continuous focus, cancelAutoFocus must be
666 // called. Restarting the preview will not resume the continuous autofocus.
667 // To stop continuous focus, applications should change the focus mode to
668 // other modes.
669 static const char FOCUS_MODE_CONTINUOUS_PICTURE[];
670
James Paintere5382062012-09-05 18:02:32 -0700671 // Values for light special effects
672 // Low-light enhancement mode
673 static const char LIGHTFX_LOWLIGHT[];
674 // High-dynamic range mode
675 static const char LIGHTFX_HDR[];
676
Eino-Ville Talvalac2d64272012-05-15 15:38:27 -0700677private:
678 DefaultKeyedVector<String8,String8> mMap;
679};
680
681}; // namespace android
682
683#endif