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