[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 <metal_stdlib>
#include <CoreImage/CoreImage.h>

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适用的代码,见下图

原理就是如此,所以我们第一步需要区分 正常的metalcikernel的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

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,270评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,489评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,630评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,906评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,928评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,718评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,442评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,345评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,802评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,984评论 3 337
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,117评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,810评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,462评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,011评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,139评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,377评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,060评论 2 355

推荐阅读更多精彩内容