summaryrefslogtreecommitdiffstats
path: root/src/LcdController.php
blob: 9e2015de42f44b88fc95cb859c4e19f28caab136 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
<?php

namespace GameBoy;

class LcdController
{
    //Actual scan line...
    public $actualScanLine = 0;

    protected $core;

    //Is the emulated LCD controller on?
    public $LCDisOn = false;

    //Should we trigger an interrupt if LY==LYC?
    public $LYCMatchTriggerSTAT = false;

    //The scan line mode (for lines 1-144 it's 2-3-0, for 145-154 it's 1)
    public $modeSTAT = 0;

    //Should we trigger an interrupt if in mode 0?
    public $mode0TriggerSTAT = false;

    //Should we trigger an interrupt if in mode 1?
    public $mode1TriggerSTAT = false;

    //Should we trigger an interrupt if in mode 2?
    public $mode2TriggerSTAT = false;

    //Tracker for STAT triggering.
    public $STATTracker = 0;

    public function __construct($core)
    {
        $this->core = $core;
    }

    public function matchLYC()
    {
        // LY - LYC Compare
        // If LY==LCY
        if ($this->core->memory[0xFF44] == $this->core->memory[0xFF45]) {
            $this->core->memory[0xFF41] |= 0x04; // set STAT bit 2: LY-LYC coincidence flag
            if ($this->LYCMatchTriggerSTAT) {
                $this->core->memory[0xFF0F] |= 0x2; // set IF bit 1
            }
        } else {
            $this->core->memory[0xFF41] &= 0xFB; // reset STAT bit 2 (LY!=LYC)
        }
    }

    public function notifyScanline()
    {
        if ($this->actualScanLine == 0) {
            $this->core->windowSourceLine = 0;
        }
        // determine the left edge of the window (160 if window is inactive)
        $windowLeft = ($this->core->gfxWindowDisplay && $this->core->memory[0xFF4A] <= $this->actualScanLine) ? min(160, $this->core->memory[0xFF4B] - 7) : 160;
        // step 1: background+window
        $skippedAnything = $this->core->drawBackgroundForLine($this->actualScanLine, $windowLeft, 0);
        // At this point, the high (alpha) byte in the frameBuffer is 0xff for colors 1,2,3 and
        // 0x00 for color 0. Foreground sprites draw on all colors, background sprites draw on
        // top of color 0 only.
        // step 2: sprites
        $this->core->drawSpritesForLine($this->actualScanLine);
        // step 3: prio tiles+window
        if ($skippedAnything) {
            $this->core->drawBackgroundForLine($this->actualScanLine, $windowLeft, 0x80);
        }
        if ($windowLeft < 160) {
            ++$this->core->windowSourceLine;
        }
    }

