vapoursynth-iccconvert 6.2

Little CMS based color management for VapourSynth

VapourSynth-ICCConvert

Little CMS based ICC profile simulation for VapourSynth.

---

Install

For VapourSynth R74 and later:

• Windows: from vsrepo, or install the wheel in the release page.
• *nix: pip install git+https://github.com/YomikoR/VapourSynth-ICCConvert.git (requires lcms2 library)

For earlier versions of VapourSynth:

• Windows: from vsrepo
• *nix: meson setup build && ninja -C build install

Usage

Convert

Color profile conversion and soft proofing.

iccc.Convert(clip,
  input_icc: str = <from_frame_properties>,
  display_icc: str = <from_system>,
  intent: str = <from_input_icc>,
  proofing_icc: str = None,
  proofing_intent: str = <from_proofing_icc>,
  gamut_warning: bool = False,
  gamut_warning_color: uint16[] = [65535, 0, 65535],
  black_point_compensation: bool = False,
  clut_size: int = 49,
  prefer_props: bool = True)

• The format of input clip must be RGB24, RGB48 or RGBS (slow). The output has the same format.

• input_icc is the path to the ICC profile of the clip (input profile for conversion).

  • When prefer_props is enabled, it is an optional fallback value for embedded ICC profiles read from frame properties.
  • See Preset ICC values for preset values.

• display_icc is the path to the ICC profile for the output, e.g. your monitor (output profile for conversion).

  • Auto detection features have been implemented on a few platforms. See OS Dependent Notes. However, it's strongly recommended to manually specify the ICC profile for production purpose.
  • See Preset ICC values for preset values.

• intent refers to the ICC rendering intent for conversion from the input clip, see this link. Possible options are

  • "perceptual" for Perceptual
  • "saturation" for Saturation
  • "relative" for Relative Colorimetric
  • "absolute" for Absolute Colorimetric

  The default value is taken from the input profile header.

  Not all rendering intents are supported by all display profiles. If the profile is not providing sufficient information for selected intent, Little CMS has the following fallback rules:

  • Perceptual -> the default intent of the (output) profile.
  • Relative Colorimetric -> perceptual.
  • Saturation -> perceptual.
  • Absolute Colorimetric -> relative colorimetric intent, with undoing of chromatic adaptation.

• proofing_icc is the path to the optional ICC profile for soft proofing, e.g. another monitor on which we are interested in the rendering. When a valid ICC profile is provided, the transform is taken in the soft proofing mode. When leaving it as the default None, a straightforward ICC transform is taken instead.

  See Preset ICC values for preset values.

  The following options only have effect in soft proofing mode:

  • proofing_intent, similar to intent above.
  • gamut_warning, the flag for a gamut check in the proofing.
  • gamut_warning_color, when gamut check is enabled, the specified color filling the region where a gamut overflow happens in the proofing simulation. The color must be given as a triple of 16-bit R, G and B values. Default magenta.

• black_point_compensation is the flag for what it tells. Default off.

• clut_size specifies the internal LUT size used by Little CMS. The LUT size is applied for each plane (channel), so it does have an impact on the speed of plugin initialization.

  Possible values are the following:

  • 2-255 for the actual LUT size
  • 1 for Little CMS preset which is equivalent to 49 (default)
  • 0 for Little CMS preset which is equivalent to 33
  • -1 for Little CMS preset which is equivalent to 17

• prefer_props is the flag for reading embedded ICC profiles from the frame property ICCProfile. Default on. The rendering intent from the header of the embedded profile will also override the above intent.

  ICC profiles are internally hashed to reuse exising ICC transform instances, so duplication of embedded ICC profiles from the input frames won't cause a big performance loss.

Playback

Video playback with BT.1886 configuration or with gamma curve. For SDR content this should have very similar behavior as the mpv player with vo=gpu.

iccc.Playback(clip,
  csp: str = "709",
  display_icc: str = <from_system>,
  gamma: float = None,
  contrast: float = <from_display_icc>,
  intent: str = "relative",
  black_point_compensation: bool = True,
  clut_size: int = 49,
  inverse: bool = False)

A gamma curve is used if gamma is set. Otherwise BT.1886.

Currently supported csp options are the following:

• "709" for HD
• "2020" for UHD (SDR)
• "170m" for SD (NTSC)

The contrast value will be used to override the inferred contrast from the provided ICC profile. For example, the sRGB profile provided by Windows seems to have zero black point, which suggests inf contrast, so that the BT.1886 EOTF is effectively equivalent to gamma 2.4, which is usually not expected in practical playback. In this case, setting an approximated contrast value from your monitor may be a better idea.

The experimental inverse option allows you to take an inverse transform.

This function ignores embedded ICC profiles in frame properties.

Tag

Embed given ICC profile to frame properties.

iccc.Tag(clip, icc: str, intent: str = None)

The function loads profile icc, and saves it to ICCProfile frame properties. There's no format check on the input clip.

Set intent to override the intent from the header of provided ICC profile.

Can also set preset ICC values for icc, see Preset ICC values.

Preset ICC values

Any argument asking for a path string to an ICC profile may be replaced by one of the following preset values. Note that the plugin will always first attempt to treat them as file names.

• "srgb": Little CMS has built-in implementation similar to https://www.color.org/srgbprofiles.xalter#v2
• "709"
• "170m"
• "2020": Should be used for SDR cases only
• "xyz": Implementation similar to D50_XYZ.icc from https://www.color.org/XYZprofiles.xalter

---

Manual Compilation

Please refer to the Meson build script or the MSVC project.

---

OS Dependent Notes

Additional libraries

For compatibility reasons, some functions are isolated into independent shared libraries:

• libiccc_colord.so when built with Linux X11 and colord;
• libiccc_cocoa.dylib when built in macOS with Cocoa.

These shared libraries are loaded by the plugin to make auto ICC profile detection function.

Display profile detection

The parameter display_icc in both functions are optional on a few platforms, with some difference in implementation:

• Windows: detects the profile for the current window (e.g. the editor window of VSEditor, or the console window for vs-preview).

  Approach: foreground window -> monitor -> ICC profile.

  Note: result should be identical the one shown in Win 10/11 system settings.

• Linux X11: detects the profile for the current window (e.g. the editor window of VSEditor, or the console window for vs-preview).

  Approach: center of the window of input focus -> monitor -> ICC profile by colord or by X11 (depending on which variant the plugin was built as).

  Note: If center of the window is out of any monitor, then the detection fails.

• MacOS: detects the profile used by current parent window that is open (e.g. the editor window of VSEditor). Detection fails when loaded in console.

  Approach: main window -> colorspace -> ICC profile.