Parameters.h revision e382ee28709b83264a46b09e8f766c5ef42efa35 
1/*
2 * Copyright (C) 2012 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_SERVERS_CAMERA_CAMERA2PARAMETERS_H
18#define ANDROID_SERVERS_CAMERA_CAMERA2PARAMETERS_H
19
20#include <system/graphics.h>
21
22#include <utils/Errors.h>
23#include <utils/Mutex.h>
24#include <utils/String8.h>
25#include <utils/Vector.h>
26#include <utils/KeyedVector.h>
27#include <camera/CameraParameters.h>
28
29#include "CameraMetadata.h"
30
31namespace android {
32namespace camera2 {
33
34/**
35 * Current camera state; this is the full state of the Camera under the old
36 * camera API (contents of the CameraParameters object in a more-efficient
37 * format, plus other state). The enum values are mostly based off the
38 * corresponding camera2 enums, not the camera1 strings. A few are defined here
39 * if they don't cleanly map to camera2 values.
40 */
41struct Parameters {
42    /**
43     * Parameters and other state
44     */
45    int cameraId;
46    int cameraFacing;
47
48    int previewWidth, previewHeight;
49    int32_t previewFpsRange[2];
50    int previewFps; // deprecated, here only for tracking changes
51    int previewFormat;
52
53    int previewTransform; // set by CAMERA_CMD_SET_DISPLAY_ORIENTATION
54
55    int pictureWidth, pictureHeight;
56
57    int32_t jpegThumbSize[2];
58    int32_t jpegQuality, jpegThumbQuality;
59    int32_t jpegRotation;
60
61    bool gpsEnabled;
62    double gpsCoordinates[3];
63    int64_t gpsTimestamp;
64    String8 gpsProcessingMethod;
65
66    uint8_t wbMode;
67    uint8_t effectMode;
68    uint8_t antibandingMode;
69    uint8_t sceneMode;
70
71    enum flashMode_t {
72        FLASH_MODE_OFF = 0,
73        FLASH_MODE_AUTO,
74        FLASH_MODE_ON,
75        FLASH_MODE_TORCH,
76        FLASH_MODE_RED_EYE = ANDROID_CONTROL_AE_ON_AUTO_FLASH_REDEYE,
77        FLASH_MODE_INVALID = -1
78    } flashMode;
79
80    enum focusMode_t {
81        FOCUS_MODE_AUTO = ANDROID_CONTROL_AF_AUTO,
82        FOCUS_MODE_MACRO = ANDROID_CONTROL_AF_MACRO,
83        FOCUS_MODE_CONTINUOUS_VIDEO = ANDROID_CONTROL_AF_CONTINUOUS_VIDEO,
84        FOCUS_MODE_CONTINUOUS_PICTURE = ANDROID_CONTROL_AF_CONTINUOUS_PICTURE,
85        FOCUS_MODE_EDOF = ANDROID_CONTROL_AF_EDOF,
86        FOCUS_MODE_INFINITY,
87        FOCUS_MODE_FIXED,
88        FOCUS_MODE_INVALID = -1
89    } focusMode;
90
91    struct Area {
92        int left, top, right, bottom;
93        int weight;
94        Area() {}
95        Area(int left, int top, int right, int bottom, int weight):
96                left(left), top(top), right(right), bottom(bottom),
97                weight(weight) {}
98    };
99    Vector<Area> focusingAreas;
100
101    int32_t exposureCompensation;
102    bool autoExposureLock;
103    bool autoWhiteBalanceLock;
104
105    Vector<Area> meteringAreas;
106
107    int zoom;
108
109    int videoWidth, videoHeight;
110
111    bool recordingHint;
112    bool videoStabilization;
113
114    enum lightFxMode_t {
115        LIGHTFX_NONE = 0,
116        LIGHTFX_LOWLIGHT,
117        LIGHTFX_HDR
118    } lightFx;
119
120    CameraParameters params;
121    String8 paramsFlattened;
122
123    // These parameters are also part of the camera API-visible state, but not
124    // directly listed in Camera.Parameters
125    bool storeMetadataInBuffers;
126    bool playShutterSound;
127    bool enableFaceDetect;
128
129    bool enableFocusMoveMessages;
130    int afTriggerCounter;
131    int currentAfTriggerId;
132    bool afInMotion;
133
134    int precaptureTriggerCounter;
135
136    uint32_t previewCallbackFlags;
137    bool previewCallbackOneShot;
138
139    bool zslMode;
140
141    // Overall camera state
142    enum State {
143        DISCONNECTED,
144        STOPPED,
145        WAITING_FOR_PREVIEW_WINDOW,
146        PREVIEW,
147        RECORD,
148        STILL_CAPTURE,
149        VIDEO_SNAPSHOT
150    } state;
151
152    // Number of zoom steps to simulate
153    static const unsigned int NUM_ZOOM_STEPS = 30;
154
155    // Full static camera info, object owned by someone else, such as
156    // Camera2Device.
157    const CameraMetadata *info;
158
159    // Fast-access static device information; this is a subset of the
160    // information available through the staticInfo() method, used for
161    // frequently-accessed values or values that have to be calculated from the
162    // static information.
163    struct DeviceInfo {
164        int32_t arrayWidth;
165        int32_t arrayHeight;
166        uint8_t bestFaceDetectMode;
167        int32_t maxFaces;
168        struct OverrideModes {
169            flashMode_t flashMode;
170            uint8_t     wbMode;
171            focusMode_t focusMode;
172            OverrideModes():
173                    flashMode(FLASH_MODE_INVALID),
174                    wbMode(ANDROID_CONTROL_AWB_OFF),
175                    focusMode(FOCUS_MODE_INVALID) {
176            }
177        };
178        DefaultKeyedVector<uint8_t, OverrideModes> sceneModeOverrides;
179    } fastInfo;
180
181    // Quirks information; these are short-lived flags to enable workarounds for
182    // incomplete HAL implementations
183    struct Quirks {
184        bool triggerAfWithAuto;
185        bool useZslFormat;
186    } quirks;
187
188    /**
189     * Parameter manipulation and setup methods
190     */
191
192    Parameters(int cameraId, int cameraFacing);
193    ~Parameters();
194
195    // Sets up default parameters
196    status_t initialize(const CameraMetadata *info);
197
198    // Build fast-access device static info from static info
199    status_t buildFastInfo();
200    // Query for quirks from static info
201    status_t buildQuirks();
202
203    // Get entry from camera static characteristics information. min/maxCount
204    // are used for error checking the number of values in the entry. 0 for
205    // max/minCount means to do no bounds check in that direction. In case of
206    // error, the entry data pointer is null and the count is 0.
207    camera_metadata_ro_entry_t staticInfo(uint32_t tag,
208            size_t minCount=0, size_t maxCount=0) const;
209
210    // Validate and update camera parameters based on new settings
211    status_t set(const String8 &paramString);
212
213    // Retrieve the current settings
214    String8 get() const;
215
216    // Update passed-in request for common parameters
217    status_t updateRequest(CameraMetadata *request) const;
218
219    // Calculate the crop region rectangle based on current stream sizes
220    struct CropRegion {
221        float left;
222        float top;
223        float width;
224        float height;
225    };
226    CropRegion calculateCropRegion(void) const;
227
228    // Static methods for debugging and converting between camera1 and camera2
229    // parameters
230
231    static const char *getStateName(State state);
232
233    static int formatStringToEnum(const char *format);
234    static const char *formatEnumToString(int format);
235
236    static int wbModeStringToEnum(const char *wbMode);
237    static const char* wbModeEnumToString(uint8_t wbMode);
238    static int effectModeStringToEnum(const char *effectMode);
239    static int abModeStringToEnum(const char *abMode);
240    static int sceneModeStringToEnum(const char *sceneMode);
241    static flashMode_t flashModeStringToEnum(const char *flashMode);
242    static const char* flashModeEnumToString(flashMode_t flashMode);
243    static focusMode_t focusModeStringToEnum(const char *focusMode);
244    static const char* focusModeEnumToString(focusMode_t focusMode);
245    static status_t parseAreas(const char *areasCStr,
246            Vector<Area> *areas);
247    static status_t validateAreas(const Vector<Area> &areas,
248                                  size_t maxRegions);
249    static bool boolFromString(const char *boolStr);
250
251    // Map from camera orientation + facing to gralloc transform enum
252    static int degToTransform(int degrees, bool mirror);
253
254    // API specifies FPS ranges are done in fixed point integer, with LSB = 0.001.
255    // Note that this doesn't apply to the (deprecated) single FPS value.
256    static const int kFpsToApiScale = 1000;
257
258    // Transform between (-1000,-1000)-(1000,1000) normalized coords from camera
259    // API and HAL2 (0,0)-(activePixelArray.width/height) coordinates
260    int arrayXToNormalized(int width) const;
261    int arrayYToNormalized(int height) const;
262    int normalizedXToArray(int x) const;
263    int normalizedYToArray(int y) const;
264};
265
266// This class encapsulates the Parameters class so that it can only be accessed
267// by constructing a Lock object, which locks the SharedParameter's mutex.
268class SharedParameters {
269  public:
270    SharedParameters(int cameraId, int cameraFacing):
271            mParameters(cameraId, cameraFacing) {
272    }
273
274    template<typename S, typename P>
275    class BaseLock {
276      public:
277        BaseLock(S &p):
278                mParameters(p.mParameters),
279                mSharedParameters(p) {
280            mSharedParameters.mLock.lock();
281        }
282
283        ~BaseLock() {
284            mSharedParameters.mLock.unlock();
285        }
286        P &mParameters;
287      private:
288        // Disallow copying, default construction
289        BaseLock();
290        BaseLock(const BaseLock &);
291        BaseLock &operator=(const BaseLock &);
292        S &mSharedParameters;
293    };
294    typedef BaseLock<SharedParameters, Parameters> Lock;
295    typedef BaseLock<const SharedParameters, const Parameters> ReadLock;
296
297    // Access static info, read-only and immutable, so no lock needed
298    camera_metadata_ro_entry_t staticInfo(uint32_t tag,
299            size_t minCount=0, size_t maxCount=0) const {
300        return mParameters.staticInfo(tag, minCount, maxCount);
301    }
302
303    // Only use for dumping or other debugging
304    const Parameters &unsafeAccess() {
305        return mParameters;
306    }
307  private:
308    Parameters mParameters;
309    mutable Mutex mLock;
310};
311
312
313}; // namespace camera2
314}; // namespace android
315
316#endif
317