xref: /utopia/UTPA2-700.0.x/modules/njpd/api/njpeg_ex/apiJPEG_OJPD.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   apiJPEG.h
98 /// @brief  JPEG API
99 /// @author MStar Semiconductor Inc.
100 ///////////////////////////////////////////////////////////////////////////////////////////////////
101 
102 #ifndef _API_JPEG_OJPD_H_
103 #define _API_JPEG_OJPD_H_
104 
105 #ifdef __cplusplus
106 extern "C" {
107 #endif
108 
109 
110 void msAPI_JPEG_get_APP0_info_OJPD( MS_U8 *unit,MS_U16 *x, MS_U16 *y );
111 
112 JPEG_Result MApi_JPEG_Init_OJPD(JPEG_InitParam *pInitParam);
113 JPEG_Result MApi_JPEG_DecodeHdr_OJPD(void);
114 JPEG_Result MApi_JPEG_Decode_OJPD(void);
115 void MApi_JPEG_Exit_OJPD(void);
116 JPEG_ErrCode MApi_JPEG_GetErrorCode_OJPD(void);
117 JPEG_Event MApi_JPEG_GetJPDEventFlag_OJPD(void);
118 void MApi_JPEG_SetJPDEventFlag_OJPD(JPEG_Event eEvtVal);
119 void MApi_JPEG_Rst_OJPD(void);
120 void MApi_JPEG_PowerOn_OJPD(void);
121 void MApi_JPEG_PowerOff_OJPD(void);
122 MS_U16 MApi_JPEG_GetCurVidx_OJPD(void);
123 MS_BOOL MApi_JPEG_IsProgressive_OJPD(void);
124 MS_BOOL MApi_JPEG_ThumbnailFound_OJPD(void);
125 MS_U16 MApi_JPEG_GetWidth_OJPD(void);
126 MS_U16 MApi_JPEG_GetHeight_OJPD(void);
127 MS_U16 MApi_JPEG_GetOriginalWidth_OJPD(void);
128 MS_U16 MApi_JPEG_GetOriginalHeight_OJPD(void);
129 MS_U16 MApi_JPEG_GetNonAlignmentWidth_OJPD(void);
130 MS_U16 MApi_JPEG_GetNonAlignmentHeight_OJPD(void);
131 MS_U16 MApi_JPEG_GetAlignedPitch_OJPD(void);
132 MS_U16 MApi_JPEG_GetAlignedPitch_H_OJPD(void);
133 MS_U16 MApi_JPEG_GetAlignedWidth_OJPD(void);
134 MS_U16 MApi_JPEG_GetAlignedHeight_OJPD(void);
135 MS_U8 MApi_JPEG_GetScaleDownFactor_OJPD(void);
136 void MApi_JPEG_SetMaxDecodeResolution_OJPD(MS_U16 u16Width, MS_U16 u16Height);
137 void MApi_JPEG_SetProMaxDecodeResolution_OJPD(MS_U16 u16ProWidth, MS_U16 u16ProHeight);
138 void MApi_JPEG_SetMRBufferValid_OJPD(JPEG_BuffLoadType u8MRBuffType);
139 void MApi_JPEG_UpdateReadInfo_OJPD(MS_U32 u32DataRead, MS_BOOL bEOFflag);
140 void MApi_JPEG_ProcessEOF_OJPD(JPEG_BuffLoadType u8MRBuffType);
141 void MApi_JPEG_SetErrCode_OJPD(JPEG_ErrCode ErrStatus);
142 void MApi_JPEG_SetDbgLevel_OJPD(MS_U8 u8DbgLevel);
143 MS_U8 MApi_JPEG_GetDbgLevel_OJPD(void);
144 void MApi_JPEG_GetInfo_OJPD(JPEG_Info *pJPEG_Info);
145 void MApi_JPEG_GetStatus_OJPD(JPEG_Status *pJPEG_Status);
146 JPEG_Result MApi_JPEG_GetLibVer_OJPD(const MSIF_Version **ppVersion);
147 JPEG_Result MApi_JPEG_HdlVidxChk_OJPD(void);
148 JPEG_Result MApi_JPEG_GetBuffLoadType_OJPD(JPEG_BuffLoadType *pBuffLoadType);
149 JPEG_Result MApi_JPEG_EnableISR_OJPD(JPEG_IsrFuncCb IsrCb);
150 JPEG_Result MApi_JPEG_DisableISR_OJPD(void);
151 JPEG_DecodeStatus MApi_JPEG_WaitDone_OJPD(void);
152 JPEG_Result MApi_JPEG_GetEXIFDateTime_OJPD(JPEG_EXIF_DateTime *DateTime);
153 JPEG_Result MApi_JPEG_GetEXIFOrientation_OJPD(JPEG_EXIF_Orientation *eOrientation);
154 #if SUPPORT_EXIF_EXTRA_INFO
155 JPEG_Result MApi_JPEG_GetEXIFManufacturer_OJPD(MS_U8 *pu8Manufacturer, MS_U8 u8size);
156 JPEG_Result MApi_JPEG_GetEXIFModel_OJPD(MS_U8 *pu8Model, MS_U8 u8size);
157 JPEG_Result MApi_JPEG_GetEXIFFlash_OJPD(MS_U16 *pu16Flash);
158 JPEG_Result MApi_JPEG_GetEXIFISOSpeedRatings_OJPD(MS_U32 *pu32ISOSpeedRatings);
159 JPEG_Result MApi_JPEG_GetEXIFShutterSpeedValue_OJPD(JPEG_RATIONAL *pShutterSpeedValue);
160 JPEG_Result MApi_JPEG_GetEXIFApertureValue_OJPD(JPEG_RATIONAL *pApertureValue);
161 JPEG_Result MApi_JPEG_GetEXIFExposureBiasValue_OJPD(JPEG_RATIONAL *pExposureBiasValue);
162 JPEG_Result MApi_JPEG_GetEXIFFocalLength_OJPD(JPEG_RATIONAL *pFocalLength);
163 JPEG_Result MApi_JPEG_GetEXIFImageWidth_OJPD(MS_U32 *pu32ImageWidth);
164 JPEG_Result MApi_JPEG_GetEXIFImageHeight_OJPD(MS_U32 *pu32ImageHeight);
165 JPEG_Result MApi_JPEG_GetEXIFExposureTime_OJPD(JPEG_RATIONAL *pExposureTime);
166 JPEG_Result MApi_JPEG_GetEXIFFNumber_OJPD(JPEG_RATIONAL *pFNumber);
167 #endif
168 JPEG_Result MApi_JPEG_GetControl_OJPD(EN_JPEG_GET_CTRL_ID eGetID, MS_U32 *param, MS_U32 u32Size);
169 
170 MS_PHYADDR MApi_JPEG_GetFreeMemory_OJPD(MS_U32 size);
171 MS_U32 MApi_JPEG_GetDataOffset_OJPD(void);
172 MS_U32 MApi_JPEG_GetSOFOffset_OJPD(void);
173 void MApi_JPEG_SetNJPDInstance_OJPD(MS_U8 JPDNum);
174 JPEG_Result MApi_JPEG_SupportCMYK_OJPD(MS_BOOL bEnable);
175 JPEG_Result MApi_JPEG_SupportRGB_OJPD(MS_BOOL bEnable);
176 void MApi_JPEG_SetMHEG5_OJPD(MS_BOOL bEnable);
177 
178 #if SUPPORT_MPO_FORMAT
179 //For MPO
180 MS_BOOL MApi_JPEG_IsMPOFormat_OJPD(void);
181 MS_BOOL MApi_JPEG_GetMPOIndex_OJPD(JPEG_MPO_INDEX_INFO **ppMPOIndex);
182 MS_BOOL MApi_JPEG_GetMPOAttr_OJPD(MS_U32 image_no, JPEG_MPO_ATTRIBUTE_INFO **ppMPOAttr);
183 void MApi_JPEG_DumpMPO_OJPD(void);
184 MS_BOOL MApi_JPEG_SetMPOBuffer_OJPD(MS_U32 read_offset, MS_U32 output_start);
185 void MApi_JPEG_SetMPOMaxDecodeResolution_OJPD(MS_U16 u16Width, MS_U16 u16Height);
186 void MApi_JPEG_SetMPOProMaxDecodeResolution_OJPD(MS_U16 u16ProWidth, MS_U16 u16ProHeight);
187 #endif
188 void MApi_JPEG_SetVerificationMode_OJPD(NJPEG_VerificationMode VerificationMode);
189 NJPEG_VerificationMode MApi_JPEG_GetVerificationMode_OJPD(void);
190 void MApi_NJPD_Debug_OJPD(void);
191 void MApi_JPEG_DisableAddressConvert_OJPD(void);
192 
193 
194 
195 #ifdef __cplusplus
196 }
197 #endif
198 
199 //------------------------------------------------------------------------------
200 #endif // _API_JPEG_OJPD_H_
201 //------------------------------------------------------------------------------
202