ACodec.h revision 97827bd7c7e64dec22c8fe0f9e734a3c432ad7ee 
1/*
2 * Copyright (C) 2010 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 A_CODEC_H_
18
19#define A_CODEC_H_
20
21#include <stdint.h>
22#include <android/native_window.h>
23#include <media/IOMX.h>
24#include <media/stagefright/foundation/AHierarchicalStateMachine.h>
25#include <media/stagefright/CodecBase.h>
26#include <media/stagefright/SkipCutBuffer.h>
27#include <OMX_Audio.h>
28
29#define TRACK_BUFFER_TIMING     0
30
31namespace android {
32
33struct ABuffer;
34struct MemoryDealer;
35struct DescribeColorFormatParams;
36
37struct ACodec : public AHierarchicalStateMachine, public CodecBase {
38    ACodec();
39
40    virtual void setNotificationMessage(const sp<AMessage> &msg);
41
42    void initiateSetup(const sp<AMessage> &msg);
43
44    virtual void initiateAllocateComponent(const sp<AMessage> &msg);
45    virtual void initiateConfigureComponent(const sp<AMessage> &msg);
46    virtual void initiateCreateInputSurface();
47    virtual void initiateStart();
48    virtual void initiateShutdown(bool keepComponentAllocated = false);
49
50    virtual void signalFlush();
51    virtual void signalResume();
52
53    virtual void signalSetParameters(const sp<AMessage> &msg);
54    virtual void signalEndOfInputStream();
55    virtual void signalRequestIDRFrame();
56
57    // AHierarchicalStateMachine implements the message handling
58    virtual void onMessageReceived(const sp<AMessage> &msg) {
59        handleMessage(msg);
60    }
61
62    struct PortDescription : public CodecBase::PortDescription {
63        size_t countBuffers();
64        IOMX::buffer_id bufferIDAt(size_t index) const;
65        sp<ABuffer> bufferAt(size_t index) const;
66
67    private:
68        friend struct ACodec;
69
70        Vector<IOMX::buffer_id> mBufferIDs;
71        Vector<sp<ABuffer> > mBuffers;
72
73        PortDescription();
74        void addBuffer(IOMX::buffer_id id, const sp<ABuffer> &buffer);
75
76        DISALLOW_EVIL_CONSTRUCTORS(PortDescription);
77    };
78
79    static bool isFlexibleColorFormat(
80        const sp<IOMX> &omx, IOMX::node_id node,
81        uint32_t colorFormat, OMX_U32 *flexibleEquivalent);
82
83protected:
84    virtual ~ACodec();
85
86private:
87    struct BaseState;
88    struct UninitializedState;
89    struct LoadedState;
90    struct LoadedToIdleState;
91    struct IdleToExecutingState;
92    struct ExecutingState;
93    struct OutputPortSettingsChangedState;
94    struct ExecutingToIdleState;
95    struct IdleToLoadedState;
96    struct FlushingState;
97    struct DeathNotifier;
98
99    enum {
100        kWhatSetup                   = 'setu',
101        kWhatOMXMessage              = 'omx ',
102        kWhatInputBufferFilled       = 'inpF',
103        kWhatOutputBufferDrained     = 'outD',
104        kWhatShutdown                = 'shut',
105        kWhatFlush                   = 'flus',
106        kWhatResume                  = 'resm',
107        kWhatDrainDeferredMessages   = 'drai',
108        kWhatAllocateComponent       = 'allo',
109        kWhatConfigureComponent      = 'conf',
110        kWhatCreateInputSurface      = 'cisf',
111        kWhatSignalEndOfInputStream  = 'eois',
112        kWhatStart                   = 'star',
113        kWhatRequestIDRFrame         = 'ridr',
114        kWhatSetParameters           = 'setP',
115        kWhatSubmitOutputMetaDataBufferIfEOS = 'subm',
116        kWhatOMXDied                 = 'OMXd',
117    };
118
119    enum {
120        kPortIndexInput  = 0,
121        kPortIndexOutput = 1
122    };
123
124    enum {
125        kFlagIsSecure                                 = 1,
126        kFlagPushBlankBuffersToNativeWindowOnShutdown = 2,
127    };
128
129    struct BufferInfo {
130        enum Status {
131            OWNED_BY_US,
132            OWNED_BY_COMPONENT,
133            OWNED_BY_UPSTREAM,
134            OWNED_BY_DOWNSTREAM,
135            OWNED_BY_NATIVE_WINDOW,
136        };
137
138        IOMX::buffer_id mBufferID;
139        Status mStatus;
140        unsigned mDequeuedAt;
141
142        sp<ABuffer> mData;
143        sp<GraphicBuffer> mGraphicBuffer;
144    };
145
146#if TRACK_BUFFER_TIMING
147    struct BufferStats {
148        int64_t mEmptyBufferTimeUs;
149        int64_t mFillBufferDoneTimeUs;
150    };
151
152    KeyedVector<int64_t, BufferStats> mBufferStats;
153#endif
154
155    sp<AMessage> mNotify;
156
157    sp<UninitializedState> mUninitializedState;
158    sp<LoadedState> mLoadedState;
159    sp<LoadedToIdleState> mLoadedToIdleState;
160    sp<IdleToExecutingState> mIdleToExecutingState;
161    sp<ExecutingState> mExecutingState;
162    sp<OutputPortSettingsChangedState> mOutputPortSettingsChangedState;
163    sp<ExecutingToIdleState> mExecutingToIdleState;
164    sp<IdleToLoadedState> mIdleToLoadedState;
165    sp<FlushingState> mFlushingState;
166    sp<SkipCutBuffer> mSkipCutBuffer;
167
168    AString mComponentName;
169    uint32_t mFlags;
170    uint32_t mQuirks;
171    sp<IOMX> mOMX;
172    IOMX::node_id mNode;
173    sp<MemoryDealer> mDealer[2];
174
175    sp<ANativeWindow> mNativeWindow;
176    sp<AMessage> mInputFormat;
177    sp<AMessage> mOutputFormat;
178
179    Vector<BufferInfo> mBuffers[2];
180    bool mPortEOS[2];
181    status_t mInputEOSResult;
182
183    List<sp<AMessage> > mDeferredQueue;
184
185    bool mSentFormat;
186    bool mIsEncoder;
187    bool mUseMetadataOnEncoderOutput;
188    bool mShutdownInProgress;
189    bool mExplicitShutdown;
190
191    // If "mKeepComponentAllocated" we only transition back to Loaded state
192    // and do not release the component instance.
193    bool mKeepComponentAllocated;
194
195    int32_t mEncoderDelay;
196    int32_t mEncoderPadding;
197    int32_t mRotationDegrees;
198
199    bool mChannelMaskPresent;
200    int32_t mChannelMask;
201    unsigned mDequeueCounter;
202    bool mStoreMetaDataInOutputBuffers;
203    int32_t mMetaDataBuffersToSubmit;
204    size_t mNumUndequeuedBuffers;
205
206    int64_t mRepeatFrameDelayUs;
207    int64_t mMaxPtsGapUs;
208
209    int64_t mTimePerFrameUs;
210    int64_t mTimePerCaptureUs;
211
212    bool mCreateInputBuffersSuspended;
213
214    status_t setCyclicIntraMacroblockRefresh(const sp<AMessage> &msg, int32_t mode);
215    status_t allocateBuffersOnPort(OMX_U32 portIndex);
216    status_t freeBuffersOnPort(OMX_U32 portIndex);
217    status_t freeBuffer(OMX_U32 portIndex, size_t i);
218
219    status_t configureOutputBuffersFromNativeWindow(
220            OMX_U32 *nBufferCount, OMX_U32 *nBufferSize,
221            OMX_U32 *nMinUndequeuedBuffers);
222    status_t allocateOutputMetaDataBuffers();
223    status_t submitOutputMetaDataBuffer();
224    void signalSubmitOutputMetaDataBufferIfEOS_workaround();
225    status_t allocateOutputBuffersFromNativeWindow();
226    status_t cancelBufferToNativeWindow(BufferInfo *info);
227    status_t freeOutputBuffersNotOwnedByComponent();
228    BufferInfo *dequeueBufferFromNativeWindow();
229
230    BufferInfo *findBufferByID(
231            uint32_t portIndex, IOMX::buffer_id bufferID,
232            ssize_t *index = NULL);
233
234    status_t setComponentRole(bool isEncoder, const char *mime);
235    status_t configureCodec(const char *mime, const sp<AMessage> &msg);
236
237    status_t configureTunneledVideoPlayback(int32_t audioHwSync,
238            const sp<ANativeWindow> &nativeWindow);
239
240    status_t setVideoPortFormatType(
241            OMX_U32 portIndex,
242            OMX_VIDEO_CODINGTYPE compressionFormat,
243            OMX_COLOR_FORMATTYPE colorFormat);
244
245    status_t setSupportedOutputFormat();
246
247    status_t setupVideoDecoder(
248            const char *mime, const sp<AMessage> &msg);
249
250    status_t setupVideoEncoder(
251            const char *mime, const sp<AMessage> &msg);
252
253    status_t setVideoFormatOnPort(
254            OMX_U32 portIndex,
255            int32_t width, int32_t height,
256            OMX_VIDEO_CODINGTYPE compressionFormat);
257
258    typedef struct drcParams {
259        int32_t drcCut;
260        int32_t drcBoost;
261        int32_t heavyCompression;
262        int32_t targetRefLevel;
263        int32_t encodedTargetLevel;
264    } drcParams_t;
265
266    status_t setupAACCodec(
267            bool encoder,
268            int32_t numChannels, int32_t sampleRate, int32_t bitRate,
269            int32_t aacProfile, bool isADTS, int32_t sbrMode,
270            int32_t maxOutputChannelCount, const drcParams_t& drc);
271
272    status_t setupAC3Codec(bool encoder, int32_t numChannels, int32_t sampleRate);
273
274    status_t selectAudioPortFormat(
275            OMX_U32 portIndex, OMX_AUDIO_CODINGTYPE desiredFormat);
276
277    status_t setupAMRCodec(bool encoder, bool isWAMR, int32_t bitRate);
278    status_t setupG711Codec(bool encoder, int32_t numChannels);
279
280    status_t setupFlacCodec(
281            bool encoder, int32_t numChannels, int32_t sampleRate, int32_t compressionLevel);
282
283    status_t setupRawAudioFormat(
284            OMX_U32 portIndex, int32_t sampleRate, int32_t numChannels);
285
286    status_t setMinBufferSize(OMX_U32 portIndex, size_t size);
287
288    status_t setupMPEG4EncoderParameters(const sp<AMessage> &msg);
289    status_t setupH263EncoderParameters(const sp<AMessage> &msg);
290    status_t setupAVCEncoderParameters(const sp<AMessage> &msg);
291    status_t setupHEVCEncoderParameters(const sp<AMessage> &msg);
292    status_t setupVPXEncoderParameters(const sp<AMessage> &msg);
293
294    status_t verifySupportForProfileAndLevel(int32_t profile, int32_t level);
295
296    status_t configureBitrate(
297            int32_t bitrate, OMX_VIDEO_CONTROLRATETYPE bitrateMode);
298
299    status_t setupErrorCorrectionParameters();
300
301    status_t initNativeWindow();
302
303    status_t pushBlankBuffersToNativeWindow();
304
305    // Returns true iff all buffers on the given port have status
306    // OWNED_BY_US or OWNED_BY_NATIVE_WINDOW.
307    bool allYourBuffersAreBelongToUs(OMX_U32 portIndex);
308
309    bool allYourBuffersAreBelongToUs();
310
311    void waitUntilAllPossibleNativeWindowBuffersAreReturnedToUs();
312
313    size_t countBuffersOwnedByComponent(OMX_U32 portIndex) const;
314    size_t countBuffersOwnedByNativeWindow() const;
315
316    void deferMessage(const sp<AMessage> &msg);
317    void processDeferredMessages();
318
319    void sendFormatChange(const sp<AMessage> &reply);
320    status_t getPortFormat(OMX_U32 portIndex, sp<AMessage> &notify);
321
322    void signalError(
323            OMX_ERRORTYPE error = OMX_ErrorUndefined,
324            status_t internalError = UNKNOWN_ERROR);
325
326    static bool describeDefaultColorFormat(DescribeColorFormatParams &describeParams);
327    static bool describeColorFormat(
328        const sp<IOMX> &omx, IOMX::node_id node,
329        DescribeColorFormatParams &describeParams);
330
331    status_t requestIDRFrame();
332    status_t setParameters(const sp<AMessage> &params);
333
334    // Send EOS on input stream.
335    void onSignalEndOfInputStream();
336
337    DISALLOW_EVIL_CONSTRUCTORS(ACodec);
338};
339
340}  // namespace android
341
342#endif  // A_CODEC_H_
343