Skip to content

App Store Version Help Page (4.x)

Yi Xie edited this page Mar 19, 2021 · 14 revisions

Thanks for downloading / updating waifu2x 4.x from App Store!

Tips on Usage

  • In the vast majority of cases you don't need to scale an image beyond 2x. The improvement of 4x compared to 2x is very marginal but at a much larger cost in storage space.
  • Don't save in 16 bit color unless you are certain you need it. This option drastically bumps output file size and RAM consumption to more than 2x. It is only useful if you want to manipulate the output image in other programs supporting 16 bit color.
  • In most cases you don't need the highest denoise level. It will wash out details which you may feel better to keep.
  • It is not recommended to process too many images in a row especially on phones. This will drain your battery and cause overheat issues.
  • If it shows error when you save a very large image (for example 15000x15000) to the album, it is because iOS photo album is not capable of handling such large image. You should save it to a file instead.
  • It is not recommended to continue if the app warns you about insufficient memory. This will happen if the device does not have enough RAM to hold the temporary buffer for output image. The app will very likely crash if you choose to proceed.
  • It is not recommended to delete the original image after processing. Models and algorithms keep improving over the time. By deleting the original image the chance of further improving the result in the future is lost.

About Network Usage

This app does not need network access to work. However, it uses Google Firebase to collect anonymous analytics data and crash logs (no image data is collected). It also needs network to download remote configuration to change app behaviors on the fly.

About Mac Catalyst Version (waifu magnifier)

Generally it is the same as iOS version. There are a few modifications:

  • Photos API on macOS does not provide original version of images. Adding from the album is thus removed.
  • macOS allows writing files directly to user-selected path. Output images are saved to destination instead of temp directory on iOS.
  • macOS version supports command line interface (CLI).
  • macOS version is a paid app without additional in app purchases.

About iOS Version on M1 Macs

iOS version is available alongside Mac Catalyst version on the Mac App Store. They are mostly the same. You can use paid models without paying again if you already own them on iOS. Major differences include:

  • CLI support including video processing is not possible with iOS version. It crashes immediately if you attempt to run the App executable binary directly.
  • Mac Catalyst version will write output images directly to user-selected directory. iOS version will put them in a temp directory first, wasting some time and disk I/O.
  • iOS version supports adding images from the album. However, it will be disabled any time if it turns out that it does not provide original version of images like it does on Mac Catalyst.

iOS version has not been fully tested on M1 Macs yet. Please consider sending a feedback report or creating an issue if you encounter any problems.

Report Issues

SwiftUI is a new framework, thus it is not as stable as UIKit. So there are a lot more issues on older iOS versions. I have already tried my best to workaround most of them. Please report issues only if it is reproducible on the latest iOS version. Use built-in email or GitHub issues to report problems. App Store comments cannot be replied efficiently and I won't check it frequently.