feature.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 <cstdint>
 
namespace StormByte::Multimedia {
    enum class Feature: std::uint32_t {
        None                    = 0,
 
        MultiThreaded           = 1u << 0,  
        RealTime                = 1u << 1,  
        LowDelay                = 1u << 2,  
        ZeroCopy                = 1u << 3,  
        HardwareAcceleration    = 1u << 4,  
 
        HighQuality             = 1u << 5,  
        PsychoVisual            = 1u << 6,  
        AdaptiveQuantization    = 1u << 7,  
        Lookahead               = 1u << 8,  
        TwoPass                 = 1u << 9,  
        Lossless                = 1u << 10, 
        ProfileBased            = 1u << 11, 
        ContentTuning           = 1u << 12, 
 
        TenBit                  = 1u << 13, 
        TwelveBit               = 1u << 14, 
        HDR10                   = 1u << 15, 
        HDR10Plus               = 1u << 16, 
        WideGamut               = 1u << 17, 
        SurroundSound           = 1u << 18, 
        SideData                = 1u << 19, 
 
        BFrames                 = 1u << 20, 
        IntraOnly               = 1u << 21, 
        Interlaced              = 1u << 22, 
        Slices                  = 1u << 23, 
 
        Streamable              = 1u << 24, 
        Encodeable              = 1u << 25  
    };
 
    constexpr const char* ToString(Feature feature) noexcept {
        switch (feature) {
            case Feature::None:                 return "None";
            case Feature::MultiThreaded:        return "MultiThreaded";
            case Feature::RealTime:             return "RealTime";
            case Feature::LowDelay:             return "LowDelay";
            case Feature::ZeroCopy:             return "ZeroCopy";
            case Feature::HardwareAcceleration: return "HardwareAcceleration";
            case Feature::HighQuality:          return "HighQuality";
            case Feature::PsychoVisual:         return "PsychoVisual";
            case Feature::AdaptiveQuantization: return "AdaptiveQuantization";
            case Feature::Lookahead:            return "Lookahead";
            case Feature::TwoPass:              return "TwoPass";
            case Feature::Lossless:             return "Lossless";
            case Feature::ProfileBased:         return "ProfileBased";
            case Feature::ContentTuning:        return "ContentTuning";
            case Feature::TenBit:               return "TenBit";
            case Feature::TwelveBit:            return "TwelveBit";
            case Feature::HDR10:                return "HDR10";
            case Feature::HDR10Plus:            return "HDR10Plus";
            case Feature::WideGamut:            return "WideGamut";
            case Feature::SurroundSound:        return "SurroundSound";
            case Feature::SideData:             return "SideData";
            case Feature::BFrames:              return "BFrames";
            case Feature::IntraOnly:            return "IntraOnly";
            case Feature::Interlaced:           return "Interlaced";
            case Feature::Slices:               return "Slices";
            case Feature::Streamable:           return "Streamable";
            case Feature::Encodeable:           return "Encodeable";
        }
        return "UnknownFeature";
    }
}