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