工具使用环境介绍
=========================================

    同时我司有许多工具支持压缩转换和打包音频，将资源文件下载到内置或外挂FLASH中。

^^^^^^^^^^^^^^^^^^^^

开发工具介绍
###############################

    AD24N支持的开发工具如下：
    
        #. 资源打包工具：能将多个文件打包成一个文件；
        #. 音频文件转换工具：能将音频文件转换为系统能支持的格式；
        #. MIDI转换工具：能将midi文件转换为系统能支持的格式以及制作midi音色库；
        #. MIO工具：能制作波形随音频律动的MIO文件；
        #. SYD系统制作工具：能格式化SD卡/U盘并挂载我司SYD文件系统的工具；
        #. 多算法授权；

    以上工具可在AD14N_AD15N_gitee开源网站上或询问我司深圳办人员获取，部分工具内含说明文档。
    
    本节将介绍以下工具；
        #. `音频转换工具`_
        #. `资源打包工具`_
        #. `多算法授权简单介绍`_

.. _音频转换工具:   

音频转换工具
###############################
    音频文件转换工具_1.2.20.exe是我司用于压缩转换WAV、MP3和WMA音频的工具，
    
    可将音频转换成我司的A（B、E）格式、F1A（F1B、F1C）格式、F1X格式以及UMP3格式；

    **（一）音频转换步骤**

        1、添加需要转换的音频文件；
    
        2、选择输出音频的保存目录；
    
        3、选择需要转换的格式、采样率、码率以及其他选项；
    
        4、点击开始转换；

    .. image:: transform.png
        :alt: "音频文件转换步骤“
        :align: center

    .. centered:: 音频文件转换步骤

    **（二）目标格式选择**
  
        转换工具可生成三种类型文件:
            | 第一类\*.a、\*.b、\*.e；
            | 第二类\*.f1a、\*.f1b、\*f1c；
            | 第三类\*.ump3。
            
        每种类型都有采样率或码率供自由选择，一般采样率高了对应选择的码率也会高些，采样率跟码率都影响音质。

        类型格式选择：选哪个格式，一般考虑音质、设备资源以及系统运行速度。

    .. note::

        | 例如需要音质高而flash大小够用，系统资源够跑，就选用高压缩比的类型。
        | 一般要低码率的话，可以先选f1a/f1b/f1c;
        | 系统需要速度快，就选 a。
        | 如果f1a/f1c没法满足要求，如压音乐之类的，可以选ump3。
        | 如需要重复播报的音频段或者音频间无缝衔接的，可以选择f1x。

    - a、b、e格式：
    
        | 该格式转换压缩比比较低，速度快，资源小。可用于人声或者背景音乐。
        | 该格式特点是音质较差，但占用内存小。

    .. image:: abe_config.png
        :alt: "a、b、e 格式配置图“
        :align: center

    .. centered:: a、b、e 格式配置图

    - f1a、f1b、f1c、f1x格式：

        该格式转换压缩比比较高，比较适用人声和音乐，音质一般，其中f1a、f1b、f1c可用于无缝衔接，f1x格式可用于音频拼接。

    .. image:: f1abcx_config.png
        :alt: "f1a、f1b、f1c、f1x 格式配置图“
        :align: center
    
    .. centered:: f1a、f1b、f1c、f1x 格式配置图

    - ump3格式：
    
        | m该格式有较多的采样率和码率可以选择，可以按情况来压缩音乐或者人声，
        | 该格式特点是占用内存大，音质较好。

    .. image:: ump3_config.png
        :alt: "ump3 格式配置图“
        :align: center

    .. centered:: ump3 格式配置图

    **（三）其他参数说明**
    
        1、f1a / f1b / f1c无缝衔接转换和提高小文件压缩比

            (1)是否无缝循环
                | 如果勾选是否无缝循环，则可以首尾无缝对接循环重复播放同一个音频。
                | 其能量转换阈值范围0到65536，代表0到1，默认参数配成10，即砍掉接近完全静音的部分。
                | 运算过程中的音频也是归一化到0到1来计算的。
                | 在实际应用中，调整的阈值范围一般是选取0到0.1，即约0到6000。可以设成2048。 试下循环效果。

            (2)循环附加预处理
                如果勾选循环附加预处理，会对f1a/f1b/f1c文件再做多一次处理，分析计算文件前后的帧叠位置，计算前后的砍帧个数，然后对文件前后做一次前后自适应砍帧的动作。
        
            (3)提高小文件压缩比
                | 如果勾选提高小文件压缩比，会使压缩后的目标文件码率较为接近目标码率。
                | f1a是cbr的编码。需要长时间来平均来达到接近目标码率。
                | 如果文件都很小的时候，压出来的目标文件码率可能会距离目标码率差距较大。
                | 勾上提高小文件压缩比，会接近些。


            .. note::

                注：建议无缝循环的时候，只勾选是否无缝循环选项，听得出卡顿的文件，再勾选循环附加预处理，因为这个步骤的砍帧可能会出现有些文件前后会被砍比较多的情况！
        
        2、f1x制作说明

            | 制作f1x音频时，需要选择音频头字节数和头尾去除帧数。
            | 音频头字节数用于文件寻址，与原始转换文件大小有关。头字节数为3时，生成的f1x文件超过16M字节会报错，文件较多时可节约空间；头字节数为4时，则无限制。
            | 头尾去除帧数用于选择去除的f1x内各个音频文件头尾的音频数据包数，可以调整衔接效果。
            | 但不可完全依赖该功能，对于衔接效果不理想的音频，需要从音源文件去改善。
    
        3、ump3的能量阈值

            | ump3格式有能量阀值选项，勾选开关便可以设置阀值，音频前后端会根据这个值砍掉一些低能量的音频，使播放开始和结束时更柔和。
            | 阀值范围：0-2147483648，默认参数配成65535.即砍掉接近完全静音的部分，
            | 值越大能量剪切越多。
            | 鼠标悬停在能量阀值输入框无任何操作两秒以上会显示阀值范围。

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


