maplibre_native 0.8.4

#pragma once

#include <mbgl/actor/scheduler.hpp>
#include <mbgl/gfx/backend_scope.hpp>
#include <mbgl/gfx/headless_frontend.hpp>
#include <mbgl/gfx/renderer_backend.hpp>
#include <mbgl/style/image.hpp>
#include <mbgl/style/layer.hpp>
#include <mbgl/map/map.hpp>
#include <mbgl/map/map_observer.hpp>
#include <mbgl/map/map_options.hpp>
#include <mbgl/style/style.hpp>
#include <mbgl/style/source.hpp>
#include <mbgl/util/image.hpp>
#include <mbgl/util/run_loop.hpp>
#include <mbgl/util/premultiply.hpp>
#include <mbgl/util/tile_server_options.hpp>
#include <mbgl/util/size.hpp>
#include <mbgl/storage/resource_options.hpp>

#if defined(MLN_WEBGPU_IMPL_FFI)
#include <mbgl/webgpu/texture2d.hpp>
#include <mbgl/webgpu/renderer_backend.hpp>
#include <mbgl/webgpu/headless_backend.hpp>
#endif


#include <cstdint>
#include <cassert>
#include <memory>
#include <mutex>
#include <optional>
#include <vector>
#include <stdexcept>
#include "rust/cxx.h"
#include "rust_log_observer.h"
#include "map_observer.h"
#include "sources/sources.h"

#if (!defined(__APPLE__) || defined(MLN_DARWIN_USE_LIBUV)) && __has_include(<uv.h>)
#include <uv.h>
#elif !defined(__APPLE__) || defined(MLN_DARWIN_USE_LIBUV)
struct uv_loop_s;
using uv_loop_t = uv_loop_s;
enum uv_run_mode { UV_RUN_DEFAULT = 0, UV_RUN_ONCE, UV_RUN_NOWAIT };
extern "C" int uv_run(uv_loop_t*, uv_run_mode);
#endif

namespace mln {
namespace bridge {

struct Texture;
struct TextureView;

constexpr size_t BYTES_PER_PIXEL = 4; // rgba

struct BridgeImage;
class RenderRequest;
struct FfiCameraOptions;
struct LatLng;
struct LatLngBounds;
struct EdgeInsets;
namespace geojson {
class GeoJson;
}

inline mbgl::util::RunLoop& threadRunLoop() {
    // MapLibre Native's RunLoop is thread-affine. Keep one private loop per
    // renderer-owning thread and share it between renderers on that thread.
    thread_local mbgl::util::RunLoop loop(mbgl::util::RunLoop::Type::New);
    return loop;
}

inline void bindThreadRunLoop() {
    mbgl::Scheduler::SetCurrent(&threadRunLoop());
}

inline void currentThreadRunLoopTick() {
    // Tick can be driven through a Rust handle without constructing a renderer first.
    bindThreadRunLoop();
    threadRunLoop().runOnce();
}

// Blocks the calling thread, advancing the run loop until it is woken by pending
// work (e.g. a render or style-load completion), without busy-polling. The exact
// primitive differs by run-loop backend (see below).
inline void currentThreadRunLoopWait() {
#if defined(__APPLE__) && !defined(MLN_DARWIN_USE_LIBUV)
    // Darwin's RunLoop is CoreFoundation-based, not libuv-based: run until a
    // completion callback calls currentThreadRunLoopStop(). (May process more
    // than one event before stopping.)
    bindThreadRunLoop();
    threadRunLoop().run();
#else
    // libuv backend: UV_RUN_ONCE blocks until at least one event is processed,
    // then returns. (mbgl's RunLoop::runOnce() is UV_RUN_NOWAIT, which would
    // busy-spin in a wait loop; UV_RUN_DEFAULT would instead wait for *all*
    // handles to drain, which hangs while network handles stay active.)
    bindThreadRunLoop();
    uv_run(static_cast<uv_loop_t*>(mbgl::util::RunLoop::getLoopHandle()), UV_RUN_ONCE);
#endif
}

inline void currentThreadRunLoopStop() {
#if defined(__APPLE__) && !defined(MLN_DARWIN_USE_LIBUV)
    threadRunLoop().stop();
#endif
}

inline std::unique_ptr<std::string> encodeImage(mbgl::PremultipliedImage image) {
    auto unpremultipliedImage = mbgl::util::unpremultiply(std::move(image));

    const size_t pixelCount = unpremultipliedImage.size.width * unpremultipliedImage.size.height;
    std::string data;
    data.reserve(2 * sizeof(uint32_t) + pixelCount * BYTES_PER_PIXEL);

    uint32_t width = unpremultipliedImage.size.width;
    uint32_t height = unpremultipliedImage.size.height;
    data.append(reinterpret_cast<const char*>(&width), sizeof(uint32_t));
    data.append(reinterpret_cast<const char*>(&height), sizeof(uint32_t));

    const char* pixelData = reinterpret_cast<const char*>(unpremultipliedImage.data.get());
    data.append(pixelData, pixelCount * BYTES_PER_PIXEL);

    return std::make_unique<std::string>(std::move(data));
}

// TODO: Remove this mutex once the upstream fix is released and `MLN_COMMIT` is
// bumped: https://github.com/maplibre/maplibre-native/pull/4332
#if MLN_RENDER_BACKEND_OPENGL
inline std::mutex& headlessDisplayMutex() {
    static std::mutex mutex;
    return mutex;
}
#endif

class MapRenderer {
public:
    explicit MapRenderer(mbgl::MapMode mapMode,
                         mbgl::Size size,
                         float pixelRatio,
                         const mbgl::ResourceOptions& resourceOptions)
        : mapObserverInstance(std::make_shared<MapObserver>()) {
        bindThreadRunLoop();
#if MLN_RENDER_BACKEND_OPENGL
        {
            // The GL display singleton is created lazily on the backend's first
            // activate(), so force activation here under the lock to serialize it.
            std::lock_guard<std::mutex> lock(headlessDisplayMutex());
            frontend = std::make_unique<mbgl::HeadlessFrontend>(size, pixelRatio);
            mbgl::gfx::BackendScope scope{*frontend->getBackend()};
        }
#else
        frontend = std::make_unique<mbgl::HeadlessFrontend>(size, pixelRatio);
#endif

        mbgl::MapOptions mapOptions;
        mapOptions.withMapMode(mapMode).withSize(size).withPixelRatio(pixelRatio);

        // Set up logging observer for Rust bridge
        auto logObserver = std::make_unique<mln::bridge::RustLogObserver>();
        mbgl::Log::setObserver(std::move(logObserver));
        map = std::make_unique<mbgl::Map>(*frontend, *mapObserverInstance, mapOptions, resourceOptions);
    }
    ~MapRenderer() {
#if MLN_RENDER_BACKEND_OPENGL
        std::lock_guard<std::mutex> lock(headlessDisplayMutex());
        map.reset();
        frontend.reset();
#endif
    }

