Написание привязок Python для кода C ++, использующего OpenCV

Я решил проблему, поэтому решил поделиться ею с другими, у кого может быть такая же проблема.

По сути, чтобы избавиться от ошибки сегментации, мне нужно вызвать функцию import_array () numpy.

Представление «высокого уровня» для запуска кода C ++ из python выглядит так:

Предположим, у вас есть функция foo(arg) в python это связывание для некоторой функции C ++. Когда вы звоните foo(myObj), должен быть какой-то код для преобразования объекта python «myObj» в форму, на которую может действовать ваш код C ++. Этот код обычно полуавтоматически создается с использованием таких инструментов, как SWIG или Boost :: Python. (Я использую Boost :: Python в примерах ниже.)

Сейчас, foo(arg) это привязка Python для некоторой функции C ++. Эта функция C ++ получит общий PyObject указатель в качестве аргумента. Вам понадобится код C ++ для преобразования этого PyObject указатель на «эквивалентный» объект C ++. В моем случае мой код на python передает массив пустых символов OpenCV для изображения OpenCV в качестве аргумента функции. «Эквивалентная» форма в C ++ — это объект OpenCV C ++ Mat. OpenCV предоставляет некоторый код в cv2.cpp (воспроизводится ниже) для преобразования PyObject указатель (представляющий массив NumPy) на C ++ Mat. Для более простых типов данных, таких как int и string, пользователю не нужно писать эти функции преобразования, поскольку они автоматически преобразуются с помощью Boost :: Python.

После PyObject указатель преобразуется в подходящую форму C ++, на него может воздействовать код C ++. Когда данные должны быть возвращены из C ++ в python, возникает аналогичная ситуация, когда код C ++ необходим для преобразования представления данных в C ++ в некоторую форму PyObject, Boost :: Python позаботится обо всем остальном при конвертации PyObject в соответствующую форму питона. когда foo(arg) возвращает результат в python, он находится в форме, используемой python. Вот и все.

В приведенном ниже коде показано, как обернуть класс C ++ «ABC» и представить его метод «doSomething», который принимает в Python массивный массив (для изображения), преобразовать его в C ++ Mat в OpenCV, выполнить некоторую обработку, преобразовать результат в PyObject. * и верните его интерпретатору python. Вы можете выставить столько функций / методов, сколько пожелаете (см. Комментарии в коде ниже).

abc.hpp:

#ifndef ABC_HPP
#define ABC_HPP

#include <Python.h>
#include <string>

class ABC
{
// Other declarations
ABC();
ABC(const std::string& someConfigFile);
virtual ~ABC();
PyObject* doSomething(PyObject* image); // We want our python code to be able to call this function to do some processing using OpenCV and return the result.
// Other declarations
};

#endif

abc.cpp:

#include "abc.hpp"#include "my_cpp_library.h" // This is what we want to make available in python. It uses OpenCV to perform some processing.

#include "numpy/ndarrayobject.h"#include "opencv2/core/core.hpp"
// The following conversion functions are taken from OpenCV's cv2.cpp file inside modules/python/src2 folder.
static PyObject* opencv_error = 0;

static int failmsg(const char *fmt, ...)
{
char str[1000];

va_list ap;
va_start(ap, fmt);
vsnprintf(str, sizeof(str), fmt, ap);
va_end(ap);

PyErr_SetString(PyExc_TypeError, str);
return 0;
}

class PyAllowThreads
{
public:
PyAllowThreads() : _state(PyEval_SaveThread()) {}
~PyAllowThreads()
{
PyEval_RestoreThread(_state);
}
private:
PyThreadState* _state;
};

class PyEnsureGIL
{
public:
PyEnsureGIL() : _state(PyGILState_Ensure()) {}
~PyEnsureGIL()
{
PyGILState_Release(_state);
}
private:
PyGILState_STATE _state;
};

#define ERRWRAP2(expr) \
try \
{ \
PyAllowThreads allowThreads; \
expr; \
} \
catch (const cv::Exception &e) \
{ \
PyErr_SetString(opencv_error, e.what()); \
return 0; \
}

using namespace cv;

static PyObject* failmsgp(const char *fmt, ...)
{
char str[1000];

va_list ap;
va_start(ap, fmt);
vsnprintf(str, sizeof(str), fmt, ap);
va_end(ap);

PyErr_SetString(PyExc_TypeError, str);
return 0;
}

static size_t REFCOUNT_OFFSET = (size_t)&(((PyObject*)0)->ob_refcnt) +
(0x12345678 != *(const size_t*)"\x78\x56\x34\x12\0\0\0\0\0")*sizeof(int);

