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

开源社区仓库链接：

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

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

开源社区交流群：

开源社区钉钉群二维码

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

---

文档版本说明:

• 文档版本说明
  • v1.1.1 说明
  • v1.1.0 说明
  • v1.0.0 说明

---

IDE 软硬件开发环境介绍:

• 1. 环境介绍
  • 1.1. 硬件环境介绍
    • 1.1.1. AD16N硬件开发环境
  • 1.2. 快速上手
    • 1.2.1. 编译下载介绍
    • 1.2.2. 编译下载报错说明
  • 1.3. SDK工程配置
    • 1.3.1. 应用配置文件《app_config.c》介绍
    • 1.3.2. 应用配置文件《app_config.h》介绍
    • 1.3.3. APP配置文件《app_modules.h》介绍
  • 1.4. AD16N超频说明
  • 1.5. AD16N启动时间
• 2. 下载目录 & 烧写说明
  • 2.1. 下载目录介绍
    • 2.1.1. dowload_bat.c 文件介绍
    • 2.1.2. isd_config.ini文件介绍
  • 2.2. 派生密钥3.0介绍
  • 2.3. 二级密钥V2.0简单介绍
  • 2.4. 多算法授权简单介绍
  • 2.5. 烧写注意事项
  • 2.6. FLASH工程烧写补充说明
  • 2.7. OTP工程烧写补充说明
    • 2.7.1. FLASH调试模式与OTP模式区别
    • 2.7.2. FLASH调试模式与OTP模式的烧写
  • 2.8. 开发工具介绍
    • 2.8.1. 资源打包工具
    • 2.8.2. 音频转换工具

---

设备、文件、编解码:

• 1. 设备管理
  • 1.1. 设备注册表
  • 1.2. 设备函数
    • 1.2.1. 函数int devices_init_api_()
    • 1.2.2. 函数void *dev_open(u32 index)
    • 1.2.3. 函数u32 device_close(u32 index)
    • 1.2.4. 函数void *device_obj(u32 index)
    • 1.2.5. 函数u32 device_online(void)
    • 1.2.6. 函数u32 device_status(u32 index， bool mode)
    • 1.2.7. 函数int dev_bulk_read(void *_device, void *buf, u32 offset, u32 len)
    • 1.2.8. 函数int dev_bulk_write(void *_device, void *buf, u32 offset, u32 len)
    • 1.2.9. 函数int dev_ioctl(void *device, int cmd, u32 arg)
    • 1.2.10. 函数int dev_close(void *device)
• 2. 文件系统管理
  • 2.1. 文件系统介绍
    • 2.1.1. sydfs文件系统
    • 2.1.2. norfs文件系统
    • 2.1.3. fat文件系统
  • 2.2. 文件系统使用一般流程
  • 2.3. 通用文件系统管理函数
    • 2.3.1. 函数void fs_init(void)
    • 2.3.2. 函数u32 fs_mount(void **ppvfs, void *device, void *type)
    • 2.3.3. 函数u32 fs_openbypath(void *pvfs, void **ppvfile, const char *path)
    • 2.3.4. 函数u32 fs_read(void *pvfile, void *buf, u32 len)
    • 2.3.5. 函数u32 fs_seek(void *pvfile, u32 offset, u32 mode)
    • 2.3.6. 函数u32 fs_file_close(void **ppvfile)
    • 2.3.7. 函数u32 fs_fs_close(void **ppvfs)
    • 2.3.8. 函数u32 fs_file_name(void *pvfile， void *name, u32 len)
    • 2.3.9. 函数int fs_get_attrs(void *pvfile, void *pvfs_attr)
    • 2.3.10. 函数int fs_ioctl(void *pvfile, int cmd, int arg)
  • 2.4. FAT文件系统管理函数
    • 2.4.1. 函数int fs_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 fs_fscan_release(void *pvfs, struct vfscan *fs)
    • 2.4.5. 函数int fs_get_folderinfo(void **pvfile, struct vfscan *fs, int *start_num, int *end_num)
    • 2.4.6. 函数int fs_get_encfolder_info(void *pvfs, char *folder, char *ext, u32 *last_num, u32 *total_num)
    • 2.4.7. 函数u32 fs_file_delete(void *pvfile)
    • 2.4.8. 函数int fs_select(void *pvfs, void **ppvfile, struct vfscan *fs, int sel_mode, int arg)
    • 2.4.9. 函数int vfs_mk_dir(void *pvfs, char *folder, u8 mode)
    • 2.4.10. 函数int vfs_get_encfolder_info(void *pvfs, char *folder, char *ext, u32 *last_num, u32 *total_num)
    • 2.4.11. 函数u32 vfs_file_delete(void *pvfile)
    • 2.4.12. 函数int vfs_select(void *pvfs, void **ppvfile, struct vfscan *fs, int sel_mode, int arg)
