MetaData.h revision 5892e3e173f20e01956f318ae7dce43d46c5fc1d 
1/*
2 * Copyright (C) 2009 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 META_DATA_H_
18
19#define META_DATA_H_
20
21#include <sys/types.h>
22
23#include <stdint.h>
24
25#include <utils/RefBase.h>
26#include <utils/KeyedVector.h>
27#include <utils/String8.h>
28
29namespace android {
30
31// The following keys map to int32_t data unless indicated otherwise.
32enum {
33    kKeyMIMEType          = 'mime',  // cstring
34    kKeyWidth             = 'widt',  // int32_t, image pixel
35    kKeyHeight            = 'heig',  // int32_t, image pixel
36    kKeyDisplayWidth      = 'dWid',  // int32_t, display/presentation
37    kKeyDisplayHeight     = 'dHgt',  // int32_t, display/presentation
38
39    // a rectangle, if absent assumed to be (0, 0, width - 1, height - 1)
40    kKeyCropRect          = 'crop',
41
42    kKeyRotation          = 'rotA',  // int32_t (angle in degrees)
43    kKeyIFramesInterval   = 'ifiv',  // int32_t
44    kKeyStride            = 'strd',  // int32_t
45    kKeySliceHeight       = 'slht',  // int32_t
46    kKeyChannelCount      = '#chn',  // int32_t
47    kKeyChannelMask       = 'chnm',  // int32_t
48    kKeySampleRate        = 'srte',  // int32_t (audio sampling rate Hz)
49    kKeyFrameRate         = 'frmR',  // int32_t (video frame rate fps)
50    kKeyBitRate           = 'brte',  // int32_t (bps)
51    kKeyESDS              = 'esds',  // raw data
52    kKeyAVCC              = 'avcc',  // raw data
53    kKeyD263              = 'd263',  // raw data
54    kKeyVorbisInfo        = 'vinf',  // raw data
55    kKeyVorbisBooks       = 'vboo',  // raw data
56    kKeyWantsNALFragments = 'NALf',
57    kKeyIsSyncFrame       = 'sync',  // int32_t (bool)
58    kKeyIsCodecConfig     = 'conf',  // int32_t (bool)
59    kKeyTime              = 'time',  // int64_t (usecs)
60    kKeyDecodingTime      = 'decT',  // int64_t (decoding timestamp in usecs)
61    kKeyNTPTime           = 'ntpT',  // uint64_t (ntp-timestamp)
62    kKeyTargetTime        = 'tarT',  // int64_t (usecs)
63    kKeyDriftTime         = 'dftT',  // int64_t (usecs)
64    kKeyAnchorTime        = 'ancT',  // int64_t (usecs)
65    kKeyDuration          = 'dura',  // int64_t (usecs)
66    kKeyColorFormat       = 'colf',
67    kKeyPlatformPrivate   = 'priv',  // pointer
68    kKeyDecoderComponent  = 'decC',  // cstring
69    kKeyBufferID          = 'bfID',
70    kKeyMaxInputSize      = 'inpS',
71    kKeyThumbnailTime     = 'thbT',  // int64_t (usecs)
72    kKeyTrackID           = 'trID',
73    kKeyIsDRM             = 'idrm',  // int32_t (bool)
74    kKeyEncoderDelay      = 'encd',  // int32_t (frames)
75    kKeyEncoderPadding    = 'encp',  // int32_t (frames)
76
77    kKeyAlbum             = 'albu',  // cstring
78    kKeyArtist            = 'arti',  // cstring
79    kKeyAlbumArtist       = 'aart',  // cstring
80    kKeyComposer          = 'comp',  // cstring
81    kKeyGenre             = 'genr',  // cstring
82    kKeyTitle             = 'titl',  // cstring
83    kKeyYear              = 'year',  // cstring
84    kKeyAlbumArt          = 'albA',  // compressed image data
85    kKeyAlbumArtMIME      = 'alAM',  // cstring
86    kKeyAuthor            = 'auth',  // cstring
87    kKeyCDTrackNumber     = 'cdtr',  // cstring
88    kKeyDiscNumber        = 'dnum',  // cstring
89    kKeyDate              = 'date',  // cstring
90    kKeyWriter            = 'writ',  // cstring
91    kKeyCompilation       = 'cpil',  // cstring
92    kKeyLocation          = 'loc ',  // cstring
93    kKeyTimeScale         = 'tmsl',  // int32_t
94
95    // video profile and level
96    kKeyVideoProfile      = 'vprf',  // int32_t
97    kKeyVideoLevel        = 'vlev',  // int32_t
98
99    // Set this key to enable authoring files in 64-bit offset
100    kKey64BitFileOffset   = 'fobt',  // int32_t (bool)
101    kKey2ByteNalLength    = '2NAL',  // int32_t (bool)
102
103    // Identify the file output format for authoring
104    // Please see <media/mediarecorder.h> for the supported
105    // file output formats.
106    kKeyFileType          = 'ftyp',  // int32_t
107
108    // Track authoring progress status
109    // kKeyTrackTimeStatus is used to track progress in elapsed time
110    kKeyTrackTimeStatus   = 'tktm',  // int64_t
111
112    kKeyNotRealTime       = 'ntrt',  // bool (int32_t)
113
114    // Ogg files can be tagged to be automatically looping...
115    kKeyAutoLoop          = 'autL',  // bool (int32_t)
116
117    kKeyValidSamples      = 'valD',  // int32_t
118
119    kKeyIsUnreadable      = 'unre',  // bool (int32_t)
120
121    // An indication that a video buffer has been rendered.
122    kKeyRendered          = 'rend',  // bool (int32_t)
123
124    // The language code for this media
125    kKeyMediaLanguage     = 'lang',  // cstring
126
127    // To store the timed text format data
128    kKeyTextFormatData    = 'text',  // raw data
129
130    kKeyRequiresSecureBuffers = 'secu',  // bool (int32_t)
131
132    kKeyScrambling        = 'scrm',  // int32_t
133    kKeyEMM               = 'emm ',  // raw data
134    kKeyECM               = 'ecm ',  // raw data
135
136    kKeyIsADTS            = 'adts',  // bool (int32_t)
137
138    // If a MediaBuffer's data represents (at least partially) encrypted
139    // data, the following fields aid in decryption.
140    // The data can be thought of as pairs of plain and encrypted data
141    // fragments, i.e. plain and encrypted data alternate.
142    // The first fragment is by convention plain data (if that's not the
143    // case, simply specify plain fragment size of 0).
144    // kKeyEncryptedSizes and kKeyPlainSizes each map to an array of
145    // size_t values. The sum total of all size_t values of both arrays
146    // must equal the amount of data (i.e. MediaBuffer's range_length()).
147    // If both arrays are present, they must be of the same size.
148    // If only encrypted sizes are present it is assumed that all
149    // plain sizes are 0, i.e. all fragments are encrypted.
150    // To programmatically set these array, use the MetaData::setData API, i.e.
151    // const size_t encSizes[];
152    // meta->setData(
153    //  kKeyEncryptedSizes, 0 /* type */, encSizes, sizeof(encSizes));
154    // A plain sizes array by itself makes no sense.
155    kKeyEncryptedSizes    = 'encr',  // size_t[]
156    kKeyPlainSizes        = 'plai',  // size_t[]
157    kKeyCryptoKey         = 'cryK',  // uint8_t[16]
158    kKeyCryptoIV          = 'cryI',  // uint8_t[16]
159};
160
161enum {
162    kTypeESDS        = 'esds',
163    kTypeAVCC        = 'avcc',
164    kTypeD263        = 'd263',
165};
166
167class MetaData : public RefBase {
168public:
169    MetaData();
170    MetaData(const MetaData &from);
171
172    enum Type {
173        TYPE_NONE     = 'none',
174        TYPE_C_STRING = 'cstr',
175        TYPE_INT32    = 'in32',
176        TYPE_INT64    = 'in64',
177        TYPE_FLOAT    = 'floa',
178        TYPE_POINTER  = 'ptr ',
179        TYPE_RECT     = 'rect',
180    };
181
182    void clear();
183    bool remove(uint32_t key);
184
185    bool setCString(uint32_t key, const char *value);
186    bool setInt32(uint32_t key, int32_t value);
187    bool setInt64(uint32_t key, int64_t value);
188    bool setFloat(uint32_t key, float value);
189    bool setPointer(uint32_t key, void *value);
190
191    bool setRect(
192            uint32_t key,
193            int32_t left, int32_t top,
194            int32_t right, int32_t bottom);
195
196    bool findCString(uint32_t key, const char **value);
197    bool findInt32(uint32_t key, int32_t *value);
198    bool findInt64(uint32_t key, int64_t *value);
199    bool findFloat(uint32_t key, float *value);
200    bool findPointer(uint32_t key, void **value);
201
202    bool findRect(
203            uint32_t key,
204            int32_t *left, int32_t *top,
205            int32_t *right, int32_t *bottom);
206
207    bool setData(uint32_t key, uint32_t type, const void *data, size_t size);
208
209    bool findData(uint32_t key, uint32_t *type,
210                  const void **data, size_t *size) const;
211
212    void dumpToLog() const;
213
214protected:
215    virtual ~MetaData();
216
217private:
218    struct typed_data {
219        typed_data();
220        ~typed_data();
221
222        typed_data(const MetaData::typed_data &);
223        typed_data &operator=(const MetaData::typed_data &);
224
225        void clear();
226        void setData(uint32_t type, const void *data, size_t size);
227        void getData(uint32_t *type, const void **data, size_t *size) const;
228        String8 asString() const;
229
230    private:
231        uint32_t mType;
232        size_t mSize;
233
234        union {
235            void *ext_data;
236            float reservoir;
237        } u;
238
239        bool usesReservoir() const {
240            return mSize <= sizeof(u.reservoir);
241        }
242
243        void allocateStorage(size_t size);
244        void freeStorage();
245
246        void *storage() {
247            return usesReservoir() ? &u.reservoir : u.ext_data;
248        }
249
250        const void *storage() const {
251            return usesReservoir() ? &u.reservoir : u.ext_data;
252        }
253    };
254
255    struct Rect {
256        int32_t mLeft, mTop, mRight, mBottom;
257    };
258
259    KeyedVector<uint32_t, typed_data> mItems;
260
261    // MetaData &operator=(const MetaData &);
262};
263
264}  // namespace android
265
266#endif  // META_DATA_H_
267