static inline PyObject* pyObjectFromRefcount(const int* refcount)
{
return (PyObject*)((size_t)refcount - REFCOUNT_OFFSET);
}

static inline int* refcountFromPyObject(const PyObject* obj)
{
return (int*)((size_t)obj + REFCOUNT_OFFSET);
}

class NumpyAllocator : public MatAllocator
{
public:
NumpyAllocator() {}
~NumpyAllocator() {}

void allocate(int dims, const int* sizes, int type, int*& refcount,
uchar*& datastart, uchar*& data, size_t* step)
{
PyEnsureGIL gil;

int depth = CV_MAT_DEPTH(type);
int cn = CV_MAT_CN(type);
const int f = (int)(sizeof(size_t)/8);
int typenum = depth == CV_8U ? NPY_UBYTE : depth == CV_8S ? NPY_BYTE :
depth == CV_16U ? NPY_USHORT : depth == CV_16S ? NPY_SHORT :
depth == CV_32S ? NPY_INT : depth == CV_32F ? NPY_FLOAT :
depth == CV_64F ? NPY_DOUBLE : f*NPY_ULONGLONG + (f^1)*NPY_UINT;
int i;
npy_intp _sizes[CV_MAX_DIM+1];
for( i = 0; i < dims; i++ )
{
_sizes[i] = sizes[i];
}

if( cn > 1 )
{
/*if( _sizes[dims-1] == 1 )
_sizes[dims-1] = cn;
else*/
_sizes[dims++] = cn;
}

PyObject* o = PyArray_SimpleNew(dims, _sizes, typenum);

if(!o)
{
CV_Error_(CV_StsError, ("The numpy array of typenum=%d, ndims=%d can not be created", typenum, dims));
}
refcount = refcountFromPyObject(o);

npy_intp* _strides = PyArray_STRIDES(o);
for( i = 0; i < dims - (cn > 1); i++ )
step[i] = (size_t)_strides[i];
datastart = data = (uchar*)PyArray_DATA(o);
}

void deallocate(int* refcount, uchar*, uchar*)
{
PyEnsureGIL gil;
if( !refcount )
return;
PyObject* o = pyObjectFromRefcount(refcount);
Py_INCREF(o);
Py_DECREF(o);
}
};

NumpyAllocator g_numpyAllocator;

enum { ARG_NONE = 0, ARG_MAT = 1, ARG_SCALAR = 2 };

static int pyopencv_to(const PyObject* o, Mat& m, const char* name = "<unknown>", bool allowND=true)
{
//NumpyAllocator g_numpyAllocator;
if(!o || o == Py_None)
{
if( !m.data )
m.allocator = &g_numpyAllocator;
return true;
}

if( !PyArray_Check(o) )
{
failmsg("%s is not a numpy array", name);
return false;
}

int typenum = PyArray_TYPE(o);
int type = typenum == NPY_UBYTE ? CV_8U : typenum == NPY_BYTE ? CV_8S :
typenum == NPY_USHORT ? CV_16U : typenum == NPY_SHORT ? CV_16S :
typenum == NPY_INT || typenum == NPY_LONG ? CV_32S :
typenum == NPY_FLOAT ? CV_32F :
typenum == NPY_DOUBLE ? CV_64F : -1;

if( type < 0 )
{
failmsg("%s data type = %d is not supported", name, typenum);
return false;
}

int ndims = PyArray_NDIM(o);
if(ndims >= CV_MAX_DIM)
{
failmsg("%s dimensionality (=%d) is too high", name, ndims);
return false;
}

int size[CV_MAX_DIM+1];
size_t step[CV_MAX_DIM+1], elemsize = CV_ELEM_SIZE1(type);
const npy_intp* _sizes = PyArray_DIMS(o);
const npy_intp* _strides = PyArray_STRIDES(o);
bool transposed = false;

for(int i = 0; i < ndims; i++)
{
size[i] = (int)_sizes[i];
step[i] = (size_t)_strides[i];
}

if( ndims == 0 || step[ndims-1] > elemsize ) {
size[ndims] = 1;
step[ndims] = elemsize;
ndims++;
}

if( ndims >= 2 && step[0] < step[1] )
{
std::swap(size[0], size[1]);
std::swap(step[0], step[1]);
transposed = true;
}

if( ndims == 3 && size[2] <= CV_CN_MAX && step[1] == elemsize*size[2] )
{
ndims--;
type |= CV_MAKETYPE(0, size[2]);
}

if( ndims > 2 && !allowND )
{
failmsg("%s has more than 2 dimensions", name);
return false;
}

m = Mat(ndims, size, type, PyArray_DATA(o), step);

if( m.data )
{
m.refcount = refcountFromPyObject(o);
m.addref(); // protect the original numpy array from deallocation
// (since Mat destructor will decrement the reference counter)
};
m.allocator = &g_numpyAllocator;

if( transposed )
{
Mat tmp;
tmp.allocator = &g_numpyAllocator;
transpose(m, tmp);
m = tmp;
}
return true;
}

