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