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