color.h

/* ********************************************************************
    itom software
    URL: http://www.uni-stuttgart.de/ito
    Copyright (C) 2020, Institut fuer Technische Optik (ITO),
    Universitaet Stuttgart, Germany

    This file is part of itom and its software development toolkit (SDK).

    itom is free software; you can redistribute it and/or modify it
    under the terms of the GNU Library General Public Licence as published by
    the Free Software Foundation; either version 2 of the Licence, or (at
    your option) any later version.
   
    In addition, as a special exception, the Institut fuer Technische
    Optik (ITO) gives you certain additional rights.
    These rights are described in the ITO LGPL Exception version 1.0,
    which can be found in the file LGPL_EXCEPTION.txt in this package.

    itom is distributed in the hope that it will be useful, but
    WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library
    General Public Licence for more details.

    You should have received a copy of the GNU Library General Public License
    along with itom. If not, see <http://www.gnu.org/licenses/>.
*********************************************************************** */

#ifndef COLOR_H
#define COLOR_H

#include "typeDefs.h"

namespace ito
{


        class Rgba32 : public RgbaBase32
        {
        public:

            enum RGBSelectionFlags
            {
                RGBA_B    = 0, 
                RGBA_G    = 1, 
                RGBA_R    = 2, 
                RGBA_A    = 3, 
                RGBA_Y    = 4, 
                RGBA_RGB  = 5
            };

            Rgba32()  
            {
                //memset(m_value, 0, 4*sizeof(ito::uint8));
            }

            static Rgba32 zeros()
            {
                Rgba32 temp;
                temp.rgba = 0;
                return temp;
            }

            static Rgba32 black()
            {
                Rgba32 temp(255, 0,0,0);
                return temp;
            }
            

            static Rgba32 fromUnsignedLong(const uint32 val)
            {
                Rgba32 temp;
                memcpy(temp.u8ptr(), &val, 4*sizeof(ito::uint8));
                return temp;
            }

            Rgba32(const uint8 &a, const uint8 &r, const uint8 &g, const uint8 &b) 
            {
                this->b = b;
                this->g = g;
                this->r = r;
                this->a = a;
            }
            

            explicit Rgba32(const uint8 gray)
            {
                a = 0xFF;
                r = gray;
                b = gray;
                g = gray;
            }

            Rgba32(const Rgba32 &rhs)
            {
                rgba = rhs.rgba;
            };

            Rgba32& operator +=(const Rgba32 &rhs)
            {
                b = static_cast<uint8>(std::min<int16>(b + rhs.b, 255));
                g = static_cast<uint8>(std::min<int16>(g + rhs.g, 255));
                r = static_cast<uint8>(std::min<int16>(r + rhs.r, 255));
                a = static_cast<uint8>(std::min<int16>(a + rhs.a, 255));
                return *this;
            }

            Rgba32& operator =(const Rgba32 &rhs)
            {
                rgba = rhs.rgba;
                return *this;
            }
        
            Rgba32& operator =(const uint32 &rhs)
            {
                rgba = rhs;
                return *this;
            }

            Rgba32& operator -=(const Rgba32 &rhs)
            {
                b = static_cast<uint8>(std::max<int16>(b - rhs.b, 0));
                g = static_cast<uint8>(std::max<int16>(g - rhs.g, 0));
                r = static_cast<uint8>(std::max<int16>(r - rhs.r, 0));
                a = static_cast<uint8>(std::max<int16>(a - rhs.a, 0));
                return *this;
            }
            

            Rgba32& operator *=(const Rgba32 &rhs)
            {
                b = static_cast<uint8>(b * rhs.b / 255);
                g = static_cast<uint8>(g * rhs.g / 255);
                r = static_cast<uint8>(r * rhs.r / 255);
                a = static_cast<uint8>(a * rhs.a / 255);
                return *this;
            }


            Rgba32& operator *=(const ito::float32 &grayFactor)
            {
                if (grayFactor < 0.0)
                {
                    throw std::runtime_error("Multiplication factor must be >= 0.0");
                }
                unsigned int t = static_cast<unsigned int>(b * grayFactor);
                b = static_cast<uint8>(t <= 255 ? t : 255);
                                t = static_cast<unsigned int>(g * grayFactor);
                g = static_cast<uint8>(t <= 255 ? t : 255);
                                t = static_cast<unsigned int>(r * grayFactor);
                r = static_cast<uint8>(t <= 255 ? t : 255);
                return *this;
            }

            Rgba32& operator /=(const Rgba32 &rhs)
            {
                if(rhs.b == 0 || rhs.g == 0 || rhs.r == 0 || rhs.a == 0)
                {
                    throw std::runtime_error("Division by zero not allowed for rgba32-values");
                }
                b = static_cast<uint8>(std::min<int16>((b * (ito::int16)255) / rhs.b, 255));
                g = static_cast<uint8>(std::min<int16>((g * (ito::int16)255) / rhs.g, 255));
                r = static_cast<uint8>(std::min<int16>((r * (ito::int16)255) / rhs.r, 255));
                a = static_cast<uint8>(std::min<int16>((a * (ito::int16)255) / rhs.a, 255));
                return *this;
            }

            Rgba32 operator +(const Rgba32 &second) const 
            {
                Rgba32 first(*this);
                first += second;
                return first;
            }

            Rgba32 operator -(const Rgba32 &second) const 
            {
                Rgba32 first(*this);
                first -= second;
                return first;
            }

