欢迎使用杰理科技32位AD系列语音IC

开源社区仓库链接：

https://gitee.com/Jieli-Tech/fw-AD15N

https://github.com/Jieli-Tech/fw-AD15N

开源社区交流群：

开源社区钉钉群二维码

作者：刘杰、陈卓豪、马万程、刘昊坤

---

文档版本说明:

• 文档版本说明
  • v1.3 说明
  • v1.2 说明
  • v1.1 说明
  • v1.0 说明

---

IDE 软硬件开发环境介绍:

• 1. 新版SDK命名说明
• 2. 环境介绍
  • 2.1. 硬件环境介绍
    • 2.1.1. AD14N AC104N硬件开发环境
    • 2.1.2. AD15N硬件开发环境
    • 2.1.3. AD17N硬件开发环境
    • 2.1.4. AD18N硬件开发环境
  • 2.2. SDK工程与配置
    • 2.2.1. 应用配置文件《app_config.c》介绍
    • 2.2.2. 应用配置文件《app_config.h》介绍
    • 2.2.3. 应用APP配置文件《app_modules.h》介绍
    • 2.2.4. CodeBlocks工程宏定义介绍
  • 2.3. 新版本SDK工程裁切（2023年7月发布的SDK起始）
  • 2.4. 旧版本SDK工程裁切
    • 2.4.1. 如何将解码格式从工程中移除
    • 2.4.2. 如何将压缩格式从工程中移除
• 3. 下载目录&工具使用环境介绍
  • 3.1. 下载目录介绍
    • 3.1.1. dowload_bat.c 文件介绍
    • 3.1.2. isd_config.ini文件介绍
  • 3.2. 开发工具介绍
    • 3.2.1. 资源打包工具
    • 3.2.2. 音频转换工具
  • 3.3. 多算法授权简单介绍

---

系统:

• 1. 时钟驱动
  • 1.1. AD14N / AC104N 系统时钟超频说明
  • 1.2. 内置系统flash spi时钟说明
    • 1.2.1. AD14N / AC104N SPI时钟限制
    • 1.2.2. AD15N SPI时钟限制
    • 1.2.3. AD17N SPI时钟限制
  • 1.3. 时钟相关函数
    • 1.3.1. 函数void pll_sel(u32 pll_clock, _PLL_DIV pll_div, _PLL_B_DIV pll_b_div)
    • 1.3.2. 函数int clk_get(const char *name);
    • 1.3.3. 函数int clk_set(const char *name, int clk)
• 2. 内置系统flash写保护
  • 2.1. A0芯片如何添加写保护参数
    • 2.1.1. flash写保护工具说明
    • 2.1.2. 新增flash写保护参数与指令
    • 2.1.3. 写保护参数下载说明
    • 2.1.4. 第一点相关函数说明
  • 2.2. 内封flash芯片如何添加写保护参数（旧）
    • 2.2.1. 配置烧写器获取内封flash写保护参数
    • 2.2.2. 配置强制下载工具获取内封flash写保护参数
    • 2.2.3. 第三点相关函数说明
  • 2.3. 内封flash芯片如何添加写保护参数（新）
  • 2.4. 程序中开启与关闭写保护功能
    • 2.4.1. 第五点相关函数说明
    • 2.4.2. 常见问题说明
• 3. 中断系统
  • 3.1. 中断的注册与注销
    • 3.1.1. 函数void HWI_Install(unsigned char index, unsigned int isr, unsigned char priority)
    • 3.1.2. 函数void HWI_Uninstall(unsigned char index)
  • 3.2. 软中断说明
    • 3.2.1. 函数void bit_set_swi(unsigned char index)
    • 3.2.2. 函数void bit_clr_swi(unsigned char index)
  • 3.3. 软件不可屏蔽中断
    • 3.3.1. 函数void _OS_ENTER_CRITICAL(u32 bit_list)
    • 3.3.2. 函数void _OS_ENTER_CRITICAL(u32 bit_list_l, u32 bit_list_h)
    • 3.3.3. 函数void _OS_EXIT_CRITICAL(void)
    • 3.3.4. 函数void vm_isr_response_index_register(u8 index)
    • 3.3.5. 函数void vm_isr_response_index_unregister(u8 index)
    • 3.3.6. 函数u32 get_vm_isr_response_index_l(void)
    • 3.3.7. 函数u32 get_vm_isr_response_index_h(void)
  • 3.4. 硬件不可屏蔽中断
    • 3.4.1. 函数void irq_unmask_set(u8 index)
    • 3.4.2. 函数void irq_unmask_disable(u8 index)