    std::shared_ptr<MapObserver> observer() {
        return mapObserverInstance;
    }

    #if defined(MLN_WEBGPU_IMPL_FFI)
    std::shared_ptr<mbgl::webgpu::Texture2D> takeTexture() {
        auto backend = static_cast<mbgl::webgpu::HeadlessBackend*>(this->frontend->getBackend());
        auto ptr = std::static_pointer_cast<mbgl::webgpu::Texture2D>(backend->takeTexture());
        assert(ptr);
        return ptr;
    }
    #endif

    void style_add_image(rust::Str id,
                         rust::Slice<const unsigned char> data,
                         mbgl::Size size,
                         float pixel_ratio,
                         bool signed_distance_field) {
        mbgl::PremultipliedImage image(size, data.data(), data.size());

        map->getStyle().addImage(std::make_unique<mbgl::style::Image>(
            std::string(id), std::move(image), pixel_ratio, signed_distance_field));
    }

    void style_remove_image(rust::Str id) {
        map->getStyle().removeImage(std::string(id));
    }

    void style_add_source(std::unique_ptr<mbgl::style::Source> source) {
        map->getStyle().addSource(std::move(source));
    }

    std::unique_ptr<mln::bridge::style::sources::SourceHandle> style_get_source_mut(rust::Str id) {
        auto* source = map->getStyle().getSource(std::string(id));
        if (!source) {
            return nullptr;
        }
        return std::make_unique<mln::bridge::style::sources::SourceHandle>(source);
    }

    void style_remove_source(rust::Str id) {
        map->getStyle().removeSource(std::string(id));
    }

    void style_add_layer(std::unique_ptr<mbgl::style::Layer> layer, rust::Str before_id) {
        // An empty before_id string means no before layer was specified.
        map->getStyle().addLayer(
            std::move(layer),
            before_id.empty() ? std::nullopt : std::optional<std::string>{std::string(before_id)});
    }

    std::unique_ptr<mbgl::style::Layer> style_remove_layer(rust::Str id) {
        return map->getStyle().removeLayer(std::string(id));
    }

    void style_load_from_url(const rust::Str styleUrl) {
        map->getStyle().loadURL((std::string)styleUrl);
    }

    void style_load_from_json(const rust::Str styleJson) {
        map->getStyle().loadJSON((std::string)styleJson);
    }

    std::unique_ptr<BridgeImage> readStillImage() {
        auto image = frontend->readStillImage();
        auto unpremultipliedImage = mbgl::util::unpremultiply(std::move(image));
        return std::make_unique<BridgeImage>(std::move(unpremultipliedImage.data), unpremultipliedImage.size);
    }

    void render_once() {
        frontend->renderOnce(*map);
    }

    std::unique_ptr<RenderRequest> submitRender();

    FfiCameraOptions cameraForLatLngBounds(const LatLngBounds& bounds,
                                           const EdgeInsets& padding,
                                           double bearing,
                                           double pitch);

