OMXCodec.h revision 2a3847ee1cbdaa8a65eee397a0173bb02211c459 
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    status_t mFinalStatus;
136    bool mNoMoreOutputData;
137    bool mOutputPortSettingsHaveChanged;
138    int64_t mSeekTimeUs;
139
140    Mutex mLock;
141    Condition mAsyncCompletion;
142
143    // A list of indices into mPortStatus[kPortIndexOutput] filled with data.
144    List<size_t> mFilledBuffers;
145    Condition mBufferFilled;
146
147    OMXCodec(const sp<IOMX> &omx, IOMX::node_id node, uint32_t quirks,
148             bool isEncoder, const char *mime, const char *componentName,
149             const sp<MediaSource> &source);
150
151    void addCodecSpecificData(const void *data, size_t size);
152    void clearCodecSpecificData();
153
154    void setComponentRole();
155
156    void setAMRFormat(bool isWAMR);
157    void setAACFormat(int32_t numChannels, int32_t sampleRate);
158
159    status_t setVideoPortFormatType(
160            OMX_U32 portIndex,
161            OMX_VIDEO_CODINGTYPE compressionFormat,
162            OMX_COLOR_FORMATTYPE colorFormat);
163
164    void setVideoInputFormat(
165            const char *mime, OMX_U32 width, OMX_U32 height);
166
167    status_t setupMPEG4EncoderParameters();
168    status_t setupAVCEncoderParameters();
169
170    status_t setVideoOutputFormat(
171            const char *mime, OMX_U32 width, OMX_U32 height);
172
173    void setImageOutputFormat(
174            OMX_COLOR_FORMATTYPE format, OMX_U32 width, OMX_U32 height);
175
176    void setJPEGInputFormat(
177            OMX_U32 width, OMX_U32 height, OMX_U32 compressedSize);
178
179    void setMinBufferSize(OMX_U32 portIndex, OMX_U32 size);
180
181    void setRawAudioFormat(
182            OMX_U32 portIndex, int32_t sampleRate, int32_t numChannels);
183
184    status_t allocateBuffers();
185    status_t allocateBuffersOnPort(OMX_U32 portIndex);
186
187    status_t freeBuffersOnPort(
188            OMX_U32 portIndex, bool onlyThoseWeOwn = false);
189
190    void drainInputBuffer(IOMX::buffer_id buffer);
191    void fillOutputBuffer(IOMX::buffer_id buffer);
192    void drainInputBuffer(BufferInfo *info);
193    void fillOutputBuffer(BufferInfo *info);
194
195    void drainInputBuffers();
196    void fillOutputBuffers();
197
198    // Returns true iff a flush was initiated and a completion event is
199    // upcoming, false otherwise (A flush was not necessary as we own all
200    // the buffers on that port).
201    // This method will ONLY ever return false for a component with quirk
202    // "kRequiresFlushCompleteEmulation".
203    bool flushPortAsync(OMX_U32 portIndex);
204
205    void disablePortAsync(OMX_U32 portIndex);
206    void enablePortAsync(OMX_U32 portIndex);
207
208    static size_t countBuffersWeOwn(const Vector<BufferInfo> &buffers);
209    static bool isIntermediateState(State state);
210
211    void onEvent(OMX_EVENTTYPE event, OMX_U32 data1, OMX_U32 data2);
212    void onCmdComplete(OMX_COMMANDTYPE cmd, OMX_U32 data);
213    void onStateChange(OMX_STATETYPE newState);
214    void onPortSettingsChanged(OMX_U32 portIndex);
215
216    void setState(State newState);
217
218    status_t init();
219    void initOutputFormat(const sp<MetaData> &inputFormat);
220
221    void dumpPortStatus(OMX_U32 portIndex);
222
223    status_t configureCodec(const sp<MetaData> &meta);
224
225    static uint32_t getComponentQuirks(const char *componentName);
226
227    static void findMatchingCodecs(
228            const char *mime,
229            bool createEncoder, const char *matchComponentName,
230            uint32_t flags,
231            Vector<String8> *matchingCodecs);
232
233    OMXCodec(const OMXCodec &);
234    OMXCodec &operator=(const OMXCodec &);
235};
236
237struct CodecProfileLevel {
238    OMX_U32 mProfile;
239    OMX_U32 mLevel;
240};
241
242struct CodecCapabilities {
243    String8 mComponentName;
244    Vector<CodecProfileLevel> mProfileLevels;
245};
246
247// Return a vector of componentNames with supported profile/level pairs
248// supporting the given mime type, if queryDecoders==true, returns components
249// that decode content of the given type, otherwise returns components
250// that encode content of the given type.
251// profile and level indications only make sense for h.263, mpeg4 and avc
252// video.
253// The profile/level values correspond to
254// OMX_VIDEO_H263PROFILETYPE, OMX_VIDEO_MPEG4PROFILETYPE,
255// OMX_VIDEO_AVCPROFILETYPE, OMX_VIDEO_H263LEVELTYPE, OMX_VIDEO_MPEG4LEVELTYPE
256// and OMX_VIDEO_AVCLEVELTYPE respectively.
257
258status_t QueryCodecs(
259        const sp<IOMX> &omx,
260        const char *mimeType, bool queryDecoders,
261        Vector<CodecCapabilities> *results);
262
263}  // namespace android
264
265#endif  // OMX_CODEC_H_
266