.. _资源打包工具:   

资源打包工具
###############################

    下载到系统FLASH的资源文件需要经过资源打包工具处理之后才能使用，SDK下载目录中的dir文件就是经过该工具打包后的文件。

    打包工具包括：new_packres.bat、packres.exe和pRFiles.exe；
    
    其中new_packres.bat支持的命令详情请看同目录下的readme.md文件。

    **（一）少量文件直接打包**
    
        1、将需要打包的文件放在工具根目录下，打开new_packres.bat文件，指定需要打包的文件以及输出的文件夹名;

        .. image:: new_packres.bat.png
            :alt: "new_packres.bat资源打包批处理说明“
            :align: center

        .. centered:: new_packres.bat资源打包批处理说明

        2、保存new_packres.bat文件，并双击该批处理，工具根目录下生成打包文件夹表示打包成功;

        .. image:: new_packres.png
            :alt: "new_packres.bat运行结果图“
            :align: center

        .. centered:: new_packres.bat运行结果图

    **（二）大量文件通过pRFiles.exe批量打包**
    
        1、将大量文件放在文件夹中，打开pRFiles.exe，如下图所示进行操作，保存为LST文件，以保存为TEST.LST为例；

        .. image:: pRFiles.png
            :alt: "pRFiles.exe打包工具操作图“
            :align: center
    
        .. centered:: pRFiles.exe打包工具操作图

        2、将大量文件放在文件夹中，打开pRFiles.exe，如下图所示进行操作，保存为LST文件，以保存为TEST.LST为例；

        .. image:: packing.png
            :alt: "new_packres.bat资源打包批处理说明“
            :align: center

        .. centered:: new_packres.bat资源打包批处理说明

        3、保存new_packres.bat文件，把资源文件全部放到工具根目录下，并双击该批处理，工具根目录下生成打包文件夹表示打包成功；

        .. image:: new_packres_running.png
            :alt: "new_packres.bat运行结果图“
            :align: center

        .. centered:: new_packres.bat运行结果图

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. _多算法授权简单介绍:   

多算法授权简单介绍
###############################

    **使用该功能前请咨询杰理助理；**
    
    多算法授权，指的是：在一个SDK中，使用了算法提供商的库函数，而算法提供商可以控制芯片的烧录次数。

    （一）使用场景
        1. 算法提供商想要控制生产商使用算法库的次数（即：算法提供商按生产的样机收取费用）。

    | 具体详细说明可以点击下方链接：
    | `多算法授权使用说明 <https://doc.zh-jieli.com/Tools/zh-cn/mass_prod_tools/multi_auth/index.html>`_