由于想要分享的内容较多，为避免读者姥爷们失去看下去的耐心，分享将以连载的方式进行。下期预告:移植 Speedsp 到 OHOS——VoIP 语音质量适配应用层机制研究综述
本期为移植speexdsp到OpenHarmony标准系统的第⑥期，主要内容如下：
speexdsp 移植后已提交至 openhamrony sig 仓库：https://gitee.com/openharmony-sig/contest/tree/master/2022_OpenHarmony_thirdparty/speexdsp
九、准备好上传 speexdsp 至 OpenHarmony 仓库。
移植完成后，先将代码上传至sig仓中的contest仓
sig 仓库是 TPC 仓库的孵化仓。代码先上 sig 仓，到时会直接平移到 tpc 仓。
上传的内容包括：
原生库代码
（除了涉及需要修改原生库代码的部分，其他都不能上传，例如编译途中生成的中间文件）
BUILD.gn
README.Opensource
库对外导出的所有 api 接口 export_api.txt
测试过的 api 接口 tested_api.txt
功能测试文档: 三方库_test_function.md
内容至少包含罗列出库所有的功能，已测试过的功能，原生库测试逻辑的分析
原生库分析文档: 三方库_analyse.md
文档命名不要用中文，如果涉及到编码问题的话，到时候会出现乱码，一般建议不用中文命名！！！
提供 OAT.xml 文件
OAT 开源扫描
工具使用
编译构建：
在父目录下添加 OAT.xml，内容如下:
<?xml version="1.0" encoding="UTF-8"?><!-- Copyright (c) 2021 Huawei Device Co., Ltd.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
This is the configuration file template for OpenHarmony OSS Audit Tool, please copy it to your project root dir and modify it refer to OpenHarmony/tools_oat/README.
-->
<configuration> <oatconfig> <licensefile>COPYING</licensefile> <policylist> <policy name="projectPolicy" desc=""> <!--policyitem type="compatibility" name="GPL-2.0+" path="abc/.*" desc="Process that runs independently, invoked by the X process."/--> <policyitem type="license" name="*" path=".*" rule="may" group="defaultGroup" filefilter="defaultPolicyFilter" desc=""/> </policy> </policylist> <filefilterlist> <filefilter name="defaultFilter" desc="Files not to check"> <filteritem type="filepath" name=".*" desc="原生库文件"/> </filefilter> <filefilter name="defaultPolicyFilter" desc="Filters for compatibility，license header policies"> <!--filteritem type="filename" name="*.uvwxyz" desc="Describe the reason for filtering scan results"/--> <!--filteritem type="filepath" name="abcdefg/.*.uvwxyz" desc="Describe the reason for filtering scan results"/--> <!--filteritem type="filepath" name="projectroot/[a-zA-Z0-9]{20,}.sh" desc="Temp files"/--> <filteritem type="filepath" name=".*" desc="原生库代码"/> </filefilter> <filefilter name="copyrightPolicyFilter" desc="Filters for copyright header policies"> <!--filteritem type="filename" name="*.uvwxyz" desc="Describe the reason for filtering scan results"/--> <!--filteritem type="filepath" name="abcdefg/.*.uvwxyz" desc="Describe the reason for filtering scan results"/--> <!--filteritem type="filepath" name="projectroot/[a-zA-Z0-9]{20,}.sh" desc="Temp files"/--> <filteritem type="filepath" name=".*" desc="原生库代码"/> </filefilter> <filefilter name="licenseFileNamePolicyFilter" desc="Filters for LICENSE file policies"> <!--filteritem type="filename" name="*.uvwxyz" desc="Describe the reason for filtering scan results"/--> <!--filteritem type="filepath" name="abcdefg/.*.uvwxyz" desc="Describe the reason for filtering scan results"/--> <!--filteritem type="filepath" name="projectroot/[a-zA-Z0-9]{20,}.sh" desc="Temp files"/--> </filefilter> <filefilter name="readmeFileNamePolicyFilter" desc="Filters for README file policies"> <!--filteritem type="filename" name="*.uvwxyz" desc="Describe the reason for filtering scan results"/--> <!--filteritem type="filepath" name="abcdefg/.*.uvwxyz" desc="Describe the reason for filtering scan results"/--> <!--filteritem type="filepath" name="projectroot/[a-zA-Z0-9]{20,}.sh" desc="Temp files"/--> </filefilter> <filefilter name="readmeOpenSourcefileNamePolicyFilter" desc="Filters for README.OpenSource file policies"> <!--filteritem type="filename" name="*.uvwxyz" desc="Describe the reason for filtering scan results"/--> <!--filteritem type="filepath" name="abcdefg/.*.uvwxyz" desc="Describe the reason for filtering scan results"/--> <!--filteritem type="filepath" name="projectroot/[a-zA-Z0-9]{20,}.sh" desc="Temp files"/--> </filefilter> <filefilter name="binaryFileTypePolicyFilter" desc="Filters for binary file policies"> <!--filteritem type="filename" name="*.uvwxyz" desc="Describe the reason for filtering scan results"/--> <!--filteritem type="filepath" name="abcdefg/.*.uvwxyz" desc="Describe the reason for filtering scan results"/--> <!--filteritem type="filepath" name="projectroot/[a-zA-Z0-9]{20,}.sh" desc="Temp files"/--> </filefilter>
</filefilterlist> <licensematcherlist> <!--licensematcher name="uvwxyz License" desc="If the scanning result is InvalidLicense, you can define matching rules here. Note that quotation marks must be escaped."> <licensetext name=" uvwxyz license textA xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx " desc=""/> <licensetext name=" uvwxyz license textB xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx " desc=""/> </licensematcher--> </licensematcherlist> </oatconfig></configuration>
复制代码
在 speexdsp 根目录下新建空白的 OAT_report.text 文件，执行命令：
Java –jar ohos_ossaudittool-1.0.jar –s src_dir –r report_file –n selfcheck
复制代码
ohos_ossaudittool-1.0.jar 工具包名，需要带实际路径
-s 指定需要检查的代码目录，src_dir 改成要检查的项目路径
-r 指定报告输出文件的路径，检查完成后可查看此文件中列出的问题，按指导文档修复
report_file
-n 检查任务的名称，任意指定，本地检查使用不上。
例如笔者执行的语句为：
sudo java -Dfile.encoding=UTF-8 -jar /home/jiajiahao/Desktop/tools_oat-master/target/ohos_ossaudittool-1.0.jar -s /home/jiajiahao/Desktop/gitee_speexdsp -r /home/jiajiahao/Desktop/gitee_speexdsp/OAT_report.text -n nameOfRepo
复制代码
扫描结果
执行完上述命令后，OAT_report.text 生成内容如下：
同时在 speexdsp 父目录下生成 log 文件夹
原生库通过 make 或者 cmake 时生成的一些配置文件。如比较通用的 config.h 配置文件，config.h 文件为原生库生成文件，原则上也不做修改，为了避免文件上仓进行代码扫码，可以将文件文件修改后缀名(config.h.in)。相关文档中需要将配置文件使用方法说明。
提供 README.OpenSource 文件
README.Opensource 的格式如下:
[ { "Name": "", ## 库名 "License": "", ## 开源协议 "License File": ", ## 开源文件，一般开源项目都会自带该文件 "Version Number": "", ## 库的版本 "Owner": "", ## 作者 "Upstream URL": "", ## 开源库的地址 "Description": "" ## 库的描述 }]
复制代码
speexdsp 的 README.OpenSource 文件如下：
[ { "Name": "speexdsp", "License": "BSD-3-Clause", "License File": "COPYING", "Version Number": "1.2.1", "Owner": "2692032597@qq.com", "Upstream URL": "https://speex.org/", "Description": "Speexdsp is a speech processing library that goes along with the Speex codec" }]
复制代码
提供库的分析文档
三方库分析文档如下：
一、确定库实现方式例如：C/C++/JS/JAVA
二.依赖分析例如：当前库依赖其他三方库，如下
1）库名1，库仓库地址
2）库名2，库仓库地址
三、license以及版权例如：一般在license文件或者COPYING中，Apache License V2.0
四、最新一次版本xx年xx月xx日，版本号xxx
五、功能点分析（罗列出该库所支持的功能）
六、代码规模（统计库代码总行数，包括.h/.hpp/.c/.cpp/.cc 等代码相关文件）
复制代码
提供功能测试文档
文档中需罗列出
提供导出的 api 接口列表
1、 导出库对外暴露的所有 api 接口的列表
2、导出库对外暴露的已测试 api 接口的列表
十、上传 speexdsp 至 OpenHarmony 仓库
配置个人信息
打开 git bash，依次输入以下命令：
git config --global user.name "xxxx" （配置用户名，xxxx为账号用户名，即个人空间地址）git config --global user.email "xxxxxx@xxx" （gitee 账号邮箱与签署DCO 的邮箱保持一致即可） git config --list （查看配置情况）git config --global credential.helper store (解决每次git pull都要输入账号信息的问题)
复制代码
克隆仓库内容到本地
到个人账号点击并进入contest仓库， fork 该仓库：
进入到 clone 界面，复制 clone 的链接地址。
执行如下语句：
git clone https://gitee.com/xxxxx/contest.git --depth=1
复制代码
利用 git lfs 机制添加特殊文件
提交三方库时候，文档中有 PDF 文件时就需要使用利用 git lfs 机制
git lfs track xxx/xxx.pdf // 声明该特殊文件到git lfs机制
复制代码
git add .gitattributes // 添加配置文件
复制代码
git add xxx/xxx.pdf // 添加具体特殊文件到暂存区中
复制代码
git lfs ls-files // 确认相关test_lfs.a 文件是否已经添加到lfs 机制中。
复制代码
git commit -s -m "add xxxxxxxx" //将暂存区内容签名并提交到本地
复制代码
-s 是签名表明这次提交者签名(signoff)
-m 是对此次提交行为进行备注.
推送本地修改到账号仓库
现在需要将本地仓库的修改内容推送到 gitee 上 fork 后的个人仓库，使用 git push 命令来完成这个动作。
进入自己的账号下面，查看这个仓库，发现已经发生了变化。从个人账号仓库下向官方仓库下提交 PR。
进入个人账号的该仓库下，点击增加 PR 即可开始提交 PR。
提交 pr 时，push 的文件超过 100 个文件，在 pr 页面只显示 100 个。
下期预告:移植 Speedsp 到 OHOS——VoIP 语音质量适配应用层机制研究综述
评论