• 3. 解码接口
  • 3.1. 解码使用一般流程
    • 3.1.1. 在解码之前的设备以及文件的初始化
    • 3.1.2. 数据流获取
    • 3.1.3. 解码流程
    • 3.1.4. DAC数据处理说明
  • 3.2. 解码管理接口函数
    • 3.2.1. 函数dec_obj *decoder_io(void *pfile, u32 dec_ctl, dp_buff * dbuff,u8 loop)
    • 3.2.2. 函数void irq_decoder_ret(dec_obj *obj,u32 ret)
  • 3.3. 解码功能控制函数
    • 3.3.1. 函数void decoder_pause(dec_obj *obj)
    • 3.3.2. 函数void decoder_stop(dec_obj *obj, DEC_STOP_WAIT wait)
    • 3.3.3. 函数bool decoder_ff(dec_obj *obj, u8 step)
    • 3.3.4. 函数bool decoder_fr(dec_obj *obj, u8 step)
    • 3.3.5. 函数int decoder_time(dec_obj *p_dec)
  • 3.4. 各个格式的解码函数
    • 3.4.1. 统一介绍decode_api
  • 3.5. 解码常见问题
    • 3.5.1. 播歌有卡音或者杂音如何查找问题
    • 3.5.2. 解码开始后声音变调问题
• 4. 编码接口
  • 4.1. 编码使用一般流程
  • 4.2. 编码功能控制接口函数
    • 4.2.1. 函数void encoder_io(u32(*fun)(void *), void *pfile)
    • 4.2.2. 函数void stop_encode(void *pfile, u32 dlen)
• 5. JL_MIO功能
  • 5.1. JLmio一般流程
    • 5.1.1. 使用JLmio.exe创建mio文件
    • 5.1.2. 使用打包工具将音频文件与所制成的mio文件放于同一目录下
    • 5.1.3. 在download.bat中添加相应mio文件夹
    • 5.1.4. 在app_music.c中添加相应mio文件夹
    • 5.1.5. 在mio_api.c中将相应宏开关打开
  • 5.2. JLmio接口介绍
    • 5.2.1. void mio_a_pwm_init(u32 chl)
    • 5.2.2. void mio_a_pwm_run(u32 chl， u32 pwm_var)
    • 5.2.3. void mio_a_io_init(u32 mask)
    • 5.2.4. void mio_a_io_run(u32 mask， u32 io_ver)

---

应用流程:

• 1. OTP小音箱应用流程
  • 1.1. 音乐解码模式
    • 1.1.1. 函数bool music_play_control(MBOX_MUSIC_CMD cmd, u32 index, DEC_STOP_WAIT mode)
    • 1.1.2. 函数bool mbox_simple_play_file(u8 dindex, u32 findex)
    • 1.1.3. 函数u32 device_mount(play_control *ppctl)
    • 1.1.4. 函数void fs_dev_close(void)
  • 1.2. 2 USB从机模式
  • 1.3. LINEIN模式