            Rgba32 operator *(const Rgba32 &second) const 
            {
                Rgba32 first(*this);
                first *= second;
                return first;
            }

            Rgba32 operator *(const ito::float32 &second) const 
            {
                Rgba32 first(*this);
                first *= second;
                return first;
            }

            Rgba32 operator /(const Rgba32 &second) const 
            {
                Rgba32 first(*this);
                first /= second;
                return first;
            }

            bool operator ==(const Rgba32 &rhs) const 
            {
                return (b == rhs.b) && (g == rhs.g) && (r == rhs.r && (a == rhs.a));
            }

            bool operator !=(const Rgba32 &rhs) const 
            {
                return (b != rhs.b) || (g != rhs.g) || (r != rhs.r || (a != rhs.a));
            }

            inline float32 gray() const 
                        {
                                return static_cast<float32>(0.299 * r + 0.587 * g + 0.114 * b);
                        } 

            uint8& alpha() {return a;}; 
            uint8& red()   {return r;}; 
            uint8& green() {return g;}; 
            uint8& blue()  {return b;}; 
            uint8 alpha() const {return a;}; 
            uint8 red()   const {return r;}; 
            uint8 green() const {return g;}; 
            uint8 blue()  const {return b;}; 
            uint32& argb() {return rgba;}; 
            uint32 argb() const {return rgba;}; 
            uint32* u32ptr() {return (&rgba);}
            uint8* u8ptr() {return ((uint8*)(&rgba));}
        };


        template<uint8 _COLOR> class RGBChannel : Rgba32
        {
        public:
            RGBChannel()  
            {
                //memset(m_value, 0, 4*sizeof(ito::uint8));
            };

            explicit RGBChannel(const uint8 gray) 
            {
                r = g = b = 0;
                a = 0xFF;
                items[_COLOR] = gray;
            }

            static RGBChannel<_COLOR> zeros()
            {
                RGBChannel<_COLOR> temp;
                temp.rgba = 0;
                return temp;
            }

            static RGBChannel<_COLOR> black()
            {
                RGBChannel<_COLOR> temp;
                temp.rgba = 0;
                temp.a = 0xFF;
                return temp;
            }

            RGBChannel(const RGBChannel &rhs)
            {
                rgba = 0;
                a = 0xFF;
                items[_COLOR] = rhs.items[_COLOR];
            }

            RGBChannel& operator +=(const RGBChannel &rhs)
            {
                items[_COLOR] = static_cast<uint8>(std::min<int16>(items[_COLOR] + rhs.items[_COLOR], 255));
                return *this;
            }

            RGBChannel& operator =(const RGBChannel &rhs)
            {
                items[_COLOR] = rhs.items[_COLOR];
                return *this;
            }

            RGBChannel& operator =(const uint32 &rhs)
            {
                items[_COLOR] = ((unsigned char*)&rhs)[_COLOR]; 
                return *this;
            }

            RGBChannel& operator -=(const RGBChannel &rhs)
            {
                items[_COLOR] = static_cast<uint8>(std::max<int16>(items[_COLOR] - rhs.items[_COLOR], 0));
                return *this;
            }

            RGBChannel& operator *=(const RGBChannel &rhs)
            {
                items[_COLOR] = static_cast<uint8>(items[_COLOR] * rhs.items[_COLOR] / 255);
                return *this;
            }

            RGBChannel& operator /=(const RGBChannel &rhs)
            {
                if(rhs.items[_COLOR] == 0)
                {
                    throw std::runtime_error("Division by zero not allowed for rgba32-values");
                }
                items[_COLOR] = static_cast<uint8>(std::min<int16>((items[_COLOR] * (ito::int16)255)/ rhs.items[_COLOR], 255));
                return *this;
            }

            RGBChannel operator +(const RGBChannel &second) const 
            {
                RGBChannel<_COLOR> first(*this);
                first += second;
                return first;
            }

            RGBChannel operator -(const RGBChannel &second) const 
            {
                RGBChannel<_COLOR> first(*this);
                first -= second;
                return first;
            }

            RGBChannel operator *(const RGBChannel &second) const 
            {
                RGBChannel<_COLOR> first(*this);
                first *= second;
                return first;
            }

            RGBChannel operator /(const RGBChannel &second) const 
            {
                RGBChannel<_COLOR> first(*this);
                first /= second;
                return first;
            }

            bool operator ==(const RGBChannel &rhs) const 
            {
                return items[_COLOR] == rhs.items[_COLOR];
            }

            bool operator !=(const RGBChannel &rhs) const 
            {
                return items[_COLOR] != rhs.items[_COLOR];
            }

            bool operator <(const RGBChannel &rhs) const 
            {
                return (items[_COLOR] < rhs.items[_COLOR]);
            }

            bool operator >(const RGBChannel &rhs) const 
            {
                return (items[_COLOR] < rhs.items[_COLOR]);
            }

            inline float32 gray() const {return static_cast<float32> (items[_COLOR]);}; 
            uint8& value() {return items[_COLOR];}; 
            uint8 value() const {return items[_COLOR];}; 
        };

        typedef RGBChannel<Rgba32::RGBA_A> AlphaChannel;
        typedef RGBChannel<Rgba32::RGBA_R> RedChannel;
        typedef RGBChannel<Rgba32::RGBA_G> GreenChannel;
        typedef RGBChannel<Rgba32::RGBA_B> BlueChannel;

} //end namespace ito

#endif //COLOR_H