CameraMetadata.h revision fc42642ab78da5fe25bcbea7a568bf880268a9dc
1effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch/* 2effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch * Copyright (C) 2012 The Android Open Source Project 3effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch * 40529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * Licensed under the Apache License, Version 2.0 (the "License"); 50529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * you may not use this file except in compliance with the License. 65f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles) * You may obtain a copy of the License at 703b57e008b61dfcb1fbad3aea950ae0e001748b0Torne (Richard Coles) * 8f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) * http://www.apache.org/licenses/LICENSE-2.0 9a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch * 10a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch * Unless required by applicable law or agreed to in writing, software 11effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch * distributed under the License is distributed on an "AS IS" BASIS, 12effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 130529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * See the License for the specific language governing permissions and 14effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch * limitations under the License. 15010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) */ 16effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch 17effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch#ifndef ANDROID_CLIENT_CAMERA2_CAMERAMETADATA_CPP 18effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch#define ANDROID_CLIENT_CAMERA2_CAMERAMETADATA_CPP 195f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles) 20effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch#include "system/camera_metadata.h" 21effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch#include <utils/String8.h> 220529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch#include <utils/Vector.h> 2346d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) 24effb81e5f8246d0db0270817048dc992db66e9fbBen Murdochnamespace android { 255f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles) 26effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch/** 27effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch * A convenience wrapper around the C-based camera_metadata_t library. 28effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch */ 29effb81e5f8246d0db0270817048dc992db66e9fbBen Murdochclass CameraMetadata { 30effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch public: 31effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch /** Creates an empty object; best used when expecting to acquire contents 3203b57e008b61dfcb1fbad3aea950ae0e001748b0Torne (Richard Coles) * from elsewhere */ 3303b57e008b61dfcb1fbad3aea950ae0e001748b0Torne (Richard Coles) CameraMetadata(); 34effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch /** Creates an object with space for entryCapacity entries, with 355f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles) * dataCapacity extra storage */ 365f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles) CameraMetadata(size_t entryCapacity, size_t dataCapacity = 10); 375f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles) 385f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles) ~CameraMetadata(); 3903b57e008b61dfcb1fbad3aea950ae0e001748b0Torne (Richard Coles) 4003b57e008b61dfcb1fbad3aea950ae0e001748b0Torne (Richard Coles) /** Takes ownership of passed-in buffer */ 4103b57e008b61dfcb1fbad3aea950ae0e001748b0Torne (Richard Coles) CameraMetadata(camera_metadata_t *buffer); 425f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles) /** Clones the metadata */ 435f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles) CameraMetadata(const CameraMetadata &other); 44a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch 45cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) /** 4646d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) * Assignment clones metadata buffer. 4746d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) */ 48effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch CameraMetadata &operator=(const CameraMetadata &other); 49effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch CameraMetadata &operator=(const camera_metadata_t *buffer); 50a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch 5146d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) /** 52a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch * Release a raw metadata buffer to the caller. After this call, 5303b57e008b61dfcb1fbad3aea950ae0e001748b0Torne (Richard Coles) * CameraMetadata no longer references the buffer, and the caller takes 54effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch * responsibility for freeing the raw metadata buffer (using 55f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) * free_camera_metadata()), or for handing it to another CameraMetadata 56f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) * instance. 570529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch */ 580529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch camera_metadata_t* release(); 590529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch 600529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch /** 610529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * Clear the metadata buffer and free all storage used by it 620529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch */ 63cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) void clear(); 64116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch 650529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch /** 660529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * Acquire a raw metadata buffer from the caller. After this call, 670529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * the caller no longer owns the raw buffer, and must not free or manipulate it. 680529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * If CameraMetadata already contains metadata, it is freed. 690529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch */ 700529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch void acquire(camera_metadata_t* buffer); 710529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch 720529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch /** 730529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * Acquires raw buffer from other CameraMetadata object. After the call, the argument 740529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * object no longer has any metadata. 750529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch */ 760529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch void acquire(CameraMetadata &other); 770529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch 780529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch /** 790529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * Append metadata from another CameraMetadata object. 80a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch */ 81effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch status_t append(const CameraMetadata &other); 82effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch 8303b57e008b61dfcb1fbad3aea950ae0e001748b0Torne (Richard Coles) /** 8403b57e008b61dfcb1fbad3aea950ae0e001748b0Torne (Richard Coles) * Number of metadata entries. 85effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch */ 86effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch size_t entryCount() const; 87effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch 88effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch /** 89effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch * Is the buffer empty (no entires) 90effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch */ 91effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch bool isEmpty() const; 92effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch 93effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch /** 94effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch * Sort metadata buffer for faster find 950529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch */ 960529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch status_t sort(); 97 98 /** 99 * Update metadata entry. Will create entry if it doesn't exist already, and 100 * will reallocate the buffer if insufficient space exists. Overloaded for 101 * the various types of valid data. 102 */ 103 status_t update(uint32_t tag, 104 const uint8_t *data, size_t data_count); 105 status_t update(uint32_t tag, 106 const int32_t *data, size_t data_count); 107 status_t update(uint32_t tag, 108 const float *data, size_t data_count); 109 status_t update(uint32_t tag, 110 const int64_t *data, size_t data_count); 111 status_t update(uint32_t tag, 112 const double *data, size_t data_count); 113 status_t update(uint32_t tag, 114 const camera_metadata_rational_t *data, size_t data_count); 115 status_t update(uint32_t tag, 116 const String8 &string); 117 118 template<typename T> 119 status_t update(uint32_t tag, Vector<T> data) { 120 return update(tag, data.array(), data.size()); 121 } 122 123 /** 124 * Check if a metadata entry exists for a given tag id 125 * 126 */ 127 bool exists(uint32_t tag) const; 128 129 /** 130 * Get metadata entry by tag id 131 */ 132 camera_metadata_entry find(uint32_t tag); 133 134 /** 135 * Get metadata entry by tag id, with no editing 136 */ 137 camera_metadata_ro_entry find(uint32_t tag) const; 138 139 /** 140 * Delete metadata entry by tag 141 */ 142 status_t erase(uint32_t tag); 143 144 /** 145 * Dump contents into FD for debugging. The verbosity levels are 146 * 0: Tag entry information only, no data values 147 * 1: Level 0 plus at most 16 data values per entry 148 * 2: All information 149 * 150 * The indentation parameter sets the number of spaces to add to the start 151 * each line of output. 152 */ 153 void dump(int fd, int verbosity = 1, int indentation = 0) const; 154 155 private: 156 camera_metadata_t *mBuffer; 157 158 /** 159 * Check if tag has a given type 160 */ 161 status_t checkType(uint32_t tag, uint8_t expectedType); 162 163 /** 164 * Base update entry method 165 */ 166 status_t update(uint32_t tag, const void *data, size_t data_count); 167 168 /** 169 * Resize metadata buffer if needed by reallocating it and copying it over. 170 */ 171 status_t resizeIfNeeded(size_t extraEntries, size_t extraData); 172 173}; 174 175}; // namespace android 176 177#endif 178