cea608xds.h

Go to the documentation of this file.

 
#pragma once
 
 
#include <promeki/config.h>
#if PROMEKI_ENABLE_PROAV
#include <cstdint>
#include <promeki/cea708cdp.h>
#include <promeki/datetime.h>
#include <promeki/list.h>
#include <promeki/map.h>
#include <promeki/namespace.h>
#include <promeki/optional.h>
#include <promeki/sharedptr.h>
#include <promeki/string.h>
 
PROMEKI_NAMESPACE_BEGIN
 
enum class Cea608XdsClass : uint8_t {
        Current     = 0, 
        Future      = 1, 
        Channel     = 2, 
        Misc        = 3, 
        PublicSvc   = 4, 
        Reserved    = 5, 
        PrivateData = 6, 
        Unknown     = 7  
};
 
enum class Cea608XdsRatingSystem : uint8_t {
        Mpaa = 0,            
        UsTvParental = 1,    
        CanadianEnglish = 2, 
        CanadianFrench = 3,  
};
 
enum class Cea608XdsMpaaRating : uint8_t {
        NotApplicable = 0, 
        G = 1,
        Pg = 2,
        Pg13 = 3,
        R = 4,
        Nc17 = 5,
        X = 6,
        NotRated = 7,
};
 
struct Cea608XdsContentAdvisory {
                Cea608XdsRatingSystem system = Cea608XdsRatingSystem::UsTvParental;
                uint8_t level = 0;
                Cea608XdsMpaaRating mpaa = Cea608XdsMpaaRating::NotApplicable;
                bool violence = false;
                bool sexual = false;
                bool language = false;
                bool dialog = false;
                bool fantasyViolence = false;
 
                bool operator==(const Cea608XdsContentAdvisory &o) const {
                        return system == o.system && level == o.level && mpaa == o.mpaa
                               && violence == o.violence && sexual == o.sexual
                               && language == o.language && dialog == o.dialog
                               && fantasyViolence == o.fantasyViolence;
                }
                bool operator!=(const Cea608XdsContentAdvisory &o) const { return !(*this == o); }
 
                String ratingName() const;
};
 
struct Cea608XdsProgramId {
                uint8_t minute = 0; 
                uint8_t hour = 0;   
                uint8_t date = 1;   
                uint8_t month = 1;  
                bool tapeDelay = false;     
                // Per CEA-608-E §9.5.1.1: "The D, L, and Z bits are
                // ignored by the decoder when processing this packet."
                // We don't expose those bits — the @c D, @c L, @c Z
                // semantics live in the Time-of-Day packet
                // (§9.5.4.1), surfaced via @ref Cea608XdsPacket::
                // timeOfDayDstFlag / timeOfDayLeapYearFlag /
                // timeOfDayZeroSecondsFlag.
 
                bool operator==(const Cea608XdsProgramId &o) const {
                        return minute == o.minute && hour == o.hour && date == o.date
                               && month == o.month && tapeDelay == o.tapeDelay;
                }
                bool operator!=(const Cea608XdsProgramId &o) const { return !(*this == o); }
};
 
struct Cea608XdsProgramLength {
                uint8_t lengthHours = 0;   
                uint8_t lengthMinutes = 0; 
                uint8_t elapsedHours = 0;     
                uint8_t elapsedMinutes = 0;   
                uint8_t elapsedSeconds = 0;   
                bool    hasElapsedTime = false;     
                bool    hasElapsedSeconds = false;  
 
                bool operator==(const Cea608XdsProgramLength &o) const {
                        return lengthHours == o.lengthHours && lengthMinutes == o.lengthMinutes
                               && elapsedHours == o.elapsedHours && elapsedMinutes == o.elapsedMinutes
                               && elapsedSeconds == o.elapsedSeconds
                               && hasElapsedTime == o.hasElapsedTime
                               && hasElapsedSeconds == o.hasElapsedSeconds;
                }
                bool operator!=(const Cea608XdsProgramLength &o) const { return !(*this == o); }
};
 
