啃论文俱乐部——移植Speexdsp到OpenHarmony标准系统（五）

啃论文俱乐部——移植Speexdsp到OpenHarmony标准系统（五）

作者：离北况归 2022-09-15 15:21:22系统 OpenHarmony 将Speexdsp加入Openharmony编译体系后，能成功编译出来动态链接库和测试用的可执行文件，并不代表移植三方库成功。还要在开发板上运行测试其功能是否正常。

​​想了解更多关于开源的内容，请访问：​​

​​51CTO开源基础软件社区​​

​​https://ost.51cto.com​​

大家好！我来自南京，在OpenHarmony成长计划啃论文俱乐部，与华为、软通动力、润和软件、拓维信息、深开鸿​等公司一起，学习和研究​操作系统技术从今年1月11日加入OpenHarmony俱乐部已经有接近8个月时间了。笔者一直在思考啃论文给我带来了些什么，通过啃论文能为OpenHarmony做些什么。笔者利用大二升大三暑假两个月时间移植了Speexdsp这个三方库到OpenHarmony标准系统，而关于前面的问题我似乎找到了答案，现将啃论文和三方库移植分享经验如下：

七、Speexdsp功能分析

将speexdsp加入openharmony编译体系后，能成功编译出来动态链接库和测试用的可执行文件，并不代表移植三方库成功。还要在开发板上运行测试其功能是否正常。

speexdsp核心库分析

1、库实现方式

编程语言：C原生平台：linux

2、依赖分析

除C标准库外，无其他第三方库依赖

3、license以及版权

根据speex官网https://speex.org/的信息，speexdsp使用的开源协议为revised BSD license(revised BSD license又称为3-clause BSD License或者BSD 3-Clause License，一般使用BSD 3-Clause)。ps://speex.org/的信息，speexdsp使用的开源协议为revised BSD license(revised BSD license又称为3-clause BSD License或者BSD 3-Clause License，一般使用BSD 3-Clause)。

OpenHamorny第三方开源软件许可证类型必须是OSI明确定义的。OSI明确定义的开源许可证有：https://opensource.org/licenses/alphabetical。BSD 3-Clause License是OSI明确定义的开源许可。

如下类型许可证可以引入到OpenHarmony项目中：

Apache License 2.0Mulan Permissive Software License, Version 2BSD 2-clauseBSD 3-clauseDOM4J LicensePostgreSQL LicenseEclipse Distribution License 1.0MITISCICUUniversity of Illinois/NCSAW3C Software Licensezlib/libpngAcademic Free License 3.0Python Software Foundation LicensePython Imaging Library Software LicenseBoost Software License Version 1.0WTF Public LicenseUNICODE, INC. LICENSE AGREEMENT - DATA FILES AND SOFTWAREZope Public License 2.0

如下类型许可证不建议引入到OpenHarmony项目中：​

GNU GPL 1, 2, 3GNU Affero GPL 3GNU LGPL 2, 2.1, 3QPLSleepycat LicenseServer Side Public License (SSPL) version 1Code Project Open License (CPOL)BSD-4-Clause/BSD-4-Clause (University of California-Specific)Facebook BSD+Patents licenseNPL 1.0/NPL 1.1The Solipsistic Eclipse Public LicenseThe "Don't Be A Dick" Public LicenseJSON LicenseBinary Code License (BCL)Intel Simplified Software LicenseJSR-275 LicenseMicrosoft Limited Public LicenseAmazon Software License (ASL)Java SDK for Satori RTM licenseRedis Source Available License (RSAL)Booz Allen Public LicenseCreative Commons Non-CommercialSun Community Source License 3.0Common Development and Distribution Licenses: CDDL 1.0 and CDDL 1.1Common Public License: CPL 1.0Eclipse Public License: EPL 1.0IBM Public License: IPL 1.0Mozilla Public Licenses: MPL 1.0, MPL 1.1, and MPL 2.0Sun Public License: SPL 1.0Open Software License 3.0Erlang Public LicenseUnRAR LicenseSIL Open Font LicenseUbuntu Font License Version 1.0IPA Font License Agreement v1.0Ruby LicenseEclipse Public License 2.0: EPL 2.0

