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