1 /* === S Y N F I G ========================================================= */
3 ** \brief Color Class Implementation
8 ** Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
10 ** This package is free software; you can redistribute it and/or
11 ** modify it under the terms of the GNU General Public License as
12 ** published by the Free Software Foundation; either version 2 of
13 ** the License, or (at your option) any later version.
15 ** This package 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 GNU
18 ** General Public License for more details.
21 /* ========================================================================= */
23 /* === S T A R T =========================================================== */
25 #ifndef __SYNFIG_COLOR_H
26 #define __SYNFIG_COLOR_H
28 /* === H E A D E R S ======================================================= */
35 #include <synfig/string.h>
38 #include <OpenEXR/half.h>
41 #ifndef SYNFIG_NO_ANGLE
45 /* === M A C R O S ========================================================= */
47 #define use_colorspace_gamma() App::use_colorspace_gamma
48 #define colorspace_gamma() (2.2f)
49 #define gamma_in(x) ((x>=0)?pow((float)x,1.0f/colorspace_gamma()):-pow((float)-x,1.0f/colorspace_gamma()))
50 #define gamma_out(x) ((x>=0)?pow((float)x,colorspace_gamma()):-pow((float)-x,colorspace_gamma()))
55 extern "C" { int _isnan(double x); }
60 // For some reason isnan() isn't working on macosx any more.
61 // This is a quick fix.
62 #if defined(__APPLE__) && !defined(SYNFIG_ISNAN_FIX)
66 inline bool isnan(double x) { return x != x; }
67 inline bool isnan(float x) { return x != x; }
68 #define SYNFIG_ISNAN_FIX 1
74 typedef half ColorReal;
76 typedef float ColorReal;
79 static const float EncodeYUV[3][3]=
81 { 0.299f, 0.587f, 0.114f },
82 { -0.168736f, -0.331264f, 0.5f },
83 { 0.5f, -0.418688f, -0.081312f }
86 static const float DecodeYUV[3][3]=
88 { 1.0f, 0.0f, 1.402f },
89 { 1.0f, -0.344136f, -0.714136f },
90 { 1.0f, 1.772f, 0.0f }
93 /* === T Y P E D E F S ===================================================== */
95 /* === C L A S S E S & S T R U C T S ======================================= */
98 class ColorAccumulator;
106 ** Future optimizations: lookup table for sqrt()?
111 typedef ColorReal value_type;
114 value_type a_, r_, g_, b_;
118 const String get_string(void)const;
121 operator+=(const Color &rhs)
131 operator-=(const Color &rhs)
141 operator*=(const float &rhs)
151 operator/=(const float &rhs)
153 const float temp(value_type(1)/rhs);
162 operator+(const Color &rhs)const
163 { return Color(*this)+=rhs; }
166 operator-(const Color &rhs)const
167 { return Color(*this)-=rhs; }
170 operator*(const float &rhs)const
171 { return Color(*this)*=rhs; }
174 operator/(const float &rhs)const
175 { return Color(*this)/=rhs; }
178 operator==(const Color &rhs)const
179 { return r_==rhs.r_ && g_==rhs.g_ && b_==rhs.b_ && a_==rhs.a_; }
182 operator!=(const Color &rhs)const
183 { return r_!=rhs.r_ || g_!=rhs.g_ || b_!=rhs.b_ || a_!=rhs.a_; }
187 { return Color(-r_,-g_,-b_,-a_); }
189 //! Effectively 1.0-color
192 { return Color(1.0f-r_,1.0f-g_,1.0f-b_,a_); }
195 { return !isnan(r_) && !isnan(g_) && !isnan(b_) && !isnan(a_); }
197 Color premult_alpha() const
199 return Color (r_*a_, g_*a_, b_*a_, a_);
202 Color demult_alpha() const
206 const value_type inva = 1/a_;
207 return Color (r_*inva, g_*inva, b_*inva, a_);
208 }else return alpha();
212 Color() /*:r_(0), g_(0), b_(0), a_(0)*/ { }
213 Color(const value_type &f) :a_(f),r_(f), g_(f), b_(f) { }
214 Color(int f) :a_(f),r_(f), g_(f), b_(f) { }
219 ** \param A Opacity(alpha) */
220 Color(const value_type& R, const value_type& G, const value_type& B, const value_type& A=1):
226 /*! \param c Source for color components
227 ** \param A Opacity(alpha) */
228 Color(const Color& c, const value_type& A):
236 Color(const Color& c):
243 friend class ColorAccumulator;
244 //! Convert constructor
245 Color(const ColorAccumulator& c);
249 //Color(const Color &c) { memcpy((void*)this, (const void*)&c, sizeof(Color)); }
251 /*const Color &operator=(const value_type &i)
253 r_ = g_ = b_ = a_ = i;
256 //Color& operator=(const Color &c) { memcpy((void*)this, (const void*)&c, sizeof(Color)); return *this; }
258 //! Returns the RED component
259 const value_type& get_r()const { return r_; }
261 //! Returns the GREEN component
262 const value_type& get_g()const { return g_; }
264 //! Returns the BLUE component
265 const value_type& get_b()const { return b_; }
267 //! Returns the amount of opacity (alpha)
268 const value_type& get_a()const { return a_; }
270 //! Synonym for get_a(). \see get_a()
271 const value_type& get_alpha()const { return get_a(); }
273 //! Converts a 2 character hex string \a s (00-ff) into a ColorReal (0.0-1.0)
274 static ColorReal hex2real(String s);
276 //! Converts a ColorReal \a c (0.0-1.0) into a 2 character hex string (00-ff)
277 static const String real2hex(ColorReal c);
279 //! Returns the color as a 6 character hex sting
280 const String get_hex()const { return String(real2hex(r_)+real2hex(g_)+real2hex(b_)); }
282 //! Sets the color's R, G, and B from a 3 or 6 character hex string
283 void set_hex(String& hex);
285 //! Sets the RED component to \a x
286 Color& set_r(const value_type& x) { r_ = x; return *this; }
288 //! Sets the GREEN component to \a x
289 Color& set_g(const value_type& x) { g_ = x; return *this; }
291 //! Sets the BLUE component to \a x
292 Color& set_b(const value_type& x) { b_ = x; return *this; }
294 //! Sets the opacity (alpha) to \a x
295 Color& set_a(const value_type& x) { a_ = x; return *this; }
297 //! Synonym for set_a(). \see set_a()
298 Color& set_alpha(const value_type& x) { return set_a(x); }
300 //! Returns color's luminance
305 (float)get_r()*EncodeYUV[0][0]+
306 (float)get_g()*EncodeYUV[0][1]+
307 (float)get_b()*EncodeYUV[0][2];
311 //! Returns U component of chromanance
316 (float)get_r()*EncodeYUV[1][0]+
317 (float)get_g()*EncodeYUV[1][1]+
318 (float)get_b()*EncodeYUV[1][2];
322 //! Returns V component of chromanance
327 (float)get_r()*EncodeYUV[2][0]+
328 (float)get_g()*EncodeYUV[2][1]+
329 (float)get_b()*EncodeYUV[2][2];
332 //! Returns the color's saturation
333 /*! This is is the magnitude of the U and V components.
338 const float u(get_u()), v(get_v());
339 return sqrt(u*u+v*v);
342 //! Sets the luminance (\a y) and chromanance (\a u and \a v)
344 set_yuv(const float &y, const float &u, const float &v)
346 set_r(y*DecodeYUV[0][0]+u*DecodeYUV[0][1]+v*DecodeYUV[0][2]);
347 set_g(y*DecodeYUV[1][0]+u*DecodeYUV[1][1]+v*DecodeYUV[1][2]);
348 set_b(y*DecodeYUV[2][0]+u*DecodeYUV[2][1]+v*DecodeYUV[2][2]);
352 //! Sets color luminance
353 Color& set_y(const float &y) { return set_yuv(y,get_u(),get_v()); }
355 //! Set U component of chromanance
356 Color& set_u(const float &u) { return set_yuv(get_y(),u,get_v()); }
358 //! Set V component of chromanance
359 Color& set_v(const float &v) { return set_yuv(get_y(),get_u(),v); }
361 //! Set the U and V components of chromanance
362 Color& set_uv(const float& u, const float& v) { return set_yuv(get_y(),u,v); }
364 //! Sets the color's saturation
367 set_s(const float &x)
369 float u(get_u()), v(get_v());
370 const float s(sqrt(u*u+v*v));
380 //! YUV Color constructor
381 static Color YUV(const float& y, const float& u, const float& v, const value_type& a=1)
382 { return Color().set_yuv(y,u,v).set_a(a); }
384 #ifndef SYNFIG_NO_ANGLE
385 //! Returns the hue of the chromanance
386 /*! This is the angle of the U and V components.
390 { return Angle::tan(get_u(),get_v()); }
392 //! Synonym for get_hue(). \see get_hue()
393 Angle get_uv_angle() const { return get_hue(); }
395 //! Sets the color's hue
396 /*! \see get_hue() */
398 set_hue(const Angle& theta)
400 const float s(get_s());
402 u(s*(float)Angle::sin(theta).get()),
403 v(s*(float)Angle::cos(theta).get());
407 //! Synonym for set_hue(). \see set_hue()
408 Color& set_uv_angle(const Angle& theta) { return set_hue(theta); }
410 //! Rotates the chromanance vector by amount specified by \a theta
411 Color& rotate_uv(const Angle& theta)
413 const float a(Angle::sin(theta).get()), b(Angle::cos(theta).get());
414 const float u(get_u()), v(get_v());
416 return set_uv(b*u-a*v,a*u+b*v);
419 //! Sets the luminance (\a y) and chromanance (\a s and \a theta).
420 /*! \param y Luminance
421 ** \param s Saturation
422 ** \param theta Hue */
423 Color& set_yuv(const float& y, const float& s, const Angle& theta)
428 s*(float)Angle::sin(theta).get(),
429 s*(float)Angle::cos(theta).get()
433 //! YUV color constructor where the chroma is in the saturation/hue form.
434 /*! \param y Luminance
435 ** \param s Saturation
437 ** \param a Opacity (alpha) */
438 static Color YUV(const float& y, const float& s, const Angle& theta, const value_type& a=1)
439 { return Color().set_yuv(y,s,theta).set_a(a); }
443 //! Clamps a color so that its values are in range. Ignores attempting to visualize negative colors.
444 Color clamped()const;
446 //! Clamps a color so that its values are in range.
447 Color clamped_negative()const;
451 //! Preset Color Constructors
454 static inline Color alpha() { return Color(0,0,0,0.0000001f); }
456 static inline Color alpha() { return Color(0,0,0,0); }
458 static inline Color black() { return Color(0,0,0); }
459 static inline Color white() { return Color(1,1,1); }
460 static inline Color gray() { return Color(0.5f,0.5f,0.5f); }
461 static inline Color magenta() { return Color(1,0,1); }
462 static inline Color red() { return Color(1,0,0); }
463 static inline Color green() { return Color(0,1,0); }
464 static inline Color blue() { return Color(0,0,1); }
465 static inline Color cyan() { return Color(0,1,1); }
466 static inline Color yellow() { return Color(1,1,0); }
472 BLEND_COMPOSITE=0, //!< Color A is composited onto B (Taking A's alpha into account)
473 BLEND_STRAIGHT=1, //!< Straight linear interpolation from A->B (Alpha ignored)
474 BLEND_ONTO=13, //!< Similar to BLEND_COMPOSITE, except that B's alpha is maintained
475 BLEND_STRAIGHT_ONTO=21, //!< <deprecated> \writeme
476 BLEND_BEHIND=12, //!< Similar to BLEND_COMPOSITE, except that B is composited onto A.
477 BLEND_SCREEN=16, //!< \writeme
478 BLEND_OVERLAY=20, //!< \writeme
479 BLEND_HARD_LIGHT=17, //!< \writeme
480 BLEND_MULTIPLY=6, //!< Simple A*B.
481 BLEND_DIVIDE=7, //!< Simple B/A
482 BLEND_ADD=4, //!< Simple A+B.
483 BLEND_SUBTRACT=5, //!< Simple A-B.
484 BLEND_DIFFERENCE=18, //!< Simple |A-B|.
485 BLEND_BRIGHTEN=2, //!< If composite is brighter than B, use composite. B otherwise.
486 BLEND_DARKEN=3, //!< If composite is darker than B, use composite. B otherwise.
487 BLEND_COLOR=8, //!< Preserves the U and V channels of color A
488 BLEND_HUE=9, //!< Preserves the angle of the UV vector of color A
489 BLEND_SATURATION=10, //!< Preserves the magnitude of the UV Vector of color A
490 BLEND_LUMINANCE=11, //!< Preserves the Y channel of color A
492 BLEND_ALPHA_BRIGHTEN=14, //!< <deprecated> If A is less opaque than B, use A
493 BLEND_ALPHA_DARKEN=15, //!< <deprecated> If A is more opaque than B, use B
494 BLEND_ALPHA_OVER=19, //!< <deprecated> multiply alphas and then straight blends using the amount
496 BLEND_END=22 //!< \internal
500 static Color blend(Color a, Color b,float amount,BlendMethod type=BLEND_COMPOSITE);
502 static bool is_onto(BlendMethod x)
504 return x==BLEND_BRIGHTEN
512 || x==BLEND_SATURATION
513 || x==BLEND_LUMINANCE
515 || x==BLEND_STRAIGHT_ONTO
518 || x==BLEND_DIFFERENCE
519 || x==BLEND_HARD_LIGHT
524 value_type& operator[](const int i)
527 assert(i<(signed)(sizeof(Color)/sizeof(value_type)));
531 const value_type& operator[](const int i)const
534 assert(i<(signed)(sizeof(Color)/sizeof(value_type)));
538 }; // END of class Color
540 #ifndef USE_HALF_TYPE
541 typedef Color ColorAccumulator;
543 class ColorAccumulator
547 typedef float value_type;
550 value_type a_, r_, g_, b_;
555 operator+=(const ColorAccumulator &rhs)
565 operator-=(const ColorAccumulator &rhs)
575 operator*=(const float &rhs)
585 operator/=(const float &rhs)
587 const float temp(value_type(1)/rhs);
596 operator+(const ColorAccumulator &rhs)const
597 { return Color(*this)+=rhs; }
600 operator-(const ColorAccumulator &rhs)const
601 { return Color(*this)-=rhs; }
604 operator*(const float &rhs)const
605 { return Color(*this)*=rhs; }
608 operator/(const float &rhs)const
609 { return Color(*this)/=rhs; }
612 operator==(const ColorAccumulator &rhs)const
613 { return r_==rhs.r_ && g_==rhs.g_ && b_==rhs.b_ && a_!=rhs.a_; }
616 operator!=(const ColorAccumulator &rhs)const
617 { return r_!=rhs.r_ || g_!=rhs.g_ || b_!=rhs.b_ || a_!=rhs.a_; }
621 { return ColorAccumulator(-r_,-g_,-b_,-a_); }
624 { return !isnan(r_) && !isnan(g_) && !isnan(b_) && !isnan(a_); }
627 ColorAccumulator() { }
632 ** \param A Opacity(alpha) */
633 ColorAccumulator(const value_type& R, const value_type& G, const value_type& B, const value_type& A=1):
640 ColorAccumulator(const ColorAccumulator& c):
647 ColorAccumulator(const Color& c):
654 ColorAccumulator(int c): a_(c),r_(c), g_(c), b_(c) { }
656 //! Returns the RED component
657 const value_type& get_r()const { return r_; }
659 //! Returns the GREEN component
660 const value_type& get_g()const { return g_; }
662 //! Returns the BLUE component
663 const value_type& get_b()const { return b_; }
665 //! Returns the amount of opacity (alpha)
666 const value_type& get_a()const { return a_; }
668 //! Synonym for get_a(). \see get_a()
669 const value_type& get_alpha()const { return get_a(); }
671 //! Sets the RED component to \a x
672 ColorAccumulator& set_r(const value_type& x) { r_ = x; return *this; }
674 //! Sets the GREEN component to \a x
675 ColorAccumulator& set_g(const value_type& x) { g_ = x; return *this; }
677 //! Sets the BLUE component to \a x
678 ColorAccumulator& set_b(const value_type& x) { b_ = x; return *this; }
680 //! Sets the opacity (alpha) to \a x
681 ColorAccumulator& set_a(const value_type& x) { a_ = x; return *this; }
683 //! Synonym for set_a(). \see set_a()
684 ColorAccumulator& set_alpha(const value_type& x) { return set_a(x); }
688 Color::Color(const ColorAccumulator& c):
702 /* Bit Descriptions (ON/OFF)
703 ** ----+-------------
704 ** 0 Color Channels (Gray/RGB)
705 ** 1 Alpha Channel (WITH/WITHOUT)
706 ** 2 ZDepth (WITH/WITHOUT)
707 ** 3 Endian (BGR/RGB)
708 ** 4 Alpha Location (Start/End)
709 ** 5 ZDepth Location (Start/End)
710 ** 6 Alpha/ZDepth Arangement (ZA,AZ)
711 ** 7 Alpha Range (Inverted,Normal)
712 ** 8 Z Range (Inverted,Normal)
715 PF_GRAY=(1<<0), //!< If set, use one grayscale channel. If clear, use three channels for RGB
716 PF_A=(1<<1), //!< If set, include alpha channel
717 PF_Z=(1<<2), //!< If set, include ZDepth channel
718 PF_BGR=(1<<3), //!< If set, reverse the order of the RGB channels
719 PF_A_START=(1<<4), //!< If set, alpha channel is before the color data. If clear, it is after.
720 PF_Z_START=(1<<5), //!< If set, ZDepth channel is before the color data. If clear, it is after.
721 PF_ZA=(1<<6), //!< If set, the ZDepth channel will be infront of the alpha channel. If clear, they are reversed.
723 PF_A_INV=(1<<7), //!< If set, the alpha channel is stored as 1.0-a
724 PF_Z_INV=(1<<8), //!< If set, the ZDepth channel is stored as 1.0-z
725 PF_RAW_COLOR=(1<<9)+(1<<1) //!< If set, the data represents a raw Color datastructure, and all other bits are ignored.
728 inline PixelFormat operator|(PixelFormat lhs, PixelFormat rhs)
729 { return static_cast<PixelFormat>((int)lhs|(int)rhs); }
731 inline PixelFormat operator&(PixelFormat lhs, PixelFormat rhs)
732 { return static_cast<PixelFormat>((int)lhs&(int)rhs); }
733 #define FLAGS(x,y) (((x)&(y))==(y))
735 //! Returns the number of channels that the given PixelFormat calls for
737 channels(PixelFormat x)
748 if(FLAGS(x,PF_RAW_COLOR))
754 inline unsigned char *
755 Color2PixelFormat(const Color &color, const PixelFormat &pf, unsigned char *out, const Gamma &gamma)
757 if(FLAGS(pf,PF_RAW_COLOR))
759 Color *outcol=reinterpret_cast<Color *>(out);
765 int alpha=(int)((FLAGS(pf,PF_A_INV)?(-(float)color.get_a()+1):(float)color.get_a())*255);
767 if(alpha>255)alpha=255;
769 if(FLAGS(pf,PF_ZA|PF_A_START|PF_Z_START))
771 if(FLAGS(pf,PF_Z_START))
772 *out++/*=(unsigned char)(color.GetZ()*255.0f)*/;
773 if(FLAGS(pf,PF_A_START))
774 *out++=static_cast<unsigned char>(alpha);
778 if(FLAGS(pf,PF_A_START))
779 *out++=static_cast<unsigned char>(alpha);
780 if(FLAGS(pf,PF_Z_START))
781 *out++/*=(unsigned char)(color.GetZ()*255.0f)*/;
785 if(FLAGS(pf,PF_GRAY))
786 *out++=static_cast<unsigned char>(gamma.g_F32_to_U8(color.get_y()));
791 *out++=static_cast<unsigned char>(gamma.r_F32_to_U8(color.get_b()));
792 *out++=static_cast<unsigned char>(gamma.g_F32_to_U8(color.get_g()));
793 *out++=static_cast<unsigned char>(gamma.b_F32_to_U8(color.get_r()));
797 *out++=static_cast<unsigned char>(gamma.r_F32_to_U8(color.get_r()));
798 *out++=static_cast<unsigned char>(gamma.g_F32_to_U8(color.get_g()));
799 *out++=static_cast<unsigned char>(gamma.b_F32_to_U8(color.get_b()));
805 if(!FLAGS(pf,PF_Z_START) && FLAGS(pf,PF_Z))
806 out++;//*out++=(unsigned char)(color.GetZ()*255.0f);
807 if(!FLAGS(pf,PF_A_START) && FLAGS(pf,PF_A))
808 *out++=static_cast<unsigned char>(alpha);
812 if(!FLAGS(pf,PF_Z_START) && FLAGS(pf,PF_Z))
813 out++;//*out++=(unsigned char)(color.GetZ()*255.0f);
814 if(!FLAGS(pf,PF_A_START) && FLAGS(pf,PF_A))
815 *out++=static_cast<unsigned char>(alpha);
821 convert_color_format(unsigned char *dest, const Color *src, int w, PixelFormat pf,const Gamma &gamma)
825 dest=Color2PixelFormat((*(src++)).clamped(),pf,dest,gamma);
828 inline const unsigned char *
829 PixelFormat2Color(Color &color, const PixelFormat &pf,const unsigned char *out)
831 if(FLAGS(pf,PF_ZA|PF_A_START|PF_Z_START))
833 if(FLAGS(pf,PF_Z_START))
834 out++;//color.SetZ((Color::value_type)*out++/255.0f);
835 if(FLAGS(pf,PF_A_START))
836 color.set_a((float)*out++/255);
840 if(FLAGS(pf,PF_A_START))
841 color.set_a((float)*out++/255);
842 if(FLAGS(pf,PF_Z_START))
843 out++;//color.SetZ((Color::value_type)*out++/255.0f);
846 if(FLAGS(pf,PF_GRAY))
847 color.set_yuv((float)*out++/255,0,0);
852 color.set_b((float)*out++/255);
853 color.set_g((float)*out++/255);
854 color.set_r((float)*out++/255);
858 color.set_r((float)*out++/255);
859 color.set_g((float)*out++/255);
860 color.set_b((float)*out++/255);
866 if(!FLAGS(pf,PF_Z_START) && FLAGS(pf,PF_Z))
867 out++;//color.SetZ((Color::value_type)*out++/255.0f);
868 if(!FLAGS(pf,PF_A_START) && FLAGS(pf,PF_A))
869 color.set_a((float)*out++/255);
873 if(!FLAGS(pf,PF_A_START) && FLAGS(pf,PF_A))
874 color.set_a((float)*out++/255);
875 if(!FLAGS(pf,PF_Z_START) && FLAGS(pf,PF_Z))
876 out++;//color.SetZ((Color::value_type)*out++/255.0f);
883 }; // END of namespace synfig
885 /* === E N D =============================================================== */