• 4. GPIO接口说明
  • 4.1. DACP，DACN口设置（AC104/AD14/15/17）
  • 4.2. 普通IO口(AC104/AD14/15/17/18)
  • 4.3. 模块IO映射
    • 4.3.1. AC104/AD14/AD15
    • 4.3.2. AD17
    • 4.3.3. AD18
  • 4.4. 常见问题和注意事项
    • 4.4.1. AC104/AD14/AD15/AD17 生产不良率高
    • 4.4.2. AD18部分IO下拉使用寄存器设置无效

---

设备、文件、编解码:

• 1. 设备管理
  • 1.1. 设备注册表
  • 1.2. 设备函数
    • 1.2.1. 函数int devices_init()
    • 1.2.2. 函数bool dev_online(const char* name)
    • 1.2.3. 函数void* dev_open(const char* name, void* arg)
    • 1.2.4. 函数int dev_bulk_read(void* _device, void* buf, u32 offset, u32 len)
    • 1.2.5. 函数int dev_bulk_write(void* _device, void* buf, u32 offset, u32 len)
    • 1.2.6. 函数int dev_byte_read(void* _device, void* buf, u32 offset, u32 len)
    • 1.2.7. 函数int dev_byte_write(void* _device, void* buf, u32 offset, u32 len)
    • 1.2.8. 函数int dev_ioctl(void* device, int cmd, u32 arg)
    • 1.2.9. 函数int dev_close(void* device)
• 2. 文件系统管理
  • 2.1. 文件系统介绍
    • 2.1.1. sydfs文件系统
    • 2.1.2. norfs文件系统
    • 2.1.3. fat/simple_fat文件系统
  • 2.2. 文件系统使用一般流程
  • 2.3. 通用文件系统管理函数
    • 2.3.1. 函数void vfs_init(void)
    • 2.3.2. 函数u32 vfs_mount(void **ppvfs, void *device, void *type)
    • 2.3.3. 函数u32 vfs_openbypath(void *pvfs, void **ppvfile, const char *path)
    • 2.3.4. 函数u32 vfs_openbyindex(void *pvfs, void **ppvfile, u32 index)
    • 2.3.5. 函数u32 vfs_createfile(void *pvfs, void **ppvfile, u32 *pindex)
    • 2.3.6. 函数u32 vfs_read(void *pvfile, void *buf, u32 len)
    • 2.3.7. 函数u32 vfs_write(void *pvfile, void *buf, u32 len)
    • 2.3.8. 函数u32 vfs_seek(void *pvfile, u32 offset, u32 mode)
    • 2.3.9. 函数u32 vfs_file_close(void **ppvfile)
    • 2.3.10. 函数u32 vfs_fs_close(void **ppvfs)
    • 2.3.11. 函数u32 vfs_file_name(void *pvfile， void *name, u32 len)
    • 2.3.12. 函数int vfs_get_attrs(void *pvfile, void *pvfs_attr)
    • 2.3.13. 函数int vfs_ioctl(void *pvfile, int cmd, int arg)
    • 2.3.14. 函数int vfs_file_crc(void *pvfile)
  • 2.4. FAT文件系统管理函数
    • 2.4.1. 函数int vfs_ftell(void *pvfile, void *parm)
    • 2.4.2. 函数int vfs_get_fsize(void *pvfile, void *parm)
    • 2.4.3. 函数struct vfscan *vfs_fscan_new(void *pvfs, const char *path, const char *arg, u8 max_deepth, int (*callback)(void), strcut vfscan *fsn, struct vfscan_reset_info *info)
    • 2.4.4. 函数void vfs_fscan_release(void *pvfs, struct vfscan *fs)
    • 2.4.5. 函数int vfs_get_folderinfo(void **pvfile, struct vfscan *fs, int *start_num, int *end_num)
    • 2.4.6. 函数int vfs_mk_dir(void *pvfs, char *folder, u8 mode)
    • 2.4.7. 函数int vfs_get_encfolder_info(void *pvfs, char *folder, char *ext, u32 *last_num, u32 *total_num)
    • 2.4.8. 函数u32 vfs_file_delete(void *pvfile)
    • 2.4.9. 函数int vfs_select(void *pvfs, void **ppvfile, struct vfscan *fs, int sel_mode, int arg)
