TRenderer.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
// Module:        CTRenderer
// Description:   Implements the VT100 display pipeline on top of Circle primitives.
// Author:        R. Zuehlsdorff, ralf.zuehlsdorff@t-online.de
// Created:       2026-01-18
// License:       MIT License (https://opensource.org/license/mit/)
//------------------------------------------------------------------------------
// Change Log:
// 2026-01-18     R. Zuehlsdorff        Initial creation
//------------------------------------------------------------------------------
 
 
#pragma once
 
 
// Include Circle core components
#include <circle/sched/task.h>
#include <circle/device.h>
#include <circle/display.h>
#include <circle/string.h>
#include <circle/chargenerator.h>
#include <circle/bcmframebuffer.h>
#include <circle/spinlock.h>
#include <circle/types.h>
 
// Forward declarations and includes for classes used in this module
#include "TColorPalette.h"
#include "TFontConverter.h"
 
class CTRenderer : public CDevice, public CTask
{
public:
    // Define realistic vintage terminal colors
    // static constexpr TRendererColor kColorBlack = DISPLAY_COLOR(12, 12, 12);
    static constexpr TRendererColor kColorBlack = DISPLAY_COLOR(0, 0, 0);
    static constexpr TRendererColor kColorWhite = DISPLAY_COLOR(235, 235, 235);
    static constexpr TRendererColor kColorAmber = DISPLAY_COLOR(255, 176, 0);
    static constexpr TRendererColor kColorGreen = DISPLAY_COLOR(51, 255, 51);
 
    struct TRendererState
    {
        const TFont *font;
        CCharGenerator::TFontFlags fontFlags;
        CDisplay::TRawColor foreground;
        CDisplay::TRawColor background;
        CDisplay::TRawColor defaultForeground;
        CDisplay::TRawColor defaultBackground;
        unsigned cursorX;
        unsigned cursorY;
        boolean cursorOn;
        boolean cursorBlock;
        boolean cursorVisible;
        boolean blinking;
        unsigned blinkTicks;
        unsigned nextBlink;
        unsigned scrollStart;
        unsigned scrollEnd;
        boolean reverseAttribute;
        boolean boldAttribute;
        boolean underlineAttribute;
        boolean blinkAttribute;
        boolean insertOn;
        boolean autoPage;
        boolean delayedUpdate;
        unsigned lastUpdateTicks;
        unsigned parserState;
        unsigned param1;
        unsigned param2;
        unsigned g0CharSet;
        unsigned g1CharSet;
        boolean useG1;
    };
 
    static CTRenderer *Get(void);
 
    CTRenderer(void);
 
    ~CTRenderer(void);
 
    boolean Initialize(void);
 
    boolean SetFont(const TFont &rFont,
                    CCharGenerator::TFontFlags FontFlags = CCharGenerator::FontFlagsNone);
 
    boolean SetFont(EFontSelection selection,
                    CCharGenerator::TFontFlags FontFlags = CCharGenerator::FontFlagsNone);
 
    TRendererColor MapColor(EColorSelection color);
 
    
 
    unsigned GetWidth(void) const;
 
    unsigned GetHeight(void) const;
 
    unsigned GetColumns(void) const;
    unsigned GetRows(void) const;
 
    unsigned GetCursorColumn(void) const;
    unsigned GetCursorRow(void) const;
 
    CBcmFrameBuffer *GetDisplay(void);
 
    void ClearDisplay(void);
 
    int Write(const void *pBuffer, size_t nCount) override;
 
    void ResetParserState(void);
 
    void Goto(unsigned nRow, unsigned nColumn);
 
    void SetPixel(unsigned nPosX, unsigned nPosY, TRendererColor Color);
 
    void SetPixel(unsigned nPosX, unsigned nPosY, CDisplay::TRawColor nColor);
 
    TRendererColor GetPixel(unsigned nPosX, unsigned nPosY);
 
    boolean SetColors(EColorSelection Foreground, EColorSelection Background);
 
    void SetColors(TRendererColor Foreground = kColorWhite, TRendererColor Background = kColorBlack);
 
    void SetCursorBlock(boolean bCursorBlock);
 
    void SetBlinkingCursor(boolean bBlinkingCursor, unsigned nPeriodMilliSeconds = 500);
 
    void Update(void);
    
    void SetCursorMode(boolean bVisible);
 
    void SetVT52Mode(boolean bEnable);
 
    void SetAutoPageMode(boolean bEnable);
 
    void SetSmoothScrollEnabled(boolean bEnable);
 
    boolean GetSmoothScrollEnabled(void) const { return m_bSmoothScrollEnabled; }
 
    void ForceHideCursor(void);
 
 
    void Run(void) override;
 
    void SetRawPixel(unsigned nPosX, unsigned nPosY, CDisplay::TRawColor nColor);
 
    CDisplay::TRawColor GetRawPixel(unsigned nPosX, unsigned nPosY);
 
    CDisplay::TColor AdjustBrightness(CDisplay::TColor color, float factor);
 
    CDisplay::TRawColor AdjustBrightness565(CDisplay::TRawColor color, float factor);
 
    void SetBrightnessScaling(float boldFactor = 1.6f,
        float reverseBackgroundFactor = 0.7f,
        float reverseForegroundFactor = 1.25f);
 
    void doRenderTest(void);
 
    void SaveState(TRendererState &state);
 
    void RestoreState(const TRendererState &state);
 
    size_t GetBufferSize(void) const;
 
    void SaveScreenBuffer(void *buffer, size_t bufferSize);
 
    void RestoreScreenBuffer(const void *buffer, size_t bufferSize);
 
 
private:
    void Write(char chChar);
 
