Skip to content

Fixes and cleanup #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 18, 2025
Merged

Fixes and cleanup #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
82ab593
Fixes and cleanup
CelliesProjects Mar 17, 2025
4d2853f
Refactored fetchMap
CelliesProjects Mar 18, 2025
57688e5
Cleanup
CelliesProjects Mar 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
152 changes: 75 additions & 77 deletions src/OpenStreetMap-esp32.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ void OpenStreetMap::PNGDraw(PNGDRAW *pDraw)
currentInstance->png.getLineAsRGB565(pDraw, destRow, PNG_RGB565_BIG_ENDIAN, 0x0000);
}

void OpenStreetMap::computeRequiredTiles(double longitude, double latitude, uint8_t zoom, tileVector &requiredTiles)
void OpenStreetMap::computeRequiredTiles(double longitude, double latitude, uint8_t zoom, tileList &requiredTiles)
{
// Compute exact tile coordinates
const double exactTileX = lon2tile(longitude, zoom);
Expand Down Expand Up @@ -100,21 +100,21 @@ void OpenStreetMap::computeRequiredTiles(double longitude, double latitude, uint
bool OpenStreetMap::isTileCached(uint32_t x, uint32_t y, uint8_t z)
{
for (const auto &tile : tilesCache)
if (tile.valid && tile.x == x && tile.y == y && tile.z == z)
if (tile.x == x && tile.y == y && tile.z == z && tile.valid)
return true;

return false;
}

CachedTile *OpenStreetMap::findUnusedTile(const tileVector &requiredTiles, uint8_t zoom)
CachedTile *OpenStreetMap::findUnusedTile(const tileList &requiredTiles, uint8_t zoom)
{
for (auto &tile : tilesCache)
{
// If a tile is valid but not required in the current frame, we can replace it
bool needed = false;
for (const auto &[x, y] : requiredTiles)
{
if (tile.valid && tile.x == x && tile.y == y && tile.z == zoom)
if (tile.x == x && tile.y == y && tile.z == zoom && tile.valid)
{
needed = true;
break;
Expand Down Expand Up @@ -161,21 +161,60 @@ bool OpenStreetMap::resizeTilesCache(uint8_t cacheSize)
return true;
}

void OpenStreetMap::updateCache(tileVector &requiredTiles, uint8_t zoom)
void OpenStreetMap::updateCache(tileList &requiredTiles, uint8_t zoom)
{
for (const auto &[x, y] : requiredTiles)
{
if (!isTileCached(x, y, zoom))
{
CachedTile *tileToReplace = findUnusedTile(requiredTiles, zoom);
String result;
const bool success = downloadAndDecodeTile(*tileToReplace, x, y, zoom, result);
if (!success)
if (!downloadAndDecodeTile(*tileToReplace, x, y, zoom, result))
log_e("%s", result.c_str());
}
}
}

log_i("%s", result.c_str());
bool OpenStreetMap::composeMap(LGFX_Sprite &mapSprite, tileList &requiredTiles, uint8_t zoom)
{
if (mapSprite.width() != mapWidth || mapSprite.height() != mapHeight)
{
mapSprite.deleteSprite();
mapSprite.setPsram(true);
mapSprite.setColorDepth(lgfx::rgb565_2Byte);
mapSprite.createSprite(mapWidth, mapHeight);
if (!mapSprite.getBuffer())
{
log_e("could not allocate");
return false;
}
}
}

int tileIndex = 0;
for (const auto &[tileX, tileY] : requiredTiles)
{
int drawX = startOffsetX + (tileIndex % numberOfColums) * OSM_TILESIZE;
int drawY = startOffsetY + (tileIndex / numberOfColums) * OSM_TILESIZE;

auto it = std::find_if(tilesCache.begin(), tilesCache.end(),
[&](const CachedTile &tile)
{
return tile.valid && tile.x == tileX && tile.y == tileY && tile.z == zoom;
});

if (it != tilesCache.end())
mapSprite.pushImage(drawX, drawY, OSM_TILESIZE, OSM_TILESIZE, it->buffer);
else
log_w("Tile (%d, %d) not found in cache", tileX, tileY);

tileIndex++;
}

const char *attribution = " Map data from OpenStreetMap.org ";
mapSprite.setTextColor(TFT_WHITE, TFT_BLACK);
mapSprite.drawRightString(attribution, mapSprite.width(), mapSprite.height() - 10, &DejaVu9);

return true;
}

bool OpenStreetMap::fetchMap(LGFX_Sprite &mapSprite, double longitude, double latitude, uint8_t zoom)
Expand All @@ -188,21 +227,25 @@ bool OpenStreetMap::fetchMap(LGFX_Sprite &mapSprite, double longitude, double la

if (!mapWidth || !mapHeight)
{
log_e("Invalid map dimensions: width=%d, height=%d", mapWidth, mapHeight);
log_e("Invalid map dimension");
return false;
}

if (!tilesCache.capacity())
{
log_w("Cache not initialized, setting up a default cache...");
resizeTilesCache(10);
if (!resizeTilesCache(OSM_DEFAULT_CACHE_ITEMS))
{
log_e("Could not allocate cache");
return false;
}
}

// normalize the coordinates
longitude = fmod(longitude + 180.0, 360.0) - 180.0;
latitude = std::clamp(latitude, -90.0, 90.0);

tileVector requiredTiles;
tileList requiredTiles;
computeRequiredTiles(longitude, latitude, zoom, requiredTiles);

if (tilesCache.capacity() < requiredTiles.size())
Expand All @@ -211,59 +254,14 @@ bool OpenStreetMap::fetchMap(LGFX_Sprite &mapSprite, double longitude, double la
return false;
}

for (const auto &[x, y] : requiredTiles)
{
if (!isTileCached(x, y, zoom))
{
CachedTile *tileToReplace = findUnusedTile(requiredTiles, zoom);
String result;
const bool success = downloadAndDecodeTile(*tileToReplace, x, y, zoom, result);
if (!success)
log_e("%s", result.c_str());
updateCache(requiredTiles, zoom);

log_i("%s", result.c_str());
}
}

if (mapSprite.width() != mapWidth || mapSprite.height() != mapHeight)
if (!composeMap(mapSprite, requiredTiles, zoom))
{
mapSprite.deleteSprite();
mapSprite.setPsram(true);
mapSprite.setColorDepth(lgfx::rgb565_2Byte);
mapSprite.createSprite(mapWidth, mapHeight);
}

if (mapSprite.getBuffer() == nullptr)
{
log_e("could not allocate");
log_e("Failed to compose map");
return false;
}

int tileIndex = 0;
for (const auto &[tileX, tileY] : requiredTiles)
{
int drawX = startOffsetX + (tileIndex % numberOfColums) * OSM_TILESIZE;
int drawY = startOffsetY + (tileIndex / numberOfColums) * OSM_TILESIZE;

auto it = std::find_if(tilesCache.begin(), tilesCache.end(),
[&](const CachedTile &tile)
{
return tile.valid && tile.x == tileX && tile.y == tileY && tile.z == zoom;
});

if (it != tilesCache.end())
mapSprite.pushImage(drawX, drawY, OSM_TILESIZE, OSM_TILESIZE, it->buffer);

else
log_w("Tile (%d, %d) not found in cache", tileX, tileY);

tileIndex++;
}

const char *attribution = " Map data from OpenStreetMap.org ";
mapSprite.setTextColor(TFT_WHITE, TFT_BLACK);
mapSprite.drawRightString(attribution, mapSprite.width(), mapSprite.height() - 10, &DejaVu9);

return true;
}

Expand Down Expand Up @@ -313,7 +311,7 @@ bool OpenStreetMap::downloadAndDecodeTile(CachedTile &tile, uint32_t x, uint32_t
return false;
}

constexpr unsigned long TIMEOUT_MS = 500;
constexpr unsigned long TIMEOUT_MS = 900;
size_t readSize = 0;
unsigned long lastReadTime = millis();

Expand Down Expand Up @@ -409,22 +407,22 @@ bool OpenStreetMap::saveMap(const char *filename, LGFX_Sprite &sprite, String &r
uint32_t biClrImportant = 0;

// Write BMP header
file.write(reinterpret_cast<const uint8_t*>(&bfType), sizeof(bfType));
file.write(reinterpret_cast<const uint8_t*>(&bfSize), sizeof(bfSize));
file.write(reinterpret_cast<const uint8_t*>(&bfReserved), sizeof(bfReserved));
file.write(reinterpret_cast<const uint8_t*>(&bfOffBits), sizeof(bfOffBits));

file.write(reinterpret_cast<const uint8_t*>(&biSize), sizeof(biSize));
file.write(reinterpret_cast<const uint8_t*>(&biWidth), sizeof(biWidth));
file.write(reinterpret_cast<const uint8_t*>(&biHeight), sizeof(biHeight));
file.write(reinterpret_cast<const uint8_t*>(&biPlanes), sizeof(biPlanes));
file.write(reinterpret_cast<const uint8_t*>(&biBitCount), sizeof(biBitCount));
file.write(reinterpret_cast<const uint8_t*>(&biCompression), sizeof(biCompression));
file.write(reinterpret_cast<const uint8_t*>(&biSizeImage), sizeof(biSizeImage));
file.write(reinterpret_cast<const uint8_t*>(&biXPelsPerMeter), sizeof(biXPelsPerMeter));
file.write(reinterpret_cast<const uint8_t*>(&biYPelsPerMeter), sizeof(biYPelsPerMeter));
file.write(reinterpret_cast<const uint8_t*>(&biClrUsed), sizeof(biClrUsed));
file.write(reinterpret_cast<const uint8_t*>(&biClrImportant), sizeof(biClrImportant));
file.write(reinterpret_cast<const uint8_t *>(&bfType), sizeof(bfType));
file.write(reinterpret_cast<const uint8_t *>(&bfSize), sizeof(bfSize));
file.write(reinterpret_cast<const uint8_t *>(&bfReserved), sizeof(bfReserved));
file.write(reinterpret_cast<const uint8_t *>(&bfOffBits), sizeof(bfOffBits));

file.write(reinterpret_cast<const uint8_t *>(&biSize), sizeof(biSize));
file.write(reinterpret_cast<const uint8_t *>(&biWidth), sizeof(biWidth));
file.write(reinterpret_cast<const uint8_t *>(&biHeight), sizeof(biHeight));
file.write(reinterpret_cast<const uint8_t *>(&biPlanes), sizeof(biPlanes));
file.write(reinterpret_cast<const uint8_t *>(&biBitCount), sizeof(biBitCount));
file.write(reinterpret_cast<const uint8_t *>(&biCompression), sizeof(biCompression));
file.write(reinterpret_cast<const uint8_t *>(&biSizeImage), sizeof(biSizeImage));
file.write(reinterpret_cast<const uint8_t *>(&biXPelsPerMeter), sizeof(biXPelsPerMeter));
file.write(reinterpret_cast<const uint8_t *>(&biYPelsPerMeter), sizeof(biYPelsPerMeter));
file.write(reinterpret_cast<const uint8_t *>(&biClrUsed), sizeof(biClrUsed));
file.write(reinterpret_cast<const uint8_t *>(&biClrImportant), sizeof(biClrImportant));

for (int y = 0; y < sprite.height(); y++)
{
Expand Down
10 changes: 6 additions & 4 deletions src/OpenStreetMap-esp32.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@
#include "MemoryBuffer.h"

constexpr int16_t OSM_TILESIZE = 256;
constexpr uint8_t OSM_DEFAULT_CACHE_ITEMS = 10;

using tileVector = std::vector<std::pair<uint32_t, uint32_t>>;
using tileList = std::vector<std::pair<uint32_t, uint32_t>>;

class OpenStreetMap
{
Expand Down Expand Up @@ -44,7 +45,7 @@ class OpenStreetMap

void setResolution(uint16_t w, uint16_t h);
bool resizeTilesCache(uint8_t cacheSize);
void updateCache(tileVector &requiredTiles, uint8_t zoom);
void updateCache(tileList &requiredTiles, uint8_t zoom);
void freeTilesCache();
bool fetchMap(LGFX_Sprite &sprite, double longitude, double latitude, uint8_t zoom);
bool saveMap(const char *filename, LGFX_Sprite &display, String &result, uint8_t sdPin = SS);
Expand All @@ -54,10 +55,11 @@ class OpenStreetMap
static void PNGDraw(PNGDRAW *pDraw);
double lon2tile(double lon, uint8_t zoom);
double lat2tile(double lat, uint8_t zoom);
void computeRequiredTiles(double longitude, double latitude, uint8_t zoom, tileVector &requiredTiles);
CachedTile *findUnusedTile(const tileVector &requiredTiles, uint8_t zoom);
void computeRequiredTiles(double longitude, double latitude, uint8_t zoom, tileList &requiredTiles);
CachedTile *findUnusedTile(const tileList &requiredTiles, uint8_t zoom);
bool isTileCached(uint32_t x, uint32_t y, uint8_t z);
bool downloadAndDecodeTile(CachedTile &tile, uint32_t x, uint32_t y, uint8_t zoom, String &result);
bool composeMap(LGFX_Sprite &mapSprite, tileList &requiredTiles, uint8_t zoom);
};

#endif