• 2. FLASH工程应用流程
  • 2.1. 音乐解码模式
  • 2.2. USB从机模式
  • 2.3. LINEIN模式
  • 2.4. MIDI解码 / MIDI琴模式
  • 2.5. 玩具多路解码模式
    • 2.5.1. 函数u32 simple_dev_fs_mount(play_control *ppctl)
    • 2.5.2. 函数u32 simple_dev_fs_close(play_control *ppctl)
    • 2.5.3. 函数u32 simple_play_file_byindex(play_control *ppctl)
    • 2.5.4. 5.4 函数u32 get_decoder_status(dec_obj *obj)
    • 2.5.5. 函数static bool simple_switch_device(play_control *ppctl)
    • 2.5.6. 函数static bool simple_next_dir(play_control *ppctl)
  • 2.6. 录音模式
    • 2.6.1. 函数int encode_start(Encode_Control *obj)
    • 2.6.2. 函数void encode_stop(Encode_Control *obj)
    • 2.6.3. 函数int fatfs_enc_file_create(Encode_Control *obj)
    • 2.6.4. 函数dec_obj *fatfs_enc_file_decode(Encode_Control *obj, u16 dec_type)
    • 2.6.5. 函数int norfs_enc_file_create(Encode_Control *obj)
    • 2.6.6. 函数dec_obj *norfs_enc_file_decode(Encode_Control *obj, u16 dec_type)
  • 2.7. LoudSpeaker扩音模式
    • 2.7.1. 函数void audio_adc_speaker_start(u32 sr)
    • 2.7.2. 函数void audio_adc_speaker_reless(void)

---

音频:

• 1. AUDIO 公共
  • 1.1. audio采样率列表
  • 1.2. audio工作模式列表
    • 1.2.1. AUDIO DAC 工作模式
    • 1.2.2. AUDIO ADC - MIC 工作模式
    • 1.2.3. AUDIO ADC - LINEIN 工作模式
  • 1.3. 《app_config.c》中的开机默认配置
  • 1.4. Audio 公共配置
• 2. AUDIO DAC
  • 2.1. 《app_config.c》中的开机默认配置
    • 2.1.1. Audio公共部分
    • 2.1.2. AUDIO DAC 部分配置
  • 2.2. 《audio_dac.h》中的开机默认配置
    • 2.2.1. 工作模式
    • 2.2.2. 位宽
  • 2.3. AUDIO DAC示例
    • 2.3.1. 开打AUDIO DAC硬件
    • 2.3.2. 关闭AUDIO DAC硬件
    • 2.3.3. 关闭AUDIO DAC与AUDIO硬件
  • 2.4. AUDIO 全关闭示例
  • 2.5. AUDIO DAC管理架构
    • 2.5.1. AUDIO DAC驱动模式
    • 2.5.2. AUDIO DAC共VCM0模式
  • 2.6. AUDIO DAC相关函数
    • 2.6.1. 函数void dac_mode_init(void)
    • 2.6.2. 函数void dac_init_api(u32 sr)
    • 2.6.3. 函数dac_sr_api(u32 sr)
    • 2.6.4. 函数void dac_off_api(void)
    • 2.6.5. 函数u8 stereo_dac_vol(char set, u8 vol_l, u8 vol_r)
    • 2.6.6. 函数u8 dac_vol(char set, u8 vol)
    • 2.6.7. 函数bool dac_mute(bool mute)
    • 2.6.8. 函数函数bool regist_dac_channel(void *psound, void *kick)
    • 2.6.9. 函数函数bool unregist_dac_channel(void *psound)
    • 2.6.10. 函数void fifo_dac_fill(u8 *buf, u32 len, AUDIO_TYPE type)
    • 2.6.11. 函数void audio_dac_analog_vol(AUDIO_DAC_ANA_VOL vol_l, AUDIO_DAC_ANA_VOL vol_r)
    • 2.6.12. 函数void audio_amux_analog_vol(AUDIO_DAC_AUMX_VOL vol_l, AUDIO_DAC_AUMX_VOL vol_r)
