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#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
25class CameraParameters
26{
27public:
28    CameraParameters();
29    CameraParameters(const String8 &params) { unflatten(params); }
30    ~CameraParameters();
31
32    String8 flatten() const;
33    void unflatten(const String8 &params);
34
35    void set(const char *key, const char *value);
36    void set(const char *key, int value);
37    void setFloat(const char *key, float value);
38    const char *get(const char *key) const;
39    int getInt(const char *key) const;
40    float getFloat(const char *key) const;
41
42    void remove(const char *key);
43
44    void setPreviewSize(int width, int height);
45    void getPreviewSize(int *width, int *height) const;
46    void setPreviewFrameRate(int fps);
47    int getPreviewFrameRate() const;
48    void setPreviewFormat(const char *format);
49    const char *getPreviewFormat() const;
50    void setPictureSize(int width, int height);
51    void getPictureSize(int *width, int *height) const;
52    void setPictureFormat(const char *format);
53    const char *getPictureFormat() const;
54
55    void dump() const;
56    status_t dump(int fd, const Vector<String16>& args) const;
57
58    // Parameter keys to communicate between camera application and driver.
59    // The access (read/write, read only, or write only) is viewed from the
60    // perspective of applications, not driver.
61
62    // Preview frame size in pixels (width x height).
63    // Example value: "480x320". Read/Write.
64    static const char KEY_PREVIEW_SIZE[];
65    // Supported preview frame sizes in pixels.
66    // Example value: "800x600,480x320". Read only.
67    static const char KEY_SUPPORTED_PREVIEW_SIZES[];
68    // The image format for preview frames.
69    // Example value: "yuv420sp" or PIXEL_FORMAT_XXX constants. Read/write.
70    static const char KEY_PREVIEW_FORMAT[];
71    // Supported image formats for preview frames.
72    // Example value: "yuv420sp,yuv422i-yuyv". Read only.
73    static const char KEY_SUPPORTED_PREVIEW_FORMATS[];
74    // Number of preview frames per second.
75    // Example value: "15". Read/write.
76    static const char KEY_PREVIEW_FRAME_RATE[];
77    // Supported number of preview frames per second.
78    // Example value: "24,15,10". Read.
79    static const char KEY_SUPPORTED_PREVIEW_FRAME_RATES[];
80    // The dimensions for captured pictures in pixels (width x height).
81    // Example value: "1024x768". Read/write.
82    static const char KEY_PICTURE_SIZE[];
83    // Supported dimensions for captured pictures in pixels.
84    // Example value: "2048x1536,1024x768". Read only.
85    static const char KEY_SUPPORTED_PICTURE_SIZES[];
86    // The image format for captured pictures.
87    // Example value: "jpeg" or PIXEL_FORMAT_XXX constants. Read/write.
88    static const char KEY_PICTURE_FORMAT[];
89    // Supported image formats for captured pictures.
90    // Example value: "jpeg,rgb565". Read only.
91    static const char KEY_SUPPORTED_PICTURE_FORMATS[];
92    // The width (in pixels) of EXIF thumbnail in Jpeg picture.
93    // Example value: "512". Read/write.
94    static const char KEY_JPEG_THUMBNAIL_WIDTH[];
95    // The height (in pixels) of EXIF thumbnail in Jpeg picture.
96    // Example value: "384". Read/write.
97    static const char KEY_JPEG_THUMBNAIL_HEIGHT[];
98    // Supported EXIF thumbnail sizes (width x height). 0x0 means not thumbnail
99    // in EXIF.
100    // Example value: "512x384,320x240,0x0". Read only.
101    static const char KEY_SUPPORTED_JPEG_THUMBNAIL_SIZES[];
102    // The quality of the EXIF thumbnail in Jpeg picture. The range is 1 to 100,
103    // with 100 being the best.
104    // Example value: "90". Read/write.
105    static const char KEY_JPEG_THUMBNAIL_QUALITY[];
106    // Jpeg quality of captured picture. The range is 1 to 100, with 100 being
107    // the best.
108    // Example value: "90". Read/write.
109    static const char KEY_JPEG_QUALITY[];
110    // The orientation of the device in degrees. For example, suppose the
111    // natural position of the device is landscape. If the user takes a picture
112    // in landscape mode in 2048x1536 resolution, the rotation will be set to
113    // "0". If the user rotates the phone 90 degrees clockwise, the rotation
114    // should be set to "90".
115    // The camera driver can set orientation in the EXIF header without rotating
116    // the picture. Or the driver can rotate the picture and the EXIF thumbnail.
117    // If the Jpeg picture is rotated, the orientation in the EXIF header should
118    // be missing or 1 (row #0 is top and column #0 is left side). The driver
119    // should not set default value for this parameter.
120    // Example value: "0" or "90" or "180" or "270". Write only.
121    static const char KEY_ROTATION[];
122    // GPS latitude coordinate. This will be stored in JPEG EXIF header.
123    // Example value: "25.032146". Write only.
124    static const char KEY_GPS_LATITUDE[];
125    // GPS longitude coordinate. This will be stored in JPEG EXIF header.
126    // Example value: "121.564448". Write only.
127    static const char KEY_GPS_LONGITUDE[];
128    // GPS altitude. This will be stored in JPEG EXIF header.
129    // Example value: "21.0". Write only.
130    static const char KEY_GPS_ALTITUDE[];
131    // GPS timestamp (UTC in seconds since January 1, 1970). This should be
132    // stored in JPEG EXIF header.
133    // Example value: "1251192757". Write only.
134    static const char KEY_GPS_TIMESTAMP[];
135    // GPS Processing Method
136    // Example value: "GPS" or "NETWORK". Write only.
137    static const char KEY_GPS_PROCESSING_METHOD[];
138    // Current white balance setting.
139    // Example value: "auto" or WHITE_BALANCE_XXX constants. Read/write.
140    static const char KEY_WHITE_BALANCE[];
141    // Supported white balance settings.
142    // Example value: "auto,incandescent,daylight". Read only.
143    static const char KEY_SUPPORTED_WHITE_BALANCE[];
144    // Current color effect setting.
145    // Example value: "none" or EFFECT_XXX constants. Read/write.
146    static const char KEY_EFFECT[];
147    // Supported color effect settings.
148    // Example value: "none,mono,sepia". Read only.
149    static const char KEY_SUPPORTED_EFFECTS[];
150    // Current antibanding setting.
151    // Example value: "auto" or ANTIBANDING_XXX constants. Read/write.
152    static const char KEY_ANTIBANDING[];
153    // Supported antibanding settings.
154    // Example value: "auto,50hz,60hz,off". Read only.
155    static const char KEY_SUPPORTED_ANTIBANDING[];
156    // Current scene mode.
157    // Example value: "auto" or SCENE_MODE_XXX constants. Read/write.
158    static const char KEY_SCENE_MODE[];
159    // Supported scene mode settings.
160    // Example value: "auto,night,fireworks". Read only.
161    static const char KEY_SUPPORTED_SCENE_MODES[];
162    // Current flash mode.
163    // Example value: "auto" or FLASH_MODE_XXX constants. Read/write.
164    static const char KEY_FLASH_MODE[];
165    // Supported flash modes.
166    // Example value: "auto,on,off". Read only.
167    static const char KEY_SUPPORTED_FLASH_MODES[];
168    // Current focus mode. If the camera does not support auto-focus, the value
169    // should be FOCUS_MODE_FIXED. If the focus mode is not FOCUS_MODE_FIXED or
170    // or FOCUS_MODE_INFINITY, applications should call
171    // CameraHardwareInterface.autoFocus to start the focus.
172    // Example value: "auto" or FOCUS_MODE_XXX constants. Read/write.
173    static const char KEY_FOCUS_MODE[];
174    // Supported focus modes.
175    // Example value: "auto,macro,fixed". Read only.
176    static const char KEY_SUPPORTED_FOCUS_MODES[];
177    // Focal length in millimeter.
178    // Example value: "4.31". Read only.
179    static const char KEY_FOCAL_LENGTH[];
180    // Horizontal angle of view in degrees.
181    // Example value: "54.8". Read only.
182    static const char KEY_HORIZONTAL_VIEW_ANGLE[];
183    // Vertical angle of view in degrees.
184    // Example value: "42.5". Read only.
185    static const char KEY_VERTICAL_VIEW_ANGLE[];
186    // Exposure compensation index. 0 means exposure is not adjusted.
187    // Example value: "0" or "5". Read/write.
188    static const char KEY_EXPOSURE_COMPENSATION[];
189    // The maximum exposure compensation index (>=0).
190    // Example value: "6". Read only.
191    static const char KEY_MAX_EXPOSURE_COMPENSATION[];
192    // The minimum exposure compensation index (<=0).
193    // Example value: "-6". Read only.
194    static const char KEY_MIN_EXPOSURE_COMPENSATION[];
195    // The exposure compensation step. Exposure compensation index multiply by
196    // step eqals to EV. Ex: if exposure compensation index is 6 and step is
197    // 0.3333, EV is -2.
198    // Example value: "0.333333333" or "0.5". Read only.
199    static const char KEY_EXPOSURE_COMPENSATION_STEP[];
200    // Current zoom value.
201    // Example value: "0" or "6". Read/write.
202    static const char KEY_ZOOM[];
203    // Maximum zoom value.
204    // Example value: "6". Read only.
205    static const char KEY_MAX_ZOOM[];
206    // The zoom ratios of all zoom values. The zoom ratio is in 1/100
207    // increments. Ex: a zoom of 3.2x is returned as 320. The number of list
208    // elements is KEY_MAX_ZOOM + 1. The first element is always 100. The last
209    // element is the zoom ratio of zoom value KEY_MAX_ZOOM.
210    // Example value: "100,150,200,250,300,350,400". Read only.
211    static const char KEY_ZOOM_RATIOS[];
212    // Whether zoom is supported. Zoom is supported if the value is "true". Zoom
213    // is not supported if the value is not "true" or the key does not exist.
214    // Example value: "true". Read only.
215    static const char KEY_ZOOM_SUPPORTED[];
216    // Whether if smooth zoom is supported. Smooth zoom is supported if the
217    // value is "true". It is not supported if the value is not "true" or the
218    // key does not exist.
219    // See CAMERA_CMD_START_SMOOTH_ZOOM, CAMERA_CMD_STOP_SMOOTH_ZOOM, and
220    // CAMERA_MSG_ZOOM in frameworks/base/include/camera/Camera.h.
221    // Example value: "true". Read only.
222    static const char KEY_SMOOTH_ZOOM_SUPPORTED[];
223
224    // Value for KEY_ZOOM_SUPPORTED or KEY_SMOOTH_ZOOM_SUPPORTED.
225    static const char TRUE[];
226
227    // Values for white balance settings.
228    static const char WHITE_BALANCE_AUTO[];
229    static const char WHITE_BALANCE_INCANDESCENT[];
230    static const char WHITE_BALANCE_FLUORESCENT[];
231    static const char WHITE_BALANCE_WARM_FLUORESCENT[];
232    static const char WHITE_BALANCE_DAYLIGHT[];
233    static const char WHITE_BALANCE_CLOUDY_DAYLIGHT[];
234    static const char WHITE_BALANCE_TWILIGHT[];
235    static const char WHITE_BALANCE_SHADE[];
236
237    // Values for effect settings.
238    static const char EFFECT_NONE[];
239    static const char EFFECT_MONO[];
240    static const char EFFECT_NEGATIVE[];
241    static const char EFFECT_SOLARIZE[];
242    static const char EFFECT_SEPIA[];
243    static const char EFFECT_POSTERIZE[];
244    static const char EFFECT_WHITEBOARD[];
245    static const char EFFECT_BLACKBOARD[];
246    static const char EFFECT_AQUA[];
247
248    // Values for antibanding settings.
249    static const char ANTIBANDING_AUTO[];
250    static const char ANTIBANDING_50HZ[];
251    static const char ANTIBANDING_60HZ[];
252    static const char ANTIBANDING_OFF[];
253
254    // Values for flash mode settings.
255    // Flash will not be fired.
256    static const char FLASH_MODE_OFF[];
257    // Flash will be fired automatically when required. The flash may be fired
258    // during preview, auto-focus, or snapshot depending on the driver.
259    static const char FLASH_MODE_AUTO[];
260    // Flash will always be fired during snapshot. The flash may also be
261    // fired during preview or auto-focus depending on the driver.
262    static const char FLASH_MODE_ON[];
263    // Flash will be fired in red-eye reduction mode.
264    static const char FLASH_MODE_RED_EYE[];
265    // Constant emission of light during preview, auto-focus and snapshot.
266    // This can also be used for video recording.
267    static const char FLASH_MODE_TORCH[];
268
269    // Values for scene mode settings.
270    static const char SCENE_MODE_AUTO[];
271    static const char SCENE_MODE_ACTION[];
272    static const char SCENE_MODE_PORTRAIT[];
273    static const char SCENE_MODE_LANDSCAPE[];
274    static const char SCENE_MODE_NIGHT[];
275    static const char SCENE_MODE_NIGHT_PORTRAIT[];
276    static const char SCENE_MODE_THEATRE[];
277    static const char SCENE_MODE_BEACH[];
278    static const char SCENE_MODE_SNOW[];
279    static const char SCENE_MODE_SUNSET[];
280    static const char SCENE_MODE_STEADYPHOTO[];
281    static const char SCENE_MODE_FIREWORKS[];
282    static const char SCENE_MODE_SPORTS[];
283    static const char SCENE_MODE_PARTY[];
284    static const char SCENE_MODE_CANDLELIGHT[];
285    // Applications are looking for a barcode. Camera driver will be optimized
286    // for barcode reading.
287    static const char SCENE_MODE_BARCODE[];
288
289    // Formats for setPreviewFormat and setPictureFormat.
290    static const char PIXEL_FORMAT_YUV422SP[];
291    static const char PIXEL_FORMAT_YUV420SP[]; // NV21
292    static const char PIXEL_FORMAT_YUV422I[]; // YUY2
293    static const char PIXEL_FORMAT_RGB565[];
294    static const char PIXEL_FORMAT_JPEG[];
295
296    // Values for focus mode settings.
297    // Auto-focus mode.
298    static const char FOCUS_MODE_AUTO[];
299    // Focus is set at infinity. Applications should not call
300    // CameraHardwareInterface.autoFocus in this mode.
301    static const char FOCUS_MODE_INFINITY[];
302    static const char FOCUS_MODE_MACRO[];
303    // Focus is fixed. The camera is always in this mode if the focus is not
304    // adjustable. If the camera has auto-focus, this mode can fix the
305    // focus, which is usually at hyperfocal distance. Applications should
306    // not call CameraHardwareInterface.autoFocus in this mode.
307    static const char FOCUS_MODE_FIXED[];
308    // Extended depth of field (EDOF). Focusing is done digitally and
309    // continuously. Applications should not call
310    // CameraHardwareInterface.autoFocus in this mode.
311    static const char FOCUS_MODE_EDOF[];
312
313private:
314    DefaultKeyedVector<String8,String8>    mMap;
315};
316
317}; // namespace android
318
319#endif
320