Enana

English | 简体中文

---

A tool for optimizing image quality in EPUB e-books, using advanced super-resolution neural network technology to enhance image clarity. The name Enana comes from:

• Epub NAtive Neural Amplifier
• Eikón (icon) NAtive Neural Amplifier
• Enana's NAtive Neural Amplifier

Features

• Supports multiple super-resolution model families, with specialized adaptation for the "realesrgan-ncnn-vulkan" family and general adaptation for other families (general adaptation does not guarantee correct program operation)
• Adjustable image scaling ratio and quality
• Simple and easy-to-use command line interface
• Automatically processes all images in EPUB files
• Supports interruption recovery. When processing is externally interrupted, it automatically loads previously completed work when given the same input file name next time

Supported Models

• "realesrgan-ncnn-vulkan": Specially adapted, generally error-free
• "realcugan-ncnn-vulkan": General adaptation available, generally error-free
• "waifu2x-ncnn-vulkan": General adaptation available, generally error-free

Model Performance and Style Suitability

Model Family	Model Name	Speed	Quality	Suitable for Anime	Suitable for Realistic
realesrgan-ncnn-vulkan	realesr-animevideov3	⭐⭐️⭐️⭐️	⭐️⭐️⭐️	✅	❌
realesrgan-ncnn-vulkan	realesrgan-x4plus	⭐️	⭐️⭐️⭐️⭐️	❌	✅
realesrgan-ncnn-vulkan	realesrgan-x4plus-anime	⭐️	⭐️⭐️⭐️⭐️	✅	❌
realesrgan-ncnn-vulkan	RealESRGANv2-animevideo-xsx2	⭐️⭐️⭐️⭐️	⭐️	✅	❌
realesrgan-ncnn-vulkan	RealESRGANv2-animevideo-xsx4	⭐️⭐️	⭐️⭐️	✅	❌
realesrgan-ncnn-vulkan	realesr-general-wdn-x4v3	⭐️⭐️	⭐️⭐️⭐️	✅	✅
realesrgan-ncnn-vulkan	realesr-general-x4v3	⭐️⭐️	⭐️⭐️⭐️	✅	✅
realcugan-ncnn-vulkan	models-se	⭐️⭐️	⭐️⭐️⭐️⭐️	✅	❌
realcugan-ncnn-vulkan	models-pro	⭐️⭐️	⭐️⭐️⭐️⭐️	✅	❌
waifu2x-ncnn-vulkan	models-cunet	⭐️⭐️	⭐️⭐️	✅	❌
waifu2x-ncnn-vulkan	models-upconv_7_anime_style_art_rgb	⭐️⭐️	⭐️⭐️	✅	❌
waifu2x-ncnn-vulkan	models-upconv_7_photo	⭐️⭐️	⭐️⭐️	❌	✅

Ratings are for reference only.

Adding Additional Models or Model Families

To add a new model to an existing model family, please add model files according to the directory rules of the corresponding model family. To add a new model family, add the model family directory to the family directory, and ensure that the executable file of the family is in the family directory and has the same name as the family directory. The structure of the family directory is as follows:

family
 ├─realcugan-ncnn-vulkan
 │  ├─models-nose
 │  │  └─...
 │  ├─models-pro
 │  │  └─...
 │  ├─models-se
 │  │  └─...
 │  ├─realcugan-ncnn-vulkan.exe    // Same name as the directory
 │  └─(other files...)
 │
 ├─realesrgan-ncnn-vulkan
 │  ├─models
 │  │  └─...
 │  ├─realesrgan-ncnn-vulkan.exe    // Same name as the directory
 │  └─(other files...)
 │
 ├─waifu2x-ncnn-vulkan
 │  ├─models-cunet
 │  │  └─...
 │  ├─models-upconv_7_anime_style_art_rgb
 │  │  └─...
 │  ├─models-upconv_7_photo
 │  │  └─...
 │  ├─waifu2x-ncnn-vulkan.exe    // Same name as the directory
 │  └─(other files...)
 │
 └─(other families...)

