c#利用SWIG调用c++dll学习总结【转】

开发环境:

操作系统:windows 7
IDE:Microsoft Visual Studio Professional 2015
SWIG: 3.0.12

swig的介绍

详细介绍可看官网,一下贴出官网上的原话:

SWIG is a software development tool that connects programs written in C and C++ with a variety of high-level programming languages. SWIG is used with different types of target languages including common scripting languages such as Javascript, Perl, PHP, Python, Tcl and Ruby. The list of supported languages also includes non-scripting languages such as C#, Common Lisp (CLISP, Allegro CL, CFFI, UFFI), D, Go language, Java including Android, Lua, Modula-3, OCAML, Octave, Scilab and R. Also several interpreted and compiled Scheme implementations (Guile, MzScheme/Racket, Chicken) are supported. SWIG is most commonly used to create high-level interpreted or compiled programming environments, user interfaces, and as a tool for testing and prototyping C/C++ software. SWIG is typically used to parse C/C++ interfaces and generate the ‘glue code’ required for the above target languages to call into the C/C++ code. SWIG can also export its parse tree in the form of XML and Lisp s-expressions. SWIG is free software and the code that SWIG generates is compatible with both commercial and non-commercial projects.

以下是我的理解(注:以下这段话并不是上段话的翻译):
Swig主要是为了将c++/c中的代码所实现的功能移植到别的语言上。一般我们要将c++/c移植到别的语言上,基本操作是将c++中的实现代码转变成dll,然后再供别的语言调用,这样安全性高,且易于调用。但是因为各种语言不相同,如果不借助swig,自己去封装。在调用dll时就会有很多类型(包括基本类型,结构体和类)转换需要注意,比如c#调c++ dll,可能得自己造一个相对应与c++的结构体和类才能成功调用。但是如果我们用了swig,这些我们都不用考虑,我们只需要考虑swig给我们的接口类型是什么,然后我们只要按照swig给的接口类型传入参数,就OK了。说白了就是swig代替了我们利用c#去重新定义dll中所需要传入的参数类型(如结构体或类)这个工作。

swig实现步骤

swig的安装:

进入如下网址:http://www.swig.org/download.html
由于我是windows系统,所以安装如下版本:
这里写图片描述
下载后,将其解压至制定目录,如:D:SDKswigwin-3.0.12

1、建立如下c++项目(应用程序类型选择dll类型)和c#项目,还没实现代码,都是空项目。主要有.h .cpp .idl .cs文件(具体这四个文件怎么创建我就不赘述了,想必能找到这篇博文就说明已具备了创建此文件的能力)。
这里写图片描述

2、填写代码:
(1) c++_file.idl:
(网上说的都是.i文件,其实就是vs里的.idl文件)

%module cppdll
%{
    /* 在包装代码中包含头文件 */
    #include "c++_file.h"  
%}
/* 解析头文件生成包装代码 */
%include "c++_file.h"

(2) c++_file.cpp

#include "c++_file.h"  
int CPlusPlusClass::Add(int a, int b)
{
    return a + b;
} 

(3)c++_file.h

#pragma once
class CPlusPlusClass
{
public:
    // 测试对C++模块中定义的Class的调用  
    int Add(int a, int b);
};

(4)Program.cs

CPlusPlusClass fromCPlusPlus = new CPlusPlusClass();
Console.WriteLine("1+2=" + fromCPlusPlus.Add(1,2));
Console.ReadKey();

3、build .idl接口文件。在.cpp所在目录下用命令框输入
D:SDKswigwin-3.0.12swig.exe -csharp -c++ c++_file.idl
回车后会发现当前文件夹中出现以下几个文件:
这里写图片描述

4、分别在c++项目和c#项目中引用各自需要的文件,引用完后,应该和如下图一样。
这里写图片描述

5、在生成dll之前,先将.idl文件的属性改为如下图所示:
这里写图片描述

6、生成c++ dll:重新生成 c++项目即可,在debug文件夹中会发现有一个c++_project.dll文件,说明生成成功。
7、运行c#项目,将c#项目设为启动项。将c++_project.dll该名为.idl文件中的module名(cppdll.dll),并放入bin/debug/中.如下图所示:
这里写图片描述

8、然后直接运行可得如下结果:
这里写图片描述