    void CarriageReturn(void);
    void ClearDisplayEnd(void);
    void ClearLineEnd(void);
    void CursorDown(void);
    void CursorHome(void);
    void CursorLeft(void);
    void CursorMove(unsigned nRow, unsigned nColumn);
    void CursorRight(void);
    void CursorUp(void);
    void DeleteChars(unsigned nCount);
    void DeleteLines(unsigned nCount);
    void DisplayChar(char chChar);
    void EraseChars(unsigned nCount);
    CDisplay::TRawColor GetTextBackgroundColor(void);
    CDisplay::TRawColor GetTextColor(void);
    void InsertLines(unsigned nCount);
    void InsertMode(boolean bBegin);
    void NewLine(void);
    void ReverseScroll(void);
 
    void SetScrollRegion(unsigned nStartRow, unsigned nEndRow);
    void SetStandoutMode(unsigned nMode);
    void Tabulator(void);
    void BackTabulator(void);
 
    void SaveCursor(void);
 
    void RestoreCursor(void);
 
    void Scroll(void);
    boolean BeginSmoothScrollAnimation(unsigned nStartY, unsigned nEndY, boolean bScrollDown);
    void RenderSmoothScrollFrame(void);
 
    void DisplayChar(char chChar, unsigned nPosX, unsigned nPosY, CDisplay::TRawColor nColor);
    void EraseChar(unsigned nPosX, unsigned nPosY);
    void InvertCursor(void);
 
 
    // We always update entire pixel lines.
    void SetUpdateArea(unsigned nPosY1, unsigned nPosY2)
    {
        if (nPosY1 < m_UpdateArea.y1)
        {
            m_UpdateArea.y1 = nPosY1;
        }
 
        if (nPosY2 > m_UpdateArea.y2)
        {
            m_UpdateArea.y2 = nPosY2;
        }
    }
 
    enum TState
    {
        StateStart,
        StateEscape,
        StateVT52Row,
        StateVT52Col,
        StateBracket,
        StateNumber1,
        StateQuestionMark,
        StateSemicolon,
        StateNumber2,
        StateNumber3,
        StateAutoPage,
        StateFontChange,
        StateSkipTillCRLF,
        StateG0,
        StateG1
    };
 
    enum ECharacterSet
    {
        CharSetUS,
        CharSetGraphics
    };
 
    const TFont *m_pFont;
    CCharGenerator::TFontFlags m_FontFlags;
    CCharGenerator *m_pCharGen;
    CCharGenerator *m_pGraphicsCharGen;
    EFontSelection m_CurrentFontSelection;
 
    ECharacterSet m_G0CharSet;
    ECharacterSet m_G1CharSet;
    boolean m_bUseG1;
 
    CDisplay::TRawColor *m_pCursorPixels;
    union
    {
        u8 *m_pBuffer8;
        u16 *m_pBuffer16;
        u32 *m_pBuffer32;
    };
    CBcmFrameBuffer *m_pFrameBuffer;
    unsigned m_nDisplayIndex;
    unsigned m_nSize;
    unsigned m_nPitch;
    unsigned m_nWidth;
    unsigned m_nHeight;
    unsigned m_nUsedWidth;
    unsigned m_nUsedHeight;
    unsigned m_nDepth;
    CDisplay::TArea m_UpdateArea;
    TState m_State;
    unsigned m_nScrollStart;
    unsigned m_nScrollEnd;
    unsigned m_nCursorX;
    unsigned m_nCursorY;
    boolean m_bCursorOn;
    boolean m_bCursorBlock;
    boolean m_bBlinkingCursor;
    boolean m_bCursorVisible;
    unsigned m_nCursorBlinkPeriodTicks;
    unsigned m_nNextCursorBlink;
    CDisplay::TRawColor m_ForegroundColor;
    CDisplay::TRawColor m_BackgroundColor;
    CDisplay::TRawColor m_DefaultForegroundColor;
    CDisplay::TRawColor m_DefaultBackgroundColor;
    float m_BoldScaleFactor;
    float m_DimScaleFactor;
    float m_ReverseBackgroundScaleFactor;
    float m_ReverseForegroundScaleFactor;
    boolean m_bReverseAttribute;
    boolean m_bBoldAttribute;
    boolean m_bDimAttribute;
    boolean m_bUnderlineAttribute;
    boolean m_bBlinkAttribute;
    boolean m_bInsertOn;
    boolean m_bVT52Mode;
    unsigned m_nParam1;
    unsigned m_nParam2;
    boolean m_bAutoPage;
    boolean m_bDelayedUpdate;
    unsigned m_nLastUpdateTicks;
    boolean m_bSmoothScrollEnabled;
    boolean m_bSmoothScrollActive;
    boolean m_bSmoothScrollDown;
    unsigned m_nSmoothScrollStartY;
    unsigned m_nSmoothScrollEndY;
    unsigned m_nSmoothScrollOffset;
    unsigned m_nSmoothScrollStep;
    unsigned m_nSmoothScrollLastTick;
    unsigned m_nSmoothScrollTickInterval;
    u8 *m_pSmoothScrollSnapshot;
    u8 *m_pSmoothScrollCompose;
    size_t m_nSmoothScrollBufferSize;
    unsigned m_nSmoothScrollStartTick;
    unsigned  m_nSmoothScrollDebounceUntil; // tick until which we suppress smooth to avoid bursts
    unsigned m_nScrollStatsLastLogTick;
    unsigned long long m_ScrollNormalTicksAccum;
    unsigned long long m_ScrollSmoothTicksAccum;
    unsigned m_ScrollNormalCount;
    unsigned m_ScrollSmoothCount;
    TRendererState m_SavedState;
    mutable CSpinLock m_SpinLock;
};