xref: /utopia/UTPA2-700.0.x/mxlib/include/apiDMS_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) 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   apiDMS_v2.h
98 /// @brief  MStar Graphics Output Path API
99 /// @author MStar Semiconductor Inc.
100 ///////////////////////////////////////////////////////////////////////////////////////////////////
101 
102 #ifndef _DMS_V2_H_
103 #define _DMS_V2_H_
104 
105 #ifdef __cplusplus
106 extern "C"
107 {
108 #endif
109 #include "UFO.h"
110 //-------------------------------------------------------------------------------------------------
111 //  Macro and Define
112 //-------------------------------------------------------------------------------------------------
113 
114 /// DMS CMD
115 typedef enum
116 {
117     //DMS command
118     E_DMS_CMD_INIT,
119     E_DMS_CMD_CREATEWINDOW,
120     E_DMS_CMD_CONNECT,
121     E_DMS_CMD_DISCONNECT,
122     E_DMS_CMD_DESTORYWINDOW,
123     E_DMS_CMD_SETWINDOW,
124     E_DMS_CMD_GETWINDOWINFO,
125     E_DMS_CMD_VIDEOFLIP,
126     E_DMS_CMD_SETZORDER,
127     E_DMS_CMD_VIDEOMUTE,
128     E_DMS_CMD_SETMUTECOLOR,
129     E_DMS_CMD_VIDEOFREEZE,
130     E_DMS_CMD_GETSTATUS,
131     E_DMS_CMD_NUM,
132     E_DMS_CMD_MAX = E_DMS_CMD_NUM,
133 }EN_DMS_IOCTL_CMDS;
134 
135 typedef struct DLL_PACKED
136 {
137     ST_DMS_INITDATA *pstDMS_InitData;
138     MS_U32 u32InitDataLen;
139     EN_DMS_RESULT eReturnValue;
140 } ST_DMS_INIT,*PST_DMS_INIT;
141 
142 typedef struct DLL_PACKED
143 {
144     ST_DMS_WINDOW stOutputWin;
145     MS_U32 u32ZOrder;
146     MS_U32* pu32WindowID;
147     EN_DMS_RESULT eReturnValue;
148 } ST_DMS_CREATEWIN,*PST_DMS_CREATEWIN;
149 
150 typedef struct DLL_PACKED
151 {
152     MS_U32 u32WindowID;
153     MS_U32 enInputSourceType;
154     ST_DMS_DISPFRAMEFORMAT *pstDispFrameFormat;
155     EN_DMS_RESULT eReturnValue;
156 } ST_DMS_CONNECT,*PST_DMS_CONNECT;
157 
158 typedef struct DLL_PACKED
159 {
160     MS_U32 u32WindowID;
161     EN_DMS_RESULT eReturnValue;
162 } ST_DMS_DISCONNECT,*PST_DMS_DISCONNECT;
163 
164 typedef struct DLL_PACKED
165 {
166     MS_U32 u32WindowID;
167     EN_DMS_RESULT eReturnValue;
168 } ST_DMS_DESTORYWIN,*PST_DMS_DESTORYWIN;
169 
170 typedef struct DLL_PACKED
171 {
172     MS_U32 u32WindowID;
173     ST_DMS_SETWIN_INFO *pstDMS_SetWin_Info;
174     MS_U32 u32InfoDataLen;
175     EN_DMS_RESULT eReturnValue;
176 } ST_DMS_SETWIN,*PST_DMS_SETWIN;
177 
178 typedef struct DLL_PACKED
179 {
180     MS_U32 u32WindowID;
181     ST_DMS_GETWIN_INFO *pstDMS_GetWin_Info;
182     MS_U32 u32InfoDataLen;
183     EN_DMS_RESULT eReturnValue;
184 } ST_DMS_GETWININFO,*PST_DMS_GETWININFO;
185 
186 typedef struct DLL_PACKED
187 {
188     MS_U32 u32WindowID;
189     ST_DMS_DISPFRAMEFORMAT* pstDispFrameFormat;
190     MS_U32 u32InfoDataLen;
191     EN_DMS_RESULT eReturnValue;
192 } ST_DMS_FLIP,*PST_DMS_FLIP;
193 
194 typedef struct DLL_PACKED
195 {
196     MS_U32 u32WindowID;
197     MS_U32 u32ZOrder;
198     EN_DMS_RESULT eReturnValue;
199 } ST_DMS_ZORDER,*PST_DMS_ZORDER;
200 
201 typedef struct DLL_PACKED
202 {
203     MS_U32 u32WindowID;
204     MS_U32 u32Enable;
205     EN_DMS_RESULT eReturnValue;
206 } ST_DMS_FREEZE,*PST_DMS_FREEZE;
207 
208 typedef struct DLL_PACKED
209 {
210     MS_U32 u32WindowID;
211     MS_U32 u32Enable;
212     EN_DMS_RESULT eReturnValue;
213 } ST_DMS_MUTE,*PST_DMS_MUTE;
214 
215 typedef struct DLL_PACKED
216 {
217     MS_U32 u32WindowID;
218     ST_DMS_COLOR stMuteColor;
219     EN_DMS_RESULT eReturnValue;
220 } ST_DMS_MUTECOLOR,*PST_DMS_MUTECOLOR;
221 
222 typedef struct DLL_PACKED
223 {
224     EN_DMS_STATUS *peStatus;
225     EN_DMS_RESULT eReturnValue;
226 } ST_DMS_GETSTATUS,*PST_DMS_GETSTATUS;
227 
228 #ifdef __cplusplus
229 }
230 #endif
231 
232 #endif
233 
234