MediaCodec.h revision 72c6686ad04feb976ea3d2f816c784e485b55506 
1/*
2 * Copyright 2012, 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 MEDIA_CODEC_H_
18
19#define MEDIA_CODEC_H_
20
21#include <gui/ISurfaceTexture.h>
22#include <media/hardware/CryptoAPI.h>
23#include <media/stagefright/foundation/AHandler.h>
24#include <utils/Vector.h>
25
26namespace android {
27
28struct ABuffer;
29struct ACodec;
30struct AMessage;
31struct AString;
32struct ICrypto;
33struct SoftwareRenderer;
34struct SurfaceTextureClient;
35
36struct MediaCodec : public AHandler {
37    enum ConfigureFlags {
38        CONFIGURE_FLAG_ENCODE   = 1,
39    };
40
41    enum BufferFlags {
42        BUFFER_FLAG_SYNCFRAME   = 1,
43        BUFFER_FLAG_CODECCONFIG = 2,
44        BUFFER_FLAG_EOS         = 4,
45    };
46
47    static sp<MediaCodec> CreateByType(
48            const sp<ALooper> &looper, const char *mime, bool encoder);
49
50    static sp<MediaCodec> CreateByComponentName(
51            const sp<ALooper> &looper, const char *name);
52
53    status_t configure(
54            const sp<AMessage> &format,
55            const sp<SurfaceTextureClient> &nativeWindow,
56            const sp<ICrypto> &crypto,
57            uint32_t flags);
58
59    status_t start();
60
61    // Returns to a state in which the component remains allocated but
62    // unconfigured.
63    status_t stop();
64
65    // Client MUST call release before releasing final reference to this
66    // object.
67    status_t release();
68
69    status_t flush();
70
71    status_t queueInputBuffer(
72            size_t index,
73            size_t offset,
74            size_t size,
75            int64_t presentationTimeUs,
76            uint32_t flags,
77            AString *errorDetailMsg = NULL);
78
79    status_t queueSecureInputBuffer(
80            size_t index,
81            size_t offset,
82            const CryptoPlugin::SubSample *subSamples,
83            size_t numSubSamples,
84            const uint8_t key[16],
85            const uint8_t iv[16],
86            CryptoPlugin::Mode mode,
87            int64_t presentationTimeUs,
88            uint32_t flags,
89            AString *errorDetailMsg = NULL);
90
91    status_t dequeueInputBuffer(size_t *index, int64_t timeoutUs = 0ll);
92
93    status_t dequeueOutputBuffer(
94            size_t *index,
95            size_t *offset,
96            size_t *size,
97            int64_t *presentationTimeUs,
98            uint32_t *flags,
99            int64_t timeoutUs = 0ll);
100
101    status_t renderOutputBufferAndRelease(size_t index);
102    status_t releaseOutputBuffer(size_t index);
103
104    status_t getOutputFormat(sp<AMessage> *format) const;
105
106    status_t getInputBuffers(Vector<sp<ABuffer> > *buffers) const;
107    status_t getOutputBuffers(Vector<sp<ABuffer> > *buffers) const;
108
109    status_t requestIDRFrame();
110
111    // Notification will be posted once there "is something to do", i.e.
112    // an input/output buffer has become available, a format change is
113    // pending, an error is pending.
114    void requestActivityNotification(const sp<AMessage> &notify);
115
116protected:
117    virtual ~MediaCodec();
118    virtual void onMessageReceived(const sp<AMessage> &msg);
119
120private:
121    enum State {
122        UNINITIALIZED,
123        INITIALIZING,
124        INITIALIZED,
125        CONFIGURING,
126        CONFIGURED,
127        STARTING,
128        STARTED,
129        FLUSHING,
130        STOPPING,
131        RELEASING,
132    };
133
134    enum {
135        kPortIndexInput         = 0,
136        kPortIndexOutput        = 1,
137    };
138
139    enum {
140        kWhatInit                           = 'init',
141        kWhatConfigure                      = 'conf',
142        kWhatStart                          = 'strt',
143        kWhatStop                           = 'stop',
144        kWhatRelease                        = 'rele',
145        kWhatDequeueInputBuffer             = 'deqI',
146        kWhatQueueInputBuffer               = 'queI',
147        kWhatDequeueOutputBuffer            = 'deqO',
148        kWhatReleaseOutputBuffer            = 'relO',
149        kWhatGetBuffers                     = 'getB',
150        kWhatFlush                          = 'flus',
151        kWhatGetOutputFormat                = 'getO',
152        kWhatDequeueInputTimedOut           = 'dITO',
153        kWhatDequeueOutputTimedOut          = 'dOTO',
154        kWhatCodecNotify                    = 'codc',
155        kWhatRequestIDRFrame                = 'ridr',
156        kWhatRequestActivityNotification    = 'racN',
157    };
158
159    enum {
160        kFlagIsSoftwareCodec            = 1,
161        kFlagOutputFormatChanged        = 2,
162        kFlagOutputBuffersChanged       = 4,
163        kFlagStickyError                = 8,
164        kFlagDequeueInputPending        = 16,
165        kFlagDequeueOutputPending       = 32,
166        kFlagIsSecure                   = 64,
167    };
168
169    struct BufferInfo {
170        void *mBufferID;
171        sp<ABuffer> mData;
172        sp<ABuffer> mEncryptedData;
173        sp<AMessage> mNotify;
174        bool mOwnedByClient;
175    };
176
177    State mState;
178    sp<ALooper> mLooper;
179    sp<ALooper> mCodecLooper;
180    sp<ACodec> mCodec;
181    uint32_t mReplyID;
182    uint32_t mFlags;
183    sp<SurfaceTextureClient> mNativeWindow;
184    SoftwareRenderer *mSoftRenderer;
185    sp<AMessage> mOutputFormat;
186
187    List<size_t> mAvailPortBuffers[2];
188    Vector<BufferInfo> mPortBuffers[2];
189
190    int32_t mDequeueInputTimeoutGeneration;
191    uint32_t mDequeueInputReplyID;
192
193    int32_t mDequeueOutputTimeoutGeneration;
194    uint32_t mDequeueOutputReplyID;
195
196    sp<ICrypto> mCrypto;
197
198    List<sp<ABuffer> > mCSD;
199
200    sp<AMessage> mActivityNotify;
201
202    MediaCodec(const sp<ALooper> &looper);
203
204    static status_t PostAndAwaitResponse(
205            const sp<AMessage> &msg, sp<AMessage> *response);
206
207    status_t init(const char *name, bool nameIsType, bool encoder);
208
209    void setState(State newState);
210    void returnBuffersToCodec();
211    void returnBuffersToCodecOnPort(int32_t portIndex);
212    size_t updateBuffers(int32_t portIndex, const sp<AMessage> &msg);
213    status_t onQueueInputBuffer(const sp<AMessage> &msg);
214    status_t onReleaseOutputBuffer(const sp<AMessage> &msg);
215    ssize_t dequeuePortBuffer(int32_t portIndex);
216
217    bool handleDequeueInputBuffer(uint32_t replyID, bool newRequest = false);
218    bool handleDequeueOutputBuffer(uint32_t replyID, bool newRequest = false);
219    void cancelPendingDequeueOperations();
220
221    void extractCSD(const sp<AMessage> &format);
222    status_t queueCSDInputBuffer(size_t bufferIndex);
223
224    status_t setNativeWindow(
225            const sp<SurfaceTextureClient> &surfaceTextureClient);
226
227    void postActivityNotificationIfPossible();
228
229    DISALLOW_EVIL_CONSTRUCTORS(MediaCodec);
230};
231
232}  // namespace android
233
234#endif  // MEDIA_CODEC_H_
235