Files
Grinch-AP/worlds/oot/data/Compress/src/yaz0.c
espeon65536 51c38fc628 Ocarina of Time (#64)
* first commit (not including OoT data files yet)

* added some basic options

* rule parser works now at least

* make sure to commit everything this time

* temporary change to BaseClasses for oot

* overworld location graph builds mostly correctly

* adding oot data files

* commenting out world options until later since they only existed to make the RuleParser work

* conversion functions between AP ids and OOT ids

* world graph outputs

* set scrub prices

* itempool generates, entrances connected, way too many options added

* fixed set_rules and set_shop_rules

* temp baseclasses changes

* Reaches the fill step now, old event-based system retained in case the new way breaks

* Song placements and misc fixes everywhere

* temporary changes to make oot work

* changed root exits for AP fill framework

* prevent infinite recursion due to OoT sharing usage of the address field

* age reachability works hopefully, songs are broken again

* working spoiler log generation on beatable-only

* Logic tricks implemented

* need this for logic tricks

* fixed map/compass being placed on Serenade location

* kill unreachable events before filling the world

* add a bunch of utility functions to prepare for rom patching

* move OptionList into generic options

* fixed some silly bugs with OptionList

* properly seed all random behavior (so far)

* ROM generation working

* fix hints trying to get alttp dungeon hint texts

* continue fixing hints

* add oot to network data package

* change item and location IDs to 66000 and 67000 range respectively

* push removed items to precollected items

* fixed various issues with cross-contamination with multiple world generation

* reenable glitched logic (hopefully)

* glitched world files age-check fix

* cleaned up some get_locations calls

* added token shuffle and scrub shuffle, modified some options slightly to make the parsing work

* reenable MQ dungeons

* fix forest mq exception

* made targeting style an option for now, will be cosmetic later

* reminder to move targeting to cosmetics

* some oot option maintenance

* enabled starting time of day

* fixed issue breaking shop slots in multiworld generation

* added "off" option for text shuffle and hints

* shopsanity functionality restored

* change patch file extension

* remove unnecessary utility functions + imports

* update MIT license

* change option to "patch_uncompressed_rom" instead of "compress_rom"

* compliance with new AutoWorld systems

* Kill only internal events, remove non-internal big poe event in code

* re-add the big poe event and handle it correctly

* remove extra method in Range option

* fix typo

* Starting items, starting with consumables option

* do not remove nonexistent item

* move set_shop_rules to after shop items are placed

* some cleanup

* add retries for song placement

* flagged Skull Mask and Mask of Truth as advancement items

* update OoT to use LogicMixin

* Fixed trying to assign starting items from the wrong players

* fixed song retry step

* improved option handling, comments, and starting item replacements

* DefaultOnToggle writes Yes or No to spoiler

* enable compression of output if Compress executable is present

* clean up compression

* check whether (de)compressor exists before running the process

* allow specification of rom path in host.yaml

* check if decompressed file already exists before decompressing again

* fix triforce hunt generation

* rename all the oot state functions with prefix

* OoT: mark triforce pieces as completion goal for triforce hunt

* added overworld and any-dungeon shuffle for dungeon items

* Hide most unshuffled locations and events from the list of locations in spoiler

* build oot option ranges with a generic function instead of defining each separately

* move oot output-type control to host.yaml instead of individual yamls

* implement dungeon song shuffle

* minor improvements to overworld dungeon item shuffle

* remove random ice trap names in shops, mostly to avoid maintaining a massive censor list

* always output patch file to folder, remove option to generate ROM in preparation for removal

* re-add the fix for infinite recursion due to not being light or dark world

* change AP-sendable to Ocarina of Time model, since the triforce piece has some extra code apparently

* oot: remove item_names and location_names

* oot: minor fixes

* oot: comment out ROM patching

* oot: only add CollectionState objects on creation if actually needed

* main entrance shuffle method and entrances-based rules

* fix entrances based rules

* disable master quest and big poe count options for client compatibility

* use get_player_name instead of get_player_names

* fix OptionList

* fix oot options for new option system

* new coop section in oot rom: expand player names to 16 bytes, write AP_PLAYER_NAME at end of PLAYER_NAMES

* fill AP player name in oot rom with 0 instead of 0xDF

* encode player name with ASCII for fixed-width

* revert oot player name array to 8 bytes per name

* remove Pierre location if fast scarecrow is on

* check player name length

* "free_scarecrow" not "fast_scarecrow"

* OoT locations now properly store the AP ID instead of the oot internal ID

* oot __version__ updates in lockstep with AP version

* pull in unmodified oot cosmetic files

* also grab JSONDump since it's needed apparently

* gather extra needed methods, modify imports

* delete cosmetics log, replace all instances of SettingsList with OOTWorld

* cosmetic options working, except for sound effects (due to ear-safe issues)

* SFX, Music, and Fanfare randomization reenabled

* move OoT data files into the worlds folder

* move Compress and Decompress into oot data folder

* Replace get_all_state with custom method to avoid the cache

* OoT ROM: increment item counter before setting incoming item/player values to 0, preventing desync issues

* set data_version to 0

* make Kokiri Sword shuffle off by default

* reenable "Random Choice" for various cosmetic options

* kill Ruto's Letter turnin if open fountain
also fix for shopsanity

* place Buy Goron/Zora Tunic first in shop shuffle

* make ice traps appear as other items instead of breaking generation

* managed to break ice traps on non-major-only

* only handle ice traps if they are on

* fix shopsanity for non-oot games, and write player name instead of player number

* light arrows hint uses player name instead of player number

* Reenable "skip child zelda" option

* fix entrances_based_rules

* fix ganondorf hint if starting with light arrows

* fix dungeonitem shuffle and shopsanity interaction

* remove has_all_of, has_any_of, count_of in BaseClasses, replace usage with has_all, has_any, has_group

* force local giveable item on ZL if skip_child_zelda and shuffle_song_items is any

* keep bosses and bombchu bowling chus out of data package

* revert workaround for infinite recursion and fix it properly

* fix shared shop id caches during patching process

* fix shop text box overflows, as much as possible

* add default oot host.yaml option

* add .apz5, .n64, .z64 to gitignore

* Properly document and name all (functioning) OOT options

* clean up some imports

* remove unnecessary files from oot's data

* fix typo in gitignore

* readd the Compress and Decompress utilities, since they are needed for generation

* cleanup of imports and some minor optimizations

* increase shop offset for item IDs to 0xCB

* remove shop item AP ids entirely

* prevent triforce pieces for other players from being received by yourself

* add "excluded" property to Location

* Hint system adapted and reenabled; hints still unseeded

* make hints deterministic with lists instead of sets

* do not allow hints to point to Light Arrows on non-vanilla bridge

* foreign locations hint as their full name in OoT rather than their region

* checkedLocations now stores hint names by player ID, so that the same location in different worlds can have hints associated

* consolidate versioning in Utils

* ice traps appear as major items rather than any progression item

* set prescription and claim check as defaults for adult trade item settings

* add oot options to playerSettings

* allow case-insensitive logic tricks in yaml

* fix oot shopsanity option formatting

* Write OoT override info even if local item, enabling local checks to show up immediately in the client

* implement CollectionState.can_live_dmg for oot glitched logic

* filter item names for invalid characters when patching shops

* make ice traps appear according to the settings of the world they are shuffled into, rather than the original world

* set hidden-spoiler items and locations with Shop items to events

* make GF carpenters, Gerudo Card, Malon, ZL, and Impa events if the relevant settings are enabled, preventing them from appearing in the client on game start

* Fix oot Glitched and No Logic generation

* fix indenting

* Greatly reduce displayed cosmetic options

* Change oot data version to 1

* add apz5 distribution to webhost

* print player name if an ALttP dungeon contains a good item for OoT world

* delete unneeded commented code

* remove OcarinaSongs import to satisfy lint
2021-09-02 14:35:05 +02:00

187 lines
4.7 KiB
C

#include <stdlib.h>
#include <stdint.h>
#include <string.h>
uint32_t RabinKarp(uint8_t*, int, int, uint32_t*);
uint32_t findBest(uint8_t*, int, int, uint32_t*, uint32_t*, uint32_t*, uint8_t*);
int yaz0_internal(uint8_t*, int, uint8_t*);
void yaz0_encode(uint8_t*, int, uint8_t*, int*);
uint32_t RabinKarp(uint8_t* src, int srcSize, int srcPos, uint32_t* matchPos)
{
int startPos, smp, i;
uint32_t hash, curHash, curSize;
uint32_t bestSize, bestPos;
smp = srcSize - srcPos;
startPos = srcPos - 0x1000;
bestPos = bestSize = 0;
/* If available size is too small, return */
if(smp < 3)
return(0);
/* If available size is too big, reduce it */
if(smp > 0x111)
smp = 0x111;
/* If start position is negative, make it 0 */
if(startPos < 0)
startPos = 0;
/* Generate "hash" by converting to an int */
hash = bSwap32(*(int*)(src + srcPos));
hash = hash >> 8;
curHash = bSwap32(*(int*)(src + startPos));
curHash = curHash >> 8;
/* Search through data */
for(i = startPos; i < srcPos; i++)
{
/* If 3 bytes match, check for more */
if(curHash == hash)
{
for(curSize = 3; curSize < smp; curSize++)
if(src[i + curSize] != src[srcPos + curSize])
break;
/* Uodate best if needed */
if(curSize > bestSize)
{
bestSize = curSize;
bestPos = i;
if(bestSize == 0x111)
break;
}
}
/* Scoot over 1 byte */
curHash = (curHash << 8 | src[i + 3]) & 0x00FFFFFF;
}
/* Set match position, return the size of the match */
*matchPos = bestPos;
return(bestSize);
}
uint32_t findBest(uint8_t* src, int srcSize, int srcPos, uint32_t* matchPos, uint32_t* pMatch, uint32_t* pSize, uint8_t* pFlag)
{
int rv;
/* Check to see if this location was found by a look-ahead */
if(*pFlag == 1)
{
*pFlag = 0;
return(*pSize);
}
/* Find best match */
*pFlag = 0;
rv = RabinKarp(src, srcSize, srcPos, matchPos);
/* Look-ahead */
if(rv >= 3)
{
/* Find best match if current one were to be a 1 byte copy */
*pSize = RabinKarp(src, srcSize, srcPos+1, pMatch);
if(*pSize >= rv+2)
{
rv = *pFlag = 1;
*matchPos = *pMatch;
}
}
return(rv);
}
int yaz0_internal(uint8_t* src, int srcSize, uint8_t* dst)
{
int dstPos, srcPos, codeBytePos;
uint32_t numBytes, matchPos, dist, pMatch, pSize;
uint8_t codeByte, bitmask, pFlag;
srcPos = codeBytePos = 0;
dstPos = codeBytePos + 1;
bitmask = 0x80;
codeByte = pFlag = 0;
/* Go through all of src */
while(srcPos < srcSize)
{
/* Try to find matching bytes for compressing */
numBytes = findBest(src, srcSize, srcPos, &matchPos, &pMatch, &pSize, &pFlag);
/* Single byte copy */
if(numBytes < 3)
{
dst[dstPos++] = src[srcPos++];
codeByte |= bitmask;
}
/* Three byte encoding */
else if (numBytes > 0x11)
{
dist = srcPos - matchPos - 1;
/* Copy over 0R RR */
dst[dstPos++] = dist >> 8;
dst[dstPos++] = dist & 0xFF;
/* Reduce N if needed, copy over NN */
if(numBytes > 0x111)
numBytes = 0x111;
dst[dstPos++] = (numBytes - 0x12) & 0xFF;
srcPos += numBytes;
}
/* Two byte encoding */
else
{
dist = srcPos - matchPos - 1;
/* Copy over NR RR */
dst[dstPos++] = ((numBytes - 2) << 4) | (dist >> 8);
dst[dstPos++] = dist & 0xFF;
srcPos += numBytes;
}
/* Move bitmask to next byte */
bitmask = bitmask >> 1;
/* If all 8 bytes were used, write and move to the next one */
if(bitmask == 0)
{
dst[codeBytePos] = codeByte;
codeBytePos = dstPos;
if(srcPos < srcSize)
dstPos++;
codeByte = 0;
bitmask = 0x80;
}
}
/* Copy over last byte if it hasn't already */
if(bitmask != 0)
dst[codeBytePos] = codeByte;
/* Return size of dst */
return(dstPos);
}
void yaz0_encode(uint8_t* src, int srcSize, uint8_t* dst, int* dstSize)
{
int temp;
/* Write Yaz0 header */
temp = bSwap32(srcSize);
memcpy(dst, "Yaz0", 4);
memcpy(dst + 4, &temp, 4);
/* Encode, adjust dstSize */
temp = yaz0_internal(src, srcSize, dst + 16);
*dstSize = (temp + 31) & -16;
return;
}