Home | History | Annotate | Download | only in system
      1 /*
      2  * Copyright (C) 2011 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 SYSTEM_CORE_INCLUDE_ANDROID_CAMERA_H
     18 #define SYSTEM_CORE_INCLUDE_ANDROID_CAMERA_H
     19 
     20 #include <stdint.h>
     21 #include <sys/cdefs.h>
     22 #include <sys/types.h>
     23 #include <cutils/native_handle.h>
     24 #include <hardware/hardware.h>
     25 #include <hardware/gralloc.h>
     26 
     27 __BEGIN_DECLS
     28 
     29 /**
     30  * A set of bit masks for specifying how the received preview frames are
     31  * handled before the previewCallback() call.
     32  *
     33  * The least significant 3 bits of an "int" value are used for this purpose:
     34  *
     35  * ..... 0 0 0
     36  *       ^ ^ ^
     37  *       | | |---------> determine whether the callback is enabled or not
     38  *       | |-----------> determine whether the callback is one-shot or not
     39  *       |-------------> determine whether the frame is copied out or not
     40  *
     41  * WARNING: When a frame is sent directly without copying, it is the frame
     42  * receiver's responsiblity to make sure that the frame data won't get
     43  * corrupted by subsequent preview frames filled by the camera. This flag is
     44  * recommended only when copying out data brings significant performance price
     45  * and the handling/processing of the received frame data is always faster than
     46  * the preview frame rate so that data corruption won't occur.
     47  *
     48  * For instance,
     49  * 1. 0x00 disables the callback. In this case, copy out and one shot bits
     50  *    are ignored.
     51  * 2. 0x01 enables a callback without copying out the received frames. A
     52  *    typical use case is the Camcorder application to avoid making costly
     53  *    frame copies.
     54  * 3. 0x05 is enabling a callback with frame copied out repeatedly. A typical
     55  *    use case is the Camera application.
     56  * 4. 0x07 is enabling a callback with frame copied out only once. A typical
     57  *    use case is the Barcode scanner application.
     58  */
     59 
     60 enum {
     61     CAMERA_FRAME_CALLBACK_FLAG_ENABLE_MASK = 0x01,
     62     CAMERA_FRAME_CALLBACK_FLAG_ONE_SHOT_MASK = 0x02,
     63     CAMERA_FRAME_CALLBACK_FLAG_COPY_OUT_MASK = 0x04,
     64     /** Typical use cases */
     65     CAMERA_FRAME_CALLBACK_FLAG_NOOP = 0x00,
     66     CAMERA_FRAME_CALLBACK_FLAG_CAMCORDER = 0x01,
     67     CAMERA_FRAME_CALLBACK_FLAG_CAMERA = 0x05,
     68     CAMERA_FRAME_CALLBACK_FLAG_BARCODE_SCANNER = 0x07
     69 };
     70 
     71 /** msgType in notifyCallback and dataCallback functions */
     72 enum {
     73     CAMERA_MSG_ERROR = 0x0001,            // notifyCallback
     74     CAMERA_MSG_SHUTTER = 0x0002,          // notifyCallback
     75     CAMERA_MSG_FOCUS = 0x0004,            // notifyCallback
     76     CAMERA_MSG_ZOOM = 0x0008,             // notifyCallback
     77     CAMERA_MSG_PREVIEW_FRAME = 0x0010,    // dataCallback
     78     CAMERA_MSG_VIDEO_FRAME = 0x0020,      // data_timestamp_callback
     79     CAMERA_MSG_POSTVIEW_FRAME = 0x0040,   // dataCallback
     80     CAMERA_MSG_RAW_IMAGE = 0x0080,        // dataCallback
     81     CAMERA_MSG_COMPRESSED_IMAGE = 0x0100, // dataCallback
     82     CAMERA_MSG_RAW_IMAGE_NOTIFY = 0x0200, // dataCallback
     83     // Preview frame metadata. This can be combined with
     84     // CAMERA_MSG_PREVIEW_FRAME in dataCallback. For example, the apps can
     85     // request FRAME and METADATA. Or the apps can request only FRAME or only
     86     // METADATA.
     87     CAMERA_MSG_PREVIEW_METADATA = 0x0400, // dataCallback
     88     CAMERA_MSG_ALL_MSGS = 0xFFFF
     89 };
     90 
     91 /** cmdType in sendCommand functions */
     92 enum {
     93     CAMERA_CMD_START_SMOOTH_ZOOM = 1,
     94     CAMERA_CMD_STOP_SMOOTH_ZOOM = 2,
     95 
     96     /**
     97      * Set the clockwise rotation of preview display (setPreviewDisplay) in
     98      * degrees. This affects the preview frames and the picture displayed after
     99      * snapshot. This method is useful for portrait mode applications. Note
    100      * that preview display of front-facing cameras is flipped horizontally
    101      * before the rotation, that is, the image is reflected along the central
    102      * vertical axis of the camera sensor. So the users can see themselves as
    103      * looking into a mirror.
    104      *
    105      * This does not affect the order of byte array of
    106      * CAMERA_MSG_PREVIEW_FRAME, CAMERA_MSG_VIDEO_FRAME,
    107      * CAMERA_MSG_POSTVIEW_FRAME, CAMERA_MSG_RAW_IMAGE, or
    108      * CAMERA_MSG_COMPRESSED_IMAGE. This is allowed to be set during preview
    109      * since API level 14.
    110      */
    111     CAMERA_CMD_SET_DISPLAY_ORIENTATION = 3,
    112 
    113     /**
    114      * cmdType to disable/enable shutter sound. In sendCommand passing arg1 =
    115      * 0 will disable, while passing arg1 = 1 will enable the shutter sound.
    116      */
    117     CAMERA_CMD_ENABLE_SHUTTER_SOUND = 4,
    118 
    119     /* cmdType to play recording sound */
    120     CAMERA_CMD_PLAY_RECORDING_SOUND = 5,
    121 
    122     /**
    123      * Start the face detection. This should be called after preview is started.
    124      * The camera will notify the listener of CAMERA_MSG_FACE and the detected
    125      * faces in the preview frame. The detected faces may be the same as the
    126      * previous ones. Apps should call CAMERA_CMD_STOP_FACE_DETECTION to stop
    127      * the face detection. This method is supported if CameraParameters
    128      * KEY_MAX_NUM_HW_DETECTED_FACES or KEY_MAX_NUM_SW_DETECTED_FACES is
    129      * bigger than 0. Hardware and software face detection should not be running
    130      * at the same time. If the face detection has started, apps should not send
    131      * this again.
    132      *
    133      * In hardware face detection mode, CameraParameters KEY_WHITE_BALANCE,
    134      * KEY_FOCUS_AREAS and KEY_METERING_AREAS have no effect.
    135      *
    136      * arg1 is the face detection type. It can be CAMERA_FACE_DETECTION_HW or
    137      * CAMERA_FACE_DETECTION_SW.
    138      */
    139     CAMERA_CMD_START_FACE_DETECTION = 6,
    140 
    141     /**
    142      * Stop the face detection.
    143      */
    144     CAMERA_CMD_STOP_FACE_DETECTION = 7,
    145 };
    146 
    147 /** camera fatal errors */
    148 enum {
    149     CAMERA_ERROR_UNKNOWN = 1,
    150     CAMERA_ERROR_SERVER_DIED = 100
    151 };
    152 
    153 enum {
    154     /** The facing of the camera is opposite to that of the screen. */
    155     CAMERA_FACING_BACK = 0,
    156     /** The facing of the camera is the same as that of the screen. */
    157     CAMERA_FACING_FRONT = 1
    158 };
    159 
    160 enum {
    161     /** Hardware face detection. It does not use much CPU. */
    162     CAMERA_FACE_DETECTION_HW = 0,
    163     /**
    164      * Software face detection. It uses some CPU. Applications must use
    165      * Camera.setPreviewTexture for preview in this mode.
    166      */
    167     CAMERA_FACE_DETECTION_SW = 1
    168 };
    169 
    170 /**
    171  * The information of a face from camera face detection.
    172  */
    173 typedef struct camera_face {
    174     /**
    175      * Bounds of the face [left, top, right, bottom]. (-1000, -1000) represents
    176      * the top-left of the camera field of view, and (1000, 1000) represents the
    177      * bottom-right of the field of view. The width and height cannot be 0 or
    178      * negative. This is supported by both hardware and software face detection.
    179      *
    180      * The direction is relative to the sensor orientation, that is, what the
    181      * sensor sees. The direction is not affected by the rotation or mirroring
    182      * of CAMERA_CMD_SET_DISPLAY_ORIENTATION.
    183      */
    184     int32_t rect[4];
    185 
    186     /**
    187      * The confidence level of the face. The range is 1 to 100. 100 is the
    188      * highest confidence. This is supported by both hardware and software
    189      * face detection.
    190      */
    191     int32_t score;
    192 
    193     /**
    194      * An unique id per face while the face is visible to the tracker. If
    195      * the face leaves the field-of-view and comes back, it will get a new
    196      * id. If the value is 0, id is not supported.
    197      */
    198     int32_t id;
    199 
    200     /**
    201      * The coordinates of the center of the left eye. The range is -1000 to
    202      * 1000. -2000, -2000 if this is not supported.
    203      */
    204     int32_t left_eye[2];
    205 
    206     /**
    207      * The coordinates of the center of the right eye. The range is -1000 to
    208      * 1000. -2000, -2000 if this is not supported.
    209      */
    210     int32_t right_eye[2];
    211 
    212     /**
    213      * The coordinates of the center of the mouth. The range is -1000 to 1000.
    214      * -2000, -2000 if this is not supported.
    215      */
    216     int32_t mouth[2];
    217 
    218 } camera_face_t;
    219 
    220 /**
    221  * The metadata of the frame data.
    222  */
    223 typedef struct camera_frame_metadata {
    224     /**
    225      * The number of detected faces in the frame.
    226      */
    227     int32_t number_of_faces;
    228 
    229     /**
    230      * An array of the detected faces. The length is number_of_faces.
    231      */
    232     camera_face_t *faces;
    233 } camera_frame_metadata_t;
    234 
    235 __END_DECLS
    236 
    237 #endif /* SYSTEM_CORE_INCLUDE_ANDROID_CAMERA_H */
    238