• 3. 解码接口
  • 3.1. 解码使用一般流程
  • 3.2. 数据流获取
  • 3.3. 解码管理接口函数
    • 3.3.1. 函数dec_obj *decoder_io(void *pfile, u32 dec_ctl, dp_buff * dbuff,u8 loop)
    • 3.3.2. 函数void irq_decoder_ret(dec_obj *obj,u32 ret)
  • 3.4. 解码功能控制函数
    • 3.4.1. 函数void decoder_pause(dec_obj *obj)
    • 3.4.2. 函数void decoder_stop(dec_obj *obj, DEC_STOP_WAIT wait)
  • 3.5. 各个格式的解码函数
    • 3.5.1. 统一介绍decode_api
• 4. F1X格式解码流程说明
  • 4.1. 简介
  • 4.2. 结构体 / 函数说明
    • 4.2.1. 结构体f1x_ctl
    • 4.2.2. 函数void *f1x_play_api(void *pfile, u8 *loop_tab, u32 size, u8 index, u32 addr)
    • 4.2.3. 函数int f1x_parsing(void *pfile, u32 *buff, u32 sum)
    • 4.2.4. 函数u32 set_play_file(void *priv, u32 *startpos, u32 *endpos)
  • 4.3. 解码流程
• 5. 编码接口
  • 5.1. 编码应用流程
  • 5.2. 编码功能控制接口函数
    • 5.2.1. void encoder_io(u32(* fun)(void* ), void* pfile)
    • 5.2.2. void stop_encode(void* pfile, u32 dlen)
• 6. JL_MIO功能
  • 6.1. JLmio一般流程
    • 6.1.1. 使用JLmio.exe创建mio文件
    • 6.1.2. 使用打包工具将音频文件与所制成的mio文件放于同一目录下
    • 6.1.3. 在download.bat中添加相应mio文件夹
    • 6.1.4. 在app_music.c中添加相应mio文件夹
    • 6.1.5. 在mio_api.c中将相应宏开关打开
  • 6.2. JLmio接口介绍
    • 6.2.1. void mio_a_pwm_init(u32 chl)
    • 6.2.2. void mio_a_pwm_run(u32 chl， u32 pwm_var)
    • 6.2.3. void mio_a_io_init(u32 mask)
    • 6.2.4. void mio_a_io_run(u32 mask， u32 io_ver)

---

应用流程:

• 1. 玩具应用篇（新工程 - voice_toy）
  • 1.1. 简介
    • 1.1.1. 模式相关函数
  • 1.2. toy_music 多路解码模式
    • 1.2.1. 模式说明
    • 1.2.2. 解码播放函数
  • 1.3. toy_midi midi解码模式
    • 1.3.1. 模式说明
    • 1.3.2. 相关函数
  • 1.4. toy_midi_keyboard midi琴模式
    • 1.4.1. 模式说明
    • 1.4.2. 相关函数
  • 1.5. toy_speaker 扩音模式
    • 1.5.1. 模式说明
    • 1.5.2. 相关函数
  • 1.6. toy_linein linein模式
    • 1.6.1. 模式说明
  • 1.7. toy_record 录音模式
    • 1.7.1. 模式说明
    • 1.7.2. 相关函数
