// Unit tests for EffectChain.
+//
+// Note that this also contains the tests for some of the simpler effects.
#include "effect_chain.h"
#include "flat_input.h"
-#include "sandbox_effect.h"
-#include "opengl.h"
#include "gtest/gtest.h"
+#include "mirror_effect.h"
+#include "resize_effect.h"
+#include "opengl.h"
+#include "test_util.h"
-#include <stdio.h>
-#include <math.h>
+TEST(EffectChainTest, EmptyChain) {
+ float data[] = {
+ 0.0f, 0.25f, 0.3f,
+ 0.75f, 1.0f, 1.0f,
+ };
+ float out_data[6];
+ EffectChainTester tester(data, 3, 2, FORMAT_GRAYSCALE, COLORSPACE_sRGB, GAMMA_LINEAR);
+ tester.run(out_data, GL_RED, COLORSPACE_sRGB, GAMMA_LINEAR);
-#include <algorithm>
+ expect_equal(data, out_data, 3, 2);
+}
-class EffectChainTester {
+// An effect that does nothing.
+class IdentityEffect : public Effect {
public:
- EffectChainTester(const float *data, unsigned width, unsigned height, ColorSpace color_space, GammaCurve gamma_curve)
- : chain(width, height), width(width), height(height)
- {
- ImageFormat format;
- format.color_space = color_space;
- format.gamma_curve = gamma_curve;
-
- FlatInput *input = new FlatInput(format, FORMAT_GRAYSCALE, GL_FLOAT, width, height);
- input->set_pixel_data(data);
- chain.add_input(input);
- }
+ IdentityEffect() {}
+ virtual std::string effect_type_id() const { return "IdentityEffect"; }
+ std::string output_fragment_shader() { return read_file("identity.frag"); }
+};
- EffectChain *get_chain() { return &chain; }
+TEST(EffectChainTest, Identity) {
+ float data[] = {
+ 0.0f, 0.25f, 0.3f,
+ 0.75f, 1.0f, 1.0f,
+ };
+ float out_data[6];
+ EffectChainTester tester(data, 3, 2, FORMAT_GRAYSCALE, COLORSPACE_sRGB, GAMMA_LINEAR);
+ tester.get_chain()->add_effect(new IdentityEffect());
+ tester.run(out_data, GL_RED, COLORSPACE_sRGB, GAMMA_LINEAR);
- void run(float *out_data, ColorSpace color_space, GammaCurve gamma_curve)
- {
- ImageFormat format;
- format.color_space = color_space;
- format.gamma_curve = gamma_curve;
- chain.add_output(format);
- chain.finalize();
-
- glViewport(0, 0, width, height);
- chain.render_to_screen();
-
- glReadPixels(0, 0, width, height, GL_RED, GL_FLOAT, out_data);
-
- // Flip upside-down to compensate for different origin.
- for (unsigned y = 0; y < height / 2; ++y) {
- unsigned flip_y = height - y - 1;
- for (unsigned x = 0; x < width; ++x) {
- std::swap(out_data[y * width + x], out_data[flip_y * width + x]);
- }
- }
- }
+ expect_equal(data, out_data, 3, 2);
+}
+
+// An effect that does nothing, but requests texture bounce.
+class BouncingIdentityEffect : public Effect {
+public:
+ BouncingIdentityEffect() {}
+ virtual std::string effect_type_id() const { return "IdentityEffect"; }
+ std::string output_fragment_shader() { return read_file("identity.frag"); }
+ bool needs_texture_bounce() const { return true; }
+};
+
+TEST(EffectChainTest, TextureBouncePreservesIdentity) {
+ float data[] = {
+ 0.0f, 0.25f, 0.3f,
+ 0.75f, 1.0f, 1.0f,
+ };
+ float out_data[6];
+ EffectChainTester tester(data, 3, 2, FORMAT_GRAYSCALE, COLORSPACE_sRGB, GAMMA_LINEAR);
+ tester.get_chain()->add_effect(new BouncingIdentityEffect());
+ tester.run(out_data, GL_RED, COLORSPACE_sRGB, GAMMA_LINEAR);
+
+ expect_equal(data, out_data, 3, 2);
+}
-private:
- EffectChain chain;
- unsigned width, height;
+TEST(MirrorTest, BasicTest) {
+ float data[] = {
+ 0.0f, 0.25f, 0.3f,
+ 0.75f, 1.0f, 1.0f,
+ };
+ float expected_data[6] = {
+ 0.3f, 0.25f, 0.0f,
+ 1.0f, 1.0f, 0.75f,
+ };
+ float out_data[6];
+ EffectChainTester tester(data, 3, 2, FORMAT_GRAYSCALE, COLORSPACE_sRGB, GAMMA_LINEAR);
+ tester.get_chain()->add_effect(new MirrorEffect());
+ tester.run(out_data, GL_RED, COLORSPACE_sRGB, GAMMA_LINEAR);
+
+ expect_equal(expected_data, out_data, 3, 2);
+}
+
+// A dummy effect that inverts its input.
+class InvertEffect : public Effect {
+public:
+ InvertEffect() {}
+ virtual std::string effect_type_id() const { return "InvertEffect"; }
+ std::string output_fragment_shader() { return read_file("invert_effect.frag"); }
};
-void expect_equal(const float *ref, const float *result, unsigned width, unsigned height)
-{
- float largest_difference = -1.0f;
- float squared_difference = 0.0f;
-
- for (unsigned y = 0; y < height; ++y) {
- for (unsigned x = 0; x < width; ++x) {
- float diff = ref[y * width + x] - result[y * width + x];
- largest_difference = std::max(largest_difference, fabsf(diff));
- squared_difference += diff * diff;
- }
+// Like IdentityEffect, but rewrites itself out of the loop,
+// splicing in a InvertEffect instead. Also stores the new node,
+// so we later can check that there are gamma conversion effects
+// on both sides.
+class RewritingToInvertEffect : public Effect {
+public:
+ RewritingToInvertEffect() {}
+ virtual std::string effect_type_id() const { return "RewritingToInvertEffect"; }
+ std::string output_fragment_shader() { EXPECT_TRUE(false); return read_file("identity.frag"); }
+ virtual void rewrite_graph(EffectChain *graph, Node *self) {
+ Node *invert_node = graph->add_node(new InvertEffect());
+ graph->replace_receiver(self, invert_node);
+ graph->replace_sender(self, invert_node);
+
+ self->disabled = true;
+ this->invert_node = invert_node;
}
- const float largest_difference_limit = 1.5 / 255.0;
- const float rms_limit = 0.5 / 255.0;
+ Node *invert_node;
+};
- EXPECT_LT(largest_difference, largest_difference_limit);
+TEST(EffectChainTest, RewritingWorksAndGammaConversionsAreInserted) {
+ float data[] = {
+ 0.0f, 0.25f, 0.3f,
+ 0.75f, 1.0f, 1.0f,
+ };
+ float expected_data[6] = {
+ 1.0f, 0.9771f, 0.9673f,
+ 0.7192f, 0.0f, 0.0f,
+ };
+ float out_data[6];
+ EffectChainTester tester(data, 3, 2, FORMAT_GRAYSCALE, COLORSPACE_sRGB, GAMMA_sRGB);
+ RewritingToInvertEffect *effect = new RewritingToInvertEffect();
+ tester.get_chain()->add_effect(effect);
+ tester.run(out_data, GL_RED, COLORSPACE_sRGB, GAMMA_sRGB);
- float rms = sqrt(squared_difference) / (width * height);
- EXPECT_LT(rms, rms_limit);
+ Node *node = effect->invert_node;
+ ASSERT_EQ(1, node->incoming_links.size());
+ ASSERT_EQ(1, node->outgoing_links.size());
+ EXPECT_EQ("GammaExpansionEffect", node->incoming_links[0]->effect->effect_type_id());
+ EXPECT_EQ("GammaCompressionEffect", node->outgoing_links[0]->effect->effect_type_id());
- if (largest_difference >= largest_difference_limit || rms >= rms_limit) {
- fprintf(stderr, "Dumping matrices for easier debugging, since at least one test failed.\n");
+ expect_equal(expected_data, out_data, 3, 2);
+}
- fprintf(stderr, "Reference:\n");
- for (unsigned y = 0; y < height; ++y) {
- for (unsigned x = 0; x < width; ++x) {
- fprintf(stderr, "%7.4f ", ref[y * width + x]);
- }
- fprintf(stderr, "\n");
- }
+TEST(EffectChainTest, RewritingWorksAndColorspaceConversionsAreInserted) {
+ float data[] = {
+ 0.0f, 0.25f, 0.3f,
+ 0.75f, 1.0f, 1.0f,
+ };
+ float expected_data[6] = {
+ 1.0f, 0.75f, 0.7f,
+ 0.25f, 0.0f, 0.0f,
+ };
+ float out_data[6];
+ EffectChainTester tester(data, 3, 2, FORMAT_GRAYSCALE, COLORSPACE_REC_601_525, GAMMA_LINEAR);
+ RewritingToInvertEffect *effect = new RewritingToInvertEffect();
+ tester.get_chain()->add_effect(effect);
+ tester.run(out_data, GL_RED, COLORSPACE_REC_601_525, GAMMA_LINEAR);
+
+ Node *node = effect->invert_node;
+ ASSERT_EQ(1, node->incoming_links.size());
+ ASSERT_EQ(1, node->outgoing_links.size());
+ EXPECT_EQ("ColorSpaceConversionEffect", node->incoming_links[0]->effect->effect_type_id());
+ EXPECT_EQ("ColorSpaceConversionEffect", node->outgoing_links[0]->effect->effect_type_id());
+
+ expect_equal(expected_data, out_data, 3, 2);
+}
+
+// Like RewritingToInvertEffect, but splicing in a MirrorEffect instead,
+// which does not need linear light or sRGB primaries.
+class RewritingToMirrorEffect : public Effect {
+public:
+ RewritingToMirrorEffect() {}
+ virtual std::string effect_type_id() const { return "RewritingToMirrorEffect"; }
+ std::string output_fragment_shader() { EXPECT_TRUE(false); return read_file("identity.frag"); }
+ virtual void rewrite_graph(EffectChain *graph, Node *self) {
+ Node *mirror_node = graph->add_node(new MirrorEffect());
+ graph->replace_receiver(self, mirror_node);
+ graph->replace_sender(self, mirror_node);
- fprintf(stderr, "\nResult:\n");
- for (unsigned y = 0; y < height; ++y) {
- for (unsigned x = 0; x < width; ++x) {
- fprintf(stderr, "%7.4f ", result[y * width + x]);
- }
- fprintf(stderr, "\n");
- }
+ self->disabled = true;
+ this->mirror_node = mirror_node;
}
+
+ Node *mirror_node;
+};
+
+TEST(EffectChainTest, NoGammaConversionsWhenLinearLightNotNeeded) {
+ float data[] = {
+ 0.0f, 0.25f, 0.3f,
+ 0.75f, 1.0f, 1.0f,
+ };
+ float expected_data[6] = {
+ 0.3f, 0.25f, 0.0f,
+ 1.0f, 1.0f, 0.75f,
+ };
+ float out_data[6];
+ EffectChainTester tester(data, 3, 2, FORMAT_GRAYSCALE, COLORSPACE_sRGB, GAMMA_sRGB);
+ RewritingToMirrorEffect *effect = new RewritingToMirrorEffect();
+ tester.get_chain()->add_effect(effect);
+ tester.run(out_data, GL_RED, COLORSPACE_sRGB, GAMMA_sRGB);
+
+ Node *node = effect->mirror_node;
+ ASSERT_EQ(1, node->incoming_links.size());
+ EXPECT_EQ(0, node->outgoing_links.size());
+ EXPECT_EQ("FlatInput", node->incoming_links[0]->effect->effect_type_id());
+
+ expect_equal(expected_data, out_data, 3, 2);
}
-TEST(EffectChainTest, Identity) {
+TEST(EffectChainTest, NoColorspaceConversionsWhensRGBPrimariesNotNeeded) {
float data[] = {
0.0f, 0.25f, 0.3f,
0.75f, 1.0f, 1.0f,
};
+ float expected_data[6] = {
+ 0.3f, 0.25f, 0.0f,
+ 1.0f, 1.0f, 0.75f,
+ };
float out_data[6];
- EffectChainTester tester(data, 3, 2, COLORSPACE_sRGB, GAMMA_LINEAR);
- tester.run(out_data, COLORSPACE_sRGB, GAMMA_LINEAR);
+ EffectChainTester tester(data, 3, 2, FORMAT_GRAYSCALE, COLORSPACE_REC_601_525, GAMMA_LINEAR);
+ RewritingToMirrorEffect *effect = new RewritingToMirrorEffect();
+ tester.get_chain()->add_effect(effect);
+ tester.run(out_data, GL_RED, COLORSPACE_REC_601_525, GAMMA_LINEAR);
- expect_equal(data, out_data, 3, 2);
+ Node *node = effect->mirror_node;
+ ASSERT_EQ(1, node->incoming_links.size());
+ EXPECT_EQ(0, node->outgoing_links.size());
+ EXPECT_EQ("FlatInput", node->incoming_links[0]->effect->effect_type_id());
+
+ expect_equal(expected_data, out_data, 3, 2);
+}
+
+// The identity effect needs linear light, and thus will get conversions on both sides.
+// Verify that sRGB data is properly converted to and from linear light for the entire ramp.
+TEST(EffectChainTest, IdentityThroughsRGBConversions) {
+ float data[256];
+ for (unsigned i = 0; i < 256; ++i) {
+ data[i] = i / 255.0;
+ };
+ float out_data[256];
+ EffectChainTester tester(data, 256, 1, FORMAT_GRAYSCALE, COLORSPACE_sRGB, GAMMA_sRGB);
+ tester.get_chain()->add_effect(new IdentityEffect());
+ tester.run(out_data, GL_RED, COLORSPACE_sRGB, GAMMA_sRGB);
+
+ expect_equal(data, out_data, 256, 1);
+}
+
+// Same, for the Rec. 601/709 gamma curve.
+TEST(EffectChainTest, IdentityThroughRec709) {
+ float data[256];
+ for (unsigned i = 0; i < 256; ++i) {
+ data[i] = i / 255.0;
+ };
+ float out_data[256];
+ EffectChainTester tester(data, 256, 1, FORMAT_GRAYSCALE, COLORSPACE_sRGB, GAMMA_REC_709);
+ tester.get_chain()->add_effect(new IdentityEffect());
+ tester.run(out_data, GL_RED, COLORSPACE_sRGB, GAMMA_REC_709);
+
+ expect_equal(data, out_data, 256, 1);
+}
+
+// Effectively scales down its input linearly by 4x (and repeating it),
+// which is not attainable without mipmaps.
+class MipmapNeedingEffect : public Effect {
+public:
+ MipmapNeedingEffect() {}
+ virtual bool needs_mipmaps() const { return true; }
+ virtual std::string effect_type_id() const { return "MipmapNeedingEffect"; }
+ std::string output_fragment_shader() { return read_file("mipmap_needing_effect.frag"); }
+ void set_gl_state(GLuint glsl_program_num, const std::string& prefix, unsigned *sampler_num)
+ {
+ glActiveTexture(GL_TEXTURE0);
+ check_error();
+ glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_REPEAT);
+ check_error();
+ glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_REPEAT);
+ check_error();
+ }
+};
+
+TEST(EffectChainTest, MipmapGenerationWorks) {
+ float data[] = { // In 4x4 blocks.
+ 1.0f, 0.0f, 0.0f, 0.0f,
+ 0.0f, 0.0f, 0.0f, 0.0f,
+ 0.0f, 0.0f, 0.0f, 0.0f,
+ 0.0f, 0.0f, 0.0f, 1.0f,
+
+ 0.0f, 0.0f, 0.0f, 0.0f,
+ 0.0f, 0.5f, 0.0f, 0.0f,
+ 0.0f, 0.0f, 1.0f, 0.0f,
+ 0.0f, 0.0f, 0.0f, 0.0f,
+
+ 1.0f, 1.0f, 1.0f, 1.0f,
+ 1.0f, 1.0f, 1.0f, 1.0f,
+ 1.0f, 1.0f, 1.0f, 1.0f,
+ 1.0f, 1.0f, 1.0f, 1.0f,
+
+ 0.0f, 0.0f, 0.0f, 0.0f,
+ 0.0f, 1.0f, 1.0f, 0.0f,
+ 0.0f, 1.0f, 1.0f, 0.0f,
+ 0.0f, 0.0f, 0.0f, 0.0f,
+ };
+ float expected_data[] = { // Repeated four times each way.
+ 0.125f, 0.125f, 0.125f, 0.125f,
+ 0.09375f, 0.09375f, 0.09375f, 0.09375f,
+ 1.0f, 1.0f, 1.0f, 1.0f,
+ 0.25f, 0.25f, 0.25f, 0.25f,
+
+ 0.125f, 0.125f, 0.125f, 0.125f,
+ 0.09375f, 0.09375f, 0.09375f, 0.09375f,
+ 1.0f, 1.0f, 1.0f, 1.0f,
+ 0.25f, 0.25f, 0.25f, 0.25f,
+
+ 0.125f, 0.125f, 0.125f, 0.125f,
+ 0.09375f, 0.09375f, 0.09375f, 0.09375f,
+ 1.0f, 1.0f, 1.0f, 1.0f,
+ 0.25f, 0.25f, 0.25f, 0.25f,
+
+ 0.125f, 0.125f, 0.125f, 0.125f,
+ 0.09375f, 0.09375f, 0.09375f, 0.09375f,
+ 1.0f, 1.0f, 1.0f, 1.0f,
+ 0.25f, 0.25f, 0.25f, 0.25f,
+ };
+ float out_data[4 * 16];
+ EffectChainTester tester(data, 4, 16, FORMAT_GRAYSCALE, COLORSPACE_sRGB, GAMMA_LINEAR);
+ tester.get_chain()->add_effect(new MipmapNeedingEffect());
+ tester.run(out_data, GL_RED, COLORSPACE_sRGB, GAMMA_LINEAR);
+
+ expect_equal(expected_data, out_data, 4, 16);
+}
+
+TEST(EffectChainTest, ResizeDownByFourThenUpByFour) {
+ float data[] = { // In 4x4 blocks.
+ 1.0f, 0.0f, 0.0f, 0.0f,
+ 0.0f, 0.0f, 0.0f, 0.0f,
+ 0.0f, 0.0f, 0.0f, 0.0f,
+ 0.0f, 0.0f, 0.0f, 1.0f,
+
+ 0.0f, 0.0f, 0.0f, 0.0f,
+ 0.0f, 0.5f, 0.0f, 0.0f,
+ 0.0f, 0.0f, 1.0f, 0.0f,
+ 0.0f, 0.0f, 0.0f, 0.0f,
+
+ 1.0f, 1.0f, 1.0f, 1.0f,
+ 1.0f, 1.0f, 1.0f, 1.0f,
+ 1.0f, 1.0f, 1.0f, 1.0f,
+ 1.0f, 1.0f, 1.0f, 1.0f,
+
+ 0.0f, 0.0f, 0.0f, 0.0f,
+ 0.0f, 1.0f, 1.0f, 0.0f,
+ 0.0f, 1.0f, 1.0f, 0.0f,
+ 0.0f, 0.0f, 0.0f, 0.0f,
+ };
+ float expected_data[] = { // Repeated four times horizontaly, interpolated vertically.
+ 0.1250f, 0.1250f, 0.1250f, 0.1250f,
+ 0.1250f, 0.1250f, 0.1250f, 0.1250f,
+ 0.1211f, 0.1211f, 0.1211f, 0.1211f,
+ 0.1133f, 0.1133f, 0.1133f, 0.1133f,
+ 0.1055f, 0.1055f, 0.1055f, 0.1055f,
+ 0.0977f, 0.0977f, 0.0977f, 0.0977f,
+ 0.2070f, 0.2070f, 0.2070f, 0.2070f,
+ 0.4336f, 0.4336f, 0.4336f, 0.4336f,
+ 0.6602f, 0.6602f, 0.6602f, 0.6602f,
+ 0.8867f, 0.8867f, 0.8867f, 0.8867f,
+ 0.9062f, 0.9062f, 0.9062f, 0.9062f,
+ 0.7188f, 0.7188f, 0.7188f, 0.7188f,
+ 0.5312f, 0.5312f, 0.5312f, 0.5312f,
+ 0.3438f, 0.3438f, 0.3438f, 0.3438f,
+ 0.2500f, 0.2500f, 0.2500f, 0.2500f,
+ 0.2500f, 0.2500f, 0.2500f, 0.2500f,
+ };
+ float out_data[4 * 16];
+
+ ResizeEffect *downscale = new ResizeEffect();
+ ASSERT_TRUE(downscale->set_int("width", 1));
+ ASSERT_TRUE(downscale->set_int("height", 4));
+
+ ResizeEffect *upscale = new ResizeEffect();
+ ASSERT_TRUE(upscale->set_int("width", 4));
+ ASSERT_TRUE(upscale->set_int("height", 16));
+
+ EffectChainTester tester(data, 4, 16, FORMAT_GRAYSCALE, COLORSPACE_sRGB, GAMMA_LINEAR);
+ tester.get_chain()->add_effect(downscale);
+ tester.get_chain()->add_effect(upscale);
+ tester.run(out_data, GL_RED, COLORSPACE_sRGB, GAMMA_LINEAR);
+
+ expect_equal(expected_data, out_data, 4, 16);
}