The Openmax Integration Layer Specification
Total Page:16
File Type:pdf, Size:1020Kb
OpenMAX™ Integration Layer Application Programming Interface Specification Version 1.0 Copyright © 2005 The Khronos Group Inc. December 16, 2005 Document version 1.10 Copyright © 2005 The Khronos Group Inc. All Rights Reserved. This specification is protected by copyright laws and contains material proprietary to the Khronos Group, Inc. It or any components may not be reproduced, republished, distributed, transmitted, displayed, broadcast, or otherwise exploited in any manner without the express prior written permission of the Khronos Group. You may use this specification for implementing the functionality therein, without altering or removing any trademark, copyright or other notice from the specification, but the receipt or possession of this specification does not convey any rights to reproduce, disclose, or distribute its contents, or to manufacture, use, or sell anything that it may describe, in whole or in part. Khronos Group grants express permission to any current Promoter, Contributor or Adopter member of Khronos to copy and redistribute UNMODIFIED versions of this specification in any fashion, provided that NO CHARGE is made for the specification and the latest available update of the specification for any version of the API is used whenever possible. Such distributed specification may be reformatted AS LONG AS the contents of the specification are not changed in any way. The specification may be incorporated into a product that is sold as long as such product includes significant independent work developed by the seller. A link to the current version of this specification on the Khronos Group website should be included whenever possible with specification distributions. Khronos Group makes no, and expressly disclaims any, representations or warranties, express or implied, regarding this specification, including, without limitation, any implied warranties of merchantability or fitness for a particular purpose or non-infringement of any intellectual property. Khronos Group makes no, and expressly disclaims any, warranties, express or implied, regarding the correctness, accuracy, completeness, timeliness, and reliability of the specification. Under no circumstances will the Khronos Group, or any of its Promoters, Contributors or Members or their respective partners, officers, directors, employees, agents or representatives be liable for any damages, whether direct, indirect, special or consequential damages for lost revenues, lost profits, or otherwise, arising from or in connection with these materials. SAMPLE CODE and EXAMPLES, as identified herein, are expressly depicted herein with a “grey” watermark and are included for illustrative purposes only and are expressly outside of the Scope as defined in Attachment A - Khronos Group Intellectual Property (IP) Rights Policy of the Khronos Group Membership Agreement. A Member or Promoter Member shall have no obligation to grant any licenses under any Necessary Patent Claims covering SAMPLE CODE and EXAMPLES. Khronos and OpenMAX are trademarks of the Khronos Group Inc. Bluetooth is a registered trademark of the Bluetooth Special Interest Group. RealAudio and RealVideo are registered trademarks of RealNetworks, Inc. Windows Media is a registered trademark of Microsoft Corporation. ii Contents 1 OVERVIEW.......................................................................................................................................................8 1.1 INTRODUCTION............................................................................................................................................8 1.1.1 About the Khronos Group......................................................................................................................8 1.1.2 A Brief History of OpenMAX .................................................................................................................8 1.2 THE OPENMAX INTEGRATION LAYER ........................................................................................................8 1.2.1 Key Features and Benefits .....................................................................................................................8 1.2.2 Design Philosophy.................................................................................................................................9 1.2.3 Software Landscape...............................................................................................................................9 1.2.4 Stakeholders.........................................................................................................................................10 1.2.5 The Interface........................................................................................................................................11 1.3 DEFINITIONS..............................................................................................................................................12 1.4 AUTHORS ..................................................................................................................................................13 2 OPENMAX IL INTRODUCTION AND ARCHITECTURE......................................................................14 2.1 OPENMAX IL DESCRIPTION .....................................................................................................................14 2.1.1 Architectural Overview........................................................................................................................14 2.1.2 Key Vocabulary ...................................................................................................................................15 2.1.3 System Components .............................................................................................................................17 2.1.4 Component States ................................................................................................................................18 2.1.5 Component Architecture......................................................................................................................20 2.1.6 Communication Behavior ....................................................................................................................20 2.1.7 Tunneled Buffer Allocation and Sharing .............................................................................................21 2.1.8 Port Reconnection ...............................................................................................................................28 2.1.9 Queues and Flush ................................................................................................................................30 2.1.10 Marking Buffers ..............................................................................................................................31 2.1.11 Events and Callbacks......................................................................................................................32 2.1.12 Buffer Payload ................................................................................................................................33 2.1.13 Buffer Flags and Timestamps..........................................................................................................35 2.1.14 Synchronization...............................................................................................................................35 2.1.15 Rate Control....................................................................................................................................36 2.1.16 Component Registration .................................................................................................................36 2.1.17 Resource Management....................................................................................................................36 3 OPENMAX INTEGRATION LAYER CONTROL API..............................................................................41 3.1 OPENMAX TYPES.....................................................................................................................................42 3.1.1 Enumerations.......................................................................................................................................42 3.1.2 Structures.............................................................................................................................................53 3.1.3 OMX_PORTDOMAINTYPE................................................................................................................65 3.1.4 OMX_HANDLETYPE..........................................................................................................................66 3.2 OPENMAX CORE METHODS/MACROS ......................................................................................................66 3.2.1 Return Codes for the Functions ...........................................................................................................67 3.2.2 Macros.................................................................................................................................................69 3.2.3 Functions .............................................................................................................................................87 3.3 OPENMAX COMPONENT METHODS AND STRUCTURES.............................................................................94 3.3.1 nSize.....................................................................................................................................................94