    /**
     * Scan Line and STAT Mode Control
     * @param  int $line Memory Scanline
     */
    public function scanLine($line)
    {
        //When turned off = Do nothing!
        if ($this->LCDisOn) {
            if ($line < 143) {
                //We're on a normal scan line:
                if ($this->core->LCDTicks < 20) {
                    $this->scanLineMode2(); // mode2: 80 cycles
                } elseif ($this->core->LCDTicks < 63) {
                    $this->scanLineMode3(); // mode3: 172 cycles
                } elseif ($this->core->LCDTicks < 114) {
                    $this->scanLineMode0(); // mode0: 204 cycles
                } else {
                    //We're on a new scan line:
                    $this->core->LCDTicks -= 114;
                    $this->actualScanLine = ++$this->core->memory[0xFF44];
                    $this->matchLYC();
                    if ($this->STATTracker != 2) {
                        if ($this->core->hdmaRunning && !$this->core->halt && $this->LCDisOn) {
                            $this->core->performHdma(); //H-Blank DMA
                        }
                        if ($this->mode0TriggerSTAT) {
                            $this->core->memory[0xFF0F] |= 0x2; // set IF bit 1
                        }
                    }
                    $this->STATTracker = 0;
                    $this->scanLineMode2(); // mode2: 80 cycles
                    if ($this->core->LCDTicks >= 114) {
                        //We need to skip 1 or more scan lines:
                        $this->core->notifyScanline();
                        $this->scanLine($this->actualScanLine); //Scan Line and STAT Mode Control
                    }
                }
            } elseif ($line == 143) {
                //We're on the last visible scan line of the LCD screen:
                if ($this->core->LCDTicks < 20) {
                    $this->scanLineMode2(); // mode2: 80 cycles
                } elseif ($this->core->LCDTicks < 63) {
                    $this->scanLineMode3(); // mode3: 172 cycles
                } elseif ($this->core->LCDTicks < 114) {
                    $this->scanLineMode0(); // mode0: 204 cycles
                } else {
                    //Starting V-Blank:
                    //Just finished the last visible scan line:
                    $this->core->LCDTicks -= 114;
                    $this->actualScanLine = ++$this->core->memory[0xFF44];
                    $this->matchLYC();
                    if ($this->mode1TriggerSTAT) {
                        $this->core->memory[0xFF0F] |= 0x2; // set IF bit 1
                    }
                    if ($this->STATTracker != 2) {
                        if ($this->core->hdmaRunning && !$this->core->halt && $this->LCDisOn) {
                            $this->core->performHdma(); //H-Blank DMA
                        }
                        if ($this->mode0TriggerSTAT) {
                            $this->core->memory[0xFF0F] |= 0x2; // set IF bit 1
                        }
                    }
                    $this->STATTracker = 0;
                    $this->modeSTAT = 1;
                    $this->core->memory[0xFF0F] |= 0x1; // set IF flag 0
                    //LCD off takes at least 2 frames.
                    if ($this->core->drewBlank > 0) {
                        --$this->core->drewBlank;
                    }
                    if ($this->core->LCDTicks >= 114) {
                        //We need to skip 1 or more scan lines:
                        $this->scanLine($this->actualScanLine); //Scan Line and STAT Mode Control
                    }
                }
            } elseif ($line < 153) {
                //In VBlank
                if ($this->core->LCDTicks >= 114) {
                    //We're on a new scan line:
                    $this->core->LCDTicks -= 114;
                    $this->actualScanLine = ++$this->core->memory[0xFF44];
                    $this->matchLYC();
                    if ($this->core->LCDTicks >= 114) {
                        //We need to skip 1 or more scan lines:
                        $this->scanLine($this->actualScanLine); //Scan Line and STAT Mode Control
                    }
                }
            } else {
                //VBlank Ending (We're on the last actual scan line)
                if ($this->core->memory[0xFF44] == 153) {
                    $this->core->memory[0xFF44] = 0; //LY register resets to 0 early.
                    $this->matchLYC(); //LY==LYC Test is early here (Fixes specific one-line glitches (example: Kirby2 intro)).
                }
                if ($this->core->LCDTicks >= 114) {
                    //We reset back to the beginning:
                    $this->core->LCDTicks -= 114;
                    $this->actualScanLine = 0;
                    $this->scanLineMode2(); // mode2: 80 cycles
                    if ($this->core->LCDTicks >= 114) {
                        //We need to skip 1 or more scan lines:
                        $this->scanLine($this->actualScanLine); //Scan Line and STAT Mode Control
                    }
                }
            }
        }
    }

    public function scanLineMode0()
    {
        // H-Blank
        if ($this->modeSTAT != 0) {
            if ($this->core->hdmaRunning && !$this->core->halt && $this->LCDisOn) {
                $this->performHdma(); //H-Blank DMA
            }
            if ($this->mode0TriggerSTAT || ($this->mode2TriggerSTAT && $this->STATTracker == 0)) {
                $this->core->memory[0xFF0F] |= 0x2; // if STAT bit 3 -> set IF bit1
            }
            $this->notifyScanline();
            $this->STATTracker = 2;
            $this->modeSTAT = 0;
        }
    }

    public function scanLineMode2()
    {
        // OAM in use
        if ($this->modeSTAT != 2) {
            if ($this->mode2TriggerSTAT) {
                $this->core->memory[0xFF0F] |= 0x2; // set IF bit 1
            }
            $this->STATTracker = 1;
            $this->modeSTAT = 2;
        }
    }

    public function scanLineMode3()
    {
        // OAM in use
        if ($this->modeSTAT != 3) {
            if ($this->mode2TriggerSTAT && $this->STATTracker == 0) {
                $this->core->memory[0xFF0F] |= 0x2; // set IF bit 1
            }
            $this->STATTracker = 1;
            $this->modeSTAT = 3;
        }
    }
}