xref: /utopia/UTPA2-700.0.x/modules/mfe/api/mfe_ex/apiMFE_priv.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) 2008-2009 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 #ifndef _APIMFE_PRIV_H_
95 #define _APIMFE_PRIV_H_
96 
97 ////////////////////////////////////////////////////////////////////////////////
98 /// @file apiMFE.h
99 /// @author MStar Semiconductor Inc.
100 /// @brief MFE control driver
101 ////////////////////////////////////////////////////////////////////////////////
102 
103 ////////////////////////////////////////////////////////////////////////////////
104 // Header Files
105 ////////////////////////////////////////////////////////////////////////////////
106 #ifdef __cplusplus
107 extern "C"
108 {
109 #endif
110 
111 #include "MsTypes.h"
112 #include "drv_mfe_st.h"
113 #include "mfe_common.h"
114 
115 typedef MS_BOOL (*IOCTL_MFE_INIT)(PVR_Info*);
116 typedef MS_BOOL (*IOCTL_MFE_ENCODE)(PVR_Info*);
117 typedef MS_BOOL (*IOCTL_MFE_GETVOL)(PVR_Info*, void*);
118 typedef MS_BOOL (*IOCTL_MFE_COMPRESSONEPICTURE)(PVR_Info*, MEMMAP_CUR_t, MS_BOOL);
119 typedef MS_BOOL (*IOCTL_MFE_DEINIT)(PVR_Info*);
120 typedef MS_BOOL (*IOCTL_MFE_POWEROFF)(PVR_Info*);
121 
122 typedef MS_BOOL (*IOCTL_MFE_GETOBUF)(PVR_Info* mfe_Info,MEMMAP_t* obuf);
123 
124 typedef MS_BOOL (*IOCTL_MFE_SETBITRATE_FRAMERATE)(PVR_Info* mfe_Info);
125 typedef MS_BOOL (*IOCTL_MFE_SETCOLORFORMAT)(PVR_Info* mfe_Info);
126 typedef MS_BOOL (*IOCTL_MFE_RESETSPSPPS)(PVR_Info* mfe_Info);
127 typedef MS_BOOL (*IOCTL_MFE_SETFRAMETYPE)(PVR_Info* mfe_Info,MS_S32 frametype);
128 typedef MS_BOOL (*IOCTL_MFE_SETISR)(PVR_Info* mfe_Info);
129 typedef MS_BOOL (*IOCTL_MFE_GETHWCAP)(PVR_Info* mfe_Info, MFE_HwCapV0 *pDrv, MS_U32 *len);
130 typedef MS_BOOL (*IOCTL_MFE_GETOUTPUT_INFO)(PVR_Info *mfe_Info, MS_S32 *frametype, MS_S32 *size);
131 typedef MS_BOOL (*IOCTL_MFE_SETVUI)(PVR_Info* mfe_Info, VUI_Info* vui_info);
132 
133 typedef struct __attribute__((packed)) _MFE_INSTANCE_PRIVATE
134 {
135     // instance variable
136     IOCTL_MFE_INIT                    fpMFEInit;
137     IOCTL_MFE_ENCODE                  fpMFEEncode;
138     IOCTL_MFE_GETVOL                  fpMFEGetVOL;
139     IOCTL_MFE_COMPRESSONEPICTURE      fpMFECompressOnePicture;
140     IOCTL_MFE_DEINIT                  fpMFEDeInit;
141     IOCTL_MFE_POWEROFF                fpMFEPowerOff;
142     IOCTL_MFE_GETOBUF                 fpMFEGetOBuf;
143     IOCTL_MFE_SETBITRATE_FRAMERATE    fpMFESetBitrateFramerate;
144     IOCTL_MFE_SETCOLORFORMAT          fpMFESetColorFormat;
145     IOCTL_MFE_RESETSPSPPS             fpMFEResetSPSPPS;
146     IOCTL_MFE_SETFRAMETYPE            fpMFESetFrameType;
147     IOCTL_MFE_SETISR                  fpMFESetISR;
148     IOCTL_MFE_GETHWCAP                fpMFEGetHWCap;
149     IOCTL_MFE_GETOUTPUT_INFO          fpMFEGetOutputInfo;
150     IOCTL_MFE_SETVUI                  fpMFESetVUI;
151 }MFE_INSTANCE_PRIVATE;
152 
153 typedef struct __attribute__((packed)) _MFE_RESOURCE_PRIVATE
154 {
155     MS_S32 sAliveInstance;
156 }MFE_RESOURCE_PRIVATE;
157 
158 void MFERegisterToUtopia(FUtopiaOpen ModuleType);
159 MS_U32 MFEOpen(void** ppInstance, MS_U32 u32ModuleVersion, void* pAttribute);
160 MS_U32 MFEClose(void* pInstance);
161 MS_U32 MFEIoctl(void* pInstance, MS_U32 u32Cmd, void* pArgs);
162 
163 
164 MS_BOOL _MApi_MFE_Init(PVR_Info* mfe_Info);
165 MS_BOOL _MApi_MFE_Encode(PVR_Info* mfe_Info);
166 MS_BOOL _MApi_MFE_GetVOL(PVR_Info* mfe_Info, void *header_info);
167 MS_BOOL _MApi_MFE_CompressOnePicture(PVR_Info* mfe_Info, MEMMAP_CUR_t YUVPlane, MS_BOOL bForceIframe);
168 MS_BOOL _MApi_MFE_DeInit(PVR_Info* mfe_Info);
169 MS_BOOL _MApi_MFE_PowerOff(PVR_Info* mfe_Info);
170 
171 MS_BOOL _MApi_MFE_GetOBuf(PVR_Info* mfe_Info,MEMMAP_t* obuf);
172 
173 MS_BOOL _MApi_MFE_SetBitrateFramerate(PVR_Info* mfe_Info);
174 MS_BOOL _MApi_MFE_SetColorFormat(PVR_Info* mfe_Info);
175 MS_BOOL _MApi_MFE_ResetSPSPPS(PVR_Info* mfe_Info);
176 MS_BOOL _MApi_MFE_SetFrameType(PVR_Info* mfe_Info, MS_S32 frametype);
177 MS_BOOL _MApi_MFE_ISREnable(PVR_Info* mfe_Info);
178 MS_BOOL _MApi_MFE_GetHWCap(PVR_Info* mfe_Info, MFE_HwCapV0 *pDrv, MS_U32 *len);
179 MS_BOOL _MApi_MFE_GetOutputInfo(PVR_Info *mfe_Info, MS_S32 *frametype, MS_S32 *size);
180 MS_BOOL _MApi_MFE_SetVUI(PVR_Info *mfe_Info, VUI_Info* vui_info);
181 #ifdef __cplusplus
182 }
183 #endif
184 #endif // _APIMFE_PRIV_H_
185 
186 
187 
188 
189 
190