xref: /utopia/UTPA2-700.0.x/projects/tmplib/include/apiMFE_v2.h (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)
1 //<MStar Software>
2 //******************************************************************************
3 // MStar Software
4 // Copyright (c) 2010 - 2012 MStar Semiconductor, Inc. All rights reserved.
5 // All software, firmware and related documentation herein ("MStar Software") are
6 // intellectual property of MStar Semiconductor, Inc. ("MStar") and protected by
7 // law, including, but not limited to, copyright law and international treaties.
8 // Any use, modification, reproduction, retransmission, or republication of all
9 // or part of MStar Software is expressly prohibited, unless prior written
10 // permission has been granted by MStar.
11 //
12 // By accessing, browsing and/or using MStar Software, you acknowledge that you
13 // have read, understood, and agree, to be bound by below terms ("Terms") and to
14 // comply with all applicable laws and regulations:
15 //
16 // 1. MStar shall retain any and all right, ownership and interest to MStar
17 //    Software and any modification/derivatives thereof.
18 //    No right, ownership, or interest to MStar Software and any
19 //    modification/derivatives thereof is transferred to you under Terms.
20 //
21 // 2. You understand that MStar Software might include, incorporate or be
22 //    supplied together with third party`s software and the use of MStar
23 //    Software may require additional licenses from third parties.
24 //    Therefore, you hereby agree it is your sole responsibility to separately
25 //    obtain any and all third party right and license necessary for your use of
26 //    such third party`s software.
27 //
28 // 3. MStar Software and any modification/derivatives thereof shall be deemed as
29 //    MStar`s confidential information and you agree to keep MStar`s
30 //    confidential information in strictest confidence and not disclose to any
31 //    third party.
32 //
33 // 4. MStar Software is provided on an "AS IS" basis without warranties of any
34 //    kind. Any warranties are hereby expressly disclaimed by MStar, including
35 //    without limitation, any warranties of merchantability, non-infringement of
36 //    intellectual property rights, fitness for a particular purpose, error free
37 //    and in conformity with any international standard.  You agree to waive any
38 //    claim against MStar for any loss, damage, cost or expense that you may
39 //    incur related to your use of MStar Software.
40 //    In no event shall MStar be liable for any direct, indirect, incidental or
41 //    consequential damages, including without limitation, lost of profit or
42 //    revenues, lost or damage of data, and unauthorized system use.
43 //    You agree that this Section 4 shall still apply without being affected
44 //    even if MStar Software has been modified by MStar in accordance with your
45 //    request or instruction for your use, except otherwise agreed by both
46 //    parties in writing.
47 //
48 // 5. If requested, MStar may from time to time provide technical supports or
49 //    services in relation with MStar Software to you for your use of
50 //    MStar Software in conjunction with your or your customer`s product
51 //    ("Services").
52 //    You understand and agree that, except otherwise agreed by both parties in
53 //    writing, Services are provided on an "AS IS" basis and the warranty
54 //    disclaimer set forth in Section 4 above shall apply.
55 //
56 // 6. Nothing contained herein shall be construed as by implication, estoppels
57 //    or otherwise:
58 //    (a) conferring any license or right to use MStar name, trademark, service
59 //        mark, symbol or any other identification;
60 //    (b) obligating MStar or any of its affiliates to furnish any person,
61 //        including without limitation, you and your customers, any assistance
62 //        of any kind whatsoever, or any information; or
63 //    (c) conferring any license or right under any intellectual property right.
64 //
65 // 7. These terms shall be governed by and construed in accordance with the laws
66 //    of Taiwan, R.O.C., excluding its conflict of law rules.
67 //    Any and all dispute arising out hereof or related hereto shall be finally
68 //    settled by arbitration referred to the Chinese Arbitration Association,
69 //    Taipei in accordance with the ROC Arbitration Law and the Arbitration
70 //    Rules of the Association by three (3) arbitrators appointed in accordance
71 //    with the said Rules.
72 //    The place of arbitration shall be in Taipei, Taiwan and the language shall
73 //    be English.
74 //    The arbitration award shall be final and binding to both parties.
75 //
76 //******************************************************************************
77 //<MStar Software>
78 ////////////////////////////////////////////////////////////////////////////////
79 //
80 // Copyright (c) 2006-2007 MStar Semiconductor, Inc.
81 // All rights reserved.
82 //
83 // Unless otherwise stipulated in writing, any and all information contained
84 // herein regardless in any format shall remain the sole proprietary of
85 // MStar Semiconductor Inc. and be kept in strict confidence
86 // (��MStar Confidential Information��) by the recipient.
87 // Any unauthorized act including without limitation unauthorized disclosure,
88 // copying, use, reproduction, sale, distribution, modification, disassembling,
89 // reverse engineering and compiling of the contents of MStar Confidential
90 // Information is unlawful and strictly prohibited. MStar hereby reserves the
91 // rights to any and all damages, losses, costs and expenses resulting therefrom.
92 //
93 ////////////////////////////////////////////////////////////////////////////////
94 
95 //////////////////////////////////////////////////////////////////////////////////////////////////
96 ///
97 /// @file   apiMFE_v2.h
98 /// @brief  MFE Driver Interface
99 /// @author MStar Semiconductor Inc.
100 ///////////////////////////////////////////////////////////////////////////////////////////////////
101 
102 #ifndef _API_MFE_V2_H_
103 #define _API_MFE_V2_H_
104 
105 #ifdef __cplusplus
106 extern "C"
107 {
108 #endif
109 
110 #include "drv_mfe_st.h"
111 
112 #include "MsTypes.h"
113 //-------------------------------------------------------------------------------------------------
114 // Defines
115 //-------------------------------------------------------------------------------------------------
116 // below for utopia20 structure
117 
118 typedef enum {
119     MApi_CMD_MFE_Init = 0x0,
120     MApi_CMD_MFE_Encode,
121     MApi_CMD_MFE_GetVOL,
122     MApi_CMD_MFE_CompressOnePicture,
123     MApi_CMD_MFE_DeInit,
124     MApi_CMD_MFE_PowerOff,
125     MApi_CMD_MFE_GetOutBuffer,
126     MApi_CMD_MFE_SetBitrateFramerate,
127     MApi_CMD_MFE_SetColorFormat,
128     MApi_CMD_MFE_ResetSPSPPS,
129     MApi_CMD_MFE_SetFrameType,
130     MApi_CMD_MFE_SetISR,
131     MApi_CMD_MFE_GetHWCap,
132 } E_MFE_V2_IOCTL_CMD;
133 
134 typedef struct _MFE_INIT_PARAM
135 {
136     PVR_Info* mfe_Info;
137     MS_BOOL retVal;
138 }MFE_INIT_PARAM, *PMFE_INIT_PARAM;
139 
140 typedef struct _MFE_SET_PARAM
141 {
142     PVR_Info* mfe_Info;
143     MS_S32 frametype;
144     MS_BOOL retVal;
145 }MFE_SET_PARAM, *PMFE_SET_PARAM;
146 
147 typedef struct _MFE_GETVOL_PARAM
148 {
149     PVR_Info* mfe_Info;
150     void *header_info;
151     MS_BOOL retVal;
152 }MFE_GETVOL_PARAM, *PMFE_GETVOL_PARAM;
153 
154 typedef struct _MFE_COMPRESSONEPICTURE_PARAM
155 {
156     PVR_Info* mfe_Info;
157     MEMMAP_CUR_t YUVPlane;
158     MS_BOOL bForceIframe;
159     MS_BOOL retVal;
160 }MFE_COMPRESSONEPICTURE_PARAM, *PMFE_COMPRESSONEPICTURE_PARAM;
161 
162 typedef struct _MFE_GET_OBUF_PARAM
163 {
164     PVR_Info* mfe_Info;
165     MEMMAP_t* outbuf;
166     MS_BOOL retVal;
167 }MFE_GET_OBUF_PARAM, *PMFE_GET_OBUF_PARAM;
168 
169 typedef struct _MFE_GET_HWCAP_PARAM
170 {
171     PVR_Info* mfe_Info;
172     MFE_HwCapV0 *pDrv;
173     MS_U32 *HwCap_len;
174     MS_BOOL retVal;
175 }MFE_GET_HWCAP_PARAM, *PMFE_GET_HWCAP_PARAM;
176 
177 void MFERegisterToUtopia(FUtopiaOpen ModuleType);
178 MS_U32 MFE_Open(void** ppInstance, MS_U32 u32ModuleVersion, void* pAttribute);
179 MS_U32 MFE_Close(void* pInstance);
180 MS_U32 MFE_Ioctl(void* pInstance, MS_U32 u32Cmd, void* pArgs);
181 
182 
183 #ifdef __cplusplus
184 }
185 #endif
186 
187 #endif // _API_MFE_V2_H_
188 
189 
190