OMXCodec.h revision abd1f4f870925d6776dbe4b930b759a1ab6595ca 
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 OMX_CODEC_H_
18
19#define OMX_CODEC_H_
20
21#include <media/IOMX.h>
22#include <media/stagefright/MediaBuffer.h>
23#include <media/stagefright/MediaSource.h>
24#include <utils/threads.h>
25
26namespace android {
27
28class MemoryDealer;
29struct OMXCodecObserver;
30struct CodecProfileLevel;
31
32struct OMXCodec : public MediaSource,
33                  public MediaBufferObserver {
34    enum CreationFlags {
35        kPreferSoftwareCodecs = 1,
36    };
37    static sp<MediaSource> Create(
38            const sp<IOMX> &omx,
39            const sp<MetaData> &meta, bool createEncoder,
40            const sp<MediaSource> &source,
41            const char *matchComponentName = NULL,
42            uint32_t flags = 0);
43
44    static void setComponentRole(
45            const sp<IOMX> &omx, IOMX::node_id node, bool isEncoder,
46            const char *mime);
47
48    virtual status_t start(MetaData *params = NULL);
49    virtual status_t stop();
50
51    virtual sp<MetaData> getFormat();
52
53    virtual status_t read(
54            MediaBuffer **buffer, const ReadOptions *options = NULL);
55
56    virtual status_t pause();
57
58    void on_message(const omx_message &msg);
59
60    // from MediaBufferObserver
61    virtual void signalBufferReturned(MediaBuffer *buffer);
62
63protected:
64    virtual ~OMXCodec();
65
66private:
67    enum State {
68        DEAD,
69        LOADED,
70        LOADED_TO_IDLE,
71        IDLE_TO_EXECUTING,
72        EXECUTING,
73        EXECUTING_TO_IDLE,
74        IDLE_TO_LOADED,
75        RECONFIGURING,
76        ERROR
77    };
78
79    enum {
80        kPortIndexInput  = 0,
81        kPortIndexOutput = 1
82    };
83
84    enum PortStatus {
85        ENABLED,
86        DISABLING,
87        DISABLED,
88        ENABLING,
89        SHUTTING_DOWN,
90    };
91
92    enum Quirks {
93        kNeedsFlushBeforeDisable              = 1,
94        kWantsNALFragments                    = 2,
95        kRequiresLoadedToIdleAfterAllocation  = 4,
96        kRequiresAllocateBufferOnInputPorts   = 8,
97        kRequiresFlushCompleteEmulation       = 16,
98        kRequiresAllocateBufferOnOutputPorts  = 32,
99        kRequiresFlushBeforeShutdown          = 64,
100        kDefersOutputBufferAllocation         = 128,
101        kDecoderLiesAboutNumberOfChannels     = 256,
102        kInputBufferSizesAreBogus             = 512,
103        kSupportsMultipleFramesPerInputBuffer = 1024,
104        kAvoidMemcopyInputRecordingFrames     = 2048,
105    };
106
107    struct BufferInfo {
108        IOMX::buffer_id mBuffer;
109        bool mOwnedByComponent;
110        sp<IMemory> mMem;
111        size_t mSize;
112        void *mData;
113        MediaBuffer *mMediaBuffer;
114    };
115
116    struct CodecSpecificData {
117        size_t mSize;
118        uint8_t mData[1];
119    };
120
121    sp<IOMX> mOMX;
122    bool mOMXLivesLocally;
123    IOMX::node_id mNode;
124    uint32_t mQuirks;
125    bool mIsEncoder;
126    char *mMIME;
127    char *mComponentName;
128    sp<MetaData> mOutputFormat;
129    sp<MediaSource> mSource;
130    Vector<CodecSpecificData *> mCodecSpecificData;
131    size_t mCodecSpecificDataIndex;
132
133    sp<MemoryDealer> mDealer[2];
134
135    State mState;
136    Vector<BufferInfo> mPortBuffers[2];
137    PortStatus mPortStatus[2];
138    bool mInitialBufferSubmit;
139    bool mSignalledEOS;
140    status_t mFinalStatus;
141    bool mNoMoreOutputData;
142    bool mOutputPortSettingsHaveChanged;
143    int64_t mSeekTimeUs;
144    ReadOptions::SeekMode mSeekMode;
145    int64_t mTargetTimeUs;
146
147    MediaBuffer *mLeftOverBuffer;
148
149    Mutex mLock;
150    Condition mAsyncCompletion;
151
152    bool mPaused;
153
154    // A list of indices into mPortStatus[kPortIndexOutput] filled with data.
155    List<size_t> mFilledBuffers;
156    Condition mBufferFilled;
157
158    OMXCodec(const sp<IOMX> &omx, IOMX::node_id node, uint32_t quirks,
159             bool isEncoder, const char *mime, const char *componentName,
160             const sp<MediaSource> &source);
161
162    void addCodecSpecificData(const void *data, size_t size);
163    void clearCodecSpecificData();
164
165    void setComponentRole();
166
167    void setAMRFormat(bool isWAMR, int32_t bitRate);
168    void setAACFormat(int32_t numChannels, int32_t sampleRate, int32_t bitRate);
169
170    status_t setVideoPortFormatType(
171            OMX_U32 portIndex,
172            OMX_VIDEO_CODINGTYPE compressionFormat,
173            OMX_COLOR_FORMATTYPE colorFormat);
174
175    void setVideoInputFormat(
176            const char *mime, const sp<MetaData>& meta);
177
178    status_t setupBitRate(int32_t bitRate);
179    status_t setupErrorCorrectionParameters();
180    status_t setupH263EncoderParameters(const sp<MetaData>& meta);
181    status_t setupMPEG4EncoderParameters(const sp<MetaData>& meta);
182    status_t setupAVCEncoderParameters(const sp<MetaData>& meta);
183
184    // If profile/level is set in the meta data, its value in the meta
185    // data will be used; otherwise, the default value will be used.
186    status_t getVideoProfileLevel(const sp<MetaData>& meta,
187            const CodecProfileLevel& defaultProfileLevel,
188            CodecProfileLevel& profileLevel);
189
190    status_t setVideoOutputFormat(
191            const char *mime, OMX_U32 width, OMX_U32 height);
192
193    void setImageOutputFormat(
194            OMX_COLOR_FORMATTYPE format, OMX_U32 width, OMX_U32 height);
195
196    void setJPEGInputFormat(
197            OMX_U32 width, OMX_U32 height, OMX_U32 compressedSize);
198
199    void setMinBufferSize(OMX_U32 portIndex, OMX_U32 size);
200
201    void setRawAudioFormat(
202            OMX_U32 portIndex, int32_t sampleRate, int32_t numChannels);
203
204    status_t allocateBuffers();
205    status_t allocateBuffersOnPort(OMX_U32 portIndex);
206
207    status_t freeBuffersOnPort(
208            OMX_U32 portIndex, bool onlyThoseWeOwn = false);
209
210    void drainInputBuffer(IOMX::buffer_id buffer);
211    void fillOutputBuffer(IOMX::buffer_id buffer);
212    void drainInputBuffer(BufferInfo *info);
213    void fillOutputBuffer(BufferInfo *info);
214
215    void drainInputBuffers();
216    void fillOutputBuffers();
217
218    // Returns true iff a flush was initiated and a completion event is
219    // upcoming, false otherwise (A flush was not necessary as we own all
220    // the buffers on that port).
221    // This method will ONLY ever return false for a component with quirk
222    // "kRequiresFlushCompleteEmulation".
223    bool flushPortAsync(OMX_U32 portIndex);
224
225    void disablePortAsync(OMX_U32 portIndex);
226    void enablePortAsync(OMX_U32 portIndex);
227
228    static size_t countBuffersWeOwn(const Vector<BufferInfo> &buffers);
229    static bool isIntermediateState(State state);
230
231    void onEvent(OMX_EVENTTYPE event, OMX_U32 data1, OMX_U32 data2);
232    void onCmdComplete(OMX_COMMANDTYPE cmd, OMX_U32 data);
233    void onStateChange(OMX_STATETYPE newState);
234    void onPortSettingsChanged(OMX_U32 portIndex);
235
236    void setState(State newState);
237
238    status_t init();
239    void initOutputFormat(const sp<MetaData> &inputFormat);
240
241    void dumpPortStatus(OMX_U32 portIndex);
242
243    status_t configureCodec(const sp<MetaData> &meta);
244
245    static uint32_t getComponentQuirks(const char *componentName);
246
247    static void findMatchingCodecs(
248            const char *mime,
249            bool createEncoder, const char *matchComponentName,
250            uint32_t flags,
251            Vector<String8> *matchingCodecs);
252
253    OMXCodec(const OMXCodec &);
254    OMXCodec &operator=(const OMXCodec &);
255};
256
257struct CodecProfileLevel {
258    OMX_U32 mProfile;
259    OMX_U32 mLevel;
260};
261
262struct CodecCapabilities {
263    String8 mComponentName;
264    Vector<CodecProfileLevel> mProfileLevels;
265};
266
267// Return a vector of componentNames with supported profile/level pairs
268// supporting the given mime type, if queryDecoders==true, returns components
269// that decode content of the given type, otherwise returns components
270// that encode content of the given type.
271// profile and level indications only make sense for h.263, mpeg4 and avc
272// video.
273// The profile/level values correspond to
274// OMX_VIDEO_H263PROFILETYPE, OMX_VIDEO_MPEG4PROFILETYPE,
275// OMX_VIDEO_AVCPROFILETYPE, OMX_VIDEO_H263LEVELTYPE, OMX_VIDEO_MPEG4LEVELTYPE
276// and OMX_VIDEO_AVCLEVELTYPE respectively.
277
278status_t QueryCodecs(
279        const sp<IOMX> &omx,
280        const char *mimeType, bool queryDecoders,
281        Vector<CodecCapabilities> *results);
282
283}  // namespace android
284
285#endif  // OMX_CODEC_H_
286