Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mitigate inference problems in color conversions #508

Merged
merged 1 commit into from
Aug 15, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 31 additions & 29 deletions src/conversions.jl
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,10 @@ convert(::Type{XYZ{T}}, c, wp::XYZ) where {T} = cnvt(XYZ{T}, c, wp)
convert(::Type{Lab{T}}, c, wp::XYZ) where {T} = cnvt(Lab{T}, c, wp)
convert(::Type{Luv{T}}, c, wp::XYZ) where {T} = cnvt(Luv{T}, c, wp)

# FIXME: inference helpers for LCH --> RGB conversions
convert(::Type{RGB}, c::Union{LCHab{T}, LCHuv{T}}) where {T} = cnvt(RGB{T}, cnvt(XYZ{T}, c))
convert(::Type{RGB{T}}, c::Union{LCHab{T}, LCHuv{T}}) where {T} = cnvt(RGB{T}, cnvt(XYZ{T}, c))

# Fallback to catch undefined operations
cnvt(::Type{C}, c::TransparentColor) where {C<:Color} = cnvt(C, color(c))
cnvt(::Type{C}, c) where {C} = convert(C, convert(RGB{eltype(C)}, c)::RGB{eltype(C)})
Expand All @@ -78,8 +82,8 @@ correct_gamut(c::CV) where {T<:Union{N0f8,N0f16,N0f32,N0f64},
correct_gamut(c::CV) where {CV<:TransparentRGB} =
CV(clamp01(red(c)), clamp01(green(c)), clamp01(blue(c)), clamp01(alpha(c))) # for `hex`

@inline function srgb_compand(v)
F = typeof(0.5f0v) === Float32 ? Float32 : promote_type(Float64, typeof(v))
@inline function srgb_compand(v::T) where T
F = typeof(0.5f0v) === Float32 ? Float32 : promote_type(Float64, T)
vf = F(v)
vc = @fastmath max(vf, F(0.0031308))
# `pow5_12` is an optimized function to get `v^(1/2.4)`
Expand Down Expand Up @@ -164,7 +168,7 @@ end
const M_XYZ2RGB = Mat3x3([ 3.2404541621141054 -1.5371385127977166 -0.4985314095560162
-0.9692660305051868 1.8760108454466942 0.04155601753034984
0.05564343095911469 -0.20402591351675387 1.0572251882231791 ])
function xyz_to_linear_rgb(c::XYZ)
function xyz_to_linear_rgb(c::XYZ{T}) where T
@mul3x3 RGB M_XYZ2RGB c.x c.y c.z
end
function cnvt(::Type{CV}, c::XYZ) where CV<:AbstractRGB
Expand Down Expand Up @@ -196,9 +200,9 @@ end

# To avoid stack overflow, the source types which do not support direct or
# indirect conversion to RGB should be rejected.
cnvt(::Type{CV}, c::Union{LMS, xyY} ) where {CV<:AbstractRGB} = cnvt(CV, convert(XYZ, c))
cnvt(::Type{CV}, c::Union{Lab, Luv, LCHab, LCHuv}) where {CV<:AbstractRGB} = cnvt(CV, convert(XYZ, c))
cnvt(::Type{CV}, c::Union{DIN99d, DIN99o, DIN99} ) where {CV<:AbstractRGB} = cnvt(CV, convert(XYZ, c))
cnvt(::Type{CV}, c::Union{LMS, xyY} ) where {CV<:AbstractRGB} = cnvt(CV, cnvt(XYZ{eltype(c)}, c))
cnvt(::Type{CV}, c::Union{Lab, Luv, LCHab, LCHuv}) where {CV<:AbstractRGB} = cnvt(CV, cnvt(XYZ{eltype(c)}, c))
cnvt(::Type{CV}, c::Union{DIN99d, DIN99o, DIN99} ) where {CV<:AbstractRGB} = cnvt(CV, cnvt(XYZ{eltype(c)}, c))
@noinline function cnvt(::Type{CV}, @nospecialize(c::Color)) where {CV<:AbstractRGB}
error("No conversion of ", c, " to ", CV, " has been defined")
end
Expand Down Expand Up @@ -227,7 +231,7 @@ function cnvt(::Type{HSV{T}}, c::AbstractRGB) where T
end


cnvt(::Type{HSV{T}}, c::Color) where {T} = cnvt(HSV{T}, convert(RGB{T}, c))
cnvt(::Type{HSV{T}}, c::Color) where {T} = cnvt(HSV{T}, convert(RGB{T}, c)::RGB{T})


# Everything to HSL
Expand All @@ -253,7 +257,7 @@ function cnvt(::Type{HSL{T}}, c::AbstractRGB) where T
end


cnvt(::Type{HSL{T}}, c::Color) where {T} = cnvt(HSL{T}, convert(RGB{T}, c))
cnvt(::Type{HSL{T}}, c::Color) where {T} = cnvt(HSL{T}, convert(RGB{T}, c)::RGB{T})


# Everything to HSI
Expand All @@ -275,13 +279,13 @@ cnvt(::Type{HSL{T}}, c::Color) where {T} = cnvt(HSL{T}, convert(RGB{T}, c))
HSI{T}(b > g ? F(360) - h : h, s, i)
end

cnvt(::Type{HSI{T}}, c::Color) where {T} = cnvt(HSI{T}, convert(RGB{T}, c))
cnvt(::Type{HSI{T}}, c::Color) where {T} = cnvt(HSI{T}, convert(RGB{T}, c)::RGB{T})

# Everything to XYZ
# -----------------

@inline function invert_srgb_compand(v)
F = typeof(0.5f0v) === Float32 ? Float32 : promote_type(Float64, typeof(v))
@inline function invert_srgb_compand(v::T) where T
F = typeof(0.5f0v) === Float32 ? Float32 : promote_type(Float64, T)
vf = F(v)
# `pow12_5` is an optimized function to get `x^2.4`
vf > F(0.04045) ? pow12_5(muladd(F(1000/1055), vf, F(55/1055))) : F(100/1292) * vf
Expand Down Expand Up @@ -314,7 +318,7 @@ const M_RGB2XYZ = Mat3x3([0.4124564390896921 0.357576077643909 0.18043748326
0.21267285140562248 0.715152155287818 0.07217499330655958
0.019333895582329317 0.119192025881303 0.9503040785363677 ])

function linear_rgb_to_xyz(c::AbstractRGB)
function linear_rgb_to_xyz(c::AbstractRGB{T}) where T
@mul3x3 XYZ M_RGB2XYZ red(c) green(c) blue(c)
end
function cnvt(::Type{XYZ{T}}, c::AbstractRGB) where T
Expand Down Expand Up @@ -415,17 +419,16 @@ function cnvt(::Type{XYZ{T}}, c::DIN99d) where T
adj = convert(XYZ, Lab(l, a, b))

XYZ{T}((adj.x + 0.12*adj.z)/1.12, adj.y, adj.z)

end


function cnvt(::Type{XYZ{T}}, c::LMS) where T
@mul3x3 XYZ{T} CAT02_INV c.l c.m c.s
end

cnvt(::Type{XYZ{T}}, c::Union{LCHab, DIN99, DIN99o}) where {T} = cnvt(XYZ{T}, convert(Lab{T}, c))
cnvt(::Type{XYZ{T}}, c::LCHuv) where {T} = cnvt(XYZ{T}, convert(Luv{T}, c))
cnvt(::Type{XYZ{T}}, c::Color) where {T} = cnvt(XYZ{T}, convert(RGB{T}, c))
cnvt(::Type{XYZ{T}}, c::Union{LCHab, DIN99, DIN99o}) where {T} = cnvt(XYZ{T}, cnvt(Lab{T}, c))
cnvt(::Type{XYZ{T}}, c::LCHuv) where {T} = cnvt(XYZ{T}, cnvt(Luv{T}, c))
cnvt(::Type{XYZ{T}}, c::Color) where {T} = cnvt(XYZ{T}, convert(RGB{T}, c)::RGB{T})

# Everything to xyY
# -----------------
Expand All @@ -435,11 +438,10 @@ function cnvt(::Type{xyY{T}}, c::XYZ) where T
x = c.x/(c.x + c.y + c.z)
y = c.y/(c.x + c.y + c.z)

xyY{T}(x, y, convert(typeof(x), c.y))

xyY{T}(x, y, oftype(x, c.y))
end

cnvt(::Type{xyY{T}}, c::Color) where {T} = cnvt(xyY{T}, convert(XYZ{T}, c))
cnvt(::Type{xyY{T}}, c::Color) where {T} = cnvt(xyY{T}, convert(XYZ{T}, c)::XYZ{T})



Expand Down Expand Up @@ -536,7 +538,7 @@ function cnvt(::Type{Lab{T}}, c::DIN99o) where T
end


cnvt(::Type{Lab{T}}, c::Color) where {T} = cnvt(Lab{T}, convert(XYZ{T}, c))
cnvt(::Type{Lab{T}}, c::Color) where {T} = cnvt(Lab{T}, convert(XYZ{T}, c)::XYZ{T})


# Everything to Luv
Expand Down Expand Up @@ -564,7 +566,7 @@ function cnvt(::Type{Luv{T}}, c::LCHuv) where T
Luv{T}(c.l, polar_to_cartesian(c.c, c.h)...)
end

cnvt(::Type{Luv{T}}, c::Color) where {T} = cnvt(Luv{T}, convert(XYZ{T}, c))
cnvt(::Type{Luv{T}}, c::Color) where {T} = cnvt(Luv{T}, convert(XYZ{T}, c)::XYZ{T})


# Everything to LCHuv
Expand All @@ -575,7 +577,7 @@ function cnvt(::Type{LCHuv{T}}, c::Luv) where T
end


cnvt(::Type{LCHuv{T}}, c::Color) where {T} = cnvt(LCHuv{T}, convert(Luv{T}, c))
cnvt(::Type{LCHuv{T}}, c::Color) where {T} = cnvt(LCHuv{T}, convert(Luv{T}, c)::Luv{T})


# Everything to LCHab
Expand All @@ -586,7 +588,7 @@ function cnvt(::Type{LCHab{T}}, c::Lab) where T
end


cnvt(::Type{LCHab{T}}, c::Color) where {T} = cnvt(LCHab{T}, convert(Lab{T}, c))
cnvt(::Type{LCHab{T}}, c::Color) where {T} = cnvt(LCHab{T}, convert(Lab{T}, c)::Lab{T})


# Everything to DIN99
Expand Down Expand Up @@ -623,7 +625,7 @@ function cnvt(::Type{DIN99{T}}, c::Lab) where T
end


cnvt(::Type{DIN99{T}}, c::Color) where {T} = cnvt(DIN99{T}, convert(Lab{T}, c))
cnvt(::Type{DIN99{T}}, c::Color) where {T} = cnvt(DIN99{T}, convert(Lab{T}, c)::Lab{T})


# Everything to DIN99d
Expand Down Expand Up @@ -656,7 +658,7 @@ function cnvt(::Type{DIN99d{T}}, c::XYZ{T}) where T
end


cnvt(::Type{DIN99d{T}}, c::Color) where {T} = cnvt(DIN99d{T}, convert(XYZ{T}, c))
cnvt(::Type{DIN99d{T}}, c::Color) where {T} = cnvt(DIN99d{T}, convert(XYZ{T}, c)::XYZ{T})


# Everything to DIN99o
Expand Down Expand Up @@ -695,7 +697,7 @@ function cnvt(::Type{DIN99o{T}}, c::Lab) where T
end


cnvt(::Type{DIN99o{T}}, c::Color) where {T} = cnvt(DIN99o{T}, convert(Lab{T}, c))
cnvt(::Type{DIN99o{T}}, c::Color) where {T} = cnvt(DIN99o{T}, convert(Lab{T}, c)::Lab{T})


# Everything to LMS
Expand All @@ -721,7 +723,7 @@ function cnvt(::Type{LMS{T}}, c::XYZ) where T
end


cnvt(::Type{LMS{T}}, c::Color) where {T} = cnvt(LMS{T}, convert(XYZ{T}, c))
cnvt(::Type{LMS{T}}, c::Color) where {T} = cnvt(LMS{T}, convert(XYZ{T}, c)::XYZ{T})

# Everything to YIQ
# -----------------
Expand All @@ -738,7 +740,7 @@ function cnvt(::Type{YIQ{T}}, c::AbstractRGB) where T
@mul3x3 YIQ{T} M_RGB2YIQ red(rgb) green(rgb) blue(rgb)
end

cnvt(::Type{YIQ{T}}, c::Color) where {T} = cnvt(YIQ{T}, convert(RGB{T}, c))
cnvt(::Type{YIQ{T}}, c::Color) where {T} = cnvt(YIQ{T}, convert(RGB{T}, c)::RGB{T})


# Everything to YCbCr
Expand All @@ -755,7 +757,7 @@ function cnvt(::Type{YCbCr{T}}, c::AbstractRGB) where T
128+112*red(rgb)-93.786*green(rgb)-18.214*blue(rgb))
end

