VNTools/FFMpeg-Compressor/README.md

FFMpeg-Compressor

Python utility uses ffmpeg to compress Visual Novel Resources

How to use

• Download ffmpeg-comp.toml and put in next to binary or in to /etc folder
• Change the configuration of the utility in ffmpeg-comp.toml for yourself
• ffmpeg-comp {folder}
• In result you get {folder-compressed} near with original {folder}

Configuration

FFMPEG section

• FFMpegParams - Some parameters & flags for ffmpeg command line interface (default: "-n -hide_banner -loglevel error")
• MimicMode - Rename compressed file to it original name and extension. VN engines determine the file type by its header, so for example PNG file named file.jpg will be loaded as PNG file. (default: false)

AUDIO section

• Extension - Required audio file extension. It supports: .aac, .flac, .m4a, .mp3, .ogg, .opus, .raw, .wav, .wma.
• BitRate - (mp3 only, for now) Required audio bitrate. For best quality use 320k value, but for worse use 1-9 (9 worst) number range.

IMAGE section

• Extension - Required image file extension. It supports: .apng, .avif, .jfif, .pjpeg, .pjp, .svg, .webp, .jpg/.jpeg, .png, .raw
• CompLevel - Compression level for images. Values range: 0-100 (100 - max compression, 0 - min compression)
• JpegComp - (May be deleted in future) Compression level specific for jpeg images. Values range: 0-10 (10 - max compression, 0 - min compression)

VIDEO section

• Extension - Required image file extension. It supports: .3gp, .amv, .avi, .gif, .m4v, .mkv, .mov, .mp4, .m4v, .mpeg, .mpv, .webm, .ogv
• Codec - (May be optional in future) Required video codec. (See official ffmpeg documentation for supported codecs)

TODO (for testing branch)

• Recreate whole game directory with compressed files
• Cross platform (Easy Windows usage and binaries, MacOS binaries)
• Use ffmpeg python bindings instead of cli commands
• Reorganize code