Mike-Solar
bb40b4923e
Automated with clang-tidy readability-identifier-naming (config added to .clang-tidy) plus scripted passes, per the updated rules now documented in CONTRIBUTING.md: - types (class/struct/enum/alias/template params): PascalCase - functions, variables, members: snake_case (incl. rational -> Rational) - private/protected members: trailing underscore; static member variables likewise (instance_, available_themes_) - constants and enum values: snake_case (kLinear -> k_linear, F32P -> f32p); ALL_CAPS reserved for macros - macros: OAK_ prefix (OLIVE_ADD_TEST/OLIVE_ASSERT/OLIVE_CONFIG -> OAK_ADD_TEST/OAK_ASSERT/OAK_CONFIG, GL_PREAMBLE -> OAK_GL_PREAMBLE, include guards -> OAK_*) - file names: all lowercase (Current/Plugin/OliveHost/OliveClip/ OlivePluginInstance -> current/plugin/olivehost/oliveclip/ oliveplugininstance) - getters share the member name sans underscore, setters set_foo() - Qt and third-party (OpenFX) virtual overrides and framework callbacks keep their original names (exempt in .clang-tidy) Manual follow-ups required where automation could not reach: - string-based QMetaObject/SIGNAL/SLOT references updated to renamed methods (AddTask, CreatedFile, DeleteSpecificFile, moveSelectionUp, ...) - macro bodies referencing renamed methods (OLIVE_CONFIG, NODE_DEFAULT_DESTRUCTOR, MANAGEDDISPLAYWIDGET_*) - self-shadowing locals renamed where signals/methods became same-named (size_changed, worker_count, selected_items, import param, filters) - third_party OFX member/namespace usages restored (OFX::Host::*, _created, _clipPrefsDirty, createInstance, clearPersistentMessage) - STL protocol aliases restored (const_iterator) with .clang-tidy ignore rules; qHash overloads restored Full build and test suite pass: ctest 4/4, ~1960 gtest cases green.
430 lines
14 KiB
C++
430 lines
14 KiB
C++
#include <gtest/gtest.h>
|
|
|
|
#include <QByteArray>
|
|
#include <QMatrix4x4>
|
|
#include <QOpenGLContext>
|
|
#include <QThread>
|
|
|
|
#include "node/value.h"
|
|
#include "render/backend/dynamicrenderer.h"
|
|
#include "render/job/shaderjob.h"
|
|
#include "render/shadercode.h"
|
|
#include "render/texture.h"
|
|
#include "render/videoparams.h"
|
|
|
|
// Verifies that the dynamic adapter can load the private OpenGL backend and
|
|
// query its advertised C ABI capabilities without creating a viewer context.
|
|
TEST(DynamicRenderBackend, LoadsExperimentalOpenGLBackend)
|
|
{
|
|
#ifndef OAK_ENABLE_DYNAMIC_RENDER_BACKEND
|
|
GTEST_SKIP() << "Dynamic render backend is not enabled in this build";
|
|
#else
|
|
olive::DynamicRenderer renderer(QStringLiteral("opengl"));
|
|
if (!renderer.load()) {
|
|
GTEST_SKIP()
|
|
<< "opengl backend library could not be loaded in this environment";
|
|
}
|
|
|
|
EXPECT_EQ(renderer.open_gl_context(), nullptr);
|
|
OakRenderBackendInfo info = {};
|
|
ASSERT_TRUE(renderer.get_backend_info(&info));
|
|
EXPECT_EQ(info.abi_version, 1U);
|
|
EXPECT_EQ(info.kind, oak_render_backend_opengl);
|
|
EXPECT_STREQ(info.name, "opengl");
|
|
EXPECT_TRUE(info.capabilities & oak_render_backend_cap_textures);
|
|
EXPECT_TRUE(info.capabilities & oak_render_backend_cap_shaders);
|
|
EXPECT_TRUE(info.capabilities & oak_render_backend_cap_blit);
|
|
EXPECT_TRUE(info.capabilities & oak_render_backend_cap_readback);
|
|
#endif
|
|
}
|
|
|
|
// Regression test: the backend renderer must follow DynamicRenderer when it is
|
|
// moved to a background thread. If it stays in the thread where Load() was
|
|
// called, GL operations are rejected as "wrong thread" and texture creation
|
|
// returns null, which manifests as a black screen.
|
|
TEST(DynamicRenderBackend, OpenGLBackendFollowsAdapterToRenderThread)
|
|
{
|
|
#ifndef OAK_ENABLE_DYNAMIC_RENDER_BACKEND
|
|
GTEST_SKIP() << "Dynamic render backend is not enabled in this build";
|
|
#else
|
|
olive::DynamicRenderer renderer(QStringLiteral("opengl"));
|
|
if (!renderer.load()) {
|
|
GTEST_SKIP()
|
|
<< "opengl backend library could not be loaded in this environment";
|
|
}
|
|
|
|
if (!renderer.init()) {
|
|
GTEST_SKIP()
|
|
<< "OpenGL backend could not be initialized on this system";
|
|
}
|
|
|
|
QThread render_thread;
|
|
renderer.moveToThread(&render_thread);
|
|
render_thread.start();
|
|
|
|
QOpenGLContext *ctx = renderer.open_gl_context();
|
|
ASSERT_NE(ctx, nullptr);
|
|
EXPECT_EQ(ctx->thread(), &render_thread)
|
|
<< "Backend OpenGL context did not follow DynamicRenderer to render thread";
|
|
|
|
// Exercise the actual GL path in the render thread: PostInit() creates the
|
|
// offscreen surface there, and CreateTexture() must not crash.
|
|
olive::TexturePtr texture;
|
|
QMetaObject::invokeMethod(
|
|
&renderer,
|
|
[&]() {
|
|
renderer.post_init();
|
|
texture = renderer.create_texture(
|
|
olive::VideoParams(64, 64, olive::PixelFormat::u8,
|
|
olive::VideoParams::k_rgba_channel_count));
|
|
},
|
|
Qt::BlockingQueuedConnection);
|
|
|
|
render_thread.quit();
|
|
render_thread.wait();
|
|
|
|
ASSERT_NE(texture, nullptr);
|
|
EXPECT_FALSE(texture->is_dummy());
|
|
#endif
|
|
}
|
|
|
|
// Verifies Vulkan backend discovery on systems with a working Vulkan ICD. The
|
|
// test skips when the runtime correctly reports Vulkan as unavailable.
|
|
TEST(DynamicRenderBackend, LoadsExperimentalVulkanBackendWhenAvailable)
|
|
{
|
|
#ifndef OAK_ENABLE_DYNAMIC_RENDER_BACKEND
|
|
GTEST_SKIP() << "Dynamic render backend is not enabled in this build";
|
|
#else
|
|
olive::DynamicRenderer renderer(QStringLiteral("vulkan"));
|
|
if (!renderer.load()) {
|
|
GTEST_SKIP()
|
|
<< "vulkan backend library could not be loaded in this environment";
|
|
}
|
|
|
|
OakRenderBackendInfo info = {};
|
|
ASSERT_TRUE(renderer.get_backend_info(&info));
|
|
if (info.kind != oak_render_backend_vulkan) {
|
|
GTEST_SKIP() << "Vulkan backend is not available on this system";
|
|
}
|
|
EXPECT_EQ(renderer.backend_name(), QStringLiteral("vulkan"));
|
|
EXPECT_EQ(renderer.open_gl_context(), nullptr);
|
|
EXPECT_STREQ(info.name, "vulkan");
|
|
EXPECT_TRUE(info.capabilities & oak_render_backend_cap_textures);
|
|
EXPECT_TRUE(info.capabilities & oak_render_backend_cap_shaders);
|
|
EXPECT_TRUE(info.capabilities & oak_render_backend_cap_blit);
|
|
EXPECT_TRUE(info.capabilities & oak_render_backend_cap_readback);
|
|
#endif
|
|
}
|
|
|
|
// Verifies that requesting Vulkan on systems without a usable runtime falls
|
|
// back to OpenGL and reports the effective backend name.
|
|
TEST(DynamicRenderBackend, FallsBackWhenExperimentalVulkanUnavailable)
|
|
{
|
|
#ifndef OAK_ENABLE_DYNAMIC_RENDER_BACKEND
|
|
GTEST_SKIP() << "Dynamic render backend is not enabled in this build";
|
|
#else
|
|
olive::DynamicRenderer renderer(QStringLiteral("vulkan"));
|
|
if (!renderer.load()) {
|
|
GTEST_SKIP()
|
|
<< "vulkan backend library could not be loaded in this environment";
|
|
}
|
|
|
|
OakRenderBackendInfo info = {};
|
|
ASSERT_TRUE(renderer.get_backend_info(&info));
|
|
if (info.kind == oak_render_backend_vulkan) {
|
|
GTEST_SKIP()
|
|
<< "Vulkan backend is available on this system; skip fallback test";
|
|
}
|
|
EXPECT_EQ(renderer.backend_name(), QStringLiteral("opengl"));
|
|
EXPECT_EQ(renderer.open_gl_context(), nullptr);
|
|
EXPECT_EQ(info.kind, oak_render_backend_opengl);
|
|
EXPECT_STREQ(info.name, "opengl");
|
|
#endif
|
|
}
|
|
|
|
// Exercises the minimal Vulkan render loop: upload a texture, run a pass-through
|
|
// shader blit, then download the destination and verify pixel data.
|
|
TEST(DynamicRenderBackend, VulkanUploadBlitDownload)
|
|
{
|
|
#ifndef OAK_ENABLE_DYNAMIC_RENDER_BACKEND
|
|
GTEST_SKIP() << "Dynamic render backend is not enabled in this build";
|
|
#else
|
|
olive::DynamicRenderer renderer(QStringLiteral("vulkan"));
|
|
if (!renderer.load()) {
|
|
GTEST_SKIP()
|
|
<< "vulkan backend library could not be loaded in this environment";
|
|
}
|
|
|
|
OakRenderBackendInfo info = {};
|
|
ASSERT_TRUE(renderer.get_backend_info(&info));
|
|
if (info.kind != oak_render_backend_vulkan) {
|
|
GTEST_SKIP() << "Vulkan backend is not available on this system";
|
|
}
|
|
|
|
ASSERT_TRUE(renderer.init());
|
|
renderer.post_init();
|
|
|
|
const int k_size = 64;
|
|
olive::VideoParams params(k_size, k_size, olive::PixelFormat::u8,
|
|
olive::VideoParams::k_rgba_channel_count);
|
|
|
|
olive::TexturePtr src = renderer.create_texture(params);
|
|
ASSERT_NE(src, nullptr);
|
|
ASSERT_FALSE(src->is_dummy());
|
|
|
|
QByteArray src_data(k_size * k_size * 4, 0);
|
|
for (int i = 0; i < k_size * k_size; ++i) {
|
|
src_data[i * 4 + 0] = static_cast<char>(255); // R
|
|
src_data[i * 4 + 1] = static_cast<char>(0); // G
|
|
src_data[i * 4 + 2] = static_cast<char>(0); // B
|
|
src_data[i * 4 + 3] = static_cast<char>(255); // A
|
|
}
|
|
src->upload(src_data.data(), k_size);
|
|
|
|
olive::TexturePtr dst = renderer.create_texture(params);
|
|
ASSERT_NE(dst, nullptr);
|
|
ASSERT_FALSE(dst->is_dummy());
|
|
|
|
const QString vert =
|
|
QStringLiteral("uniform mat4 ove_mvpmat;\n"
|
|
"in vec4 a_position;\n"
|
|
"in vec2 a_texcoord;\n"
|
|
"out vec2 ove_texcoord;\n"
|
|
"void main() {\n"
|
|
" gl_Position = ove_mvpmat * a_position;\n"
|
|
" ove_texcoord = a_texcoord;\n"
|
|
"}\n");
|
|
const QString frag =
|
|
QStringLiteral("uniform sampler2D ove_maintex;\n"
|
|
"in vec2 ove_texcoord;\n"
|
|
"out vec4 frag_color;\n"
|
|
"void main() {\n"
|
|
" frag_color = texture(ove_maintex, ove_texcoord);\n"
|
|
"}\n");
|
|
QVariant shader =
|
|
renderer.create_native_shader(olive::ShaderCode(frag, vert));
|
|
ASSERT_FALSE(shader.isNull());
|
|
|
|
olive::ShaderJob job;
|
|
job.insert(QStringLiteral("ove_maintex"),
|
|
olive::NodeValue(olive::NodeValue::k_texture,
|
|
QVariant::fromValue(src)));
|
|
job.insert(QStringLiteral("ove_mvpmat"),
|
|
olive::NodeValue(olive::NodeValue::k_matrix, QMatrix4x4()));
|
|
|
|
renderer.blit_to_texture(shader, job, dst.get(), true);
|
|
|
|
QByteArray dst_data(k_size * k_size * 4, 0);
|
|
dst->download(dst_data.data(), k_size);
|
|
|
|
// The default pass-through shader should reproduce the red source pixel.
|
|
EXPECT_EQ(static_cast<uint8_t>(dst_data[0]), 255u);
|
|
EXPECT_EQ(static_cast<uint8_t>(dst_data[1]), 0u);
|
|
EXPECT_EQ(static_cast<uint8_t>(dst_data[2]), 0u);
|
|
EXPECT_EQ(static_cast<uint8_t>(dst_data[3]), 255u);
|
|
#endif
|
|
}
|
|
|
|
// Ensures the Vulkan backend handles null-destination blits by rendering to a
|
|
// temporary offscreen target instead of dereferencing a missing framebuffer.
|
|
TEST(DynamicRenderBackend, VulkanNullDestinationBlitDoesNotCrash)
|
|
{
|
|
#ifndef OAK_ENABLE_DYNAMIC_RENDER_BACKEND
|
|
GTEST_SKIP() << "Dynamic render backend is not enabled in this build";
|
|
#else
|
|
olive::DynamicRenderer renderer(QStringLiteral("vulkan"));
|
|
if (!renderer.load()) {
|
|
GTEST_SKIP()
|
|
<< "vulkan backend library could not be loaded in this environment";
|
|
}
|
|
|
|
OakRenderBackendInfo info = {};
|
|
ASSERT_TRUE(renderer.get_backend_info(&info));
|
|
if (info.kind != oak_render_backend_vulkan) {
|
|
GTEST_SKIP() << "Vulkan backend is not available on this system";
|
|
}
|
|
|
|
ASSERT_TRUE(renderer.init());
|
|
renderer.post_init();
|
|
|
|
const int k_size = 32;
|
|
olive::VideoParams params(k_size, k_size, olive::PixelFormat::u8,
|
|
olive::VideoParams::k_rgba_channel_count);
|
|
|
|
olive::TexturePtr src = renderer.create_texture(params);
|
|
ASSERT_NE(src, nullptr);
|
|
ASSERT_FALSE(src->is_dummy());
|
|
|
|
QByteArray src_data(k_size * k_size * 4, 0);
|
|
for (int i = 0; i < k_size * k_size; ++i) {
|
|
src_data[i * 4 + 0] = static_cast<char>(255);
|
|
src_data[i * 4 + 3] = static_cast<char>(255);
|
|
}
|
|
src->upload(src_data.data(), k_size);
|
|
|
|
const QString vert =
|
|
QStringLiteral("uniform mat4 ove_mvpmat;\n"
|
|
"in vec4 a_position;\n"
|
|
"in vec2 a_texcoord;\n"
|
|
"out vec2 ove_texcoord;\n"
|
|
"void main() {\n"
|
|
" gl_Position = ove_mvpmat * a_position;\n"
|
|
" ove_texcoord = a_texcoord;\n"
|
|
"}\n");
|
|
const QString frag =
|
|
QStringLiteral("uniform sampler2D ove_maintex;\n"
|
|
"in vec2 ove_texcoord;\n"
|
|
"out vec4 frag_color;\n"
|
|
"void main() {\n"
|
|
" frag_color = texture(ove_maintex, ove_texcoord);\n"
|
|
"}\n");
|
|
QVariant shader =
|
|
renderer.create_native_shader(olive::ShaderCode(frag, vert));
|
|
ASSERT_FALSE(shader.isNull());
|
|
|
|
olive::ShaderJob job;
|
|
job.insert(QStringLiteral("ove_maintex"),
|
|
olive::NodeValue(olive::NodeValue::k_texture,
|
|
QVariant::fromValue(src)));
|
|
job.insert(QStringLiteral("ove_mvpmat"),
|
|
olive::NodeValue(olive::NodeValue::k_matrix, QMatrix4x4()));
|
|
|
|
// Null-destination Blit has no render target; it should simply not crash.
|
|
renderer.blit(shader, job, params, true);
|
|
SUCCEED();
|
|
#endif
|
|
}
|
|
|
|
// Verifies iterative shader support: the first pass writes to a temporary
|
|
// texture and the second pass samples it before writing the final destination.
|
|
TEST(DynamicRenderBackend, VulkanIterativeBlitPingPong)
|
|
{
|
|
#ifndef OAK_ENABLE_DYNAMIC_RENDER_BACKEND
|
|
GTEST_SKIP() << "Dynamic render backend is not enabled in this build";
|
|
#else
|
|
olive::DynamicRenderer renderer(QStringLiteral("vulkan"));
|
|
if (!renderer.load()) {
|
|
GTEST_SKIP()
|
|
<< "vulkan backend library could not be loaded in this environment";
|
|
}
|
|
|
|
OakRenderBackendInfo info = {};
|
|
ASSERT_TRUE(renderer.get_backend_info(&info));
|
|
if (info.kind != oak_render_backend_vulkan) {
|
|
GTEST_SKIP() << "Vulkan backend is not available on this system";
|
|
}
|
|
|
|
ASSERT_TRUE(renderer.init());
|
|
renderer.post_init();
|
|
|
|
const int k_size = 32;
|
|
olive::VideoParams params(k_size, k_size, olive::PixelFormat::u8,
|
|
olive::VideoParams::k_rgba_channel_count);
|
|
|
|
olive::TexturePtr src = renderer.create_texture(params);
|
|
ASSERT_NE(src, nullptr);
|
|
ASSERT_FALSE(src->is_dummy());
|
|
|
|
// Start with a fully red texture.
|
|
QByteArray src_data(k_size * k_size * 4, 0);
|
|
for (int i = 0; i < k_size * k_size; ++i) {
|
|
src_data[i * 4 + 0] = static_cast<char>(255);
|
|
src_data[i * 4 + 3] = static_cast<char>(255);
|
|
}
|
|
src->upload(src_data.data(), k_size);
|
|
|
|
olive::TexturePtr dst = renderer.create_texture(params);
|
|
ASSERT_NE(dst, nullptr);
|
|
ASSERT_FALSE(dst->is_dummy());
|
|
|
|
// Shader that samples the iterative input and scales RGB by 0.5 each pass.
|
|
const QString vert =
|
|
QStringLiteral("uniform mat4 ove_mvpmat;\n"
|
|
"in vec4 a_position;\n"
|
|
"in vec2 a_texcoord;\n"
|
|
"out vec2 ove_texcoord;\n"
|
|
"void main() {\n"
|
|
" gl_Position = ove_mvpmat * a_position;\n"
|
|
" ove_texcoord = a_texcoord;\n"
|
|
"}\n");
|
|
const QString frag =
|
|
QStringLiteral("uniform sampler2D ove_maintex;\n"
|
|
"in vec2 ove_texcoord;\n"
|
|
"out vec4 frag_color;\n"
|
|
"void main() {\n"
|
|
" vec4 c = texture(ove_maintex, ove_texcoord);\n"
|
|
" frag_color = vec4(c.rgb * 0.5, c.a);\n"
|
|
"}\n");
|
|
QVariant shader =
|
|
renderer.create_native_shader(olive::ShaderCode(frag, vert));
|
|
ASSERT_FALSE(shader.isNull());
|
|
|
|
olive::ShaderJob job;
|
|
job.insert(QStringLiteral("ove_maintex"),
|
|
olive::NodeValue(olive::NodeValue::k_texture,
|
|
QVariant::fromValue(src)));
|
|
job.insert(QStringLiteral("ove_mvpmat"),
|
|
olive::NodeValue(olive::NodeValue::k_matrix, QMatrix4x4()));
|
|
job.set_iterations(2, QStringLiteral("ove_maintex"));
|
|
|
|
renderer.blit_to_texture(shader, job, dst.get(), true);
|
|
|
|
QByteArray dst_data(k_size * k_size * 4, 0);
|
|
dst->download(dst_data.data(), k_size);
|
|
|
|
// After two halving passes, red is 255 * 0.5 * 0.5. UNORM conversion floors
|
|
// the intermediate value, so the result is 63 rather than 64.
|
|
EXPECT_EQ(static_cast<uint8_t>(dst_data[0]), 63u);
|
|
EXPECT_EQ(static_cast<uint8_t>(dst_data[1]), 0u);
|
|
EXPECT_EQ(static_cast<uint8_t>(dst_data[2]), 0u);
|
|
EXPECT_EQ(static_cast<uint8_t>(dst_data[3]), 255u);
|
|
#endif
|
|
}
|
|
|
|
// Verifies RGB upload/download when the Vulkan driver stores the texture in a
|
|
// wider renderable format such as RGBA.
|
|
TEST(DynamicRenderBackend, VulkanUploadDownloadThreeChannel)
|
|
{
|
|
#ifndef OAK_ENABLE_DYNAMIC_RENDER_BACKEND
|
|
GTEST_SKIP() << "Dynamic render backend is not enabled in this build";
|
|
#else
|
|
olive::DynamicRenderer renderer(QStringLiteral("vulkan"));
|
|
if (!renderer.load()) {
|
|
GTEST_SKIP()
|
|
<< "vulkan backend library could not be loaded in this environment";
|
|
}
|
|
|
|
OakRenderBackendInfo info = {};
|
|
ASSERT_TRUE(renderer.get_backend_info(&info));
|
|
if (info.kind != oak_render_backend_vulkan) {
|
|
GTEST_SKIP() << "Vulkan backend is not available on this system";
|
|
}
|
|
|
|
ASSERT_TRUE(renderer.init());
|
|
renderer.post_init();
|
|
|
|
const int k_size = 16;
|
|
olive::VideoParams params(k_size, k_size, olive::PixelFormat::u8,
|
|
olive::VideoParams::k_rgb_channel_count);
|
|
|
|
olive::TexturePtr tex = renderer.create_texture(params);
|
|
ASSERT_NE(tex, nullptr);
|
|
ASSERT_FALSE(tex->is_dummy());
|
|
|
|
QByteArray src_data(k_size * k_size * 3, 0);
|
|
for (int i = 0; i < k_size * k_size; ++i) {
|
|
src_data[i * 3 + 0] = static_cast<char>(255);
|
|
src_data[i * 3 + 1] = static_cast<char>(128);
|
|
src_data[i * 3 + 2] = static_cast<char>(64);
|
|
}
|
|
tex->upload(src_data.data(), k_size);
|
|
|
|
QByteArray dst_data(k_size * k_size * 3, 0);
|
|
tex->download(dst_data.data(), k_size);
|
|
|
|
EXPECT_EQ(static_cast<uint8_t>(dst_data[0]), 255u);
|
|
EXPECT_EQ(static_cast<uint8_t>(dst_data[1]), 128u);
|
|
EXPECT_EQ(static_cast<uint8_t>(dst_data[2]), 64u);
|
|
#endif
|
|
}
|