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