[core] Move Sprite parsing to thread pool
This commit is contained in:
@@ -21,19 +21,9 @@ const std::string AnnotationManager::PointLayerID = "com.mapbox.annotations.poin
|
||||
|
||||
AnnotationManager::AnnotationManager(float pixelRatio)
|
||||
: spriteAtlas({ 1024, 1024 }, pixelRatio) {
|
||||
|
||||
struct NullFileSource : public FileSource {
|
||||
std::unique_ptr<AsyncRequest> request(const Resource&, Callback) override {
|
||||
assert(false);
|
||||
return nullptr;
|
||||
}
|
||||
};
|
||||
|
||||
NullFileSource nullFileSource;
|
||||
|
||||
// This is a special atlas, holding only images added via addIcon. But we need its isLoaded()
|
||||
// method to return true.
|
||||
spriteAtlas.load("", nullFileSource);
|
||||
// This is a special atlas, holding only images added via addIcon, so we always treat it as
|
||||
// loaded.
|
||||
spriteAtlas.markAsLoaded();
|
||||
}
|
||||
|
||||
AnnotationManager::~AnnotationManager() = default;
|
||||
|
||||
@@ -359,7 +359,7 @@ void Map::setStyleURL(const std::string& url) {
|
||||
impl->styleJSON.clear();
|
||||
impl->styleMutated = false;
|
||||
|
||||
impl->style = std::make_unique<Style>(impl->fileSource, impl->pixelRatio);
|
||||
impl->style = std::make_unique<Style>(impl->scheduler, impl->fileSource, impl->pixelRatio);
|
||||
|
||||
impl->styleRequest = impl->fileSource.request(Resource::style(impl->styleURL), [this](Response res) {
|
||||
// Once we get a fresh style, or the style is mutated, stop revalidating.
|
||||
@@ -405,7 +405,7 @@ void Map::setStyleJSON(const std::string& json) {
|
||||
impl->styleJSON.clear();
|
||||
impl->styleMutated = false;
|
||||
|
||||
impl->style = std::make_unique<Style>(impl->fileSource, impl->pixelRatio);
|
||||
impl->style = std::make_unique<Style>(impl->scheduler, impl->fileSource, impl->pixelRatio);
|
||||
|
||||
impl->loadStyleJSON(json);
|
||||
}
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
#include <mbgl/sprite/sprite_atlas.hpp>
|
||||
#include <mbgl/sprite/sprite_atlas_worker.hpp>
|
||||
#include <mbgl/sprite/sprite_atlas_observer.hpp>
|
||||
#include <mbgl/sprite/sprite_parser.hpp>
|
||||
#include <mbgl/gl/context.hpp>
|
||||
@@ -11,6 +12,8 @@
|
||||
#include <mbgl/storage/file_source.hpp>
|
||||
#include <mbgl/storage/resource.hpp>
|
||||
#include <mbgl/storage/response.hpp>
|
||||
#include <mbgl/util/run_loop.hpp>
|
||||
#include <mbgl/actor/actor.hpp>
|
||||
|
||||
#include <cassert>
|
||||
#include <cmath>
|
||||
@@ -21,10 +24,17 @@ namespace mbgl {
|
||||
static SpriteAtlasObserver nullObserver;
|
||||
|
||||
struct SpriteAtlas::Loader {
|
||||
Loader(Scheduler& scheduler, SpriteAtlas& spriteAtlas)
|
||||
: mailbox(std::make_shared<Mailbox>(*util::RunLoop::Get())),
|
||||
worker(scheduler, ActorRef<SpriteAtlas>(spriteAtlas, mailbox)) {
|
||||
}
|
||||
|
||||
std::shared_ptr<const std::string> image;
|
||||
std::shared_ptr<const std::string> json;
|
||||
std::unique_ptr<AsyncRequest> jsonRequest;
|
||||
std::unique_ptr<AsyncRequest> spriteRequest;
|
||||
std::shared_ptr<Mailbox> mailbox;
|
||||
Actor<SpriteAtlasWorker> worker;
|
||||
};
|
||||
|
||||
SpriteAtlasElement::SpriteAtlasElement(Rect<uint16_t> rect_,
|
||||
@@ -56,14 +66,14 @@ SpriteAtlas::SpriteAtlas(Size size_, float pixelRatio_)
|
||||
|
||||
SpriteAtlas::~SpriteAtlas() = default;
|
||||
|
||||
void SpriteAtlas::load(const std::string& url, FileSource& fileSource) {
|
||||
void SpriteAtlas::load(const std::string& url, Scheduler& scheduler, FileSource& fileSource) {
|
||||
if (url.empty()) {
|
||||
// Treat a non-existent sprite as a successfully loaded empty sprite.
|
||||
loaded = true;
|
||||
markAsLoaded();
|
||||
return;
|
||||
}
|
||||
|
||||
loader = std::make_unique<Loader>();
|
||||
loader = std::make_unique<Loader>(scheduler, *this);
|
||||
|
||||
loader->jsonRequest = fileSource.request(Resource::spriteJSON(url, pixelRatio), [this](Response res) {
|
||||
if (res.error) {
|
||||
@@ -102,18 +112,22 @@ void SpriteAtlas::emitSpriteLoadedIfComplete() {
|
||||
return;
|
||||
}
|
||||
|
||||
auto result = parseSprite(*loader->image, *loader->json);
|
||||
if (result.is<Sprites>()) {
|
||||
loaded = true;
|
||||
setSprites(result.get<Sprites>());
|
||||
observer->onSpriteLoaded();
|
||||
for (auto requestor : requestors) {
|
||||
requestor->onIconsAvailable(this, buildIconMap());
|
||||
}
|
||||
requestors.clear();
|
||||
} else {
|
||||
observer->onSpriteError(result.get<std::exception_ptr>());
|
||||
loader->worker.invoke(&SpriteAtlasWorker::parse, loader->image, loader->json);
|
||||
// TODO: delete the loader?
|
||||
}
|
||||
|
||||
void SpriteAtlas::onParsed(Sprites&& result) {
|
||||
markAsLoaded();
|
||||
setSprites(result);
|
||||
observer->onSpriteLoaded();
|
||||
for (auto requestor : requestors) {
|
||||
requestor->onIconsAvailable(this, buildIconMap());
|
||||
}
|
||||
requestors.clear();
|
||||
}
|
||||
|
||||
void SpriteAtlas::onError(std::exception_ptr err) {
|
||||
observer->onSpriteError(err);
|
||||
}
|
||||
|
||||
void SpriteAtlas::setObserver(SpriteAtlasObserver* observer_) {
|
||||
|
||||
@@ -15,6 +15,7 @@
|
||||
|
||||
namespace mbgl {
|
||||
|
||||
class Scheduler;
|
||||
class FileSource;
|
||||
class SpriteAtlasObserver;
|
||||
|
||||
@@ -56,7 +57,11 @@ public:
|
||||
SpriteAtlas(Size, float pixelRatio);
|
||||
~SpriteAtlas();
|
||||
|
||||
void load(const std::string& url, FileSource&);
|
||||
void load(const std::string& url, Scheduler&, FileSource&);
|
||||
|
||||
void markAsLoaded() {
|
||||
loaded = true;
|
||||
}
|
||||
|
||||
bool isLoaded() const {
|
||||
return loaded;
|
||||
@@ -97,6 +102,10 @@ private:
|
||||
void _setSprite(const std::string&, const std::shared_ptr<const SpriteImage>& = nullptr);
|
||||
void emitSpriteLoadedIfComplete();
|
||||
|
||||
// Invoked by SpriteAtlasWorker
|
||||
friend class SpriteAtlasWorker;
|
||||
void onParsed(Sprites&& result);
|
||||
void onError(std::exception_ptr);
|
||||
|
||||
const Size size;
|
||||
const float pixelRatio;
|
||||
|
||||
29
src/mbgl/sprite/sprite_atlas_worker.cpp
Normal file
29
src/mbgl/sprite/sprite_atlas_worker.cpp
Normal file
@@ -0,0 +1,29 @@
|
||||
#include <mbgl/sprite/sprite_atlas_worker.hpp>
|
||||
#include <mbgl/sprite/sprite_atlas.hpp>
|
||||
#include <mbgl/sprite/sprite_parser.hpp>
|
||||
|
||||
namespace mbgl {
|
||||
|
||||
SpriteAtlasWorker::SpriteAtlasWorker(ActorRef<SpriteAtlasWorker>, ActorRef<SpriteAtlas> parent_)
|
||||
: parent(std::move(parent_)) {
|
||||
}
|
||||
|
||||
void SpriteAtlasWorker::parse(std::shared_ptr<const std::string> image,
|
||||
std::shared_ptr<const std::string> json) {
|
||||
try {
|
||||
if (!image) {
|
||||
// This shouldn't happen, since we always invoke it with a non-empty pointer.
|
||||
throw std::runtime_error("missing sprite image");
|
||||
}
|
||||
if (!json) {
|
||||
// This shouldn't happen, since we always invoke it with a non-empty pointer.
|
||||
throw std::runtime_error("missing sprite metadata");
|
||||
}
|
||||
|
||||
parent.invoke(&SpriteAtlas::onParsed, parseSprite(*image, *json));
|
||||
} catch (...) {
|
||||
parent.invoke(&SpriteAtlas::onError, std::current_exception());
|
||||
}
|
||||
}
|
||||
|
||||
} // namespace mbgl
|
||||
23
src/mbgl/sprite/sprite_atlas_worker.hpp
Normal file
23
src/mbgl/sprite/sprite_atlas_worker.hpp
Normal file
@@ -0,0 +1,23 @@
|
||||
#pragma once
|
||||
|
||||
#include <mbgl/actor/actor_ref.hpp>
|
||||
#include <mbgl/sprite/sprite_parser.hpp>
|
||||
|
||||
#include <memory>
|
||||
#include <string>
|
||||
|
||||
namespace mbgl {
|
||||
|
||||
class SpriteAtlas;
|
||||
|
||||
class SpriteAtlasWorker {
|
||||
public:
|
||||
SpriteAtlasWorker(ActorRef<SpriteAtlasWorker>, ActorRef<SpriteAtlas>);
|
||||
|
||||
void parse(std::shared_ptr<const std::string> image, std::shared_ptr<const std::string> json);
|
||||
|
||||
private:
|
||||
ActorRef<SpriteAtlas> parent;
|
||||
};
|
||||
|
||||
} // namespace mbgl
|
||||
@@ -84,26 +84,19 @@ bool getBoolean(const JSValue& value, const char* name, const bool def = false)
|
||||
|
||||
} // namespace
|
||||
|
||||
SpriteParseResult parseSprite(const std::string& image, const std::string& json) {
|
||||
Sprites sprites;
|
||||
PremultipliedImage raster;
|
||||
|
||||
try {
|
||||
raster = decodeImage(image);
|
||||
} catch (...) {
|
||||
return std::current_exception();
|
||||
}
|
||||
Sprites parseSprite(const std::string& image, const std::string& json) {
|
||||
const PremultipliedImage raster = decodeImage(image);
|
||||
|
||||
JSDocument doc;
|
||||
doc.Parse<0>(json.c_str());
|
||||
|
||||
if (doc.HasParseError()) {
|
||||
std::stringstream message;
|
||||
message << "Failed to parse JSON: " << rapidjson::GetParseError_En(doc.GetParseError()) << " at offset " << doc.GetErrorOffset();
|
||||
return std::make_exception_ptr(std::runtime_error(message.str()));
|
||||
throw std::runtime_error(message.str());
|
||||
} else if (!doc.IsObject()) {
|
||||
return std::make_exception_ptr(std::runtime_error("Sprite JSON root must be an object"));
|
||||
throw std::runtime_error("Sprite JSON root must be an object");
|
||||
} else {
|
||||
Sprites sprites;
|
||||
for (const auto& property : doc.GetObject()) {
|
||||
const std::string name = { property.name.GetString(), property.name.GetStringLength() };
|
||||
const JSValue& value = property.value;
|
||||
@@ -122,9 +115,8 @@ SpriteParseResult parseSprite(const std::string& image, const std::string& json)
|
||||
}
|
||||
}
|
||||
}
|
||||
return sprites;
|
||||
}
|
||||
|
||||
return sprites;
|
||||
}
|
||||
|
||||
} // namespace mbgl
|
||||
|
||||
@@ -26,12 +26,7 @@ SpriteImagePtr createSpriteImage(const PremultipliedImage&,
|
||||
|
||||
using Sprites = std::map<std::string, SpriteImagePtr>;
|
||||
|
||||
|
||||
using SpriteParseResult = variant<
|
||||
Sprites, // success
|
||||
std::exception_ptr>; // error
|
||||
|
||||
// Parses an image and an associated JSON file and returns the sprite objects.
|
||||
SpriteParseResult parseSprite(const std::string& image, const std::string& json);
|
||||
Sprites parseSprite(const std::string& image, const std::string& json);
|
||||
|
||||
} // namespace mbgl
|
||||
|
||||
@@ -40,8 +40,9 @@ namespace style {
|
||||
|
||||
static Observer nullObserver;
|
||||
|
||||
Style::Style(FileSource& fileSource_, float pixelRatio)
|
||||
: fileSource(fileSource_),
|
||||
Style::Style(Scheduler& scheduler_, FileSource& fileSource_, float pixelRatio)
|
||||
: scheduler(scheduler_),
|
||||
fileSource(fileSource_),
|
||||
glyphAtlas(std::make_unique<GlyphAtlas>(Size{ 2048, 2048 }, fileSource)),
|
||||
spriteAtlas(std::make_unique<SpriteAtlas>(Size{ 1024, 1024 }, pixelRatio)),
|
||||
lineAtlas(std::make_unique<LineAtlas>(Size{ 256, 512 })),
|
||||
@@ -133,7 +134,7 @@ void Style::setJSON(const std::string& json) {
|
||||
defaultPitch = parser.pitch;
|
||||
|
||||
glyphAtlas->setURL(parser.glyphURL);
|
||||
spriteAtlas->load(parser.spriteURL, fileSource);
|
||||
spriteAtlas->load(parser.spriteURL, scheduler, fileSource);
|
||||
|
||||
loaded = true;
|
||||
|
||||
|
||||
@@ -30,6 +30,7 @@ class LineAtlas;
|
||||
class RenderData;
|
||||
class TransformState;
|
||||
class RenderedQueryOptions;
|
||||
class Scheduler;
|
||||
|
||||
namespace style {
|
||||
|
||||
@@ -43,7 +44,7 @@ class Style : public GlyphAtlasObserver,
|
||||
public LayerObserver,
|
||||
public util::noncopyable {
|
||||
public:
|
||||
Style(FileSource&, float pixelRatio);
|
||||
Style(Scheduler&, FileSource&, float pixelRatio);
|
||||
~Style() override;
|
||||
|
||||
void setJSON(const std::string&);
|
||||
@@ -106,6 +107,7 @@ public:
|
||||
|
||||
void dumpDebugLogs() const;
|
||||
|
||||
Scheduler& scheduler;
|
||||
FileSource& fileSource;
|
||||
std::unique_ptr<GlyphAtlas> glyphAtlas;
|
||||
std::unique_ptr<SpriteAtlas> spriteAtlas;
|
||||
|
||||
Reference in New Issue
Block a user