1 /* === S Y N F I G ========================================================= */
3 ** \brief Color Class Implementation
5 ** $Id: color.h,v 1.1.1.1 2005/01/04 01:23:14 darco Exp $
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 ======================================================= */
30 #ifndef SYNFIG_NO_ANGLE
41 #include <OpenEXR/half.h>
44 /* === M A C R O S ========================================================= */
51 extern "C" { int _isnan(double x); }
57 #define isnan __isnanf
65 typedef half ColorReal;
67 typedef float ColorReal;
70 static const float EncodeYUV[3][3]=
72 { 0.299f, 0.587f, 0.114f },
73 { -0.168736f, -0.331264f, 0.5f },
74 { 0.5f, -0.418688f, -0.081312f }
77 static const float DecodeYUV[3][3]=
79 { 1.0f, 0.0f, 1.402f },
80 { 1.0f, -0.344136f, -0.714136f },
81 { 1.0f, 1.772f, 0.0f }
84 /* === T Y P E D E F S ===================================================== */
86 /* === C L A S S E S & S T R U C T S ======================================= */
89 class ColorAccumulator;
97 ** Future optimizations: lookup table for sqrt()?
102 typedef ColorReal value_type;
105 value_type a_, r_, g_, b_;
110 operator+=(const Color &rhs)
120 operator-=(const Color &rhs)
130 operator*=(const float &rhs)
140 operator/=(const float &rhs)
142 const float temp(value_type(1)/rhs);
151 operator+(const Color &rhs)const
152 { return Color(*this)+=rhs; }
155 operator-(const Color &rhs)const
156 { return Color(*this)-=rhs; }
159 operator*(const float &rhs)const
160 { return Color(*this)*=rhs; }
163 operator/(const float &rhs)const
164 { return Color(*this)/=rhs; }
167 operator==(const Color &rhs)const
168 { return r_==rhs.r_ && g_==rhs.g_ && b_==rhs.b_ && a_==rhs.a_; }
171 operator!=(const Color &rhs)const
172 { return r_!=rhs.r_ || g_!=rhs.g_ || b_!=rhs.b_ || a_!=rhs.a_; }
176 { return Color(-r_,-g_,-b_,-a_); }
178 //! Effectively 1.0-color
181 { return Color(1.0f-r_,1.0f-g_,1.0f-b_,a_); }
184 { return !isnan(r_) && !isnan(g_) && !isnan(b_) && !isnan(a_); }
186 Color premult_alpha() const
188 return Color (r_*a_, g_*a_, b_*a_, a_);
191 Color demult_alpha() const
195 const value_type inva = 1/a_;
196 return Color (r_*inva, g_*inva, b_*inva, a_);
197 }else return alpha();
201 Color() /*:r_(0), g_(0), b_(0), a_(0)*/ { }
202 Color(const value_type &f) :a_(f),r_(f), g_(f), b_(f) { }
203 Color(int f) :a_(f),r_(f), g_(f), b_(f) { }
208 ** \param A Opacity(alpha) */
209 Color(const value_type& R, const value_type& G, const value_type& B, const value_type& A=1):
215 /*! \param C Source for color components
216 ** \param A Opacity(alpha) */
217 Color(const Color& c, const value_type& A):
225 Color(const Color& c):
232 friend class ColorAccumulator;
233 //! Convert constructor
234 Color(const ColorAccumulator& c);
238 //Color(const Color &c) { memcpy((void*)this, (const void*)&c, sizeof(Color)); }
240 /*const Color &operator=(const value_type &i)
242 r_ = g_ = b_ = a_ = i;
245 //Color& operator=(const Color &c) { memcpy((void*)this, (const void*)&c, sizeof(Color)); return *this; }
247 //! Returns the RED component
248 const value_type& get_r()const { return r_; }
250 //! Returns the GREEN component
251 const value_type& get_g()const { return g_; }
253 //! Returns the BLUE component
254 const value_type& get_b()const { return b_; }
256 //! Returns the amount of opacity (alpha)
257 const value_type& get_a()const { return a_; }
259 //! Synonym for get_a(). \see get_a()
260 const value_type& get_alpha()const { return get_a(); }
262 //! Sets the RED component to \a x
263 Color& set_r(const value_type& x) { r_ = x; return *this; }
265 //! Sets the GREEN component to \a x
266 Color& set_g(const value_type& x) { g_ = x; return *this; }
268 //! Sets the BLUE component to \a x
269 Color& set_b(const value_type& x) { b_ = x; return *this; }
271 //! Sets the opacity (alpha) to \a x
272 Color& set_a(const value_type& x) { a_ = x; return *this; }
274 //! Synonym for set_a(). \see set_a()
275 Color& set_alpha(const value_type& x) { return set_a(x); }
277 //! Returns color's luminance
282 (float)get_r()*EncodeYUV[0][0]+
283 (float)get_g()*EncodeYUV[0][1]+
284 (float)get_b()*EncodeYUV[0][2];
288 //! Returns U component of chromanance
293 (float)get_r()*EncodeYUV[1][0]+
294 (float)get_g()*EncodeYUV[1][1]+
295 (float)get_b()*EncodeYUV[1][2];
299 //! Returns V component of chromanance
304 (float)get_r()*EncodeYUV[2][0]+
305 (float)get_g()*EncodeYUV[2][1]+
306 (float)get_b()*EncodeYUV[2][2];
309 //! Returns the color's saturation
310 /*! This is is the magnitude of the U and V components.
315 const float u(get_u()), v(get_v());
316 return sqrt(u*u+v*v);
319 //! Sets the luminance (\a y) and chromanance (\a u and \a v)
321 set_yuv(const float &y, const float &u, const float &v)
323 set_r(y*DecodeYUV[0][0]+u*DecodeYUV[0][1]+v*DecodeYUV[0][2]);
324 set_g(y*DecodeYUV[1][0]+u*DecodeYUV[1][1]+v*DecodeYUV[1][2]);
325 set_b(y*DecodeYUV[2][0]+u*DecodeYUV[2][1]+v*DecodeYUV[2][2]);
329 //! Sets color luminance
330 Color& set_y(const float &y) { return set_yuv(y,get_u(),get_v()); }
332 //! Set U component of chromanance
333 Color& set_u(const float &u) { return set_yuv(get_y(),u,get_v()); }
335 //! Set V component of chromanance
336 Color& set_v(const float &v) { return set_yuv(get_y(),get_u(),v); }
338 //! Set the U and V components of chromanance
339 Color& set_uv(const float& u, const float& v) { return set_yuv(get_y(),u,v); }
341 //! Sets the color's saturation
344 set_s(const float &x)
346 float u(get_u()), v(get_v());
347 const float s(sqrt(u*u+v*v));
357 //! YUV Color constructor
358 static Color YUV(const float& y, const float& u, const float& v, const value_type& a=1)
359 { return Color().set_yuv(y,u,v).set_a(a); }
361 #ifndef SYNFIG_NO_ANGLE
362 //! Returns the hue of the chromanance
363 /*! This is the angle of the U and V components.
367 { return Angle::tan(get_u(),get_v()); }
369 //! Synonym for get_hue(). \see get_hue()
370 Angle get_uv_angle() const { return get_hue(); }
372 //! Sets the color's hue
373 /*! \see get_hue() */
375 set_hue(const Angle& theta)
377 const float s(get_s());
379 u(s*(float)Angle::sin(theta).get()),
380 v(s*(float)Angle::cos(theta).get());
384 //! Synonym for set_hue(). \see set_hue()
385 Color& set_uv_angle(const Angle& theta) { return set_hue(theta); }
387 //! Rotates the chromanance vector by amount specified by \a theta
388 Color& rotate_uv(const Angle& theta)
390 const float a(Angle::sin(theta).get()), b(Angle::cos(theta).get());
391 const float u(get_u()), v(get_v());
393 return set_uv(b*u-a*v,a*u+b*v);
396 //! Sets the luminance (\a y) and chromanance (\a s and \a theta).
397 /*! \param y Luminance
398 ** \param s Saturation
399 ** \param theta Hue */
400 Color& set_yuv(const float& y, const float& s, const Angle& theta)
405 s*(float)Angle::sin(theta).get(),
406 s*(float)Angle::cos(theta).get()
410 //! YUV color constructor where the chroma is in the saturation/hue form.
411 /*! \param y Luminance
412 ** \param s Saturation
414 ** \param a Opacity (alpha) */
415 static Color YUV(const float& y, const float& s, const Angle& theta, const value_type& a=1)
416 { return Color().set_yuv(y,s,theta).set_a(a); }
420 //! Clamps a color so that its values are in range. Ignores attempting to visualize negative colors.
421 Color clamped()const;
423 //! Clamps a color so that its values are in range.
424 Color clamped_negative()const;
428 //! Preset Color Constructors
431 static inline Color alpha() { return Color(0,0,0,0.0000001f); }
433 static inline Color alpha() { return Color(0,0,0,0); }
435 static inline Color black() { return Color(0,0,0); }
436 static inline Color white() { return Color(1,1,1); }
437 static inline Color gray() { return Color(0.5f,0.5f,0.5f); }
438 static inline Color magenta() { return Color(1,0,1); }
439 static inline Color red() { return Color(1,0,0); }
440 static inline Color green() { return Color(0,1,0); }
441 static inline Color blue() { return Color(0,0,1); }
442 static inline Color cyan() { return Color(0,1,1); }
443 static inline Color yellow() { return Color(1,1,0); }
449 BLEND_COMPOSITE=0, //!< Color A is composited onto B (Taking into about A's alpha)
450 BLEND_STRAIGHT=1, //!< Straight linear interpolation from A->B (Alpha ignored)
451 BLEND_BRIGHTEN=2, //!< If composite is brighter than B, use composite. B otherwise.
452 BLEND_DARKEN=3, //!< If composite is brighter than B, use composite. B otherwise.
453 BLEND_ADD=4, //!< Simple A+B.
454 BLEND_SUBTRACT=5, //!< Simple A-B.
455 BLEND_MULTIPLY=6, //!< Simple A*B.
456 BLEND_DIVIDE=7, //!< Simple B/A
457 BLEND_COLOR=8, //!< Preserves the U and V channels of color A
458 BLEND_HUE=9, //!< Preserves the angle of the UV vector of color A
459 BLEND_SATURATION=10,//!< Preserves the magnitude of the UV Vector of color A
460 BLEND_LUMINANCE=11, //!< Preserves the Y channel of color A
461 BLEND_BEHIND=12, //!< Similar to BLEND_COMPOSITE, except that B is composited onto A.
462 BLEND_ONTO=13, //!< Similar to BLEND_COMPOSITE, except that B's alpha is maintained
463 BLEND_SCREEN=16, //!< \writeme
464 BLEND_OVERLAY=20, //!< \writeme
465 BLEND_DIFFERENCE=18, //!< \writeme
466 BLEND_HARD_LIGHT=17, //!< \writeme
469 BLEND_ALPHA_BRIGHTEN=14, //!< If A is less opaque than B, use A
470 BLEND_ALPHA_DARKEN=15, //!< If A is more opaque than B, use B
471 BLEND_ALPHA_OVER=19,//!< multiply alphas and then straight blends that using the amount
472 BLEND_STRAIGHT_ONTO=21,//!< \writeme
474 BLEND_END=22 //!< \internal
478 static Color blend(Color a, Color b,float amount,BlendMethod type=BLEND_COMPOSITE);
480 static bool is_onto(BlendMethod x)
482 return x==BLEND_BRIGHTEN
490 || x==BLEND_SATURATION
491 || x==BLEND_LUMINANCE
493 || x==BLEND_STRAIGHT_ONTO
496 || x==BLEND_DIFFERENCE
497 || x==BLEND_HARD_LIGHT
502 value_type& operator[](const int i)
505 assert(i<(signed)(sizeof(Color)/sizeof(value_type)));
509 const value_type& operator[](const int i)const
512 assert(i<(signed)(sizeof(Color)/sizeof(value_type)));
516 }; // END of class Color
518 #ifndef USE_HALF_TYPE
519 typedef Color ColorAccumulator;
521 class ColorAccumulator
525 typedef float value_type;
528 value_type a_, r_, g_, b_;
533 operator+=(const ColorAccumulator &rhs)
543 operator-=(const ColorAccumulator &rhs)
553 operator*=(const float &rhs)
563 operator/=(const float &rhs)
565 const float temp(value_type(1)/rhs);
574 operator+(const ColorAccumulator &rhs)const
575 { return Color(*this)+=rhs; }
578 operator-(const ColorAccumulator &rhs)const
579 { return Color(*this)-=rhs; }
582 operator*(const float &rhs)const
583 { return Color(*this)*=rhs; }
586 operator/(const float &rhs)const
587 { return Color(*this)/=rhs; }
590 operator==(const ColorAccumulator &rhs)const
591 { return r_==rhs.r_ && g_==rhs.g_ && b_==rhs.b_ && a_!=rhs.a_; }
594 operator!=(const ColorAccumulator &rhs)const
595 { return r_!=rhs.r_ || g_!=rhs.g_ || b_!=rhs.b_ || a_!=rhs.a_; }
599 { return ColorAccumulator(-r_,-g_,-b_,-a_); }
602 { return !isnan(r_) && !isnan(g_) && !isnan(b_) && !isnan(a_); }
605 ColorAccumulator() { }
610 ** \param A Opacity(alpha) */
611 ColorAccumulator(const value_type& R, const value_type& G, const value_type& B, const value_type& A=1):
618 ColorAccumulator(const ColorAccumulator& c):
625 ColorAccumulator(const Color& c):
631 //! Returns the RED component
632 const value_type& get_r()const { return r_; }
634 //! Returns the GREEN component
635 const value_type& get_g()const { return g_; }
637 //! Returns the BLUE component
638 const value_type& get_b()const { return b_; }
640 //! Returns the amount of opacity (alpha)
641 const value_type& get_a()const { return a_; }
643 //! Synonym for get_a(). \see get_a()
644 const value_type& get_alpha()const { return get_a(); }
646 //! Sets the RED component to \a x
647 ColorAccumulator& set_r(const value_type& x) { r_ = x; return *this; }
649 //! Sets the GREEN component to \a x
650 ColorAccumulator& set_g(const value_type& x) { g_ = x; return *this; }
652 //! Sets the BLUE component to \a x
653 ColorAccumulator& set_b(const value_type& x) { b_ = x; return *this; }
655 //! Sets the opacity (alpha) to \a x
656 ColorAccumulator& set_a(const value_type& x) { a_ = x; return *this; }
658 //! Synonym for set_a(). \see set_a()
659 ColorAccumulator& set_alpha(const value_type& x) { return set_a(x); }
663 Color::Color(const ColorAccumulator& c):
677 /* Bit Descriptions (ON/OFF)
678 ** ----+-------------
679 ** 0 Color Channels (Gray/RGB)
680 ** 1 Alpha Channel (WITH/WITHOUT)
681 ** 2 ZDepth (WITH/WITHOUT)
682 ** 3 Endian (BGR/RGB)
683 ** 4 Alpha Location (Start/End)
684 ** 5 ZDepth Location (Start/End)
685 ** 6 Alpha/ZDepth Arangement (ZA,AZ)
686 ** 7 Alpha Range (Inverted,Normal)
687 ** 8 Z Range (Inverted,Normal)
690 PF_GRAY=(1<<0), //!< If set, use one grayscale channel. If clear, use three channels for RGB
691 PF_A=(1<<1), //!< If set, include alpha channel
692 PF_Z=(1<<2), //!< If set, include ZDepth channel
693 PF_BGR=(1<<3), //!< If set, reverse the order of the RGB channels
694 PF_A_START=(1<<4), //!< If set, alpha channel is before the color data. If clear, it is after.
695 PF_Z_START=(1<<5), //!< If set, ZDepth channel is before the color data. If clear, it is after.
696 PF_ZA=(1<<6), //!< If set, the ZDepth channel will be infront of the alpha channel. If clear, they are reversed.
698 PF_A_INV=(1<<7), //!< If set, the alpha channel is stored as 1.0-a
699 PF_Z_INV=(1<<8), //!< If set, the ZDepth channel is stored as 1.0-z
700 PF_RAW_COLOR=(1<<9)+(1<<1) //!< If set, the data represents a raw Color datastructure, and all other bits are ignored.
703 inline PixelFormat operator|(PixelFormat lhs, PixelFormat rhs)
704 { return static_cast<PixelFormat>((int)lhs|(int)rhs); }
706 inline PixelFormat operator&(PixelFormat lhs, PixelFormat rhs)
707 { return static_cast<PixelFormat>((int)lhs&(int)rhs); }
708 #define FLAGS(x,y) (((x)&(y))==(y))
710 //! Returns the number of channels that the given PixelFormat calls for
712 channels(PixelFormat x)
723 if(FLAGS(x,PF_RAW_COLOR))
729 inline unsigned char *
730 Color2PixelFormat(const Color &color, const PixelFormat &pf, unsigned char *out, const Gamma &gamma)
732 if(FLAGS(pf,PF_RAW_COLOR))
734 Color *outcol=reinterpret_cast<Color *>(out);
740 int alpha=(int)((FLAGS(pf,PF_A_INV)?(-(float)color.get_a()+1):(float)color.get_a())*255);
742 if(alpha>255)alpha=255;
744 if(FLAGS(pf,PF_ZA|PF_A_START|PF_Z_START))
746 if(FLAGS(pf,PF_Z_START))
747 *out++/*=(unsigned char)(color.GetZ()*255.0f)*/;
748 if(FLAGS(pf,PF_A_START))
749 *out++=static_cast<unsigned char>(alpha);
753 if(FLAGS(pf,PF_A_START))
754 *out++=static_cast<unsigned char>(alpha);
755 if(FLAGS(pf,PF_Z_START))
756 *out++/*=(unsigned char)(color.GetZ()*255.0f)*/;
760 if(FLAGS(pf,PF_GRAY))
761 *out++=static_cast<unsigned char>(gamma.g_F32_to_U8(color.get_y()));
766 *out++=static_cast<unsigned char>(gamma.r_F32_to_U8(color.get_b()));
767 *out++=static_cast<unsigned char>(gamma.g_F32_to_U8(color.get_g()));
768 *out++=static_cast<unsigned char>(gamma.b_F32_to_U8(color.get_r()));
772 *out++=static_cast<unsigned char>(gamma.r_F32_to_U8(color.get_r()));
773 *out++=static_cast<unsigned char>(gamma.g_F32_to_U8(color.get_g()));
774 *out++=static_cast<unsigned char>(gamma.b_F32_to_U8(color.get_b()));
780 if(!FLAGS(pf,PF_Z_START) && FLAGS(pf,PF_Z))
781 out++;//*out++=(unsigned char)(color.GetZ()*255.0f);
782 if(!FLAGS(pf,PF_A_START) && FLAGS(pf,PF_A))
783 *out++=static_cast<unsigned char>(alpha);
787 if(!FLAGS(pf,PF_Z_START) && FLAGS(pf,PF_Z))
788 out++;//*out++=(unsigned char)(color.GetZ()*255.0f);
789 if(!FLAGS(pf,PF_A_START) && FLAGS(pf,PF_A))
790 *out++=static_cast<unsigned char>(alpha);
796 convert_color_format(unsigned char *dest, const Color *src, int w, PixelFormat pf,const Gamma &gamma)
800 dest=Color2PixelFormat((*(src++)).clamped(),pf,dest,gamma);
803 inline const unsigned char *
804 PixelFormat2Color(Color &color, const PixelFormat &pf,const unsigned char *out)
806 if(FLAGS(pf,PF_ZA|PF_A_START|PF_Z_START))
808 if(FLAGS(pf,PF_Z_START))
809 out++;//color.SetZ((Color::value_type)*out++/255.0f);
810 if(FLAGS(pf,PF_A_START))
811 color.set_a((float)*out++/255);
815 if(FLAGS(pf,PF_A_START))
816 color.set_a((float)*out++/255);
817 if(FLAGS(pf,PF_Z_START))
818 out++;//color.SetZ((Color::value_type)*out++/255.0f);
821 if(FLAGS(pf,PF_GRAY))
822 color.set_yuv((float)*out++/255,0,0);
827 color.set_b((float)*out++/255);
828 color.set_g((float)*out++/255);
829 color.set_r((float)*out++/255);
833 color.set_r((float)*out++/255);
834 color.set_g((float)*out++/255);
835 color.set_b((float)*out++/255);
841 if(!FLAGS(pf,PF_Z_START) && FLAGS(pf,PF_Z))
842 out++;//color.SetZ((Color::value_type)*out++/255.0f);
843 if(!FLAGS(pf,PF_A_START) && FLAGS(pf,PF_A))
844 color.set_a((float)*out++/255);
848 if(!FLAGS(pf,PF_A_START) && FLAGS(pf,PF_A))
849 color.set_a((float)*out++/255);
850 if(!FLAGS(pf,PF_Z_START) && FLAGS(pf,PF_Z))
851 out++;//color.SetZ((Color::value_type)*out++/255.0f);
858 }; // END of namespace synfig
860 /* === E N D =============================================================== */