rockbox/apps/plugins/xworld/bank.h
Franklin Wei 33cb13dee5 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>
2014-12-23 23:48:12 +01:00

55 lines
1.7 KiB
C

/***************************************************************************
* __________ __ ___.
* Open \______ \ ____ ____ | | _\_ |__ _______ ___
* Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
* Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
* Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
* \/ \/ \/ \/ \/
* $Id$
*
* Copyright (C) 2014 Franklin Wei, Benjamin Brown
* Copyright (C) 2004 Gregory Montoir
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
* KIND, either express or implied.
*
***************************************************************************/
#ifndef __BANK_H__
#define __BANK_H__
#include "intern.h"
struct MemEntry;
struct UnpackContext {
uint16_t size;
uint32_t crc;
uint32_t chk;
int32_t datasize;
};
struct Bank
{
struct UnpackContext _unpCtx;
const char *_dataDir;
uint8_t *_iBuf, *_oBuf, *_startBuf;
};
/* needs allocated memory */
void bank_create(struct Bank*, const char *dataDir);
bool bank_read(struct Bank*, const struct MemEntry *me, uint8_t *buf);
void bank_decUnk1(struct Bank*, uint8_t numChunks, uint8_t addCount);
void bank_decUnk2(struct Bank*, uint8_t numChunks);
bool bank_unpack(struct Bank*);
uint16_t bank_getCode(struct Bank*, uint8_t numChunks);
bool bank_nextChunk(struct Bank*);
bool bank_rcr(struct Bank*, bool CF);
#endif