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