MetaData.h revision a9741a9232c81eaf59179acef91f5be46c42264e 
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
28namespace android {
29
30// The following keys map to int32_t data unless indicated otherwise.
31enum {
32    kKeyMIMEType          = 'mime',  // cstring
33    kKeyWidth             = 'widt',  // int32_t
34    kKeyHeight            = 'heig',  // int32_t
35    kKeyIFramesInterval   = 'ifiv',  // int32_t
36    kKeyStride            = 'strd',  // int32_t
37    kKeySliceHeight       = 'slht',  // int32_t
38    kKeyChannelCount      = '#chn',  // int32_t
39    kKeySampleRate        = 'srte',  // int32_t (also video frame rate)
40    kKeyBitRate           = 'brte',  // int32_t (bps)
41    kKeyESDS              = 'esds',  // raw data
42    kKeyAVCC              = 'avcc',  // raw data
43    kKeyVorbisInfo        = 'vinf',  // raw data
44    kKeyVorbisBooks       = 'vboo',  // raw data
45    kKeyWantsNALFragments = 'NALf',
46    kKeyIsSyncFrame       = 'sync',  // int32_t (bool)
47    kKeyIsCodecConfig     = 'conf',  // int32_t (bool)
48    kKeyTime              = 'time',  // int64_t (usecs)
49    kKeyNTPTime           = 'ntpT',  // uint64_t (ntp-timestamp)
50    kKeyTargetTime        = 'tarT',  // int64_t (usecs)
51    kKeyDriftTime         = 'dftT',  // int64_t (usecs)
52    kKeyAnchorTime        = 'ancT',  // int64_t (usecs)
53    kKeyDuration          = 'dura',  // int64_t (usecs)
54    kKeyColorFormat       = 'colf',
55    kKeyPlatformPrivate   = 'priv',  // pointer
56    kKeyDecoderComponent  = 'decC',  // cstring
57    kKeyBufferID          = 'bfID',
58    kKeyMaxInputSize      = 'inpS',
59    kKeyThumbnailTime     = 'thbT',  // int64_t (usecs)
60    kKeyTrackID           = 'trID',
61    kKeyIsDRM             = 'idrm',  // int32_t (bool)
62
63    kKeyAlbum             = 'albu',  // cstring
64    kKeyArtist            = 'arti',  // cstring
65    kKeyAlbumArtist       = 'aart',  // cstring
66    kKeyComposer          = 'comp',  // cstring
67    kKeyGenre             = 'genr',  // cstring
68    kKeyTitle             = 'titl',  // cstring
69    kKeyYear              = 'year',  // cstring
70    kKeyAlbumArt          = 'albA',  // compressed image data
71    kKeyAlbumArtMIME      = 'alAM',  // cstring
72    kKeyAuthor            = 'auth',  // cstring
73    kKeyCDTrackNumber     = 'cdtr',  // cstring
74    kKeyDiscNumber        = 'dnum',  // cstring
75    kKeyDate              = 'date',  // cstring
76    kKeyWriter            = 'writ',  // cstring
77    kKeyTimeScale         = 'tmsl',  // int32_t
78
79    // video profile and level
80    kKeyVideoProfile      = 'vprf',  // int32_t
81    kKeyVideoLevel        = 'vlev',  // int32_t
82
83    // Set this key to enable authoring files in 64-bit offset
84    kKey64BitFileOffset   = 'fobt',  // int32_t (bool)
85    kKey2ByteNalLength    = '2NAL',  // int32_t (bool)
86
87    // Identify the file output format for authoring
88    // Please see <media/mediarecorder.h> for the supported
89    // file output formats.
90    kKeyFileType          = 'ftyp',  // int32_t
91
92    // Track authoring progress status
93    // kKeyTrackTimeStatus is used to track progress in elapsed time
94    kKeyTrackTimeStatus   = 'tktm',  // int64_t
95
96    kKeyNotRealTime       = 'ntrt',  // bool (int32_t)
97
98    // Ogg files can be tagged to be automatically looping...
99    kKeyAutoLoop          = 'autL',  // bool (int32_t)
100
101    kKeyValidSamples      = 'valD',  // int32_t
102
103    kKeyIsUnreadable      = 'unre',  // bool (int32_t)
104};
105
106enum {
107    kTypeESDS        = 'esds',
108    kTypeAVCC        = 'avcc',
109};
110
111class MetaData : public RefBase {
112public:
113    MetaData();
114    MetaData(const MetaData &from);
115
116    enum Type {
117        TYPE_NONE     = 'none',
118        TYPE_C_STRING = 'cstr',
119        TYPE_INT32    = 'in32',
120        TYPE_INT64    = 'in64',
121        TYPE_FLOAT    = 'floa',
122        TYPE_POINTER  = 'ptr ',
123    };
124
125    void clear();
126    bool remove(uint32_t key);
127
128    bool setCString(uint32_t key, const char *value);
129    bool setInt32(uint32_t key, int32_t value);
130    bool setInt64(uint32_t key, int64_t value);
131    bool setFloat(uint32_t key, float value);
132    bool setPointer(uint32_t key, void *value);
133
134    bool findCString(uint32_t key, const char **value);
135    bool findInt32(uint32_t key, int32_t *value);
136    bool findInt64(uint32_t key, int64_t *value);
137    bool findFloat(uint32_t key, float *value);
138    bool findPointer(uint32_t key, void **value);
139
140    bool setData(uint32_t key, uint32_t type, const void *data, size_t size);
141
142    bool findData(uint32_t key, uint32_t *type,
143                  const void **data, size_t *size) const;
144
145protected:
146    virtual ~MetaData();
147
148private:
149    struct typed_data {
150        typed_data();
151        ~typed_data();
152
153        typed_data(const MetaData::typed_data &);
154        typed_data &operator=(const MetaData::typed_data &);
155
156        void clear();
157        void setData(uint32_t type, const void *data, size_t size);
158        void getData(uint32_t *type, const void **data, size_t *size) const;
159
160    private:
161        uint32_t mType;
162        size_t mSize;
163
164        union {
165            void *ext_data;
166            float reservoir;
167        } u;
168
169        bool usesReservoir() const {
170            return mSize <= sizeof(u.reservoir);
171        }
172
173        void allocateStorage(size_t size);
174        void freeStorage();
175
176        void *storage() {
177            return usesReservoir() ? &u.reservoir : u.ext_data;
178        }
179
180        const void *storage() const {
181            return usesReservoir() ? &u.reservoir : u.ext_data;
182        }
183    };
184
185    KeyedVector<uint32_t, typed_data> mItems;
186
187    // MetaData &operator=(const MetaData &);
188};
189
190}  // namespace android
191
192#endif  // META_DATA_H_
193