• 2. 玩具应用篇（旧工程 - app_mg）
  • 2.1. 简介
  • 2.2. 模式初始化函数
    • 2.2.1. 函数int app_mg_init(APP_T app,void* param)
    • 2.2.2. 函数void app(void)
  • 2.3. 模式切换函数
    • 2.3.1. 函数int app_switch(APP_T app,void* param)
    • 2.3.2. 函数int app_switch_next(void)
    • 2.3.3. 函数int app_switch_priv(void)
    • 2.3.4. 函数u8 app_get(void)
  • 2.4. 常用工程配置文件
    • 2.4.1. “app_config.c”文件
    • 2.4.2. 函数u8 app_get(void)
    • 2.4.3. code block 工程配置
• 3. 小音箱应用

---

音频:

• 1. AUDIO DAC
  • 1.1. AUDIO DAC配置参数
    • 1.1.1. AD14N / AD15N / AC104N DAC驱动模式介绍
    • 1.1.2. AD17N APA驱动模式介绍
    • 1.1.3. AD18N AUDIO驱动模式介绍
  • 1.2. AUDIO DAC接口介绍
    • 1.2.1. 函数void dac_mode_init(void)
    • 1.2.2. 函数void dac_init_api(u32 sr)
    • 1.2.3. 函数void dac_power_on(u32 sr, bool delay_flag)
    • 1.2.4. 函数void dac_off_api(void)
    • 1.2.5. 函数bool dac_mute(bool mute)
    • 1.2.6. 函数u8 dac_vol(char set, u8 vol)
    • 1.2.7. 函数bool regist_dac_channel(void *psound, void *kick)
    • 1.2.8. 函数bool unregist_dac_channel(void *psound)
    • 1.2.9. 函数void fill_dac_fill(u8 *buf, u32 len)
    • 1.2.10. 函数void single_apa_startup_mute_cb(void)
    • 1.2.11. 函数void single_apa_mute(u8 mute)
• 2. AUDIO ADC（AD14N / AC104N）
  • 2.1. 1 AUDIO ADC接口介绍
    • 2.1.1. 1.1 函数void audio_adc_mode_init(void)
    • 2.1.2. 1.2 函数u32 audio_adc_init_api(u32 sr, ADC_MODE mode, u32 ch)
    • 2.1.3. 1.3 函数void audio_adc_off_api(void)
    • 2.1.4. 1.4 函数bool regist_audio_adc_channel(void *psound, void *kick)
    • 2.1.5. 1.5 函数bool unregist_audio_adc_channel(void *psound)
    • 2.1.6. 1.6 函数void fill_audio_adc_fill(u8 *buf, u32 len)
• 3. 音量
  • 3.1. 底层音量接口
    • 3.1.1. 函数void dac_mode_init(u16 vol, void *phy_vol_set_func)
    • 3.1.2. 函数u8 dac_vol(char set,u8 vol)
  • 3.2. 音量应用介绍

---

音效算法:

• 1. 混响（echo）
  • 1.1. 1 配置参数说明
  • 1.2. 2 相关函数
    • 1.2.1. 2.1 函数void *link_echo_sound(void *p_sound_out, void *p_dac_cbuf, void **pp_effect, u32 sr)
    • 1.2.2. 2.2 函数void *echo_api(void *obuf, u32 sr, void **ppsound)
• 2. 移频啸叫抑制（pitchshifter_howling）
  • 2.1. 1 配置参数说明
  • 2.2. 2 相关函数
    • 2.2.1. 2.1 函数void *link_pitchshift_howling_sound(void *p_sound_out, void *p_dac_cbuf, void **pp_effect, u32 sr)
    • 2.2.2. 2.2 函数void *pitchshift_howling_api(void *obuf, u32 sr, void **ppsound)
    • 2.2.3. 2.3 函数void update_howling_parm_fs_api(u32 sr, s16 new_fs)
• 3. 自适应陷波啸叫抑制（notch_howling）
  • 3.1. 1 配置参数说明
  • 3.2. 2 相关函数
    • 3.2.1. 2.1 函数void *link_notch_howling_sound(void *p_sound_out, void *p_dac_cbuf, void **pp_effect, u32 sr)
    • 3.2.2. 2.2 函数void *notch_howling_api(void *obuf, u32 sr, void **ppsound)
