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