enum class Cea608XdsCgmsControl : uint8_t {
        CopyFree     = 0, 
        NoMoreCopies = 1, 
        CopyOnce     = 2, 
        CopyNever    = 3, 
};
 
enum class Cea608XdsApsControl : uint8_t {
        Off                 = 0, 
        PspOnly             = 1, 
        Psp2LineSplitBurst  = 2, 
        Psp4LineSplitBurst  = 3, 
};
 
struct Cea608XdsCgmsA {
                Cea608XdsCgmsControl         cgms = Cea608XdsCgmsControl::CopyFree;
                Optional<Cea608XdsApsControl> aps; 
                bool                          analogSourceBit = false;
                bool                          redistributionControl = false;
 
                bool operator==(const Cea608XdsCgmsA &o) const {
                        return cgms == o.cgms && aps == o.aps
                               && analogSourceBit == o.analogSourceBit
                               && redistributionControl == o.redistributionControl;
                }
                bool operator!=(const Cea608XdsCgmsA &o) const { return !(*this == o); }
};
 
struct Cea608XdsAspectRatio {
                uint8_t startLine = 0; 
                uint8_t endLine = 0;   
                bool    squeezed = false; 
 
                bool operator==(const Cea608XdsAspectRatio &o) const {
                        return startLine == o.startLine && endLine == o.endLine && squeezed == o.squeezed;
                }
                bool operator!=(const Cea608XdsAspectRatio &o) const { return !(*this == o); }
};
 
enum class Cea608XdsLanguage : uint8_t {
        Unknown = 0,
        English = 1,
        Spanish = 2,
        French  = 3,
        German  = 4,
        Italian = 5,
        Other   = 6,
        None    = 7,
};
 
enum class Cea608XdsMainAudioType : uint8_t {
        Unknown        = 0,
        Mono           = 1,
        SimulatedStereo = 2,
        TrueStereo     = 3,
        StereoSurround = 4,
        DataService    = 5,
        Other          = 6,
        None           = 7,
};
 
enum class Cea608XdsSecondAudioType : uint8_t {
        Unknown          = 0,
        Mono             = 1,
        VideoDescriptions = 2,
        NonProgramAudio   = 3,
        SpecialEffects   = 4,
        DataService      = 5,
        Other            = 6,
        None             = 7,
};
 
struct Cea608XdsAudioServices {
                Cea608XdsLanguage       mainLanguage = Cea608XdsLanguage::Unknown;
                Cea608XdsMainAudioType  mainType = Cea608XdsMainAudioType::Unknown;
                Cea608XdsLanguage       sapLanguage = Cea608XdsLanguage::Unknown;
                Cea608XdsSecondAudioType sapType = Cea608XdsSecondAudioType::Unknown;
 
                bool operator==(const Cea608XdsAudioServices &o) const {
                        return mainLanguage == o.mainLanguage && mainType == o.mainType
                               && sapLanguage == o.sapLanguage && sapType == o.sapType;
                }
                bool operator!=(const Cea608XdsAudioServices &o) const { return !(*this == o); }
};
 
struct Cea608XdsCaptionService {
                Cea608XdsLanguage language = Cea608XdsLanguage::Unknown;
                bool              fieldTwo = false; 
                bool              channelTwo = false; 
                bool              textMode = false; 
 
                bool operator==(const Cea608XdsCaptionService &o) const {
                        return language == o.language && fieldTwo == o.fieldTwo
                               && channelTwo == o.channelTwo && textMode == o.textMode;
                }
                bool operator!=(const Cea608XdsCaptionService &o) const { return !(*this == o); }
};
 
struct Cea608XdsTapeDelay {
                uint8_t hours = 0;
                uint8_t minutes = 0;
 
                bool operator==(const Cea608XdsTapeDelay &o) const {
                        return hours == o.hours && minutes == o.minutes;
                }
                bool operator!=(const Cea608XdsTapeDelay &o) const { return !(*this == o); }
};
 
struct Cea608XdsImpulseCaptureId {
                Cea608XdsProgramId     programId;
                uint8_t                lengthMinutes = 0;
                uint8_t                lengthHours = 0;
 
