/* * Oak Video Editor - Non-Linear Video Editor * Copyright (C) 2026 Oak Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ /* * 最小测试插件(M11 §2.4 的交付物;build.rs 编译为共享库, * 运行时装配成 oak-test-plugin.ofx.bundle 供 host 扫描)。 * * filter 上下文: * - 参数:gain(Double,默认 0) * - clip:Source(输入,RGBA)、Output * - describe/describeInContext 建参数与 clip; * - getClipPreferences:全链路 F32+RGBA、帧率 24; * - render:把输出图像填成常量 0.5(RGBA float),alpha=1; * - getRoD:project size;getRoI:原样返回 region; * - isIdentity:不设 → 非透传; * - begin/endSequenceRender:记日志(状态码 OK)。 */ #include #include #include "ofxCore.h" #include "ofxColour.h" #include "ofxGPURender.h" #include "ofxImageEffect.h" #include "ofxMessage.h" #include "ofxParam.h" #include "ofxProgress.h" #include "ofxProperty.h" /* kOfxImageEffectGLFormatRGBA 在 vendored ofxOpenGLRender.h 是 stub * 未收录(OpenFX 1.4 规范名),按规范定义。kOfxImageEffectPropIsIdentity * 同理(vendored ofxImageEffect.h 只文档化了该属性,未给宏)。 */ #define GL_FORMAT_RGBA "OfxImageEffectGLFormatRGBA" #define kOfxImageEffectPropIsIdentity "OfxImageEffectPropIsIdentity" static OfxHost *g_host = NULL; static const OfxPropertySuiteV1 *g_propSuite = NULL; static const OfxImageEffectSuiteV1 *g_imageEffectSuite = NULL; static const OfxParameterSuiteV1 *g_paramSuite = NULL; static const OfxMessageSuiteV1 *g_messageSuite = NULL; static const OfxProgressSuiteV1 *g_progressSuite = NULL; static const OfxImageEffectOpenGLRenderSuiteV1 *g_glSuite = NULL; /* ---------- suite 便捷封装 ---------- */ static OfxStatus propSetString(OfxPropertySetHandle h, const char *name, int index, const char *v) { return g_propSuite->propSetString(h, name, index, v); } static OfxStatus propSetStringN(OfxPropertySetHandle h, const char *name, int count, const char **v) { return g_propSuite->propSetStringN(h, name, count, v); } static OfxStatus propSetDoubleN(OfxPropertySetHandle h, const char *name, int count, const double *v) { return g_propSuite->propSetDoubleN(h, name, count, v); } static OfxStatus propGetDouble(OfxPropertySetHandle h, const char *name, int index, double *v) { return g_propSuite->propGetDouble(h, name, index, v); } static OfxStatus propGetInt(OfxPropertySetHandle h, const char *name, int index, int *v) { return g_propSuite->propGetInt(h, name, index, v); } static OfxStatus propGetIntN(OfxPropertySetHandle h, const char *name, int count, int *v) { return g_propSuite->propGetIntN(h, name, count, v); } static OfxStatus propGetPointer(OfxPropertySetHandle h, const char *name, int index, void **v) { return g_propSuite->propGetPointer(h, name, index, v); } /* 协商期 per-clip 属性名:前缀_clip */ static void setClipPref(OfxPropertySetHandle out, const char *prefix, const char *clip, const char *value) { char name[256]; snprintf(name, sizeof(name), "%s_%s", prefix, clip); propSetString(out, name, 0, value); } /* ---------- setHost(mandatory 第一个调用) ---------- */ static void setHost(OfxHost *host) { g_host = host; if (!host) return; g_propSuite = (const OfxPropertySuiteV1 *)host->fetchSuite(host->host, kOfxPropertySuite, 1); g_imageEffectSuite = (const OfxImageEffectSuiteV1 *)host->fetchSuite(host->host, kOfxImageEffectSuite, 1); g_paramSuite = (const OfxParameterSuiteV1 *)host->fetchSuite(host->host, kOfxParameterSuite, 1); g_messageSuite = (const OfxMessageSuiteV1 *)host->fetchSuite(host->host, kOfxMessageSuite, 1); g_progressSuite = (const OfxProgressSuiteV1 *)host->fetchSuite(host->host, kOfxProgressSuite, 1); g_glSuite = (const OfxImageEffectOpenGLRenderSuiteV1 *)host->fetchSuite( host->host, kOfxOpenGLRenderSuite, 1); } /* ---------- action 实现 ---------- */ static OfxStatus actionDescribe(const void *handle, int is_gl) { const char *comps[] = { kOfxImageComponentRGBA, kOfxImageComponentRGB, kOfxImageComponentAlpha }; propSetString(handle, kOfxPropLabel, 0, "Oak Test Plugin"); propSetStringN(handle, kOfxImageEffectPropSupportedContexts, 1, &(const char *){ kOfxImageEffectContextFilter }); /* ofxColour(M11 §4):声明 OCIO 色彩管理能力与可用配置。 */ propSetString(handle, kOfxImageEffectPropColourManagementStyle, 0, kOfxImageEffectColourManagementOCIO); { const char *configs[] = { "ofx-native-v1.5_aces-v1.3_ocio-v2.3" }; propSetStringN(handle, kOfxImageEffectPropColourManagementAvailableConfigs, 1, configs); } /* GL 能力(M11 §4):GL 变体声明 "true" + 支持位深(F32)。 * CPU 变体保持默认 "false"。 */ if (is_gl) { propSetString(handle, kOfxImageEffectPropOpenGLRenderSupported, 0, "true"); { const char *depths[] = { kOfxBitDepthFloat }; propSetStringN(handle, kOfxOpenGLPropPixelDepth, 1, depths); } } /* 参数族:gain(Double,带 display min/max)、mode(Choice, * 两选项)、debug(Double,secret)、label(String)。 */ OfxPropertySetHandle paramProps = NULL; OfxStatus st = g_paramSuite->paramDefine((OfxParamSetHandle)handle, kOfxParamTypeDouble, "gain", ¶mProps); if (st != kOfxStatOK) return st; propSetString(paramProps, kOfxPropLabel, 0, "Gain"); { const double min = -2.0, max = 2.0; g_propSuite->propSetDouble(paramProps, kOfxParamPropDisplayMin, 0, min); g_propSuite->propSetDouble(paramProps, kOfxParamPropDisplayMax, 0, max); } st = g_paramSuite->paramDefine((OfxParamSetHandle)handle, kOfxParamTypeChoice, "mode", ¶mProps); if (st != kOfxStatOK) return st; propSetString(paramProps, kOfxPropLabel, 0, "Mode"); { const char *options[] = { "Fast", "High" }; g_propSuite->propSetStringN(paramProps, kOfxParamPropChoiceOption, 2, options); } st = g_paramSuite->paramDefine((OfxParamSetHandle)handle, kOfxParamTypeDouble, "debug", ¶mProps); if (st != kOfxStatOK) return st; g_propSuite->propSetInt(paramProps, kOfxParamPropSecret, 0, 1); st = g_paramSuite->paramDefine((OfxParamSetHandle)handle, kOfxParamTypeString, "label", ¶mProps); if (st != kOfxStatOK) return st; propSetString(paramProps, kOfxPropLabel, 0, "Label"); /* clip:Source + Output。 */ OfxPropertySetHandle clipProps = NULL; st = g_imageEffectSuite->clipDefine((OfxImageEffectHandle)handle, "Source", &clipProps); if (st != kOfxStatOK) return st; propSetStringN(clipProps, kOfxImageEffectPropSupportedComponents, 3, comps); propSetString(clipProps, kOfxPropLabel, 0, "Source"); st = g_imageEffectSuite->clipDefine((OfxImageEffectHandle)handle, "Output", &clipProps); if (st != kOfxStatOK) return st; propSetStringN(clipProps, kOfxImageEffectPropSupportedComponents, 3, comps); return kOfxStatOK; } static OfxStatus actionGetClipPreferences(OfxPropertySetHandle outArgs) { setClipPref(outArgs, "OfxImageClipPropComponents", "Source", kOfxImageComponentRGBA); setClipPref(outArgs, "OfxImageClipPropDepth", "Source", kOfxBitDepthFloat); setClipPref(outArgs, "OfxImageClipPropComponents", "Output", kOfxImageComponentRGBA); setClipPref(outArgs, "OfxImageClipPropDepth", "Output", kOfxBitDepthFloat); g_propSuite->propSetDouble(outArgs, kOfxImageEffectPropFrameRate, 0, 24.0); g_propSuite->propSetString(outArgs, kOfxImageClipPropFieldOrder, 0, kOfxImageFieldNone); return kOfxStatOK; } static OfxStatus actionGetRoD(OfxPropertySetHandle outArgs) { const double rod[4] = { 0.0, 0.0, 1920.0, 1080.0 }; propSetDoubleN(outArgs, kOfxImageEffectPropRegionOfDefinition, 4, rod); return kOfxStatOK; } static OfxStatus actionGetRoI(OfxImageEffectHandle inst, OfxPropertySetHandle inArgs, OfxPropertySetHandle outArgs) { /* 对每个输入 clip 回填 region(此处原样返回 Output 的 window 即可)。 */ OfxImageClipHandle clip = NULL; OfxPropertySetHandle clipProps = NULL; OfxStatus st = g_imageEffectSuite->clipGetHandle(inst, "Source", &clip, &clipProps); if (st != kOfxStatOK) return st; double region[4] = { 0.0, 0.0, 0.0, 0.0 }; st = g_propSuite->propGetDoubleN(inArgs, kOfxImageEffectPropRegionOfInterest, 4, region); if (st != kOfxStatOK) return st; char name[256]; snprintf(name, sizeof(name), "OfxImageEffectPropRegionOfInterest_%s", "Source"); st = propSetDoubleN(outArgs, name, 4, region); fprintf(stderr, "DBG getRoI read=(%g,%g,%g,%g) set st=%d\n", region[0], region[1], region[2], region[3], st); if (st != kOfxStatOK) return st; return kOfxStatOK; } static OfxStatus actionRender(OfxImageEffectHandle inst, OfxPropertySetHandle inArgs) { double time = 0.0; propGetDouble(inArgs, kOfxPropTime, 0, &time); OfxImageClipHandle clip = NULL; OfxPropertySetHandle clipProps = NULL; OfxStatus st = g_imageEffectSuite->clipGetHandle(inst, "Output", &clip, &clipProps); if (st != kOfxStatOK) return st; OfxPropertySetHandle image = NULL; st = g_imageEffectSuite->clipGetImage(clip, time, NULL, &image); if (st != kOfxStatOK) return st; void *data = NULL; int rowBytes = 0; int bounds[4] = { 0, 0, 0, 0 }; propGetPointer(image, kOfxImagePropData, 0, &data); propGetInt(image, kOfxImagePropRowBytes, 0, &rowBytes); propGetIntN(image, kOfxImagePropBounds, 4, bounds); /* 进度:Start → Update(0.5)(取消则中止)→ End。 */ if (g_progressSuite) { g_progressSuite->progressStart((OfxImageEffectHandle)inst, "render"); OfxStatus ps = g_progressSuite->progressUpdate((OfxImageEffectHandle)inst, 0.5); if (ps != kOfxStatOK) { g_progressSuite->progressEnd((OfxImageEffectHandle)inst); return kOfxStatFailed; } } int w = bounds[2] - bounds[0]; int h = bounds[3] - bounds[1]; if (data && w > 0 && h > 0) { /* 常量 0.5(RGBA float);alpha=1。 */ for (int y = 0; y < h; y++) { float *row = (float *)((char *)data + (size_t)y * (size_t)rowBytes); for (int x = 0; x < w; x++) { row[x * 4 + 0] = 0.5f; row[x * 4 + 1] = 0.5f; row[x * 4 + 2] = 0.5f; row[x * 4 + 3] = 1.0f; } } } g_imageEffectSuite->clipReleaseImage(image); if (g_progressSuite) { g_progressSuite->progressEnd((OfxImageEffectHandle)inst); } return kOfxStatOK; } /* ---------- ofxColour(M11 §4):GetOutputColourspace ---------- */ static OfxStatus actionGetOutputColourspace(OfxPropertySetHandle inArgs, OfxPropertySetHandle outArgs) { /* 优先采纳宿主偏好的第一个色彩空间;否则交叉引用 Source clip * (ofxColour.h:cross-reference 是合法回写,宿主须解析)。 */ int n = 0; g_propSuite->propGetDimension(inArgs, kOfxImageClipPropPreferredColourspaces, &n); if (n > 0) { char *pref = NULL; OfxStatus st = g_propSuite->propGetString( inArgs, kOfxImageClipPropPreferredColourspaces, 0, &pref); if (st == kOfxStatOK && pref) { propSetString(outArgs, kOfxImageClipPropColourspace, 0, pref); return kOfxStatOK; } } propSetString(outArgs, kOfxImageClipPropColourspace, 0, "OfxColourspace_Source"); return kOfxStatOK; } /* ---------- isIdentity 变体:透传 Source ---------- */ static OfxStatus actionIsIdentity(OfxPropertySetHandle inArgs, OfxPropertySetHandle outArgs) { /* 恒透传 Source(时间不变)——宿主应短路 render 直接拷贝 Source * 的帧。 */ propSetString(outArgs, kOfxImageEffectPropIsIdentity, 0, "Source"); return kOfxStatOK; } /* ---------- GL 变体(M11 §4):attach/detach 与 GL render ---------- */ static OfxStatus actionGLAttached(OfxImageEffectHandle handle) { if (g_messageSuite) { g_messageSuite->message(handle, kOfxMessageMessage, "gl-test", "gl-attached"); } return kOfxStatOK; } static OfxStatus actionGLDetached(OfxImageEffectHandle handle) { if (g_messageSuite) { g_messageSuite->message(handle, kOfxMessageMessage, "gl-test", "gl-detached"); } return kOfxStatOK; } /* GL render:经 OpenGL suite 取 Source 与 Output 纹理并上报索引 * (宿主侧测试经 message 捕获断言)。GL 未使能时回退 CPU render。 */ static OfxStatus actionRenderGL(OfxImageEffectHandle inst, OfxPropertySetHandle inArgs) { int gl_enabled = 0; g_propSuite->propGetInt(inArgs, kOfxImageEffectPropOpenGLEnabled, 0, &gl_enabled); if (!gl_enabled) { return actionRender(inst, inArgs); } if (!g_glSuite) { return kOfxStatErrMissingHostFeature; } double time = 0.0; propGetDouble(inArgs, kOfxPropTime, 0, &time); /* 输入 clip:clipLoadTexture(请求 RGBA)。 */ OfxImageClipHandle clip = NULL; OfxPropertySetHandle clipProps = NULL; OfxStatus st = g_imageEffectSuite->clipGetHandle(inst, "Source", &clip, &clipProps); if (st != kOfxStatOK) return st; OfxPropertySetHandle tex = NULL; st = g_glSuite->clipLoadTexture(clip, time, GL_FORMAT_RGBA, NULL, &tex); if (st != kOfxStatOK) return st; int src_index = 0; g_propSuite->propGetInt(tex, kOfxImageEffectPropOpenGLTextureIndex, 0, &src_index); if (g_messageSuite) { g_messageSuite->message(inst, kOfxMessageMessage, "gl-test", "gl-source-index=%d", src_index); } st = g_glSuite->clipFreeTexture(tex); if (st != kOfxStatOK) return st; /* 输出 clip:clipLoadTexture(Output)(format 忽略)。 */ st = g_imageEffectSuite->clipGetHandle(inst, "Output", &clip, &clipProps); if (st != kOfxStatOK) return st; tex = NULL; st = g_glSuite->clipLoadTexture(clip, time, NULL, NULL, &tex); if (st != kOfxStatOK) return st; int out_index = 0; g_propSuite->propGetInt(tex, kOfxImageEffectPropOpenGLTextureIndex, 0, &out_index); if (g_messageSuite) { g_messageSuite->message(inst, kOfxMessageMessage, "gl-test", "gl-output-index=%d", out_index); } st = g_glSuite->clipFreeTexture(tex); if (st != kOfxStatOK) return st; return kOfxStatOK; } static OfxStatus mainEntry(const char *action, const void *handle, OfxPropertySetHandle inArgs, OfxPropertySetHandle outArgs) { if (strcmp(action, kOfxActionDescribe) == 0 || strcmp(action, kOfxImageEffectActionDescribeInContext) == 0) { return actionDescribe(handle, 0); } if (strcmp(action, kOfxActionCreateInstance) == 0) { /* 经 message suite 发一条(facade 处理器断言用)。 */ if (g_messageSuite) { g_messageSuite->message(handle, kOfxMessageMessage, "test-plugin", "created id=%d", 7); } return kOfxStatOK; } if (strcmp(action, kOfxActionDestroyInstance) == 0 || strcmp(action, kOfxActionLoad) == 0 || strcmp(action, kOfxActionUnload) == 0 || strcmp(action, kOfxImageEffectActionBeginSequenceRender) == 0 || strcmp(action, kOfxImageEffectActionEndSequenceRender) == 0 || strcmp(action, kOfxImageEffectActionIsIdentity) == 0) { return kOfxStatOK; } if (strcmp(action, kOfxImageEffectActionGetClipPreferences) == 0) { return actionGetClipPreferences(outArgs); } if (strcmp(action, kOfxImageEffectActionGetRegionOfDefinition) == 0) { return actionGetRoD(outArgs); } if (strcmp(action, kOfxImageEffectActionGetRegionsOfInterest) == 0) { return actionGetRoI((OfxImageEffectHandle)handle, inArgs, outArgs); } if (strcmp(action, kOfxImageEffectActionGetOutputColourspace) == 0) { return actionGetOutputColourspace(inArgs, outArgs); } if (strcmp(action, kOfxImageEffectActionRender) == 0) { return actionRender((OfxImageEffectHandle)handle, inArgs); } return kOfxStatReplyDefault; } /* GL 变体入口:describe 带 GL 声明;render 走 GL suite;attach/ * detach 上报。 */ static OfxStatus mainEntryGL(const char *action, const void *handle, OfxPropertySetHandle inArgs, OfxPropertySetHandle outArgs) { if (strcmp(action, kOfxActionDescribe) == 0 || strcmp(action, kOfxImageEffectActionDescribeInContext) == 0) { return actionDescribe(handle, 1); } if (strcmp(action, kOfxActionCreateInstance) == 0) { return kOfxStatOK; } if (strcmp(action, kOfxActionDestroyInstance) == 0 || strcmp(action, kOfxActionLoad) == 0 || strcmp(action, kOfxActionUnload) == 0 || strcmp(action, kOfxImageEffectActionBeginSequenceRender) == 0 || strcmp(action, kOfxImageEffectActionEndSequenceRender) == 0 || strcmp(action, kOfxImageEffectActionIsIdentity) == 0) { return kOfxStatOK; } if (strcmp(action, kOfxActionOpenGLContextAttached) == 0) { return actionGLAttached((OfxImageEffectHandle)handle); } if (strcmp(action, kOfxActionOpenGLContextDetached) == 0) { return actionGLDetached((OfxImageEffectHandle)handle); } if (strcmp(action, kOfxImageEffectActionGetClipPreferences) == 0) { return actionGetClipPreferences(outArgs); } if (strcmp(action, kOfxImageEffectActionGetRegionOfDefinition) == 0) { return actionGetRoD(outArgs); } if (strcmp(action, kOfxImageEffectActionGetRegionsOfInterest) == 0) { return actionGetRoI((OfxImageEffectHandle)handle, inArgs, outArgs); } if (strcmp(action, kOfxImageEffectActionGetOutputColourspace) == 0) { return actionGetOutputColourspace(inArgs, outArgs); } if (strcmp(action, kOfxImageEffectActionRender) == 0) { return actionRenderGL((OfxImageEffectHandle)handle, inArgs); } return kOfxStatReplyDefault; } /* 恒透传变体入口:isIdentity 返回 Source;其余同 CPU 插件。 */ static OfxStatus mainEntryID(const char *action, const void *handle, OfxPropertySetHandle inArgs, OfxPropertySetHandle outArgs) { if (strcmp(action, kOfxActionDescribe) == 0 || strcmp(action, kOfxImageEffectActionDescribeInContext) == 0) { return actionDescribe(handle, 0); } if (strcmp(action, kOfxImageEffectActionIsIdentity) == 0) { return actionIsIdentity(inArgs, outArgs); } if (strcmp(action, kOfxImageEffectActionGetOutputColourspace) == 0) { return actionGetOutputColourspace(inArgs, outArgs); } return mainEntry(action, handle, inArgs, outArgs); } /* ---------- 导出 ---------- */ static const OfxPlugin test_plugin = { /* pluginApi */ kOfxImageEffectPluginApi, /* apiVersion */ kOfxImageEffectPluginApiVersion, /* pluginIdentifier */ "org.oak.test-plugin", /* pluginVersionMajor */ 1, /* pluginVersionMinor */ 0, /* setHost */ setHost, /* mainEntry */ mainEntry, }; static const OfxPlugin test_plugin_gl = { /* pluginApi */ kOfxImageEffectPluginApi, /* apiVersion */ kOfxImageEffectPluginApiVersion, /* pluginIdentifier */ "org.oak.test-plugin.gl", /* pluginVersionMajor */ 1, /* pluginVersionMinor */ 0, /* setHost */ setHost, /* mainEntry */ mainEntryGL, }; static const OfxPlugin test_plugin_id = { /* pluginApi */ kOfxImageEffectPluginApi, /* apiVersion */ kOfxImageEffectPluginApiVersion, /* pluginIdentifier */ "org.oak.test-plugin.identity", /* pluginVersionMajor */ 1, /* pluginVersionMinor */ 0, /* setHost */ setHost, /* mainEntry */ mainEntryID, }; OfxExport int OfxGetNumberOfPlugins(void) { return 3; } OfxExport OfxPlugin *OfxGetPlugin(int nth) { if (nth == 0) return (OfxPlugin *)&test_plugin; if (nth == 1) return (OfxPlugin *)&test_plugin_gl; if (nth == 2) return (OfxPlugin *)&test_plugin_id; return NULL; }