• 3. AUDIO ADC
  • 3.1. 《app_config.c》中的开机默认配置
    • 3.1.1. Audio公共部分
    • 3.1.2. AUDIO ADC 部分配置
  • 3.2. AUDIO ADC示例
    • 3.2.1. 打开AUDIO ADC硬件
    • 3.2.2. 停止AUDIO ADC运行
    • 3.2.3. 关闭AUDIO ADC硬件
    • 3.2.4. 关闭AUDIO以及AUDIO ADC硬件
  • 3.3. AUDIO 全关闭示例
  • 3.4. AUDIO ADC管理架构
    • 3.4.1. AUDIO ADC驱动模式
  • 3.5. AUDIO ADC相关函数
    • 3.5.1. 函数void audio_adc_mode_init(void)
    • 3.5.2. 函数u32 audio_adc_init_api(u32 sr, ADC_MODE mode, u32 ch)
    • 3.5.3. 函数void audio_adc_off_api(void)
    • 3.5.4. 函数bool regist_audio_adc_channel(void *psound, void *kick)
    • 3.5.5. 函数bool unregist_audio_adc_channel(void *psound)
    • 3.5.6. 函数void fill_audio_adc_fill(u8 *buf, u32 len)
• 4. 软硬件淡入淡出
  • 4.1. 淡入淡出效果配置
  • 4.2. 淡入淡出相关函数
    • 4.2.1. void dac_fade(void)
    • 4.2.2. dac_fade_in_api()
    • 4.2.3. dac_fade_out_api()

---

音效算法:

• 1. 混响音效（echo）
  • 1.1. 配置参数说明
  • 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. 函数void *echo_api(void *obuf, u32 sr, void **ppsound)
• 2. 移频啸叫抑制（pitchshifter_howling）
  • 2.1. 配置参数说明
  • 2.2. 相关函数
    • 2.2.1. 函数void *link_pitchshift_howling_sound(void *p_sound_out, void *p_dac_cbuf, void **pp_effect, u32 sr)
    • 2.2.2. 函数void *pitchshift_howling_api(void *obuf, u32 sr, void **ppsound)
• 3. 自适应陷波啸叫抑制（notch_howling）
  • 3.1. 配置参数说明
  • 3.2. 相关函数
    • 3.2.1. 函数void *link_notch_howling_sound(void *p_sound_out, void *p_dac_cbuf, void **pp_effect, u32 sr)
    • 3.2.2. 函数void *notch_howling_api(void *obuf, u32 sr, void **ppsound)
• 4. 简单EQ
  • 4.1. 简单EQ配置（OTP工程）
  • 4.2. 简单EQ相关接口（OTP工程）
    • 4.2.1. 函数void audio_eq_init_api(void)
    • 4.2.2. 函数void audio_eq_open_api(u8 ch, u16 sr)
    • 4.2.3. 函数void audio_eq_switch_tab(void)
    • 4.2.4. 函数void audio_eq_close_api(void)
• 5. 完整的浮点EQ
  • 5.1. 浮点EQ配置（Flash工程）
    • 5.1.1. 旧版本EQ模式管理
    • 5.1.2. 新版本EQ模式管理
  • 5.2. 浮点EQ相关接口（Flash工程）
    • 5.2.1. 函数 void *link_eq_sound(void *p_sound_out, void *p_dac_cbuf, void **pp_effect, u32 sr, u8 ch)
    • 5.2.2. 函数 void *link_eq_sound(void *p_sound_out, void *p_dac_cbuf, void **pp_effect, u32 sr, u8 ch)
    • 5.2.3. 函数 int eq_mode_sw(void *parm)
    • 5.2.4. 函数 u8 get_eq_mode_total_num(void *parm)
    • 5.2.5. 函数 u8 get_eq_mode_total_num(void *parm)
  • 5.3. 在线EQ调试助手使用一般流程
    • 5.3.1. SDK里开启PC模式和使用在线EQ调试工具宏定义
    • 5.3.2. 小机进入PC模式后打开使用AD16N在线EQ调试助手
    • 5.3.3. 在音效调节界面双击点击musicEQ进入在线调节EQ曲线界面
    • 5.3.4. 把生成的.bin文件下载到小机上
    • 5.3.5. SDK具体使用EQ样例