                bool operator==(const Cea608XdsImpulseCaptureId &o) const {
                        return programId == o.programId
                               && lengthMinutes == o.lengthMinutes
                               && lengthHours == o.lengthHours;
                }
                bool operator!=(const Cea608XdsImpulseCaptureId &o) const { return !(*this == o); }
};
 
struct Cea608XdsSupplementalDataLocation {
                bool    fieldTwo = false;
                uint8_t lineNumber = 0;
 
                bool operator==(const Cea608XdsSupplementalDataLocation &o) const {
                        return fieldTwo == o.fieldTwo && lineNumber == o.lineNumber;
                }
                bool operator!=(const Cea608XdsSupplementalDataLocation &o) const { return !(*this == o); }
};
 
struct Cea608XdsChannelMapHeader {
                uint16_t channelCount = 0; 
                uint8_t  version = 0;      
 
                bool operator==(const Cea608XdsChannelMapHeader &o) const {
                        return channelCount == o.channelCount && version == o.version;
                }
                bool operator!=(const Cea608XdsChannelMapHeader &o) const { return !(*this == o); }
};
 
struct Cea608XdsChannelMapPacket {
                uint16_t userChannel = 0; 
                bool     remapped = false; 
                uint16_t tuneChannel = 0; 
                String   channelId;       
 
                bool operator==(const Cea608XdsChannelMapPacket &o) const {
                        return userChannel == o.userChannel && remapped == o.remapped
                               && tuneChannel == o.tuneChannel && channelId == o.channelId;
                }
                bool operator!=(const Cea608XdsChannelMapPacket &o) const { return !(*this == o); }
};
 
struct Cea608XdsWrsame {
                String   eventCode;       
                uint8_t  countySlice = 0; 
                uint8_t  stateCode = 0;   
                uint16_t countyCode = 0;  
                uint8_t  durationQuarters = 0; 
 
                bool operator==(const Cea608XdsWrsame &o) const {
                        return eventCode == o.eventCode && countySlice == o.countySlice
                               && stateCode == o.stateCode && countyCode == o.countyCode
                               && durationQuarters == o.durationQuarters;
                }
                bool operator!=(const Cea608XdsWrsame &o) const { return !(*this == o); }
};
 
struct Cea608XdsCompositePacket1 {
                List<uint8_t>            programTypeKeywords;
                uint8_t                  contentAdvisoryByte1 = 0;
                uint8_t                  lengthMinutes = 0;
                uint8_t                  lengthHours = 0;
                uint8_t                  elapsedMinutes = 0;
                uint8_t                  elapsedHours = 0;
                String                   title;
 
                bool operator==(const Cea608XdsCompositePacket1 &o) const {
                        return programTypeKeywords == o.programTypeKeywords
                               && contentAdvisoryByte1 == o.contentAdvisoryByte1
                               && lengthMinutes == o.lengthMinutes
                               && lengthHours == o.lengthHours
                               && elapsedMinutes == o.elapsedMinutes
                               && elapsedHours == o.elapsedHours
                               && title == o.title;
                }
                bool operator!=(const Cea608XdsCompositePacket1 &o) const { return !(*this == o); }
};
 
struct Cea608XdsCompositePacket2 {
                Cea608XdsProgramId            programId;
                Cea608XdsAudioServices        audioServices;
                List<Cea608XdsCaptionService> captionServices;
                String                        callLetters;
                Optional<int>                 nativeChannel; 
                String                        networkName;
 
                bool operator==(const Cea608XdsCompositePacket2 &o) const {
                        return programId == o.programId
                               && audioServices == o.audioServices
                               && captionServices == o.captionServices
                               && callLetters == o.callLetters
                               && nativeChannel == o.nativeChannel
                               && networkName == o.networkName;
                }
                bool operator!=(const Cea608XdsCompositePacket2 &o) const { return !(*this == o); }
};
 
struct Cea608XdsTimeZone {
                int8_t utcOffsetHours = 0;  
                bool   observesDst = false; 
 
