| /*-------------------------------------------------------------------------- |
| Copyright (c) 2009, The Linux Foundation. All rights reserved. |
| |
| Redistribution and use in source and binary forms, with or without |
| modification, are permitted provided that the following conditions are met: |
| * Redistributions of source code must retain the above copyright |
| notice, this list of conditions and the following disclaimer. |
| * Redistributions in binary form must reproduce the above copyright |
| notice, this list of conditions and the following disclaimer in the |
| documentation and/or other materials provided with the distribution. |
| * Neither the name of The Linux Foundation nor |
| the names of its contributors may be used to endorse or promote |
| products derived from this software without specific prior written |
| permission. |
| |
| THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
| NON-INFRINGEMENT ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR |
| CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
| EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
| PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; |
| OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, |
| WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR |
| OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF |
| ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| --------------------------------------------------------------------------*/ |
| /*============================================================================ |
| O p e n M A X w r a p p e r s |
| O p e n M A X C o m p o n e n t I n t e r f a c e |
| |
| *//** @file qc_omx_component.h |
| This module contains the abstract interface for the OpenMAX components. |
| |
| *//*========================================================================*/ |
| |
| #ifndef QC_OMX_COMPONENT_H |
| #define QC_OMX_COMPONENT_H |
| ////////////////////////////////////////////////////////////////////////////// |
| // Include Files |
| ////////////////////////////////////////////////////////////////////////////// |
| #include "OMX_Core.h" |
| #include "OMX_Component.h" |
| |
| class qc_omx_component |
| { |
| |
| public: |
| /* single member to hold the vtable */ |
| OMX_COMPONENTTYPE m_cmp; |
| |
| public: |
| |
| // this is critical, otherwise, sub class destructor will not be called |
| virtual ~qc_omx_component(){} |
| |
| // Initialize the component after creation |
| virtual OMX_ERRORTYPE component_init(OMX_IN OMX_STRING componentName)=0; |
| |
| /*******************************************************************/ |
| /* Standard OpenMAX Methods */ |
| /*******************************************************************/ |
| |
| // Query the component for its information |
| virtual |
| OMX_ERRORTYPE get_component_version(OMX_HANDLETYPE cmp_handle, |
| OMX_STRING cmp_name, |
| OMX_VERSIONTYPE* cmp_version, |
| OMX_VERSIONTYPE* spec_version, |
| OMX_UUIDTYPE* cmp_UUID)=0; |
| |
| // Invoke a command on the component |
| virtual |
| OMX_ERRORTYPE send_command(OMX_HANDLETYPE cmp_handle, |
| OMX_COMMANDTYPE cmd, |
| OMX_U32 param1, |
| OMX_PTR cmd_data)=0; |
| |
| // Get a Parameter setting from the component |
| virtual |
| OMX_ERRORTYPE get_parameter(OMX_HANDLETYPE cmp_handle, |
| OMX_INDEXTYPE param_index, |
| OMX_PTR param_data)=0; |
| |
| // Send a parameter structure to the component |
| virtual |
| OMX_ERRORTYPE set_parameter(OMX_HANDLETYPE cmp_handle, |
| OMX_INDEXTYPE param_index, |
| OMX_PTR param_data)=0; |
| |
| // Get a configuration structure from the component |
| virtual |
| OMX_ERRORTYPE get_config(OMX_HANDLETYPE cmp_handle, |
| OMX_INDEXTYPE config_index, |
| OMX_PTR config_data)=0; |
| |
| // Set a component configuration value |
| virtual |
| OMX_ERRORTYPE set_config(OMX_HANDLETYPE cmp_handle, |
| OMX_INDEXTYPE config_index, |
| OMX_PTR config_data)=0; |
| |
| // Translate the vendor specific extension string to |
| // standardized index type |
| virtual |
| OMX_ERRORTYPE get_extension_index(OMX_HANDLETYPE cmp_handle, |
| OMX_STRING paramName, |
| OMX_INDEXTYPE* indexType)=0; |
| |
| // Get Current state information |
| virtual |
| OMX_ERRORTYPE get_state(OMX_HANDLETYPE cmp_handle, |
| OMX_STATETYPE* state)=0; |
| |
| // Component Tunnel Request |
| virtual |
| OMX_ERRORTYPE component_tunnel_request(OMX_HANDLETYPE cmp_handle, |
| OMX_U32 port, |
| OMX_HANDLETYPE peer_component, |
| OMX_U32 peer_port, |
| OMX_TUNNELSETUPTYPE* tunnel_setup)=0; |
| |
| // Use a buffer already allocated by the IL client |
| // or a buffer already supplied by a tunneled component |
| virtual |
| OMX_ERRORTYPE use_buffer(OMX_HANDLETYPE cmp_handle, |
| OMX_BUFFERHEADERTYPE** buffer_hdr, |
| OMX_U32 port, |
| OMX_PTR app_data, |
| OMX_U32 bytes, |
| OMX_U8* buffer)=0; |
| |
| |
| // Request that the component allocate new buffer and associated header |
| virtual |
| OMX_ERRORTYPE allocate_buffer(OMX_HANDLETYPE cmp_handle, |
| OMX_BUFFERHEADERTYPE** buffer_hdr, |
| OMX_U32 port, |
| OMX_PTR app_data, |
| OMX_U32 bytes)=0; |
| |
| // Release the buffer and associated header from the component |
| virtual |
| OMX_ERRORTYPE free_buffer(OMX_HANDLETYPE cmp_handle, |
| OMX_U32 port, |
| OMX_BUFFERHEADERTYPE* buffer)=0; |
| |
| // Send a filled buffer to an input port of a component |
| virtual |
| OMX_ERRORTYPE empty_this_buffer(OMX_HANDLETYPE cmp_handle, |
| OMX_BUFFERHEADERTYPE* buffer)=0; |
| |
| // Send an empty buffer to an output port of a component |
| virtual |
| OMX_ERRORTYPE fill_this_buffer(OMX_HANDLETYPE cmp_handle, |
| OMX_BUFFERHEADERTYPE* buffer)=0; |
| |
| // Set callbacks |
| virtual |
| OMX_ERRORTYPE set_callbacks( OMX_HANDLETYPE cmp_handle, |
| OMX_CALLBACKTYPE* callbacks, |
| OMX_PTR app_data)=0; |
| |
| // Component De-Initialize |
| virtual |
| OMX_ERRORTYPE component_deinit( OMX_HANDLETYPE cmp_handle)=0; |
| |
| // Use the Image already allocated via EGL |
| virtual |
| OMX_ERRORTYPE use_EGL_image(OMX_HANDLETYPE cmp_handle, |
| OMX_BUFFERHEADERTYPE** buffer_hdr, |
| OMX_U32 port, |
| OMX_PTR app_data, |
| void* egl_image)=0; |
| |
| // Component Role enum |
| virtual |
| OMX_ERRORTYPE component_role_enum( OMX_HANDLETYPE cmp_handle, |
| OMX_U8* role, |
| OMX_U32 index)=0; |
| |
| }; |
| #endif /* QC_OMX_COMPONENT_H */ |
