PPU.hpp

Go to the documentation of this file.

//
// Created by cbihan on 1/27/20.
//
 
#pragma once
 
#include <cstdint>
#include "Memory/AMemory.hpp"
#include "Memory/MemoryBus.hpp"
#include "Renderer/IRenderer.hpp"
#include "Ram/Ram.hpp"
#include "Models/Vector2.hpp"
#include <algorithm>
#include "Background.hpp"
#include "PPU/PPUUtils.hpp"
#include "PPU/PPURegisters.hpp"
 
#ifdef DEBUGGER_ENABLED
#include "Debugger/TileViewer/RAMTileRenderer.hpp"
#endif
 
#define FALLTHROUGH __attribute__((fallthrough));
 
namespace ComSquare::PPU::Utils
{
    struct PpuState;
}
 
namespace ComSquare::PPU
{
    static constexpr uint32_t VramSize = 65536;
    static constexpr uint32_t CGRamSize = 512;
    static constexpr uint32_t OAMRamSize = 544;
 
 
    class Background;
    enum BgName {
        Background1 = 0,
        Background2,
        Background3,
        Background4
    };
 
    class PPU : public Memory::AMemory {
    public:
        Ram::Ram vram;
        Ram::Ram oamram;
        Ram::Ram cgram;
    private:
        Registers _registers{};
        Renderer::IRenderer &_renderer;
        Background _backgrounds[4];
        std::array<std::array<uint32_t, 1024>, 1024> _mainScreen;
        std::array<std::array<uint8_t, 1024>, 1024> _mainScreenLevelMap;
        std::array<std::array<uint8_t, 1024>, 1024> _subScreenLevelMap;
        std::array<std::array<uint32_t, 1024>, 1024> _subScreen;
        std::array<std::array<uint32_t, 1024>, 1024> _screen;
        uint16_t _vramReadBuffer = 0;
        struct Utils::PpuState _ppuState;
 
    public:
 
        explicit PPU(Renderer::IRenderer &renderer);
        PPU(const PPU &) = delete;
        ~PPU() override = default;
        PPU &operator=(const PPU &) = delete;
 
        uint8_t read(uint24_t addr) override;
        void write(uint24_t addr, uint8_t data) override;
        [[nodiscard]] std::string getName() const override;
        [[nodiscard]] Component getComponent() const override;
        [[nodiscard]] uint24_t getSize() const override;
 
        virtual void update(unsigned cycles);
        [[nodiscard]] uint16_t getVramAddress() const;
        [[nodiscard]] std::string getValueName(uint24_t addr) const override;
        uint16_t cgramRead(uint16_t addr);
        [[nodiscard]] int getBPP(int bgNumber) const;
        [[nodiscard]] Vector2<int> getCharacterSize(int bgNumber) const;
        [[nodiscard]] uint16_t getTileMapStartAddress(int bgNumber) const;
        [[nodiscard]] uint16_t getTilesetAddress(int bgNumber) const;
        [[nodiscard]] Vector2<bool> getBackgroundMirroring(int bgNumber) const;
        void renderMainAndSubScreen();
        template<int levelLow, int levelHigh>
        void addToMainSubScreen(Background &bg)
        {
            if (this->_registers._t[0].raw & (1U << (bg.getBgNumber() - 1U))) {
                Background::mergeBackgroundBuffer<levelLow, levelHigh>(this->_mainScreen, this->_mainScreenLevelMap, bg);
            }
            if (this->_registers._t[1].raw & (1U << (bg.getBgNumber() - 1U))) {
                Background::mergeBackgroundBuffer<levelLow, levelHigh>(this->_subScreen, this->_subScreenLevelMap, bg);
            }
        }
        [[nodiscard]] int getBgMode() const;
        void updateVramReadBuffer();
        [[nodiscard]] Vector2<int> getBgScroll(int bgNumber) const;
        [[nodiscard]] const Registers &getWriteRegisters() const;
    };
}