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
 35enum GBAVideoObjMode {
 36	OBJ_MODE_NORMAL = 0,
 37	OBJ_MODE_SEMITRANSPARENT = 1,
 38	OBJ_MODE_OBJWIN = 2
 39};
 40
 41enum GBAVideoObjShape {
 42	OBJ_SHAPE_SQUARE = 0,
 43	OBJ_SHAPE_HORIZONTAL = 1,
 44	OBJ_SHAPE_VERTICAL = 2
 45};
 46
 47enum GBAVideoBlendEffect {
 48	BLEND_NONE = 0,
 49	BLEND_ALPHA = 1,
 50	BLEND_BRIGHTEN = 2,
 51	BLEND_DARKEN = 3
 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
154DECL_BITFIELD(GBAWindowControl, uint8_t);
155DECL_BIT(GBAWindowControl, Bg0Enable, 0);
156DECL_BIT(GBAWindowControl, Bg1Enable, 1);
157DECL_BIT(GBAWindowControl, Bg2Enable, 2);
158DECL_BIT(GBAWindowControl, Bg3Enable, 3);
159DECL_BIT(GBAWindowControl, ObjEnable, 4);
160DECL_BIT(GBAWindowControl, BlendEnable, 5);
161
162DECL_BITFIELD(GBAMosaicControl, uint16_t);
163DECL_BITS(GBAMosaicControl, BgH, 0, 4);
164DECL_BITS(GBAMosaicControl, BgV, 4, 4);
165DECL_BITS(GBAMosaicControl, ObjH, 8, 4);
166DECL_BITS(GBAMosaicControl, ObjV, 12, 4);
167
168struct GBAVideoRenderer {
169	void (*init)(struct GBAVideoRenderer* renderer);
170	void (*reset)(struct GBAVideoRenderer* renderer);
171	void (*deinit)(struct GBAVideoRenderer* renderer);
172
173	uint16_t (*writeVideoRegister)(struct GBAVideoRenderer* renderer, uint32_t address, uint16_t value);
174	void (*writeVRAM)(struct GBAVideoRenderer* renderer, uint32_t address);
175	void (*writePalette)(struct GBAVideoRenderer* renderer, uint32_t address, uint16_t value);
176	void (*writeOAM)(struct GBAVideoRenderer* renderer, uint32_t oam);
177	void (*drawScanline)(struct GBAVideoRenderer* renderer, int y);
178	void (*finishFrame)(struct GBAVideoRenderer* renderer);
179
180	void (*getPixels)(struct GBAVideoRenderer* renderer, size_t* stride, const void** pixels);
181	void (*putPixels)(struct GBAVideoRenderer* renderer, size_t stride, const void* pixels);
182
183	uint16_t* palette;
184	uint16_t* vram;
185	union GBAOAM* oam;
186	struct mCacheSet* cache;
187
188	bool disableBG[4];
189	bool disableOBJ;
190};
191
192struct GBAVideo {
193	struct GBA* p;
194	struct GBAVideoRenderer* renderer;
195	struct mTimingEvent event;
196
197	// VCOUNT
198	int vcount;
199
200	uint16_t palette[512];
201	uint16_t* vram;
202	union GBAOAM oam;
203
204	int32_t frameCounter;
205	int frameskip;
206	int frameskipCounter;
207};
208
209void GBAVideoInit(struct GBAVideo* video);
210void GBAVideoReset(struct GBAVideo* video);
211void GBAVideoDeinit(struct GBAVideo* video);
212void GBAVideoAssociateRenderer(struct GBAVideo* video, struct GBAVideoRenderer* renderer);
213
214void GBAVideoWriteDISPSTAT(struct GBAVideo* video, uint16_t value);
215
216struct GBASerializedState;
217void GBAVideoSerialize(const struct GBAVideo* video, struct GBASerializedState* state);
218void GBAVideoDeserialize(struct GBAVideo* video, const struct GBASerializedState* state);
219
220extern const int GBAVideoObjSizes[16][2];
221
222CXX_GUARD_END
223
224#endif