forked from mia/Aegisub
6ee2f98349
Document all functions, class, struct, union, enum, macro, variable, typedefs. This isn't the actual document in itself but empty documentation using any old documentation if it was there. This was done using exuberant ctags to get tag info, then a TCL script to parse/remove old comments and convert them into Doxygen-style. Some notes: * Anything labeled 'DOCME' needs to be documented, @param and @return have been left blank as it would be annoying to delete the 'DOCME' from every one of those. * Some multiline comments may have been munged into single line comments * Leave the /// comments above global variables with a space, if they're harder to read then we'll be less likey to use them. * Enum comments can go after the enumeration itself '[value] /// comment' * include/aegisub/*.h haven't been converted yet, this will be done in a later commit * Some documentation blocks are in the wrong place, in the .h when it should be in the .cpp, or vice versa. See http://devel.aegisub.org/wiki/Doxygen for some details on Doxygen and a 'style guide'. Originally committed to SVN as r3312.
497 lines
11 KiB
C++
497 lines
11 KiB
C++
// Copyright (c) 2005, Niels Martin Hansen, Rodrigo Braz Monteiro
|
|
// All rights reserved.
|
|
//
|
|
// Redistribution and use in source and binary forms, with or without
|
|
// modification, are permitted provided that the following conditions are met:
|
|
//
|
|
// * Redistributions of source code must retain the above copyright notice,
|
|
// this list of conditions and the following disclaimer.
|
|
// * Redistributions in binary form must reproduce the above copyright notice,
|
|
// this list of conditions and the following disclaimer in the documentation
|
|
// and/or other materials provided with the distribution.
|
|
// * Neither the name of the Aegisub Group nor the names of its contributors
|
|
// may be used to endorse or promote products derived from this software
|
|
// without specific prior written permission.
|
|
//
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
|
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
// POSSIBILITY OF SUCH DAMAGE.
|
|
//
|
|
// Aegisub Project http://www.aegisub.org/
|
|
//
|
|
// $Id$
|
|
|
|
/// @file colorspace.cpp
|
|
/// @brief Functions for converting colours between different representations
|
|
/// @ingroup utility
|
|
///
|
|
|
|
#include "config.h"
|
|
|
|
#include "colorspace.h"
|
|
#include "utils.h"
|
|
|
|
|
|
|
|
/// @brief matrix from http://forum.doom9.org/showthread.php?p=684080#post684080
|
|
/// @param Y
|
|
/// @param U
|
|
/// @param V
|
|
/// @param R
|
|
/// @param G
|
|
/// @param B
|
|
///
|
|
void yuv_to_rgb(int Y, int U, int V, unsigned char *R, unsigned char *G, unsigned char *B)
|
|
{
|
|
U = U - 128;
|
|
V = V - 128;
|
|
*R = clip_colorval((Y*65536 + int(1.140*65536) * V) / 65536);
|
|
*G = clip_colorval((Y*65536 - int(0.395*65536) * U - int(0.581*65536) * V) / 65536);
|
|
*B = clip_colorval((Y*65536 + int(2.032*65536) * U ) / 65536);
|
|
}
|
|
|
|
|
|
|
|
/// @brief making every value into 0..255 range though algorithm from http://130.113.54.154/~monger/hsl-rgb.html
|
|
/// @param H
|
|
/// @param S
|
|
/// @param L
|
|
/// @param R
|
|
/// @param G
|
|
/// @param B
|
|
/// @return
|
|
///
|
|
void hsl_to_rgb(int H, int S, int L, unsigned char *R, unsigned char *G, unsigned char *B)
|
|
{
|
|
if (S == 0) {
|
|
*R = L;
|
|
*G = L;
|
|
*B = L;
|
|
return;
|
|
}
|
|
|
|
if (L == 128 && S == 255) {
|
|
switch (H) {
|
|
case 0:
|
|
case 255: // actually this is wrong, since this is more like 359 degrees... but it's what you'd expect (sadly :)
|
|
*R = 255;
|
|
*G = 0;
|
|
*B = 0;
|
|
return;
|
|
case 43:
|
|
*R = 255;
|
|
*G = 255;
|
|
*B = 0;
|
|
return;
|
|
case 85:
|
|
*R = 0;
|
|
*G = 255;
|
|
*B = 0;
|
|
return;
|
|
case 128:
|
|
*R = 0;
|
|
*G = 255;
|
|
*B = 255;
|
|
return;
|
|
case 171:
|
|
*R = 0;
|
|
*G = 0;
|
|
*B = 255;
|
|
return;
|
|
case 213:
|
|
*R = 255;
|
|
*G = 0;
|
|
*B = 255;
|
|
return;
|
|
}
|
|
}
|
|
|
|
float h, s, l, r, g, b;
|
|
h = H / 255.f;
|
|
s = S / 255.f;
|
|
l = L / 255.f;
|
|
|
|
float temp2;
|
|
if (l < .5) {
|
|
temp2 = l * (1. + s);
|
|
} else {
|
|
temp2 = l + s - l*s;
|
|
}
|
|
|
|
float temp1 = 2.f * l - temp2;
|
|
|
|
// assume h is in range [0;1]
|
|
float temp3[3];
|
|
temp3[0] = h + 1.f/3.f;
|
|
if (temp3[0] > 1.f) temp3[0] -= 1.f;
|
|
temp3[1] = h;
|
|
temp3[2] = h - 1.f/3.f;
|
|
if (temp3[2] < 0.f) temp3[2] += 1.f;
|
|
|
|
if (6.f * temp3[0] < 1.f)
|
|
r = temp1 + (temp2 - temp1) * 6.f * temp3[0];
|
|
else if (2.f * temp3[0] < 1.f)
|
|
r = temp2;
|
|
else if (3.f * temp3[0] < 2.f)
|
|
r = temp1 + (temp2 - temp1) * ((2.f/3.f) - temp3[0]) * 6.f;
|
|
else
|
|
r = temp1;
|
|
|
|
if (6.f * temp3[1] < 1.f)
|
|
g = temp1 + (temp2 - temp1) * 6.f * temp3[1];
|
|
else if (2.f * temp3[1] < 1.f)
|
|
g = temp2;
|
|
else if (3.f * temp3[1] < 2.f)
|
|
g = temp1 + (temp2 - temp1) * ((2.f/3.f) - temp3[1]) * 6.f;
|
|
else
|
|
g = temp1;
|
|
|
|
if (6.f * temp3[2] < 1.f)
|
|
b = temp1 + (temp2 - temp1) * 6.f * temp3[2];
|
|
else if (2.f * temp3[2] < 1.f)
|
|
b = temp2;
|
|
else if (3.f * temp3[2] < 2.f)
|
|
b = temp1 + (temp2 - temp1) * ((2.f/3.f) - temp3[2]) * 6.f;
|
|
else
|
|
b = temp1;
|
|
|
|
*R = clip_colorval((int)(r*255));
|
|
*G = clip_colorval((int)(g*255));
|
|
*B = clip_colorval((int)(b*255));
|
|
}
|
|
|
|
|
|
|
|
/// @brief the range for H is 0..255 instead of 0..359, so 60 degrees has been translated to 256/6 here formulas taken from wikipedia: http://en.wikipedia.org/wiki/HSV_color_space
|
|
/// @param H
|
|
/// @param S
|
|
/// @param V
|
|
/// @param R
|
|
/// @param G
|
|
/// @param B
|
|
/// @return
|
|
///
|
|
void hsv_to_rgb(int H, int S, int V, unsigned char *R, unsigned char *G, unsigned char *B)
|
|
{
|
|
*R = *G = *B = 0;
|
|
|
|
// some special cases... oh yeah baby!
|
|
if (S == 255) {
|
|
switch (H) {
|
|
case 0:
|
|
case 255: // actually this is wrong, since this is more like 359 degrees... but it's what you'd expect (sadly :)
|
|
*R = V;
|
|
*G = 0;
|
|
*B = 0;
|
|
return;
|
|
case 43:
|
|
*R = V;
|
|
*G = V;
|
|
*B = 0;
|
|
return;
|
|
case 85:
|
|
*R = 0;
|
|
*G = V;
|
|
*B = 0;
|
|
return;
|
|
case 128:
|
|
*R = 0;
|
|
*G = V;
|
|
*B = V;
|
|
return;
|
|
case 171:
|
|
*R = 0;
|
|
*G = 0;
|
|
*B = V;
|
|
return;
|
|
case 213:
|
|
*R = V;
|
|
*G = 0;
|
|
*B = V;
|
|
return;
|
|
}
|
|
}
|
|
|
|
// Cap values
|
|
unsigned int h = H * 360;
|
|
unsigned int s = clip_colorval(S)*256;
|
|
unsigned int v = clip_colorval(V)*256;
|
|
|
|
// Saturation is zero, make grey
|
|
if (S == 0) {
|
|
*R = V;
|
|
*G = V;
|
|
*B = V;
|
|
return;
|
|
}
|
|
|
|
unsigned int r, g, b;
|
|
|
|
// Else, calculate color
|
|
unsigned int Hi = h / 60 / 256;
|
|
unsigned int f = h / 60 - Hi * 256;
|
|
unsigned int p = v * (65535 - s) / 65536;
|
|
unsigned int q = v * (65535 - (f * s)/256) / 65536;
|
|
unsigned int t = v * (65535 - ((255 - f) * s)/256) / 65536;
|
|
switch (Hi) {
|
|
case 0:
|
|
r = v;
|
|
g = t;
|
|
b = p;
|
|
break;
|
|
case 1:
|
|
r = q;
|
|
g = v;
|
|
b = p;
|
|
break;
|
|
case 2:
|
|
r = p;
|
|
g = v;
|
|
b = t;
|
|
break;
|
|
case 3:
|
|
r = p;
|
|
g = q;
|
|
b = v;
|
|
break;
|
|
case 4:
|
|
r = t;
|
|
g = p;
|
|
b = v;
|
|
break;
|
|
case 5:
|
|
default:
|
|
r = v;
|
|
g = p;
|
|
b = q;
|
|
break;
|
|
}
|
|
|
|
*R = clip_colorval(r/256);
|
|
*G = clip_colorval(g/256);
|
|
*B = clip_colorval(b/256);
|
|
}
|
|
|
|
|
|
|
|
/// @brief matrix from http://forum.doom9.org/showthread.php?p=684080#post684080
|
|
/// @param R
|
|
/// @param G
|
|
/// @param B
|
|
/// @param Y
|
|
/// @param U
|
|
/// @param V
|
|
///
|
|
void rgb_to_yuv(int R, int G, int B, unsigned char *Y, unsigned char *U, unsigned char *V)
|
|
{
|
|
*Y = clip_colorval(( int(0.299*65536) * R + int(0.587*65536) * G + int(0.114*65536) * B) / 65536);
|
|
*U = clip_colorval((-int(0.147*65536) * R - int(0.289*65536) * G + int(0.436*65536) * B) / 65536 + 128);
|
|
*V = clip_colorval(( int(0.615*65536) * R - int(0.515*65536) * G - int(0.100*65536) * B) / 65536 + 128);
|
|
}
|
|
|
|
|
|
|
|
/// @brief still keeping everything integer also from http://130.113.54.154/~monger/hsl-rgb.html
|
|
/// @param R
|
|
/// @param G
|
|
/// @param B
|
|
/// @param H
|
|
/// @param S
|
|
/// @param L
|
|
///
|
|
void rgb_to_hsl(int R, int G, int B, unsigned char *H, unsigned char *S, unsigned char *L)
|
|
{
|
|
float r = R/255.f, g = G/255.f, b = B/255.f;
|
|
float h, s, l;
|
|
|
|
float maxrgb = MAX(r, MAX(g, b)), minrgb = MIN(r, MIN(g, b));
|
|
|
|
l = (minrgb + maxrgb) / 2;
|
|
|
|
if (minrgb == maxrgb) {
|
|
h = 0;
|
|
s = 0;
|
|
} else {
|
|
if (l < 0.5) {
|
|
s = (maxrgb - minrgb) / (maxrgb + minrgb);
|
|
} else {
|
|
s = (maxrgb - minrgb) / (2.f - maxrgb - minrgb);
|
|
}
|
|
if (r == maxrgb) {
|
|
h = (g-b) / (maxrgb-minrgb) + 0;
|
|
} else if (g == maxrgb) {
|
|
h = (b-r) / (maxrgb-minrgb) + 2;
|
|
} else { // if b == maxrgb
|
|
h = (r-g) / (maxrgb-minrgb) + 4;
|
|
}
|
|
}
|
|
|
|
if (h < 0) h += 6;
|
|
if (h >= 6) h -= 6;
|
|
|
|
*H = clip_colorval(int(h*256/6));
|
|
*S = clip_colorval(int(s*255));
|
|
*L = clip_colorval(int(l*255));
|
|
}
|
|
|
|
|
|
|
|
/// @brief formulas from http://en.wikipedia.org/wiki/HSV_color_space
|
|
/// @param R
|
|
/// @param G
|
|
/// @param B
|
|
/// @param H
|
|
/// @param S
|
|
/// @param V
|
|
///
|
|
void rgb_to_hsv(int R, int G, int B, unsigned char *H, unsigned char *S, unsigned char *V)
|
|
{
|
|
float r = R/255.f, g = G/255.f, b = B/255.f;
|
|
float h, s, v;
|
|
|
|
float maxrgb = MAX(r, MAX(g, b)), minrgb = MIN(r, MIN(g, b));
|
|
|
|
v = maxrgb;
|
|
|
|
if (maxrgb < .001f) {
|
|
s = 1;
|
|
} else {
|
|
s = (maxrgb - minrgb) / maxrgb;
|
|
}
|
|
|
|
if (minrgb == maxrgb) {
|
|
h = 0;
|
|
} else if (maxrgb == r) {
|
|
h = (g-b) / (maxrgb-minrgb) + 0;
|
|
} else if (maxrgb == g) {
|
|
h = (b-r) / (maxrgb-minrgb) + 2;
|
|
} else { // if maxrgb == b
|
|
h = (r-g) / (maxrgb-minrgb) + 4;
|
|
}
|
|
|
|
if (h < 0) h += 6;
|
|
if (h >= 6) h -= 6;
|
|
|
|
*H = clip_colorval(int(h*256/6));
|
|
*S = clip_colorval(int(s*255));
|
|
*V = clip_colorval(int(v*255));
|
|
}
|
|
|
|
|
|
|
|
/// @brief DOCME
|
|
/// @param iH
|
|
/// @param iS
|
|
/// @param iV
|
|
/// @param oH
|
|
/// @param oS
|
|
/// @param oL
|
|
///
|
|
void hsv_to_hsl(int iH, int iS, int iV, unsigned char *oH, unsigned char *oS, unsigned char *oL)
|
|
{
|
|
int p = iV * (255 - iS);
|
|
*oH = iH;
|
|
*oL = clip_colorval((p + iV*255)/255/2);
|
|
if (*oL == 0) {
|
|
*oS = iS; // oS is actually undefined, so any value should work ;)
|
|
} else if (*oL <= 128) {
|
|
*oS = clip_colorval((iV*255 - p) / (2 * *oL));
|
|
} else {
|
|
*oS = clip_colorval((iV*255 - p) / (511 - 2 * *oL));
|
|
}
|
|
}
|
|
|
|
|
|
|
|
/// @brief DOCME
|
|
/// @param iH
|
|
/// @param iS
|
|
/// @param iL
|
|
/// @param oH
|
|
/// @param oS
|
|
/// @param oV
|
|
/// @return
|
|
///
|
|
void hsl_to_hsv(int iH, int iS, int iL, unsigned char *oH, unsigned char *oS, unsigned char *oV)
|
|
{
|
|
*oH = iH;
|
|
|
|
if (iS == 0) {
|
|
*oS = 0;
|
|
*oV = iL;
|
|
return;
|
|
}
|
|
|
|
if (iL < 128) {
|
|
*oV = iL * (255 + iS) / 255;
|
|
*oS = 2 * 255 * iS / (255 + iS);
|
|
} else {
|
|
*oV = (iL*255 + iS*255 - iL*iS)/255;
|
|
*oS = 2 * 255 * iS * (255 - iL) / (iL*255 + iS*255 - iL*iS);
|
|
}
|
|
}
|
|
|
|
|
|
|
|
/// @brief DOCME
|
|
/// @param color
|
|
/// @return
|
|
///
|
|
wxString color_to_html(wxColour color)
|
|
{
|
|
return wxString::Format(_T("#%02X%02X%02X"), color.Red(), color.Green(), color.Blue());
|
|
}
|
|
|
|
|
|
|
|
/// @brief DOCME
|
|
/// @param html
|
|
///
|
|
wxColour html_to_color(wxString html)
|
|
{
|
|
html.Trim(true);
|
|
html.Trim(false);
|
|
if (html.StartsWith(_T("#"))) {
|
|
html.Remove(0, 1);
|
|
}
|
|
if (html.size() == 6) {
|
|
// 8 bit per channel
|
|
long r, g, b;
|
|
wxString sr, sg, sb;
|
|
sr = html.Mid(0, 2);
|
|
sg = html.Mid(2, 2);
|
|
sb = html.Mid(4, 2);
|
|
if (sr.ToLong(&r, 16) && sg.ToLong(&g, 16) && sb.ToLong(&b, 16)) {
|
|
return wxColour(r, g, b);
|
|
} else {
|
|
return wxColour(*wxBLACK);
|
|
}
|
|
} else if (html.size() == 3) {
|
|
// 4 bit per channel
|
|
long r, g, b;
|
|
wxString sr, sg, sb;
|
|
sr = html.Mid(0, 1);
|
|
sg = html.Mid(1, 1);
|
|
sb = html.Mid(2, 1);
|
|
if (sr.ToLong(&r, 16) && sg.ToLong(&g, 16) && sb.ToLong(&b, 16)) {
|
|
return wxColour(r*16+r, g*16+g, b*16+b);
|
|
} else {
|
|
return wxColour(*wxBLACK);
|
|
}
|
|
} else {
|
|
// only care about valid colors
|
|
return wxColour(*wxBLACK);
|
|
}
|
|
}
|
|
|
|
|
|
|