voxelforge/tests/testTileTexture.cpp

#include <cstdio>
#include <set>
#include <vector>

#include "testHarness.h"
#include "vf/Block.h"
#include "vf/TileTexture.h"

using namespace vf;

namespace {

int luminance(TilePixel texel) {
    return (texel.r * 299 + texel.g * 587 + texel.b * 114) / 1000;
}

int colourDistance(TilePixel texel, TileRgb reference) {
    int dr = static_cast<int>(texel.r) - reference.r;
    int dg = static_cast<int>(texel.g) - reference.g;
    int db = static_cast<int>(texel.b) - reference.b;
    return dr * dr + dg * dg + db * db;
}

bool leansToAccent(TilePixel texel, const TileSpec& spec) {
    return colourDistance(texel, spec.accent) < colourDistance(texel, spec.base);
}

// The palette owns how many tiles exist. A table short of a row must surface as
// a reported failure, not as a read past the end of the table proving it.
int renderedTiles(const TileSampler& sampler) {
    int held = sampler.palette().size();
    return held < tileCount ? held : tileCount;
}

std::vector<uint8_t> renderTile(const TileSampler& sampler, int tile) {
    int size = sampler.params().tileSize;
    std::vector<uint8_t> bytes(static_cast<std::size_t>(size) * size * 4);
    sampler.writeTile(tile, bytes.data());
    return bytes;
}

std::vector<uint8_t> renderAtlas(const TileSampler& sampler, bool backwards) {
    int size = sampler.params().tileSize;
    std::size_t tileBytes = static_cast<std::size_t>(size) * size * 4;
    int held = renderedTiles(sampler);
    std::vector<uint8_t> bytes(tileBytes * static_cast<std::size_t>(held));
    if (backwards) {
        for (int tile = held - 1; tile >= 0; --tile) {
            sampler.writeTile(tile, bytes.data() + tileBytes * static_cast<std::size_t>(tile));
        }
    } else {
        for (int tile = 0; tile < held; ++tile) {
            sampler.writeTile(tile, bytes.data() + tileBytes * static_cast<std::size_t>(tile));
        }
    }
    return bytes;
}

// The first row and column carry a deliberate edge darkening, which would hand
// every tile a luminance spread for free. Contrast is therefore only ever
// measured inside that border.
struct LuminanceRange {
    int lowest = 255;
    int highest = 0;
    int spread() const { return highest - lowest; }
};

LuminanceRange interiorRange(const TileSampler& sampler, int tile) {
    LuminanceRange range;
    int size = sampler.params().tileSize;
    for (int y = 1; y < size; ++y) {
        for (int x = 1; x < size; ++x) {
            int value = luminance(sampler.pixelAt(tile, x, y));
            if (value < range.lowest) range.lowest = value;
            if (value > range.highest) range.highest = value;
        }
    }
    return range;
}

TileSpec withoutGrain(TileSpec spec) {
    spec.noise = 0.0f;
    return spec;
}

// Columns in one row that the pattern painted with the accent colour. For a
// brick tile those are the vertical mortar joints.
std::vector<int> accentColumns(const TileSampler& sampler, const TileSpec& spec, int tileSalt,
                               int y) {
    std::vector<int> columns;
    for (int x = 0; x < sampler.params().tileSize; ++x) {
        if (leansToAccent(sampler.pixelOf(spec, tileSalt, x, y), spec)) columns.push_back(x);
    }
    return columns;
}

// A brick course is offset from the one above it, so the set of mortar columns
// has to differ between courses. Rows that are entirely mortar are the
// horizontal joints and say nothing about the offset.
int distinctJointLayouts(const TileSampler& sampler, const TileSpec& spec, int tileSalt) {
    int size = sampler.params().tileSize;
    std::set<std::vector<int>> layouts;
    for (int y = 0; y < size; ++y) {
        std::vector<int> columns = accentColumns(sampler, spec, tileSalt, y);
        if (columns.empty()) continue;
        if (static_cast<int>(columns.size()) > size / 2) continue;
        layouts.insert(columns);
    }
    return static_cast<int>(layouts.size());
}

TileSpec syntheticBrick() {
    TileSpec spec;
    spec.name = "syntheticBrick";
    spec.pattern = TilePattern::Brick;
    spec.material = TileMaterial::Stone;
    spec.base = TileRgb{30, 30, 30};
    spec.accent = TileRgb{240, 240, 240};
    spec.noise = 0.0f;
    spec.scale = 0.40f;
    spec.density = 0.50f;
    return spec;
}

} // namespace

