lovell / lovell/sharp

Enhancement: support custom input ICC profiles

Open
#1,324 0 comments 12 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
JavaScript
Stars
32.7k
Forks
1.4k
Avg merge
1d 14h
Merged PRs (30d)
5

Description

Embedded input profiles (and default profiles for CMYK images that are missing a profile) are already supported. This enhancement relates to using custom input profiles.

Proposed API:
```javascript
sharp(input, { profile: '/path/to/profile.icc' })
...
```

The `icc_import` operation can be used for this (use XYZ profile connection space and set `embedded` to FALSE).

See #1323 for custom *output* profile support.

See #218 for previous discussion on this and related features.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the public sharp(input, options) API and trace how input colour profiles reach the icc_import operation. Compare the proposed XYZ connection space and embedded=false behavior with #1323 and #218. Done means custom input profiles can be supplied through the proposed profile option, including for images without an embedded profile.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
api, computer-graphics
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.