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 ======================================================= */
40 #include <synfig/string.h>
43 #include <OpenEXR/half.h>
46 #ifndef SYNFIG_NO_ANGLE
50 /* === M A C R O S ========================================================= */
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 inline const String get_string(void)const
120 std::ostringstream o;
121 o << std::fixed << std::setprecision(3) << "#" << get_hex() << " : " << std::setw(6) << a_;
122 return String(o.str().c_str());
126 operator+=(const Color &rhs)
136 operator-=(const Color &rhs)
146 operator*=(const float &rhs)
156 operator/=(const float &rhs)
158 const float temp(value_type(1)/rhs);
167 operator+(const Color &rhs)const
168 { return Color(*this)+=rhs; }
171 operator-(const Color &rhs)const
172 { return Color(*this)-=rhs; }
175 operator*(const float &rhs)const
176 { return Color(*this)*=rhs; }
179 operator/(const float &rhs)const
180 { return Color(*this)/=rhs; }
183 operator==(const Color &rhs)const
184 { return r_==rhs.r_ && g_==rhs.g_ && b_==rhs.b_ && a_==rhs.a_; }
187 operator!=(const Color &rhs)const
188 { return r_!=rhs.r_ || g_!=rhs.g_ || b_!=rhs.b_ || a_!=rhs.a_; }
192 { return Color(-r_,-g_,-b_,-a_); }
194 //! Effectively 1.0-color
197 { return Color(1.0f-r_,1.0f-g_,1.0f-b_,a_); }
200 { return !isnan(r_) && !isnan(g_) && !isnan(b_) && !isnan(a_); }
202 Color premult_alpha() const
204 return Color (r_*a_, g_*a_, b_*a_, a_);
207 Color demult_alpha() const
211 const value_type inva = 1/a_;
212 return Color (r_*inva, g_*inva, b_*inva, a_);
213 }else return alpha();
217 Color() /*:r_(0), g_(0), b_(0), a_(0)*/ { }
218 Color(const value_type &f) :a_(f),r_(f), g_(f), b_(f) { }
219 Color(int f) :a_(f),r_(f), g_(f), b_(f) { }
224 ** \param A Opacity(alpha) */
225 Color(const value_type& R, const value_type& G, const value_type& B, const value_type& A=1):
231 /*! \param c Source for color components
232 ** \param A Opacity(alpha) */
233 Color(const Color& c, const value_type& A):
241 Color(const Color& c):
248 friend class ColorAccumulator;
249 //! Convert constructor
250 Color(const ColorAccumulator& c);
254 //Color(const Color &c) { memcpy((void*)this, (const void*)&c, sizeof(Color)); }
256 /*const Color &operator=(const value_type &i)
258 r_ = g_ = b_ = a_ = i;
261 //Color& operator=(const Color &c) { memcpy((void*)this, (const void*)&c, sizeof(Color)); return *this; }
263 //! Returns the RED component
264 const value_type& get_r()const { return r_; }
266 //! Returns the GREEN component
267 const value_type& get_g()const { return g_; }
269 //! Returns the BLUE component
270 const value_type& get_b()const { return b_; }
272 //! Returns the amount of opacity (alpha)
273 const value_type& get_a()const { return a_; }
275 //! Synonym for get_a(). \see get_a()
276 const value_type& get_alpha()const { return get_a(); }
278 //! Converts a 2 character hex string \a s (00-ff) into a ColorReal (0.0-1.0)
279 static ColorReal hex2real(String s);
281 //! Converts a ColorReal \a c (0.0-1.0) into a 2 character hex string (00-ff)
282 static const String real2hex(ColorReal c);
284 //! Returns the color as a 6 character hex sting
285 const String get_hex()const { return String(real2hex(r_)+real2hex(g_)+real2hex(b_)); }
287 //! Sets the color's R, G, and B from a 3 or 6 character hex string
288 void set_hex(String& hex);
290 //! Sets the RED component to \a x
291 Color& set_r(const value_type& x) { r_ = x; return *this; }
293 //! Sets the GREEN component to \a x
294 Color& set_g(const value_type& x) { g_ = x; return *this; }
296 //! Sets the BLUE component to \a x
297 Color& set_b(const value_type& x) { b_ = x; return *this; }
299 //! Sets the opacity (alpha) to \a x
300 Color& set_a(const value_type& x) { a_ = x; return *this; }
302 //! Synonym for set_a(). \see set_a()
303 Color& set_alpha(const value_type& x) { return set_a(x); }
305 //! Returns color's luminance
310 (float)get_r()*EncodeYUV[0][0]+
311 (float)get_g()*EncodeYUV[0][1]+
312 (float)get_b()*EncodeYUV[0][2];
316 //! Returns U component of chromanance
321 (float)get_r()*EncodeYUV[1][0]+
322 (float)get_g()*EncodeYUV[1][1]+
323 (float)get_b()*EncodeYUV[1][2];
327 //! Returns V component of chromanance
332 (float)get_r()*EncodeYUV[2][0]+
333 (float)get_g()*EncodeYUV[2][1]+
334 (float)get_b()*EncodeYUV[2][2];
337 //! Returns the color's saturation
338 /*! This is is the magnitude of the U and V components.
343 const float u(get_u()), v(get_v());
344 return sqrt(u*u+v*v);
347 //! Sets the luminance (\a y) and chromanance (\a u and \a v)
349 set_yuv(const float &y, const float &u, const float &v)
351 set_r(y*DecodeYUV[0][0]+u*DecodeYUV[0][1]+v*DecodeYUV[0][2]);
352 set_g(y*DecodeYUV[1][0]+u*DecodeYUV[1][1]+v*DecodeYUV[1][2]);
353 set_b(y*DecodeYUV[2][0]+u*DecodeYUV[2][1]+v*DecodeYUV[2][2]);
357 //! Sets color luminance
358 Color& set_y(const float &y) { return set_yuv(y,get_u(),get_v()); }
360 //! Set U component of chromanance
361 Color& set_u(const float &u) { return set_yuv(get_y(),u,get_v()); }
363 //! Set V component of chromanance
364 Color& set_v(const float &v) { return set_yuv(get_y(),get_u(),v); }
366 //! Set the U and V components of chromanance
367 Color& set_uv(const float& u, const float& v) { return set_yuv(get_y(),u,v); }
369 //! Sets the color's saturation
372 set_s(const float &x)
374 float u(get_u()), v(get_v());
375 const float s(sqrt(u*u+v*v));
385 //! YUV Color constructor
386 static Color YUV(const float& y, const float& u, const float& v, const value_type& a=1)
387 { return Color().set_yuv(y,u,v).set_a(a); }
389 #ifndef SYNFIG_NO_ANGLE
390 //! Returns the hue of the chromanance
391 /*! This is the angle of the U and V components.
395 { return Angle::tan(get_u(),get_v()); }
397 //! Synonym for get_hue(). \see get_hue()
398 Angle get_uv_angle() const { return get_hue(); }
400 //! Sets the color's hue
401 /*! \see get_hue() */
403 set_hue(const Angle& theta)
405 const float s(get_s());
407 u(s*(float)Angle::sin(theta).get()),
408 v(s*(float)Angle::cos(theta).get());
412 //! Synonym for set_hue(). \see set_hue()
413 Color& set_uv_angle(const Angle& theta) { return set_hue(theta); }
415 //! Rotates the chromanance vector by amount specified by \a theta
416 Color& rotate_uv(const Angle& theta)
418 const float a(Angle::sin(theta).get()), b(Angle::cos(theta).get());
419 const float u(get_u()), v(get_v());
421 return set_uv(b*u-a*v,a*u+b*v);
424 //! Sets the luminance (\a y) and chromanance (\a s and \a theta).
425 /*! \param y Luminance
426 ** \param s Saturation
427 ** \param theta Hue */
428 Color& set_yuv(const float& y, const float& s, const Angle& theta)
433 s*(float)Angle::sin(theta).get(),
434 s*(float)Angle::cos(theta).get()
438 //! YUV color constructor where the chroma is in the saturation/hue form.
439 /*! \param y Luminance
440 ** \param s Saturation
442 ** \param a Opacity (alpha) */
443 static Color YUV(const float& y, const float& s, const Angle& theta, const value_type& a=1)
444 { return Color().set_yuv(y,s,theta).set_a(a); }
448 //! Clamps a color so that its values are in range. Ignores attempting to visualize negative colors.
449 Color clamped()const;
451 //! Clamps a color so that its values are in range.
452 Color clamped_negative()const;
456 //! Preset Color Constructors
459 static inline Color alpha() { return Color(0,0,0,0.0000001f); }
461 static inline Color alpha() { return Color(0,0,0,0); }
463 static inline Color black() { return Color(0,0,0); }
464 static inline Color white() { return Color(1,1,1); }
465 static inline Color gray() { return Color(0.5f,0.5f,0.5f); }
466 static inline Color magenta() { return Color(1,0,1); }
467 static inline Color red() { return Color(1,0,0); }
468 static inline Color green() { return Color(0,1,0); }
469 static inline Color blue() { return Color(0,0,1); }
470 static inline Color cyan() { return Color(0,1,1); }
471 static inline Color yellow() { return Color(1,1,0); }
477 BLEND_COMPOSITE=0, //!< Color A is composited onto B (Taking A's alpha into account)
478 BLEND_STRAIGHT=1, //!< Straight linear interpolation from A->B (Alpha ignored)
479 BLEND_ONTO=13, //!< Similar to BLEND_COMPOSITE, except that B's alpha is maintained
480 BLEND_STRAIGHT_ONTO=21, //!< <deprecated> \writeme
481 BLEND_BEHIND=12, //!< Similar to BLEND_COMPOSITE, except that B is composited onto A.
482 BLEND_SCREEN=16, //!< \writeme
483 BLEND_OVERLAY=20, //!< \writeme
484 BLEND_HARD_LIGHT=17, //!< \writeme
485 BLEND_MULTIPLY=6, //!< Simple A*B.
486 BLEND_DIVIDE=7, //!< Simple B/A
487 BLEND_ADD=4, //!< Simple A+B.
488 BLEND_SUBTRACT=5, //!< Simple A-B.
489 BLEND_DIFFERENCE=18, //!< Simple |A-B|.
490 BLEND_BRIGHTEN=2, //!< If composite is brighter than B, use composite. B otherwise.
491 BLEND_DARKEN=3, //!< If composite is darker than B, use composite. B otherwise.
492 BLEND_COLOR=8, //!< Preserves the U and V channels of color A
493 BLEND_HUE=9, //!< Preserves the angle of the UV vector of color A
494 BLEND_SATURATION=10, //!< Preserves the magnitude of the UV Vector of color A
495 BLEND_LUMINANCE=11, //!< Preserves the Y channel of color A
497 BLEND_ALPHA_BRIGHTEN=14, //!< <deprecated> If A is less opaque than B, use A
498 BLEND_ALPHA_DARKEN=15, //!< <deprecated> If A is more opaque than B, use B
499 BLEND_ALPHA_OVER=19, //!< <deprecated> multiply alphas and then straight blends using the amount
501 BLEND_END=22 //!< \internal
505 static Color blend(Color a, Color b,float amount,BlendMethod type=BLEND_COMPOSITE);
507 static bool is_onto(BlendMethod x)
509 return x==BLEND_BRIGHTEN
517 || x==BLEND_SATURATION
518 || x==BLEND_LUMINANCE
520 || x==BLEND_STRAIGHT_ONTO
523 || x==BLEND_DIFFERENCE
524 || x==BLEND_HARD_LIGHT
529 value_type& operator[](const int i)
532 assert(i<(signed)(sizeof(Color)/sizeof(value_type)));
536 const value_type& operator[](const int i)const
539 assert(i<(signed)(sizeof(Color)/sizeof(value_type)));
543 }; // END of class Color
545 #ifndef USE_HALF_TYPE
546 typedef Color ColorAccumulator;
548 class ColorAccumulator
552 typedef float value_type;
555 value_type a_, r_, g_, b_;
560 operator+=(const ColorAccumulator &rhs)
570 operator-=(const ColorAccumulator &rhs)
580 operator*=(const float &rhs)
590 operator/=(const float &rhs)
592 const float temp(value_type(1)/rhs);
601 operator+(const ColorAccumulator &rhs)const
602 { return Color(*this)+=rhs; }
605 operator-(const ColorAccumulator &rhs)const
606 { return Color(*this)-=rhs; }
609 operator*(const float &rhs)const
610 { return Color(*this)*=rhs; }
613 operator/(const float &rhs)const
614 { return Color(*this)/=rhs; }
617 operator==(const ColorAccumulator &rhs)const
618 { return r_==rhs.r_ && g_==rhs.g_ && b_==rhs.b_ && a_!=rhs.a_; }
621 operator!=(const ColorAccumulator &rhs)const
622 { return r_!=rhs.r_ || g_!=rhs.g_ || b_!=rhs.b_ || a_!=rhs.a_; }
626 { return ColorAccumulator(-r_,-g_,-b_,-a_); }
629 { return !isnan(r_) && !isnan(g_) && !isnan(b_) && !isnan(a_); }
632 ColorAccumulator() { }
637 ** \param A Opacity(alpha) */
638 ColorAccumulator(const value_type& R, const value_type& G, const value_type& B, const value_type& A=1):
645 ColorAccumulator(const ColorAccumulator& c):
652 ColorAccumulator(const Color& c):
659 ColorAccumulator(int c): a_(c),r_(c), g_(c), b_(c) { }
661 //! Returns the RED component
662 const value_type& get_r()const { return r_; }
664 //! Returns the GREEN component
665 const value_type& get_g()const { return g_; }
667 //! Returns the BLUE component
668 const value_type& get_b()const { return b_; }
670 //! Returns the amount of opacity (alpha)
671 const value_type& get_a()const { return a_; }
673 //! Synonym for get_a(). \see get_a()
674 const value_type& get_alpha()const { return get_a(); }
676 //! Sets the RED component to \a x
677 ColorAccumulator& set_r(const value_type& x) { r_ = x; return *this; }
679 //! Sets the GREEN component to \a x
680 ColorAccumulator& set_g(const value_type& x) { g_ = x; return *this; }
682 //! Sets the BLUE component to \a x
683 ColorAccumulator& set_b(const value_type& x) { b_ = x; return *this; }
685 //! Sets the opacity (alpha) to \a x
686 ColorAccumulator& set_a(const value_type& x) { a_ = x; return *this; }
688 //! Synonym for set_a(). \see set_a()
689 ColorAccumulator& set_alpha(const value_type& x) { return set_a(x); }
693 Color::Color(const ColorAccumulator& c):
707 /* Bit Descriptions (ON/OFF)
708 ** ----+-------------
709 ** 0 Color Channels (Gray/RGB)
710 ** 1 Alpha Channel (WITH/WITHOUT)
711 ** 2 ZDepth (WITH/WITHOUT)
712 ** 3 Endian (BGR/RGB)
713 ** 4 Alpha Location (Start/End)
714 ** 5 ZDepth Location (Start/End)
715 ** 6 Alpha/ZDepth Arangement (ZA,AZ)
716 ** 7 Alpha Range (Inverted,Normal)
717 ** 8 Z Range (Inverted,Normal)
720 PF_GRAY=(1<<0), //!< If set, use one grayscale channel. If clear, use three channels for RGB
721 PF_A=(1<<1), //!< If set, include alpha channel
722 PF_Z=(1<<2), //!< If set, include ZDepth channel
723 PF_BGR=(1<<3), //!< If set, reverse the order of the RGB channels
724 PF_A_START=(1<<4), //!< If set, alpha channel is before the color data. If clear, it is after.
725 PF_Z_START=(1<<5), //!< If set, ZDepth channel is before the color data. If clear, it is after.
726 PF_ZA=(1<<6), //!< If set, the ZDepth channel will be infront of the alpha channel. If clear, they are reversed.
728 PF_A_INV=(1<<7), //!< If set, the alpha channel is stored as 1.0-a
729 PF_Z_INV=(1<<8), //!< If set, the ZDepth channel is stored as 1.0-z
730 PF_RAW_COLOR=(1<<9)+(1<<1) //!< If set, the data represents a raw Color datastructure, and all other bits are ignored.
733 inline PixelFormat operator|(PixelFormat lhs, PixelFormat rhs)
734 { return static_cast<PixelFormat>((int)lhs|(int)rhs); }
736 inline PixelFormat operator&(PixelFormat lhs, PixelFormat rhs)
737 { return static_cast<PixelFormat>((int)lhs&(int)rhs); }
738 #define FLAGS(x,y) (((x)&(y))==(y))
740 //! Returns the number of channels that the given PixelFormat calls for
742 channels(PixelFormat x)
753 if(FLAGS(x,PF_RAW_COLOR))
759 inline unsigned char *
760 Color2PixelFormat(const Color &color, const PixelFormat &pf, unsigned char *out, const Gamma &gamma)
762 if(FLAGS(pf,PF_RAW_COLOR))
764 Color *outcol=reinterpret_cast<Color *>(out);
770 int alpha=(int)((FLAGS(pf,PF_A_INV)?(-(float)color.get_a()+1):(float)color.get_a())*255);
772 if(alpha>255)alpha=255;
774 if(FLAGS(pf,PF_ZA|PF_A_START|PF_Z_START))
776 if(FLAGS(pf,PF_Z_START))
777 *out++/*=(unsigned char)(color.GetZ()*255.0f)*/;
778 if(FLAGS(pf,PF_A_START))
779 *out++=static_cast<unsigned char>(alpha);
783 if(FLAGS(pf,PF_A_START))
784 *out++=static_cast<unsigned char>(alpha);
785 if(FLAGS(pf,PF_Z_START))
786 *out++/*=(unsigned char)(color.GetZ()*255.0f)*/;
790 if(FLAGS(pf,PF_GRAY))
791 *out++=static_cast<unsigned char>(gamma.g_F32_to_U8(color.get_y()));
796 *out++=static_cast<unsigned char>(gamma.r_F32_to_U8(color.get_b()));
797 *out++=static_cast<unsigned char>(gamma.g_F32_to_U8(color.get_g()));
798 *out++=static_cast<unsigned char>(gamma.b_F32_to_U8(color.get_r()));
802 *out++=static_cast<unsigned char>(gamma.r_F32_to_U8(color.get_r()));
803 *out++=static_cast<unsigned char>(gamma.g_F32_to_U8(color.get_g()));
804 *out++=static_cast<unsigned char>(gamma.b_F32_to_U8(color.get_b()));
810 if(!FLAGS(pf,PF_Z_START) && FLAGS(pf,PF_Z))
811 out++;//*out++=(unsigned char)(color.GetZ()*255.0f);
812 if(!FLAGS(pf,PF_A_START) && FLAGS(pf,PF_A))
813 *out++=static_cast<unsigned char>(alpha);
817 if(!FLAGS(pf,PF_Z_START) && FLAGS(pf,PF_Z))
818 out++;//*out++=(unsigned char)(color.GetZ()*255.0f);
819 if(!FLAGS(pf,PF_A_START) && FLAGS(pf,PF_A))
820 *out++=static_cast<unsigned char>(alpha);
826 convert_color_format(unsigned char *dest, const Color *src, int w, PixelFormat pf,const Gamma &gamma)
830 dest=Color2PixelFormat((*(src++)).clamped(),pf,dest,gamma);
833 inline const unsigned char *
834 PixelFormat2Color(Color &color, const PixelFormat &pf,const unsigned char *out)
836 if(FLAGS(pf,PF_ZA|PF_A_START|PF_Z_START))
838 if(FLAGS(pf,PF_Z_START))
839 out++;//color.SetZ((Color::value_type)*out++/255.0f);
840 if(FLAGS(pf,PF_A_START))
841 color.set_a((float)*out++/255);
845 if(FLAGS(pf,PF_A_START))
846 color.set_a((float)*out++/255);
847 if(FLAGS(pf,PF_Z_START))
848 out++;//color.SetZ((Color::value_type)*out++/255.0f);
851 if(FLAGS(pf,PF_GRAY))
852 color.set_yuv((float)*out++/255,0,0);
857 color.set_b((float)*out++/255);
858 color.set_g((float)*out++/255);
859 color.set_r((float)*out++/255);
863 color.set_r((float)*out++/255);
864 color.set_g((float)*out++/255);
865 color.set_b((float)*out++/255);
871 if(!FLAGS(pf,PF_Z_START) && FLAGS(pf,PF_Z))
872 out++;//color.SetZ((Color::value_type)*out++/255.0f);
873 if(!FLAGS(pf,PF_A_START) && FLAGS(pf,PF_A))
874 color.set_a((float)*out++/255);
878 if(!FLAGS(pf,PF_A_START) && FLAGS(pf,PF_A))
879 color.set_a((float)*out++/255);
880 if(!FLAGS(pf,PF_Z_START) && FLAGS(pf,PF_Z))
881 out++;//color.SetZ((Color::value_type)*out++/255.0f);
888 }; // END of namespace synfig
890 /* === E N D =============================================================== */