Barry Warsaw | 2406b1d | 1998-01-31 00:29:41 +0000 | [diff] [blame] | 1 | """Color Database. |
| 2 | |
Barry Warsaw | a9053f6 | 1998-10-02 16:01:42 +0000 | [diff] [blame] | 3 | This file contains one class, called ColorDB, and several utility functions. |
| 4 | The class must be instantiated by the get_colordb() function in this file, |
| 5 | passing it a filename to read a database out of. |
| 6 | |
| 7 | The get_colordb() function will try to examine the file to figure out what the |
| 8 | format of the file is. If it can't figure out the file format, or it has |
| 9 | trouble reading the file, None is returned. You can pass get_colordb() an |
| 10 | optional filetype argument. |
Barry Warsaw | 2406b1d | 1998-01-31 00:29:41 +0000 | [diff] [blame] | 11 | |
| 12 | Supporte file types are: |
| 13 | |
| 14 | X_RGB_TXT -- X Consortium rgb.txt format files. Three columns of numbers |
| 15 | from 0 .. 255 separated by whitespace. Arbitrary trailing |
| 16 | columns used as the color name. |
Barry Warsaw | a9053f6 | 1998-10-02 16:01:42 +0000 | [diff] [blame] | 17 | |
| 18 | The utility functions are useful for converting between the various expected |
| 19 | color formats, and for calculating other color values. |
| 20 | |
Barry Warsaw | 2406b1d | 1998-01-31 00:29:41 +0000 | [diff] [blame] | 21 | """ |
| 22 | |
| 23 | import sys |
| 24 | import re |
Barry Warsaw | f4562a7 | 1998-02-11 17:19:23 +0000 | [diff] [blame] | 25 | from types import * |
Barry Warsaw | 8d3e5ee | 1998-02-18 00:02:26 +0000 | [diff] [blame] | 26 | import operator |
Barry Warsaw | 2406b1d | 1998-01-31 00:29:41 +0000 | [diff] [blame] | 27 | |
Barry Warsaw | 9f4d73a | 1998-01-31 23:38:48 +0000 | [diff] [blame] | 28 | class BadColor(Exception): |
| 29 | pass |
| 30 | |
Barry Warsaw | f4562a7 | 1998-02-11 17:19:23 +0000 | [diff] [blame] | 31 | DEFAULT_DB = None |
Barry Warsaw | 6c50ae0 | 2001-07-10 21:38:47 +0000 | [diff] [blame] | 32 | SPACE = ' ' |
| 33 | COMMASPACE = ', ' |
Barry Warsaw | f4562a7 | 1998-02-11 17:19:23 +0000 | [diff] [blame] | 34 | |
Barry Warsaw | a5a018f | 1998-09-25 22:51:36 +0000 | [diff] [blame] | 35 | |
Barry Warsaw | 2406b1d | 1998-01-31 00:29:41 +0000 | [diff] [blame] | 36 | |
| 37 | # generic class |
| 38 | class ColorDB: |
Barry Warsaw | 0604d72 | 1999-04-26 23:17:16 +0000 | [diff] [blame] | 39 | def __init__(self, fp): |
| 40 | lineno = 2 |
| 41 | self.__name = fp.name |
Barry Warsaw | 5c45805 | 2002-10-21 14:25:24 +0000 | [diff] [blame] | 42 | # Maintain several dictionaries for indexing into the color database. |
| 43 | # Note that while Tk supports RGB intensities of 4, 8, 12, or 16 bits, |
| 44 | # for now we only support 8 bit intensities. At least on OpenWindows, |
| 45 | # all intensities in the /usr/openwin/lib/rgb.txt file are 8-bit |
| 46 | # |
| 47 | # key is (red, green, blue) tuple, value is (name, [aliases]) |
| 48 | self.__byrgb = {} |
| 49 | # key is name, value is (red, green, blue) |
| 50 | self.__byname = {} |
Barry Warsaw | 8be2594 | 1998-10-02 14:43:30 +0000 | [diff] [blame] | 51 | # all unique names (non-aliases). built-on demand |
| 52 | self.__allnames = None |
Barry Warsaw | 5c45805 | 2002-10-21 14:25:24 +0000 | [diff] [blame] | 53 | while 1: |
| 54 | line = fp.readline() |
| 55 | if not line: |
| 56 | break |
| 57 | # get this compiled regular expression from derived class |
| 58 | mo = self._re.match(line) |
| 59 | if not mo: |
Barry Warsaw | 6c50ae0 | 2001-07-10 21:38:47 +0000 | [diff] [blame] | 60 | print >> sys.stderr, 'Error in', fp.name, ' line', lineno |
Barry Warsaw | 5c45805 | 2002-10-21 14:25:24 +0000 | [diff] [blame] | 61 | lineno += 1 |
| 62 | continue |
| 63 | # extract the red, green, blue, and name |
Barry Warsaw | 0604d72 | 1999-04-26 23:17:16 +0000 | [diff] [blame] | 64 | red, green, blue = self._extractrgb(mo) |
| 65 | name = self._extractname(mo) |
Barry Warsaw | 5c45805 | 2002-10-21 14:25:24 +0000 | [diff] [blame] | 66 | keyname = name.lower() |
| 67 | # BAW: for now the `name' is just the first named color with the |
| 68 | # rgb values we find. Later, we might want to make the two word |
| 69 | # version the `name', or the CapitalizedVersion, etc. |
| 70 | key = (red, green, blue) |
| 71 | foundname, aliases = self.__byrgb.get(key, (name, [])) |
| 72 | if foundname <> name and foundname not in aliases: |
| 73 | aliases.append(name) |
| 74 | self.__byrgb[key] = (foundname, aliases) |
| 75 | # add to byname lookup |
| 76 | self.__byname[keyname] = key |
| 77 | lineno = lineno + 1 |
Barry Warsaw | 2406b1d | 1998-01-31 00:29:41 +0000 | [diff] [blame] | 78 | |
Barry Warsaw | 0604d72 | 1999-04-26 23:17:16 +0000 | [diff] [blame] | 79 | # override in derived classes |
| 80 | def _extractrgb(self, mo): |
Barry Warsaw | 6c50ae0 | 2001-07-10 21:38:47 +0000 | [diff] [blame] | 81 | return [int(x) for x in mo.group('red', 'green', 'blue')] |
Barry Warsaw | 0604d72 | 1999-04-26 23:17:16 +0000 | [diff] [blame] | 82 | |
| 83 | def _extractname(self, mo): |
| 84 | return mo.group('name') |
| 85 | |
| 86 | def filename(self): |
| 87 | return self.__name |
| 88 | |
Barry Warsaw | eb9b8af | 1998-02-11 18:55:37 +0000 | [diff] [blame] | 89 | def find_byrgb(self, rgbtuple): |
Barry Warsaw | 0604d72 | 1999-04-26 23:17:16 +0000 | [diff] [blame] | 90 | """Return name for rgbtuple""" |
Barry Warsaw | 5c45805 | 2002-10-21 14:25:24 +0000 | [diff] [blame] | 91 | try: |
| 92 | return self.__byrgb[rgbtuple] |
| 93 | except KeyError: |
| 94 | raise BadColor(rgbtuple) |
Barry Warsaw | 2406b1d | 1998-01-31 00:29:41 +0000 | [diff] [blame] | 95 | |
| 96 | def find_byname(self, name): |
Barry Warsaw | 0604d72 | 1999-04-26 23:17:16 +0000 | [diff] [blame] | 97 | """Return (red, green, blue) for name""" |
Barry Warsaw | 5c45805 | 2002-10-21 14:25:24 +0000 | [diff] [blame] | 98 | name = name.lower() |
| 99 | try: |
| 100 | return self.__byname[name] |
| 101 | except KeyError: |
| 102 | raise BadColor(name) |
Barry Warsaw | 2406b1d | 1998-01-31 00:29:41 +0000 | [diff] [blame] | 103 | |
Barry Warsaw | 7a13418 | 1998-09-29 20:03:15 +0000 | [diff] [blame] | 104 | def nearest(self, red, green, blue): |
Barry Warsaw | 0604d72 | 1999-04-26 23:17:16 +0000 | [diff] [blame] | 105 | """Return the name of color nearest (red, green, blue)""" |
Barry Warsaw | 5c45805 | 2002-10-21 14:25:24 +0000 | [diff] [blame] | 106 | # BAW: should we use Voronoi diagrams, Delaunay triangulation, or |
| 107 | # octree for speeding up the locating of nearest point? Exhaustive |
| 108 | # search is inefficient, but seems fast enough. |
| 109 | nearest = -1 |
| 110 | nearest_name = '' |
| 111 | for name, aliases in self.__byrgb.values(): |
| 112 | r, g, b = self.__byname[name.lower()] |
| 113 | rdelta = red - r |
| 114 | gdelta = green - g |
| 115 | bdelta = blue - b |
| 116 | distance = rdelta * rdelta + gdelta * gdelta + bdelta * bdelta |
| 117 | if nearest == -1 or distance < nearest: |
| 118 | nearest = distance |
| 119 | nearest_name = name |
| 120 | return nearest_name |
Barry Warsaw | 8be2594 | 1998-10-02 14:43:30 +0000 | [diff] [blame] | 121 | |
Barry Warsaw | 9f3ea21 | 1998-10-02 15:59:20 +0000 | [diff] [blame] | 122 | def unique_names(self): |
Barry Warsaw | 8be2594 | 1998-10-02 14:43:30 +0000 | [diff] [blame] | 123 | # sorted |
| 124 | if not self.__allnames: |
| 125 | self.__allnames = [] |
| 126 | for name, aliases in self.__byrgb.values(): |
| 127 | self.__allnames.append(name) |
Barry Warsaw | 9f3ea21 | 1998-10-02 15:59:20 +0000 | [diff] [blame] | 128 | # sort irregardless of case |
| 129 | def nocase_cmp(n1, n2): |
Barry Warsaw | 6c50ae0 | 2001-07-10 21:38:47 +0000 | [diff] [blame] | 130 | return cmp(n1.lower(), n2.lower()) |
Barry Warsaw | 9f3ea21 | 1998-10-02 15:59:20 +0000 | [diff] [blame] | 131 | self.__allnames.sort(nocase_cmp) |
Barry Warsaw | 8be2594 | 1998-10-02 14:43:30 +0000 | [diff] [blame] | 132 | return self.__allnames |
Barry Warsaw | 9f3ea21 | 1998-10-02 15:59:20 +0000 | [diff] [blame] | 133 | |
| 134 | def aliases_of(self, red, green, blue): |
| 135 | try: |
| 136 | name, aliases = self.__byrgb[(red, green, blue)] |
| 137 | except KeyError: |
| 138 | raise BadColor((red, green, blue)) |
| 139 | return [name] + aliases |
Barry Warsaw | 5c45805 | 2002-10-21 14:25:24 +0000 | [diff] [blame] | 140 | |
Barry Warsaw | 2406b1d | 1998-01-31 00:29:41 +0000 | [diff] [blame] | 141 | |
| 142 | class RGBColorDB(ColorDB): |
| 143 | _re = re.compile( |
Barry Warsaw | 0604d72 | 1999-04-26 23:17:16 +0000 | [diff] [blame] | 144 | '\s*(?P<red>\d+)\s+(?P<green>\d+)\s+(?P<blue>\d+)\s+(?P<name>.*)') |
| 145 | |
| 146 | |
| 147 | class HTML40DB(ColorDB): |
| 148 | _re = re.compile('(?P<name>\S+)\s+(?P<hexrgb>#[0-9a-fA-F]{6})') |
| 149 | |
| 150 | def _extractrgb(self, mo): |
| 151 | return rrggbb_to_triplet(mo.group('hexrgb')) |
| 152 | |
| 153 | class LightlinkDB(HTML40DB): |
| 154 | _re = re.compile('(?P<name>(.+))\s+(?P<hexrgb>#[0-9a-fA-F]{6})') |
| 155 | |
| 156 | def _extractname(self, mo): |
Barry Warsaw | 6c50ae0 | 2001-07-10 21:38:47 +0000 | [diff] [blame] | 157 | return mo.group('name').strip() |
Barry Warsaw | 0604d72 | 1999-04-26 23:17:16 +0000 | [diff] [blame] | 158 | |
| 159 | class WebsafeDB(ColorDB): |
| 160 | _re = re.compile('(?P<hexrgb>#[0-9a-fA-F]{6})') |
| 161 | |
| 162 | def _extractrgb(self, mo): |
| 163 | return rrggbb_to_triplet(mo.group('hexrgb')) |
| 164 | |
| 165 | def _extractname(self, mo): |
Barry Warsaw | 6c50ae0 | 2001-07-10 21:38:47 +0000 | [diff] [blame] | 166 | return mo.group('hexrgb').upper() |
Barry Warsaw | 2406b1d | 1998-01-31 00:29:41 +0000 | [diff] [blame] | 167 | |
| 168 | |
| 169 | |
| 170 | # format is a tuple (RE, SCANLINES, CLASS) where RE is a compiled regular |
| 171 | # expression, SCANLINES is the number of header lines to scan, and CLASS is |
| 172 | # the class to instantiate if a match is found |
| 173 | |
Barry Warsaw | 0604d72 | 1999-04-26 23:17:16 +0000 | [diff] [blame] | 174 | FILETYPES = [ |
Barry Warsaw | 5c45805 | 2002-10-21 14:25:24 +0000 | [diff] [blame] | 175 | (re.compile('Xorg'), RGBColorDB), |
Barry Warsaw | 0604d72 | 1999-04-26 23:17:16 +0000 | [diff] [blame] | 176 | (re.compile('XConsortium'), RGBColorDB), |
| 177 | (re.compile('HTML'), HTML40DB), |
| 178 | (re.compile('lightlink'), LightlinkDB), |
| 179 | (re.compile('Websafe'), WebsafeDB), |
| 180 | ] |
Barry Warsaw | 2406b1d | 1998-01-31 00:29:41 +0000 | [diff] [blame] | 181 | |
Barry Warsaw | 0604d72 | 1999-04-26 23:17:16 +0000 | [diff] [blame] | 182 | def get_colordb(file, filetype=None): |
Barry Warsaw | 2406b1d | 1998-01-31 00:29:41 +0000 | [diff] [blame] | 183 | colordb = None |
Barry Warsaw | 0604d72 | 1999-04-26 23:17:16 +0000 | [diff] [blame] | 184 | fp = open(file) |
Barry Warsaw | 2406b1d | 1998-01-31 00:29:41 +0000 | [diff] [blame] | 185 | try: |
Barry Warsaw | 0604d72 | 1999-04-26 23:17:16 +0000 | [diff] [blame] | 186 | line = fp.readline() |
| 187 | if not line: |
| 188 | return None |
| 189 | # try to determine the type of RGB file it is |
| 190 | if filetype is None: |
| 191 | filetypes = FILETYPES |
| 192 | else: |
| 193 | filetypes = [filetype] |
| 194 | for typere, class_ in filetypes: |
| 195 | mo = typere.search(line) |
| 196 | if mo: |
| 197 | break |
| 198 | else: |
| 199 | # no matching type |
| 200 | return None |
| 201 | # we know the type and the class to grok the type, so suck it in |
| 202 | colordb = class_(fp) |
Barry Warsaw | 2406b1d | 1998-01-31 00:29:41 +0000 | [diff] [blame] | 203 | finally: |
Barry Warsaw | 0604d72 | 1999-04-26 23:17:16 +0000 | [diff] [blame] | 204 | fp.close() |
Barry Warsaw | f4562a7 | 1998-02-11 17:19:23 +0000 | [diff] [blame] | 205 | # save a global copy |
| 206 | global DEFAULT_DB |
| 207 | DEFAULT_DB = colordb |
Barry Warsaw | 2406b1d | 1998-01-31 00:29:41 +0000 | [diff] [blame] | 208 | return colordb |
| 209 | |
Barry Warsaw | 9f4d73a | 1998-01-31 23:38:48 +0000 | [diff] [blame] | 210 | |
| 211 | |
Barry Warsaw | 8d3e5ee | 1998-02-18 00:02:26 +0000 | [diff] [blame] | 212 | _namedict = {} |
Barry Warsaw | 6c50ae0 | 2001-07-10 21:38:47 +0000 | [diff] [blame] | 213 | |
| 214 | def rrggbb_to_triplet(color): |
Barry Warsaw | 9f4d73a | 1998-01-31 23:38:48 +0000 | [diff] [blame] | 215 | """Converts a #rrggbb color to the tuple (red, green, blue).""" |
Barry Warsaw | 8d3e5ee | 1998-02-18 00:02:26 +0000 | [diff] [blame] | 216 | rgbtuple = _namedict.get(color) |
| 217 | if rgbtuple is None: |
Barry Warsaw | b7b1cf0 | 1998-10-06 18:10:59 +0000 | [diff] [blame] | 218 | if color[0] <> '#': |
| 219 | raise BadColor(color) |
Barry Warsaw | 5c45805 | 2002-10-21 14:25:24 +0000 | [diff] [blame] | 220 | red = color[1:3] |
| 221 | green = color[3:5] |
| 222 | blue = color[5:7] |
Barry Warsaw | 6c50ae0 | 2001-07-10 21:38:47 +0000 | [diff] [blame] | 223 | rgbtuple = int(red, 16), int(green, 16), int(blue, 16) |
Barry Warsaw | 5c45805 | 2002-10-21 14:25:24 +0000 | [diff] [blame] | 224 | _namedict[color] = rgbtuple |
Barry Warsaw | 8d3e5ee | 1998-02-18 00:02:26 +0000 | [diff] [blame] | 225 | return rgbtuple |
Barry Warsaw | 9f4d73a | 1998-01-31 23:38:48 +0000 | [diff] [blame] | 226 | |
Barry Warsaw | f4562a7 | 1998-02-11 17:19:23 +0000 | [diff] [blame] | 227 | |
Barry Warsaw | 8d3e5ee | 1998-02-18 00:02:26 +0000 | [diff] [blame] | 228 | _tripdict = {} |
Barry Warsaw | f4562a7 | 1998-02-11 17:19:23 +0000 | [diff] [blame] | 229 | def triplet_to_rrggbb(rgbtuple): |
| 230 | """Converts a (red, green, blue) tuple to #rrggbb.""" |
Barry Warsaw | 0604d72 | 1999-04-26 23:17:16 +0000 | [diff] [blame] | 231 | global _tripdict |
Barry Warsaw | 8d3e5ee | 1998-02-18 00:02:26 +0000 | [diff] [blame] | 232 | hexname = _tripdict.get(rgbtuple) |
| 233 | if hexname is None: |
Barry Warsaw | 5c45805 | 2002-10-21 14:25:24 +0000 | [diff] [blame] | 234 | hexname = '#%02x%02x%02x' % rgbtuple |
| 235 | _tripdict[rgbtuple] = hexname |
Barry Warsaw | 8d3e5ee | 1998-02-18 00:02:26 +0000 | [diff] [blame] | 236 | return hexname |
Barry Warsaw | 9f4d73a | 1998-01-31 23:38:48 +0000 | [diff] [blame] | 237 | |
| 238 | |
Barry Warsaw | 8d3e5ee | 1998-02-18 00:02:26 +0000 | [diff] [blame] | 239 | _maxtuple = (256.0,) * 3 |
Barry Warsaw | a5a018f | 1998-09-25 22:51:36 +0000 | [diff] [blame] | 240 | def triplet_to_fractional_rgb(rgbtuple): |
Barry Warsaw | 8d3e5ee | 1998-02-18 00:02:26 +0000 | [diff] [blame] | 241 | return map(operator.__div__, rgbtuple, _maxtuple) |
Barry Warsaw | 2662e15 | 1998-02-13 21:27:56 +0000 | [diff] [blame] | 242 | |
| 243 | |
Barry Warsaw | 0e3e699 | 1998-09-28 23:39:18 +0000 | [diff] [blame] | 244 | def triplet_to_brightness(rgbtuple): |
| 245 | # return the brightness (grey level) along the scale 0.0==black to |
| 246 | # 1.0==white |
| 247 | r = 0.299 |
| 248 | g = 0.587 |
| 249 | b = 0.114 |
| 250 | return r*rgbtuple[0] + g*rgbtuple[1] + b*rgbtuple[2] |
| 251 | |
| 252 | |
Barry Warsaw | 2406b1d | 1998-01-31 00:29:41 +0000 | [diff] [blame] | 253 | |
| 254 | if __name__ == '__main__': |
Barry Warsaw | 2406b1d | 1998-01-31 00:29:41 +0000 | [diff] [blame] | 255 | colordb = get_colordb('/usr/openwin/lib/rgb.txt') |
| 256 | if not colordb: |
Barry Warsaw | 5c45805 | 2002-10-21 14:25:24 +0000 | [diff] [blame] | 257 | print 'No parseable color database found' |
| 258 | sys.exit(1) |
Barry Warsaw | 2406b1d | 1998-01-31 00:29:41 +0000 | [diff] [blame] | 259 | # on my system, this color matches exactly |
| 260 | target = 'navy' |
Barry Warsaw | a5a018f | 1998-09-25 22:51:36 +0000 | [diff] [blame] | 261 | red, green, blue = rgbtuple = colordb.find_byname(target) |
| 262 | print target, ':', red, green, blue, triplet_to_rrggbb(rgbtuple) |
| 263 | name, aliases = colordb.find_byrgb(rgbtuple) |
Barry Warsaw | 6c50ae0 | 2001-07-10 21:38:47 +0000 | [diff] [blame] | 264 | print 'name:', name, 'aliases:', COMMASPACE.join(aliases) |
Barry Warsaw | 5c45805 | 2002-10-21 14:25:24 +0000 | [diff] [blame] | 265 | r, g, b = (1, 1, 128) # nearest to navy |
| 266 | r, g, b = (145, 238, 144) # nearest to lightgreen |
| 267 | r, g, b = (255, 251, 250) # snow |
Barry Warsaw | 2406b1d | 1998-01-31 00:29:41 +0000 | [diff] [blame] | 268 | print 'finding nearest to', target, '...' |
| 269 | import time |
| 270 | t0 = time.time() |
Barry Warsaw | 840a84d | 1998-10-15 02:18:08 +0000 | [diff] [blame] | 271 | nearest = colordb.nearest(r, g, b) |
Barry Warsaw | 2406b1d | 1998-01-31 00:29:41 +0000 | [diff] [blame] | 272 | t1 = time.time() |
| 273 | print 'found nearest color', nearest, 'in', t1-t0, 'seconds' |
Barry Warsaw | 840a84d | 1998-10-15 02:18:08 +0000 | [diff] [blame] | 274 | # dump the database |
| 275 | for n in colordb.unique_names(): |
| 276 | r, g, b = colordb.find_byname(n) |
| 277 | aliases = colordb.aliases_of(r, g, b) |
| 278 | print '%20s: (%3d/%3d/%3d) == %s' % (n, r, g, b, |
Barry Warsaw | 6c50ae0 | 2001-07-10 21:38:47 +0000 | [diff] [blame] | 279 | SPACE.join(aliases[1:])) |