src/gba/video.h (view raw)
1/* Copyright (c) 2013-2015 Jeffrey Pfau
2 *
3 * This Source Code Form is subject to the terms of the Mozilla Public
4 * License, v. 2.0. If a copy of the MPL was not distributed with this
5 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
6#ifndef GBA_VIDEO_H
7#define GBA_VIDEO_H
8
9#include "util/common.h"
10
11#include "core/core.h"
12#include "gba/memory.h"
13#include "macros.h"
14
15#define GBA_R5(X) ((X) & 0x1F)
16#define GBA_G5(X) (((X) >> 5) & 0x1F)
17#define GBA_B5(X) (((X) >> 10) & 0x1F)
18
19#define GBA_R8(X) (((X) << 3) & 0xF8)
20#define GBA_G8(X) (((X) >> 2) & 0xF8)
21#define GBA_B8(X) (((X) >> 7) & 0xF8)
22
23enum {
24 VIDEO_HORIZONTAL_PIXELS = 240,
25 VIDEO_HBLANK_PIXELS = 68,
26 VIDEO_HDRAW_LENGTH = 1006,
27 VIDEO_HBLANK_LENGTH = 226,
28 VIDEO_HORIZONTAL_LENGTH = VIDEO_HDRAW_LENGTH + VIDEO_HBLANK_LENGTH,
29
30 VIDEO_VERTICAL_PIXELS = 160,
31 VIDEO_VBLANK_PIXELS = 68,
32 VIDEO_VERTICAL_TOTAL_PIXELS = VIDEO_VERTICAL_PIXELS + VIDEO_VBLANK_PIXELS,
33
34 VIDEO_TOTAL_LENGTH = VIDEO_HORIZONTAL_LENGTH * VIDEO_VERTICAL_TOTAL_PIXELS,
35
36 OBJ_HBLANK_FREE_LENGTH = 954,
37 OBJ_LENGTH = 1210,
38
39 BASE_TILE = 0x00010000
40};
41
42enum ObjMode {
43 OBJ_MODE_NORMAL = 0,
44 OBJ_MODE_SEMITRANSPARENT = 1,
45 OBJ_MODE_OBJWIN = 2
46};
47
48enum ObjShape {
49 OBJ_SHAPE_SQUARE = 0,
50 OBJ_SHAPE_HORIZONTAL = 1,
51 OBJ_SHAPE_VERTICAL = 2
52};
53
54DECL_BITFIELD(GBAObjAttributesA, uint16_t);
55DECL_BITS(GBAObjAttributesA, Y, 0, 8);
56DECL_BIT(GBAObjAttributesA, Transformed, 8);
57DECL_BIT(GBAObjAttributesA, Disable, 9);
58DECL_BIT(GBAObjAttributesA, DoubleSize, 9);
59DECL_BITS(GBAObjAttributesA, Mode, 10, 2);
60DECL_BIT(GBAObjAttributesA, Mosaic, 12);
61DECL_BIT(GBAObjAttributesA, 256Color, 13);
62DECL_BITS(GBAObjAttributesA, Shape, 14, 2);
63
64DECL_BITFIELD(GBAObjAttributesB, uint16_t);
65DECL_BITS(GBAObjAttributesB, X, 0, 9);
66DECL_BITS(GBAObjAttributesB, MatIndex, 9, 5);
67DECL_BIT(GBAObjAttributesB, HFlip, 12);
68DECL_BIT(GBAObjAttributesB, VFlip, 13);
69DECL_BITS(GBAObjAttributesB, Size, 14, 2);
70
71DECL_BITFIELD(GBAObjAttributesC, uint16_t);
72DECL_BITS(GBAObjAttributesC, Tile, 0, 10);
73DECL_BITS(GBAObjAttributesC, Priority, 10, 2);
74DECL_BITS(GBAObjAttributesC, Palette, 12, 4);
75
76struct GBAObj {
77 GBAObjAttributesA a;
78 GBAObjAttributesB b;
79 GBAObjAttributesC c;
80 uint16_t d;
81};
82
83union GBAOAM {
84 struct GBAObj obj[128];
85
86 struct GBAOAMMatrix {
87 int16_t padding0[3];
88 int16_t a;
89 int16_t padding1[3];
90 int16_t b;
91 int16_t padding2[3];
92 int16_t c;
93 int16_t padding3[3];
94 int16_t d;
95 } mat[32];
96
97 uint16_t raw[512];
98};
99
100#define GBA_TEXT_MAP_TILE(MAP) ((MAP) & 0x03FF)
101#define GBA_TEXT_MAP_HFLIP(MAP) ((MAP) & 0x0400)
102#define GBA_TEXT_MAP_VFLIP(MAP) ((MAP) & 0x0800)
103#define GBA_TEXT_MAP_PALETTE(MAP) (((MAP) & 0xF000) >> 12)
104
105DECL_BITFIELD(GBARegisterDISPCNT, uint16_t);
106DECL_BITS(GBARegisterDISPCNT, Mode, 0, 3);
107DECL_BIT(GBARegisterDISPCNT, Cgb, 3);
108DECL_BIT(GBARegisterDISPCNT, FrameSelect, 4);
109DECL_BIT(GBARegisterDISPCNT, HblankIntervalFree, 5);
110DECL_BIT(GBARegisterDISPCNT, ObjCharacterMapping, 6);
111DECL_BIT(GBARegisterDISPCNT, ForcedBlank, 7);
112DECL_BIT(GBARegisterDISPCNT, Bg0Enable, 8);
113DECL_BIT(GBARegisterDISPCNT, Bg1Enable, 9);
114DECL_BIT(GBARegisterDISPCNT, Bg2Enable, 10);
115DECL_BIT(GBARegisterDISPCNT, Bg3Enable, 11);
116DECL_BIT(GBARegisterDISPCNT, ObjEnable, 12);
117DECL_BIT(GBARegisterDISPCNT, Win0Enable, 13);
118DECL_BIT(GBARegisterDISPCNT, Win1Enable, 14);
119DECL_BIT(GBARegisterDISPCNT, ObjwinEnable, 15);
120
121DECL_BITFIELD(GBARegisterDISPSTAT, uint16_t);
122DECL_BIT(GBARegisterDISPSTAT, InVblank, 0);
123DECL_BIT(GBARegisterDISPSTAT, InHblank, 1);
124DECL_BIT(GBARegisterDISPSTAT, Vcounter, 2);
125DECL_BIT(GBARegisterDISPSTAT, VblankIRQ, 3);
126DECL_BIT(GBARegisterDISPSTAT, HblankIRQ, 4);
127DECL_BIT(GBARegisterDISPSTAT, VcounterIRQ, 5);
128DECL_BITS(GBARegisterDISPSTAT, VcountSetting, 8, 8);
129
130DECL_BITFIELD(GBARegisterBGCNT, uint16_t);
131DECL_BITS(GBARegisterBGCNT, Priority, 0, 2);
132DECL_BITS(GBARegisterBGCNT, CharBase, 2, 2);
133DECL_BIT(GBARegisterBGCNT, Mosaic, 6);
134DECL_BIT(GBARegisterBGCNT, 256Color, 7);
135DECL_BITS(GBARegisterBGCNT, ScreenBase, 8, 5);
136DECL_BIT(GBARegisterBGCNT, Overflow, 13);
137DECL_BITS(GBARegisterBGCNT, Size, 14, 2);
138
139DECL_BITFIELD(GBARegisterBLDCNT, uint16_t);
140DECL_BIT(GBARegisterBLDCNT, Target1Bg0, 0);
141DECL_BIT(GBARegisterBLDCNT, Target1Bg1, 1);
142DECL_BIT(GBARegisterBLDCNT, Target1Bg2, 2);
143DECL_BIT(GBARegisterBLDCNT, Target1Bg3, 3);
144DECL_BIT(GBARegisterBLDCNT, Target1Obj, 4);
145DECL_BIT(GBARegisterBLDCNT, Target1Bd, 5);
146DECL_BITS(GBARegisterBLDCNT, Effect, 6, 2);
147DECL_BIT(GBARegisterBLDCNT, Target2Bg0, 8);
148DECL_BIT(GBARegisterBLDCNT, Target2Bg1, 9);
149DECL_BIT(GBARegisterBLDCNT, Target2Bg2, 10);
150DECL_BIT(GBARegisterBLDCNT, Target2Bg3, 11);
151DECL_BIT(GBARegisterBLDCNT, Target2Obj, 12);
152DECL_BIT(GBARegisterBLDCNT, Target2Bd, 13);
153
154struct GBAVideoRenderer {
155 void (*init)(struct GBAVideoRenderer* renderer);
156 void (*reset)(struct GBAVideoRenderer* renderer);
157 void (*deinit)(struct GBAVideoRenderer* renderer);
158
159 uint16_t (*writeVideoRegister)(struct GBAVideoRenderer* renderer, uint32_t address, uint16_t value);
160 void (*writeVRAM)(struct GBAVideoRenderer* renderer, uint32_t address);
161 void (*writePalette)(struct GBAVideoRenderer* renderer, uint32_t address, uint16_t value);
162 void (*writeOAM)(struct GBAVideoRenderer* renderer, uint32_t oam);
163 void (*drawScanline)(struct GBAVideoRenderer* renderer, int y);
164 void (*finishFrame)(struct GBAVideoRenderer* renderer);
165
166 void (*getPixels)(struct GBAVideoRenderer* renderer, unsigned* stride, const void** pixels);
167 void (*putPixels)(struct GBAVideoRenderer* renderer, unsigned stride, void* pixels);
168
169 uint16_t* palette;
170 uint16_t* vram;
171 union GBAOAM* oam;
172
173 bool disableBG[4];
174 bool disableOBJ;
175};
176
177struct GBAVideo {
178 struct GBA* p;
179 struct GBAVideoRenderer* renderer;
180
181 // VCOUNT
182 int vcount;
183
184 int32_t nextHblank;
185 int32_t nextEvent;
186 int32_t eventDiff;
187
188 int32_t nextHblankIRQ;
189 int32_t nextVblankIRQ;
190 int32_t nextVcounterIRQ;
191
192 uint16_t palette[SIZE_PALETTE_RAM >> 1];
193 uint16_t* vram;
194 union GBAOAM oam;
195
196 int32_t frameCounter;
197 int frameskip;
198 int frameskipCounter;
199};
200
201void GBAVideoInit(struct GBAVideo* video);
202void GBAVideoReset(struct GBAVideo* video);
203void GBAVideoDeinit(struct GBAVideo* video);
204void GBAVideoAssociateRenderer(struct GBAVideo* video, struct GBAVideoRenderer* renderer);
205int32_t GBAVideoProcessEvents(struct GBAVideo* video, int32_t cycles);
206
207void GBAVideoWriteDISPSTAT(struct GBAVideo* video, uint16_t value);
208
209struct GBASerializedState;
210void GBAVideoSerialize(const struct GBAVideo* video, struct GBASerializedState* state);
211void GBAVideoDeserialize(struct GBAVideo* video, const struct GBASerializedState* state);
212
213extern const int GBAVideoObjSizes[16][2];
214
215#endif