camera.h revision 9d5bfd35414f2be2f1ea8a2cabee8f407d3e38c0 
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
60enum {
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 */
72enum {
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    // Face metadata. This can be combined with CAMERA_MSG_PREVIEW_FRAME in
84    // dataCallback. For example, the apps can request PREVIEW_FRAME and FACE.
85    // Or the apps can request only PREVIEW_FRAME or only FACE.
86    CAMERA_MSG_METADATA_FACE = 0x0400,    // dataCallback
87    CAMERA_MSG_ALL_MSGS = 0xFFFF
88};
89
90/** cmdType in sendCommand functions */
91enum {
92    CAMERA_CMD_START_SMOOTH_ZOOM = 1,
93    CAMERA_CMD_STOP_SMOOTH_ZOOM = 2,
94
95    /**
96     * Set the clockwise rotation of preview display (setPreviewDisplay) in
97     * degrees. This affects the preview frames and the picture displayed after
98     * snapshot. This method is useful for portrait mode applications. Note
99     * that preview display of front-facing cameras is flipped horizontally
100     * before the rotation, that is, the image is reflected along the central
101     * vertical axis of the camera sensor. So the users can see themselves as
102     * looking into a mirror.
103     *
104     * This does not affect the order of byte array of
105     * CAMERA_MSG_PREVIEW_FRAME, CAMERA_MSG_VIDEO_FRAME,
106     * CAMERA_MSG_POSTVIEW_FRAME, CAMERA_MSG_RAW_IMAGE, or
107     * CAMERA_MSG_COMPRESSED_IMAGE. This is not allowed to be set during
108     * preview
109     */
110    CAMERA_CMD_SET_DISPLAY_ORIENTATION = 3,
111
112    /**
113     * cmdType to disable/enable shutter sound. In sendCommand passing arg1 =
114     * 0 will disable, while passing arg1 = 1 will enable the shutter sound.
115     */
116    CAMERA_CMD_ENABLE_SHUTTER_SOUND = 4,
117
118    /* cmdType to play recording sound */
119    CAMERA_CMD_PLAY_RECORDING_SOUND = 5,
120
121    /**
122     * Start the face detection. This should be called after preview is started.
123     * The camera will notify the listener of CAMERA_MSG_FACE and the detected
124     * faces in the preview frame. The detected faces may be the same as the
125     * previous ones. Apps should call CAMERA_CMD_STOP_FACE_DETECTION to stop
126     * the face detection. This method is supported if CameraParameters
127     * KEY_MAX_NUM_HW_DETECTED_FACES or KEY_MAX_NUM_SW_DETECTED_FACES is
128     * bigger than 0. Hardware and software face detection should not be running
129     * at the same time. If the face detection has started, apps should not send
130     * this again.
131     *
132     * In hardware face detection mode, CameraParameters KEY_WHITE_BALANCE,
133     * KEY_FOCUS_AREAS and KEY_METERING_AREAS have no effect.
134     *
135     * arg1 is the face detection type. It can be CAMERA_FACE_DETECTION_HW or
136     * CAMERA_FACE_DETECTION_SW.
137     */
138    CAMERA_CMD_START_FACE_DETECTION = 6,
139
140    /**
141     * Stop the face detection.
142     */
143    CAMERA_CMD_STOP_FACE_DETECTION = 7,
144};
145
146/** camera fatal errors */
147enum {
148    CAMERA_ERROR_UNKNOWN = 1,
149    CAMERA_ERROR_SERVER_DIED = 100
150};
151
152enum {
153    /** The facing of the camera is opposite to that of the screen. */
154    CAMERA_FACING_BACK = 0,
155    /** The facing of the camera is the same as that of the screen. */
156    CAMERA_FACING_FRONT = 1
157};
158
159enum {
160    /** Hardware face detection. It does not use much CPU. */
161    CAMERA_FACE_DETECTION_HW = 0,
162    /**
163     * Software face detection. It uses some CPU. Applications must use
164     * Camera.setPreviewTexture for preview in this mode.
165     */
166    CAMERA_FACE_DETECTION_SW = 1
167};
168
169/**
170 * The information of a face from camera face detection.
171 */
172typedef struct camera_face {
173    /**
174     * Bounds of the face [left, top, right, bottom]. (-1000, -1000) represents
175     * the top-left of the camera field of view, and (1000, 1000) represents the
176     * bottom-right of the field of view. The width and height cannot be 0 or
177     * negative. This is supported by both hardware and software face detection.
178     *
179     * The direction is relative to the sensor orientation, that is, what the
180     * sensor sees. The direction is not affected by the rotation or mirroring
181     * of CAMERA_CMD_SET_DISPLAY_ORIENTATION.
182     */
183    int rect[4];
184
185    /**
186     * The confidence level of the face. The range is 1 to 100. 100 is the
187     * highest confidence. This is supported by both hardware and software
188     * face detection.
189     */
190    int score;
191
192    /**
193     * An unique id per face while the face is visible to the tracker. If
194     * the face leaves the field-of-view and comes back, it will get a new
195     * id. If the value is 0, id is not supported.
196     */
197    int id;
198
199    /**
200     * The coordinates of the center of the left eye. The range is -1000 to
201     * 1000. -2000, -2000 if this is not supported.
202     */
203    int left_eye[2];
204
205    /**
206     * The coordinates of the center of the right eye. The range is -1000 to
207     * 1000. -2000, -2000 if this is not supported.
208     */
209    int right_eye[2];
210
211    /**
212     * The coordinates of the center of the mouth. The range is -1000 to 1000.
213     * -2000, -2000 if this is not supported.
214     */
215    int mouth[2];
216
217} camera_face_t;
218
219/**
220 * The metadata of the frame data.
221 */
222typedef struct camera_frame_metadata {
223    /**
224     * The number of detected faces in the frame.
225     */
226    int number_of_faces;
227
228    /**
229     * An array of the detected faces. The length is number_of_faces. The list
230     * is sorted by the score. The highest score is the first element.
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