subtitleburnmediaio.h

Go to the documentation of this file.

 
#pragma once
 
 
#include <promeki/config.h>
#if PROMEKI_ENABLE_PROAV
#include <promeki/anctranslator.h>
#include <promeki/captiondecoder.h>
#include <promeki/enumlist.h>
#include <promeki/enums.h>
#include <promeki/list.h>
#include <promeki/mediaiofactory.h>
#include <promeki/namespace.h>
#include <promeki/sharedthreadmediaio.h>
#include <promeki/string.h>
#include <promeki/subtitlerenderer.h>
#include <promeki/uniqueptr.h>
 
PROMEKI_NAMESPACE_BEGIN
 
class SubtitleBurnMediaIO : public SharedThreadMediaIO {
                PROMEKI_OBJECT(SubtitleBurnMediaIO, SharedThreadMediaIO)
        public:
                static inline const MediaIOStats::ID StatsFramesPainted{"FramesPainted"};
 
                SubtitleBurnMediaIO(ObjectBase *parent = nullptr);
                ~SubtitleBurnMediaIO() override;
 
                Error proposeInput(const MediaDesc &offered, MediaDesc *preferred) const override;
                Error proposeOutput(const MediaDesc &requested, MediaDesc *achievable,
                                    MediaConfig *configDelta = nullptr) const override;
                int   pendingInternalWrites() const override;
 
        protected:
                Error executeCmd(MediaIOCommandOpen &cmd) override;
                Error executeCmd(MediaIOCommandClose &cmd) override;
                Error executeCmd(MediaIOCommandRead &cmd) override;
                Error executeCmd(MediaIOCommandWrite &cmd) override;
                Error executeCmd(MediaIOCommandStats &cmd) override;
 
        private:
                Error burnFrame(const Frame &input, Frame &output);
 
                Subtitle pickCue(const Frame &input);
 
                bool sourceEnabled(const SubtitleSource &src) const;
 
                Subtitle tryMetadataSource(const Frame &input);
 
                Subtitle tryAncSource(const Frame &input, CaptionCodec codec);
 
                SubtitleRenderer _renderer;
                bool             _enabled = false;
                EnumList         _sources; 
                int              _capacity = 4;
 
                Frame::List _outputQueue;
                FrameCount  _frameCount{0};
                int64_t     _readCount = 0;
                FrameCount  _framesPainted{0};
                bool        _capacityWarned = false;
                bool        _notPaintableWarned = false;
 
                // Lazily-constructed ANC helpers (only used when the
                // corresponding @c SubtitleSource is listed in
                // @c VideoSubtitleBurnSources).  Translator is a plain
                // value shared across both decoders; each decoder is
                // stateful and pimpl'd.  One @ref CaptionDecoder per
                // codec rides in @c _ancDecoders, looked up by
                // @ref CaptionDecoder::codec.
                AncTranslator           _ancTranslator;
                CaptionDecoder::PtrList _ancDecoders;
};
 
class SubtitleBurnFactory : public MediaIOFactory {
        public:
                SubtitleBurnFactory() = default;
 
                String name() const override { return String("SubtitleBurn"); }
                String displayName() const override { return String("Subtitle Burn-in"); }
                String description() const override {
                        return String("Renders the active Metadata::Subtitle cue (or a CEA-608 ANC-decoded "
                                      "cue) onto each video frame.");
                }
                bool canBeTransform() const override { return true; }
 
                Config::SpecMap configSpecs() const override;
                MediaIO        *create(const Config &config, ObjectBase *parent = nullptr) const override;
};
 
PROMEKI_NAMESPACE_END
 
#endif // PROMEKI_ENABLE_PROAV