Skip to content

Commit c2ea329

Browse files
Add a RAII wrapper around pngdec (#15)
* Add a RAII wrapper around pngdec
1 parent 32d36b6 commit c2ea329

File tree

3 files changed

+83
-7
lines changed

3 files changed

+83
-7
lines changed

src/OpenStreetMap-esp32.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -383,10 +383,10 @@ bool OpenStreetMap::fetchTile(CachedTile &tile, uint32_t x, uint32_t y, uint8_t
383383
if (!buffer)
384384
return false;
385385

386-
const int16_t rc = png.openRAM(buffer.value()->get(), buffer.value()->size(), PNGDraw);
387-
if (rc != PNG_SUCCESS)
386+
PNGDecoderRAII png(PNGDraw);
387+
if (!png.open(buffer.value()->get(), buffer.value()->size()))
388388
{
389-
result = "PNG Decoder Error: " + String(rc);
389+
result = "PNG Decoder Error";
390390
return false;
391391
}
392392

src/OpenStreetMap-esp32.h

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,16 @@
2525
#define OPENSTREETMAP_ESP32_H
2626

2727
#include <Arduino.h>
28-
#include <HTTPClient.h>
2928
#include <WiFiClient.h>
3029
#include <SD.h>
3130
#include <vector>
3231
#include <optional>
33-
#include <memory>
3432
#include <LovyanGFX.hpp>
35-
#include <PNGdec.h>
3633

3734
#include "CachedTile.h"
3835
#include "MemoryBuffer.h"
3936
#include "HTTPClientRAII.h"
37+
#include "pngdecRAII.h"
4038

4139
constexpr uint16_t OSM_TILESIZE = 256;
4240
constexpr uint16_t OSM_TILE_TIMEOUT_MS = 2500;
@@ -77,7 +75,6 @@ class OpenStreetMap
7775

7876
std::vector<CachedTile> tilesCache;
7977
uint16_t *currentTileBuffer = nullptr;
80-
PNG png;
8178

8279
uint16_t mapWidth = 320;
8380
uint16_t mapHeight = 240;

src/pngdecRAII.h

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
/*
2+
Copyright (c) 2025 Cellie https://github.com/CelliesProjects/OpenStreetMap-esp32
3+
4+
Permission is hereby granted, free of charge, to any person obtaining a copy
5+
of this software and associated documentation files (the "Software"), to deal
6+
in the Software without restriction, including without limitation the rights
7+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8+
copies of the Software, and to permit persons to whom the Software is
9+
furnished to do so, subject to the following conditions:
10+
11+
The above copyright notice and this permission notice shall be included in all
12+
copies or substantial portions of the Software.
13+
14+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20+
SOFTWARE.
21+
SPDX-License-Identifier: MIT
22+
*/
23+
24+
#ifndef PNGDEC_RAII_H
25+
#define PNGDEC_RAII_H
26+
27+
#include <PNGdec.h>
28+
29+
class PNGDecoderRAII
30+
{
31+
public:
32+
explicit PNGDecoderRAII(PNG_DRAW_CALLBACK *drawCallback)
33+
: callback(drawCallback), isOpen(false) {}
34+
35+
PNGDecoderRAII(const PNGDecoderRAII &) = delete;
36+
PNGDecoderRAII &operator=(const PNGDecoderRAII &) = delete;
37+
38+
~PNGDecoderRAII()
39+
{
40+
close();
41+
}
42+
43+
bool open(uint8_t *pngData, size_t dataSize)
44+
{
45+
if (isOpen)
46+
close();
47+
48+
int result = png.openRAM(pngData, dataSize, callback);
49+
isOpen = (result == PNG_SUCCESS);
50+
return isOpen;
51+
}
52+
53+
int decode(void *pPriv = NULL, uint8_t options = 0)
54+
{
55+
if (!isOpen)
56+
return PNG_INVALID_PARAMETER;
57+
58+
return png.decode(pPriv, options);
59+
}
60+
61+
int getWidth() const { return png.getWidth(); }
62+
int getHeight() const { return png.getHeight(); }
63+
64+
void close()
65+
{
66+
if (isOpen)
67+
{
68+
png.close();
69+
isOpen = false;
70+
}
71+
}
72+
73+
private:
74+
PNGdec png;
75+
PNG_DRAW_CALLBACK *callback;
76+
bool isOpen;
77+
};
78+
79+
#endif // PNGDEC_RAII_H

0 commit comments

Comments
 (0)