                bool operator==(const Cea608XdsTimeZone &o) const {
                        return utcOffsetHours == o.utcOffsetHours && observesDst == o.observesDst;
                }
                bool operator!=(const Cea608XdsTimeZone &o) const { return !(*this == o); }
};
 
struct Cea608XdsPacket {
                Cea608XdsClass class_ = Cea608XdsClass::Unknown;
                uint8_t type = 0;
                List<uint8_t> payload;
 
                bool isOutOfBand() const { return (type & 0x40) != 0; }
 
                String text() const;
 
                String programName() const;
 
                String networkName() const;
 
                String callLetters() const;
 
                Optional<int> nativeChannel() const;
 
                Optional<DateTime> timeOfDay() const;
 
                bool timeOfDayDstFlag() const;
 
                bool timeOfDayLeapYearFlag() const;
 
                bool timeOfDayTapeDelayFlag() const;
 
                bool timeOfDayZeroSecondsFlag() const;
 
                Optional<Cea608XdsContentAdvisory> contentAdvisory() const;
 
                Optional<Cea608XdsProgramId> programId() const;
 
                bool isProgramIdEndOfProgramSentinel() const;
 
                Optional<Cea608XdsProgramLength> programLength() const;
 
                List<uint8_t> programTypeKeywords() const;
 
                Optional<Cea608XdsAspectRatio> aspectRatio() const;
 
                Optional<Cea608XdsCgmsA> cgmsA() const;
 
                Optional<uint16_t> transmissionSignalId() const;
 
                Optional<Cea608XdsTimeZone> timeZone() const;
 
                Optional<Cea608XdsAudioServices> audioServices() const;
 
                List<Cea608XdsCaptionService> captionServices() const;
 
                Optional<Cea608XdsTapeDelay> tapeDelay() const;
 
                Optional<Cea608XdsImpulseCaptureId> impulseCaptureId() const;
 
                List<Cea608XdsSupplementalDataLocation> supplementalDataLocations() const;
 
                Optional<uint16_t> outOfBandChannel() const;
 
                Optional<uint16_t> channelMapPointer() const;
 
                Optional<Cea608XdsChannelMapHeader> channelMapHeader() const;
 
                Optional<Cea608XdsChannelMapPacket> channelMapPacket() const;
 
                Optional<Cea608XdsWrsame> wrsame() const;
 
                String nwsMessage() const;
 
                String programDescriptionRow() const;
 
                int programDescriptionRowIndex() const;
 
                Optional<Cea608XdsCompositePacket1> compositePacket1() const;
 
                Optional<Cea608XdsCompositePacket2> compositePacket2() const;
 
                static String programTypeName(uint8_t keywordByte);
 
                List<uint8_t> encode() const;
 
                bool operator==(const Cea608XdsPacket &o) const {
                        return class_ == o.class_ && type == o.type && payload == o.payload;
                }
                bool operator!=(const Cea608XdsPacket &o) const { return !(*this == o); }
};
 
uint8_t xdsStartByte(Cea608XdsClass cls);
 
uint8_t xdsContinueByte(Cea608XdsClass cls);
 
uint8_t xdsChecksum(uint32_t classAndType, uint32_t informational);
 
struct Cea608XdsExtractorImpl; // Pimpl — defined in cea608xds.cpp.
 
class Cea608XdsExtractor {
        public:
                static constexpr int MaxInFlight = 4;
 
                static constexpr int MaxPayloadBytes = 32;
 
                Cea608XdsExtractor();
 
                void reset();
 
                void processPair(uint8_t b1, uint8_t b2);
 
                void pushFrame(const Cea708Cdp::CcDataList &data);
 
                List<Cea608XdsPacket> drain();
 
                size_t pending() const;
 
                uint32_t checksumFailures() const;
 
                uint32_t oversizedPackets() const;
 
        private:
                SharedPtr<Cea608XdsExtractorImpl> _d;
};
 
PROMEKI_NAMESPACE_END
 
#endif // PROMEKI_ENABLE_PROAV