MapLibreParticleLab/src/mbgl/renderer/sources/render_tile_source.cpp

#include <mbgl/renderer/sources/render_tile_source.hpp>

#include <mbgl/renderer/buckets/debug_bucket.hpp>
#include <mbgl/renderer/render_tile.hpp>
#include <mbgl/renderer/paint_parameters.hpp>
#include <mbgl/renderer/tile_parameters.hpp>
#include <mbgl/renderer/tile_render_data.hpp>
#include <mbgl/tile/vector_tile.hpp>
#include <mbgl/util/constants.hpp>
#include <mbgl/util/instrumentation.hpp>
#include <mbgl/util/math.hpp>

#if MLN_DRAWABLE_RENDERER
#include <mbgl/gfx/cull_face_mode.hpp>
#include <mbgl/gfx/drawable.hpp>
#include <mbgl/gfx/drawable_builder.hpp>
#include <mbgl/gfx/shader_group.hpp>
#include <mbgl/renderer/layer_group.hpp>
#include <mbgl/renderer/render_static_data.hpp>
#include <mbgl/shaders/debug_layer_ubo.hpp>
#include <mbgl/shaders/shader_program_base.hpp>
#include <mbgl/util/convert.hpp>
#include <mbgl/tile/geojson_tile_data.hpp>
#include <mbgl/gfx/polyline_generator.hpp>
#include <mbgl/style/types.hpp>
#include <mbgl/shaders/line_layer_ubo.hpp>
#include <mbgl/gfx/drawable_tweaker.hpp>
#include <mbgl/renderer/layer_tweaker.hpp>

#include <unordered_set>
#endif

