[IOS Metal]使用METAL自定义CIFilter导致vertex function找不到的问题

通常使用 CIFilter 可以对图像做一些处理，如果有些效果我们不满意，我们需要自己去实现的话，是可以通过写 metal 来自定义 CIFilter，和 fragment shader 类似，处理对象都是一个像素点。

如何使用 metal shader 自定义 CIFilter 网上的教程有很多，我这里还是赘述一下。

第一步：创建一个.metal文件，定义 filter。记住自己的方法名，后面需要用到。
第二步：继承 CIFilter 定义出一个子类，通过加载 default.metallib 找到对应的方法即可。
第三步：在 Build Settings 里面加入两个flag。

下面是第一步的代码，随便定义一个文件比如叫 kernel.metal，里面放上这些代码。注意到这里的方法名是 myColor。

myColor 方法就是简单的返回当前点的颜色。

#include 
#include 

using namespace metal;

extern "C" {
    namespace coreimage {
        
        float4 myColor(sample_t s, float value) {
            return s.rgba;
        }
    }
}

第二步，建立一个自己的 CIFilter 子类，然后做下面这些事情。

class CustomFilter : CIFilter {
    
    var value: Double = 0
    
    private var kernel: CIKernel!
    
    override init() {
        super.init()
        commonInit()
    }
    
    required init?(coder: NSCoder) {
        super.init(coder: coder)
        commonInit()
    }
    
    private func commonInit() {
        // 找到默认的 default.metallib
        guard let url = Bundle.main.url(forResource: "default", withExtension: "metallib"),
            let data = try? Data(contentsOf: url) else {
            fatalError("Unable to get metallib")
        }
        
        // 从lib中加载到 myColor 方法
        guard let myKernel = try? CIKernel.init(functionName: "myColor", fromMetalLibraryData: data) else {
            fatalError("Unable to create CIKernel from myKernel")
        }
        
        kernel = myKernel
    }
    
    var inputImage:CIImage?
    override var outputImage: CIImage? {
        let src = CISampler(image: self.inputImage!)
        // apply 这个 filter
        return kernel.apply(extent: inputImage!.extent, roiCallback: { _, rect in return rect}, arguments: [src, value])
    }
}

第三步，在 Build Setting 里面加入 flag

需要加两个参数一个 -fcikernel，另一个是 -cikernel。这篇文档第10页有讲 https://developer.apple.com/metal/MetalCIKLReference6.pdf 照着加一下即可。

好耶，自定义的 CIFilter 可以使用了，BUT，此时此刻你之前写的 pipeline 却无法正常工作了，会提示找不到vertex function。

为什么会这样呢？因为加了 flag 之后，编译的时候会将所有的 .metal 文件都通过某种形式进行特殊的编译使之成为适合 CoreImage 框架使用的代码，正常的 pipeline 里面需要的 vertex shader 和 fragment shader 都失效了。

为了解决这个问题，需要将区分哪些是需要经过 -cikernel, -fcikernel flag 打包的，哪些是不需要的。

这里有解决方案：https://stackoverflow.com/questions/57391441/metal-vertexfunction-defined-in-metal-file-becomes-nil-once-setting-compiler-a

我踩了不少坑才完成这项功能。

其实在 https://developer.apple.com/metal/MetalCIKLReference6.pdf 文档中已经写了如何编译 metal 使之成为kernel适用的代码，见下图

原理就是如此，所以我们第一步需要区分 正常的metal 和 cikernel的metal，为了区分这一点，直接将刚刚写的 kernel.metal 的后缀改为 .kernel。这样普通的metal文件仍然是 *.metal，而为 CIFilter 用的 metal 文件后缀则是 .kernel。

第二步，编译前需要改回 .metal 后缀，经过实践发现，metal编译器直接忽略了后缀名不正确的文件以至于无法编译成功，所以我们需要先执行一个 cp 步骤。

第三步，执行如上图所示的编译，变成一个我们自定义的 xxxx.metallib

第四步，将 xxxx.metallib 复制到打包路径中，以便打包的时候可以打进ipa文件。

第五步，在自定义的 CIFilter 中加载metallib时，使用刚刚自定义的 xxxx.metallib，而不是 default。

现在来讲讲具体操作。

在 Build Rules 中添加一个步骤

在里面的输入框中放入

# 复制一下，不然metal编译器不认识
cp "${SRCROOT}/Varlens/Shader/kernel.kernel" "${DERIVED_FILES_DIR}/kernel.metal"

# 后面这两句就是编译了，注意输入输出路径即可
xcrun metal -fcikernel "${DERIVED_FILES_DIR}/kernel.metal" -c -o "${DERIVED_FILES_DIR}/MyKernels.air"
xcrun metallib -cikernel "${DERIVED_FILES_DIR}/MyKernels.air" -o ${DERIVED_FILE_DIR}/kernel.metallib

然后在 Build Phases 中添加一个步骤，做复制 metallib 的操作。

完事。

krosshj @ 2021-04-22 14:57