snark13/Xteink-X4-crosspoint-reader
1
0
Fork 0
mirror of https://github.com/daveallie/crosspoint-reader.git synced 2026-02-04 14:47:37 +03:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
5078c490b1
Xteink-X4-crosspoint-reader/lib/Xtc
History
icannotttt 38302e9865
Add ChapterData struct to XtcTypes.h 
Added new struct ChapterData with chapterIndex, startPage, and shortTitle fields.
2026-01-29 23:57:12 +08:00
..
Xtc Add ChapterData struct to XtcTypes.h 2026-01-29 23:57:12 +08:00
README Add XTC/XTCH ebook format support (#135) 2025-12-29 01:56:05 +11:00
Xtc.cpp feat: Extract author from XTC/XTCH files (#563) 2026-01-27 22:56:51 +11:00
Xtc.h Enhance Xtc class with page and chapter methods 2026-01-29 19:05:39 +08:00

README 

# XTC/XTCH Library

XTC ebook format support for CrossPoint Reader.

## Supported Formats

| Format | Extension | Description                                  |
|--------|-----------|----------------------------------------------|
| XTC    | `.xtc`    | Container with XTG pages (1-bit monochrome)  |
| XTCH   | `.xtch`   | Container with XTH pages (2-bit grayscale)   |

## Format Overview

XTC/XTCH are container formats designed for ESP32 e-paper displays. They store pre-rendered bitmap pages optimized for the XTeink X4 e-reader (480x800 resolution).

### Container Structure (XTC/XTCH)

- 56-byte header with metadata offsets
- Optional metadata (title, author, etc.)
- Page index table (16 bytes per page)
- Page data (XTG or XTH format)

### Page Formats

#### XTG (1-bit monochrome)

- Row-major storage, 8 pixels per byte
- MSB first (bit 7 = leftmost pixel)
- 0 = Black, 1 = White

#### XTH (2-bit grayscale)

- Two bit planes stored sequentially
- Column-major order (right to left)
- 8 vertical pixels per byte
- Grayscale: 0=White, 1=Dark Grey, 2=Light Grey, 3=Black

## Reference

Original format info: <https://gist.github.com/CrazyCoder/b125f26d6987c0620058249f59f1327d>