subtitle.h

Go to the documentation of this file.

 
#pragma once
 
 
#include <promeki/config.h>
#if PROMEKI_ENABLE_PROAV
#include <cstdint>
#include <promeki/color.h>
#include <promeki/enums.h>
#include <promeki/error.h>
#include <promeki/list.h>
#include <promeki/namespace.h>
#include <promeki/rect.h>
#include <promeki/sharedptr.h>
#include <promeki/string.h>
#include <promeki/timestamp.h>
 
PROMEKI_NAMESPACE_BEGIN
 
class DataStream;
class FrameRate;
class JsonObject;
class Metadata;
class SubtitleList;
struct SubtitleImpl;     // Pimpl — defined in subtitle.cpp.
struct SubtitleSpanImpl; // Pimpl — defined in subtitle.cpp.
 
class SubtitleSpan {
        public:
                // -- Construction / destruction (out-of-line for pimpl) ---
 
                SubtitleSpan();
 
                explicit SubtitleSpan(String text);
 
                SubtitleSpan(String text, bool bold, bool italic, bool underline, Color color = Color());
 
                SubtitleSpan(const SubtitleSpan &);
                SubtitleSpan(SubtitleSpan &&) noexcept;
                ~SubtitleSpan();
                SubtitleSpan &operator=(const SubtitleSpan &);
                SubtitleSpan &operator=(SubtitleSpan &&) noexcept;
 
                // -- Read-only accessors ----------------------------------
 
                const String &text() const;
 
                bool bold() const;
 
                bool italic() const;
 
                bool underline() const;
 
                const Color &color() const;
 
                const Color &backgroundColor() const;
 
                const Color &edgeColor() const;
 
                const SubtitleEdgeStyle &edgeStyle() const;
 
                const SubtitleFontFace &fontFace() const;
 
                const SubtitleOpacity &foregroundOpacity() const;
 
                const SubtitleOpacity &backgroundOpacity() const;
 
                const SubtitleOpacity &edgeOpacity() const;
 
                bool hasStyle() const;
 
                bool isEmpty() const;
 
                // -- CoW mutators -----------------------------------------
 
                void setText(String v);
                void setBold(bool v);
                void setItalic(bool v);
                void setUnderline(bool v);
                void setColor(const Color &v);
                void setBackgroundColor(const Color &v);
                void setEdgeColor(const Color &v);
                void setEdgeStyle(const SubtitleEdgeStyle &v);
                void setFontFace(const SubtitleFontFace &v);
                void setForegroundOpacity(const SubtitleOpacity &v);
                void setBackgroundOpacity(const SubtitleOpacity &v);
                void setEdgeOpacity(const SubtitleOpacity &v);
 
                // -- Comparison + diagnostics -----------------------------
 
                bool operator==(const SubtitleSpan &o) const;
                bool operator!=(const SubtitleSpan &o) const { return !(*this == o); }
 
                JsonObject toJson() const;
 
                String toString() const;
 
                using List = ::promeki::List<SubtitleSpan>;
 
        private:
                SharedPtr<SubtitleSpanImpl> _d;
};
 
DataStream &operator<<(DataStream &stream, const SubtitleSpan &span);
 
DataStream &operator>>(DataStream &stream, SubtitleSpan &span);
 
class Subtitle {
        public:
                PROMEKI_DATATYPE(Subtitle, DataTypeSubtitle, 1)
 
                // -- Construction / destruction (out-of-line for pimpl) ---
 
                
                Subtitle();
 
                Subtitle(TimeStamp start, TimeStamp end, String text,
                         SubtitleAnchor anchor = SubtitleAnchor::Default);
 
                Subtitle(TimeStamp start, TimeStamp end, String text, SubtitleAnchor anchor, Rect2Di32 region,
                         String speaker, Metadata metadata);
 
                Subtitle(TimeStamp start, TimeStamp end, SubtitleSpan::List spans, SubtitleAnchor anchor,
                         Rect2Di32 region, String speaker, Metadata metadata);
 
