EffectTool_UserManual

📎 原始文档：https://www.kdocs.cn/l/cpWjDqyWBUVaimage

Effect Tool User Manual

珠海市杰理科技股份有限公司

Zhuhai Jieli Technologyco.,LTD

版权所有，未经许可，禁止外传
目录
第 1章 快速开始...............................................................................................................................3
1.1 程序配置................................................................................................................................... 3
1.2 打开工具................................................................................................................................... 4
1.3 连接工具................................................................................................................................... 4
1.3. 1.通过USB 连接............................................................................................................ 5
1.3.2.通过串口连接.............................................................................................................5
1.4 音效调节................................................................................................................................... 5
1.4. 1.模式选项卡................................................................................................................. 6
1.4.2.数据流程图................................................................................................................. 6
1.4.3.模块参数..................................................................................................................... 6
1.4.4.开始音效调节............................................................................................................. 7
1.5 下载音效配置文件................................................................................................................... 7
1.5. 1.通过导出配置文件更新............................................................................................. 7
1.5.2.通过配置写入功能更新............................................................................................. 7
第2章 概念介绍...............................................................................................................................9
2.1 界面说明................................................................................................................................... 9
2. 1. 1.设置界面.....................................................................................................................9
2. 1.2.音效调节界面........................................................................................................... 10
2. 1.3.模块设置界面........................................................................................................... 11
2. 1.4.模式介绍................................................................................................................... 12
2. 1.5.快照功能................................................................................................................... 12
2. 1.6.密码功能................................................................................................................... 12

第1章 快速开始

音效配置工具能够让开发者更好地完成音效的调试与确认，支持保存到文件与在线调试等形式，并且已数据流形式呈现，更加直观，音效配置工具的使用场景见下图.
image

1.1 程序配置

在开始音效调试之前，需要程序进行对应的配置才能生效，详见配置如下：
imageimage 程序配置好所需的功能后，仅需编译下载即可，程序内部会自动选择对应的音效配置文件。
以下是宏配置与下载目录下音效配置文件的对应关系:
music_base. bin：没有麦克风音效，只有播放音效设置，且LINEIN与蓝牙使用相同的音效配置
image

  1. #define TCFG_MIC_EFFECT_ENABLE DISABLE
  2. #define LINEIN_MODE_SOLE_EQ_EN DISABLE
    music_base_linein.bin：没有麦克风音效，只有播放音效设置，且LINEIN与蓝牙使用不同的音效配置
  3. #define TCFG_MIC_EFFECT_ENABLE DISABLE
    image
  4. #define LINEIN_MODE_SOLE_EQ_EN DISABLE
    mic_effect_reverb.bin：打开麦克风音效，使能Reverb效果，LINEIN与蓝牙使用不同的音效配置
    image
  5. #define TCFG_MIC_EFFECT_ENABLE ENABLE
  6. #define LINEIN_MODE_SOLE_EQ_EN ENABLE
    image
  7. #define TCFG_MIC_EFFECT_SEL MIC_EFFECT_REVERB
    mic_effect_echo.bin：打开麦克风音效，使能Reverb效果，LINEIN与蓝牙使用不同的音效配置
    image
  8. #define TCFG_MIC_EFFECT_ENABLE ENABLE
  9. #define LINEIN_MODE_SOLE_EQ_EN ENABLE
    image
  10. #define TCFG_MIC_EFFECT_SEL MIC_EFFECT_ECHO

1.2 打开工具

在下载目录中找到xxx配置入口.jlxproj ,点击打开。弹出以下界面
image 点击调音工具一旁的打开按钮，打开调音工具

1.3 连接工具

通过与工具连接，将样机中的音效配置文件读取到工具中，将不同的模式对应的数据流以数据流程图形式显示在对应的模式选项卡中。
image

1.3.1.通过USB连接

程序配置：
image

  1. #define TCFG_EFFECT_TOOL_ENABLE ENABLE
  2. #define TCFG_COMM_TYPE TCFG_USB_COMM
    通过USB线将样机与PC连接,工具端口选择USB 串行设备（COM<?>），如果有多个此类设备可以拔出样机的 USB线，观察消失的设备即为样机枚举的端口。例：
    image 点击打开，等待通信结束。完成通讯后会自动跳转到音效调节页面，并在下方状态栏显示更新模式成功。
1.3.2.通过串口连接

程序配置：
image

  1. #define TCFG_EFFECT_TOOL_ENABLE ENABLE
  2. #define TCFG_COMM_TYPE TCFG_UART_COMM
  3. #define TCFG_TOOL_TX_PORT IO_PORT_DP
  4. #define TCFG_TOOL_RX_PORT IO_PORT_DM
    将PC 串口的 RX，TX分别与样机配置的TX， RX连接工具端口选择对应的 PC 串口设备，例：
    image 点击打开，等待通信结束（串口传输较慢，可能需要等待比较长时间）。完成通讯后会自动跳转到音效调节页面，并在下方状态栏显示更新模式成功。

