OMXNodeInstance.h revision 609b815a3131d22da38b2f452faa9f89daad4039 
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;
30struct GraphicBufferSource;
31
32struct OMXNodeInstance {
33    OMXNodeInstance(
34            OMX *owner, const sp<IOMXObserver> &observer);
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 enableGraphicBuffers(OMX_U32 portIndex, OMX_BOOL enable);
56
57    status_t getGraphicBufferUsage(OMX_U32 portIndex, OMX_U32* usage);
58
59    status_t storeMetaDataInBuffers(OMX_U32 portIndex, OMX_BOOL enable);
60
61    status_t prepareForAdaptivePlayback(
62            OMX_U32 portIndex, OMX_BOOL enable,
63            OMX_U32 maxFrameWidth, OMX_U32 maxFrameHeight);
64
65    status_t useBuffer(
66            OMX_U32 portIndex, const sp<IMemory> &params,
67            OMX::buffer_id *buffer);
68
69    status_t useGraphicBuffer(
70            OMX_U32 portIndex, const sp<GraphicBuffer> &graphicBuffer,
71            OMX::buffer_id *buffer);
72
73    status_t updateGraphicBufferInMeta(
74            OMX_U32 portIndex, const sp<GraphicBuffer> &graphicBuffer,
75            OMX::buffer_id buffer);
76
77    status_t createInputSurface(
78            OMX_U32 portIndex, sp<IGraphicBufferProducer> *bufferProducer);
79
80    status_t signalEndOfInputStream();
81
82    status_t allocateBuffer(
83            OMX_U32 portIndex, size_t size, OMX::buffer_id *buffer,
84            void **buffer_data);
85
86    status_t allocateBufferWithBackup(
87            OMX_U32 portIndex, const sp<IMemory> &params,
88            OMX::buffer_id *buffer);
89
90    status_t freeBuffer(OMX_U32 portIndex, OMX::buffer_id buffer);
91
92    status_t fillBuffer(OMX::buffer_id buffer);
93
94    status_t emptyBuffer(
95            OMX::buffer_id buffer,
96            OMX_U32 rangeOffset, OMX_U32 rangeLength,
97            OMX_U32 flags, OMX_TICKS timestamp);
98
99    status_t emptyDirectBuffer(
100            OMX_BUFFERHEADERTYPE *header,
101            OMX_U32 rangeOffset, OMX_U32 rangeLength,
102            OMX_U32 flags, OMX_TICKS timestamp);
103
104    status_t getExtensionIndex(
105            const char *parameterName, OMX_INDEXTYPE *index);
106
107    status_t setInternalOption(
108            OMX_U32 portIndex,
109            IOMX::InternalOptionType type,
110            const void *data,
111            size_t size);
112
113    void onMessage(const omx_message &msg);
114    void onObserverDied(OMXMaster *master);
115    void onGetHandleFailed();
116    void onEvent(OMX_EVENTTYPE event, OMX_U32 arg1, OMX_U32 arg2);
117
118    static OMX_CALLBACKTYPE kCallbacks;
119
120private:
121    Mutex mLock;
122
123    OMX *mOwner;
124    OMX::node_id mNodeID;
125    OMX_HANDLETYPE mHandle;
126    sp<IOMXObserver> mObserver;
127    bool mDying;
128
129    // Lock only covers mGraphicBufferSource.  We can't always use mLock
130    // because of rare instances where we'd end up locking it recursively.
131    Mutex mGraphicBufferSourceLock;
132    // Access this through getGraphicBufferSource().
133    sp<GraphicBufferSource> mGraphicBufferSource;
134
135
136    struct ActiveBuffer {
137        OMX_U32 mPortIndex;
138        OMX::buffer_id mID;
139    };
140    Vector<ActiveBuffer> mActiveBuffers;
141#ifdef __LP64__
142    Mutex mBufferIDLock;
143    uint32_t mBufferIDCount;
144    KeyedVector<OMX::buffer_id, OMX_BUFFERHEADERTYPE *> mBufferIDToBufferHeader;
145    KeyedVector<OMX_BUFFERHEADERTYPE *, OMX::buffer_id> mBufferHeaderToBufferID;
146#endif
147
148    ~OMXNodeInstance();
149
150    void addActiveBuffer(OMX_U32 portIndex, OMX::buffer_id id);
151    void removeActiveBuffer(OMX_U32 portIndex, OMX::buffer_id id);
152    void freeActiveBuffers();
153
154    // For buffer id management
155    OMX::buffer_id makeBufferID(OMX_BUFFERHEADERTYPE *bufferHeader);
156    OMX_BUFFERHEADERTYPE *findBufferHeader(OMX::buffer_id buffer);
157    OMX::buffer_id findBufferID(OMX_BUFFERHEADERTYPE *bufferHeader);
158    void invalidateBufferID(OMX::buffer_id buffer);
159
160    status_t useGraphicBuffer2_l(
161            OMX_U32 portIndex, const sp<GraphicBuffer> &graphicBuffer,
162            OMX::buffer_id *buffer);
163    static OMX_ERRORTYPE OnEvent(
164            OMX_IN OMX_HANDLETYPE hComponent,
165            OMX_IN OMX_PTR pAppData,
166            OMX_IN OMX_EVENTTYPE eEvent,
167            OMX_IN OMX_U32 nData1,
168            OMX_IN OMX_U32 nData2,
169            OMX_IN OMX_PTR pEventData);
170
171    static OMX_ERRORTYPE OnEmptyBufferDone(
172            OMX_IN OMX_HANDLETYPE hComponent,
173            OMX_IN OMX_PTR pAppData,
174            OMX_IN OMX_BUFFERHEADERTYPE *pBuffer);
175
176    static OMX_ERRORTYPE OnFillBufferDone(
177            OMX_IN OMX_HANDLETYPE hComponent,
178            OMX_IN OMX_PTR pAppData,
179            OMX_IN OMX_BUFFERHEADERTYPE *pBuffer);
180
181    status_t storeMetaDataInBuffers_l(OMX_U32 portIndex, OMX_BOOL enable);
182
183    sp<GraphicBufferSource> getGraphicBufferSource();
184    void setGraphicBufferSource(const sp<GraphicBufferSource>& bufferSource);
185
186    OMXNodeInstance(const OMXNodeInstance &);
187    OMXNodeInstance &operator=(const OMXNodeInstance &);
188};
189
190}  // namespace android
191
192#endif  // OMX_NODE_INSTANCE_H_
193