SWIG C++ 的数组分配从 Python 输入

Question

我正在为一个程序编写一个 python 脚本，该程序已使用 SWIG 公开其 C++ API。 SWIG 公开的函数具有如下接口：

void writePixelsRect(JoxColor* colors, int left, int top, int width, int height);

JoxColor 是一个 POD 结构，如下所示：

struct JoxColor {
    float r, g, b, a;
};

我可以轻松地在 Python 中创建单个 JoxColor 并调用对 writePixelsRect 的调用，如下所示：

c = JoxApi.JoxColor()
c.r = r
c.g = g
c.b = b
c.a = a
JoxApi.writePixelsRect(c, x, y, 1, 1)

使用 1x1 像素矩形重复调用 writePixelsRect 非常慢，因此我我想从 python 创建一个 JoxColor 数组，这样我就可以当时写更大的矩形。这对于 SWIG 类型来说可能吗？

请注意，我无权访问公开 JoxColor 和 writePixelsRect 的 C++ 库的源代码，因此我无法为此添加帮助函数。我也不想在系统中引入新的 C++ 代码，因为这会强制我的 python 脚本的用户在他们运行的任何平台上编译 C++ 代码。我确实可以在 python 环境中访问 c​​types，因此如果我能以某种方式将 ctypes 中创建的浮点数组类型转换为 SWIG 的 JoxColor* 类型，那么它对我来说会很有用。

Answer 1

这有点棘手，但是至少对于这部分代码，您可以使用纯 ctypes 解决方案吗？基本上手动查看共享库文件导出的符号以查找 writePixelsRect 函数导出的名称。 C++ 确实有名称修饰，因此，如果库作者选择将其设为 extern "C"，它可能只是 writePixelsRect，但它可能会更加混乱，例如 _Z15writePixelsRectP8JoxColoriiii（这就是它在我刚刚在系统上创建的虚拟 C++ 库中导出的方式）。

在 Linux 上，此命令应该告诉您符号名称：

nm libjox.so | grep writePixel | cut -d " " -f 3

然后，保存该字符串并将其插入到 Python 代码中，如下所示：

from ctypes import *

LIBRARY_NAME = 'libjox.so'
c = cdll.LoadLibrary(LIBRARY_NAME)

WIDTH = 20
HEIGHT = 20

class JoxColor(Structure):
    _fields_ = [("r", c_float), ("g", c_float), ("b", c_float), ("a", c_float)]

ColorBlock = JoxColor * (WIDTH * HEIGHT)

data_array = ColorBlock()

color = JoxColor(0, 0, 1, 0)
for i in range(WIDTH * HEIGHT):
    data_array[i] = color

c._Z15writePixelsRectP8JoxColoriiii(data_array, 0, 0, WIDTH, HEIGHT)

假设 _Z15writePixelsRectP8JoxColoriiii 是该函数可在共享库中访问的符号。运行此代码只是在我的系统上使用如下所示的虚拟库运行：

#include <stdio.h>

struct JoxColor {
    float r, g, b, a;
};

void writePixelsRect(JoxColor *colors, int left, int top, int width, int height) {
    int p = 0;
    printf("size: %i, %i\n", width, height);
    for (int i = 0; i < width; i++) {
        for (int j = 0; j < height; j++) {
            JoxColor color = colors[p];
            printf("pixel: %f, %f, %f, %f\n", color.r, color.g, color.b, color.a);
        }
    }
}

所以我希望它与您环境中的工作代码相距不远。

Answer 2

除非使用特殊的类型映射，此 SWIG 原型

void writePixelsRect(JoxColor* colors, int left, int top, int width, int height);

意味着 colors 是 JoxColor 类型的单个对象，而不是数组。事实上，您仅使用单个对象进行的调用就可以工作（尽管速度很慢），这表明这是事实。因此，传递数组可能只会给您带来 SWIG 包装器代码中的类型不匹配错误。

但老实说，这看起来像是一个写入任意大矩形的函数。因此，如果您想绘制更大的矩形（一种颜色），只需传入更大的宽度和/或高度：

JoxApi.writePixelsRect(c, x, y, 10, 20)

编辑：
我没有意识到您正在编写 SWIG 包装器，我以为这是提供给您的。在这种情况下，您可以编写一个类型映射，将 Python 列表（或元组，或任何您想要的）转换为 JoxColor*。
SWIG 文档显示了如何将 Python 字符串列表转换为 char** 的示例： http://www.swig.org/Doc1.3/Python.html#Python_nn59
类型映射使用 Python C API 进行转换，您可以使用 Python 文档中所说的任何内容。本质上，您分配一个 JoxColor 数组，然后迭代 Python 列表对象并使用 PyList_GetItem 获取每个单独的对象。这将返回一个 SWIG 包装的 PyObject，您可以使用 SWIG_ConvertPtr(list_item_py_object, (void**)&joxcolor_ptr, $descriptor(JoxColor *), 0) 将其转换为指向您实际的指针JoxColor 元素。然后你可以将其复制到你的数组中。

请记住，JoxColor* 的类型映射将应用于出现 JoxColor* 的任何地方，您可以说 JoxColor* color 将其专门用于这种情况。

仅供参考，默认情况下，SWIG 以完全相同的方式将 JoxColor*、JoxColor&、JoxColor 和 JoxColor[] 包装为单个对象。 Python 只有对象，它不知道指针/引用/数组（Python 列表也是对象）。 http://www.swig.org/Doc1.3/Python.html#Python_nn22