hdr10.hxx

Go to the documentation of this file.

/*
 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
 *
 * This file is part of StormByte-Multimedia.
 *
 * StormByte-Multimedia original source is dual-licensed:
 *
 * 1. GNU Lesser General Public License v3.0 (or later)
 *    You may redistribute and/or modify this file under the terms of the
 *    GNU Lesser General Public License as published by the Free Software
 *    Foundation, either version 3 of the License, or (at your option)
 *    any later version.
 *
 * 2. Commercial license
 *    Alternatively, this file may be used under the terms of a commercial
 *    license agreement with the copyright holder
 *    (David C. Manuelda <StormByte@gmail.com>).
 *
 * Both licenses apply only to original StormByte-Multimedia source in this
 * file. Third-party components — including FFmpeg and embedded trained data —
 * remain under their own licenses and are not covered by the commercial grant.
 *
 * Neither license grants any patent rights. Any patent licenses required
 * to use this software or third-party components must be obtained separately
 * from the patent holders.
 *
 * StormByte-Multimedia 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with StormByte-Multimedia. If not, see
 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
 *
 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
 */
 
#pragma once
 
#include <StormByte/multimedia/property/point.hxx>
#include <StormByte/multimedia/visibility.h>
 
#include <optional>

namespace StormByte::Multimedia::Property {
    class STORMBYTE_MULTIMEDIA_PUBLIC HDR10 final {
        public:
            enum class Source {
                Metadata,   
                Heuristics  
            };

            HDR10() noexcept;

            HDR10(const Point& red, const Point& green, const Point& blue, const Point& white,
                const Point& luminance, const std::optional<Point>& light_level = std::nullopt,
                Source source = Source::Metadata) noexcept;

            HDR10(Point&& red, Point&& green, Point&& blue, Point&& white,
                Point&& luminance, std::optional<Point>&& light_level = std::nullopt,
                Source source = Source::Metadata) noexcept;

            HDR10(const HDR10&) = default;

            HDR10(HDR10&&) noexcept = default;

            ~HDR10() noexcept = default;

            HDR10& operator=(const HDR10&) = default;

            HDR10& operator=(HDR10&&) noexcept = default;

            const Point& Red() const noexcept;

            const Point& Green() const noexcept;

            const Point& Blue() const noexcept;

            const Point& White() const noexcept;

            const Point& Luminance() const noexcept;

            const std::optional<Point>& LightLevel() const noexcept;

            Source Origin() const noexcept;

            bool IsHDR10Plus() const noexcept;

            void HDR10Plus(bool hdrplus) noexcept;
 
            static const HDR10 DEFAULT;     
 
        private:
            Point m_red;                            
            Point m_green;                          
            Point m_blue;                           
            Point m_white;                          
            Point m_luminance;                      
            std::optional<Point> m_light_level;     
            Source m_source;                        
            bool m_hdr10plus;                       
    };
}