C++的深度相机SDK按功能封装成dll并由Python程序调用

操作系统：Windows 10
IDE：Visual Studio 2017(community)
SDK语言：C++
应用程序语言：Python
相机类型：深度相机

1. 应用背景

在进行工业相机视觉开发时，往往会根据官方提供的SDK样例进行自己工程方案的部署。若SDK采用C++编写，工程应用采用Python编写，则需要将C++封装成dll供Python调用。然而，在实际应用中，并不是简单地将SDK的demo封装完成就可以，往往需要将代码按照功能来封装。
本文以封装一款深度相机的SDK为例，简单介绍一下SDK封装成dll和Python程序调用的过程及一些注意事项。封装SDK代码能够快速实现代码在其他语言程序的应用，使Python开发者也能够很好地利用C++代码。

2. SDK举例

此款相机提供的SDK如下。

sample下代码文件夹如下，红框标记文件夹下的main.cpp就是需要封装的程序。

main.cpp主要代码如下（有删减）：

#include "../common/common.hpp"

void eventCallback(TY_EVENT_INFO *event_info, void *userdata)
{
    <<<<<<<<<省略代码
}

int main(int argc, char* argv[])
{
    std::string ID, IP;
    TY_INTERFACE_HANDLE hIface = NULL;
    TY_ISP_HANDLE hColorIspHandle = NULL;
    TY_DEV_HANDLE hDevice = NULL;
    <<<<<<<<<省略代码
    LOGD("Init lib");
    ASSERT_OK( TYInitLib() );
    <<<<<<<<<省略代码
    LOGD("Start capture");
    ASSERT_OK( TYStartCapture(hDevice) );
    LOGD("While loop to fetch frame");
    bool exit_main = false;
    TY_FRAME_DATA frame;
    int index = 0;
    while(!exit_main) {
         <<<<<<<<<省略代码
            }
        <<<<<<<<<省略代码
        }
    }
    ASSERT_OK( TYStopCapture(hDevice) );
    ASSERT_OK( TYCloseDevice(hDevice) );
    ASSERT_OK( TYCloseInterface(hIface) );
    ASSERT_OK(TYISPRelease(&hColorIspHandle));
    ASSERT_OK( TYDeinitLib() );
    delete frameBuffer[0];
    delete frameBuffer[1];

    LOGD("Main done!");
    return 0;
}

此代码需要配置OpenCV，需要添加一个tycam.dll，这是编译成功必须的组件。OpenCV可参考其他博客来配置，添加的dll可到SDK中查找。

3. C++封装成dll

封装前需要根据应用场景，合理规划封装函数个数，即将main.cpp“拆分”成几个函数来封装。

3.1 将C++代码“拆分”

将main.cpp封装成具有相机初始化（init）、拍照（shootimg）、停止（uninit）等三个功能，下图中1、2、3分别是这三个功能模块的代码。
上面代码可大致按照下图“拆分”，或者应用其他“拆分”方案。

3.2 整理代码

这里面临几个问题：
1.上图红框1内前几句代码为设置参数，可能在其他代码段也会复用，需要将其改为全局量；
2.上图红框2内为while循环拍照，实际只需要拍照的功能，所以这里并不需要while循环；
3.上图红框3内“delete”操作可能不必要或者会造成代码错误，可考虑删除。
以上举例介绍了代码的修改，具体需要根据实际应用来修改代码。

3.3 封装设置

对修改好的代码进行封装设置，即加入“extern “C” _declspec(dllexport)”标记符对要封装函数进行标记，如下图。

#include "../common/common.hpp"

void eventCallback(TY_EVENT_INFO *event_info, void *userdata)
{
    <<<<<<<<<省略代码
}

extern "C" _declspec(dllexport) int init(int argc, char* argv[])
{
    <<<<<<<<<代码段1
}

extern "C" _declspec(dllexport) int shootimg(int argc, char* argv[])
{
    <<<<<<<<<代码段2
}

extern "C" _declspec(dllexport) int uninit(int argc, char* argv[])
{
    <<<<<<<<<代码段3
}

上图中，只有需要标记的代码段需要添加封装标记符，其他不需要添加。

3.4 VS2017编译设置

配置好VS2017环境、配置应用库（如OpenCV）、添加组件（如dll）、进行相关设置，然后就可以进行VS2017编译了。需要注意的是更改一下文件输出格式，特别注意一下红色圆圈内的设置，Release或者Debug、x64或者x86。

然后，便可“调试”生成dll，默认情况下，dll名字为main.cpp所在的文件夹名。

4. Python调用dll

将生成的dll及原main.cpp关联的dll拷贝到Python工程目录下，通过ctypes模块来调用dll。
以下提供了一个类命名的dll调用demo。用类再次封装主要是为了方便操作，也可以按照所需单独调取相应函数。

import ctypes

class TyCam():

    def __init__(self):
        self.TYDll = ctypes.cdll.LoadLibrary('./SimpleView_FetchFrame.dll')

    def Init(self):
        self.TYDll.init()

    def UnInit(self):
        self.TYDll.uninit()

    def ShootImg(self):
        self.TYDll.shootimg()

if __name__ == '__main__':
    #调用dll
    Ty = TyCam()
    #初始化
    Ty.Init()
    while 1:
        #拍照
        Ty.ShootImg()
        if <条件>:
            #停止拍照
            Ty.UnInit()
            break

5. 其他问题

1.若出现ctypes模块问题，大部分是无法加载dll，则只需要将相关的dll放置到Python.exe所在的文件夹下便可。
2.dll生成过程中出现“dll不是可执行的文件”，不需要管，因为只是导出dll，并不需要运行，此时已完成了dll生成。
3.若出现“OSError:exception:access violation reading 0xFFFFFFFFFF”错误，请参考此文修改修饰符为“extern “C” __stdcall”。