SWIG封装C函数时正确传递NumPy数组的完整指南-Python教程-PHP中文网

SWIG封装C函数时正确传递NumPy数组的完整指南

本文详解如何在SWIG 4.3中正确封装含const指针和多输出参数的C函数，解决TypeError: argument X of type 'T const *'等常见问题，并提供可运行的NumPy兼容接口方案。

本文详解如何在swig 4.3中正确封装含`const`指针和多输出参数的c函数，解决`typeerror: argument x of type 't const *'`等常见问题，并提供可运行的numpy兼容接口方案。

在使用SWIG将C函数（如图像白平衡算法）暴露给Python时，直接传递NumPy数组却触发TypeError: argument 1 of type 'unsigned short const *'，是典型类型映射失效的表现。根本原因在于：SWIG默认不识别const修饰符与NumPy数组的内存布局语义冲突，且原生%include方式无法精准控制参数绑定逻辑。

✅ 正确做法：手动封装 + 精准 typemap 应用

首先，必须移除%include头文件——它会绕过你自定义的typemap规则，导致SWIG按原始函数签名生成胶水代码，而const unsigned short*无法被IN_ARRAY1自动匹配。取而代之的是使用%inline手动声明Python可见的包装函数：

%module AesAutoWhiteBalance

%{
#define SWIG_FILE_WITH_INIT
#include "AesAutoWhiteBalance.h"
%}

%include "numpy.i"
%init %{
import_array();
%}

// 关键：为输入数组应用 IN_ARRAY1（自动处理 uint16、连续性、尺寸检查）
%apply (unsigned short* IN_ARRAY1, int DIM1) {
  (unsigned short* measurementsR, int size_r),
  (unsigned short* measurementsG, int size_g),
  (unsigned short* measurementsB, int size_b)
};

// 关键：为输出系数数组应用 INPLACE_ARRAY1（允许原地修改，支持 float32）
%apply (float* INPLACE_ARRAY1, int DIM1) { (float* balancingCoeffs, int out_size) };

// 手动实现安全包装函数
%inline %{
void balance(
    unsigned short* measurementsR, int size_r,
    unsigned short* measurementsG, int size_g,
    unsigned short* measurementsB, int size_b,
    int bitWidth,
    float* balancingCoeffs, int out_size
) {
    // 运行时校验：确保三通道长度一致
    if (size_r != size_g || size_r != size_b) {
        PyErr_Format(PyExc_ValueError,
            "Measurement arrays must have equal length: R=%d, G=%d, B=%d",
            size_r, size_g, size_b);
        return;
    }
    // 校验输出数组大小（应为3维系数向量）
    if (out_size != 3) {
        PyErr_SetString(PyExc_ValueError, "balancingCoeffs must be a 3-element array");
        return;
    }
    // 调用原始C函数（注意：仅传 size_r 作为 measureCount）
    AesAutoWhiteBalance_Balance(
        measurementsR, measurementsG, measurementsB,
        static_cast<unsigned>(size_r),  // 转换为 unsigned
        static_cast<unsigned>(bitWidth),
        balancingCoeffs
    );
}
%}</unsigned></unsigned>

? Python端调用示例（修正版）

import numpy as np
from PIL import Image
import AesAutoWhiteBalance

# 加载并预处理图像（保持 uint16）
img = Image.open("input.png").convert('RGB')
img_array = np.array(img, dtype=np.uint16)  # 直接指定 dtype，避免 astype 拷贝

# 提取并展平通道（自动保证 C-contiguous）
red   = img_array[:, :, 0].flatten()
green = img_array[:, :, 1].flatten()
blue  = img_array[:, :, 2].flatten()

# 准备3元素输出数组（dtype=float32，非标量！）
coeffs = np.zeros(3, dtype=np.float32)

# 调用包装函数（注意：不再传 identity_matrix[0][0] 等标量！）
AesAutoWhiteBalance.balance(
    red, len(red),
    green, len(green),
    blue, len(blue),
    8,           # bitWidth
    coeffs, 3     # 输出数组及其长度
)

print("Balancing coefficients:", coeffs)  # [r_coeff, g_coeff, b_coeff]

⚠️ 关键注意事项

禁止传入NumPy标量：identity_matrix[0][0] 是 np.float32 标量，而C函数期望 float* 指针 → 必须传入一维NumPy数组（如 np.zeros(3, dtype=np.float32)），并配合 INPLACE_ARRAY1。
const 是SWIG的“拦路虎”：SWIG typemaps（如 IN_ARRAY1）内部不处理const限定符，因此包装函数签名中必须去掉const，并在%inline中用非const形参接收。
尺寸参数必须显式传递：SWIG无法从数组推断measureCount，需在Python调用中显式传入len(red)等；包装函数内做一致性校验。
内存连续性保障：.flatten() 返回的是C连续副本，安全；若用 .ravel() 需确认原数组连续，否则SWIG可能报错。