akcolorcomponent.h 4.3 KB
/* Webcamoid, webcam capture application.
 * Copyright (C) 2022  Gonzalo Exequiel Pedone
 *
 * Webcamoid is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Webcamoid 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Webcamoid. If not, see <http://www.gnu.org/licenses/>.
 *
 * Web-Site: http://webcamoid.github.io/
 */

#ifndef AKCOLORCOMPONENT_H
#define AKCOLORCOMPONENT_H

#include <QObject>

#include "akcommons.h"

class AkColorComponent;
class AkColorComponentPrivate;

using AkColorComponentList = QVector<AkColorComponent>;

class AKCOMMONS_EXPORT AkColorComponent: public QObject
{
    Q_OBJECT
    Q_PROPERTY(ComponentType type
               READ type
               CONSTANT)
    Q_PROPERTY(size_t step
               READ step
               CONSTANT)
    Q_PROPERTY(size_t offset
               READ offset
               CONSTANT)
    Q_PROPERTY(size_t shift
               READ shift
               CONSTANT)
    Q_PROPERTY(size_t byteDepth
               READ byteDepth
               CONSTANT)
    Q_PROPERTY(size_t depth
               READ depth
               CONSTANT)
    Q_PROPERTY(size_t widthDiv
               READ widthDiv
               CONSTANT)
    Q_PROPERTY(size_t heightDiv
               READ heightDiv
               CONSTANT)

    public:
        enum ComponentType
        {
            CT_Unknown,
            CT_R,
            CT_G,
            CT_B,
            CT_Y,
            CT_U,
            CT_V,
            CT_A
        };
        Q_ENUM(ComponentType)

        AkColorComponent(QObject *parent=nullptr);
        AkColorComponent(ComponentType type,
                         size_t step,
                         size_t offset,
                         size_t shift,
                         size_t byteDepth,
                         size_t depth,
                         size_t widthDiv,
                         size_t heightDiv);
        AkColorComponent(const AkColorComponent &other);
        ~AkColorComponent();
        AkColorComponent &operator =(const AkColorComponent &other);
        bool operator ==(const AkColorComponent &other) const;
        bool operator !=(const AkColorComponent &other) const;

        Q_INVOKABLE static QObject *create();
        Q_INVOKABLE static QObject *create(const AkColorComponent &colorComponent);
        Q_INVOKABLE static QObject *create(AkColorComponent::ComponentType type,
                                           size_t step,
                                           size_t offset,
                                           size_t shift,
                                           size_t byteDepth,
                                           size_t depth,
                                           size_t widthDiv,
                                           size_t heightDiv);
        Q_INVOKABLE QVariant toVariant() const;

        Q_INVOKABLE AkColorComponent::ComponentType type() const;
        Q_INVOKABLE size_t step() const;
        Q_INVOKABLE size_t offset() const;
        Q_INVOKABLE size_t shift() const;
        Q_INVOKABLE size_t byteDepth() const;
        Q_INVOKABLE size_t depth() const;
        Q_INVOKABLE size_t widthDiv() const;
        Q_INVOKABLE size_t heightDiv() const;

        template <typename T>
        inline T max() const
        {
            return (T(1) << this->depth()) - 1;
        }

    private:
        AkColorComponentPrivate *d;

    public Q_SLOTS:
        static void registerTypes();
};

AKCOMMONS_EXPORT QDebug operator <<(QDebug debug, const AkColorComponent &component);
AKCOMMONS_EXPORT QDebug operator <<(QDebug debug, AkColorComponent::ComponentType type);
AKCOMMONS_EXPORT QDataStream &operator >>(QDataStream &istream, AkColorComponent &component);
AKCOMMONS_EXPORT QDataStream &operator <<(QDataStream &ostream, const AkColorComponent &component);

Q_DECLARE_METATYPE(AkColorComponent)
Q_DECLARE_METATYPE(AkColorComponentList)
Q_DECLARE_METATYPE(AkColorComponent::ComponentType)

#endif // AKCOLORCOMPONENT_H