speexdsp的license以及版权内容如下：

Copyright 2002-2008 Xiph.org FoundationCopyright 2002-2008 Jean-Marc ValinCopyright 2005-2007 Analog Devices Inc.Copyright 2005-2008 Commonwealth Scientific and Industrial Research Organisation (CSIRO)Copyright 1993, 2002, 2006 David RoweCopyright 2003EpicGamesCopyright 1992-1994 Jutta Degener, Carsten BormannRedistribution and use in source and binary forms, with or withoutmodification, are permitted provided that the following conditionsare met:- Redistributions of source code must retain the above copyrightnotice, this list of conditions and the following disclaimer.- Redistributions in binary form must reproduce the above copyrightnotice, this list of conditions and the following disclaimer in thedocumentation and/or other materials provided with the distribution.- Neither the name of the Xiph.org Foundation nor the names of itscontributors may be used to endorse or promote products derived fromthis software without specific prior written permission.THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOTLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FORA PARTICULAR PURPOSE ARE DISCLAIMED.IN NO EVENT SHALL THE FOUNDATION ORCONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, ORPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OFLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDINGNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THISSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

4、最新一次版本

2022年6月16日,版本号1.2.1。

5、代码规模

linux系统提供了wc命令来统计文件的行数，统计当前目录下的所有文件行数，终端输入如下命令：

wc -l *

文件名

代码行数

arch.h

232

bfin.h

15

buffer.c

176

fftwrap.c

448

fftwrap.h

58

filterbank.c

227

filterbank.h

66

fixed_arm4.h

135

fixed_arm5e.h

160

fixed_bfin.h

141

fixed_debug.h

497

fixed_generic.h

106

jitter.c

839

kiss_fft.c

523

_kiss_fft_guts.h

160

kiss_fft.h

108

kiss_fftr.c

297

kiss_fftr.h

51

math_approx.h

332

mdf.c

1279

misc_bfin.h

56

os_support.h

169

preprocess.c

1215

pseudofloat.h

379

resample.c

1239

resample_neon.h

339

resample_sse.h

128

scal.c

293

smallft.c

1261

smallft.h

46

vorbis_psy.h

97

speex_buffer.h

68

speexdsp_config_types.h

12

speexdsp_types.h

126

speex_echo.h

170

speex_jitter.h

197

speex_preprocess.h

219

speex_resampler.h

343

总行数

12207

功能分析

可以参考speexdsp提供的文档分析功能。

预处理器

预处理器被设计为在运行编码器之前在音频上使用。预处理器提供三个主要功能：

噪声抑制自动增益控制(AGC)语音活动检测(V AD)

自适应抖动缓冲区

当通过UDP或RTP传输语音(或任何相关内容)时，包可能会丢失，以不同的延迟到达，甚至乱序。抖动缓冲区的目的是重新排序数据包，并缓冲足够长的时间，以便它们可以被发送以进行解码。

声学回声消除器

回声消除是为了提高远端质量。

在任何免提通信系统中，远端语音通过本地扬声器播放。音频在房间内传播，并被麦克风捕获。如果从麦克风捕获的音频被直接发送到远端，那么用户就会听到远端语音的回声。声学回声消除器设计用于在声学回声发送到远端之前消除它。

重采样器

这个重采样器可以用于在任意两个速率之间进行转换(比率必须是有理数)，并且可以控制质量/复杂性的权衡。

重采样器在某些情况下将音频从一个采样率转换到另一个采样率。它可以用于混合具有不同采样率的流、用于支持声卡不支持的采样率、用于转码等。

八、Speexdsp功能测试

测试逻辑

在speexdsp原生库的libspeexdsp目录下有原生的测试源文件testresample.c、testresample2.c、testecho.c、testdenoise.c、testjitter.c。

进行功能测试需要对比pc端和开发板的运行效果，因此需要在pc端编译出测试用的可执行文件（开发板上的已经编译出来了）。

重采样功能