cnvt(::Type{YCbCr{T}}, c::Color) where {T} = cnvt(YCbCr{T}, convert(RGB{T}, c))
cnvt(::Type{YCbCr{T}}, c::Color) where {T} = cnvt(YCbCr{T}, convert(RGB{T}, c)::RGB{T})


# To Gray
Expand Down
20 changes: 12 additions & 8 deletions src/precompile.jl
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,27 @@ function _precompile_()
pctypes = (Gray, RGB, AGray, GrayA, ARGB, RGBA) # parametric colors
cctypes = (Gray24, AGray32, RGB24, ARGB32) # non-parametric colors
# conversions
## to RGB
for T in eltypes, F in feltypes, C in (HSV,LCHab,LCHuv,Lab,Luv,XYZ)
precompile(Tuple{typeof(convert),Type{RGB{T}},C{F}})
end
## to XYZ
for T in feltypes, F in feltypes, C in (HSV,LCHab,LCHuv,Lab,Luv,XYZ,RGB)
precompile(Tuple{typeof(convert),Type{XYZ{T}},C{F}})
## from/to XYZ
for T in feltypes, C in (HSV,LCHab,LCHuv,Lab,Luv)
precompile(Tuple{typeof(convert),Type{C{T}},XYZ{T}})
precompile(Tuple{typeof(convert),Type{XYZ{T}},C{T}})
end
for T in feltypes, F in (N0f8, N0f16)
for T in feltypes, F in eltypes
precompile(Tuple{typeof(convert),Type{RGB{F}},XYZ{T}})
precompile(Tuple{typeof(convert),Type{XYZ{T}},RGB{F}})
end
## to RGB
for T in eltypes, F in feltypes, C in (HSV,LCHab,LCHuv,Lab,Luv)
precompile(Tuple{typeof(convert),Type{RGB{T}},C{F}})
end
# parse
precompile(Tuple{typeof(parse),Type{ColorTypes.Colorant},String})
precompile(Tuple{typeof(parse),Type{RGB{N0f8}},String})
precompile(Tuple{typeof(parse),Type{RGBA{N0f8}},String})
# colordiff
for T in eltypes
# Currently, there is a problem with `Float64` related to `cos`/`sin`.
T === Float64 && continue
precompile(Tuple{typeof(colordiff),RGB{T},RGB{T}})
end
precompile(Tuple{typeof(colormap),String})
Expand Down
9 changes: 4 additions & 5 deletions src/utilities.jl
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,6 @@ pow3_4(x) = (y = @fastmath(sqrt(x)); y*@fastmath(sqrt(y))) # x^(3/4)
# `pow5_12` is called from `srgb_compand`.
pow5_12(x) = pow3_4(x) / cbrt(x) # 5/12 == 1/2 + 1/4 - 1/3 == 3/4 - 1/3
@inline function pow5_12(x::Float64)
@noinline _cbrt(x) = cbrt01(x)
p3_4 = pow3_4(x)
# x^(-1/6)
if x < 0.02
Expand All @@ -106,7 +105,7 @@ pow5_12(x) = pow3_4(x) / cbrt(x) # 5/12 == 1/2 + 1/4 - 1/3 == 3/4 - 1/3
t0 = @evalpoly(x, 1.7047813285940905, -3.1261253501167308,
7.498744828350077, -10.100319516746419, 6.820601476522508, -1.7978894213531524)
else
return p3_4 / _cbrt(x)
return p3_4 / cbrt01(x)
end
# x^(-1/3)
t1 = t0 * t0
Expand Down Expand Up @@ -164,7 +163,7 @@ end

# a variant of `atand` returning the angle in the range of [0, 360]
atan360(y, x) = (a = atand(y, x); signbit(a) ? oftype(a, a + 360) : a)
function atan360(y::T, x::T) where T <: Union{Float32, Float64}
@inline function atan360(y::T, x::T) where T <: Union{Float32, Float64}
(isnan(x) | isnan(y)) && return T(NaN)
ax, ay = abs(x), abs(y)
n, m = @fastmath minmax(ax, ay)
Expand All @@ -190,8 +189,8 @@ function atan360(y::T, x::T) where T <: Union{Float32, Float64}
end

# override only the `Lab` and `Luv` versions just for now
ColorTypes.hue(c::Lab) = atan360(c.b, c.a)
ColorTypes.hue(c::Luv) = atan360(c.v, c.u)
@inline ColorTypes.hue(c::Lab) = atan360(c.b, c.a)
@inline ColorTypes.hue(c::Luv) = atan360(c.v, c.u)

@inline function sin_kernel(x::Float64)
x * @evalpoly(x^2,
Expand Down