color: add more function, use them in shr-color
[gnus] / lisp / color.el
1 ;;; color.el --- Color manipulation laboratory routines -*- coding: utf-8; -*-
2
3 ;; Copyright (C) 2010 Free Software Foundation, Inc.
4
5 ;; Author: Julien Danjou <julien@danjou.info>
6 ;; Keywords: html
7
8 ;; This file is part of GNU Emacs.
9
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
14
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 ;; GNU General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
22
23 ;;; Commentary:
24
25 ;; This package provides color manipulation functions.
26
27 ;;; Code:
28
29 (eval-when-compile
30   (require 'cl))
31
32 ;; Emacs < 23.3
33 (eval-and-compile
34   (unless (boundp 'float-pi)
35     (defconst float-pi (* 4 (atan 1)) "The value of Pi (3.1415926...).")))
36
37 (defun color-rgb->hex  (red green blue)
38   "Return hexadecimal notation for RED GREEN BLUE color.
39 RED GREEN BLUE must be values between [0,1]."
40   (format "#%02x%02x%02x"
41           (* red 255) (* green 255) (* blue 255)))
42
43 (defun color-complement (color)
44   "Return the color that is the complement of COLOR."
45   (let ((color (color-rgb->normalize color)))
46     (list (- 1.0 (car color))
47           (- 1.0 (cadr color))
48           (- 1.0 (caddr color)))))
49
50 (defun color-complement-hex (color)
51   "Return the color that is the complement of COLOR, in hexadecimal format."
52   (apply 'color-rgb->hex (color-complement color)))
53
54 (defun color-rgb->hsv (red green blue)
55   "Convert RED GREEN BLUE values to HSV representation.
56 Hue is in radian. Saturation and values are between 0 and 1."
57    (let* ((r (float red))
58          (g (float green))
59          (b (float blue))
60          (max (max r g b))
61          (min (min r g b)))
62      (list
63       (/ (* 2 float-pi
64             (cond ((and (= r g) (= g b)) 0)
65                   ((and (= r max)
66                         (>= g b))
67                    (* 60 (/ (- g b) (- max min))))
68                   ((and (= r max)
69                         (< g b))
70                    (+ 360 (* 60 (/ (- g b) (- max min)))))
71                   ((= max g)
72                    (+ 120 (* 60 (/ (- b r) (- max min)))))
73                   ((= max b)
74                        (+ 240 (* 60 (/ (- r g) (- max min)))))))
75          360)
76       (if (= max 0)
77           0
78         (- 1 (/ min max)))
79       (/ max 255.0))))
80
81 (defun color-rgb->hsl (red green blue)
82   "Convert RED GREEN BLUE colors to their HSL representation.
83 RED, GREEN and BLUE must be between [0,1]."
84   (let* ((r red)
85          (g green)
86          (b blue)
87          (max (max r g b))
88          (min (min r g b))
89          (delta (- max min))
90          (l (/ (+ max min) 2.0)))
91     (list
92      (if (= max min)
93          0
94        (* 2 float-pi
95           (/ (cond ((= max r)
96                     (+ (/ (- g b) delta) (if (< g b) 6 0)))
97                    ((= max g)
98                  (+ (/ (- b r) delta) 2))
99                    (t
100                     (+ (/ (- r g) delta) 4)))
101              6)))
102      (if (= max min)
103          0
104        (if (> l 0.5)
105            (/ delta (- 2 (+ max min)))
106          (/ delta (+ max min))))
107      l)))
108
109 (defun color-rgb->xyz (red green blue)
110   "Converts RED GREEN BLUE colors to CIE XYZ representation.
111 RED, BLUE and GREEN must be between [0,1]."
112   (let ((r (if (<= red 0.04045)
113                (/ red 12.95)
114              (expt (/ (+ red 0.055) 1.055) 2.4)))
115         (g (if (<= green 0.04045)
116                (/ green 12.95)
117              (expt (/ (+ green 0.055) 1.055) 2.4)))
118         (b (if (<= blue 0.04045)
119                (/ blue 12.95)
120              (expt (/ (+ blue 0.055) 1.055) 2.4))))
121     (list (+ (* 0.4124564 r) (* 0.3575761 g) (* 0.1804375 b))
122           (+ (* 0.21266729 r) (* 0.7151522 g) (* 0.0721750 b))
123           (+ (* 0.0193339 r) (* 0.1191920 g) (* 0.9503041 b)))))
124
125 (defun color-xyz->rgb (X Y Z)
126   "Converts CIE X Y Z colors to RGB."
127   (let ((r (+ (* 3.2404542 X) (* -1.5371385 Y) (* -0.4985314 Z)))
128         (g (+ (* -0.9692660 X) (* 1.8760108 Y) (* 0.0415560 Z)))
129         (b (+ (* 0.0556434 X) (* -0.2040259 Y) (* 1.0572252 Z))))
130     (list (if (<= r 0.0031308)
131               (* 12.92 r)
132             (- (* 1.055 (expt r (/ 1 2.4))) 0.055))
133           (if (<= g 0.0031308)
134               (* 12.92 g)
135             (- (* 1.055 (expt g (/ 1 2.4))) 0.055))
136           (if (<= b 0.0031308)
137               (* 12.92 b)
138             (- (* 1.055 (expt b (/ 1 2.4))) 0.055)))))
139
140 (defconst color-d65-xyz '(0.950455 1.0 1.088753)
141   "D65 white point in CIE XYZ.")
142
143 (defconst color-cie-ε (/ 216 24389.0))
144 (defconst color-cie-κ (/ 24389 27.0))
145
146 (defun color-xyz->lab (X Y Z &optional white-point)
147   "Converts CIE XYZ to CIE L*a*b*.
148 WHITE-POINT can be specified as (X Y Z) white point to use. If
149 none is set, `color-d65-xyz' is used."
150   (destructuring-bind (Xr Yr Zr) (or white-point color-d65-xyz)
151       (let* ((xr (/ X Xr))
152              (yr (/ Y Yr))
153              (zr (/ Z Zr))
154              (fx (if (> xr color-cie-ε)
155                      (expt xr (/ 1 3.0))
156                    (/ (+ (* color-cie-κ xr) 16) 116.0)))
157              (fy (if (> yr color-cie-ε)
158                      (expt yr (/ 1 3.0))
159                    (/ (+ (* color-cie-κ yr) 16) 116.0)))
160              (fz (if (> zr color-cie-ε)
161                      (expt zr (/ 1 3.0))
162                    (/ (+ (* color-cie-κ zr) 16) 116.0))))
163         (list
164          (- (* 116 fy) 16)                  ; L
165          (* 500 (- fx fy))                  ; a
166          (* 200 (- fy fz))))))              ; b
167
168 (defun color-lab->xyz (L a b &optional white-point)
169   "Converts CIE L*a*b* to CIE XYZ.
170 WHITE-POINT can be specified as (X Y Z) white point to use. If
171 none is set, `color-d65-xyz' is used."
172   (destructuring-bind (Xr Yr Zr) (or white-point color-d65-xyz)
173       (let* ((fy (/ (+ L 16) 116.0))
174              (fz (- fy (/ b 200.0)))
175              (fx (+ (/ a 500.0) fy))
176              (xr (if (> (expt fx 3.0) color-cie-ε)
177                      (expt fx 3.0)
178                (/ (- (* fx 116) 16) color-cie-κ)))
179              (yr (if (> L (* color-cie-κ color-cie-ε))
180                      (expt (/ (+ L 16) 116.0) 3.0)
181                    (/ L color-cie-κ)))
182              (zr (if (> (expt fz 3) color-cie-ε)
183                      (expt fz 3.0)
184                    (/ (- (* 116 fz) 16) color-cie-κ))))
185         (list (* xr Xr)                 ; X
186               (* yr Yr)                 ; Y
187               (* zr Zr)))))             ; Z
188
189 (defun color-rgb->lab (red green blue)
190   "Converts RGB to CIE L*a*b*."
191   (apply 'color-xyz->lab (color-rgb->xyz red green blue)))
192
193 (defun color-rgb->normalize (color)
194   "Normalize a RGB color to values between [0,1]."
195   (mapcar (lambda (x) (/ x 65535.0)) (x-color-values color)))
196
197 (defun color-lab->rgb (L a b)
198   "Converts CIE L*a*b* to RGB."
199   (apply 'color-xyz->rgb (color-lab->xyz L a b)))
200
201 (defun color-cie-de2000 (color1 color2 &optional kL kC kH)
202   "Computes the CIEDE2000 color distance between COLOR1 and COLOR2.
203 Colors must be in CIE L*a*b* format."
204   (destructuring-bind (L₁ a₁ b₁) color1
205     (destructuring-bind (L₂ a₂ b₂) color2
206       (let* ((kL (or kL 1))
207              (kC (or kC 1))
208              (kH (or kH 1))
209              (C₁ (sqrt (+ (expt a₁ 2.0) (expt b₁ 2.0))))
210              (C₂ (sqrt (+ (expt a₂ 2.0) (expt b₂ 2.0))))
211              (C̄ (/ (+ C₁ C₂) 2.0))
212              (G (* 0.5 (- 1 (sqrt (/ (expt C̄ 7.0) (+ (expt C̄ 7.0) (expt 25 7.0)))))))
213              (a′₁ (* (+ 1 G) a₁))
214              (a′₂ (* (+ 1 G) a₂))
215              (C′₁ (sqrt (+ (expt a′₁ 2.0) (expt b₁ 2.0))))
216              (C′₂ (sqrt (+ (expt a′₂ 2.0) (expt b₂ 2.0))))
217              (h′₁ (if (and (= b₁ 0) (= a′₁ 0))
218                       0
219                     (let ((v (atan b₁ a′₁)))
220                       (if (< v 0)
221                           (+ v (* 2 float-pi))
222                         v))))
223              (h′₂ (if (and (= b₂ 0) (= a′₂ 0))
224                       0
225                     (let ((v (atan b₂ a′₂)))
226                       (if (< v 0)
227                           (+ v (* 2 float-pi))
228                         v))))
229              (ΔL′ (- L₂ L₁))
230              (ΔC′ (- C′₂ C′₁))
231              (Δh′ (cond ((= (* C′₁ C′₂) 0)
232                          0)
233                         ((<= (abs (- h′₂ h′₁)) float-pi)
234                          (- h′₂ h′₁))
235                         ((> (- h′₂ h′₁) float-pi)
236                          (- (- h′₂ h′₁) (* 2 float-pi)))
237                         ((< (- h′₂ h′₁) (- float-pi))
238                          (+ (- h′₂ h′₁) (* 2 float-pi)))))
239              (ΔH′ (* 2 (sqrt (* C′₁ C′₂)) (sin (/ Δh′ 2.0))))
240              (L̄′ (/ (+ L₁ L₂) 2.0))
241              (C̄′ (/ (+ C′₁ C′₂) 2.0))
242              (h̄′ (cond ((= (* C′₁ C′₂) 0)
243                         (+ h′₁ h′₂))
244                        ((<= (abs (- h′₁ h′₂)) float-pi)
245                         (/ (+ h′₁ h′₂) 2.0))
246                        ((< (+ h′₁ h′₂) (* 2 float-pi))
247                         (/ (+ h′₁ h′₂ (* 2 float-pi)) 2.0))
248                        ((>= (+ h′₁ h′₂) (* 2 float-pi))
249                         (/ (+ h′₁ h′₂ (* -2 float-pi)) 2.0))))
250              (T (+ 1
251                    (- (* 0.17 (cos (- h̄′ (degrees-to-radians 30)))))
252                    (* 0.24 (cos (* h̄′ 2)))
253                    (* 0.32 (cos (+ (* h̄′ 3) (degrees-to-radians 6))))
254                    (- (* 0.20 (cos (- (* h̄′ 4) (degrees-to-radians 63)))))))
255              (Δθ (* (degrees-to-radians 30) (exp (- (expt (/ (- h̄′ (degrees-to-radians 275)) (degrees-to-radians 25)) 2.0)))))
256              (Rc (* 2 (sqrt (/ (expt C̄′ 7.0) (+ (expt C̄′ 7.0) (expt 25.0 7.0))))))
257              (Sl (+ 1 (/ (* 0.015 (expt (- L̄′ 50) 2.0)) (sqrt (+ 20 (expt (- L̄′ 50) 2.0))))))
258              (Sc (+ 1 (* C̄′ 0.045)))
259              (Sh (+ 1 (* 0.015 C̄′ T)))
260              (Rt (- (* (sin (* Δθ 2)) Rc))))
261         (sqrt (+ (expt (/ ΔL′ (* Sl kL)) 2.0)
262                  (expt (/ ΔC′ (* Sc kC)) 2.0)
263                  (expt (/ ΔH′ (* Sh kH)) 2.0)
264                  (* Rt (/ ΔC′ (* Sc kC)) (/ ΔH′ (* Sh kH)))))))))
265
266 (provide 'color)
267
268 ;;; color.el ends here