IOMX.h revision 0a5ca668c6f7d45706e9aec4a1dfec0aacc6d233 
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 storeMetaDataInBuffers(
83            node_id node, OMX_U32 port_index, OMX_BOOL enable) = 0;
84
85    virtual status_t enableGraphicBuffers(
86            node_id node, OMX_U32 port_index, OMX_BOOL enable) = 0;
87
88    virtual status_t useBuffer(
89            node_id node, OMX_U32 port_index, const sp<IMemory> &params,
90            buffer_id *buffer) = 0;
91
92    virtual status_t useGraphicBuffer(
93            node_id node, OMX_U32 port_index,
94            const sp<GraphicBuffer> &graphicBuffer, buffer_id *buffer) = 0;
95
96    // This API clearly only makes sense if the caller lives in the
97    // same process as the callee, i.e. is the media_server, as the
98    // returned "buffer_data" pointer is just that, a pointer into local
99    // address space.
100    virtual status_t allocateBuffer(
101            node_id node, OMX_U32 port_index, size_t size,
102            buffer_id *buffer, void **buffer_data) = 0;
103
104    virtual status_t allocateBufferWithBackup(
105            node_id node, OMX_U32 port_index, const sp<IMemory> &params,
106            buffer_id *buffer) = 0;
107
108    virtual status_t freeBuffer(
109            node_id node, OMX_U32 port_index, buffer_id buffer) = 0;
110
111    virtual status_t fillBuffer(node_id node, buffer_id buffer) = 0;
112
113    virtual status_t emptyBuffer(
114            node_id node,
115            buffer_id buffer,
116            OMX_U32 range_offset, OMX_U32 range_length,
117            OMX_U32 flags, OMX_TICKS timestamp) = 0;
118
119    virtual status_t getExtensionIndex(
120            node_id node,
121            const char *parameter_name,
122            OMX_INDEXTYPE *index) = 0;
123};
124
125struct omx_message {
126    enum {
127        EVENT,
128        EMPTY_BUFFER_DONE,
129        FILL_BUFFER_DONE,
130
131    } type;
132
133    IOMX::node_id node;
134
135    union {
136        // if type == EVENT
137        struct {
138            OMX_EVENTTYPE event;
139            OMX_U32 data1;
140            OMX_U32 data2;
141        } event_data;
142
143        // if type == EMPTY_BUFFER_DONE
144        struct {
145            IOMX::buffer_id buffer;
146        } buffer_data;
147
148        // if type == FILL_BUFFER_DONE
149        struct {
150            IOMX::buffer_id buffer;
151            OMX_U32 range_offset;
152            OMX_U32 range_length;
153            OMX_U32 flags;
154            OMX_TICKS timestamp;
155            OMX_PTR platform_private;
156            OMX_PTR data_ptr;
157        } extended_buffer_data;
158
159    } u;
160};
161
162class IOMXObserver : public IInterface {
163public:
164    DECLARE_META_INTERFACE(OMXObserver);
165
166    virtual void onMessage(const omx_message &msg) = 0;
167};
168
169////////////////////////////////////////////////////////////////////////////////
170
171class BnOMX : public BnInterface<IOMX> {
172public:
173    virtual status_t onTransact(
174            uint32_t code, const Parcel &data, Parcel *reply,
175            uint32_t flags = 0);
176};
177
178class BnOMXObserver : public BnInterface<IOMXObserver> {
179public:
180    virtual status_t onTransact(
181            uint32_t code, const Parcel &data, Parcel *reply,
182            uint32_t flags = 0);
183};
184
185}  // namespace android
186
187#endif  // ANDROID_IOMX_H_
188