简介

Simd Library是一个免费开源的图像处理和机器学习库，专为C和C++程序员设计。它提供了许多有用的高性能图像处理算法，如：像素格式转换、图像缩放和滤波、提取图像统计信息、运动检测、物体检测和分类、神经网络等。

这些算法通过使用不同的SIMD CPU扩展进行了优化。具体来说，该库支持以下CPU扩展：x86/x64的SSE、AVX、AVX-512和AMX，ARM的NEON。

Simd Library提供C语言API，同时还包含有用的C++类和函数，以便于访问C API。该库支持动态和静态链接，32位和64位Windows和Linux，MSVS、G++和Clang编译器，以及MSVS项目和CMake构建系统。

库文件夹结构

Simd Library具有以下文件夹结构：

simd/src/Simd/ - 包含库的源代码。
simd/src/Test/ - 包含库的测试框架。
simd/src/Use/ - 包含库的使用示例。
simd/py/SimdPy/ - 包含库的Python封装。
simd/prj/vs2015/ - 包含Microsoft Visual Studio 2015的项目文件。
simd/prj/vs2017/ - 包含Microsoft Visual Studio 2017的项目文件。
simd/prj/vs2019/ - 包含Microsoft Visual Studio 2019的项目文件。
simd/prj/vs2022/ - 包含Microsoft Visual Studio 2022的项目文件。
simd/prj/cmd/ - 包含在Windows中构建库所需的额外脚本。
simd/prj/cmake/ - 包含CMake构建系统的文件。
simd/prj/sh/ - 包含在Linux中构建库所需的额外脚本。
simd/prj/txt/ - 包含构建库所需的文本文件。
simd/data/cascade/ - 包含OpenCV级联（HAAR和LBP）。
simd/data/image/ - 包含图像样本。
simd/data/network/ - 包含训练好的网络示例。
simd/docs/ - 包含库的文档。

在Windows上构建库

要为Windows 32/64构建库和测试应用程序，你需要使用Microsoft Visual Studio 2022（或2015/2017/2019）。项目文件位于以下目录：

simd/prj/vs2022/

默认情况下，库被构建为DLL（动态链接库）。你也可以将其构建为静态库。要做到这一点，你必须更改Simd项目的相应属性（配置类型），并在以下文件中取消注释#define SIMD_STATIC：

simd/src/Simd/SimdConfig.h

此外，你也可以使用CMake和MinGW来构建库：

mkdir build
cd build
cmake ..\prj\cmake -DSIMD_TOOLCHAIN="your_toolchain\bin\g++" -DSIMD_TARGET="x86_64" -DCMAKE_BUILD_TYPE="Release" -G "MinGW Makefiles"
mingw32-make

在Linux上构建库

要为Linux 32/64构建库和测试应用程序，你需要使用CMake构建系统。CMake构建系统的文件位于以下目录：

simd/prj/cmake/

该库可以使用G++或Clang编译器为x86/x64、ARM（32/64）平台构建。使用当前平台的本机编译器（g++）很简单：

mkdir build
cd build
cmake ../prj/cmake -DSIMD_TOOLCHAIN="" -DSIMD_TARGET=""
make

要为ARM（32/64）平台构建库，你也可以使用交叉编译工具链。以下是ARM（32位）的使用示例：

mkdir build
cd build
cmake ../prj/cmake -DSIMD_TOOLCHAIN="/your_toolchain/usr/bin/arm-linux-gnueabihf-g++" -DSIMD_TARGET="arm" -DCMAKE_BUILD_TYPE="Release"
make

ARM（64位）的示例：

mkdir build
cd build
cmake ../prj/cmake -DSIMD_TOOLCHAIN="/your_toolchain/usr/bin/aarch64-linux-gnu-g++" -DSIMD_TARGET="aarch64" -DCMAKE_BUILD_TYPE="Release"
make

构建完成后，库和测试应用程序将生成在当前目录中。

还有一些额外的构建参数：

