anctranslateconfig.h

Go to the documentation of this file.

 
#pragma once
 
 
#include <promeki/config.h>
#if PROMEKI_ENABLE_PROAV
#include <promeki/namespace.h>
#include <promeki/variantdatabase.h>
#include <promeki/duration.h>
#include <promeki/enums_anc.h>
#include <promeki/string.h>
#include <promeki/error.h>
#include <promeki/metadata.h>
 
PROMEKI_NAMESPACE_BEGIN
 
class AncTranslateConfig : public VariantDatabase<"AncTranslateConfig"> {
        public:
                using Base = VariantDatabase<"AncTranslateConfig">;
 
                using Base::Base;
 
                // ============================================================
                // Universal knobs
                // ============================================================
 
                PROMEKI_DECLARE_ID(Fidelity,
                                   VariantSpec()
                                           .setType(DataTypeEnum)
                                           .setEnumType(AncFidelity::Type)
                                           .setDefault(AncFidelity(AncFidelity::Default))
                                           .setDescription("Output verbosity for translators that have multiple valid output forms."));
 
                PROMEKI_DECLARE_ID(Checksum,
                                   VariantSpec()
                                           .setType(DataTypeEnum)
                                           .setEnumType(AncChecksumPolicy::Type)
                                           .setDefault(AncChecksumPolicy(AncChecksumPolicy::PreserveOrRecompute))
                                           .setDescription("ST 291 checksum policy for builder / translator outputs."));
 
                PROMEKI_DECLARE_ID(OnUnsupported,
                                   VariantSpec()
                                           .setType(DataTypeEnum)
                                           .setEnumType(AncOnUnsupported::Type)
                                           .setDefault(AncOnUnsupported(AncOnUnsupported::BestEffort))
                                           .setDescription("Behaviour when the input cannot be represented on the target transport."));
 
                PROMEKI_DECLARE_ID(AllowLossy,
                                   VariantSpec()
                                           .setType(DataTypeBool)
                                           .setDefault(false)
                                           .setDescription("Permit lossy translations (truncation / downsampling) when no lossless path exists."));
 
                // ============================================================
                // Per-transport build-time inputs
                // ============================================================
                //
                // Naming pattern: <Transport><Field>.  The dotted-namespace
                // form the devplan sketches (`St291::BuildLine`) is not
                // representable as a single C++ identifier in a database
                // that takes a flat name list; we keep the wire name
                // dotted (`St291.BuildLine`) for nice JSON output while
                // the C++ identifier collapses the dot.
 
                PROMEKI_DECLARE_ID(St291BuildLine,
                                   VariantSpec()
                                           .setType(DataTypeUInt16)
                                           .setDefault(uint16_t(0x7FE))
                                           .setDescription("VANC line number for built ST 291 packets (0x7FE = "
                                                           "RP 168 sentinel: anywhere after the switching point)."));
 
                PROMEKI_DECLARE_ID(St291FieldB,
                                   VariantSpec()
                                           .setType(DataTypeBool)
                                           .setDefault(false)
                                           .setDescription("F-bit for built ST 291 packets (field-2 indicator)."));
 
                PROMEKI_DECLARE_ID(St291BuildCBit,
                                   VariantSpec()
                                           .setType(DataTypeBool)
                                           .setDefault(false)
                                           .setDescription("C-bit (Y=false / C=true) for built ST 291 packets."));
 
                PROMEKI_DECLARE_ID(St291KeepAliveField,
                                   VariantSpec()
                                           .setType(DataTypeUInt8)
                                           .setDefault(uint8_t(0))
                                           .setDescription("F-bit for the ST 2110-40 §5.5 ANC_Count=0 keep-alive RTP packet."));
 
                PROMEKI_DECLARE_ID(NdiXmlNamespace,
                                   VariantSpec()
                                           .setType(DataTypeString)
                                           .setDefault(String())
                                           .setDescription("XML namespace prefix preference for built NDI metadata frames."));
 
