/* ** Copyright (C) 1989 by Jef Poskanzer. ** ** Permission to use, copy, modify, and distribute this software and its ** documentation for any purpose and without fee is hereby granted, provided ** that the above copyright notice appear in all copies and that both that ** copyright notice and this permission notice appear in supporting ** documentation. This software is provided "as is" without express or ** implied warranty. */ #include #include #include #include #include #include "netpbm/pm_c_util.h" #include "netpbm/mallocvar.h" #include "netpbm/nstring.h" #include "ppm.h" #include "colorname.h" #include "pam.h" #define MAXCOLORNAMES 1000u /* The maximum size of a colornames array, in the old interface */ static colorhash_table allocColorHash(void) { colorhash_table cht; jmp_buf jmpbuf; jmp_buf * origJmpbufP; if (setjmp(jmpbuf) != 0) cht = NULL; else { pm_setjmpbufsave(&jmpbuf, &origJmpbufP); cht = ppm_alloccolorhash(); } pm_setjmpbuf(origJmpbufP); return cht; } static ppm_ColorDict * colorDict_newEmpty() { ppm_ColorDict * colorDictP; MALLOCVAR_NOFAIL(colorDictP); colorDictP->version = 0; colorDictP->size = 0; colorDictP->name = NULL; colorDictP->color = NULL; colorDictP->cht = allocColorHash(); colorDictP->count = 0; if (!colorDictP->cht) pm_error("Unable to allocate space for color hash"); return colorDictP; } void ppm_colorDict_destroy(ppm_ColorDict * const colorDictP) { unsigned int i; for (i = 0; i < colorDictP->size; ++i) pm_strfree(colorDictP->name[i]); if (colorDictP->name) free(colorDictP->name); if (colorDictP->color) free(colorDictP->color); ppm_freecolorhash(colorDictP->cht); free(colorDictP); } static void colorDict_resize(ppm_ColorDict * const colorDictP, unsigned int const newSz, const char ** const errorP) { const char ** newName; newName = realloc(colorDictP->name, newSz * sizeof(colorDictP->name[0])); if (!newName) pm_asprintf(errorP, "Failed to extend allocation for color " "dictionary to %u entries", newSz); else { pixel * newColor; colorDictP->name = newName; newColor = realloc(colorDictP->color, newSz * sizeof(colorDictP->color[0])); if (!newColor) pm_asprintf(errorP, "Failed to extend allocation for color " "dictionary to %u entries", newSz); else { *errorP = NULL; colorDictP->color = newColor; colorDictP->size = newSz; } } } static void openColornameFile(const char * const fileName, bool const mustOpen, FILE ** const filePP, const char ** const errorP) { jmp_buf jmpbuf; jmp_buf * origJmpbufP; if (setjmp(jmpbuf) != 0) { pm_asprintf(errorP, "Failed to open color name file"); } else { pm_setjmpbufsave(&jmpbuf, &origJmpbufP); *filePP = pm_openColornameFile(fileName, mustOpen); *errorP = NULL; /* Would have longjmped if there were a problem */ } pm_setjmpbuf(origJmpbufP); } static void processColorfileEntry(struct colorfile_entry const ce, ppm_ColorDict * const colorDictP, const char ** const errorP) { /*---------------------------------------------------------------------------- Add the color file entry 'ce' to *colorDictP as required. -----------------------------------------------------------------------------*/ pixel color; PPM_ASSIGN(color, ce.r, ce.g, ce.b); if (ppm_lookupcolor(colorDictP->cht, &color) >= 0) { /* The color is already in the hash, which means we saw it earlier in the file. We prefer the first name that the file gives for each color, so we just ignore the current entry. */ *errorP = NULL; } else { ppm_addtocolorhash(colorDictP->cht, &color, colorDictP->count); if (colorDictP->count >= colorDictP->size) { colorDict_resize(colorDictP, MAX(1024, colorDictP->size * 2), errorP); } else *errorP = NULL; assert(colorDictP->size >= colorDictP->count); if (!*errorP) { colorDictP->name[colorDictP->count] = pm_strdup(ce.colorname); colorDictP->color[colorDictP->count] = color; if (colorDictP->name[colorDictP->count] == pm_strsol) pm_asprintf(errorP, "Unable to allocate space for color name"); else ++colorDictP->count; } } } static void readColorFile(const char * const fileName, bool const mustOpen, ppm_ColorDict * const colorDictP, const char ** const errorP) { /*---------------------------------------------------------------------------- Read the color dictionary file named 'fileName' and add the colors in it to *colorDictP. If the file is not openable (e.g. no file by that name exists), abort the program if 'mustOpen' is true; otherwise, return values indicating a dictionary with no colors. We may add colors to *colorDictP even if we fail. -----------------------------------------------------------------------------*/ FILE * colorFileP; openColornameFile(fileName, mustOpen, &colorFileP, errorP); if (!*errorP) { if (!colorFileP) { /* Couldn't open it, but Caller says treat same as empty file */ *errorP = NULL; } else { bool done; for (done = false, *errorP = NULL; !done && !*errorP; ) { struct colorfile_entry const ce = pm_colorget(colorFileP); if (!ce.colorname) done = true; else processColorfileEntry(ce, colorDictP, errorP); } fclose(colorFileP); } } } ppm_ColorDict * ppm_colorDict_new(const char * const fileName, int const mustOpen) { ppm_ColorDict * colorDictP; const char * error; colorDictP = colorDict_newEmpty(); readColorFile(fileName, mustOpen, colorDictP, &error); if (error) { pm_errormsg("%s", error); pm_strfree(error); pm_longjmp(); } return colorDictP; } pixel ppm_parsecolor2(const char * const colorname, pixval const maxval, int const closeOk) { tuple const color = pnm_parsecolor2(colorname, maxval, closeOk); pixel retval; PPM_PUTR(retval, color[PAM_RED_PLANE]); PPM_PUTG(retval, color[PAM_GRN_PLANE]); PPM_PUTB(retval, color[PAM_BLU_PLANE]); free(color); return retval; } pixel ppm_parsecolor(const char * const colorname, pixval const maxval) { return ppm_parsecolor2(colorname, maxval, true); } char * ppm_colorname(const pixel * const colorP, pixval const maxval, int const hexok) { int r, g, b; FILE * fileP; static char colorname[200]; /* Null string means no suitable name so far */ if (maxval == 255) { r = PPM_GETR(*colorP); g = PPM_GETG(*colorP); b = PPM_GETB(*colorP); } else { r = (int) PPM_GETR(*colorP) * 255 / (int) maxval; g = (int) PPM_GETG(*colorP) * 255 / (int) maxval; b = (int) PPM_GETB(*colorP) * 255 / (int) maxval; } fileP = pm_openColornameFile(NULL, !hexok); if (!fileP) STRSCPY(colorname, ""); else { int bestDiff; bool eof; for (bestDiff = 32767, eof = false; !eof && bestDiff > 0; ) { struct colorfile_entry const ce = pm_colorget(fileP); if (ce.colorname) { int const thisDiff = abs(r - (int)ce.r) + abs(g - (int)ce.g) + abs(b - (int)ce.b); if (thisDiff < bestDiff) { bestDiff = thisDiff; STRSCPY(colorname, ce.colorname); } } else eof = true; } fclose(fileP); if (bestDiff == 32767) { /* Color file contain no entries, so we can't even pick a close one */ STRSCPY(colorname, ""); } else if (bestDiff > 0 && hexok) { /* We didn't find an exact match and user is willing to accept hex, so we don't have to use an approximate match. */ STRSCPY(colorname, ""); } } if (streq(colorname, "")) { if (hexok) { /* Color lookup failed, but caller is willing to take an X11-style hex specifier, so return that. */ sprintf(colorname, "#%02x%02x%02x", r, g, b); } else { pm_error("Couldn't find any name colors at all"); } } return colorname; } void ppm_readcolordict(const char * const fileName, int const mustOpen, unsigned int * const nColorsP, const char *** const colorNamesP, pixel ** const colorsP, colorhash_table * const chtP) { /*---------------------------------------------------------------------------- Read the color dictionary from the file named 'fileName' (NULL means default). If we can't open the file (e.g. because it does not exist), and 'mustOpen' is false, return an empty dictionary (it contains no colors). But if 'mustOpen' is true, abort the program instead of returning an empty dictionary. Return as *nColorsP the number of colors in the dictionary. Return as *colorNamesP the names of those colors. *colorNamesP is a malloced array that Caller must free with ppm_freecolorNames(). The first *nColorsP entries are valid; *chtP contains indices into this array. Return as *colorsP a malloced array of the colors. (*colorsP)[i] is the color that goes with (*colorNamesP)[i]. Return as *chtP a color hash table mapping each color in the dictionary to the index into *colorNamesP for the name of the color. Each of 'nColorsP, 'colorNamesP', and 'colorsP' may be null, in which case we do not return the corresponding information (or allocate memory for it). -----------------------------------------------------------------------------*/ ppm_ColorDict * colorDictP; colorDictP = ppm_colorDict_new(fileName, mustOpen); if (chtP) *chtP = colorDictP->cht; else ppm_freecolorhash(colorDictP->cht); if (colorNamesP) { /* We have a simplistic, primitive interface where the array must be exactly MAXCOLORNAMES entries in size with unused entries set to NULL so that caller can free it with a call to 'ppm_freecolornames' (which has no size argument). So we fail now (as the old interface would) if there are more than MAXCOLORNAMES colors and expand the array if there are fewer. */ if (colorDictP->count > MAXCOLORNAMES) pm_error("Too many color names (%u) in color dictionary. " "Max allowed is %u", colorDictP->count, MAXCOLORNAMES); else { unsigned int i; REALLOCARRAY(colorDictP->name, MAXCOLORNAMES); if (!colorDictP->name) pm_error("Failed to allocate color name array for " "maximum colors %u", MAXCOLORNAMES); for (i = colorDictP->count; i < MAXCOLORNAMES; ++i) colorDictP->name[i] = NULL; } *colorNamesP = colorDictP->name; } else { unsigned int i; for (i = 0; i < colorDictP->count; ++i) pm_strfree(colorDictP->name[i]); free(colorDictP->name); } if (colorsP) *colorsP = colorDictP->color; else free(colorDictP->color); if (nColorsP) *nColorsP = colorDictP->count; } void ppm_readcolornamefile(const char * const fileName, int const mustOpen, colorhash_table * const chtP, const char *** const colorNamesP) { ppm_readcolordict(fileName, mustOpen, NULL, colorNamesP, NULL, chtP); } void ppm_freecolornames(const char ** const colorNames) { unsigned int i; for (i = 0; i < MAXCOLORNAMES; ++i) if (colorNames[i]) free((char *)colorNames[i]); free(colorNames); } static unsigned int nonnegative(unsigned int const arg) { if ((int)(arg) < 0) return 0; else return arg; } pixel ppm_color_from_ycbcr(unsigned int const y, int const cb, int const cr) { /*---------------------------------------------------------------------------- Return the color that has luminance 'y', blue chrominance 'cb', and red chrominance 'cr'. The 3 input values can be on any scale (as long as it's the same scale for all 3) and the maxval of the returned pixel value is the same as that for the input values. Rounding may cause an output value to be greater than the maxval. -----------------------------------------------------------------------------*/ pixel retval; PPM_ASSIGN(retval, y + 1.4022 * cr, nonnegative(y - 0.7145 * cr - 0.3456 * cb), y + 1.7710 * cb ); return retval; } pixel ppm_color_from_hsv(struct hsv const hsv, pixval const maxval) { pixel retval; double R, G, B; if (hsv.s == 0) { R = hsv.v; G = hsv.v; B = hsv.v; } else { unsigned int const sectorSize = 60; /* Color wheel is divided into six 60 degree sectors. */ unsigned int const sector = (hsv.h/sectorSize); /* The sector in which our color resides. Value is in 0..5 */ double const f = (hsv.h - sector*sectorSize)/60; /* The fraction of the way the color is from one side of our sector to the other side, going clockwise. Value is in [0, 1). */ double const m = (hsv.v * (1 - hsv.s)); double const n = (hsv.v * (1 - (hsv.s * f))); double const k = (hsv.v * (1 - (hsv.s * (1 - f)))); switch (sector) { case 0: R = hsv.v; G = k; B = m; break; case 1: R = n; G = hsv.v; B = m; break; case 2: R = m; G = hsv.v; B = k; break; case 3: R = m; G = n; B = hsv.v; break; case 4: R = k; G = m; B = hsv.v; break; case 5: R = hsv.v; G = m; B = n; break; default: pm_error("Invalid H value passed to color_from_HSV: %f", hsv.h); } } PPM_ASSIGN(retval, ppm_unnormalize(R, maxval), ppm_unnormalize(G, maxval), ppm_unnormalize(B, maxval)); return retval; } struct hsv ppm_hsv_from_color(pixel const color, pixval const maxval) { double const epsilon = 1e-5; double const R = (double)PPM_GETR(color) / maxval; double const G = (double)PPM_GETG(color) / maxval; double const B = (double)PPM_GETB(color) / maxval; enum hueSector {SECTOR_RED, SECTOR_GRN, SECTOR_BLU}; enum hueSector hueSector; struct hsv retval; double range; if (R >= G) { if (R >= B) { hueSector = SECTOR_RED; retval.v = R; } else { hueSector = SECTOR_BLU; retval.v = B; } } else { if (G >= B) { hueSector = SECTOR_GRN; retval.v = G; } else { hueSector = SECTOR_BLU; retval.v = B; } } range = retval.v - MIN(R, MIN(G, B)); if (retval.v < epsilon) retval.s = 0.0; else retval.s = range/retval.v; if (range < epsilon) /* It's gray, so hue really has no meaning. We arbitrarily pick 0 */ retval.h = 0.0; else { double const cr = (retval.v - R) / range; double const cg = (retval.v - G) / range; double const cb = (retval.v - B) / range; double angle; /* hue angle, in range -30 - +330 */ switch(hueSector) { case SECTOR_RED: angle = 0.0 + 60.0 * (cb - cg); break; case SECTOR_GRN: angle = 120.0 + 60.0 * (cr - cb); break; case SECTOR_BLU: angle = 240.0 + 60.0 * (cg - cr); break; } retval.h = angle >= 0.0 ? angle : 360 + angle; } return retval; }