// Same params in, same bytes out. Anything that reached for a clock, a global
// counter or an uninitialised buffer would show up here first.
VF_TEST(renderingATileTwiceProducesIdenticalBytes) {
    TileSampler first;
    TileSampler second;
    CHECK_EQ(first.palette().size(), tileCount);
    for (int tile = 0; tile < renderedTiles(first); ++tile) {
        std::vector<uint8_t> a = renderTile(first, tile);
        std::vector<uint8_t> b = renderTile(second, tile);
        bool identical = a == b;
        CHECK(identical);
        if (!identical) std::printf("  tile %d is not reproducible\n", tile);
    }
}

// A tile must not care which tiles were generated before it. The atlas built
// back to front has to match the atlas built front to back byte for byte.
VF_TEST(theAtlasDoesNotDependOnTheOrderTilesAreGenerated) {
    TileSampler sampler;
    std::vector<uint8_t> forwards = renderAtlas(sampler, false);
    std::vector<uint8_t> backwards = renderAtlas(sampler, true);
    CHECK_EQ(forwards.size(), backwards.size());
    CHECK(forwards == backwards);
}

// The opaque pass draws without blending, so an opaque tile with a hole in it
// would put a stale colour on screen rather than a hole.
VF_TEST(opaqueTilesAreFullyOpaqueInEveryPixel) {
    TileSampler sampler;
    int size = sampler.params().tileSize;
    for (int tile = 0; tile < renderedTiles(sampler); ++tile) {
        if (sampler.palette().specFor(tile).cutout) continue;
        int transparent = 0;
        for (int y = 0; y < size; ++y) {
            for (int x = 0; x < size; ++x) {
                if (sampler.pixelAt(tile, x, y).a != 255) ++transparent;
            }
        }
        CHECK_EQ(transparent, 0);
        if (transparent != 0) {
            std::printf("  tile %d (%s) has %d see-through pixels\n", tile,
                        sampler.palette().specFor(tile).name, transparent);
        }
    }
}

// A cutout tile that is solid everywhere is not a shape, and one that is hollow
// everywhere is not a tile. Both ends have to be present in the alpha channel.
VF_TEST(cutoutTilesCarryBothHolesAndSolidPixels) {
    TileSampler sampler;
    int size = sampler.params().tileSize;
    int cutouts = 0;
    for (int tile = 0; tile < renderedTiles(sampler); ++tile) {
        const TileSpec& spec = sampler.palette().specFor(tile);
        if (!spec.cutout) continue;
        ++cutouts;
        int holes = 0;
        int solid = 0;
        for (int y = 0; y < size; ++y) {
            for (int x = 0; x < size; ++x) {
                uint8_t alpha = sampler.pixelAt(tile, x, y).a;
                if (alpha == 0) ++holes;
                if (alpha == 255) ++solid;
            }
        }
        CHECK(holes > 0);
        CHECK(solid > 0);
        CHECK_EQ(holes + solid, size * size);
        if (holes == 0 || solid == 0) {
            std::printf("  tile %d (%s): %d holes, %d solid\n", tile, spec.name, holes, solid);
        }
    }
    CHECK(cutouts >= 20);
}

// The failure this whole wave exists to stop: a tile that renders as one flat
// plate of colour. Measured on the interior so the edge darkening cannot pass a
// flat tile off as textured.
VF_TEST(everyTileVariesAcrossItsInterior) {
    TileSampler sampler;
    const int minimumSpread = 12;
    for (int tile = 0; tile < renderedTiles(sampler); ++tile) {
        LuminanceRange range = interiorRange(sampler, tile);
        CHECK(range.spread() >= minimumSpread);
        if (range.spread() < minimumSpread) {
            std::printf("  tile %d (%s) is flat: spread %d\n", tile,
                        sampler.palette().specFor(tile).name, range.spread());
        }
    }
}