                PROMEKI_DECLARE_ID(HdmiInfoFrameOui,
                                   VariantSpec()
                                           .setType(DataTypeUInt32)
                                           .setDefault(uint32_t(0))
                                           .setDescription("OUI to stamp into built vendor-specific HDMI InfoFrames (0 = codec default)."));
 
                PROMEKI_DECLARE_ID(RtmpAmfObjectName,
                                   VariantSpec()
                                           .setType(DataTypeString)
                                           .setDefault(String())
                                           .setDescription("AMF0 script-tag name override for built RTMP outputs (empty = codec default)."));
 
                PROMEKI_DECLARE_ID(HdrDynamicImageWidth,
                                   VariantSpec()
                                           .setType(DataTypeUInt32)
                                           .setDefault(uint32_t(0))
                                           .setDescription("Image width (pixels) for ST 2094-40 §9.2 Window 0 (0 = unknown, emits sentinel)."));
 
                PROMEKI_DECLARE_ID(HdrDynamicImageHeight,
                                   VariantSpec()
                                           .setType(DataTypeUInt32)
                                           .setDefault(uint32_t(0))
                                           .setDescription("Image height (pixels) for ST 2094-40 §9.2 Window 0 (0 = unknown, emits sentinel)."));
 
                PROMEKI_DECLARE_ID(AtcParseRateHint,
                                   VariantSpec()
                                           .setType(DataTypeUInt32)
                                           .setDefault(uint32_t(0))
                                           .setDescription("ATC parse-time frame-rate hint (24/25/30; 0 = no hint)."));
 
                PROMEKI_DECLARE_ID(AtcHfrtcBitstreamNumber,
                                   VariantSpec()
                                           .setType(DataTypeUInt8)
                                           .setDefault(uint8_t(0))
                                           .setDescription("Bitstream number (DBB1 low nibble, 0..15) for built ATC_HFRTC packets."));
 
                PROMEKI_DECLARE_ID(AtcHfrtcParseFormatHint,
                                   VariantSpec()
                                           .setType(DataTypeUInt32)
                                           .setDefault(uint32_t(0))
                                           .setDescription("ATC_HFRTC parse-time format-rate fallback (72/96/100/120; 0 = none)."));
 
                PROMEKI_DECLARE_ID(RtpJitterWarnThreshold,
                                   VariantSpec()
                                           .setType(DataTypeDuration)
                                           .setDefault(Duration::zero())
                                           .setDescription("RTP interarrival-jitter warning threshold (e.g. 10ms; 0 = off)."));
 
                // ============================================================
                // String round-trip (JSON)
                // ============================================================
 
                AncChecksumPolicy checksumPolicy() const {
                        if (!contains(Checksum)) {
                                return AncChecksumPolicy(AncChecksumPolicy::PreserveOrRecompute);
                        }
                        Enum e = getAs<Enum>(Checksum);
                        return AncChecksumPolicy(e.value());
                }
 
                uint8_t keepAliveFieldByte() const {
                        return getAs<uint8_t>(St291KeepAliveField, uint8_t(0));
                }
 
                String toString(unsigned int indent = 0) const {
                        return toJson().toString(indent);
                }
 
                static AncTranslateConfig fromString(const String &str, Error *err = nullptr) {
                        Error      parseErr;
                        JsonObject json = JsonObject::parse(str, &parseErr);
                        if (parseErr.isError()) {
                                if (err) *err = parseErr;
                                return AncTranslateConfig();
                        }
                        // Mirror Metadata::fromJson: walk the object and feed
                        // each entry through the spec-aware coercion path so
                        // string-encoded rich types (Enum, Url, …) land back
                        // as their proper Variant kind.
                        AncTranslateConfig cfg;
                        bool               good = true;
                        json.forEach([&cfg, &good](const String &key, const Variant &val) {
                                if (!val.isValid()) {
                                        good = false;
                                        return;
                                }
                                Error e = cfg.setFromJson(ID(key), val);
                                if (e.isError()) good = false;
                        });
                        if (err) *err = good ? Error::Ok : Error::Invalid;
                        return cfg;
                }
};
 
PROMEKI_NAMESPACE_END
 
#endif // PROMEKI_ENABLE_PROAV