• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 
29 namespace android {
30 
31 // The following keys map to int32_t data unless indicated otherwise.
32 enum {
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     kKeyD263              = 'd263',  // raw data
57     kKeyVorbisInfo        = 'vinf',  // raw data
58     kKeyVorbisBooks       = 'vboo',  // raw data
59     kKeyWantsNALFragments = 'NALf',
60     kKeyIsSyncFrame       = 'sync',  // int32_t (bool)
61     kKeyIsCodecConfig     = 'conf',  // int32_t (bool)
62     kKeyTime              = 'time',  // int64_t (usecs)
63     kKeyDecodingTime      = 'decT',  // int64_t (decoding timestamp in usecs)
64     kKeyNTPTime           = 'ntpT',  // uint64_t (ntp-timestamp)
65     kKeyTargetTime        = 'tarT',  // int64_t (usecs)
66     kKeyDriftTime         = 'dftT',  // int64_t (usecs)
67     kKeyAnchorTime        = 'ancT',  // int64_t (usecs)
68     kKeyDuration          = 'dura',  // int64_t (usecs)
69     kKeyColorFormat       = 'colf',
70     kKeyPlatformPrivate   = 'priv',  // pointer
71     kKeyDecoderComponent  = 'decC',  // cstring
72     kKeyBufferID          = 'bfID',
73     kKeyMaxInputSize      = 'inpS',
74     kKeyThumbnailTime     = 'thbT',  // int64_t (usecs)
75     kKeyTrackID           = 'trID',
76     kKeyIsDRM             = 'idrm',  // int32_t (bool)
77     kKeyEncoderDelay      = 'encd',  // int32_t (frames)
78     kKeyEncoderPadding    = 'encp',  // int32_t (frames)
79 
80     kKeyAlbum             = 'albu',  // cstring
81     kKeyArtist            = 'arti',  // cstring
82     kKeyAlbumArtist       = 'aart',  // cstring
83     kKeyComposer          = 'comp',  // cstring
84     kKeyGenre             = 'genr',  // cstring
85     kKeyTitle             = 'titl',  // cstring
86     kKeyYear              = 'year',  // cstring
87     kKeyAlbumArt          = 'albA',  // compressed image data
88     kKeyAlbumArtMIME      = 'alAM',  // cstring
89     kKeyAuthor            = 'auth',  // cstring
90     kKeyCDTrackNumber     = 'cdtr',  // cstring
91     kKeyDiscNumber        = 'dnum',  // cstring
92     kKeyDate              = 'date',  // cstring
93     kKeyWriter            = 'writ',  // cstring
94     kKeyCompilation       = 'cpil',  // cstring
95     kKeyLocation          = 'loc ',  // cstring
96     kKeyTimeScale         = 'tmsl',  // int32_t
97 
98     // video profile and level
99     kKeyVideoProfile      = 'vprf',  // int32_t
100     kKeyVideoLevel        = 'vlev',  // int32_t
101 
102     // Set this key to enable authoring files in 64-bit offset
103     kKey64BitFileOffset   = 'fobt',  // int32_t (bool)
104     kKey2ByteNalLength    = '2NAL',  // int32_t (bool)
105 
106     // Identify the file output format for authoring
107     // Please see <media/mediarecorder.h> for the supported
108     // file output formats.
109     kKeyFileType          = 'ftyp',  // int32_t
110 
111     // Track authoring progress status
112     // kKeyTrackTimeStatus is used to track progress in elapsed time
113     kKeyTrackTimeStatus   = 'tktm',  // int64_t
114 
115     kKeyRealTimeRecording = 'rtrc',  // bool (int32_t)
116     kKeyNumBuffers        = 'nbbf',  // int32_t
117 
118     // Ogg files can be tagged to be automatically looping...
119     kKeyAutoLoop          = 'autL',  // bool (int32_t)
120 
121     kKeyValidSamples      = 'valD',  // int32_t
122 
123     kKeyIsUnreadable      = 'unre',  // bool (int32_t)
124 
125     // An indication that a video buffer has been rendered.
126     kKeyRendered          = 'rend',  // bool (int32_t)
127 
128     // The language code for this media
129     kKeyMediaLanguage     = 'lang',  // cstring
130 
131     // To store the timed text format data
132     kKeyTextFormatData    = 'text',  // raw data
133 
134     kKeyRequiresSecureBuffers = 'secu',  // bool (int32_t)
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     kKeyCryptoMode        = 'cryM',  // int32_t
160 
161     kKeyCryptoDefaultIVSize = 'cryS',  // int32_t
162 
163     kKeyPssh              = 'pssh',  // raw data
164 };
165 
166 enum {
167     kTypeESDS        = 'esds',
168     kTypeAVCC        = 'avcc',
169     kTypeD263        = 'd263',
170 };
171 
172 class MetaData : public RefBase {
173 public:
174     MetaData();
175     MetaData(const MetaData &from);
176 
177     enum Type {
178         TYPE_NONE     = 'none',
179         TYPE_C_STRING = 'cstr',
180         TYPE_INT32    = 'in32',
181         TYPE_INT64    = 'in64',
182         TYPE_FLOAT    = 'floa',
183         TYPE_POINTER  = 'ptr ',
184         TYPE_RECT     = 'rect',
185     };
186 
187     void clear();
188     bool remove(uint32_t key);
189 
190     bool setCString(uint32_t key, const char *value);
191     bool setInt32(uint32_t key, int32_t value);
192     bool setInt64(uint32_t key, int64_t value);
193     bool setFloat(uint32_t key, float value);
194     bool setPointer(uint32_t key, void *value);
195 
196     bool setRect(
197             uint32_t key,
198             int32_t left, int32_t top,
199             int32_t right, int32_t bottom);
200 
201     bool findCString(uint32_t key, const char **value);
202     bool findInt32(uint32_t key, int32_t *value);
203     bool findInt64(uint32_t key, int64_t *value);
204     bool findFloat(uint32_t key, float *value);
205     bool findPointer(uint32_t key, void **value);
206 
207     bool findRect(
208             uint32_t key,
209             int32_t *left, int32_t *top,
210             int32_t *right, int32_t *bottom);
211 
212     bool setData(uint32_t key, uint32_t type, const void *data, size_t size);
213 
214     bool findData(uint32_t key, uint32_t *type,
215                   const void **data, size_t *size) const;
216 
217     void dumpToLog() const;
218 
219 protected:
220     virtual ~MetaData();
221 
222 private:
223     struct typed_data {
224         typed_data();
225         ~typed_data();
226 
227         typed_data(const MetaData::typed_data &);
228         typed_data &operator=(const MetaData::typed_data &);
229 
230         void clear();
231         void setData(uint32_t type, const void *data, size_t size);
232         void getData(uint32_t *type, const void **data, size_t *size) const;
233         String8 asString() const;
234 
235     private:
236         uint32_t mType;
237         size_t mSize;
238 
239         union {
240             void *ext_data;
241             float reservoir;
242         } u;
243 
usesReservoirtyped_data244         bool usesReservoir() const {
245             return mSize <= sizeof(u.reservoir);
246         }
247 
248         void allocateStorage(size_t size);
249         void freeStorage();
250 
storagetyped_data251         void *storage() {
252             return usesReservoir() ? &u.reservoir : u.ext_data;
253         }
254 
storagetyped_data255         const void *storage() const {
256             return usesReservoir() ? &u.reservoir : u.ext_data;
257         }
258     };
259 
260     struct Rect {
261         int32_t mLeft, mTop, mRight, mBottom;
262     };
263 
264     KeyedVector<uint32_t, typed_data> mItems;
265 
266     // MetaData &operator=(const MetaData &);
267 };
268 
269 }  // namespace android
270 
271 #endif  // META_DATA_H_
272