Skip to content

Unclear documentation for encoder options quality and effort #238

@Enet4

Description

@Enet4

While tinkering with the encoding APIs in zune-image, I found an oddity in the type EncoderOptions. Documentation for the getter and setter of effort is missing, and there are claims in method get_quality that the quality option also affects effort when doing lossless encoding:

Lossy

Higher quality means some images take longer to write and are big but they look good

Lower quality means small images and low quality.

Lossless

High quality indicates more time is spent in making the file smaller

Low quality indicates less time is spent in making the file bigger

It would be great if the documentation of the encoder options answered these questions:

  • Is there a universally accepted range of values for effort? Should we also provide a number in the range 0..100?
  • If an encoder supports mathematically lossless encoding, does quality = 100 imply lossless encoding? Or is there another way to signal that the encoding is intended to be lossless?
  • Does quality still affect the encoding effort when doing lossless encoding, or is this part of the documentation outdated?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions