OMXNodeInstance.h revision 73dd808754c641fe798273d356ee38368715fa7b 
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_NODE_INSTANCE_H_
18
19#define OMX_NODE_INSTANCE_H_
20
21#include "OMX.h"
22
23#include <utils/RefBase.h>
24#include <utils/threads.h>
25
26namespace android {
27
28class IOMXObserver;
29struct OMXMaster;
30class GraphicBufferSource;
31
32struct OMXNodeInstance {
33    OMXNodeInstance(
34            OMX *owner, const sp<IOMXObserver> &observer, const char *name);
35
36    void setHandle(OMX::node_id node_id, OMX_HANDLETYPE handle);
37
38    OMX *owner();
39    sp<IOMXObserver> observer();
40    OMX::node_id nodeID();
41
42    status_t freeNode(OMXMaster *master);
43
44    status_t sendCommand(OMX_COMMANDTYPE cmd, OMX_S32 param);
45    status_t getParameter(OMX_INDEXTYPE index, void *params, size_t size);
46
47    status_t setParameter(
48            OMX_INDEXTYPE index, const void *params, size_t size);
49
50    status_t getConfig(OMX_INDEXTYPE index, void *params, size_t size);
51    status_t setConfig(OMX_INDEXTYPE index, const void *params, size_t size);
52
53    status_t getState(OMX_STATETYPE* state);
54
55    status_t enableNativeBuffers(OMX_U32 portIndex, OMX_BOOL graphic, OMX_BOOL enable);
56
57    status_t getGraphicBufferUsage(OMX_U32 portIndex, OMX_U32* usage);
58
59    status_t storeMetaDataInBuffers(
60            OMX_U32 portIndex, OMX_BOOL enable, MetadataBufferType *type);
61
62    status_t prepareForAdaptivePlayback(
63            OMX_U32 portIndex, OMX_BOOL enable,
64            OMX_U32 maxFrameWidth, OMX_U32 maxFrameHeight);
65
66    status_t configureVideoTunnelMode(
67            OMX_U32 portIndex, OMX_BOOL tunneled,
68            OMX_U32 audioHwSync, native_handle_t **sidebandHandle);
69
70    status_t useBuffer(
71            OMX_U32 portIndex, const sp<IMemory> &params,
72            OMX::buffer_id *buffer, OMX_U32 allottedSize);
73
74    status_t useGraphicBuffer(
75            OMX_U32 portIndex, const sp<GraphicBuffer> &graphicBuffer,
76            OMX::buffer_id *buffer);
77
78    status_t updateGraphicBufferInMeta(
79            OMX_U32 portIndex, const sp<GraphicBuffer> &graphicBuffer,
80            OMX::buffer_id buffer);
81
82    status_t createInputSurface(
83            OMX_U32 portIndex, sp<IGraphicBufferProducer> *bufferProducer,
84            MetadataBufferType *type);
85
86    static status_t createPersistentInputSurface(
87            sp<IGraphicBufferProducer> *bufferProducer,
88            sp<IGraphicBufferConsumer> *bufferConsumer);
89
90    status_t setInputSurface(
91            OMX_U32 portIndex, const sp<IGraphicBufferConsumer> &bufferConsumer,
92            MetadataBufferType *type);
93
94    status_t signalEndOfInputStream();
95
96    status_t allocateSecureBuffer(
97            OMX_U32 portIndex, size_t size, OMX::buffer_id *buffer,
98            void **buffer_data, native_handle_t **native_handle);
99
100    status_t allocateBufferWithBackup(
101            OMX_U32 portIndex, const sp<IMemory> &params,
102            OMX::buffer_id *buffer, OMX_U32 allottedSize);
103
104    status_t freeBuffer(OMX_U32 portIndex, OMX::buffer_id buffer);
105
106    status_t fillBuffer(OMX::buffer_id buffer, int fenceFd);
107
108    status_t emptyBuffer(
109            OMX::buffer_id buffer,
110            OMX_U32 rangeOffset, OMX_U32 rangeLength,
111            OMX_U32 flags, OMX_TICKS timestamp, int fenceFd);
112
113    status_t emptyGraphicBuffer(
114            OMX_BUFFERHEADERTYPE *header, const sp<GraphicBuffer> &buffer,
115            OMX_U32 flags, OMX_TICKS timestamp, int fenceFd);
116
117    status_t getExtensionIndex(
118            const char *parameterName, OMX_INDEXTYPE *index);
119
120    status_t setInternalOption(
121            OMX_U32 portIndex,
122            IOMX::InternalOptionType type,
123            const void *data,
124            size_t size);
125
126    bool isSecure() const {
127        return mIsSecure;
128    }
129
130    // handles messages and removes them from the list
131    void onMessages(std::list<omx_message> &messages);
132    void onMessage(const omx_message &msg);
133    void onObserverDied(OMXMaster *master);
134    void onGetHandleFailed();
135    void onEvent(OMX_EVENTTYPE event, OMX_U32 arg1, OMX_U32 arg2);
136
137    static OMX_CALLBACKTYPE kCallbacks;
138
139private:
140    Mutex mLock;
141
142    OMX *mOwner;
143    OMX::node_id mNodeID;
144    OMX_HANDLETYPE mHandle;
145    sp<IOMXObserver> mObserver;
146    bool mDying;
147    bool mIsSecure;
148
149    // Lock only covers mGraphicBufferSource.  We can't always use mLock
150    // because of rare instances where we'd end up locking it recursively.
151    Mutex mGraphicBufferSourceLock;
152    // Access this through getGraphicBufferSource().
153    sp<GraphicBufferSource> mGraphicBufferSource;
154
155
156    struct ActiveBuffer {
157        OMX_U32 mPortIndex;
158        OMX::buffer_id mID;
159    };
160    Vector<ActiveBuffer> mActiveBuffers;
161    // for buffer ptr to buffer id translation
162    Mutex mBufferIDLock;
163    uint32_t mBufferIDCount;
164    KeyedVector<OMX::buffer_id, OMX_BUFFERHEADERTYPE *> mBufferIDToBufferHeader;
165    KeyedVector<OMX_BUFFERHEADERTYPE *, OMX::buffer_id> mBufferHeaderToBufferID;
166
167    // metadata and secure buffer type tracking
168    MetadataBufferType mMetadataType[2];
169    enum SecureBufferType {
170        kSecureBufferTypeUnknown,
171        kSecureBufferTypeOpaque,
172        kSecureBufferTypeNativeHandle,
173    };
174    SecureBufferType mSecureBufferType[2];
175
176    // For debug support
177    char *mName;
178    int DEBUG;
179    size_t mNumPortBuffers[2];  // modified under mLock, read outside for debug
180    Mutex mDebugLock;
181    // following are modified and read under mDebugLock
182    int DEBUG_BUMP;
183    SortedVector<OMX_BUFFERHEADERTYPE *> mInputBuffersWithCodec, mOutputBuffersWithCodec;
184    size_t mDebugLevelBumpPendingBuffers[2];
185    void bumpDebugLevel_l(size_t numInputBuffers, size_t numOutputBuffers);
186    void unbumpDebugLevel_l(size_t portIndex);
187
188    ~OMXNodeInstance();
189
190    void addActiveBuffer(OMX_U32 portIndex, OMX::buffer_id id);
191    void removeActiveBuffer(OMX_U32 portIndex, OMX::buffer_id id);
192    void freeActiveBuffers();
193
194    // For buffer id management
195    OMX::buffer_id makeBufferID(OMX_BUFFERHEADERTYPE *bufferHeader);
196    OMX_BUFFERHEADERTYPE *findBufferHeader(OMX::buffer_id buffer);
197    OMX::buffer_id findBufferID(OMX_BUFFERHEADERTYPE *bufferHeader);
198    void invalidateBufferID(OMX::buffer_id buffer);
199
200    status_t useGraphicBuffer2_l(
201            OMX_U32 portIndex, const sp<GraphicBuffer> &graphicBuffer,
202            OMX::buffer_id *buffer);
203    static OMX_ERRORTYPE OnEvent(
204            OMX_IN OMX_HANDLETYPE hComponent,
205            OMX_IN OMX_PTR pAppData,
206            OMX_IN OMX_EVENTTYPE eEvent,
207            OMX_IN OMX_U32 nData1,
208            OMX_IN OMX_U32 nData2,
209            OMX_IN OMX_PTR pEventData);
210
211    static OMX_ERRORTYPE OnEmptyBufferDone(
212            OMX_IN OMX_HANDLETYPE hComponent,
213            OMX_IN OMX_PTR pAppData,
214            OMX_IN OMX_BUFFERHEADERTYPE *pBuffer);
215
216    static OMX_ERRORTYPE OnFillBufferDone(
217            OMX_IN OMX_HANDLETYPE hComponent,
218            OMX_IN OMX_PTR pAppData,
219            OMX_IN OMX_BUFFERHEADERTYPE *pBuffer);
220
221    status_t storeMetaDataInBuffers_l(
222            OMX_U32 portIndex, OMX_BOOL enable, MetadataBufferType *type);
223
224    // Stores fence into buffer if it is ANWBuffer type and has enough space.
225    // otherwise, waits for the fence to signal.  Takes ownership of |fenceFd|.
226    status_t storeFenceInMeta_l(
227            OMX_BUFFERHEADERTYPE *header, int fenceFd, OMX_U32 portIndex);
228
229    // Retrieves the fence from buffer if ANWBuffer type and has enough space. Otherwise, returns -1
230    int retrieveFenceFromMeta_l(
231            OMX_BUFFERHEADERTYPE *header, OMX_U32 portIndex);
232
233    status_t emptyBuffer_l(
234            OMX_BUFFERHEADERTYPE *header,
235            OMX_U32 flags, OMX_TICKS timestamp, intptr_t debugAddr, int fenceFd);
236
237    status_t updateGraphicBufferInMeta_l(
238            OMX_U32 portIndex, const sp<GraphicBuffer> &graphicBuffer,
239            OMX::buffer_id buffer, OMX_BUFFERHEADERTYPE *header);
240
241    status_t createGraphicBufferSource(
242            OMX_U32 portIndex, sp<IGraphicBufferConsumer> consumer /* nullable */,
243            MetadataBufferType *type);
244    sp<GraphicBufferSource> getGraphicBufferSource();
245    void setGraphicBufferSource(const sp<GraphicBufferSource>& bufferSource);
246
247    // Handles |msg|, and may modify it. Returns true iff completely handled it and
248    // |msg| does not need to be sent to the event listener.
249    bool handleMessage(omx_message &msg);
250
251    OMXNodeInstance(const OMXNodeInstance &);
252    OMXNodeInstance &operator=(const OMXNodeInstance &);
253};
254
255}  // namespace android
256
257#endif  // OMX_NODE_INSTANCE_H_
258