swig需要注意的几点:

  • 装swig时需注意:windows安装swigwin版本的,否则会找不到swig命令。
  • “cppPINVOKE”的类型初始值设定项引发异常。原因:未找到所要调用的dll文件,需要手动将dll文件名改为module名。
  • 报错:“cppPINVOKE”的类型初始值设定项引发异常。解决方案:生成dll的工程平台要与c#的活动解决方案平台保持一致,否则就会报此错误。(注:有的时候vs上面显示的并不是你真正的所在平台,你必须在属性页面查看,尤其是csharp项目平台)
  • 报错‘possibly a missing semicolon’,原因:可能由于.h文本里面嵌套着.h文本。解决方案:https://stackoverflow.com/questions/28523496/syntax-error-when-include-opencv-core-hpp-in-swig
  • Error: Syntax error in inputs(3)。解决方案:在.idl文件中还得include本身.h文件里包含的那些.h文件。
  • Syntax error in inputs(3),在引别的.h文件时把__declspec(dllexport)前缀给去了。
  • C++中添加库目录,调用的不一定是库目录里的dll,但是放在工程项目中的release下的dll,一定能被调用。
  • 如果生成dll时调用了别的dll的时候记得把dll一起拷到bin目录下。

难点。

Intptr参数的转换:
Intptr是c#中的句柄,有点类似于c++指针,但又不是一个东西,指针指向的是一个地址,但是Intptr只是某个资源的编号。
这个也是最不可控的一点,我在这上面花费了很大的精力。我准备是利用swig将c++实现的人脸识别代码用c#来调用,因为c#做壳子挺方便的。但是我通过swig调用的时候,他传入的图像参数类型是intptr的,但是我是bitmap类型的。然后我遇到了一下棘手的问题:

  • 我用GetHbitmap()函数将bitmap变为intptr类型,但发现c++不可访问,
    最后我把bitmap先转为byte[]类型,然后再转成inptr类型就成功了。

最后我也把我解决这个问题的代码贴出来吧:
(1)BitmapExtensions.cs:

internal static class BitmapExtensions
    {
        /// <summary>
        /// 将图像转换为RGB图像
        /// </summary>
        /// <param name="self"></param>
        /// <returns></returns>
        public static Bitmap ConvertToRgb24(this Bitmap self)
        {
            if (self.PixelFormat != PixelFormat.Format24bppRgb)
            {
                var convertImage = new Bitmap(self.Width, self.Height, PixelFormat.Format24bppRgb);
                using (var g = Graphics.FromImage(self))
                {
                    g.DrawImage(self, 0, 0);
                }

                return convertImage;
            }
            return self;
        }

        /// <summary>
        /// 获取位图数据的像素数据
        /// </summary>
        /// <param name="self"></param>
        /// <param name="useNativePixelFormat"></param>
        /// <param name="pixelSize"></param>
        /// <returns></returns>
        public static byte[] GetBitmapData(this Bitmap self, out int pixelSize, bool useNativePixelFormat = false)
        {
            var rect = new Rectangle(0, 0, self.Width, self.Height);
            var bmpData = self.LockBits(rect, ImageLockMode.ReadOnly,
                useNativePixelFormat ? self.PixelFormat : PixelFormat.Format24bppRgb);
            var dataPtr = bmpData.Scan0;
            var bytesCount = Math.Abs(bmpData.Stride) * self.Height;

            var data = new byte[bytesCount];
            Marshal.Copy(dataPtr, data, 0, bytesCount);

            self.UnlockBits(bmpData);

            pixelSize = bmpData.Stride / bmpData.Width;

            return data;
        }
    }

外部实现代码:

Bitmap gray = new Bitmap(image.Width, image.Height, PixelFormat.Format8bppIndexed);
gray = new Grayscale(0.2125, 0.7154, 0.0721).Apply(image);
int pixelSize;
var imageData = BitmapExtensions.GetBitmapData(gray,out pixelSize,true);
var pImageData = Marshal.AllocHGlobal(imageData.Length); //未释放
Marshal.Copy(imageData, 0, pImageData, imageData.Length);

待参考网址:

http://www.swig.org/ (官网)
http://blog.csdn.net/lee353086/article/details/40707305 (建立一个示例)
http://www.technical-recipes.com/2013/getting-started-with-swig-interfacing-between-c-and-c-visual-studio-projects/ (建立一个示例)
http://www.swig.org/Doc1.3/CSharp.html#csharp_directors_example (讲解swig与c#)

良心教程(建议英语好的可以看这个教程,官网教程太含糊了):
http://www.jenkinssoftware.com/raknet/manual/swigtutorial.html

https://blog.csdn.net/liu14lang/article/details/78882539

原文地址:https://www.cnblogs.com/mazhenyu/p/9138664.html