查看源码可知，运行测试重采样率的可执行文件时，输入一份音频文件的同时需要指定处理后输出的音频文件。测试重采样功能的源文件为testresample.c和testresample2.c。

testresample.c源码分析如下：

#ifdef HAVE_CONFIG_H#include "config.h"#endif//要使用重采样器，必须包含它的头文件speex_resampler.h:#include "speex/speex_resampler.h"//基本输入输出函数的声明#include ////头文件中声明了一些数学函数和宏#include#include //NN定义的是帧长度#define NN 256int main(){ spx_uint32_t i; short *in; short *out; float *fin, *fout; int count = 0;//对于每一个被重采样的流(流是一种抽象的概念,表示一连串的数据元素;流中的数据元素称为帧Frame。)，有必要创建一个重采样状态:SpeexResamplerState *resampler;//resampler = speex_resampler_init(nb_channels, input_rate, output_rate, quality, &err);// nb_channels声道数量，这段测试程序要求输入的音频声道数量为1// input_rate和output_rate指的是输入音频的采样率和输出音频的采样率。// err错误码 SpeexResamplerState *st = speex_resampler_init(1, 8000, 12000, 10, NULL);//96000是输入音频的采样率，44100是输出音频的采样率。单位为Hz speex_resampler_set_rate(st, 96000, 44100); speex_resampler_skip_zeros(st); in = malloc(NN*sizeof(short)); out = malloc(2*NN*sizeof(short)); fin = malloc(NN*sizeof(float)); fout = malloc(2*NN*sizeof(float));//while(1):这是一个死循环，一直在while里循环.//调试代码时，为了检测一部分代码是否OK，可加测试点while(1),测试这段代码。 while (1) {spx_uint32_t in_len;spx_uint32_t out_len;fread(in, sizeof(short), NN, stdin);//feof()是检测流上的文件结束符的函数，如果文件结束，则返回非0值，否则返回0if (feof(stdin)) break;for (i=0;i可以得知：

输入音频的采样率要求为96000Hz、声道为单声道。输出音频的采样率为44100。

回声消除功能

运行测试回声消除的可执行文件时，需要输入两段音频文件，分别为一份麦克风的音频、一份speaker的音频。另外需要指定一份处理后输出的音频文件。采样率都为8000Hz测试回声消除功能的源文件为testecho.c。testecho.c源码分析如下：#ifdef HAVE_CONFIG_H#include "config.h"#endif#include "speex/speex_echo.h"#include "speex/speex_preprocess.h"#include //stdlib 头文件即standard library标准库头文件 #include // sys/types.h中文名称为基本系统 数据类型。在应用程序源文件中包含 以访问 _LP64 和 _ILP32 的定义#include //stat.h头文件，轻松获取文件属性#include //fcntl.h相关函数 open，fcntl，shutdown，unlink，fclose#include //NN是frame_size帧长度，TAIL是filter_length滤波器长度#define NN 128#define TAIL 1024 //当你需要程序带参数地启动的时候，就用int main(int argc, char *argv[])int main(int argc, char **argv) {//FILE* 指针作为文件句柄，是文件访问的唯一标识，它由fopen函数创建，fopen打开文件成功，则返回一个有效的FILE*指针，否则返回空指针NULL //[nʌl] FILE *echo_fd, *ref_fd, *e_fd; short echo_buf[NN], ref_buf[NN], e_buf[NN]; SpeexEchoState *st; SpeexPreprocessState *den;//采样率为8000.单位为hz int sampleRate = 8000; if (argc != 4) {fprintf(stderr, "testecho mic_signal.sw speaker_signal.sw output.sw\n");exit(1); }// fopen函数用于打开文件 echo_fd = fopen(argv[2], "rb"); ref_fd= fopen(argv[1],"rb"); e_fd= fopen(argv[3], "wb");/*1.创建一个回声消除状态:SpeexEchoState *echo_state = speex_echo_state_init(frame_size, filter_length);前边的语句SpeexEchoState *st;2.NN是frame_size帧长度，TAIL是filter_length滤波器长度*/· st = speex_echo_state_init(NN, TAIL); den = speex_preprocess_state_init(NN, sampleRate); speex_echo_ctl(st, SPEEX_ECHO_SET_SAMPLING_RATE, &sampleRate); speex_preprocess_ctl(den, SPEEX_PREPROCESS_SET_ECHO_STATE, st); while (!feof(ref_fd) && !feof(echo_fd)) {fread(ref_buf, sizeof(short), NN, ref_fd);fread(echo_buf, sizeof(short), NN, echo_fd);speex_echo_cancellation(st, ref_buf, echo_buf, e_buf);speex_preprocess_run(den, e_buf);fwrite(e_buf, sizeof(short), NN, e_fd); } speex_echo_state_destroy(st); //可以用以下方法消除回声抵消状态:speex_echo_state_destroy(echo_state); speex_preprocess_state_destroy(den);// fclose(FILE *fp) 一般地，fclose(fp)应与fopen配对使用，特别是含有写方式的文件，若不关闭，可能会造成文件数据丢失。 fclose(e_fd); fclose(echo_fd); fclose(ref_fd); return 0;}

