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