    FfiCameraOptions cameraForLatLngs(rust::Slice<const LatLng> latLngs,
                                      const EdgeInsets& padding,
                                      double bearing,
                                      double pitch);

    FfiCameraOptions cameraForGeoJson(const mln::bridge::geojson::GeoJson& geojson,
                                      const EdgeInsets& padding,
                                      double bearing,
                                      double pitch);

    std::unique_ptr<std::string> readStillImageBytes() {
        return encodeImage(frontend->readStillImage());
    }

    void setSize(const mbgl::Size& size) {
        if (size.width == 0 || size.height == 0)
            return;
        frontend->setSize(size);
        map->setSize(size);
    }

    void setDebugFlags(mbgl::MapDebugOptions debugFlags) {
        map->setDebug(debugFlags);
    }

    void jumpTo(const FfiCameraOptions& cameraOptions);

    void moveBy(const mbgl::ScreenCoordinate& delta) {
        map->moveBy(delta);
    }

    void scaleBy(double scale, const mbgl::ScreenCoordinate& pos) {
        map->scaleBy(scale, pos);
    }

    void pitchBy(double pitch) {
        map->pitchBy(pitch);
    }

    void rotateBy(const mbgl::ScreenCoordinate& first, const mbgl::ScreenCoordinate& second) {
        map->rotateBy(first, second);
    }

    // Set the wgpu device and queue required for rendering when using the wgpu ffi backend
    #if defined(MLN_WEBGPU_IMPL_FFI)
    void setDeviceAndQueue(WGPUDevice device, WGPUQueue queue) {
        static_cast<mbgl::webgpu::RendererBackend*>(frontend->getBackend())->setDevice(device);
        static_cast<mbgl::webgpu::RendererBackend*>(frontend->getBackend())->setQueue(queue);
    }
    #endif
public:
    // CXX bridge helpers below access these directly. Keep them alive here
    // because the frontend and observer are passed by reference to the map.
    std::unique_ptr<mbgl::HeadlessFrontend> frontend;
    std::shared_ptr<MapObserver> mapObserverInstance;
    std::unique_ptr<mbgl::Map> map;
};

class RenderRequest {
public:
    struct State {
        bool ready = false;
        std::exception_ptr error;
        std::unique_ptr<std::string> image;
    };

    RenderRequest()
        : state(std::make_shared<State>()) {}

    ~RenderRequest() {
        // If the request is dropped before completion, drive the run loop here
        // while the borrowed renderer is still alive, so MapLibre Native returns to
        // an idle state before the next submitRender.
        while (!state->ready) {
            currentThreadRunLoopWait();
        }
    }

    std::shared_ptr<State> getState() const {
        return state;
    }

    bool isReady() const {
        return state->ready;
    }

    bool hasError() const {
        return static_cast<bool>(state->error);
    }

    rust::String errorMessage() const {
        if (!state->error) {
            return rust::String();
        }

        try {
            std::rethrow_exception(state->error);
        } catch (const std::exception& error) {
            return rust::String(error.what());
        } catch (...) {
            return rust::String("Unknown render error");
        }
    }

    std::unique_ptr<std::string> takeImage() {
        assert(state->ready);
        assert(!state->error);
        assert(state->image);
        assert(!taken);
        taken = true;
        return std::move(state->image);
    }

private:
    std::shared_ptr<State> state;
    bool taken = false;
};

inline std::unique_ptr<RenderRequest> MapRenderer::submitRender() {
    auto request = std::make_unique<RenderRequest>();
    auto state = request->getState();

    map->renderStill([this, state](const std::exception_ptr& error) {
        state->error = error;
        if (!error) {
            state->image = readStillImageBytes();
        }
        state->ready = true;
#if defined(__APPLE__) && !defined(MLN_DARWIN_USE_LIBUV)
        // Wake a thread blocked in currentThreadRunLoopWait() (Darwin non-libuv).
        currentThreadRunLoopStop();
#endif
    });

    return request;
}

inline std::unique_ptr<MapRenderer> MapRenderer_new(
            mbgl::MapMode mapMode,
            uint32_t width,
            uint32_t height,
            float pixelRatio,
            const mbgl::ResourceOptions& resourceOptions
) {
    mbgl::Size size = {width, height};
    return std::make_unique<MapRenderer>(mapMode, size, pixelRatio, resourceOptions);
}

struct BridgeImage {
    public:
        BridgeImage(std::unique_ptr<uint8_t[]> data, mbgl::Size size): mSize(size), mData(std::move(data)) {}

        const uint8_t* get() const {
            return mData.get();
        }

        size_t bufferLength() const {
            const size_t pixelCount = mSize.width * mSize.height;
            return pixelCount * BYTES_PER_PIXEL;
        }

        mbgl::Size size() const {
            return mSize;
        }

    private:
        mbgl::Size mSize;
        std::unique_ptr<uint8_t[]> mData;
};

} // namespace bridge
} // namespace mln