發(fā)給客戶的ap82-sdk包卡拉mvkaraoke dsp應(yīng)用簡(jiǎn)要說明

MV26_Karaoke_DSP_SDK應(yīng)用簡(jiǎn)要說明上海山景集成電路股份有限公司 MV26KaraokeDSPSDK應(yīng)用簡(jiǎn)要說明V1.4dateRevisionByDescription2018-04-041.0AlvinInitial2018-04-201.1Alvin完善TREB,BASS使用說明；完善Q&A部分說明2018-05-231.3Alvin1.修改提示音相關(guān)說明；2.修改flash存儲(chǔ)地址說明；3.修改調(diào)音部分說明；2018-06-201.4Alvin修改功能說明；完善karaoke_dsp.c部分說明；完善sound_remind.c部分說明;完善user_config.h部分說明；2018-10-121.5Alvin更新音效框圖；完善Q&A部分說明目錄TOC\o"1-9"\h\uMV26_Karaoke_DSP_SDK應(yīng)用簡(jiǎn)要說明 -1-1.功能簡(jiǎn)要說明 32.工程目錄說明 33.主要源文件說明 34.音效處理應(yīng)用說明 55.在線調(diào)音說明 56.系統(tǒng)流程圖 6功能簡(jiǎn)要說明：MV26_Karaoke_DSP_SDK版本試用于山景AP82系列IC，針對(duì)MIC卡拉OK，K麥，直播聲卡類等應(yīng)用的場(chǎng)合而定制，方便用戶快速進(jìn)行此類產(chǎn)品開發(fā)。功能說明：支持的音頻輸入接口：2路獨(dú)立ADC-IN、2路獨(dú)立I2S-IN、USB-IN、REMINDSOUND-IN；SPDIF-IN支持的音頻輸出接口：2.1路DAC-OUT、2路獨(dú)立I2S-OUT、USB-OUT；SPDIF-OUT支持的音效算法：SwNoiseSuppressor,FreqShifter,HowlingDetector,Echo,Reverb,PitchShifter,VoiceChanger,SwEq,VocalCut,Drc；支持Mic信號(hào)檢測(cè)功能；支持AdcKey,Adc電位器，IR,編碼開關(guān)等處理；支持PowerKey功能；支持flash掉電記憶處理功能；支持USBHID在線升級(jí)MVA功能；支持低壓檢測(cè)處理功能；支持提示音功能；支持閃避功能；支持在線調(diào)音功能（UART或USBHID方式）工程目錄說明[documents] 開發(fā)文檔及各種說明文檔目錄[driver] 硬件驅(qū)動(dòng)庫(kù)文件及庫(kù)的頭文件[禁止修改][middleware] 各種中間件的庫(kù)文件或者源文件及對(duì)應(yīng)的頭文件[禁止修改][startup] 工程的啟動(dòng)代碼[禁止修改][tools] 工具包，提供一些實(shí)用工具（提示音制作工具，PC升級(jí)工具）[timer] 定時(shí)器的使用例程接口[key] 各種按鍵處理文件，如ADKEY，GPIOKEY，SOFTKEY，IRKEY[effect_parameter]存放調(diào)音參數(shù)文件，由調(diào)音工具導(dǎo)出生成[main]SDK開始程序文件，有主文件，算法，通訊，調(diào)音，全局變量定義等[user] 模塊使用示例工程,用戶新增功能可以添加到這個(gè)目錄release_history.txt 發(fā)布包歷史更新記錄主要源文件說明karaoke_dsp.c系統(tǒng)主函數(shù)處理系統(tǒng)相關(guān)初始化；DmaChannelMap表格為DMA通道配置選擇表；DMA可同時(shí)選擇9路通道（有效使能0~8）;Sdk提供的DMA配置為：其他未使能打開的DMA需要根據(jù)實(shí)際情況重新打開使能配置，最大不要超過9；系統(tǒng)主循環(huán)：處理各通道輸入音頻流音效處理；mixer,及輸出音頻數(shù)據(jù)流處理；key掃描處理；AudioMusic_ChannelSet（）為MUSIC通道選擇函數(shù)，用戶需要手動(dòng)切換MUSIC通道的應(yīng)用場(chǎng)景時(shí)，可調(diào)用此函數(shù)來實(shí)現(xiàn)；ctrlvars.c系統(tǒng)控制變量gCtrlVars初始化；相關(guān)算法結(jié)構(gòu)體變量初始化；重點(diǎn)說明事項(xiàng)：1.系統(tǒng)控制變量gCtrlVars存放在CFG_BACKUP_CFG_2_FLASH_ADDR地址開始的flash區(qū)間；2.用戶需要記憶的變量請(qǐng)?jiān)趃CtrlVars中進(jìn)行定義，方便存儲(chǔ)記憶（調(diào)用CtrlVarsSave來記憶）；3.若要調(diào)整參數(shù)存儲(chǔ)空間地址,請(qǐng)同步修改user_config.h和init_default.c中如下部分：audio_effect.c音頻流音效處理相關(guān)函數(shù)集；重點(diǎn)說明事項(xiàng)：1.AudioEffectModeSel為音效模式選擇，目前預(yù)留10組音效模式參數(shù)，用戶可在此函數(shù)中定義相關(guān)模式名稱；2.BassTrebAjust為高低音調(diào)節(jié)接口函數(shù)，目前默認(rèn)使用MIC_OUT_EQ的f5,f6對(duì)應(yīng)的gain來進(jìn)行調(diào)節(jié):f5對(duì)應(yīng)bass,f6對(duì)應(yīng)treb;用戶可根據(jù)實(shí)際調(diào)音的情況來定制修改，例如，定制MIC_BYPASS_EQ的f5,f6對(duì)應(yīng)的gain來進(jìn)行調(diào)節(jié)，首先要確保調(diào)音對(duì)應(yīng)的這組EQ中要包含f5,f6,修改如下：voidBassTrebAjust(void){ gCtrlVars.mic_bypass_eq_unit.filter_params[2].gain=gCtrlVars.mic_bypass_eq_unit.eq_params[2].gain=BassTrebGainTable[gCtrlVars.TrebGain/2]; gCtrlVars.mic_bypass_eq_unit.filter_params[5].gain=gCtrlVars.mic_bypass_eq_unit.eq_params[6].gain=BassTrebGainTable[gCtrlVars.BassGain/2]; AudioEffectEQFilterConfig(&gCtrlVars.mic_bypass_eq_unit,gCtrlVars.sample_rate);}communication.c調(diào)音通信相關(guān)驅(qū)動(dòng)代碼，請(qǐng)謹(jǐn)慎修改?。onfig.h音頻接口相關(guān)內(nèi)存分配，請(qǐng)謹(jǐn)慎修改！！power_management.c電源管理相關(guān)處理代碼，用戶可根據(jù)實(shí)際需要，修改如下電量檢測(cè)值：#defineLDOIN_VOLTAGE_FULL 2578//4.15v#defineLDOIN_VOLTAGE_HIGH 2359//3.8v#defineLDOIN_VOLTAGE_MID2 2281//3.7v#defineLDOIN_VOLTAGE_MID1 2214//3.6v#defineLDOIN_VOLTAGE_LOW 2135//3.5v#defineLDOIN_VOLTAGE_EMPTY 2074//3.4v#defineLDOIN_VOLTAGE_OFF 2053//3.3v低于此電壓值進(jìn)入關(guān)機(jī)powerdown狀態(tài)sound_remind.c提示音相關(guān)處理代碼；重點(diǎn)說明事項(xiàng)：1.提示音存放地址由CFG_REMINDSOUND_ADDR來指定；若要調(diào)整提示音存儲(chǔ)空間地址,請(qǐng)同步修改user_config.h,init_default.c和gener_remind_bin中如下部分：若要調(diào)整參數(shù)存儲(chǔ)空間地址,請(qǐng)同步修改user_config.h，init_default.c中如下部分：2.目前SDK提示音支持MP3格式（默認(rèn)44.1K采樣率）；3.目前提示音制作工具是script，使用說明請(qǐng)參見\Karaoke_DSP_SDK\tools\script中的“提示音工具說明”文檔說明；adc_key.cadckey相關(guān)處理代碼；重點(diǎn)說明事項(xiàng)：1.目前SDK提供2路adckey,每路最多支持11個(gè)key;2.NORMAL_ADKEY為0時(shí)，每路adckey對(duì)應(yīng)的電阻阻值請(qǐng)嚴(yán)格按照山景提供的參考設(shè)計(jì)來做；3.NORMAL_ADKEY為1時(shí)，用戶可自行定義每路adckey對(duì)應(yīng)的電阻阻值及key數(shù)目，需要根據(jù)分配電壓值修改如下定義：#defineADKEY_0(ADC_000V+ADC_030V)/2#defineADKEY_1(ADC_030V+ADC_060V)/2#defineADKEY_2(ADC_060V+ADC_085V)/2#defineADKEY_3(ADC_085V+ADC_110V)/2#defineADKEY_4(ADC_110V+ADC_140V)/2#defineADKEY_5(ADC_140V+ADC_165V)/2#defineADKEY_6(ADC_165V+ADC_180V)/2#defineADKEY_7(ADC_180V+ADC_200V)/2#defineADKEY_8(ADC_200V+ADC_230V)/2#defineADKEY_9(ADC_230V+ADC_260V)/2#defineADKEY_10(ADC_260V+ADC_290V)/2#defineADKEY_11(ADC_000V+ADC_030V)/2#defineADKEY_12(ADC_000V+ADC_030V)/2#defineADKEY_13(ADC_000V+ADC_030V)/2#defineADKEY_14(ADC_000V+ADC_030V)/2adc_levels.cadc多路電位器相關(guān)初始化及掃描處理代碼；重點(diǎn)說明事項(xiàng)：1.電位器行程分段數(shù)目默認(rèn)值由MAX_ADCLEVL_STEP來定義，修改時(shí)，請(qǐng)注意相關(guān)table表格要同步更新；2.此處判斷的最大采樣電壓值需要根據(jù)實(shí)際使用的電位器來修改：gpio_key.cGPIOKEY相關(guān)初始化及掃描處理；重點(diǎn)說明事項(xiàng)：1.CFG_SOFT_POWER_KEY_EN對(duì)應(yīng)外部軟開關(guān)電路相關(guān)應(yīng)用功能，具體請(qǐng)參照山景提供的硬件參考設(shè)計(jì);2.sdk提供2個(gè)GPIOKEY的應(yīng)用接口，對(duì)應(yīng)CFG_GPIO_KEY1_EN和CFG_GPIO_KEY2_EN，用戶可自行擴(kuò)展；3.gpio_key可配置為雙擊或多擊的操作（adckey類似），例如，配置powerkey雙擊為消原音功能的開關(guān)，GpioKeyInit中配置如下：key_process.c/h各種key應(yīng)用處理函數(shù)統(tǒng)一接口；重點(diǎn)說明事項(xiàng)：1.SDK相關(guān)消息類型定義在.h中，用戶可根據(jù)實(shí)際需要進(jìn)行擴(kuò)展；2.電位器處理接口，用戶需要根據(jù)定義的電位器數(shù)目及功能定義來修改ADCLevelsMsgTab，例如，定義高音，低音，音量，混響4個(gè)電位器：3.ADCKEY相關(guān)功能定義見ADKEY1_TAB，ADKEY2_TAB，用戶需要根據(jù)實(shí)際產(chǎn)品修改此表；例如，修改第1組ADCKEY的1個(gè)KEY作為MICVOL+(長(zhǎng)按，短按)，修改如下：4.IOKEY相關(guān)功能定義見IOKEY_TAB，用戶需要根據(jù)實(shí)際產(chǎn)品修改此表；5.IRKEY相關(guān)功能定義見IRKEY_TAB，用戶需要根據(jù)實(shí)際產(chǎn)品修改此表；6.TranslateMessage中如下地方修改雙擊間隔時(shí)間：key_app.c各種消息處理應(yīng)用接口函數(shù)集；重點(diǎn)說明事項(xiàng)：用戶若增加新消息及處理函數(shù)，需要增加處理函數(shù)，及在KeyAppTab中增加消息名稱及函數(shù)指針，例如，hw_interface.hGPIO相關(guān)配置接口；重點(diǎn)說明事項(xiàng)：SDK提供的相關(guān)GPIO定義是內(nèi)部IO,無實(shí)際作用;用戶需要根據(jù)實(shí)際硬件GPIO分配來重新修改GPIO定義，例如：misc.csdk提供的各種常用應(yīng)用例程函數(shù)集；重點(diǎn)說明事項(xiàng)：為了方便升級(jí)SDK版本，建議用戶增加或修改的相關(guān)應(yīng)用代碼，盡量放在此文件中；HWDeviceDected函數(shù)中，提供了單個(gè)LED顯示接口，耳機(jī)檢測(cè)，MIC檢測(cè)，電量檢測(cè)，DACFadeInOut處理，電位器調(diào)節(jié)微調(diào)處理；此函數(shù)每2MS調(diào)用1次；用戶需要根據(jù)實(shí)際需要修改相關(guān)接口函數(shù)代碼：例如修改單個(gè)LED顯示，直接修改LedDisplay函數(shù)的內(nèi)容；MiscDeviceProcess函數(shù)中，目前提供了閃避（伴音）處理接口；此函數(shù)每3MS調(diào)用1次；用戶需要增加的其他應(yīng)用處理建議在此函數(shù)中實(shí)現(xiàn)；user_config.hSDK中主要功能宏定義開關(guān)，用戶需要根據(jù)實(shí)際情況定制相關(guān)宏開關(guān)；重點(diǎn)說明事項(xiàng)：此文件中芯片型號(hào)選擇很關(guān)鍵，要根據(jù)實(shí)際需要選對(duì)型號(hào)，否則會(huì)出現(xiàn)模擬通路聲音異常問題?。。±?，選擇AP8248A2，配置如下：音效功能配置部分不建議修改，若手動(dòng)關(guān)閉某些音效功能，在O26-ACPWorkbench中會(huì)不再顯示對(duì)應(yīng)的音效界面??！AUDIO_CH_MIC為MIC輸入PIN腳選擇，其中AP8264可選擇MIC1腳，MIC2腳，MIC3腳，MIC4腳；AP8248A2可選擇MIC3腳，MIC4腳；AP8224固定選擇MIC4腳；例如，采用AP8248A2的硬件設(shè)計(jì)，MIC輸入選擇MIC3，配置如下：#ifdefFUNC_AP8248A2_FOR_FURUIJIE_PROJ_EN#defineAUDIO_CH_MIC BIT(INPUT_MIC3)//AP8248系列只能選擇MIC3，MIC4，連接到ADC0#else#defineAUDIO_CH_MIC BIT(INPUT_MIC3)|BIT(INPUT_MIC4)//AP8248系列只能選擇MIC3，MIC4，連接到ADC0#endif串口DEBUG配置部分，UART_SW_N0是軟件模擬UART做DEBUG輸出口，例如，配置A28做DEBUG，配置如下：#defineUART_SW_PORTGPIO_A_START#defineUART_SW_PORT_PIN28CFG_USB_MODE為USB工作模式選擇，例如只需要單獨(dú)HID，配置為：#defineCFG_USB_MODE HIDFlash空間分配說明：0~CFG_REMINDSOUND_ADDR為code代碼空間，目前SDK預(yù)留832K大小存放code(CFG_REMINDSOUND_ADDR為0xd0000)；用戶可根據(jù)實(shí)際需要重新分配CFG_REMINDSOUND_ADDR(注意：init_default.c和gener_remind_bin中要同步修改??！)；CFG_REMINDSOUND_ADDR~CFG_BACKUP_CFG_2_FLASH_ADDR空間為存放mp3格式提示音（即gener_remind_bin生成的Karaoke_DSP_Remind.bin）；目前預(yù)留1Mbytes空間存放提示音；若此空間不夠，需要采用外置flash的方案！！CFG_BACKUP_CFG_2_FLASH_ADDR~CFG_EFFECT_PARAME_FLASH_ADDR空間為存放系統(tǒng)gCtrlVars變量存儲(chǔ)空間大小(CFG_BACKUP_CFG_2_FLASH_ADDR為0x1d0000)，目前SDK預(yù)留64K大小存放gCtrlVars變量；此空間大小不建議修改?。?！CFG_EFFECT_PARAME_FLASH_ADDR~0x1F0000空間為調(diào)音參數(shù)存儲(chǔ)空間(CFG_EFFECT_PARAME_FLASH_ADDR為0x1E0000)，目前sdk預(yù)留64K大小存放16組調(diào)音參數(shù)；此空間大小不建議修改?。。?x1F0000~flash尾地址(例如內(nèi)置16Mbitflash,此地址為0x200000)空間大?。?4K）存放flashboot；若FLASH_BOOT_EN打開，此空間不被占用，否則會(huì)出現(xiàn)系統(tǒng)工作異?，F(xiàn)象??！ADCKEY配置說明：例如配置GPIOA23為ADCKEY1，GPIOA29為ADCKEY2，修改如下：ADC電位器配置說明：例如配置GPIOA24，GPIOA25，GPIOA26，GPIOA27作為4路ADC電位器，修改如下：#defineADCLEVL_CHANNEL_MAP (ADC3_GPIOA24|ADC4_GPIOA25|ADC5_GPIOA26|ADC6_GPIOA27)CFG_DEBUG_EFFECT_EN若打開，在線調(diào)音時(shí)，工具可直接下載調(diào)音參數(shù)到CFG_EFFECT_PARAME_FLASH_ADDR~0x1F0000空間，方便在線調(diào)音及更新參數(shù)；注：音效處理應(yīng)用說明音效處理定制目前SDK除了提供現(xiàn)有的音效處理流程，用戶也可實(shí)現(xiàn)自定義的音效處理：只需在audio_effect.c文件中參考AudioEffectsProcessDemo()，重新實(shí)現(xiàn)一個(gè)相同接口的處理函數(shù)，名字可自定義，然后將這個(gè)自定義的函數(shù)名在user_config.h中給CFG_AUDIO_EFFECT_PROCESS_HANDLE宏賦值即可；注：SDK提供的音效處理流程如下：2．此類個(gè)性化音效處理定制方案應(yīng)用，需要對(duì)現(xiàn)有的流程有比較深入的熟悉及理解，并需要完善在線調(diào)音的流程，具體應(yīng)用時(shí)，請(qǐng)與山景FAE聯(lián)系給與定制支持；在線調(diào)音說明目前AP82系列調(diào)音工具為：ACPWorkbench_Vx.x.x_for_AP82xxDU56x；使用前，請(qǐng)核對(duì)下release_notes中說明的和SDK對(duì)應(yīng)的調(diào)音工具版本；目前支持UART或USB（目前仍在完善中）做為調(diào)音通信口，SDK中請(qǐng)選擇正確的通信口：#defineCFG_COMMUNICATION_METHID(1)若需要對(duì)調(diào)音參數(shù)加密，請(qǐng)打開如下宏：#defineCFG_COMMUNICATION_CRYPTO(1)SDK中調(diào)音參數(shù)更新說明：導(dǎo)出類型選擇.c格式（文件名要與SDK中effect_parameter目錄下的對(duì)應(yīng)文件名一致），并替換effect_parameter目錄下的對(duì)應(yīng)文件；SDK再重新編譯并下載或升級(jí)即可：常見應(yīng)用疑問Question&AnswerQ:如何配置在線調(diào)音B0，B1口做普通GPIO來用？A:請(qǐng)?jiān)谙到y(tǒng)初始化時(shí)，調(diào)用如下代碼：intmain(void){uint16_tlen;//若需要GPIOB0，GPIOB1做普通GPIO，請(qǐng)打開如下代碼 GPIO_PortBModeSet(GPIOB0,0); GPIO_PortBModeSet(GPIOB1,0);Q:SDK中選擇AP8248A2型號(hào)后，MIC無音效，是什么原因？A:音效模式設(shè)置AudioEffectModeSel()中，會(huì)調(diào)取調(diào)音參數(shù).c文件解析并配置系統(tǒng)參數(shù)及音效參數(shù)，\effect_parameter中提供的調(diào)音參數(shù)文件默認(rèn)是按照AP8264系列來配置的（MIC3,MIC4，LINE2），因此解析中會(huì)因通道設(shè)置不一致而導(dǎo)致解析失敗，會(huì)默認(rèn)關(guān)閉所有的音效模塊；此種情況下，需要連調(diào)音工具重新配置調(diào)音參數(shù)，并導(dǎo)出.c文件（例如HunXiang.c）并替換sdk中對(duì)應(yīng)文件:Q:SDK中使能I2S0_IN或I2S0_OUT，無聲音輸出，是什么原因？A:首先，I2S0的DMA要使能（最大同時(shí)可打開9組DMA）：其次，要保證\Karaoke_DSP_SDK\effect_parameter下調(diào)音參數(shù)文件中要打開I2S0:另外，若I2S_IN配置為slave時(shí)，要保證BCK,LRCK有信號(hào)，否則也會(huì)無聲音輸出；最后，若聲音仍不正常，一定要打開調(diào)音工具在線再確認(rèn)下I2S相關(guān)配置，重新調(diào)試好導(dǎo)出.c文件并替換：Q:調(diào)用AudioEffectModeSel切換音效時(shí)，伴音聲音會(huì)卡頓，如何解決？A:1.LoadAudioMode中恢復(fù)如下代碼的調(diào)用：gCtrlVars.init_one_digital=0;//若需要只初始化一次硬件參數(shù)，則需要恢復(fù)這個(gè)變量的調(diào)用（減小切換的POP聲）2.AudioEffectModeSel中屏蔽如下代碼：//AudioDAC_ClearBuff();Q:DMA部分應(yīng)用注意事項(xiàng)有哪些？A:DMA通道最多可同時(shí)打開9路（打開時(shí)，對(duì)應(yīng)的使能數(shù)字在0~8中設(shè)置，不要有重復(fù)，默認(rèn)255為關(guān)閉對(duì)應(yīng)DMA），用戶在做應(yīng)用開發(fā)中，要首先關(guān)注下DMA配置表DmaChannelMap中相關(guān)DMA使能是否有打開；Q:SPDIFIN無功能，如何解決？A:先確認(rèn)下DmaChannelMap中，PERIPHERAL_ID_SDPIF_RX是否有使能打開；調(diào)音參數(shù).c文件中，確認(rèn)下spdif是否有enable:Q:如何在調(diào)音界面中單獨(dú)設(shè)置ADC,DAC,I2S的MCLK時(shí)鐘源和采樣率？A:在某些多路音源同時(shí)輸入的應(yīng)用場(chǎng)景下，需要選擇不同的MCLK時(shí)鐘源（適配對(duì)應(yīng)的采樣率，例如I2S_IN設(shè)置