xref: /utopia/UTPA2-700.0.x/modules/audio/drv/audio/internal/drvSOUND.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 bEngineering 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 //  [Doxygen]
94 /// @file drvSOUND.h
95 /// @brief Subroutine for sound effect
96 /// @author MStarSemi Inc.
97 ////////////////////////////////////////////////////////////////////////////////
98 
99 #ifndef _DRVSOUND_H_
100 #define _DRVSOUND_H_
101 
102 #include "MsTypes.h"
103 #include "drvAUDIO_if.h"
104 
105 #ifdef __cplusplus
106 extern "C"
107 {
108 #endif
109 
110 
111 enum
112 {
113     SUBWOOFER=0x00,
114     VOLUME_BALANCE=0x01,
115     SPATIAL=0x02,
116     u8BaSS_TREBLE=0x03,
117     AUTO_VOLUME=0x04,
118     DAC_OUTPUT=0x05,
119     SOUND_EFFECT=0x06,
120     STEREO_MODE=0x07,
121     SOUND_MODE=0x08
122 };
123 
124 //=====================================================
125 // Declare audio function here.
126 //=====================================================
127 void    MDrv_SOUND_Init(void);
128 void    MDrv_SOUND_SetMute(MS_U8 u8Path, MS_BOOL bEnable);
129 void    MDrv_SOUND_AbsoluteVolume(MS_U8 u8Path, MS_U8 u8Vol1, MS_U8 u8Vol2);
130 void    MDrv_SOUND_SetPreScale(MS_U8 u8Path, MS_U8 u8Prescale);
131 void    MDrv_SOUND_SetBalance(MS_U8 u8Balance);
132 void    MDrv_SOUND_SetBalance_L(MS_U8 u8Balance_L);
133 void    MDrv_SOUND_SetBalance_R(MS_U8 u8Balance_R);
134 void    MDrv_SOUND_SetBass(MS_U8 u8Level);
135 void    MDrv_SOUND_SetDynamicBass(MS_U8 u8Level);
136 void    MDrv_SOUND_AbsoluteBass(MS_U8 u8Bass);
137 void    MDrv_SOUND_SetTreble(MS_U8 u8Level);
138 void    MDrv_SOUND_AbsoluteTreble(MS_U8 u8Treble);
139 void    MDrv_SOUND_SetEq(MS_U8 u8Band, MS_U8 u8Level);
140 void    MDrv_SOUND_SetEq7(MS_U8 u8Band, MS_U8 u8Level);
141 
142 void    MDrv_SOUND_SetADCThreshold(MS_U8 u8Threshold);
143 void    MDrv_SOUND_SetNRAttenuate(MS_U8 u8Mode);
144 void    MDrv_SOUND_SetAVCThreshold(MS_U8 u8Level);
145 void    MDrv_SOUND_SetAvcMode( MS_U8 u8AvcMode );
146 void    MDrv_SOUND_SetAvcAT( MS_U8 u8AvcAT );
147 void    MDrv_SOUND_SetAvcRT( MS_U8 u8AvcRT );
148 void    MDrv_SOUND_PowerDown_Wait(MS_BOOL bEnable);
149 void    MDrv_SOUND_SetCH1AudioDelay(MS_U8 u8Delay);
150 void    MDrv_SOUND_PlayMenuSound(void);
151 void    MDrv_SOUND_SetSurroundXA(MS_U8 u8Mode);
152 void    MDrv_SOUND_SetSurroundXB(MS_U8 u8Mode);
153 void    MDrv_SOUND_SetSurroundXK(MS_U8 u8Mode);
154 void    MDrv_SOUND_SetSurroundLPFGain(MS_U8 u8Mode);
155 
156 //======================================================
157 void    MDrv_SOUND_EnableAutoVolume(MS_BOOL bEnAVC);
158 void    MDrv_SOUND_EnableTone(MS_BOOL bEnTone);
159 void    MDrv_SOUND_EnableEQ(MS_BOOL bEnEQ);
160 void    MDrv_SOUND_EnableSurround(MS_BOOL bEnSurround);
161 void    MDrv_SOUND_EnableNR(MS_U8 u8Level);
162 void    MDrv_SOUND_EnableBalance(MS_U8 u8Enable);
163 //================From DrvAudioProcess=======================
164 void    MDrv_SOUND_SetAdAbsoluteVolume(MS_U8 u8Vol1, MS_U8 u8Vol2);
165 void    MDrv_SOUND_SetAdMute(MS_BOOL bEnable);
166 void    MDrv_SOUND_SetPEQCoef(AUDIO_PEQ_COEF *peq_coef);
167 void    MDrv_SOUND_EnablePEQ(MS_BOOL Enpeq);
168 
169 void    MDrv_SOUND_SetMixModeMute(AUDIO_SOURCE_INFO_TYPE eSourceType, AUDIO_MIX_VOL_TYPE VolType, MS_BOOL EnMute );
170 void    MDrv_SOUND_SetMixModeVolume(AUDIO_SOURCE_INFO_TYPE eSourceType, AUDIO_MIX_VOL_TYPE VolType, MS_U8 u8Vol1, MS_U8 u8Vol2  );
171 
172 MS_BOOL MDrv_SOUND_EnableDcRemove(MS_BOOL EnDcRemove);
173 MS_BOOL MDrv_SOUND_SetParam( Sound_SET_Type Type, MS_U32 *p_param );
174 
175 MS_BOOL MDrv_SND_ProcessEnable(Sound_ENABLE_Type Type, MS_BOOL enable);
176 MS_BOOL MDrv_SND_SetParam( Sound_SET_PARAM_Type Type, MS_U16 param1, MS_U16 param2);
177 MS_U16  MDrv_SND_GetParam( Sound_GET_PARAM_Type Type, MS_U16 param1);
178 
179 #ifdef __cplusplus
180 }
181 #endif
182 
183 
184 #endif //_DRVSOUND_H_
185