MetaData.h revision 3b5a6b9fa6c6825a1d0b441429e2bb365b259827 
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    kKeyThumbnailTime     = 'thbT',  // int64_t (usecs)
79    kKeyTrackID           = 'trID',
80    kKeyIsDRM             = 'idrm',  // int32_t (bool)
81    kKeyEncoderDelay      = 'encd',  // int32_t (frames)
82    kKeyEncoderPadding    = 'encp',  // int32_t (frames)
83
84    kKeyAlbum             = 'albu',  // cstring
85    kKeyArtist            = 'arti',  // cstring
86    kKeyAlbumArtist       = 'aart',  // cstring
87    kKeyComposer          = 'comp',  // cstring
88    kKeyGenre             = 'genr',  // cstring
89    kKeyTitle             = 'titl',  // cstring
90    kKeyYear              = 'year',  // cstring
91    kKeyAlbumArt          = 'albA',  // compressed image data
92    kKeyAlbumArtMIME      = 'alAM',  // cstring
93    kKeyAuthor            = 'auth',  // cstring
94    kKeyCDTrackNumber     = 'cdtr',  // cstring
95    kKeyDiscNumber        = 'dnum',  // cstring
96    kKeyDate              = 'date',  // cstring
97    kKeyWriter            = 'writ',  // cstring
98    kKeyCompilation       = 'cpil',  // cstring
99    kKeyLocation          = 'loc ',  // cstring
100    kKeyTimeScale         = 'tmsl',  // int32_t
101
102    // video profile and level
103    kKeyVideoProfile      = 'vprf',  // int32_t
104    kKeyVideoLevel        = 'vlev',  // int32_t
105
106    // Set this key to enable authoring files in 64-bit offset
107    kKey64BitFileOffset   = 'fobt',  // int32_t (bool)
108    kKey2ByteNalLength    = '2NAL',  // int32_t (bool)
109
110    // Identify the file output format for authoring
111    // Please see <media/mediarecorder.h> for the supported
112    // file output formats.
113    kKeyFileType          = 'ftyp',  // int32_t
114
115    // Track authoring progress status
116    // kKeyTrackTimeStatus is used to track progress in elapsed time
117    kKeyTrackTimeStatus   = 'tktm',  // int64_t
118
119    kKeyRealTimeRecording = 'rtrc',  // bool (int32_t)
120    kKeyNumBuffers        = 'nbbf',  // int32_t
121
122    // Ogg files can be tagged to be automatically looping...
123    kKeyAutoLoop          = 'autL',  // bool (int32_t)
124
125    kKeyValidSamples      = 'valD',  // int32_t
126
127    kKeyIsUnreadable      = 'unre',  // bool (int32_t)
128
129    // An indication that a video buffer has been rendered.
130    kKeyRendered          = 'rend',  // bool (int32_t)
131
132    // The language code for this media
133    kKeyMediaLanguage     = 'lang',  // cstring
134
135    // To store the timed text format data
136    kKeyTextFormatData    = 'text',  // raw data
137
138    kKeyRequiresSecureBuffers = 'secu',  // bool (int32_t)
139
140    kKeyIsADTS            = 'adts',  // bool (int32_t)
141    kKeyAACAOT            = 'aaot',  // int32_t
142
143    // If a MediaBuffer's data represents (at least partially) encrypted
144    // data, the following fields aid in decryption.
145    // The data can be thought of as pairs of plain and encrypted data
146    // fragments, i.e. plain and encrypted data alternate.
147    // The first fragment is by convention plain data (if that's not the
148    // case, simply specify plain fragment size of 0).
149    // kKeyEncryptedSizes and kKeyPlainSizes each map to an array of
150    // size_t values. The sum total of all size_t values of both arrays
151    // must equal the amount of data (i.e. MediaBuffer's range_length()).
152    // If both arrays are present, they must be of the same size.
153    // If only encrypted sizes are present it is assumed that all
154    // plain sizes are 0, i.e. all fragments are encrypted.
155    // To programmatically set these array, use the MetaData::setData API, i.e.
156    // const size_t encSizes[];
157    // meta->setData(
158    //  kKeyEncryptedSizes, 0 /* type */, encSizes, sizeof(encSizes));
159    // A plain sizes array by itself makes no sense.
160    kKeyEncryptedSizes    = 'encr',  // size_t[]
161    kKeyPlainSizes        = 'plai',  // size_t[]
162    kKeyCryptoKey         = 'cryK',  // uint8_t[16]
163    kKeyCryptoIV          = 'cryI',  // uint8_t[16]
164    kKeyCryptoMode        = 'cryM',  // int32_t
165
166    kKeyCryptoDefaultIVSize = 'cryS',  // int32_t
167
168    kKeyPssh              = 'pssh',  // raw data
169};
170
171enum {
172    kTypeESDS        = 'esds',
173    kTypeAVCC        = 'avcc',
174    kTypeHVCC        = 'hvcc',
175    kTypeD263        = 'd263',
176};
177
178class MetaData : public RefBase {
179public:
180    MetaData();
181    MetaData(const MetaData &from);
182
183    enum Type {
184        TYPE_NONE     = 'none',
185        TYPE_C_STRING = 'cstr',
186        TYPE_INT32    = 'in32',
187        TYPE_INT64    = 'in64',
188        TYPE_FLOAT    = 'floa',
189        TYPE_POINTER  = 'ptr ',
190        TYPE_RECT     = 'rect',
191    };
192
193    void clear();
194    bool remove(uint32_t key);
195
196    bool setCString(uint32_t key, const char *value);
197    bool setInt32(uint32_t key, int32_t value);
198    bool setInt64(uint32_t key, int64_t value);
199    bool setFloat(uint32_t key, float value);
200    bool setPointer(uint32_t key, void *value);
201
202    bool setRect(
203            uint32_t key,
204            int32_t left, int32_t top,
205            int32_t right, int32_t bottom);
206
207    bool findCString(uint32_t key, const char **value);
208    bool findInt32(uint32_t key, int32_t *value);
209    bool findInt64(uint32_t key, int64_t *value);
210    bool findFloat(uint32_t key, float *value);
211    bool findPointer(uint32_t key, void **value);
212
213    bool findRect(
214            uint32_t key,
215            int32_t *left, int32_t *top,
216            int32_t *right, int32_t *bottom);
217
218    bool setData(uint32_t key, uint32_t type, const void *data, size_t size);
219
220    bool findData(uint32_t key, uint32_t *type,
221                  const void **data, size_t *size) const;
222
223    bool hasData(uint32_t key) const;
224
225    void dumpToLog() const;
226
227protected:
228    virtual ~MetaData();
229
230private:
231    struct typed_data {
232        typed_data();
233        ~typed_data();
234
235        typed_data(const MetaData::typed_data &);
236        typed_data &operator=(const MetaData::typed_data &);
237
238        void clear();
239        void setData(uint32_t type, const void *data, size_t size);
240        void getData(uint32_t *type, const void **data, size_t *size) const;
241        String8 asString() const;
242
243    private:
244        uint32_t mType;
245        size_t mSize;
246
247        union {
248            void *ext_data;
249            float reservoir;
250        } u;
251
252        bool usesReservoir() const {
253            return mSize <= sizeof(u.reservoir);
254        }
255
256        void allocateStorage(size_t size);
257        void freeStorage();
258
259        void *storage() {
260            return usesReservoir() ? &u.reservoir : u.ext_data;
261        }
262
263        const void *storage() const {
264            return usesReservoir() ? &u.reservoir : u.ext_data;
265        }
266    };
267
268    struct Rect {
269        int32_t mLeft, mTop, mRight, mBottom;
270    };
271
272    KeyedVector<uint32_t, typed_data> mItems;
273
274    // MetaData &operator=(const MetaData &);
275};
276
277}  // namespace android
278
279#endif  // META_DATA_H_
280