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