Parameters.h revision 7d2a4aaaf5691ee523fc0d03c286620f392ed16f 
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    // For use with triggerAfWithAuto quirk
92    focusMode_t shadowFocusMode;
93
94    struct Area {
95        int left, top, right, bottom;
96        int weight;
97        Area() {}
98        Area(int left, int top, int right, int bottom, int weight):
99                left(left), top(top), right(right), bottom(bottom),
100                weight(weight) {}
101    };
102    Vector<Area> focusingAreas;
103
104    int32_t exposureCompensation;
105    bool autoExposureLock;
106    bool autoWhiteBalanceLock;
107
108    Vector<Area> meteringAreas;
109
110    int zoom;
111
112    int videoWidth, videoHeight;
113
114    bool recordingHint;
115    bool videoStabilization;
116
117    enum lightFxMode_t {
118        LIGHTFX_NONE = 0,
119        LIGHTFX_LOWLIGHT,
120        LIGHTFX_HDR
121    } lightFx;
122
123    CameraParameters params;
124    String8 paramsFlattened;
125
126    // These parameters are also part of the camera API-visible state, but not
127    // directly listed in Camera.Parameters
128    bool storeMetadataInBuffers;
129    bool playShutterSound;
130    bool enableFaceDetect;
131
132    bool enableFocusMoveMessages;
133    int afTriggerCounter;
134    int currentAfTriggerId;
135    bool afInMotion;
136
137    int precaptureTriggerCounter;
138
139    uint32_t previewCallbackFlags;
140    bool previewCallbackOneShot;
141
142    bool zslMode;
143
144    // Overall camera state
145    enum State {
146        DISCONNECTED,
147        STOPPED,
148        WAITING_FOR_PREVIEW_WINDOW,
149        PREVIEW,
150        RECORD,
151        STILL_CAPTURE,
152        VIDEO_SNAPSHOT
153    } state;
154
155    // Number of zoom steps to simulate
156    static const unsigned int NUM_ZOOM_STEPS = 30;
157
158    // Full static camera info, object owned by someone else, such as
159    // Camera2Device.
160    const CameraMetadata *info;
161
162    // Fast-access static device information; this is a subset of the
163    // information available through the staticInfo() method, used for
164    // frequently-accessed values or values that have to be calculated from the
165    // static information.
166    struct DeviceInfo {
167        int32_t arrayWidth;
168        int32_t arrayHeight;
169        uint8_t bestFaceDetectMode;
170        int32_t maxFaces;
171        struct OverrideModes {
172            flashMode_t flashMode;
173            uint8_t     wbMode;
174            focusMode_t focusMode;
175            OverrideModes():
176                    flashMode(FLASH_MODE_INVALID),
177                    wbMode(ANDROID_CONTROL_AWB_OFF),
178                    focusMode(FOCUS_MODE_INVALID) {
179            }
180        };
181        DefaultKeyedVector<uint8_t, OverrideModes> sceneModeOverrides;
182    } fastInfo;
183
184    // Quirks information; these are short-lived flags to enable workarounds for
185    // incomplete HAL implementations
186    struct Quirks {
187        bool triggerAfWithAuto;
188        bool useZslFormat;
189        bool meteringCropRegion;
190    } quirks;
191
192    /**
193     * Parameter manipulation and setup methods
194     */
195
196    Parameters(int cameraId, int cameraFacing);
197    ~Parameters();
198
199    // Sets up default parameters
200    status_t initialize(const CameraMetadata *info);
201
202    // Build fast-access device static info from static info
203    status_t buildFastInfo();
204    // Query for quirks from static info
205    status_t buildQuirks();
206
207    // Get entry from camera static characteristics information. min/maxCount
208    // are used for error checking the number of values in the entry. 0 for
209    // max/minCount means to do no bounds check in that direction. In case of
210    // error, the entry data pointer is null and the count is 0.
211    camera_metadata_ro_entry_t staticInfo(uint32_t tag,
212            size_t minCount=0, size_t maxCount=0) const;
213
214    // Validate and update camera parameters based on new settings
215    status_t set(const String8 &paramString);
216
217    // Retrieve the current settings
218    String8 get() const;
219
220    // Update passed-in request for common parameters
221    status_t updateRequest(CameraMetadata *request) const;
222
223    // Add/update JPEG entries in metadata
224    status_t updateRequestJpeg(CameraMetadata *request) const;
225
226    // Calculate the crop region rectangle based on current stream sizes
227    struct CropRegion {
228        float left;
229        float top;
230        float width;
231        float height;
232
233        enum Outputs {
234            OUTPUT_PREVIEW         = 0x01,
235            OUTPUT_VIDEO           = 0x02,
236            OUTPUT_JPEG_THUMBNAIL  = 0x04,
237            OUTPUT_PICTURE         = 0x08,
238        };
239    };
240    CropRegion calculateCropRegion(CropRegion::Outputs outputs) const;
241
242    // Static methods for debugging and converting between camera1 and camera2
243    // parameters
244
245    static const char *getStateName(State state);
246
247    static int formatStringToEnum(const char *format);
248    static const char *formatEnumToString(int format);
249
250    static int wbModeStringToEnum(const char *wbMode);
251    static const char* wbModeEnumToString(uint8_t wbMode);
252    static int effectModeStringToEnum(const char *effectMode);
253    static int abModeStringToEnum(const char *abMode);
254    static int sceneModeStringToEnum(const char *sceneMode);
255    static flashMode_t flashModeStringToEnum(const char *flashMode);
256    static const char* flashModeEnumToString(flashMode_t flashMode);
257    static focusMode_t focusModeStringToEnum(const char *focusMode);
258    static const char* focusModeEnumToString(focusMode_t focusMode);
259    static status_t parseAreas(const char *areasCStr,
260            Vector<Area> *areas);
261
262    enum AreaKind
263    {
264        AREA_KIND_FOCUS,
265        AREA_KIND_METERING
266    };
267    status_t validateAreas(const Vector<Area> &areas,
268                                  size_t maxRegions,
269                                  AreaKind areaKind) const;
270    static bool boolFromString(const char *boolStr);
271
272    // Map from camera orientation + facing to gralloc transform enum
273    static int degToTransform(int degrees, bool mirror);
274
275    // API specifies FPS ranges are done in fixed point integer, with LSB = 0.001.
276    // Note that this doesn't apply to the (deprecated) single FPS value.
277    static const int kFpsToApiScale = 1000;
278
279    // Transform between (-1000,-1000)-(1000,1000) normalized coords from camera
280    // API and HAL2 (0,0)-(activePixelArray.width/height) coordinates
281    int arrayXToNormalized(int width) const;
282    int arrayYToNormalized(int height) const;
283    int normalizedXToArray(int x) const;
284    int normalizedYToArray(int y) const;
285
286    struct Range {
287        int min;
288        int max;
289    };
290
291    int32_t fpsFromRange(int32_t min, int32_t max) const;
292
293private:
294
295    // Convert between HAL2 sensor array coordinates and
296    // viewfinder crop-region relative array coordinates
297    int cropXToArray(int x) const;
298    int cropYToArray(int y) const;
299    int arrayXToCrop(int x) const;
300    int arrayYToCrop(int y) const;
301
302    // Convert between viewfinder crop-region relative array coordinates
303    // and camera API (-1000,1000)-(1000,1000) normalized coords
304    int cropXToNormalized(int x) const;
305    int cropYToNormalized(int y) const;
306    int normalizedXToCrop(int x) const;
307    int normalizedYToCrop(int y) const;
308};
309
310// This class encapsulates the Parameters class so that it can only be accessed
311// by constructing a Lock object, which locks the SharedParameter's mutex.
312class SharedParameters {
313  public:
314    SharedParameters(int cameraId, int cameraFacing):
315            mParameters(cameraId, cameraFacing) {
316    }
317
318    template<typename S, typename P>
319    class BaseLock {
320      public:
321        BaseLock(S &p):
322                mParameters(p.mParameters),
323                mSharedParameters(p) {
324            mSharedParameters.mLock.lock();
325        }
326
327        ~BaseLock() {
328            mSharedParameters.mLock.unlock();
329        }
330        P &mParameters;
331      private:
332        // Disallow copying, default construction
333        BaseLock();
334        BaseLock(const BaseLock &);
335        BaseLock &operator=(const BaseLock &);
336        S &mSharedParameters;
337    };
338    typedef BaseLock<SharedParameters, Parameters> Lock;
339    typedef BaseLock<const SharedParameters, const Parameters> ReadLock;
340
341    // Access static info, read-only and immutable, so no lock needed
342    camera_metadata_ro_entry_t staticInfo(uint32_t tag,
343            size_t minCount=0, size_t maxCount=0) const {
344        return mParameters.staticInfo(tag, minCount, maxCount);
345    }
346
347    // Only use for dumping or other debugging
348    const Parameters &unsafeAccess() {
349        return mParameters;
350    }
351  private:
352    Parameters mParameters;
353    mutable Mutex mLock;
354};
355
356
357}; // namespace camera2
358}; // namespace android
359
360#endif
361