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