Python Script Usage

Please ensure that the directories src and family are in the same directory!

cd src
python main.py -h | -v | -lf | -lm [-f FAMILY] | -i INPUT_PATH [-o OUTPUT_PATH] [-p] [-ps PRE_SCALE] [-s SCALE] [-f FAMILY] [-m MODEL] [-q QUALITY] [-r]

Parameter Description

• -h, --help: to display help information
• -v, --version: to print version information
• -lf, --list-family: to list all available super-resolution model families
• -lm, --list-model: to list all available models in a specific family (use with -f)
• -i, --input: input file path (required)
• -o, --output: output file path (optional, default is the input filename with "_enana" suffix)
• -p, --preview: to output preview image. If you use this option, the program will choose one image in your EPUB file and output its original and processed copy to the output directory.
• -ps, --pre-scale: pre-scaling factor (floating number), applied before super-resolution, default=1.0
• -s, --scale: scaling factor (floating number), range and default value depends on the selected model
• -f, --family: family name of super-resolution models, default=realesrgan-ncnn-vulkan
• -m, --model: name of the super-resolution model, default value depends on the selected family
• -q, --quality: JPEG image compression quality level (0-100), default=75
• -r, --restart: to force reprocessing all images, otherwise continue from interruption of the last time

Examples

List all available model families:

python main.py -lf

List all models in the realesrgan-ncnn-vulkan family:

python main.py -lm -f realesrgan-ncnn-vulkan

Generate a preview image with default settings:

python main.py -i book.epub -p

Generate a preview image with custom settings:

python main.py -i book.epub -p -s 2.0 -f realesrgan-ncnn-vulkan -m realesrgan-x4plus -q 60

Process an EPUB file with default settings:

python main.py -i book.epub -o book_enhanced.epub

Process an EPUB file with custom settings:

python main.py -i book.epub -o book_enhanced.epub -s 2.0 -f realesrgan-ncnn-vulkan -m realesrgan-x4plus -q 60

Executable Program Usage

Get the executable program from releases.

enana -h | -v | -lf | -lm [-f FAMILY] | -i INPUT_PATH [-o OUTPUT_PATH] [-p] [-ps PRE_SCALE] [-s SCALE] [-f FAMILY] [-m MODEL] [-q QUALITY] [-r]

Parameter Description

• -h, --help: to display help information
• -v, --version: to print version information
• -lf, --list-family: to list all available super-resolution model families
• -lm, --list-model: to list all available models in a specific family (use with -f)
• -i, --input: input file path (required)
• -o, --output: output file path (optional, default is the input filename with "_enana" suffix)
• -p, --preview: to output preview image. If you use this option, the program will choose one image in your EPUB file and output its original and processed copy to the output directory.
• -ps, --pre-scale: pre-scaling factor (floating number), applied before super-resolution, default=1.0
• -s, --scale: scaling factor (floating number), range and default value depends on the selected model
• -f, --family: family name of super-resolution models, default=realesrgan-ncnn-vulkan
• -m, --model: name of the super-resolution model, default value depends on the selected family
• -q, --quality: JPEG image compression quality level (0-100), default=75
• -r, --restart: to force reprocessing all images, otherwise continue from interruption of the last time

Examples

List all available model families:

enana -lf

List all models in the realesrgan-ncnn-vulkan family:

enana -lm -f realesrgan-ncnn-vulkan

Generate a preview image with default settings:

enana -i book.epub -p

Generate a preview image with custom settings:

enana -i book.epub -p -s 2.0 -f realesrgan-ncnn-vulkan -m realesrgan-x4plus -q 60

Process an EPUB file with default settings:

enana -i book.epub -o book_enhanced.epub

Process an EPUB file with custom settings:

enana -i book.epub -o book_enhanced.epub -s 2.0 -f realesrgan-ncnn-vulkan -m realesrgan-x4plus -q 60

License

This project's license - MIT License

License for super-resolution models used in this project