xref: /utopia/UTPA2-700.0.x/modules/njpd/drv/njpd_ex/jpeg_def.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    jpeg_def.h
98 /// @brief  JPEG internal definition
99 /// @author MStar Semiconductor Inc.
100 ///////////////////////////////////////////////////////////////////////////////////////////////////
101 
102 #ifndef _JPEG_DEF_H_
103 #define _JPEG_DEF_H_
104 
105 //-------------------------------------------------------------------------------------------------
106 //  Local Compiler Options
107 //-------------------------------------------------------------------------------------------------
108 #define JPEG_STATIC     static
109 
110 #define MSOS_GET_SYSTEM_TIME    1
111 
112 
113 #if defined(CHIP_EDISON)   // need to modify njpeg_def.h and jpeg_def.h simontaneously
114 #define SUPPORT_OJPD                    TRUE
115 #else
116 #define SUPPORT_OJPD                    FALSE
117 #endif
118 
119 //JPD IP supporting feature
120 #define JPD_SUPPORT_3_HUFFMAN_TABLE                             FALSE//TRUE
121 #define JPD_SUPPORT_AUTO_PROTECT                                FALSE//TRUE
122 
123 #define ENABLE_TEST_09_JPEGWriteProtectTest                     FALSE
124 #define ENABLE_TEST_11_JPEGScaleDownFunctionTest_2              FALSE
125 #define ENABLE_TEST_11_JPEGScaleDownFunctionTest_4              FALSE
126 #define ENABLE_TEST_11_JPEGScaleDownFunctionTest_8              FALSE
127 #define ENABLE_TEST_16_JPEGEnablePsaveModeTest                  FALSE
128 #define ENABLE_TEST_18_miu_sel_128M                             FALSE
129 #define ENABLE_TEST_18_miu_sel_64M                              FALSE
130 #define ENABLE_TEST_18_miu_sel_32M                              FALSE
131 #define ENABLE_TEST_22_AutoProtectFailTest                      FALSE
132 
133 //-------------------------------------------------------------------------------------------------
134 //  Macro and Define
135 //-------------------------------------------------------------------------------------------------
136 //------------------------------------------------------------------------------
137 #define JPEG_BLOCK_TYPE         MS_S16
138 //------------------------------------------------------------------------------
139 #define JPEG_QUANT_TYPE         MS_S16
140 //------------------------------------------------------------------------------
141 // May need to be adjusted if support for other colorspaces/sampling factors is added
142 #define JPEG_MAXBLOCKSPERMCU    10
143 //------------------------------------------------------------------------------
144 #define JPEG_MAXHUFFTABLES      8
145 //------------------------------------------------------------------------------
146 #define JPEG_MAXQUANTTABLES     4
147 //------------------------------------------------------------------------------
148 #define JPEG_MAXCOMPONENTS      4
149 //------------------------------------------------------------------------------
150 #define JPEG_MAXCOMPSINSCAN     4
151 //------------------------------------------------------------------------------
152 //Increase this if you increase the max width!
153 #define JPEG_MAXBLOCKSPERROW    6144
154 
155 #if 0//(defined (MSOS_TYPE_NOS) || defined(MSOS_TYPE_LINUX) || defined(MSOS_TYPE_ECOS))
156 #define JPEG_memcpy(pDstAddr, pSrcAddr, u32Size)                \
157     do {                                                        \
158         MS_U32 idx = 0;                                         \
159         volatile MS_U8 *Dest = (volatile MS_U8 *)(pDstAddr);    \
160         volatile MS_U8 *Src = (volatile MS_U8 *)(pSrcAddr);     \
161         for (idx = 0; idx < (u32Size); idx++)                   \
162         {                                                       \
163             Dest[idx] = Src[idx];                               \
164         }                                                       \
165     }while(0)
166 
167 #define JPEG_memset(pDstAddr, u8value, u32Size)                 \
168     do {                                                        \
169         MS_U32 idx = 0;                                         \
170         volatile MS_U8 *Dest = (volatile MS_U8 *)(pDstAddr);    \
171         for (idx = 0; idx < (u32Size); idx++)                   \
172         {                                                       \
173             Dest[idx] = (u8value);                              \
174         }                                                       \
175     }while(0)
176 #else
177 #define JPEG_memcpy(pDstAddr, pSrcAddr, u32Size) memcpy((pDstAddr), (pSrcAddr), (u32Size))
178 #define JPEG_memset(pDstAddr, u8value, u32Size)  memset((pDstAddr), (u8value), (u32Size))
179 #endif
180 
181 #define JPEG_AtoU32(pData, u32value) \
182     do { \
183         u32value = 0; \
184         while(('0' <= *pData) && ('9' >= *pData)) \
185         { \
186             u32value = (10 * u32value) + (MS_U32)(*pData - '0'); \
187             pData++; \
188         } \
189     }while(0)
190 
191 #ifndef UNUSED
192 #define UNUSED(x) ((x)=(x))
193 #endif
194 
195 //-------------------------------------------------------------------------------------------------
196 //  Type and Structure
197 //-------------------------------------------------------------------------------------------------
198 //-----------------------------------------------------------------------------
199 //Description: JPEG scan type
200 typedef enum
201 {
202     E_JPEG_GRAYSCALE    = 0
203   , E_JPEG_YH1V1        = 1
204   , E_JPEG_YH2V1        = 2
205   , E_JPEG_YH1V2        = 3
206   , E_JPEG_YH2V2        = 4
207   , E_JPEG_YH4V1        = 5
208 //#if SW_JPD_RGB_CMYK
209   , E_JPEG_CMYK         = 6
210   , E_JPEG_RGB          = 7
211 //#endif
212 }JPEG_ScanType;
213 //-----------------------------------------------------------------------------
214 /// @brief \b Struct \b Name: JPEG_QuantTbl
215 /// @brief \b Struct \b Description: Structure for JPEG Quantization Table
216 //-----------------------------------------------------------------------------
217 typedef struct //same as JPD_QuanTbl in drvJPD.h
218 {
219     JPEG_QUANT_TYPE s16Value[64];   ///< value of Q table
220     MS_BOOL bValid;                 ///< has Q table or not.
221 } JPEG_QuantTbl;
222 
223 //-----------------------------------------------------------------------------
224 /// @brief \b Struct \b Name: JPEG_HuffInfo
225 /// @brief \b Struct \b Description: Structure for JPEG huffman information
226 //-----------------------------------------------------------------------------
227 typedef struct
228 {
229     MS_U8 u8Huff_num[17];   ///< number of Huffman codes per bit size
230     MS_U8 u8Huff_val[256];  ///< Huffman codes per bit size
231 
232     MS_U8 u8Symbol[17];     ///< u8Huff_num in reverse order
233     MS_U16 u16Code[17];     ///< Minimun code word
234     MS_BOOL bValid;         ///< has huffman table or not
235 } JPEG_HuffInfo;
236 //-----------------------------------------------------------------------------
237 /// @brief \b Struct \b Name: JPEG_HuffTbl
238 /// @brief \b Struct \b Description: Structure for JPEG huffman table
239 //-----------------------------------------------------------------------------
240 typedef struct
241 {
242     MS_S16 s16Look_up[256]; ///< the lookup of huffman code
243     // FIXME: Is 512 tree entries really enough to handle _all_ possible
244     // code sets? I think so but not 100% positive.
245     MS_S16 s16Tree[512];    ///< huffman tree of huffman code
246     MS_U8 u8Code_size[256]; ///< code size of huffman code
247 } JPEG_HuffTbl;
248 
249 
250 #endif //_JPEG_DEF_H_
251 
252