1.4 音效调节

进入音效调节阶段,介绍基本概念：模式选项卡，数据流程图，模块参数，三个基本组成部分;

1.4.1.模式选项卡

image 模式选项卡用于选择不同的模式，每个模式选项卡都包含相应的数据流程图

1.4.2.数据流程图

image 数据流程图描述了从样机中读取到的数据流。数据从开头Source模块出发经过多个算法模块处理到达数据流的结束Sink模块。 点击数据流中需要调试的模块，就会弹出对应的模块参数窗口。
在不同的数据流程图中，Source与Sink 的实际意义各不相同。 比如在蓝牙播放的音效数据流程图中,Source代表解码器的输出，Sink代表DAC或者其他音频输出，具体根据样机程序决定。

1.4.3.模块参数

image 上图为EQ 的模块参数窗口，对窗口中的参数修改会实时传输到样机上生效。

1.4.4.开始音效调节

选择需要调试模式选项卡，双击数据流程图中需要调试的模块，就会弹出相应的模块参数窗口。

1.5 下载音效配置文件

1.5.1.通过导出配置文件更新

在调音结束后，点击保存音效配置文件按钮，保存音效配置文件。然后把音效配置文件复制到下载目录下，重新下载到样机。适用于量产程序生成。

1.5.2.通过配置写入功能更新

在调音结束后，点击将配置写入设备按钮，把当前所有的模块参数写入到设备中，实现掉电保存。适用于少量样机送样。
image

第2章 概念介绍

本工具为了方便开发者在线快速调试音效算法参数，实现理想的声音效果而设计。可以通过USB，或串口连接芯片实时修改算法模块参数，且可以在线把参数写入到芯片flash实现掉电保存。

2.1 界面说明

2.1.1.设置界面

image A.端口下拉菜单选择不同的通信接口，根据实际连接方式选定
B.波特率下拉菜单选择不同的波特率，默认115200
C.点击打开按钮开始跟下位机连接

2.1.2.音效调节界面

image A.打开音效配置文件
B.保存音效配置文件
C.将配置写入设备:通过这种方式把配置在线写入下位机是可以掉电保存。
D.从设备中读取配置
E.放大视图
F.缩小视图
G.重置视图
H.流程图居中
I.模式选项卡:显示下位机当前存储的模式，点击不同的模式选项卡显示不同的流程图。
J.流程图视图 :显示当前模式下的流程图。双击流程图中的模块显示模块的参数设置界面。
K.状态栏:显示当前工具与下位机通讯的状态信息。

2.1.3.模块设置界面

以下以DRC模块的设置界面为例进行进行说明
image A.回退按键 : 可以撤销这个界面内的上一次修改(Undo)
B.重做按键: 可以重做上一次撤销的修改(Redo)
C.增加快照: 把当前界面的参数状态保存到新的快照
D.当前的快照列表: 可以在下来菜单中选取不同的快照，选择快照的同时参数会全部更新为快照的状态。
E. bypass选框: 勾选bypass选框可以让当前模块bypass

2.1.4.模式介绍

image 如上图所示模式是对应从样机中读取到的数据流。一个模式对应一个数据流程图。
这些模式可能对应不同的通路，如图中的music和echo0，分别对应了麦克风的 ECHO 音效和音乐播放的音效。
同时，多个模式也可能对应相同的通路，如echo0~echo3,这些模式对应ECHO音效的多种不同效果。

2.1.5.快照功能

快照功能可以帮助调试者快速在不同的参数之间切换试听，同时部分模块还包含了一些预设的模式以供快速调试。
点击新增快照将当前界面的参数状态保存到新的快照，新增加的快照以snap-[x]的方式命名，x为快照序号。
在快照列表中有两个特殊的快照，分别是default和origin.
default :快照的参数是当前从下位机读取得到
origin :快照的参数是模块的默认值，且对此快照做出的所有修改在切换到其他快照后都不会保存。 主要用于生成新的快照。
注意：快照只会在工具关闭前保持，当工具关闭后所有快照都会丢失。点击保存音效配置文件或者将配置写入设备按纽会把当前流程图中所有模块最后选中的快照状态下的参数保存或写入到设备。

2.1.6.密码功能

密码功能可以对音效配置文件加密，使得连接样机时，需要密码才可以查看相关的信息。
image 首先在在已经连接样机的状态下点击设置->设置密码
image 输入密码，然后通过1.5 的下载方法重新下载音效配置文件即可。