diff options
author | Franklin Wei <frankhwei536@gmail.com> | 2014-10-13 21:00:47 -0400 |
---|---|---|
committer | Michael Giacomelli <giac2000@hotmail.com> | 2014-12-23 23:48:12 +0100 |
commit | 33cb13dee5a527ac445ea1b13d42723e4eb3e3b0 (patch) | |
tree | 3ce36ea21b53377b900049143e77e74b77ca1b0d /apps/plugins/xworld/resource.h | |
parent | b681e932a9da797249ddc0e4ccab7ed7cf50fd41 (diff) | |
download | rockbox-33cb13dee5a527ac445ea1b13d42723e4eb3e3b0.tar.gz rockbox-33cb13dee5a527ac445ea1b13d42723e4eb3e3b0.zip |
Xworld - Another World interpreter for Rockbox
Co-conspirators: Franklin Wei, Benjamin Brown
--------------------------------------------------------------------
This work is based on:
- Fabien Sanglard's "Fabother World" based on
- Piotr Padkowski's newRaw interpreter which was based on
- Gregory Montoir's reverse engineering of
- Eric Chahi's assembly code
--------------------------------------------------------------------
Progress:
* The plugin runs pretty nicely (with sound!) on most color targets
* Keymaps for color LCD targets are complete
* The manual entry is finished
* Grayscale/monochrome support is NOT PLANNED
- the game looks horrible in grayscale! :p
--------------------------------------------------------------------
Notes:
* The original game strings were built-in to the executable, and
were copyrighted and could not be used.
* This port ships with an alternate set of strings by default, but
can load the "official" strings from a file at runtime.
--------------------------------------------------------------------
To be done (in descending order of importance):
* vertical stride compatibility <30% done>
* optimization <10% done>
Change-Id: I3155b0d97c2ac470cb8a2040f40d4139ddcebfa5
Reviewed-on: http://gerrit.rockbox.org/1077
Reviewed-by: Michael Giacomelli <giac2000@hotmail.com>
Diffstat (limited to 'apps/plugins/xworld/resource.h')
-rw-r--r-- | apps/plugins/xworld/resource.h | 107 |
1 files changed, 107 insertions, 0 deletions
diff --git a/apps/plugins/xworld/resource.h b/apps/plugins/xworld/resource.h new file mode 100644 index 0000000000..3242777bc2 --- /dev/null +++ b/apps/plugins/xworld/resource.h | |||
@@ -0,0 +1,107 @@ | |||
1 | /*************************************************************************** | ||
2 | * __________ __ ___. | ||
3 | * Open \______ \ ____ ____ | | _\_ |__ _______ ___ | ||
4 | * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ / | ||
5 | * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < < | ||
6 | * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \ | ||
7 | * \/ \/ \/ \/ \/ | ||
8 | * $Id$ | ||
9 | * | ||
10 | * Copyright (C) 2014 Franklin Wei, Benjamin Brown | ||
11 | * Copyright (C) 2004 Gregory Montoir | ||
12 | * | ||
13 | * This program is free software; you can redistribute it and/or | ||
14 | * modify it under the terms of the GNU General Public License | ||
15 | * as published by the Free Software Foundation; either version 2 | ||
16 | * of the License, or (at your option) any later version. | ||
17 | * | ||
18 | * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY | ||
19 | * KIND, either express or implied. | ||
20 | * | ||
21 | ***************************************************************************/ | ||
22 | |||
23 | #ifndef __RESOURCE_H__ | ||
24 | #define __RESOURCE_H__ | ||
25 | |||
26 | #include "intern.h" | ||
27 | |||
28 | |||
29 | #define MEMENTRY_STATE_END_OF_MEMLIST 0xFF | ||
30 | #define MEMENTRY_STATE_NOT_NEEDED 0 | ||
31 | #define MEMENTRY_STATE_LOADED 1 | ||
32 | #define MEMENTRY_STATE_LOAD_ME 2 | ||
33 | |||
34 | /* | ||
35 | This is a directory entry. When the game starts, it loads memlist.bin and | ||
36 | populate and array of MemEntry | ||
37 | */ | ||
38 | typedef struct MemEntry { | ||
39 | uint8_t state; /* 0x0 */ | ||
40 | uint8_t type; /* 0x1, Resource::ResType */ | ||
41 | uint8_t *bufPtr; /* 0x2 */ | ||
42 | uint16_t unk4; /* 0x4, unused */ | ||
43 | uint8_t rankNum; /* 0x6 */ | ||
44 | uint8_t bankId; /* 0x7 */ | ||
45 | uint32_t bankOffset; /* 0x8 0xA */ | ||
46 | uint16_t unkC; /* 0xC, unused */ | ||
47 | uint16_t packedSize; /* 0xE */ | ||
48 | /* All ressources are packed (for a gain of 28% according to Chahi) */ | ||
49 | |||
50 | uint16_t unk10; /* 0x10, unused */ | ||
51 | uint16_t size; /* 0x12 */ | ||
52 | } __attribute__((packed)) MemEntry; | ||
53 | |||
54 | /* | ||
55 | Note: state is not a boolean, it can have value 0, 1, 2 or 255, respectively meaning: | ||
56 | 0:NOT_NEEDED | ||
57 | 1:LOADED | ||
58 | 2:LOAD_ME | ||
59 | 255:END_OF_MEMLIST | ||
60 | |||
61 | See MEMENTRY_STATE_* #defines above. | ||
62 | */ | ||
63 | |||
64 | struct Serializer; | ||
65 | struct Video; | ||
66 | |||
67 | #define MEM_BLOCK_SIZE (600 * 1024) | ||
68 | #define RT_SOUND 0 | ||
69 | #define RT_MUSIC 1 | ||
70 | #define RT_POLY_ANIM 2 | ||
71 | #define RT_PALETTE 3 | ||
72 | #define RT_BYTECODE 4 | ||
73 | #define RT_POLY_CINEMATIC 5 | ||
74 | |||
75 | struct Resource { | ||
76 | struct Video *video; | ||
77 | struct System *sys; | ||
78 | const char *_dataDir; | ||
79 | struct MemEntry _memList[150]; | ||
80 | uint16_t _numMemList; | ||
81 | uint16_t currentPartId, requestedNextPart; | ||
82 | uint8_t *_memPtrStart, *_scriptBakPtr, *_scriptCurPtr, *_vidBakPtr, *_vidCurPtr; | ||
83 | bool _useSegVideo2; | ||
84 | |||
85 | uint8_t *segPalettes; | ||
86 | uint8_t *segBytecode; | ||
87 | uint8_t *segCinematic; | ||
88 | uint8_t *_segVideo2; | ||
89 | }; | ||
90 | |||
91 | |||
92 | void res_create(struct Resource*, struct Video*, struct System*, const char* dataDir); | ||
93 | |||
94 | void res_readBank(struct Resource*, const MemEntry *me, uint8_t *dstBuf); | ||
95 | void res_readEntries(struct Resource*); | ||
96 | void res_loadMarkedAsNeeded(struct Resource*); | ||
97 | void res_invalidateAll(struct Resource*); | ||
98 | void res_invalidateRes(struct Resource*); | ||
99 | void res_loadPartsOrMemoryEntry(struct Resource*, uint16_t num); | ||
100 | void res_setupPart(struct Resource*, uint16_t ptrId); | ||
101 | void res_allocMemBlock(struct Resource*); | ||
102 | void res_freeMemBlock(struct Resource*); | ||
103 | |||
104 | void res_saveOrLoad(struct Resource*, struct Serializer *ser); | ||
105 | |||
106 | const char* res_getDataDir(struct Resource*); | ||
107 | #endif | ||