namespace mbgl {

using namespace style;
using namespace shaders;

void TileSourceRenderItem::upload(gfx::UploadPass& parameters) const {
    for (auto& tile : *renderTiles) {
        tile.upload(parameters);
    }
}

void TileSourceRenderItem::render(PaintParameters& parameters) const {
    for (auto& tile : *renderTiles) {
        tile.finishRender(parameters);
    }
}

#if MLN_DRAWABLE_RENDERER
void TileSourceRenderItem::updateDebugDrawables(DebugLayerGroupMap& debugLayerGroups,
                                                PaintParameters& parameters) const {
    if (!(parameters.debugOptions &
          (MapDebugOptions::Timestamps | MapDebugOptions::ParseStatus | MapDebugOptions::TileBorders))) {
        debugLayerGroups.clear();
        return;
    }

    auto& context = parameters.context;
    const auto renderPass = RenderPass::None;
    auto& shaders = *parameters.staticData.shaders;

    // initialize debug builder
    constexpr auto DebugShaderName = "DebugShader";
    gfx::ShaderProgramBasePtr debugShader = context.getGenericShader(shaders, std::string(DebugShaderName));
    if (!debugShader) {
        return;
    }

    const auto drawableName = "debug-" + name;
    std::unique_ptr<gfx::DrawableBuilder> debugBuilder = [&]() -> std::unique_ptr<gfx::DrawableBuilder> {
        auto builder = context.createDrawableBuilder("debug-builder");
        builder->setShader(debugShader);
        builder->setRenderPass(renderPass);
        builder->setEnableDepth(false);
        builder->setColorMode(gfx::ColorMode::unblended());
        builder->setCullFaceMode(gfx::CullFaceMode::disabled());
        builder->setVertexAttrId(idDebugPosVertexAttribute);
        builder->setDrawableName(drawableName);

        return builder;
    }();

#if MLN_RENDER_BACKEND_METAL
    // initialize polyline builder
    gfx::ShaderPtr polylineShader;
    const auto createPolylineShader = [&]() -> gfx::ShaderPtr {
        gfx::ShaderGroupPtr shaderGroup = shaders.getShaderGroup("LineShader");
        const StringIDSetsPair propertiesAsUniforms{
            {"a_color", "a_blur", "a_opacity", "a_gapwidth", "a_offset", "a_width"},
            {idLineColorVertexAttribute,
             idLineBlurVertexAttribute,
             idLineOpacityVertexAttribute,
             idLineGapWidthVertexAttribute,
             idLineOffsetVertexAttribute,
             idLineWidthVertexAttribute}};
        return shaderGroup->getOrCreateShader(context, propertiesAsUniforms);
    };

    std::unique_ptr<gfx::DrawableBuilder> polylineBuilder;
    const auto createPolylineBuilder = [&](gfx::ShaderPtr shader) -> std::unique_ptr<gfx::DrawableBuilder> {
        std::unique_ptr<gfx::DrawableBuilder> builder = context.createDrawableBuilder("debug-polyline-builder");
        builder->setShader(std::static_pointer_cast<gfx::ShaderProgramBase>(shader));
        builder->setRenderPass(renderPass);
        builder->setEnableDepth(false);
        builder->setColorMode(gfx::ColorMode::alphaBlended());
        builder->setCullFaceMode(gfx::CullFaceMode::disabled());
        builder->setVertexAttrId(idLinePosNormalVertexAttribute);
        builder->setDrawableName(drawableName);

        return builder;
    };
#endif

    // add or get the layer group for a debug type
    const auto addOrGetLayerGroupForType =
        [&debugLayerGroups, &context](DebugType type, std::string&& layerName) -> DebugLayerGroupMap::const_iterator {
        auto it = debugLayerGroups.find(type);
        if (it == debugLayerGroups.end()) {
            auto inserted = debugLayerGroups.insert(
                std::make_pair(type,
                               context.createTileLayerGroup(
                                   static_cast<int32_t>(type), /*initialCapacity=*/64, std::move(layerName))));
            assert(inserted.second);
            it = inserted.first;
        }
        return it;
    };

    // build a set of tiles to cover
    mbgl::unordered_set<OverscaledTileID> newTiles;
    newTiles.reserve(renderTiles->size());
    for (auto& tile : *renderTiles) {
        newTiles.insert(tile.getOverscaledTileID());
    }

    // create texture. to be reused for all the tiles of the debug layers
    auto texture = context.createTexture2D();
    {
        std::array<uint8_t, 4> data{{0, 0, 0, 0}};
        auto emptyImage = std::make_shared<PremultipliedImage>(Size(1, 1), data.data(), data.size());
        texture->setImage(emptyImage);
        texture->setSamplerConfiguration(
            {gfx::TextureFilterType::Linear, gfx::TextureWrapType::Clamp, gfx::TextureWrapType::Clamp});
    }

    // function to update existing tile drawables with UBO value. return number of updated drawables
    const auto updateDrawables =
        [&](TileLayerGroup* tileLayerGroup, const OverscaledTileID& tileID, const DebugUBO& debugUBO) -> size_t {
        auto updatedCount = tileLayerGroup->visitDrawables(renderPass, tileID, [&](gfx::Drawable& drawable) {
            // update existing drawable
            auto& drawableUniforms = drawable.mutableUniformBuffers();
            drawableUniforms.createOrUpdate(idDebugUBO, &debugUBO, context);
        });
        return updatedCount;
    };

    // function to add lines drawable
    const auto addDrawable = [&](TileLayerGroup* tileLayerGroup,
                                 const OverscaledTileID& tileID,
                                 const DebugUBO& debugUBO,
                                 const gfx::DrawMode mode,
                                 const auto& vertices,
                                 const auto& indexes,
                                 const auto& segments) {
        // create new drawable
        std::vector<std::array<int16_t, 2>> verts(vertices.size());
        std::transform(vertices.begin(), vertices.end(), verts.begin(), [](const auto& v) -> std::array<int16_t, 2> {
            return v.a1;
        });

        debugBuilder->addVertices(verts, 0, verts.size());
        debugBuilder->setSegments(mode, indexes, segments.data(), segments.size());
        // texture
        debugBuilder->setTexture(texture, idDebugOverlayTexture);

        // finish
        debugBuilder->flush(context);
        for (auto& drawable : debugBuilder->clearDrawables()) {
            drawable->setTileID(tileID);
            auto& drawableUniforms = drawable->mutableUniformBuffers();
            drawableUniforms.createOrUpdate(idDebugUBO, &debugUBO, context);

            tileLayerGroup->addDrawable(renderPass, tileID, std::move(drawable));
        }
    };

#if MLN_RENDER_BACKEND_METAL
    // function to add polylines drawable
    const auto addPolylineDrawable = [&](TileLayerGroup* tileLayerGroup, const RenderTile& tile) {
        class PolylineDrawableTweaker : public gfx::DrawableTweaker {
        public:
            PolylineDrawableTweaker(const shaders::LineEvaluatedPropsUBO& properties)
                : linePropertiesUBO(properties) {}
            ~PolylineDrawableTweaker() override = default;

            void init(gfx::Drawable&) override {}

            void execute(gfx::Drawable& drawable, const PaintParameters& parameters) override {
                if (!drawable.getTileID().has_value()) {
                    return;
                }

                const UnwrappedTileID tileID = drawable.getTileID()->toUnwrapped();
                const auto zoom = parameters.state.getZoom();
                mat4 tileMatrix;
                parameters.state.matrixFor(/*out*/ tileMatrix, tileID);

                const auto matrix = LayerTweaker::getTileMatrix(
                    tileID, parameters, {{0, 0}}, style::TranslateAnchorType::Viewport, false, false, drawable, false);

                const shaders::LineDrawableUBO drawableUBO = {/*matrix = */ util::cast<float>(matrix),
                                                              /*ratio = */ 1.0f / tileID.pixelsToTileUnits(1.0f, zoom),
                                                              0,
                                                              0,
                                                              0};
                const shaders::LineInterpolationUBO lineInterpolationUBO = {/*color_t =*/0.f,
                                                                            /*blur_t =*/0.f,
                                                                            /*opacity_t =*/0.f,
                                                                            /*gapwidth_t =*/0.f,
                                                                            /*offset_t =*/0.f,
                                                                            /*width_t =*/0.f,
                                                                            0,
                                                                            0};
                auto& drawableUniforms = drawable.mutableUniformBuffers();
                drawableUniforms.createOrUpdate(idLineDrawableUBO, &drawableUBO, parameters.context);
                drawableUniforms.createOrUpdate(idLineInterpolationUBO, &lineInterpolationUBO, parameters.context);
                drawableUniforms.createOrUpdate(idLineEvaluatedPropsUBO, &linePropertiesUBO, parameters.context);

                // We would need to set up `idLineExpressionUBO` if the expression mask isn't empty
                assert(linePropertiesUBO.expressionMask == LineExpressionMask::None);

                const LineExpressionUBO exprUBO = {
                    /* color = */ nullptr,
                    /* blur = */ nullptr,
                    /* opacity = */ nullptr,
                    /* gapwidth = */ nullptr,
                    /* offset = */ nullptr,
                    /* width = */ nullptr,
                    /* floorWidth = */ nullptr,
                };
                drawableUniforms.createOrUpdate(idLineExpressionUBO, &exprUBO, parameters.context);
            };

        private:
            shaders::LineEvaluatedPropsUBO linePropertiesUBO;
        };

        GeometryCoordinates coords{{0, 0}, {util::EXTENT, 0}, {util::EXTENT, util::EXTENT}, {0, util::EXTENT}, {0, 0}};
        gfx::PolylineGeneratorOptions options;
        options.type = FeatureType::Polygon;

        if (!polylineShader) polylineShader = createPolylineShader();
        if (!polylineBuilder) {
            polylineBuilder = createPolylineBuilder(polylineShader);
        }
        polylineBuilder->addPolyline(coords, options);

        // create line tweaker
        const shaders::LineEvaluatedPropsUBO linePropertiesUBO = {/*color*/ Color::red(),
                                                                  /*blur*/ 0.f,
                                                                  /*opacity*/ 1.f,
                                                                  /*gapwidth*/ 0.f,
                                                                  /*offset*/ 0.f,
                                                                  /*width*/ 4.f,
                                                                  /*floorwidth*/ 0,
                                                                  LineExpressionMask::None,
                                                                  0};
        auto tweaker = std::make_shared<PolylineDrawableTweaker>(linePropertiesUBO);

        // finish
        polylineBuilder->flush(context);
        for (auto& drawable : polylineBuilder->clearDrawables()) {
            drawable->setTileID(tile.getOverscaledTileID());
            drawable->addTweaker(tweaker);
            tileLayerGroup->addDrawable(renderPass, tile.getOverscaledTileID(), std::move(drawable));
        }
    };
#endif

    // Timestamps or Parse Status
    if (parameters.debugOptions & (MapDebugOptions::Timestamps | MapDebugOptions::ParseStatus)) {
        TileLayerGroup* outlineLayerGroup = static_cast<TileLayerGroup*>(
            addOrGetLayerGroupForType(DebugType::TextOutline, "debug-text-outline")->second.get());
        TileLayerGroup* textLayerGroup = static_cast<TileLayerGroup*>(
            addOrGetLayerGroupForType(DebugType::Text, "debug-text")->second.get());

        // erase drawables that are not in the current tile set
        for (auto& lg : {outlineLayerGroup, textLayerGroup}) {
            lg->removeDrawablesIf([&](gfx::Drawable& drawable) {
                return drawable.getName() == drawableName &&
                       !(drawable.getTileID().has_value() && newTiles.count(*drawable.getTileID()) > 0);
            });
        }

        // add new drawables and update existing ones
        for (auto& tile : *renderTiles) {
            const auto tileID = tile.getOverscaledTileID();
            const auto& debugBucket = tile.debugBucket;
            if (!debugBucket) continue;

            const DebugUBO outlineUBO{/*matrix = */ util::cast<float>(tile.matrix),
                                      /*color = */ Color::white(),
                                      /*overlay_scale = */ 1.0f,
                                      0,
                                      0,
                                      0};
            if (0 == updateDrawables(outlineLayerGroup, tileID, outlineUBO)) {
                addDrawable(outlineLayerGroup,
                            tileID,
                            outlineUBO,
                            gfx::Lines(4.0f * parameters.pixelRatio),
                            debugBucket->vertices.vector(),
                            debugBucket->indices.vector(),
                            debugBucket->segments);
            }

            const DebugUBO textUBO{/*matrix = */ util::cast<float>(tile.matrix),
                                   /*color = */ Color::black(),
                                   /*overlay_scale = */ 1.0f,
                                   0,
                                   0,
                                   0};
            if (0 == updateDrawables(textLayerGroup, tileID, textUBO) && tile.getNeedsRendering()) {
                addDrawable(textLayerGroup,
                            tileID,
                            textUBO,
                            gfx::Lines(2.0f * parameters.pixelRatio),
                            debugBucket->vertices.vector(),
                            debugBucket->indices.vector(),
                            debugBucket->segments);
            }
        }
    } else {
        // tile texts are not required, erase layer groups
        debugLayerGroups.erase(DebugType::TextOutline);
        debugLayerGroups.erase(DebugType::Text);
    }

    // Tile Borders
    if (parameters.debugOptions & (MapDebugOptions::TileBorders)) {
        TileLayerGroup* tileLayerGroup = static_cast<TileLayerGroup*>(
            addOrGetLayerGroupForType(DebugType::Border, "debug-border")->second.get());

        // erase drawables that are not in the current tile set
        tileLayerGroup->removeDrawablesIf([&](gfx::Drawable& drawable) {
            return drawable.getName() == drawableName &&
                   !(drawable.getTileID().has_value() && newTiles.count(*drawable.getTileID()) > 0);
        });

        // add new drawables and update existing ones
        auto vertices = RenderStaticData::tileVertices().vector();
        auto indexes = RenderStaticData::tileLineStripIndices().vector();
        auto segments = RenderStaticData::tileBorderSegments();
        for (auto& tile : *renderTiles) {
            const auto tileID = tile.getOverscaledTileID();
            const auto& debugBucket = tile.debugBucket;
            if (!debugBucket) continue;

            const DebugUBO debugUBO{/*matrix = */ util::cast<float>(tile.matrix),
                                    /*color = */ Color::red(),
                                    /*overlay_scale = */ 1.0f,
                                    0,
                                    0,
                                    0};
            if (0 == updateDrawables(tileLayerGroup, tileID, debugUBO) && tile.getNeedsRendering()) {
#if MLN_RENDER_BACKEND_METAL
                addPolylineDrawable(tileLayerGroup, tile);
#else
                addDrawable(tileLayerGroup,
                            tileID,
                            debugUBO,
                            gfx::LineStrip(4.0f * parameters.pixelRatio),
                            vertices,
                            indexes,
                            segments);
#endif
            }
        }
    } else {
        // if tile borders are not required, erase layer group
        debugLayerGroups.erase(DebugType::Border);
    }
}
#endif

RenderTileSource::RenderTileSource(Immutable<style::Source::Impl> impl_, const TaggedScheduler& threadPool_)
    : RenderSource(std::move(impl_)),
      tilePyramid(threadPool_),
      renderTiles(makeMutable<std::vector<RenderTile>>()) {
    tilePyramid.setObserver(this);
}

RenderTileSource::~RenderTileSource() = default;

bool RenderTileSource::isLoaded() const {
    return tilePyramid.isLoaded();
}

std::unique_ptr<RenderItem> RenderTileSource::createRenderItem() {
    return std::make_unique<TileSourceRenderItem>(renderTiles, baseImpl->id);
}

void RenderTileSource::prepare(const SourcePrepareParameters& parameters) {
    MLN_TRACE_FUNC()
    MLN_ZONE_STR(baseImpl->id)
    bearing = static_cast<float>(parameters.transform.state.getBearing());
    filteredRenderTiles = nullptr;
    renderTilesSortedByY = nullptr;
    auto tiles = makeMutable<std::vector<RenderTile>>();
    tiles->reserve(tilePyramid.getRenderedTiles().size());
    for (auto& entry : tilePyramid.getRenderedTiles()) {
        tiles->emplace_back(entry.first, entry.second);
        tiles->back().prepare(parameters);
    }
    featureState.coalesceChanges(*tiles);
    renderTiles = std::move(tiles);
}

void RenderTileSource::updateFadingTiles() {
    tilePyramid.updateFadingTiles();
}

bool RenderTileSource::hasFadingTiles() const {
    return tilePyramid.hasFadingTiles();
}

RenderTiles RenderTileSource::getRenderTiles() const {
    if (!filteredRenderTiles) {
        auto result = std::make_shared<std::vector<std::reference_wrapper<const RenderTile>>>();
        for (const auto& renderTile : *renderTiles) {
            if (renderTile.holdForFade()) {
                continue;
            }
            result->emplace_back(renderTile);
        }
        filteredRenderTiles = std::move(result);
    }
    return filteredRenderTiles;
}

RenderTiles RenderTileSource::getRenderTilesSortedByYPosition() const {
    if (!renderTilesSortedByY) {
        const auto comp = [sourceBearing = this->bearing](const RenderTile& a, const RenderTile& b) {
            Point<float> pa(static_cast<float>(a.id.canonical.x), static_cast<float>(a.id.canonical.y));
            Point<float> pb(static_cast<float>(b.id.canonical.x), static_cast<float>(b.id.canonical.y));

            auto par = util::rotate(pa, sourceBearing);
            auto pbr = util::rotate(pb, sourceBearing);

            return std::tie(b.id.canonical.z, par.y, par.x) < std::tie(a.id.canonical.z, pbr.y, pbr.x);
        };

        auto result = std::make_shared<std::vector<std::reference_wrapper<const RenderTile>>>();
        result->reserve(renderTiles->size());
        for (const auto& renderTile : *renderTiles) {
            result->emplace_back(renderTile);
        }
        std::sort(result->begin(), result->end(), comp);
        renderTilesSortedByY = std::move(result);
    }
    return renderTilesSortedByY;
}

const Tile* RenderTileSource::getRenderedTile(const UnwrappedTileID& tileID) const {
    return tilePyramid.getRenderedTile(tileID);
}

std::unordered_map<std::string, std::vector<Feature>> RenderTileSource::queryRenderedFeatures(
    const ScreenLineString& geometry,
    const TransformState& transformState,
    const std::unordered_map<std::string, const RenderLayer*>& layers,
    const RenderedQueryOptions& options,
    const mat4& projMatrix) const {
    return tilePyramid.queryRenderedFeatures(geometry, transformState, layers, options, projMatrix, featureState);
}

std::vector<Feature> RenderTileSource::querySourceFeatures(const SourceQueryOptions& options) const {
    return tilePyramid.querySourceFeatures(options);
}

void RenderTileSource::setFeatureState(const std::optional<std::string>& sourceLayerID,
                                       const std::string& featureID,
                                       const FeatureState& state) {
    featureState.updateState(sourceLayerID, featureID, state);
}

void RenderTileSource::getFeatureState(FeatureState& state,
                                       const std::optional<std::string>& sourceLayerID,
                                       const std::string& featureID) const {
    featureState.getState(state, sourceLayerID, featureID);
}

void RenderTileSource::removeFeatureState(const std::optional<std::string>& sourceLayerID,
                                          const std::optional<std::string>& featureID,
                                          const std::optional<std::string>& stateKey) {
    featureState.removeState(sourceLayerID, featureID, stateKey);
}

void RenderTileSource::setCacheEnabled(bool enable) {
    tilePyramid.setCacheEnabled(enable);
}

void RenderTileSource::reduceMemoryUse() {
    tilePyramid.reduceMemoryUse();
}

void RenderTileSource::dumpDebugLogs() const {
    tilePyramid.dumpDebugLogs();
}

// RenderTileSetSource implementation

RenderTileSetSource::RenderTileSetSource(Immutable<style::Source::Impl> impl_, const TaggedScheduler& threadPool_)
    : RenderTileSource(std::move(impl_), threadPool_) {}

RenderTileSetSource::~RenderTileSetSource() = default;

uint8_t RenderTileSetSource::getMaxZoom() const {
    return cachedTileset ? cachedTileset->zoomRange.max : util::TERRAIN_RGB_MAXZOOM;
}

void RenderTileSetSource::update(Immutable<style::Source::Impl> baseImpl_,
                                 const std::vector<Immutable<style::LayerProperties>>& layers,
                                 const bool needsRendering,
                                 const bool needsRelayout,
                                 const TileParameters& parameters) {
    std::swap(baseImpl, baseImpl_);

    enabled = needsRendering;

    const auto& implTileset = getTileset();
    // In Continuous mode, keep the existing tiles if the new cachedTileset is
    // not yet available, thus providing smart style transitions without
    // flickering. In other modes, allow clearing the tile pyramid first, before
    // the early return in order to avoid render tests being flaky.
    bool canUpdateTileset = implTileset || parameters.mode != MapMode::Continuous;
    if (canUpdateTileset && cachedTileset != implTileset) {
        cachedTileset = implTileset;

        // TODO: this removes existing buckets, and will cause flickering.
        // Should instead refresh tile data in place.
        tilePyramid.clearAll();
    }

    if (!cachedTileset) return;

    updateInternal(*cachedTileset, layers, needsRendering, needsRelayout, parameters);
}

} // namespace mbgl