                Subtitle(const Subtitle &);
                Subtitle(Subtitle &&) noexcept;
                ~Subtitle();
                Subtitle &operator=(const Subtitle &);
                Subtitle &operator=(Subtitle &&) noexcept;
 
                // -- Read-only accessors ----------------------------------
 
                const TimeStamp &start() const;
 
                const TimeStamp &end() const;
 
                TimeStamp::Duration duration() const;
 
                const String &text() const;
 
                const SubtitleSpan::List &spans() const;
 
                const SubtitleAnchor &anchor() const;
 
                const CaptionMode &mode() const;
 
                int rollUpRows() const;
 
                const Rect2Di32 &region() const;
 
                const String &speaker() const;
 
                const Metadata &metadata() const;
 
                // -- CoW mutators -----------------------------------------
 
                void setStart(const TimeStamp &v);
                void setEnd(const TimeStamp &v);
 
                void setText(const String &v);
 
                void setSpans(SubtitleSpan::List v);
 
                void setAnchor(const SubtitleAnchor &v);
                void setMode(const CaptionMode &v);
                void setRollUpRows(int v);
                void setRegion(const Rect2Di32 &v);
                void setSpeaker(const String &v);
                void setMetadata(const Metadata &v);
 
                // -- Layout helpers ---------------------------------------
 
                Subtitle wrapped(int maxCols, int maxRows) const;
 
                // -- Predicates -------------------------------------------
 
                bool isEmpty() const;
 
                bool isActiveAt(const TimeStamp &t) const;
 
                // -- Comparison + diagnostics -----------------------------
 
                bool operator==(const Subtitle &o) const;
                bool operator!=(const Subtitle &o) const { return !(*this == o); }
 
                JsonObject toJson() const;
 
                String toString() const;
 
                Error writeToStream(DataStream &s) const;
 
                template <uint32_t V> static Result<Subtitle> readFromStream(DataStream &s);
 
        private:
                SharedPtr<SubtitleImpl> _d;
};
 
// ============================================================================
// SubtitleList
// ============================================================================
 
struct SubtitleListImpl; // Pimpl — defined in subtitle.cpp.
 
class SubtitleList {
        public:
                // -- Construction / destruction (out-of-line for pimpl) ---
 
                SubtitleList();
                explicit SubtitleList(List<Subtitle> entries);
                SubtitleList(const SubtitleList &);
                SubtitleList(SubtitleList &&) noexcept;
                ~SubtitleList();
                SubtitleList &operator=(const SubtitleList &);
                SubtitleList &operator=(SubtitleList &&) noexcept;
 
                // -- Size / access ----------------------------------------
 
                size_t size() const;
                bool   isEmpty() const;
 
                const Subtitle &at(size_t i) const;
 
                const Subtitle &operator[](size_t i) const;
 
                // -- Mutators (CoW) ---------------------------------------
 
                void append(const Subtitle &s);
 
                void clear();
 
                void sortByStart();
 
                void reserve(size_t n);
 
                // -- Search helpers ---------------------------------------
 
                int64_t findActiveAt(const TimeStamp &t) const;
 
                int64_t findNextAfter(const TimeStamp &t) const;
 
                SubtitleList findInRange(const TimeStamp &start, const TimeStamp &end) const;
 
                SubtitleList snapToFrames(const FrameRate &frameRate) const;
 
                // -- Raw access -------------------------------------------
 
                const List<Subtitle> &entries() const;
 
                // -- Comparison + diagnostics -----------------------------
 
                bool operator==(const SubtitleList &o) const;
                bool operator!=(const SubtitleList &o) const { return !(*this == o); }
 
                JsonObject toJson() const;
 
                String toString() const;
 
        private:
                SharedPtr<SubtitleListImpl> _d;
};
 
PROMEKI_NAMESPACE_END
 
#endif // PROMEKI_ENABLE_PROAV