IOMX.h revision a61285dcf1da8a2cf40c499ee3a7b9fc4d74ac58 
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 ANDROID_IOMX_H_
18
19#define ANDROID_IOMX_H_
20
21#include <binder/IInterface.h>
22#include <gui/IGraphicBufferProducer.h>
23#include <ui/GraphicBuffer.h>
24#include <utils/List.h>
25#include <utils/String8.h>
26
27#include <OMX_Core.h>
28#include <OMX_Video.h>
29
30namespace android {
31
32class IMemory;
33class IOMXObserver;
34class IOMXRenderer;
35class Surface;
36
37class IOMX : public IInterface {
38public:
39    DECLARE_META_INTERFACE(OMX);
40
41    typedef void *buffer_id;
42    typedef void *node_id;
43
44    // Given a node_id and the calling process' pid, returns true iff
45    // the implementation of the OMX interface lives in the same
46    // process.
47    virtual bool livesLocally(node_id node, pid_t pid) = 0;
48
49    struct ComponentInfo {
50        String8 mName;
51        List<String8> mRoles;
52    };
53    virtual status_t listNodes(List<ComponentInfo> *list) = 0;
54
55    virtual status_t allocateNode(
56            const char *name, const sp<IOMXObserver> &observer,
57            node_id *node) = 0;
58
59    virtual status_t freeNode(node_id node) = 0;
60
61    virtual status_t sendCommand(
62            node_id node, OMX_COMMANDTYPE cmd, OMX_S32 param) = 0;
63
64    virtual status_t getParameter(
65            node_id node, OMX_INDEXTYPE index,
66            void *params, size_t size) = 0;
67
68    virtual status_t setParameter(
69            node_id node, OMX_INDEXTYPE index,
70            const void *params, size_t size) = 0;
71
72    virtual status_t getConfig(
73            node_id node, OMX_INDEXTYPE index,
74            void *params, size_t size) = 0;
75
76    virtual status_t setConfig(
77            node_id node, OMX_INDEXTYPE index,
78            const void *params, size_t size) = 0;
79
80    virtual status_t getState(
81            node_id node, OMX_STATETYPE* state) = 0;
82
83    virtual status_t storeMetaDataInBuffers(
84            node_id node, OMX_U32 port_index, OMX_BOOL enable) = 0;
85
86    virtual status_t enableGraphicBuffers(
87            node_id node, OMX_U32 port_index, OMX_BOOL enable) = 0;
88
89    virtual status_t getGraphicBufferUsage(
90            node_id node, OMX_U32 port_index, OMX_U32* usage) = 0;
91
92    virtual status_t useBuffer(
93            node_id node, OMX_U32 port_index, const sp<IMemory> &params,
94            buffer_id *buffer) = 0;
95
96    virtual status_t useGraphicBuffer(
97            node_id node, OMX_U32 port_index,
98            const sp<GraphicBuffer> &graphicBuffer, buffer_id *buffer) = 0;
99
100    virtual status_t updateGraphicBufferInMeta(
101            node_id node, OMX_U32 port_index,
102            const sp<GraphicBuffer> &graphicBuffer, buffer_id buffer) = 0;
103
104    virtual status_t createInputSurface(
105            node_id node, OMX_U32 port_index,
106            sp<IGraphicBufferProducer> *bufferProducer) = 0;
107
108    virtual status_t signalEndOfInputStream(node_id node) = 0;
109
110    // This API clearly only makes sense if the caller lives in the
111    // same process as the callee, i.e. is the media_server, as the
112    // returned "buffer_data" pointer is just that, a pointer into local
113    // address space.
114    virtual status_t allocateBuffer(
115            node_id node, OMX_U32 port_index, size_t size,
116            buffer_id *buffer, void **buffer_data) = 0;
117
118    virtual status_t allocateBufferWithBackup(
119            node_id node, OMX_U32 port_index, const sp<IMemory> &params,
120            buffer_id *buffer) = 0;
121
122    virtual status_t freeBuffer(
123            node_id node, OMX_U32 port_index, buffer_id buffer) = 0;
124
125    virtual status_t fillBuffer(node_id node, buffer_id buffer) = 0;
126
127    virtual status_t emptyBuffer(
128            node_id node,
129            buffer_id buffer,
130            OMX_U32 range_offset, OMX_U32 range_length,
131            OMX_U32 flags, OMX_TICKS timestamp) = 0;
132
133    virtual status_t getExtensionIndex(
134            node_id node,
135            const char *parameter_name,
136            OMX_INDEXTYPE *index) = 0;
137
138    enum InternalOptionType {
139        INTERNAL_OPTION_SUSPEND,  // data is a bool
140        INTERNAL_OPTION_REPEAT_PREVIOUS_FRAME_DELAY,  // data is an int64_t
141    };
142    virtual status_t setInternalOption(
143            node_id node,
144            OMX_U32 port_index,
145            InternalOptionType type,
146            const void *data,
147            size_t size) = 0;
148};
149
150struct omx_message {
151    enum {
152        EVENT,
153        EMPTY_BUFFER_DONE,
154        FILL_BUFFER_DONE,
155
156    } type;
157
158    IOMX::node_id node;
159
160    union {
161        // if type == EVENT
162        struct {
163            OMX_EVENTTYPE event;
164            OMX_U32 data1;
165            OMX_U32 data2;
166        } event_data;
167
168        // if type == EMPTY_BUFFER_DONE
169        struct {
170            IOMX::buffer_id buffer;
171        } buffer_data;
172
173        // if type == FILL_BUFFER_DONE
174        struct {
175            IOMX::buffer_id buffer;
176            OMX_U32 range_offset;
177            OMX_U32 range_length;
178            OMX_U32 flags;
179            OMX_TICKS timestamp;
180            OMX_PTR platform_private;
181            OMX_PTR data_ptr;
182        } extended_buffer_data;
183
184    } u;
185};
186
187class IOMXObserver : public IInterface {
188public:
189    DECLARE_META_INTERFACE(OMXObserver);
190
191    virtual void onMessage(const omx_message &msg) = 0;
192};
193
194////////////////////////////////////////////////////////////////////////////////
195
196class BnOMX : public BnInterface<IOMX> {
197public:
198    virtual status_t onTransact(
199            uint32_t code, const Parcel &data, Parcel *reply,
200            uint32_t flags = 0);
201};
202
203class BnOMXObserver : public BnInterface<IOMXObserver> {
204public:
205    virtual status_t onTransact(
206            uint32_t code, const Parcel &data, Parcel *reply,
207            uint32_t flags = 0);
208};
209
210struct CodecProfileLevel {
211    OMX_U32 mProfile;
212    OMX_U32 mLevel;
213};
214
215}  // namespace android
216
217#endif  // ANDROID_IOMX_H_
218