预处理功能

运行测试预处理功能的可执行文件时，输入一份音频文件的同时需要指定处理后输出的音频文件。(采样率为8000Hz)测试源文件testdenoise.c测试的是预处理功能中的噪声抑制。

testdenoise.c源码分析如下：

#ifdef HAVE_CONFIG_H#include "config.h"#endif//使用预处理功能先#include "speex/speex_preprocess.h"#include "speex/speex_preprocess.h"#include //定义NN为160#define NN 160int main(){ short in[NN]; int i;/*然后，可以创建一个预处理器状态:SpeexPreprocessState *preprocess_state = speex_preprocess_state_init(frame_size,sampling_rate);preprocess_state（预处理状态）frame_size指的是帧长度sampling_rate指的是采样率*/ SpeexPreprocessState *st; int count=0; float f; st = speex_preprocess_state_init(NN, 8000); i=1; // i=1就是打开预处理器的降噪功能；i=2就是关闭降噪功能 speex_preprocess_ctl(st, SPEEX_PREPROCESS_SET_DENOISE, &i); i=0; //speex_preprocess_ctl(st, SPEEX_PREPROCESS_SET_AGC, &i); i=8000; speex_preprocess_ctl(st, SPEEX_PREPROCESS_SET_AGC_LEVEL, &i);//reverberation removal混响消除 i=0; speex_preprocess_ctl(st, SPEEX_PREPROCESS_SET_DEREVERB, &i); f=.0; speex_preprocess_ctl(st, SPEEX_PREPROCESS_SET_DEREVERB_DECAY, &f); f=.0; speex_preprocess_ctl(st, SPEEX_PREPROCESS_SET_DEREVERB_LEVEL, &f); while (1) {int vad;/*C 库函数 size_t fread(void *ptr, size_t size, size_t nmemb, FILE *stream) 从给定流 stream 读取数据到 ptr 所指向的数组中。*/fread(in, sizeof(short), NN, stdin);if (feof(stdin)) break;//fwrite和fread是以记录为单位的I/O函数，fread和fwrite函数一般用于二进制文件的输入输出。vad = speex_preprocess_run(st, in);fwrite(in, sizeof(short), NN, stdout);count++; }//预处理器状态可以通过以下方式销毁:speex_preprocess_state_destroy(preprocess_state); speex_preprocess_state_destroy(st); return 0;}

抖动缓冲功能

当通过UDP或RTP传输语音(或任何相关内容)时，包可能会丢失，以不同的延迟到达，甚至乱序。

1.抖动缓冲区的目的是重新排序数据包，并缓冲足够长的时间，以便它们可以被发送以进行解码。

2.测试源文件testjitter.c，这个去抖动测试需要接收来自udp/rtp的网络语音数据，原生测试程序没有做到真正意义上的测试，从程序上看是告诉用户如何使用接口。

testjitter.c源码分析：

