xref: /utopia/UTPA2-700.0.x/mxlib/include/apiXC_VMark.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-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 /// @file  apiXC_ModeParse.h
94 /// @brief MIU header file
95 /// @author MStar Semiconductor Inc.
96 ///
97 ////////////////////////////////////////////////////////////////////////////////
98 #ifndef _API_XC_VMARK_H_
99 #define _API_XC_VMARK_H_
100 #ifdef __cplusplus
101 extern "C"
102 {
103 #endif
104 
105 //-------------------------------------------------------------------------------------------------
106 //  Include Files
107 //-------------------------------------------------------------------------------------------------
108 #include "apiXC.h"
109 //-------------------------------------------------------------------------------------------------
110 //  Macro and Define
111 //-------------------------------------------------------------------------------------------------
112 
113 /// vmark data
114 #define XC_VMARK_PARAMETER_VERSION             1
115 
116 //-------------------------------------------------------------------------------------------------
117 //  Type and Structure
118 //-------------------------------------------------------------------------------------------------
119 
120 
121 typedef struct __attribute__((packed))
122 {
123     //versioning
124     MS_U32 u32XC_VMark_version;                   ///<Version of current structure.
125     MS_U32 u32XC_VMarK_Length;                   ///<Length of this structure, u32XC_VMarK_Length=sizeof(XC_VMARK_PARAMETER)
126     //embedding part
127     MS_U8 u8WatermarkOn;
128     MS_U8 u8FrequencyDistance[3][3];
129     MS_U8 u8BackgroundEmbeddingOn;
130     MS_U16 u16EmbeddingStrengthThreshold[48];
131     MS_U16 u16EmbeddingStrengthThresholdBG[48];
132     MS_U16 u16DirectionMax;
133     MS_S8 s8StrengthMultiply;
134     //rendering part
135     MS_U8 u8PayloadSymbols[1920];
136     MS_U8 u8SymbolsRows;
137     MS_U8 u8SymbolsCols;
138     MS_U8 u8SymbolsXpos;
139     MS_U8 u8SymbolsYpos;
140     MS_U8 u8SymbolSize;
141     MS_U16 u16SpacingVert;
142     MS_U16 u16SpacingHorz;
143     MS_U8 u8SymbolScaleControl;
144 }XC_VMARK_PARAMETER;
145 
146 //-------------------------------------------------------------------------------------------------
147 //  Function and Variable
148 //-------------------------------------------------------------------------------------------------
149 
150 #ifdef UFO_XC_VMARK
151 //-------------------------------------------------------------------------------------------------
152 /// MApi_XC_VMark_SetParameters
153 /// @param  u8ServiceIndex                       \b IN: Identifies uniquely a video stream inside the decoder. May not be supported if the support of a single decode is sufficient.
154 /// @param  pstXC_VMarkParameters           \b IN: VMark parameters for HW embedding
155 //-------------------------------------------------------------------------------------------------
156 DLL_PUBLIC E_APIXC_ReturnValue MApi_XC_VMark_SetParameters(MS_U8 u8ServiceIndex, XC_VMARK_PARAMETER *pstXC_VMarkParameters);
157 #endif
158 
159 #ifdef __cplusplus
160 }
161 #endif
162 
163 #endif /* _API_XC_VMARK_H_ */
164