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 <mgba-util/common.h>
 10
 11CXX_GUARD_START
 12
 13#include <mgba/core/log.h>
 14#include <mgba/core/timing.h>
 15
 16mLOG_DECLARE_CATEGORY(GBA_VIDEO);
 17
 18enum {
 19	VIDEO_HBLANK_PIXELS = 68,
 20	VIDEO_HDRAW_LENGTH = 1006,
 21	VIDEO_HBLANK_LENGTH = 226,
 22	VIDEO_HORIZONTAL_LENGTH = 1232,
 23
 24	VIDEO_VBLANK_PIXELS = 68,
 25	VIDEO_VERTICAL_TOTAL_PIXELS = 228,
 26
 27	VIDEO_TOTAL_LENGTH = 280896,
 28
 29	OBJ_HBLANK_FREE_LENGTH = 954,
 30	OBJ_LENGTH = 1210,
 31
 32	BASE_TILE = 0x00010000,
 33
 34	VRAM_BLOCK_OFFSET = 14,
 35	VRAM_BLOCK_MASK = 0x3FFF
 36};
 37
 38enum GBAVideoObjMode {
 39	OBJ_MODE_NORMAL = 0,
 40	OBJ_MODE_SEMITRANSPARENT = 1,
 41	OBJ_MODE_OBJWIN = 2,
 42	OBJ_MODE_BITMAP = 3
 43};
 44
 45enum GBAVideoObjShape {
 46	OBJ_SHAPE_SQUARE = 0,
 47	OBJ_SHAPE_HORIZONTAL = 1,
 48	OBJ_SHAPE_VERTICAL = 2
 49};
 50
 51enum GBAVideoBlendEffect {
 52	BLEND_NONE = 0,
 53	BLEND_ALPHA = 1,
 54	BLEND_BRIGHTEN = 2,
 55	BLEND_DARKEN = 3
 56};
 57
 58DECL_BITFIELD(GBAObjAttributesA, uint16_t);
 59DECL_BITS(GBAObjAttributesA, Y, 0, 8);
 60DECL_BIT(GBAObjAttributesA, Transformed, 8);
 61DECL_BIT(GBAObjAttributesA, Disable, 9);
 62DECL_BIT(GBAObjAttributesA, DoubleSize, 9);
 63DECL_BITS(GBAObjAttributesA, Mode, 10, 2);
 64DECL_BIT(GBAObjAttributesA, Mosaic, 12);
 65DECL_BIT(GBAObjAttributesA, 256Color, 13);
 66DECL_BITS(GBAObjAttributesA, Shape, 14, 2);
 67
 68DECL_BITFIELD(GBAObjAttributesB, uint16_t);
 69DECL_BITS(GBAObjAttributesB, X, 0, 9);
 70DECL_BITS(GBAObjAttributesB, MatIndex, 9, 5);
 71DECL_BIT(GBAObjAttributesB, HFlip, 12);
 72DECL_BIT(GBAObjAttributesB, VFlip, 13);
 73DECL_BITS(GBAObjAttributesB, Size, 14, 2);
 74
 75DECL_BITFIELD(GBAObjAttributesC, uint16_t);
 76DECL_BITS(GBAObjAttributesC, Tile, 0, 10);
 77DECL_BITS(GBAObjAttributesC, Priority, 10, 2);
 78DECL_BITS(GBAObjAttributesC, Palette, 12, 4);
 79
 80struct GBAObj {
 81	GBAObjAttributesA a;
 82	GBAObjAttributesB b;
 83	GBAObjAttributesC c;
 84	uint16_t d;
 85};
 86
 87union GBAOAM {
 88	struct GBAObj obj[128];
 89
 90	struct GBAOAMMatrix {
 91		int16_t padding0[3];
 92		int16_t a;
 93		int16_t padding1[3];
 94		int16_t b;
 95		int16_t padding2[3];
 96		int16_t c;
 97		int16_t padding3[3];
 98		int16_t d;
 99	} mat[32];
100
101	uint16_t raw[512];
102};
103
104struct GBAVideoWindowRegion {
105	uint8_t end;
106	uint8_t start;
107};
108
109#define GBA_TEXT_MAP_TILE(MAP) ((MAP) & 0x03FF)
110#define GBA_TEXT_MAP_HFLIP(MAP) ((MAP) & 0x0400)
111#define GBA_TEXT_MAP_VFLIP(MAP) ((MAP) & 0x0800)
112#define GBA_TEXT_MAP_PALETTE(MAP) (((MAP) & 0xF000) >> 12)
113
114DECL_BITFIELD(GBARegisterDISPCNT, uint16_t);
115DECL_BITS(GBARegisterDISPCNT, Mode, 0, 3);
116DECL_BIT(GBARegisterDISPCNT, Cgb, 3);
117DECL_BIT(GBARegisterDISPCNT, FrameSelect, 4);
118DECL_BIT(GBARegisterDISPCNT, HblankIntervalFree, 5);
119DECL_BIT(GBARegisterDISPCNT, ObjCharacterMapping, 6);
120DECL_BIT(GBARegisterDISPCNT, ForcedBlank, 7);
121DECL_BIT(GBARegisterDISPCNT, Bg0Enable, 8);
122DECL_BIT(GBARegisterDISPCNT, Bg1Enable, 9);
123DECL_BIT(GBARegisterDISPCNT, Bg2Enable, 10);
124DECL_BIT(GBARegisterDISPCNT, Bg3Enable, 11);
125DECL_BIT(GBARegisterDISPCNT, ObjEnable, 12);
126DECL_BIT(GBARegisterDISPCNT, Win0Enable, 13);
127DECL_BIT(GBARegisterDISPCNT, Win1Enable, 14);
128DECL_BIT(GBARegisterDISPCNT, ObjwinEnable, 15);
129
130DECL_BITFIELD(GBARegisterDISPSTAT, uint16_t);
131DECL_BIT(GBARegisterDISPSTAT, InVblank, 0);
132DECL_BIT(GBARegisterDISPSTAT, InHblank, 1);
133DECL_BIT(GBARegisterDISPSTAT, Vcounter, 2);
134DECL_BIT(GBARegisterDISPSTAT, VblankIRQ, 3);
135DECL_BIT(GBARegisterDISPSTAT, HblankIRQ, 4);
136DECL_BIT(GBARegisterDISPSTAT, VcounterIRQ, 5);
137DECL_BITS(GBARegisterDISPSTAT, VcountSetting, 8, 8);
138
139DECL_BITFIELD(GBARegisterBGCNT, uint16_t);
140DECL_BITS(GBARegisterBGCNT, Priority, 0, 2);
141DECL_BITS(GBARegisterBGCNT, CharBase, 2, 4);
142DECL_BIT(GBARegisterBGCNT, Mosaic, 6);
143DECL_BIT(GBARegisterBGCNT, 256Color, 7);
144DECL_BITS(GBARegisterBGCNT, ScreenBase, 8, 5);
145DECL_BIT(GBARegisterBGCNT, Overflow, 13);
146DECL_BITS(GBARegisterBGCNT, Size, 14, 2);
147
148DECL_BITFIELD(GBARegisterBLDCNT, uint16_t);
149DECL_BIT(GBARegisterBLDCNT, Target1Bg0, 0);
150DECL_BIT(GBARegisterBLDCNT, Target1Bg1, 1);
151DECL_BIT(GBARegisterBLDCNT, Target1Bg2, 2);
152DECL_BIT(GBARegisterBLDCNT, Target1Bg3, 3);
153DECL_BIT(GBARegisterBLDCNT, Target1Obj, 4);
154DECL_BIT(GBARegisterBLDCNT, Target1Bd, 5);
155DECL_BITS(GBARegisterBLDCNT, Effect, 6, 2);
156DECL_BIT(GBARegisterBLDCNT, Target2Bg0, 8);
157DECL_BIT(GBARegisterBLDCNT, Target2Bg1, 9);
158DECL_BIT(GBARegisterBLDCNT, Target2Bg2, 10);
159DECL_BIT(GBARegisterBLDCNT, Target2Bg3, 11);
160DECL_BIT(GBARegisterBLDCNT, Target2Obj, 12);
161DECL_BIT(GBARegisterBLDCNT, Target2Bd, 13);
162
163DECL_BITFIELD(GBAWindowControl, uint8_t);
164DECL_BIT(GBAWindowControl, Bg0Enable, 0);
165DECL_BIT(GBAWindowControl, Bg1Enable, 1);
166DECL_BIT(GBAWindowControl, Bg2Enable, 2);
167DECL_BIT(GBAWindowControl, Bg3Enable, 3);
168DECL_BIT(GBAWindowControl, ObjEnable, 4);
169DECL_BIT(GBAWindowControl, BlendEnable, 5);
170
171DECL_BITFIELD(GBAMosaicControl, uint16_t);
172DECL_BITS(GBAMosaicControl, BgH, 0, 4);
173DECL_BITS(GBAMosaicControl, BgV, 4, 4);
174DECL_BITS(GBAMosaicControl, ObjH, 8, 4);
175DECL_BITS(GBAMosaicControl, ObjV, 12, 4);
176
177struct GBAVideoRenderer {
178	void (*init)(struct GBAVideoRenderer* renderer);
179	void (*reset)(struct GBAVideoRenderer* renderer);
180	void (*deinit)(struct GBAVideoRenderer* renderer);
181
182	uint16_t (*writeVideoRegister)(struct GBAVideoRenderer* renderer, uint32_t address, uint16_t value);
183	void (*writeVRAM)(struct GBAVideoRenderer* renderer, uint32_t address);
184	void (*writePalette)(struct GBAVideoRenderer* renderer, uint32_t address, uint16_t value);
185	void (*writeOAM)(struct GBAVideoRenderer* renderer, uint32_t oam);
186	void (*drawScanline)(struct GBAVideoRenderer* renderer, int y);
187	void (*finishFrame)(struct GBAVideoRenderer* renderer);
188
189	void (*getPixels)(struct GBAVideoRenderer* renderer, size_t* stride, const void** pixels);
190	void (*putPixels)(struct GBAVideoRenderer* renderer, size_t stride, const void* pixels);
191
192	uint16_t* palette;
193	uint16_t* vramBG[32];
194	uint16_t* vramOBJ[32];
195	union GBAOAM* oam;
196	struct mCacheSet* cache;
197
198	bool disableBG[4];
199	bool disableOBJ;
200};
201
202struct GBAVideo {
203	struct GBA* p;
204	struct GBAVideoRenderer* renderer;
205	struct mTimingEvent event;
206
207	// VCOUNT
208	int vcount;
209
210	uint16_t palette[512];
211	uint16_t* vram;
212	union GBAOAM oam;
213
214	int32_t frameCounter;
215	int frameskip;
216	int frameskipCounter;
217};
218
219void GBAVideoInit(struct GBAVideo* video);
220void GBAVideoReset(struct GBAVideo* video);
221void GBAVideoDeinit(struct GBAVideo* video);
222void GBAVideoAssociateRenderer(struct GBAVideo* video, struct GBAVideoRenderer* renderer);
223
224void GBAVideoWriteDISPSTAT(struct GBAVideo* video, uint16_t value);
225
226struct GBASerializedState;
227void GBAVideoSerialize(const struct GBAVideo* video, struct GBASerializedState* state);
228void GBAVideoDeserialize(struct GBAVideo* video, const struct GBASerializedState* state);
229
230extern const int GBAVideoObjSizes[16][2];
231
232CXX_GUARD_END
233
234#endif