ancframesync.h

Go to the documentation of this file.

 
#pragma once
 
 
#include <promeki/config.h>
#if PROMEKI_ENABLE_PROAV
#include <promeki/namespace.h>
#include <promeki/ancpacket.h>
#include <promeki/anctranslateconfig.h>
#include <promeki/anctranslator.h>
#include <promeki/ancformat.h>
#include <promeki/frame.h>
#include <promeki/framesyncdisposition.h>
#include <promeki/list.h>
#include <promeki/map.h>
#include <promeki/result.h>
#include <promeki/set.h>
 
PROMEKI_NAMESPACE_BEGIN
 
class AncFrameSync {
        public:
                AncFrameSync() = default;
 
                explicit AncFrameSync(AncTranslateConfig cfg) : _translator(std::move(cfg)) {}
 
                const AncTranslateConfig &config() const { return _translator.config(); }
 
                void setConfig(AncTranslateConfig cfg) { _translator.setConfig(std::move(cfg)); }
 
                Result<::promeki::List<Frame>> apply(Frame in, FrameSyncDisposition disposition);
 
                size_t stashedPacketCount() const;
 
        private:
                // Walks `frame`'s payload list and dispatches every ANC packet
                // through AncTranslator::applySyncPolicy with the given
                // disposition + repeatIndex.  Mutates the frame in place via
                // CoW: detaches the Frame::Data, then detaches each
                // AncPayload::Ptr via .modify(), then replaces the packet
                // list with the policy's output.  Non-ANC payloads are
                // untouched, so a downstream observer can verify that
                // VideoPayload / AudioPayload entries are still aliased
                // across repeats.
                Error applyToFrame(Frame &frame, FrameSyncDisposition disposition, uint8_t repeatIndex);
 
                // Logs a once-per-format warning the first time we see an ANC
                // packet whose format has no registered SyncPolicy.  The
                // dedupe set is per-instance, matching the spec.
                void warnFallbackOnce(AncFormat::ID id, const String &name);
 
                // Walks every ANC packet on the (read-only) input frame and
                // dispatches each through applySyncPolicy with disposition
                // = Drop.  Any packets the per-format policy returns
                // (SCTE-104 cues, etc.) are stuffed into the stash.
                Error applyDropAndStash(const Frame &frame);
 
                // Latest-wins insert into the stash, keyed on the input
                // packet's format.  When a Drop policy returns multiple
                // packets they all stash atomically under that format
                // (next Play emits all of them).  A second Drop hitting the
                // same format replaces the previously-stashed list and
                // warns once.
                void stashPackets(AncFormat::ID id, const AncPacket::List &pkts);
 
                // Appends every stashed packet to @p frame's first AncPayload
                // (creating an empty AncPayload on the frame if none exists).
                // Clears the stash on completion.  No-op when the stash is
                // empty.
                void drainStashInto(Frame &frame);
 
                AncTranslator                                       _translator;
                Set<AncFormat::ID>                                  _fallbackWarned;
                Map<AncFormat::ID, AncPacket::List>      _stash;
};
 
PROMEKI_NAMESPACE_END
 
#endif // PROMEKI_ENABLE_PROAV