SIMD_AVX512 - 启用AVX-512（AVX-512F、AVX-512CD、AVX-512VL、AVX-512DQ、AVX-512BW）CPU扩展。默认开启。
SIMD_AVX512VNNI - 启用AVX-512-VNNI CPU扩展。默认开启。
SIMD_AMXBF16 - 启用AMX-BF16、AMX-INT8和AVX-512-BF16 CPU扩展。默认关闭。
SIMD_TEST - 构建测试框架。默认开启。
SIMD_INFO - 打印构建信息。默认开启。
SIMD_PERF - 启用内部性能统计。默认关闭。
SIMD_SHARED - 构建为共享库。默认关闭。
SIMD_GET_VERSION - 调用脚本获取Simd Library版本。默认开启。
SIMD_SYNET - 启用Synet框架的优化。默认开启。
SIMD_INT8_DEBUG - 为Synet框架启用INT8调试功能。默认关闭。
SIMD_HIDE - 隐藏Simd Library的内部函数。默认关闭。
SIMD_RUNTIME - 启用运行时更快的算法选择。默认开启。
SIMD_TEST_FLAGS - 构建测试框架的额外编译器标志。
SIMD_OPENCV - 在测试框架中使用OpenCV。默认关闭。
SIMD_INSTALL - 启用安装目标。默认开启。
SIMD_UNINSTALL - 启用卸载目标。默认开启。
SIMD_PYTHON - 启用Simd Python封装。默认开启。

使用库

如果你在C代码中使用该库，你必须包含：

#include "Simd/SimdLib.h"

如果在C++代码中使用该库，你必须包含：

#include "Simd/SimdLib.hpp"

为了使用Simd::Detection，你必须包含：

#include "Simd/SimdDetection.hpp"

为了使用Simd::Neural，你必须包含：

#include "Simd/SimdNeural.hpp"

为了使用Simd::Motion，你必须包含：

#include "Simd/SimdMotion.hpp"

包管理器

你可以使用vcpkg依赖管理器下载和安装simd：

git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg
./bootstrap-vcpkg.sh
./vcpkg integrate install
./vcpkg install simd

vcpkg中的simd端口由Microsoft团队成员和社区贡献者保持更新。如果版本过时，请在vcpkg仓库上创建一个问题或拉取请求。

与OpenCV的交互

如果你需要在Simd和OpenCV类型之间进行相互转换，只需在包含Simd头文件之前定义宏SIMD_OPENCV_ENABLE：

#include <opencv2/core/core.hpp>
#define SIMD_OPENCV_ENABLE
#include "Simd/SimdLib.hpp"

你可以转换以下类型：

cv::Point, cv::Size <--> Simd::Point
cv::Rect <--> Simd::Rectangle
cv::Mat <--> Simd::View

测试框架

测试套件用于测试库的正确性和性能。库API中的每个函数都有一组测试。以下是测试应用程序使用的示例：

./Test -m=a -tt=1 -f=Sobel -ot=log.txt

使用了以下参数：

-m=a - 自动检查模式，包括性能测试（仅适用于Release模式下构建的库）。在这种情况下，每个函数的不同实现将相互比较（例如，标量实现和使用不同SIMD指令如SSE2、AVX2等的实现）。也可以是 -m=s（运行特殊测试）。
-tt=1 - 测试线程数。使用-1设置最大并行化。
-fi=Sobel - 包含过滤器。在当前情况下，只会测试名称中包含"Sobel"的函数。如果省略此参数，将执行完整测试。你可以使用多个过滤器 - 函数名称需要满足其中至少一个。
-ot=log.txt - 测试报告文件名（TEXT文件格式）。测试报告也会输出到控制台。

你还可以使用以下参数：

-help 或 -? 打印帮助信息。
-r=../.. 设置项目根目录。
-pa=1 打印对齐统计信息。
-pi=1 打印内部统计信息（Cmake参数SIMD_PERF必须为ON）。
-c=512 性能测试中测试图像的通道数。
-h=1080 性能测试中测试图像的高度。
-w=1920 性能测试中测试图像的宽度。
-oh=log.html - 测试报告文件名（HTML文件格式）。
-s=sample.avi 视频源（参见Simd::Motion测试）。
-o=output.avi 带注释的视频输出（参见Simd::Motion测试）。
-wt=1 用于并行化算法的线程数。使用-1设置最大并行化。
-fe=Abs 排除过滤器，用于排除某些测试。
-mt=100 最小测试执行时间（毫秒）。
-lc=1 在测试运行之间污染CPU缓存。
-ri=city.jpg 某些测试中使用的真实图像名称。图像必须放在./data/image目录中。
-tr=2 测试执行重复次数。
-ts=1 打印测试执行时间统计信息。
-cc=1 检查c++ API。
-de=2 禁用测试的SIMD扩展标志。基本 - 1，2 - SSE4.1/NEON，4 - AVX2，8 - AVX-512BW，16 - AVX-512VNNI，32 - AMX-BF16。
-wu=100 测试前预热CPU的时间（毫秒）。