• 4. 均衡器（PCM_EQ）
  • 4.1. 1 配置参数说明
  • 4.2. 2 相关函数
    • 4.2.1. 2.1 函数void *link_pcm_eq_sound(void *p_sound_out, void *p_dac_cbuf, void **pp_effect, u32 sr, u32 channel)
    • 4.2.2. 2.2 函数void *pcm_eq_api(void *obuf, u32 sr, u32 channel, void **ppsound)
  • 4.3. 3 EQ工具使用
    • 4.3.1. 3.1 EQ工具使用介绍
    • 4.3.2. 3.2 SDK配置说明
• 5. 变音音效（vo_pitch）
  • 5.1. 可选音效
  • 5.2. 配置参数说明
  • 5.3. 相关结构体及函数
    • 5.3.1. 结构体VOICE_PITCH_PARA_STRUCT
    • 5.3.2. 函数void *link_voice_pitch_sound(sound_out_obj *p_curr_sound, void *p_dac_cbuf, void **pp_effect, u32 cmd)
    • 5.3.3. 函数void *voice_pitch_api(void *obuf, u32 cmd, void **ppsound)
    • 5.3.4. 函数void rap_callback(void *priv, int pos)
    • 5.3.5. 函数void rap_reopen(void)
  • 5.4. RAP和RAP_REALTIME模式文件替换说明
• 6. 混合变音音效（voicechanger）
  • 6.1. 可选音效
  • 6.2. 配置参数说明
  • 6.3. 相关函数接口
    • 6.3.1. 函数void *link_voice_changer_sound(void *p_sound_out, void p_dac_cbuf, void **pp_effect, u32 in_sr)
    • 6.3.2. 函数void *voice_changer_api(void *obuf, u32 sr, void **ppsound)
    • 6.3.3. 函数void update_voice_changer_parm(VOICECHANGER_AV_PARM *new_vc_parm, VOICESYN_AV_PARM *new_vsyn_ctrol)
• 7. 变速变调（speed）
  • 7.1. 配置参数说明
  • 7.2. 相关函数
    • 7.2.1. 函数void *speed_api(void *obuf, u32 insample, void **ppsound)
    • 7.2.2. 函数int music_play_speed_set_para(music_play_obj *hdl, SPEED_PITCH_PARA_STRCUT *sp_parm)

---

电源:

• 1. 软关机Soft off和低功耗Power down
  • 1.1. 关机与唤醒相关参数配置
    • 1.1.1. A0芯片flash使用VDDIO供电配置
    • 1.1.2. VDDIO电压档位配置
    • 1.1.3. 低功耗唤醒源配置
  • 1.2. Soft off及Power down相关函数
    • 1.2.1. 函数void sys_softoff()
    • 1.2.2. 函数void sys_power_down(u32 usec)
    • 1.2.3. 函数void board_set_soft_poweroff(void)
  • 1.3. Soft off及Power down唤醒源获取及其他函数
    • 1.3.1. AD14N / AD15N / AC104N 相关接口
    • 1.3.2. AD17N与AD18N相关接口
• 2. VDDIO电压配置说明
  • 2.1. VDDIO作用域
  • 2.2. 如何配置每个阶段的VDDIO档位
    • 2.2.1. 上电过程：
    • 2.2.2. Boot-Loader：
    • 2.2.3. SDK：
  • 2.3. 常见问题介绍
    • 2.3.1. VDDIO偏差

---

其他:

• 1. VM 掉电存储说明
  • 1.1. VM 记忆的基本原理
  • 1.2. VM 记忆的系统局限性
  • 1.3. NEW VM的预擦除
  • 1.4. NEW VM常见BUG
  • 1.5. VM 掉电存储使用说明
  • 1.6. VM 掉电存储版本简单说明
  • 1.7. 新旧VM文件组成及版本选择
  • 1.8. VM相关参数介绍
    • 1.8.1. ID号（vm_api.h）
    • 1.8.2. 读/写入数据长度
    • 1.8.3. vm存储区域大小
    • 1.8.4. 新版VM格式整理时缓存空间设置new_vm_buff（new_vm.h）
    • 1.8.5. 新版vm格式整理后是否立即擦除旧半区区域功能
    • 1.8.6. 新版vm是否支持多段读功能
  • 1.9. VM掉电记忆存储接口
    • 1.9.1. 函数u32 syscfg_vm_init(u32 addr, u32 size)
    • 1.9.2. 函数u32 vm_write(u32 id,u8 *buf,u32 len)
    • 1.9.3. 函数u32 vm_read(u32 id ,u8 *buf,u32 len)
    • 1.9.4. 函数 u32 vm_pre_erase(void)
    • 1.9.5. 函数 nvm_pre_erasure_next(NEW_VM_OBJ *p_nvm, u16 using_next, u16 idle_next)
  • 1.10. VM常见问题介绍
    • 1.10.1. VM简单使用demo：
    • 1.10.2. 调整VM区域大小设置：
    • 1.10.3. 新版VM在关机或者掉电后可能存在数据丢失BUG：
    • 1.10.4. VM格式整理原理：
• 2. 消息与事件
  • 2.1. 1 消息与事件使用一般流程
  • 2.2. 2 消息与事件函数
    • 2.2.1. 2.1 void event_init(void)
    • 2.2.2. 2.2 void message_init()
    • 2.2.3. 2.3 u32 event2msg_api(u32 event)
    • 2.2.4. 2.4 int post_event(int event)
    • 2.2.5. 2.5 int post_msg(int argc, …)
    • 2.2.6. 2.6 bool get_event_status(u32 event)
    • 2.2.7. 2.7 函数int get_msg(int len, int *msg)
    • 2.2.8. 2.8 函数void clear_all_message(void)
• 3. 按键系统key
  • 3.1. 按键类型介绍
    • 3.1.1. IO按键
    • 3.1.2. AD按键
    • 3.1.3. IR按键
    • 3.1.4. MATRIX按键
    • 3.1.5. touch按键：
  • 3.2. 按键接口介绍：
    • 3.2.1. 函数void key_init(void)
    • 3.2.2. 函数void key_table_sel(void *msg_filter)
    • 3.2.3. 函数void key_scan(void)
• 4. Reserved_Area区域说明
  • 4.1. 1 认证码使用说明
  • 4.2. 2 认证码文件说明
• 5. 多录音分区（AD14N）
  • 5.1. 1 多录音分区一般流程
    • 5.1.1. 1.1 创建录音分区初始化
    • 5.1.2. 1.2 创建录音切换分区消息事件并设置键位
    • 5.1.3. 1.3 在app录音任务中实现录音分区切换操作
• 6. 虚拟RTC
  • 6.1. 功能接口介绍
    • 6.1.1. int rtc_simulate_init(const struct vir_rtc_data *arg)
    • 6.1.2. void read_sys_time(struct sys_time *curr_time);
    • 6.1.3. void write_sys_time(struct sys_time *curr_time);
    • 6.1.4. void read_alarm(struct sys_time *alarm_time);
    • 6.1.5. void write_alarm(struct sys_time *alarm_time);
    • 6.1.6. void vir_set_alarm_ctrl(u8 set_alarm);
    • 6.1.7. u8 vir_get_alarm_ctrl(void);
• 7. 双备份升级
  • 7.1. 支持双备份升级的芯片以及对应SDK版本
  • 7.2. SDK相关配置
  • 7.3. 相关接口说明
    • 7.3.1. 函数u32 jlfs_get_idle_bank_info(u32 *bank_addr, u32 *bank_size)
    • 7.3.2. 函数u32 jlfs_updata_dual_bank_info(u32 bank_addr, u16 data_crc)
    • 7.3.3. 函数u32 jlfs_check_dual_bank_info(u32 update_bank_addr)
  • 7.4. 常见客户问题

---

Indices and tables

• 索引

• 模块索引

• 搜索页面