static PyObject* pyopencv_from(const Mat& m)
{
if( !m.data )
Py_RETURN_NONE;
Mat temp, *p = (Mat*)&m;
if(!p->refcount || p->allocator != &g_numpyAllocator)
{
temp.allocator = &g_numpyAllocator;
m.copyTo(temp);
p = &temp;
}
p->addref();
return pyObjectFromRefcount(p->refcount);
}

ABC::ABC() {}
ABC::~ABC() {}
// Note the import_array() from NumPy must be called else you will experience segmentation faults.
ABC::ABC(const std::string &someConfigFile)
{
// Initialization code. Possibly store someConfigFile etc.
import_array(); // This is a function from NumPy that MUST be called.
// Do other stuff
}

// The conversions functions above are taken from OpenCV. The following function is
// what we define to access the C++ code we are interested in.
PyObject* ABC::doSomething(PyObject* image)
{
cv::Mat cvImage;
pyopencv_to(image, cvImage); // From OpenCV's source

MyCPPClass obj; // Some object from the C++ library.
cv::Mat processedImage = obj.process(cvImage);

return pyopencv_from(processedImage); // From OpenCV's source
}

Код для использования Boost Python для создания модуля Python. Я взял этот и следующий Makefile из http://jayrambhia.wordpress.com/tag/boost/:

pysomemodule.cpp:

#include <string>
#include<boost/python.hpp>
#include "abc.hpp"
using namespace boost::python;

BOOST_PYTHON_MODULE(pysomemodule)
{
class_<ABC>("ABC", init<const std::string &>())
.def(init<const std::string &>())
.def("doSomething", &ABC::doSomething) // doSomething is the method in class ABC you wish to expose. One line for each method (or function depending on how you structure your code). Note: You don't have to expose everything in the library, just the ones you wish to make available to python.
;
}

И, наконец, Makefile (успешно скомпилированный в Ubuntu, но должен работать в другом месте, возможно, с минимальными изменениями).

PYTHON_VERSION = 2.7
PYTHON_INCLUDE = /usr/include/python$(PYTHON_VERSION)

# location of the Boost Python include files and library
BOOST_INC = /usr/local/include/boost
BOOST_LIB = /usr/local/lib

OPENCV_LIB = `pkg-config --libs opencv`
OPENCV_CFLAGS = `pkg-config --cflags opencv`

MY_CPP_LIB = lib_my_cpp_library.so

TARGET = pysomemodule
SRC = pysomemodule.cpp abc.cpp
OBJ = pysomemodule.o abc.o

$(TARGET).so: $(OBJ)
g++ -shared $(OBJ) -L$(BOOST_LIB) -lboost_python -L/usr/lib/python$(PYTHON_VERSION)/config -lpython$(PYTHON_VERSION) -o $(TARGET).so $(OPENCV_LIB) $(MY_CPP_LIB)

$(OBJ): $(SRC)
g++ -I$(PYTHON_INCLUDE) -I$(BOOST_INC) $(OPENCV_CFLAGS) -fPIC -c $(SRC)

clean:
rm -f $(OBJ)
rm -f $(TARGET).so

После того, как вы успешно скомпилировали библиотеку, у вас должен быть файл «pysomemodule.so» в каталоге. Поместите этот файл lib в место, доступное для вашего интерпретатора Python. Затем вы можете импортировать этот модуль и создать экземпляр класса «ABC», описанного выше, следующим образом:

import pysomemodule

foo = pysomemodule.ABC("config.txt") # This will create an instance of ABC

Теперь, учитывая изображение массива OpenCV, мы можем вызвать функцию C ++, используя:

processedImage = foo.doSomething(image) # Where the argument "image" is a OpenCV numpy image.

Обратите внимание, что вам понадобятся Boost Python, Numpy dev, а также библиотека Python dev для создания привязок.

Документы NumPy в следующих двух ссылках особенно полезны, помогая понять методы, которые использовались в коде преобразования, и почему необходимо вызывать import_array (). В частности, официальный документ numpy полезен для понимания кода связывания Python в OpenCV.

http://dsnra.jpl.nasa.gov/software/Python/numpydoc/numpy-13.html
http://docs.scipy.org/doc/numpy/user/c-info.how-to-extend.html

Надеюсь это поможет.