Files
Crosspoint/src/util/ScreenshotUtil.cpp
T
Zach Nelson 23aad213fc refactor: Removed redundant FsFile close() calls (#1434)
## Summary

**What is the goal of this PR?** (e.g., Implements the new feature for
file uploading.)

`DESTRUCTOR_CLOSES_FILE=1` is set in platformio.ini, which makes SdFat's
FsBaseFile destructor call close() automatically when a file goes out of
scope.

Three categories of file close calls remain untouched:
1. Close before Storage.remove() on the same path: ScreenshotUtil.cpp
closes the file before deleting it on write error. The remove might fail
if the file is still open.
2. Close before reopening the same variable: Epub.cpp writes a temp
NCX/nav file, closes it, then reopens it for reading. The
RecentBooksStore.cpp close before saveToFile() is the same pattern, it
rewrites the same file.
3. Close on member variables: BookMetadataCache.cpp (bookFile,
spineFile, tocFile), Section.cpp (file), XtcParser.cpp (m_file),
ZipFile.cpp (file). These persist beyond any single function scope, so
the destructor timing doesn't match the intended close point.

---

### AI Usage

While CrossPoint doesn't have restrictions on AI tools in contributing,
please be transparent about their usage as it
helps set the right context for reviewers.

Did you use AI tools to help write this code? _**PARTIALLY**_
2026-04-14 16:41:05 -05:00

121 lines
3.8 KiB
C++

#include "ScreenshotUtil.h"
#include <Arduino.h>
#include <BitmapHelpers.h>
#include <GfxRenderer.h>
#include <HalStorage.h>
#include <Logging.h>
#include <string>
#include "Bitmap.h" // Required for BmpHeader struct definition
void ScreenshotUtil::takeScreenshot(GfxRenderer& renderer) {
const uint8_t* fb = renderer.getFrameBuffer();
if (fb) {
String filename_str = "/screenshots/screenshot-" + String(millis()) + ".bmp";
if (ScreenshotUtil::saveFramebufferAsBmp(filename_str.c_str(), fb, renderer.getDisplayWidth(),
renderer.getDisplayHeight())) {
LOG_DBG("SCR", "Screenshot saved to %s", filename_str.c_str());
} else {
LOG_ERR("SCR", "Failed to save screenshot");
}
} else {
LOG_ERR("SCR", "Framebuffer not available");
}
// Display a border around the screen to indicate a screenshot was taken
if (renderer.storeBwBuffer()) {
renderer.drawRect(6, 6, renderer.getDisplayHeight() - 12, renderer.getDisplayWidth() - 12, 2, true);
renderer.displayBuffer();
delay(1000);
renderer.restoreBwBuffer();
renderer.displayBuffer(HalDisplay::RefreshMode::HALF_REFRESH);
}
}
bool ScreenshotUtil::saveFramebufferAsBmp(const char* filename, const uint8_t* framebuffer, int width, int height) {
if (!framebuffer) {
return false;
}
// Note: the width and height, we rotate the image 90d counter-clockwise to match the default display orientation
int phyWidth = height;
int phyHeight = width;
std::string path(filename);
size_t last_slash = path.find_last_of('/');
if (last_slash != std::string::npos) {
std::string dir = path.substr(0, last_slash);
if (!Storage.exists(dir.c_str())) {
if (!Storage.mkdir(dir.c_str())) {
return false;
}
}
}
FsFile file;
if (!Storage.openFileForWrite("SCR", filename, file)) {
LOG_ERR("SCR", "Failed to save screenshot");
return false;
}
BmpHeader header;
createBmpHeader(&header, phyWidth, phyHeight, BmpRowOrder::BottomUp);
bool write_error = false;
if (file.write(reinterpret_cast<uint8_t*>(&header), sizeof(header)) != sizeof(header)) {
write_error = true;
}
if (write_error) {
// Explicitly close() file before calling Storage.remove()
file.close();
Storage.remove(filename);
return false;
}
const uint32_t rowSizePadded = (phyWidth + 31) / 32 * 4;
// Max row size for 528px height (X3) after rotation = 68 bytes; use fixed buffer to avoid VLA
constexpr size_t kMaxRowSize = 68;
if (rowSizePadded > kMaxRowSize) {
LOG_ERR("SCR", "Row size %u exceeds buffer capacity", rowSizePadded);
// Explicitly close() file before calling Storage.remove()
file.close();
Storage.remove(filename);
return false;
}
// rotate the image 90d counter-clockwise on-the-fly while writing to save memory
uint8_t rowBuffer[kMaxRowSize];
memset(rowBuffer, 0, rowSizePadded);
for (int outY = 0; outY < phyHeight; outY++) {
for (int outX = 0; outX < phyWidth; outX++) {
// 90d counter-clockwise: source (srcX, srcY)
// BMP rows are bottom-to-top, so outY=0 is the bottom of the displayed image
int srcX = width - 1 - outY; // phyHeight == width
int srcY = phyWidth - 1 - outX; // phyWidth == height
int fbIndex = srcY * (width / 8) + (srcX / 8);
uint8_t pixel = (framebuffer[fbIndex] >> (7 - (srcX % 8))) & 0x01;
rowBuffer[outX / 8] |= pixel << (7 - (outX % 8));
}
if (file.write(rowBuffer, rowSizePadded) != rowSizePadded) {
write_error = true;
break;
}
memset(rowBuffer, 0, rowSizePadded); // Clear the buffer for the next row
}
// Explicitly close() file before calling Storage.remove()
file.close();
if (write_error) {
Storage.remove(filename);
return false;
}
return true;
}