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