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