#ifdef HAVE_CONFIG_H#include "config.h"#endif#include "speex/speex_jitter.h"#include union jbpdata {unsigned int idx; //unsigned int是整数类型 ，存储大小为2 或 4 字节，值范围为0 到 65,535 或 0 到 4,294,967,295//unsigned char的表示范围为0~255 此处定义了一个拥有四个元素的数组unsigned char data[4];};void synthIn(JitterBufferPacket *in, int idx, int span) {union jbpdata d;d.idx = idx;in->data = d.data;in->len = sizeof(d);in->timestamp = idx * 10;in->span = span * 10;in->sequence = idx;in->user_data = 0;}void jitterFill(JitterBuffer *jb) { char buffer[65536]; JitterBufferPacket in, out; int i; out.data = buffer; jitter_buffer_reset(jb); for(i=0;i<100;++i) { synthIn(&in, i, 1); jitter_buffer_put(jb, &in); out.len = 65536; //如果从不同的线程调用jitter_buffer_put()和jitter_buffer_get()，那么需要使用互斥锁来保护jitter缓冲区状态。 if (jitter_buffer_get(jb, &out, 10, NULL) != JITTER_BUFFER_OK) { printf("Fill test failed iteration %d\n", i); } if (out.timestamp != i * 10) { printf("Fill test expected %d got %d\n", i*10, out.timestamp); } jitter_buffer_tick(jb); }}int main(){ char buffer[65536]; JitterBufferPacket in, out; int i; /* 新的抖动缓冲状态可以通过以下方式初始化:JitterBuffer *state = jitter_buffer_init(step); step参数是用于调整延迟的默认时间步长还有做隐藏，step参数的值总是为1，也可以是更高的值。 */ JitterBuffer *jb = jitter_buffer_init(10); out.data = buffer; jitterFill(jb); for(i=0;i<100;++i) { out.len = 65536; jitter_buffer_get(jb, &out, 10, NULL); jitter_buffer_tick(jb); } synthIn(&in, 100, 1); jitter_buffer_put(jb, &in); out.len = 65536; if (jitter_buffer_get(jb, &out, 10, NULL) != JITTER_BUFFER_OK) { printf("Failed frozen sender resynchronize\n"); } else { printf("Frozen sender: Jitter %d\n", out.timestamp - 100*10); } return 0;}

测试步骤

编译pc端上的测试用的可执行程序

编译pc端的可执行程序:

gcc testdenoise.c -L /home/jiajiahao/Desktop/speexdsp-SpeexDSP-1.2.1/build/lib -o testdenoise -I /home/jiajiahao/Desktop/speexdsp-SpeexDSP-1.2.1/include -lm -lspeexdsp

其中：

gcc后面是测试用的源文件。-L 后指定so库所在的文件夹。-l+so库的名字（除去lib和后缀）。-o 后面是可执行文件的名字。-l 后面是测试用的源文件要用到的头文件的路径。

将编译生成的库以及测试用的可执行文件推送到开发板上

hdc工具的使用 请参考用​​hdc工具在OpenHarmony3.2 上安装应用​​中的相关内容。

1.通过与ohos版本匹配的hdc_std工具,将编译生成的库以及测试用的可执行文件推送到开发板上。

hdc_std shell mount -o remount,rw / ## 重新加载系统为可读写mkdir speexdsp## 创建speexdsp目录存放测试用例exit## 退出开发板系统

2.将压缩包push到开发板。

hdc_std file speexdsp.tar /speexdsp

3.解压压缩包并将库文件拷贝到对应的目录

本次移植是基于openharmony标准系统3.2Beta1版本，是arm64位系统。

hdc_std shell## 进入开发板系统cd speexdsptar -xvf speexdsp.tarcp libspeexdsp_share.z.so /system/lib64/ ## 将库文件拷贝系统目录

执行测试程序、分析测试结果

分析测试结果需要使用到的音频处理软件是ocenaudio,下载地址：https://www.ocenaudio.com/en/。

①执行testresample可执行文件。

通过分析testresample.c源码可知：执行测试程序时输入一份采样率为96000Hz并且为单声道的音频时，经过重采样输出的音频采样率为44100Hz。

在pc端运行：

输入的音频为input.pcm,把它拷贝到testresample同目录下，并且新建空白文档命名为output.pcm。

