1 /* 2 * Copyright (C) 2015 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 /** 18 * @addtogroup Camera 19 * @{ 20 */ 21 22 /** 23 * @file NdkCameraMetadata.h 24 */ 25 26 /* 27 * This file defines an NDK API. 28 * Do not remove methods. 29 * Do not change method signatures. 30 * Do not change the value of constants. 31 * Do not change the size of any of the classes defined in here. 32 * Do not reference types that are not part of the NDK. 33 * Do not #include files that aren't part of the NDK. 34 */ 35 36 #ifndef _NDK_CAMERA_METADATA_H 37 #define _NDK_CAMERA_METADATA_H 38 39 #include <stdbool.h> 40 #include <stdint.h> 41 #include <sys/cdefs.h> 42 43 #ifndef __ANDROID_VNDK__ 44 #include "jni.h" 45 #endif /* __ANDROID_VNDK__ */ 46 47 #include "NdkCameraError.h" 48 #include "NdkCameraMetadataTags.h" 49 50 __BEGIN_DECLS 51 52 /** 53 * ACameraMetadata is opaque type that provides access to read-only camera metadata like camera 54 * characteristics (via {@link ACameraManager_getCameraCharacteristics}) or capture results (via 55 * {@link ACameraCaptureSession_captureCallback_result}). 56 */ 57 typedef struct ACameraMetadata ACameraMetadata; 58 59 /** 60 * Possible data types of a metadata entry. 61 * 62 * Keep in sync with system/media/include/system/camera_metadata.h 63 */ 64 enum { 65 /// Unsigned 8-bit integer (uint8_t) 66 ACAMERA_TYPE_BYTE = 0, 67 /// Signed 32-bit integer (int32_t) 68 ACAMERA_TYPE_INT32 = 1, 69 /// 32-bit float (float) 70 ACAMERA_TYPE_FLOAT = 2, 71 /// Signed 64-bit integer (int64_t) 72 ACAMERA_TYPE_INT64 = 3, 73 /// 64-bit float (double) 74 ACAMERA_TYPE_DOUBLE = 4, 75 /// A 64-bit fraction (ACameraMetadata_rational) 76 ACAMERA_TYPE_RATIONAL = 5, 77 /// Number of type fields 78 ACAMERA_NUM_TYPES 79 }; 80 81 /** 82 * Definition of rational data type in {@link ACameraMetadata}. 83 */ 84 typedef struct ACameraMetadata_rational { 85 int32_t numerator; 86 int32_t denominator; 87 } ACameraMetadata_rational; 88 89 /** 90 * A single camera metadata entry. 91 * 92 * <p>Each entry is an array of values, though many metadata fields may only have 1 entry in the 93 * array.</p> 94 */ 95 typedef struct ACameraMetadata_entry { 96 /** 97 * The tag identifying the entry. 98 * 99 * <p> It is one of the values defined in 100 * <a href="https://cs.android.com/android/platform/superproject/+/master:frameworks/av/camera/ndk/include/camera/NdkCameraMetadataTags.h">NdkCameraMetadataTags.h</a> 101 * , and defines how the 102 * entry should be interpreted and which parts of the API provide it. 103 * See <a href="https://cs.android.com/android/platform/superproject/+/master:frameworks/av/camera/ndk/include/camera/NdkCameraMetadataTags.h">NdkCameraMetadataTags.h</a> 104 * for more details. </p> 105 */ 106 uint32_t tag; 107 108 /** 109 * The data type of this metadata entry. 110 * 111 * <p>Must be one of ACAMERA_TYPE_* enum values defined above. A particular tag always has the 112 * same type.</p> 113 */ 114 uint8_t type; 115 116 /** 117 * Count of elements (NOT count of bytes) in this metadata entry. 118 */ 119 uint32_t count; 120 121 /** 122 * Pointer to the data held in this metadata entry. 123 * 124 * <p>The type field above defines which union member pointer is valid. The count field above 125 * defines the length of the data in number of elements.</p> 126 */ 127 union { 128 uint8_t *u8; 129 int32_t *i32; 130 float *f; 131 int64_t *i64; 132 double *d; 133 ACameraMetadata_rational* r; 134 } data; 135 } ACameraMetadata_entry; 136 137 /** 138 * A single read-only camera metadata entry. 139 * 140 * <p>Each entry is an array of values, though many metadata fields may only have 1 entry in the 141 * array.</p> 142 */ 143 typedef struct ACameraMetadata_const_entry { 144 /** 145 * The tag identifying the entry. 146 * 147 * <p> It is one of the values defined in <a href="https://cs.android.com/android/platform/superproject/+/master:frameworks/av/camera/ndk/include/camera/NdkCameraMetadataTags.h">NdkCameraMetadataTags.h</a> 148 * , and defines how the 149 * entry should be interpreted and which parts of the API provide it. 150 * See <a href="https://cs.android.com/android/platform/superproject/+/master:frameworks/av/camera/ndk/include/camera/NdkCameraMetadataTags.h">NdkCameraMetadataTags.h</a> 151 * for more details. </p> 152 */ 153 uint32_t tag; 154 155 /** 156 * The data type of this metadata entry. 157 * 158 * <p>Must be one of ACAMERA_TYPE_* enum values defined above. A particular tag always has the 159 * same type.</p> 160 */ 161 uint8_t type; 162 163 /** 164 * Count of elements (NOT count of bytes) in this metadata entry. 165 */ 166 uint32_t count; 167 168 /** 169 * Pointer to the data held in this metadata entry. 170 * 171 * <p>The type field above defines which union member pointer is valid. The count field above 172 * defines the length of the data in number of elements.</p> 173 */ 174 union { 175 const uint8_t *u8; 176 const int32_t *i32; 177 const float *f; 178 const int64_t *i64; 179 const double *d; 180 const ACameraMetadata_rational* r; 181 } data; 182 } ACameraMetadata_const_entry; 183 184 /** 185 * Get a metadata entry from an input {@link ACameraMetadata}. 186 * 187 * <p>The memory of the data field in the returned entry is managed by camera framework. Do not 188 * attempt to free it.</p> 189 * 190 * @param metadata the {@link ACameraMetadata} of interest. 191 * @param tag the tag value of the camera metadata entry to be get. 192 * @param entry the output {@link ACameraMetadata_const_entry} will be filled here if the method 193 * call succeeds. 194 * 195 * @return <ul> 196 * <li>{@link ACAMERA_OK} if the method call succeeds.</li> 197 * <li>{@link ACAMERA_ERROR_INVALID_PARAMETER} if metadata or entry is NULL.</li> 198 * <li>{@link ACAMERA_ERROR_METADATA_NOT_FOUND} if input metadata does not contain an entry 199 * of input tag value.</li></ul> 200 */ 201 camera_status_t ACameraMetadata_getConstEntry( 202 const ACameraMetadata* metadata, 203 uint32_t tag, /*out*/ACameraMetadata_const_entry* entry) __INTRODUCED_IN(24); 204 205 /** 206 * List all the entry tags in input {@link ACameraMetadata}. 207 * 208 * @param metadata the {@link ACameraMetadata} of interest. 209 * @param numEntries number of metadata entries in input {@link ACameraMetadata} 210 * @param tags the tag values of the metadata entries. Length of tags is returned in numEntries 211 * argument. The memory is managed by ACameraMetadata itself and must NOT be free/delete 212 * by application. Do NOT access tags after calling ACameraMetadata_free. 213 * 214 * @return <ul> 215 * <li>{@link ACAMERA_OK} if the method call succeeds.</li> 216 * <li>{@link ACAMERA_ERROR_INVALID_PARAMETER} if metadata, numEntries or tags is NULL.</li> 217 * <li>{@link ACAMERA_ERROR_UNKNOWN} if the method fails for some other reasons.</li></ul> 218 */ 219 camera_status_t ACameraMetadata_getAllTags( 220 const ACameraMetadata* metadata, 221 /*out*/int32_t* numEntries, /*out*/const uint32_t** tags) __INTRODUCED_IN(24); 222 223 /** 224 * Look up tag ID value for device-specific custom tags that are usable only 225 * for the particular device, by name. The name and type of the tag need to be 226 * discovered from some other source, such as the manufacturer. The ID value is 227 * stable during the lifetime of an application, but should be queried again after 228 * process restarts. This method can also be used to query tag values using the names 229 * for public tags which exist in the Java API, however it is just simpler and faster to 230 * use the values of the tags which exist in the ndk. 231 * @param metadata The {@link ACameraMetadata} of to query the tag value from. 232 * @param name The name of the tag being queried. 233 * @param tag The output tag assigned by this method. 234 * 235 * @return ACAMERA_OK only if the function call was successful. 236 */ 237 238 camera_status_t 239 ACameraMetadata_getTagFromName(const ACameraMetadata* metadata, const char *name, uint32_t *tag) __INTRODUCED_IN(35); 240 241 /** 242 * Create a copy of input {@link ACameraMetadata}. 243 * 244 * <p>The returned ACameraMetadata must be freed by the application by {@link ACameraMetadata_free} 245 * after application is done using it.</p> 246 * 247 * @param src the input {@link ACameraMetadata} to be copied. 248 * 249 * @return a valid ACameraMetadata pointer or NULL if the input metadata cannot be copied. 250 */ 251 ACameraMetadata* ACameraMetadata_copy(const ACameraMetadata* src) __INTRODUCED_IN(24); 252 253 /** 254 * Free a {@link ACameraMetadata} structure. 255 * 256 * @param metadata the {@link ACameraMetadata} to be freed. 257 */ 258 void ACameraMetadata_free(ACameraMetadata* metadata) __INTRODUCED_IN(24); 259 260 /** 261 * Helper function to check if a camera is logical multi-camera. 262 * 263 * <p> Check whether a camera device is a logical multi-camera based on its 264 * static metadata. If it is, also returns its physical sub camera Ids.</p> 265 * 266 * @param staticMetadata the static metadata of the camera being checked. 267 * @param numPhysicalCameras returns the number of physical cameras. 268 * @param physicalCameraIds returns the array of physical camera Ids backing this logical 269 * camera device. Note that this pointer is only valid 270 * during the lifetime of the staticMetadata object. 271 * 272 * @return true if this is a logical multi-camera, false otherwise. 273 */ 274 bool ACameraMetadata_isLogicalMultiCamera(const ACameraMetadata* staticMetadata, 275 /*out*/size_t* numPhysicalCameras, /*out*/const char* const** physicalCameraIds) 276 __INTRODUCED_IN(29); 277 278 #ifndef __ANDROID_VNDK__ 279 280 /** 281 * Return a {@link ACameraMetadata} that references the same data as 282 * <a href="/reference/android/hardware/camera2/CameraMetadata"> 283 * android.hardware.camera2.CameraMetadata</a> from Java API. (e.g., a 284 * <a href="/reference/android/hardware/camera2/CameraCharacteristics"> 285 * android.hardware.camera2.CameraCharacteristics</a> 286 * or <a href="/reference/android/hardware/camera2/CaptureResult"> 287 * android.hardware.camera2.CaptureResult</a>). 288 * 289 * <p>The returned ACameraMetadata must be freed by the application by {@link ACameraMetadata_free} 290 * after application is done using it.</p> 291 * 292 * <p>The ACameraMetadata maintains a reference count to the underlying data, so 293 * it can be used independently of the Java object, and it remains valid even if 294 * the Java metadata is garbage collected. 295 * 296 * @param env the JNI environment. 297 * @param cameraMetadata the source <a href="/reference/android/hardware/camera2/CameraMetadata"> 298 android.hardware.camera2.CameraMetadata </a>from which the 299 * returned {@link ACameraMetadata} is a view. 300 * 301 * @return a valid ACameraMetadata pointer or NULL if cameraMetadata is null or not a valid 302 * instance of <a href="android/hardware/camera2/CameraMetadata"> 303 * android.hardware.camera2.CameraMetadata</a>. 304 * 305 */ 306 ACameraMetadata* ACameraMetadata_fromCameraMetadata(JNIEnv* env, jobject cameraMetadata) 307 __INTRODUCED_IN(30); 308 309 #endif /* __ANDROID_VNDK__ */ 310 311 __END_DECLS 312 313 #endif /* _NDK_CAMERA_METADATA_H */ 314 315 /** @} */ 316