// Brick courses are offset by half a brick. Without the offset every joint
// lines up and a brick wall reads as a grid, so the mortar columns of one
// course must not repeat in the next.
VF_TEST(brickCoursesShiftTheirJointsBetweenRows) {
    TileSampler sampler;
    TileSpec synthetic = syntheticBrick();
    int layouts = distinctJointLayouts(sampler, synthetic, 500);
    CHECK(layouts >= 2);
    if (layouts < 2) std::printf("  synthetic brick has %d joint layouts\n", layouts);

    // The two courses that actually sit next to each other, spelled out.
    std::vector<int> firstCourse = accentColumns(sampler, synthetic, 500, 2);
    std::vector<int> secondCourse = accentColumns(sampler, synthetic, 500, 6);
    CHECK(!firstCourse.empty());
    CHECK(!secondCourse.empty());
    CHECK(firstCourse != secondCourse);

    for (int tile = 0; tile < renderedTiles(sampler); ++tile) {
        const TileSpec& spec = sampler.palette().specFor(tile);
        if (spec.pattern != TilePattern::Brick) continue;
        int real = distinctJointLayouts(sampler, withoutGrain(spec), tile);
        CHECK(real >= 2);
        if (real < 2) std::printf("  tile %d (%s) has %d joint layouts\n", tile, spec.name, real);
    }
}

// Contrast is a real knob, not a field nobody reads: raising it has to widen
// what the tile actually puts on screen.
VF_TEST(raisingContrastWidensTheLuminanceRange) {
    TileTextureParams plain;
    TileTextureParams punchy;
    punchy.contrast = 2.0f;
    TileSampler flat(plain);
    TileSampler bold(punchy);

    int widened = 0;
    for (int tile = 0; tile < renderedTiles(flat); ++tile) {
        int quiet = interiorRange(flat, tile).spread();
        int loud = interiorRange(bold, tile).spread();
        CHECK(loud >= quiet);
        if (loud > quiet) ++widened;
    }
    CHECK(widened > tileCount / 2);
}

// The seed reaches the grain, and only the grain: the palette a sampler reports
// is the same table whatever the seed is.
VF_TEST(changingTheNoiseSeedRedrawsTheGrainButNotThePalette) {
    TileTextureParams first;
    TileTextureParams second;
    second.noiseSeed = first.noiseSeed ^ 0x5bf03635u;
    TileSampler original(first);
    TileSampler reseeded(second);

    int changed = 0;
    for (int tile = 0; tile < renderedTiles(original); ++tile) {
        if (renderTile(original, tile) != renderTile(reseeded, tile)) ++changed;
        CHECK(original.palette().specFor(tile).base == reseeded.palette().specFor(tile).base);
        CHECK(original.palette().specFor(tile).accent == reseeded.palette().specFor(tile).accent);
    }
    CHECK(changed > tileCount * 3 / 4);

    TileSampler sameSeedAgain(first);
    CHECK(renderAtlas(original, false) == renderAtlas(sameSeedAgain, false));
}

// writeTile is the path render/Atlas.cpp takes and pixelAt is the path the
// tests take. They have to be the same generator.
VF_TEST(writeTileAgreesWithPixelAtEverywhere) {
    TileSampler sampler;
    int size = sampler.params().tileSize;
    for (int tile = 0; tile < renderedTiles(sampler); ++tile) {
        std::vector<uint8_t> bytes = renderTile(sampler, tile);
        for (int y = 0; y < size; ++y) {
            for (int x = 0; x < size; ++x) {
                TilePixel texel = sampler.pixelAt(tile, x, y);
                std::size_t offset = (static_cast<std::size_t>(y) * size + x) * 4;
                CHECK_EQ(bytes[offset + 0], texel.r);
                CHECK_EQ(bytes[offset + 1], texel.g);
                CHECK_EQ(bytes[offset + 2], texel.b);
                CHECK_EQ(bytes[offset + 3], texel.a);
            }
        }
    }
}