打开终端执行如下命令：

chmod 777 testresample./testresample < input.pcm >output.pcm

使用<符号指定输入文件，>符号指定输出文件。

输出的output.pcm采样率变为44100Hz，音频的波形图和声谱图如下：

在rk3568上运行：

这里测试testresample时，将一份与pc端同样的input.pcm和output.pcm拷贝至开发板speexdsp目录。

在开发板speexdsp目录执行语句如下：

chmod 777 testresample## 添加可执行权限./testresample < input.pcm >output.pcm

将开发板输出的output.pcm拷贝至pc端。

hdc_std file recv /speexdsp/output.pcm C:\Users\jjh\Desktop\

测试结果：经过重采样，pc端和rk3568开发板输出的output.pcm音频采样率都为44100Hz，两者运行测试程序testresample结果一致。

②执行testresample2可执行文件。

通过分析testresample2.c源码可知，执行测试程序时需要指定一份空白的单声道音频文件output.pcm。

测试testresample2时，需要把空白的单声道音频文件output.pcm拷贝至开发板speexdsp目录。

pc端运行：

执行语句如下：

./testresample2 >output.pcm

输出结果如下：

终端打印信息：

输出音频output.pcm波形图和声谱图如下：

rk3568开发板上运行：

执行语句如下：

./testresample2 >output.pcm

测试结果：输出一份不为空的output.pcm音频文件，并且在终端输出文本如下：

1000 0 1024 22 -> 1024 01100 0 1024 24 -> 1024 151200 0 1024 26 -> 926 261300 926 1122 31 -> 1048 311400 950 1098 33 -> 1032 33.........127600 1024 1024 2723 -> 1024 2723......127900 1024 1024 2729 -> 1024 2729128000 1024 1024 2731 -> 1024 2730

以最后一行"128000 1024 1024 2731 -> 1024 2730“”为例,其中128000为采样率（Hz）;1024为一个编码单元采样点数（帧）;1024为输入音频理论帧长;2731为输出音频理论帧长。"->"符号后的1024为经过重采样处理输入音频实际帧长，2730为输出音频实际帧长。

pc端和rk3568开发板运行testresample2可执行程序效果一致。

③执行testecho可执行文件。

测试testecho时，需要输入两份音频文件，同时需要指定一份输出的音频文件。

输入的两份音频一份为speaker.wav（麦克风收录的说话人语音信号+在房间多径反射的语音），另一份为micin.wav(麦克风收录的房间多径反射的语音)。

speaker.wav正常房间环境下收录说话人说话声音即可，mic2.pcm在正常环境收录时说话人不说话即可。同时需要指定一份testecho_output.wav输出文件。

执行语句如下：

./testecho speaker.wav micin.wav testecho_output.wav

测试结果：对比输入的speaker.wav和输出testecho_output.wav的波形图和声谱图，回声已经被消除。pc端和rk3568开发板运行testecho可执行程序效果一致。

④执行testdenoise可执行文件。

通过分析testdenoise.c源码，执行测试程序时需要指定一份输入的不为空的8000Hz的input.pcm音频，并且需要指定一份空的输出的output.pcm音频。

rk3568上运行：

执行语句如下：

./testdenoise< input.pcm >output.pcm

测试结果：对比输入的input.pcm和输出的outpu.pcm的波形图和声谱图，噪声已经被消除。pc端和rk3568开发板运行testdenoise可执行程序效果一致。

⑤执行testjitter可执行文件。

通过分析testjitter.c源码，测试需要接收来自udp/rtp的网络语音数据，原生测试程序没有做到真正意义上的测试，从程序上看是告诉用户如何使用接口。

执行语句如下：

./testjitter

测试结果：终端打印出语句。

Frozen sender: Jitter 0

pc端和rk3568开发板运行testjitter可执行程序效果一致。

​​想了解更多关于开源的内容，请访问：​​

​​51CTO开源基础软件社区​​

​​https://ost.51cto.com​​。

责任编辑：jianghua 来源：51CTO开源基础软件社区​​ 操作系统鸿蒙