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