1/*
2 * Copyright (C) 2012 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_SERVERS_CAMERA_CAMERA2METADATA_CPP
18#define ANDROID_SERVERS_CAMERA_CAMERA2METADATA_CPP
19
20#include "system/camera_metadata.h"
21#include <utils/String8.h>
22#include <utils/Vector.h>
23
24namespace android {
25namespace camera2 {
26
27/**
28 * A convenience wrapper around the C-based camera_metadata_t library.
29 */
30class CameraMetadata {
31  public:
32    /** Creates an empty object; best used when expecting to acquire contents
33     * from elsewhere */
34    CameraMetadata();
35    /** Creates an object with space for entryCapacity entries, with
36     * dataCapacity extra storage */
37    CameraMetadata(size_t entryCapacity, size_t dataCapacity = 10);
38
39    ~CameraMetadata();
40
41    /** Takes ownership of passed-in buffer */
42    CameraMetadata(camera_metadata_t *buffer);
43    /** Clones the metadata */
44    CameraMetadata(const CameraMetadata &other);
45
46    /**
47     * Assignment clones metadata buffer.
48     */
49    CameraMetadata &operator=(const CameraMetadata &other);
50    CameraMetadata &operator=(const camera_metadata_t *buffer);
51
52    /**
53     * Release a raw metadata buffer to the caller. After this call,
54     * CameraMetadata no longer references the buffer, and the caller takes
55     * responsibility for freeing the raw metadata buffer (using
56     * free_camera_metadata()), or for handing it to another CameraMetadata
57     * instance.
58     */
59    camera_metadata_t* release();
60
61    /**
62     * Clear the metadata buffer and free all storage used by it
63     */
64    void clear();
65
66    /**
67     * Acquire a raw metadata buffer from the caller. After this call,
68     * the caller no longer owns the raw buffer, and must not free or manipulate it.
69     * If CameraMetadata already contains metadata, it is freed.
70     */
71    void acquire(camera_metadata_t* buffer);
72
73    /**
74     * Acquires raw buffer from other CameraMetadata object. After the call, the argument
75     * object no longer has any metadata.
76     */
77    void acquire(CameraMetadata &other);
78
79    /**
80     * Append metadata from another CameraMetadata object.
81     */
82    status_t append(const CameraMetadata &other);
83
84    /**
85     * Number of metadata entries.
86     */
87    size_t entryCount() const;
88
89    /**
90     * Is the buffer empty (no entires)
91     */
92    bool isEmpty() const;
93
94    /**
95     * Sort metadata buffer for faster find
96     */
97    status_t sort();
98
99    /**
100     * Update metadata entry. Will create entry if it doesn't exist already, and
101     * will reallocate the buffer if insufficient space exists. Overloaded for
102     * the various types of valid data.
103     */
104    status_t update(uint32_t tag,
105            const uint8_t *data, size_t data_count);
106    status_t update(uint32_t tag,
107            const int32_t *data, size_t data_count);
108    status_t update(uint32_t tag,
109            const float *data, size_t data_count);
110    status_t update(uint32_t tag,
111            const int64_t *data, size_t data_count);
112    status_t update(uint32_t tag,
113            const double *data, size_t data_count);
114    status_t update(uint32_t tag,
115            const camera_metadata_rational_t *data, size_t data_count);
116    status_t update(uint32_t tag,
117            const String8 &string);
118
119    template<typename T>
120    status_t update(uint32_t tag, Vector<T> data) {
121        return update(tag, data.array(), data.size());
122    }
123
124    /**
125     * Get metadata entry by tag id
126     */
127    camera_metadata_entry find(uint32_t tag);
128
129    /**
130     * Get metadata entry by tag id, with no editing
131     */
132    camera_metadata_ro_entry find(uint32_t tag) const;
133
134    /**
135     * Delete metadata entry by tag
136     */
137    status_t erase(uint32_t tag);
138
139    /**
140     * Dump contents into FD for debugging. The verbosity levels are
141     * 0: Tag entry information only, no data values
142     * 1: Level 0 plus at most 16 data values per entry
143     * 2: All information
144     *
145     * The indentation parameter sets the number of spaces to add to the start
146     * each line of output.
147     */
148    void dump(int fd, int verbosity = 1, int indentation = 0) const;
149
150  private:
151    camera_metadata_t *mBuffer;
152
153    /**
154     * Check if tag has a given type
155     */
156    status_t checkType(uint32_t tag, uint8_t expectedType);
157
158    /**
159     * Base update entry method
160     */
161    status_t update(uint32_t tag, const void *data, size_t data_count);
162
163    /**
164     * Resize metadata buffer if needed by reallocating it and copying it over.
165     */
166    status_t resizeIfNeeded(size_t extraEntries, size_t extraData);
167
168};
169
170}; // namespace camera2
171}; // namespace android
172
173#endif
174