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