• 6. 变音音效（vo_pitch）
  • 6.1. 变音音效参数配置
  • 6.2. 变音音效算法链路链接函数
    • 6.2.1. 函数sound_out_obj *link_voice_pitch_sound(sound_out_obj *p_curr_sound, void *p_dac_cbuf, void **pp_effect, u32 cmd)
    • 6.2.2. 函数void *voice_pitch_api(void *obuf, u32 cmd, void **ppsound)
    • 6.2.3. 函数void rap_callback(void *priv, int pos)
    • 6.2.4. 函数void rap_reopen(void)
  • 6.3. 变音音效算法参数函数
  • 6.4. 两种RAP音效的区别
• 7. 实时变速变调(SONG_SPEED，用于扩音)
  • 7.1. 配置参数
  • 7.2. 相关函数
    • 7.2.1. 函数void *link_speed_sound(void *p_sound_out, void *p_dac_cbuf, void **pp_effect, u32 in_sr)
• 8. 歌曲变速变调(SONG_SPEED，用于解码)
  • 8.1. 配置参数
  • 8.2. 相关函数
    • 8.2.1. 函数void *link_song_speed_sound(void *p_sound_out, void *p_dac_cbuf, void **pp_effect, u32 in_sr, u8 ch)
    • 8.2.2. 函数void *song_speed_phy(void *obuf, PS69_CONTEXT_CONF *psp_parm, void **ppsound)

---

系统记忆:

• 1. 系统记忆存储
  • 1.1. 系统记忆存储接口
    • 1.1.1. 函数int sysmem_init_api(u32 mem_addr, u32 mem_size)
    • 1.1.2. 函数int sysmem_read_api(u32 id, u8 *data_buf, u16 len)
    • 1.1.3. 函数int sysmem_write_api(u32 id, u8 *data_buf, u16 len)
    • 1.1.4. 函数void sysmem_pre_erase_api(void)
• 2. 设备记忆（OTP工程）
  • 2.1. 设备记忆存储接口
    • 2.1.1. 函数u32 device_memory_control(u8 devmm_index, u8 *buf, u32 offset, u32 len, char set)
• 3. VM 掉电存储详细说明
  • 3.1. VM 记忆的基本原理
  • 3.2. VM 记忆的系统局限性
  • 3.3. NEW VM的预擦除
  • 3.4. NEW VM常见BUG
  • 3.5. VM 掉电存储使用说明
  • 3.6. VM 掉电存储版本简单说明
  • 3.7. 新旧VM文件组成及版本选择
  • 3.8. VM相关参数介绍
    • 3.8.1. ID号（vm_api.h）
    • 3.8.2. 读/写入数据长度
    • 3.8.3. vm存储区域大小
    • 3.8.4. 新版VM格式整理时缓存空间设置new_vm_buff（new_vm.h）
    • 3.8.5. 新版vm格式整理后是否立即擦除旧半区区域功能
    • 3.8.6. 新版vm多段读功能开关
  • 3.9. VM掉电记忆存储接口
    • 3.9.1. 函数u32 syscfg_vm_init(u32 mem_addr, u32 mem_size)
    • 3.9.2. 函数u32 sysmem_write_api(u32 id,u8 *data_buf, u32 len)
    • 3.9.3. 函数u32 sysmem_read_api(u32 id ,u8 *data_buf, u32 len)
    • 3.9.4. 函数 u32 sysmem_pre_erase_api(void)
    • 3.9.5. 函数void nvm_pre_erasure_next(NEW_VM_OBJ *p_nvm, u16 using_next, u16 idle_next)
  • 3.10. VM常见问题介绍
    • 3.10.1. VM简单使用demo：
    • 3.10.2. 调整VM区域大小设置：
    • 3.10.3. 新版VM在关机或者掉电后可能存在数据丢失BUG：
    • 3.10.4. VM格式整理原理：

