#include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #define _USE_MATH_DEFINES #include #include // Check libuv library version. const static bool uvVersionCheck = []() { const unsigned int version = uv_version(); const unsigned int major = (version >> 16) & 0xFF; const unsigned int minor = (version >> 8) & 0xFF; const unsigned int patch = version & 0xFF; #ifndef UV_VERSION_PATCH // 0.10 doesn't have UV_VERSION_PATCH defined, so we "fake" it by using the library patch level. const unsigned int UV_VERSION_PATCH = version & 0xFF; #endif if (major != UV_VERSION_MAJOR || minor != UV_VERSION_MINOR || patch != UV_VERSION_PATCH) { throw std::runtime_error(mbgl::util::sprintf<96>( "libuv version mismatch: headers report %d.%d.%d, but library reports %d.%d.%d", UV_VERSION_MAJOR, UV_VERSION_MINOR, UV_VERSION_PATCH, major, minor, patch)); } return true; }(); using namespace mbgl; Map::Map(View& view_, FileSource& fileSource_) : env(util::make_unique(fileSource_)), scope(util::make_unique(*env, ThreadType::Main, "Main")), view(view_), transform(view_), fileSource(fileSource_), glyphAtlas(util::make_unique(1024, 1024)), glyphStore(std::make_shared(*env)), spriteAtlas(util::make_unique(512, 512)), lineAtlas(util::make_unique(512, 512)), texturePool(std::make_shared()), painter(util::make_unique(*spriteAtlas, *glyphAtlas, *lineAtlas)), annotationManager(util::make_unique()), data(util::make_unique()), updated(static_cast(Update::Nothing)) { view.initialize(this); } Map::~Map() { if (mode == Mode::Continuous) { stop(); } // Extend the scope to include both Main and Map thread types to ease cleanup. scope.reset(); scope = util::make_unique( *env, static_cast(static_cast(ThreadType::Main) | static_cast(ThreadType::Map)), "MapandMain"); // Explicitly reset all pointers. sprite.reset(); glyphStore.reset(); style.reset(); workers.reset(); painter.reset(); annotationManager.reset(); lineAtlas.reset(); spriteAtlas.reset(); glyphAtlas.reset(); uv_run(env->loop, UV_RUN_DEFAULT); env->performCleanup(); } uv::worker &Map::getWorker() { assert(workers); return *workers; } void Map::start(bool startPaused) { assert(Environment::currentlyOn(ThreadType::Main)); assert(mode == Mode::None); // When starting map rendering in another thread, we perform async/continuously // updated rendering. Only in these cases, we attach the async handlers. mode = Mode::Continuous; // Reset the flag. isStopped = false; // Setup async notifications asyncTerminate = util::make_unique(env->loop, [this]() { assert(Environment::currentlyOn(ThreadType::Map)); // Remove all of these to make sure they are destructed in the correct thread. style.reset(); // It's now safe to destroy/join the workers since there won't be any more callbacks that // could dispatch to the worker pool. workers.reset(); terminating = true; // Closes all open handles on the loop. This means that the loop will automatically terminate. asyncRender.reset(); asyncUpdate.reset(); asyncInvoke.reset(); asyncTerminate.reset(); }); asyncUpdate = util::make_unique(env->loop, [this] { update(); }); asyncInvoke = util::make_unique(env->loop, [this] { processTasks(); }); asyncRender = util::make_unique(env->loop, [this] { // Must be called in Map thread. assert(Environment::currentlyOn(ThreadType::Map)); render(); // Finally, notify all listeners that we have finished rendering this frame. { std::lock_guard lk(mutexRendered); rendered = true; } condRendered.notify_all(); }); // Do we need to pause first? if (startPaused) { pause(); } thread = std::thread([this]() { #ifdef __APPLE__ pthread_setname_np("Map"); #endif run(); // Make sure that the stop() function knows when to stop invoking the callback function. isStopped = true; view.notify(); }); triggerUpdate(); } void Map::stop(std::function callback) { assert(Environment::currentlyOn(ThreadType::Main)); assert(mode == Mode::Continuous); asyncTerminate->send(); resume(); if (callback) { // Wait until the render thread stopped. We are using this construct instead of plainly // relying on the thread_join because the system might need to run things in the current // thread that is required for the render thread to terminate correctly. This is for example // the case with Cocoa's NSURLRequest. Otherwise, we will eventually deadlock because this // thread (== main thread) is blocked. The callback function should use an efficient waiting // function to avoid a busy waiting loop. while (!isStopped) { callback(); } } // If a callback function was provided, this should return immediately because the thread has // already finished executing. thread.join(); mode = Mode::None; } void Map::pause(bool waitForPause) { assert(Environment::currentlyOn(ThreadType::Main)); assert(mode == Mode::Continuous); mutexRun.lock(); pausing = true; mutexRun.unlock(); uv_stop(env->loop); triggerUpdate(); // Needed to ensure uv_stop is seen and uv_run exits, otherwise we deadlock on wait_for_pause if (waitForPause) { std::unique_lock lockPause (mutexPause); while (!isPaused) { condPause.wait(lockPause); } } } void Map::resume() { assert(Environment::currentlyOn(ThreadType::Main)); assert(mode == Mode::Continuous); mutexRun.lock(); pausing = false; condRun.notify_all(); mutexRun.unlock(); } void Map::run() { ThreadType threadType = ThreadType::Map; std::string threadName("Map"); if (mode == Mode::None) { mode = Mode::Static; // FIXME: Threads should have only one purpose. When running on Static mode, // we are currently not spawning a Map thread and running the code on the // Main thread, thus, the Main thread in this case is both Main and Map thread. threadType = static_cast(static_cast(threadType) | static_cast(ThreadType::Main)); threadName += "andMain"; } EnvironmentScope mapScope(*env, threadType, threadName); if (mode == Mode::Continuous) { checkForPause(); } auto styleInfo = data->getStyleInfo(); if (mode == Mode::Static && !style && (styleInfo.url.empty() && styleInfo.json.empty())) { throw util::Exception("Style is not set"); } view.activate(); workers = util::make_unique(env->loop, 4, "Tile Worker"); setup(); prepare(); if (mode == Mode::Continuous) { terminating = false; while(!terminating) { uv_run(env->loop, UV_RUN_DEFAULT); checkForPause(); } } else { uv_run(env->loop, UV_RUN_DEFAULT); } // Run the event loop once more to make sure our async delete handlers are called. uv_run(env->loop, UV_RUN_ONCE); // If the map rendering wasn't started asynchronously, we perform one render // *after* all events have been processed. if (mode == Mode::Static) { render(); mode = Mode::None; } view.deactivate(); } void Map::renderSync() { // Must be called in UI thread. assert(Environment::currentlyOn(ThreadType::Main)); triggerRender(); std::unique_lock lock(mutexRendered); condRendered.wait(lock, [this] { return rendered; }); rendered = false; } void Map::triggerUpdate(const Update u) { updated |= static_cast(u); if (mode == Mode::Static) { prepare(); } else if (asyncUpdate) { asyncUpdate->send(); } } void Map::triggerRender() { assert(asyncRender); asyncRender->send(); } // Runs the function in the map thread. void Map::invokeTask(std::function&& fn) { { std::lock_guard lock(mutexTask); tasks.emplace(::std::forward>(fn)); } // TODO: Once we have aligned static and continuous rendering, this should always dispatch // to the async queue. if (asyncInvoke) { asyncInvoke->send(); } else { processTasks(); } } template auto Map::invokeSyncTask(const Fn& fn) -> decltype(fn()) { std::promise promise; invokeTask([&fn, &promise] { promise.set_value(fn()); }); return promise.get_future().get(); } // Processes the functions that should be run in the map thread. void Map::processTasks() { std::queue> queue; { std::lock_guard lock(mutexTask); queue.swap(tasks); } while (!queue.empty()) { queue.front()(); queue.pop(); } } void Map::checkForPause() { std::unique_lock lockRun (mutexRun); while (pausing) { view.deactivate(); mutexPause.lock(); isPaused = true; condPause.notify_all(); mutexPause.unlock(); condRun.wait(lockRun); view.activate(); } mutexPause.lock(); isPaused = false; mutexPause.unlock(); } void Map::terminate() { assert(painter); painter->terminate(); view.deactivate(); } #pragma mark - Setup void Map::setup() { assert(Environment::currentlyOn(ThreadType::Map)); assert(painter); painter->setup(); } std::string Map::getStyleURL() const { return data->getStyleInfo().url; } void Map::setStyleURL(const std::string &url) { assert(Environment::currentlyOn(ThreadType::Main)); const std::string styleURL = mbgl::util::mapbox::normalizeStyleURL(url, getAccessToken()); const size_t pos = styleURL.rfind('/'); std::string base = ""; if (pos != std::string::npos) { base = styleURL.substr(0, pos + 1); } data->setStyleInfo({ styleURL, base, "" }); triggerUpdate(Update::StyleInfo); } void Map::setStyleJSON(const std::string& json, const std::string& base) { assert(Environment::currentlyOn(ThreadType::Main)); data->setStyleInfo({ "", base, json }); triggerUpdate(Update::StyleInfo); } std::string Map::getStyleJSON() const { return data->getStyleInfo().json; } util::ptr Map::getSprite() { const float pixelRatio = state.getPixelRatio(); const std::string &sprite_url = style->getSpriteURL(); if (!sprite || !sprite->hasPixelRatio(pixelRatio)) { sprite = Sprite::Create(sprite_url, pixelRatio, *env); } return sprite; } #pragma mark - Size void Map::resize(uint16_t width, uint16_t height, float ratio) { resize(width, height, ratio, width * ratio, height * ratio); } void Map::resize(uint16_t width, uint16_t height, float ratio, uint16_t fbWidth, uint16_t fbHeight) { if (transform.resize(width, height, ratio, fbWidth, fbHeight)) { triggerUpdate(); } } #pragma mark - Transitions void Map::cancelTransitions() { transform.cancelTransitions(); triggerUpdate(); } void Map::setGestureInProgress(bool inProgress) { transform.setGestureInProgress(inProgress); triggerUpdate(); } #pragma mark - Position void Map::moveBy(double dx, double dy, Duration duration) { transform.moveBy(dx, dy, duration); triggerUpdate(); } void Map::setLatLng(LatLng latLng, Duration duration) { transform.setLatLng(latLng, duration); triggerUpdate(); } LatLng Map::getLatLng() const { return transform.getLatLng(); } void Map::resetPosition() { transform.setAngle(0); transform.setLatLng(LatLng(0, 0)); transform.setZoom(0); triggerUpdate(Update::Zoom); } #pragma mark - Scale void Map::scaleBy(double ds, double cx, double cy, Duration duration) { transform.scaleBy(ds, cx, cy, duration); triggerUpdate(Update::Zoom); } void Map::setScale(double scale, double cx, double cy, Duration duration) { transform.setScale(scale, cx, cy, duration); triggerUpdate(Update::Zoom); } double Map::getScale() const { return transform.getScale(); } void Map::setZoom(double zoom, Duration duration) { transform.setZoom(zoom, duration); triggerUpdate(Update::Zoom); } double Map::getZoom() const { return transform.getZoom(); } void Map::setLatLngZoom(LatLng latLng, double zoom, Duration duration) { transform.setLatLngZoom(latLng, zoom, duration); triggerUpdate(Update::Zoom); } void Map::resetZoom() { setZoom(0); } double Map::getMinZoom() const { return transform.getMinZoom(); } double Map::getMaxZoom() const { return transform.getMaxZoom(); } #pragma mark - Rotation void Map::rotateBy(double sx, double sy, double ex, double ey, Duration duration) { transform.rotateBy(sx, sy, ex, ey, duration); triggerUpdate(); } void Map::setBearing(double degrees, Duration duration) { transform.setAngle(-degrees * M_PI / 180, duration); triggerUpdate(); } void Map::setBearing(double degrees, double cx, double cy) { transform.setAngle(-degrees * M_PI / 180, cx, cy); triggerUpdate(); } double Map::getBearing() const { return -transform.getAngle() / M_PI * 180; } void Map::resetNorth() { transform.setAngle(0, std::chrono::milliseconds(500)); triggerUpdate(); } #pragma mark - Access Token void Map::setAccessToken(const std::string &token) { data->setAccessToken(token); } std::string Map::getAccessToken() const { return data->getAccessToken(); } #pragma mark - Annotations void Map::setDefaultPointAnnotationSymbol(const std::string& symbol) { assert(Environment::currentlyOn(ThreadType::Main)); invokeTask([=] { annotationManager->setDefaultPointAnnotationSymbol(symbol); }); } double Map::getTopOffsetPixelsForAnnotationSymbol(const std::string& symbol) { assert(Environment::currentlyOn(ThreadType::Main)); return invokeSyncTask([&] { assert(sprite); const SpritePosition pos = sprite->getSpritePosition(symbol); return -pos.height / pos.pixelRatio / 2; }); } uint32_t Map::addPointAnnotation(const LatLng& point, const std::string& symbol) { return addPointAnnotations({ point }, { symbol }).front(); } std::vector Map::addPointAnnotations(const std::vector& points, const std::vector& symbols) { assert(Environment::currentlyOn(ThreadType::Main)); return invokeSyncTask([&] { auto result = annotationManager->addPointAnnotations(points, symbols, *this); updateAnnotationTiles(result.first); return result.second; }); } void Map::removeAnnotation(uint32_t annotation) { assert(Environment::currentlyOn(ThreadType::Main)); removeAnnotations({ annotation }); } void Map::removeAnnotations(const std::vector& annotations) { assert(Environment::currentlyOn(ThreadType::Main)); invokeTask([=] { auto result = annotationManager->removeAnnotations(annotations, *this); updateAnnotationTiles(result); }); } std::vector Map::getAnnotationsInBounds(const LatLngBounds& bounds) { assert(Environment::currentlyOn(ThreadType::Main)); return invokeSyncTask([&] { return annotationManager->getAnnotationsInBounds(bounds, *this); }); } LatLngBounds Map::getBoundsForAnnotations(const std::vector& annotations) { assert(Environment::currentlyOn(ThreadType::Main)); return invokeSyncTask([&] { return annotationManager->getBoundsForAnnotations(annotations); }); } void Map::updateAnnotationTiles(const std::vector& ids) { assert(Environment::currentlyOn(ThreadType::Map)); if (!style) return; for (const auto &source : style->sources) { if (source->info.type == SourceType::Annotations) { source->invalidateTiles(ids); } } triggerUpdate(); } #pragma mark - Toggles void Map::setDebug(bool value) { data->setDebug(value); triggerUpdate(Update::Debug); } void Map::toggleDebug() { data->toggleDebug(); triggerUpdate(Update::Debug); } bool Map::getDebug() const { return data->getDebug(); } TimePoint Map::getTime() const { return data->getAnimationTime(); } void Map::addClass(const std::string& klass) { if (data->addClass(klass)) { triggerUpdate(Update::Classes); } } void Map::removeClass(const std::string& klass) { if (data->removeClass(klass)) { triggerUpdate(Update::Classes); } } void Map::setClasses(const std::vector& classes) { data->setClasses(classes); triggerUpdate(Update::Classes); } bool Map::hasClass(const std::string& klass) const { return data->hasClass(klass); } std::vector Map::getClasses() const { return data->getClasses(); } void Map::setDefaultTransitionDuration(Duration duration) { assert(Environment::currentlyOn(ThreadType::Main)); data->setDefaultTransitionDuration(duration); triggerUpdate(Update::DefaultTransitionDuration); } Duration Map::getDefaultTransitionDuration() { assert(Environment::currentlyOn(ThreadType::Main)); return data->getDefaultTransitionDuration(); } void Map::updateTiles() { assert(Environment::currentlyOn(ThreadType::Map)); if (!style) return; for (const auto& source : style->sources) { source->update(*this, getWorker(), style, *glyphAtlas, *glyphStore, *spriteAtlas, getSprite(), *texturePool, [this]() { assert(Environment::currentlyOn(ThreadType::Map)); triggerUpdate(); }); } } void Map::update() { assert(Environment::currentlyOn(ThreadType::Map)); if (state.hasSize()) { prepare(); } } void Map::reloadStyle() { assert(Environment::currentlyOn(ThreadType::Map)); style = std::make_shared