## Summary
- Add embedded image support to EPUB rendering with JPEG and PNG
decoders
- Implement pixel caching system to cache decoded/dithered images to SD
card for faster re-rendering
- Add 4-level grayscale support for display
## Changes
### New Image Rendering System
- Add `ImageBlock` class to represent an image with its cached path and
display dimensions
- Add `PageImage` class as a new `PageElement` type for images on pages
- Add `ImageToFramebufferDecoder` interface for format-specific image
decoders
- Add `JpegToFramebufferConverter` - JPEG decoder with Bayer dithering
and scaling
- Add `PngToFramebufferConverter` - PNG decoder with Bayer dithering and
scaling
- Add `ImageDecoderFactory` to select appropriate decoder based on file
extension
- Add `getRenderMode()` to GfxRenderer for grayscale render mode queries
### Dithering and Grayscale
- Implement 4x4 Bayer ordered dithering for 4-level grayscale output
- Stateless algorithm works correctly with MCU block decoding
- Handles scaling without artifacts
- Add grayscale render mode support (BW, GRAYSCALE_LSB, GRAYSCALE_MSB)
- Image decoders and cache renderer respect current render mode
- Enables proper 4-level e-ink grayscale when anti-aliasing is enabled
### Pixel Caching
- Cache decoded/dithered images to `.pxc` files on SD card
- Cache format: 2-bit packed pixels (4 pixels per byte) with
width/height header
- On subsequent renders, load directly from cache instead of re-decoding
- Cache renderer supports grayscale render modes for multi-pass
rendering
- Significantly improves page navigation speed for image-heavy EPUBs
### HTML Parser Integration
- Update `ChapterHtmlSlimParser` to process `<img>` tags and extract
images from EPUB
- Resolve relative image paths within EPUB ZIP structure
- Extract images to cache directory before decoding
- Create `PageImage` elements with proper scaling to fit viewport
- Fall back to alt text display if image processing fails
### Build Configuration
- Add `PNG_MAX_BUFFERED_PIXELS=6402` to support up to 800px wide images
### Test Script
- Generate test EPUBs with annotated JPEG and PNG images
- Test cases cover: grayscale (4 levels), centering, scaling, cache
performance
## Test plan
- [x] Open EPUB with JPEG images - verify images display with proper
grayscale
- [x] Open EPUB with PNG images - verify images display correctly and no
crash
- [x] Navigate away from image page and back - verify faster load from
cache
- [x] Verify grayscale tones render correctly (not just black/white
dithering)
- [x] Verify large images are scaled down to fit screen
- [x] Verify images are centered horizontally
- [x] Verify page serialization/deserialization works with images
- [x] Verify images rendered in landscape mode
## Test Results
[png](https://photos.app.goo.gl/5zFUb8xA8db3dPd19)
[jpeg](https://photos.app.goo.gl/SwtwaL2DSQwKybhw7)








---
### AI Usage
Did you use AI tools to help write this code? _**< YES >**_
---------
Co-authored-by: Matthías Páll Gissurarson <mpg@mpg.is>
Co-authored-by: Dave Allie <dave@daveallie.com>
97 lines
2.6 KiB
C++
97 lines
2.6 KiB
C++
#include "Page.h"
|
|
|
|
#include <Logging.h>
|
|
#include <Serialization.h>
|
|
|
|
void PageLine::render(GfxRenderer& renderer, const int fontId, const int xOffset, const int yOffset) {
|
|
block->render(renderer, fontId, xPos + xOffset, yPos + yOffset);
|
|
}
|
|
|
|
bool PageLine::serialize(FsFile& file) {
|
|
serialization::writePod(file, xPos);
|
|
serialization::writePod(file, yPos);
|
|
|
|
// serialize TextBlock pointed to by PageLine
|
|
return block->serialize(file);
|
|
}
|
|
|
|
std::unique_ptr<PageLine> PageLine::deserialize(FsFile& file) {
|
|
int16_t xPos;
|
|
int16_t yPos;
|
|
serialization::readPod(file, xPos);
|
|
serialization::readPod(file, yPos);
|
|
|
|
auto tb = TextBlock::deserialize(file);
|
|
return std::unique_ptr<PageLine>(new PageLine(std::move(tb), xPos, yPos));
|
|
}
|
|
|
|
void PageImage::render(GfxRenderer& renderer, const int fontId, const int xOffset, const int yOffset) {
|
|
// Images don't use fontId or text rendering
|
|
imageBlock->render(renderer, xPos + xOffset, yPos + yOffset);
|
|
}
|
|
|
|
bool PageImage::serialize(FsFile& file) {
|
|
serialization::writePod(file, xPos);
|
|
serialization::writePod(file, yPos);
|
|
|
|
// serialize ImageBlock
|
|
return imageBlock->serialize(file);
|
|
}
|
|
|
|
std::unique_ptr<PageImage> PageImage::deserialize(FsFile& file) {
|
|
int16_t xPos;
|
|
int16_t yPos;
|
|
serialization::readPod(file, xPos);
|
|
serialization::readPod(file, yPos);
|
|
|
|
auto ib = ImageBlock::deserialize(file);
|
|
return std::unique_ptr<PageImage>(new PageImage(std::move(ib), xPos, yPos));
|
|
}
|
|
|
|
void Page::render(GfxRenderer& renderer, const int fontId, const int xOffset, const int yOffset) const {
|
|
for (auto& element : elements) {
|
|
element->render(renderer, fontId, xOffset, yOffset);
|
|
}
|
|
}
|
|
|
|
bool Page::serialize(FsFile& file) const {
|
|
const uint16_t count = elements.size();
|
|
serialization::writePod(file, count);
|
|
|
|
for (const auto& el : elements) {
|
|
// Use getTag() method to determine type
|
|
serialization::writePod(file, static_cast<uint8_t>(el->getTag()));
|
|
|
|
if (!el->serialize(file)) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
std::unique_ptr<Page> Page::deserialize(FsFile& file) {
|
|
auto page = std::unique_ptr<Page>(new Page());
|
|
|
|
uint16_t count;
|
|
serialization::readPod(file, count);
|
|
|
|
for (uint16_t i = 0; i < count; i++) {
|
|
uint8_t tag;
|
|
serialization::readPod(file, tag);
|
|
|
|
if (tag == TAG_PageLine) {
|
|
auto pl = PageLine::deserialize(file);
|
|
page->elements.push_back(std::move(pl));
|
|
} else if (tag == TAG_PageImage) {
|
|
auto pi = PageImage::deserialize(file);
|
|
page->elements.push_back(std::move(pi));
|
|
} else {
|
|
LOG_ERR("PGE", "Deserialization failed: Unknown tag %u", tag);
|
|
return nullptr;
|
|
}
|
|
}
|
|
|
|
return page;
|
|
}
|