YiClosedCaptionsRenderer.h

Go to the documentation of this file.

#ifndef _YI_CLOSED_CAPTIONS_RENDERER_H_
#define _YI_CLOSED_CAPTIONS_RENDERER_H_

#include "player/YiClosedCaptionsStylingBridge.h"
#include "scenetree/YiTextSceneNode.h"
#include "utility/YiColor.h"
#include "utility/YiString.h"

class IYIClosedCaptionsRenderer
{
public:
    enum TEXT_ANCHOR_POINT
    {
        TOP_LEFT_OF_TEXT,
        TOP_LEFT_OF_BOX,
        CENTER
    };

    enum TEXT_HORIZONTAL_ALIGNMENT
    {
        ALIGN_LEFT,
        ALIGN_CENTER,
        ALIGN_RIGHT
    };

    enum TEXT_VERTICAL_ALIGNMENT
    {
        ALIGN_VERTICALLY_TOP,
        ALIGN_VERTICALLY_CENTER,
        ALIGN_VERTICALLY_BOTTOM
    };

    enum LIFETIME
    {
        UNTIL_NEXT_BEGIN, 
        UNTIL_REMOVED 
    };

    struct Span
    {
        Span();

        CYIString text;

        CYIString fontFamily;
        bool bItalic; 
        bool bBold; 
        bool bUnderline; 
        float fFontSize; 

        CYIColor fontColor; 
        CYIColor characterBackgroundColor; 
    };

    struct Cue
    {
        Cue();

        CYIString GetText() const;

        void RestyleCue(const CYIClosedCaptionsStylingBridge::Style &userStyle, float fVideoHeight);

        std::vector<CYITextSceneNode::YI_TEXT_STYLE_DEF> GenerateTextSceneNodeStyles() const;


        std::vector<Span> spans; 

        CYIColor windowColor; 

        glm::vec2 position; 
        TEXT_ANCHOR_POINT eAnchorPoint; 
        TEXT_HORIZONTAL_ALIGNMENT eHorizontalAlignment; 
        TEXT_VERTICAL_ALIGNMENT eVerticalAlignment; 

        float fTextWidth; 
        float fTextHeight; 

        LIFETIME eLifetime; 
        uint64_t uExpirationTimeMs; 
    };
    
    virtual ~IYIClosedCaptionsRenderer() {}

    virtual void Clear() = 0;

    virtual void Begin() = 0;

    virtual void End() = 0;
    
    virtual void AddCue(const Cue &cue) = 0;

    virtual void RemoveCues(const CYIString &cueText) = 0;

    virtual void OnVideoTimeUpdated(uint64_t uVideoTimeMs) = 0;
};

#endif