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