---

其他:

• 1. FLASH硬件写保护功能
  • 1.1. flash写保护工具说明
    • 1.1.1. 新增flash写保护参数与指令
    • 1.1.2. Flash SR1、SR2寄存器和写保护范围
    • 1.1.3. 如何添加flash写保护参数
    • 1.1.4. Flash读写SR1、SR2指令
  • 1.2. 程序中开启与关闭写保护功能
  • 1.3. 写保护相关函数
    • 1.3.1. 函数int norflash_set_write_protect(u8 enable_write_protect)
    • 1.3.2. 函数u16 norflash_read_sr1_sr2(void)
    • 1.3.3. 函数u32 flash_code_protect_callback(u32 offset, u32 len)
• 2. 消息与事件
  • 2.1. 消息与事件使用一般流程
  • 2.2. 消息(msg)函数
    • 2.2.1. 函数void message_init()
    • 2.2.2. 函数int post_msg(int argc, …)
    • 2.2.3. 函数int get_msg(int len, int *msg)
    • 2.2.4. 函数void clear_all_message(void)
  • 2.3. 事件(EVENT)函数
    • 2.3.1. 函数void event_init(void)
    • 2.3.2. 函数u32 event2msg_api(u32 event)
    • 2.3.3. 函数int post_event(int event)
    • 2.3.4. 函数bool get_event_status(u32 event)
• 3. 按键系统Key
  • 3.1. 按键类型介绍
    • 3.1.1. IO按键介绍
    • 3.1.2. AD按键介绍
    • 3.1.3. 红外按键介绍
    • 3.1.4. 触摸按键介绍
  • 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)
  • 3.3. 按键消息配置
• 4. 低功耗与唤醒
  • 4.1. 低功耗相关参数配置
  • 4.2. 唤醒相关参数配置
  • 4.3. 低功耗相关函数
    • 4.3.1. 函数void music_idle_deal(void)（OTP工程）
    • 4.3.2. 函数void app_powerdown_deal(u8 is_busy)（FLASH工程）
    • 4.3.3. 函数void sys_softoff(void)
    • 4.3.4. 函数void board_set_soft_poweroff(void)
    • 4.3.5. 函数void sys_power_down(u32 usec)
  • 4.4. 唤醒相关函数
    • 4.4.1. 函数u8 is_wakeup_source(enum WAKEUP_REASON index)
    • 4.4.2. 函数void wakeup_callback(u8 index)
• 5. LCD段码屏驱动说明
  • 5.1. 简介
  • 5.2. 使用流程
  • 5.3. 与低功耗的配合使用和注意事项
• 6. RTC功能
  • 6.1. RTC功能介绍
  • 6.2. RTC配置参数
  • 6.3. RTC接口函数
    • 6.3.1. void read_current_time();
    • 6.3.2. void write_clock_time(u16 year , u8 month , u8 day , u8 hour , u8 min , u8 sec);
    • 6.3.3. void rea_alarm_time();
    • 6.3.4. void write_alarm_time(u16 year , u8 month , u8 day , u8 hour , u8 min , u8 sec);
    • 6.3.5. void time_wakeup_set(u8 index , u8 en);
    • 6.3.6. void set_alarm_ctrl(u8 set_alarm);
  • 6.4. RTC简单使用示例

---

Indices and tables

• 索引

• 模块索引

• 搜索页面