xref: /utopia/UTPA2-700.0.x/projects/tmplib/include/apiGOPSC_Ex.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 
95 ///////////////////////////////////////////////////////////////////////////////////////////////////
96 ///
97 /// @file   apiGOP_SC.h
98 /// @brief  MStar Graphics Output Path API
99 /// @author MStar Semiconductor Inc.
100 ///////////////////////////////////////////////////////////////////////////////////////////////////
101 
102 #ifndef _API_GOPSC_EX_H_
103 #define _API_GOPSC_EX_H_
104 
105 #ifdef __cplusplus
106 extern "C"
107 {
108 #endif
109 
110 #define MSIF_GOPSC_EX_LIBVER              {'0','0'}            //LIB version
111 #define MSIF_GOPSC_EX_BUILDNUM            {'1','1'}            //Build Number
112 #define MSIF_GOPSC_EX_CHANGELIST          {'0','0','3','9','1','8','8','7'} //P4 ChangeList Number
113 
114 typedef enum
115 {
116     EN_Bilinear = 0,
117     EN_Cubic
118 }EN_GOPSC_VScalingMode;
119 
120 typedef struct
121 {
122     MS_U16 srcWidth;
123     MS_U16 srcHeight;
124     MS_U16 destWidth;
125     MS_U16 destHeight;
126     MS_U8 bEnableScaleX;
127     MS_U8 bEnableScaleY;
128 }GOPSC_SizeInfo;
129 
130 typedef struct
131 {
132     MS_U16 xStart;
133     MS_U16 xEnd;
134     MS_U16 yStart;
135     MS_U16 yEnd;
136     MS_U8 bEnableSkipX;
137     MS_U8 bEnableSkipY;
138 }GOPSC_SkipPixelInfo;
139 
140 typedef struct
141 {
142     MS_U32 u32Version;
143     MS_U32 u32Id;
144 }GOPSC_DeviceInfo;
145 
146 typedef enum
147 {
148     ///failed
149     En_GOPSC_FAIL = 0,
150     ///success
151     En_GOPSC_OK,
152     ///invalid parameter
153     En_GOPSC_INVALID_PARAM,
154     ///access not allow
155     En_GOPSC_NOT_INITIALIZE,
156     ///access not allow
157     En_GOPSC_NotSupport,
158 }GOPSC_Result;
159 
160 typedef enum
161 {
162     None = 0x0,
163     SetOutputRateControl = 0x1,
164     EnableP2I = 0x2,
165     HalfMode = 0x4,
166 }EN_GOPSCCmd;
167 
168 typedef enum
169 {
170     EN_Source_GOP,
171     EN_Source_OP,
172 }EN_GOPSC_Source;
173 
174 typedef struct
175 {
176     EN_GOPSC_VScalingMode en_VScalingMode;
177     EN_GOPSC_Source en_Source;
178     MS_U16 dlyLineNumber; //(unit : 2-line)
179     MS_BOOL P2IEnable;
180     MS_BOOL HalfModeEnable; //output frame rate is half input frame rate
181     MS_BOOL OutputRateControlEnable;
182     MS_BOOL UseP2IFormula; //If GOP use GOPSC result is P2I, scaling factor formula must use change
183 }GOPSC_Info;
184 
185 GOPSC_Result MApi_GOPSC_Init(GOPSC_DeviceInfo* DevInfo);
186 GOPSC_Result MApi_GOPSC_Enable(GOPSC_DeviceInfo* DevInfo, MS_BOOL enable);
187 GOPSC_Result MApi_GOPSC_GetGOPSCInfo(GOPSC_DeviceInfo* DevInfo, GOPSC_Info* gopscInfo);
188 GOPSC_Result MApi_GOPSC_SetGOPSCInfo(GOPSC_DeviceInfo* DevInfo, GOPSC_Info* gopscInfo);
189 GOPSC_Result MApi_GOPSC_SetHVSPSize(GOPSC_DeviceInfo* DevInfo, GOPSC_SizeInfo* sizeInfo, MS_U32 flag);
190 // GOPSC_Result MApi_GOPSC_SetSkipPixel(GOPSC_DeviceInfo* DevInfo, GOPSC_SkipPixelInfo* skippixelInfo, MS_U32 flag);
191 // GOPSC_Result MApi_GOPSC_ScalingDownOnce(GOPSC_DeviceInfo* DevInfo, MS_U8 FrameNum);
192 
193 //MS_BOOL MApi_GOPSC_SetCommand(EN_GOPSCCmd cmds);
194 //EN_GOPSCCmd MApi_GOPSC_GetCommand(void);
195 
196 #ifdef __cplusplus
197 }
198 #endif
199 
200 #endif
201