SOD

一款嵌入式计算机视觉与机器学习库
sod.pixlab.io

• 简介。
• 特性。
• 使用SOD进行编程。
• 实用链接。

SOD Embedded

版本 1.1.9（2023年7月）| 更新日志 | 下载

SOD是一个嵌入式、现代化的跨平台计算机视觉和机器学习软件库，它提供了一组用于深度学习、高级媒体分析与处理的API，包括实时多类别目标检测以及在计算资源有限的嵌入式系统和物联网设备上进行模型训练的功能。

SOD旨在为计算机视觉应用提供通用的基础架构，并加速机器感知技术在开源及商业产品中的应用。

SOD专为计算效率而设计，特别注重实时应用。它包含一套全面的经典与最先进深度神经网络及其预训练模型。使用SOD构建：

• 卷积神经网络（CNN）用于多类别（20类和80类）目标检测与分类。
• 循环神经网络（RNN）用于文本生成（如莎士比亚、4chan、康德哲学、Python代码等）。
• 决策树用于单类别实时目标检测。
• 专为SOD设计的新架构，名为RealNets。

跨平台、无依赖、整合为单个C文件且高度优化。实际应用场景包括：

• 实时检测与识别物体（包括人脸）。
• 车牌提取。
• 入侵检测。
• 模仿Snapchat滤镜。
• 人类行为分类。
• 物体识别。
• 眼睛与瞳孔追踪。
• 面部与身体轮廓提取。
• 图像/帧分割。

SOD显著特性

• 专为真实世界和实时应用而设计。
• 最先进的CPU优化深度神经网络，包括全新的独家RealNets架构。
• 无专利的先进计算机视觉算法。
• 支持主要图像格式。
• 简洁、清晰且易于使用的API。
• 将深度学习引入到计算资源有限的嵌入式系统和物联网设备中。
• 可轻松与OpenCV或其他专有API集成。
• 大多数架构均有预训练模型可供使用。
• 支持CPU运行，可进行RealNets模型训练。
• 生产就绪、跨平台、高质量源代码。
• SOD无依赖，用C语言编写，几乎可在任何具备良好C编译器的平台和架构上无需修改直接编译并运行。
• 整合版——所有SOD源文件被合并为一个C文件（sod.c），便于部署。
• 开源、积极开发与维护的产品。
• 对开发者友好的支持渠道。

编程接口

该文档既是API参考手册，也是编程教程。它描述了库的内部结构，并指导用户仅用几行代码即可创建应用程序。需要注意的是，SOD非常容易上手，即使是初学者也能快速掌握。

资源	描述
5分钟内了解SOD	快速介绍如何使用SOD嵌入式C/C++ API进行编程，并提供用C语言实现的真实场景代码示例。
C/C++ API参考指南	本文档详细介绍了每个API函数。这是您应当依赖的参考文档。
C/C++代码示例	关于如何嵌入、加载模型并开始使用SOD进行实验的真实场景代码示例。
车牌检测	学习如何在不使用复杂机器学习技术的情况下，仅通过SOD中已实现的标准图像处理流程来检测车辆车牌。
将我们的面部检测器移植到WebAssembly	了解我们如何将SOD Realnets面部检测器移植到WebAssembly，以实现在浏览器中的实时性能。

其他实用链接

资源	描述
下载	获取SOD最新公开版本、预训练模型、扩展组件等。立即开始集成并享受编程的乐趣。
版权/许可	SOD是一款开源、双重许可的产品。在此了解更多关于许可情况的信息。
在线支持渠道	在集成SOD时遇到困难？请查看我们提供的多种支持渠道。

SOD 快速上手指南

SOD (Small Object Detector) 是一个专为嵌入式系统、IoT 设备及资源受限环境设计的现代跨平台计算机视觉与机器学习库。它无需任何外部依赖，采用纯 C 语言编写，支持实时多类物体检测、人脸追踪及模型训练。

环境准备

系统要求

• 操作系统：支持几乎所有拥有合格 C 编译器的平台（Linux, macOS, Windows, Android, iOS 等）。
• 硬件架构：x86, ARM, RISC-V 等主流架构均可运行。
• 编译器：GCC, Clang, MSVC 或任何标准的 C 编译器。

前置依赖

• 无外部依赖：SOD 设计为“零依赖”（Dependency Free），无需安装 OpenCV、TensorFlow 或其他第三方库即可编译运行。
• 可选集成：如需与现有项目结合，可轻松与 OpenCV 或其他专有 API 互操作，但非必须。

安装步骤

SOD 采用“合并源文件”（Amalgamated）方式发布，所有源代码合并为单个 sod.c 文件，极大简化了部署流程。

1. 下载源码与预训练模型 访问官方下载页面获取最新发布的 sod.c、头文件 sod.h 以及预训练模型文件。

   下载地址: https://pixlab.io/downloads

   提示：下载后你将获得 sod.c, sod.h 以及 .dat 格式的预训练模型文件（如人脸检测模型）。

2. 文件放置 将下载的 sod.c 和 sod.h 放入你的项目目录中。

3. 编译项目 由于是单文件库，只需在编译时将 sod.c 加入构建列表。以下是一个使用 GCC 的简单编译命令示例：

   gcc -o my_app main.c sod.c -lm
   

   注：-lm 用于链接数学库，通常在 Linux/Unix 环境下需要。Windows (MSVC) 用户通常无需额外参数。

基本使用

以下示例展示如何使用 SOD 加载预训练模型并进行实时人脸检测。假设你已下载名为 face.dat 的预训练模型。

代码示例 (C 语言)

#include "sod.h"
#include <stdio.h>

int main(int argc, char **argv) {
    // 1. 初始化 SOD 核心
    sod_core_t core = sod_core_new();

    // 2. 加载预训练的人脸检测模型 (RealNets 架构)
    // 请确保 'face.dat' 文件在当前目录下
    sod_realnet_t net = sod_realnet_load(core, "face.dat");

    if (!net) {
        printf("Failed to load model.\n");
        return -1;
    }

    // 3. 加载输入图像
    sod_img_t img = sod_img_load_from_file("input.jpg", 0);

    if (!img) {
        printf("Failed to load image.\n");
        return -1;
    }

    // 4. 执行检测
    // 返回检测到的对象列表
    sod_obj_list_t detections = sod_realnet_detect(net, img, 0.5f);

    // 5. 处理结果
    int count = sod_obj_list_length(detections);
    printf("Detected %d objects.\n", count);

    for (int i = 0; i < count; i++) {
        sod_obj_t obj = sod_obj_list_get(detections, i);
        sod_rect_t rect = sod_obj_get_box(obj);
        printf("Object %d: x=%d, y=%d, w=%d, h=%d\n", 
               i, rect.x, rect.y, rect.w, rect.h);
        
        // 可选：在图像上绘制边框
        sod_img_draw_rectangle(img, rect, 255, 0, 0, 2);
    }

    // 6. 保存或显示结果图像
    sod_img_save_to_file(img, "output.jpg");

    // 7. 清理资源
    sod_obj_list_free(detections);
    sod_img_free(img);
    sod_realnet_free(net);
    sod_core_free(core);

    return 0;
}

运行说明

1. 将上述代码保存为 main.c。
2. 确保 sod.c, sod.h, face.dat (模型), 和 input.jpg (测试图片) 在同一目录。
3. 编译并运行：

   gcc -o demo main.c sod.c -lm
   ./demo
   

4. 程序将输出检测到的物体坐标，并生成标记后的 output.jpg。

更多高级用法（如视频流处理、模型训练、WebAssembly 移植）请参考官方文档：SOD API Reference。