ScummVM API documentation
Classes | Typedefs | Enumerations | Functions | Variables
Freescape Namespace Reference

Classes

struct  AnimationOpcode
 
class  Area
 
class  AreaConnections
 
struct  C64SFXData
 
struct  CastleAmigaLayout
 
struct  CastleAtariLayout
 
class  CastleAYMusicPlayer
 
class  CastleC64MusicPlayer
 
class  CastleEngine
 
class  CastleOPLMusicPlayer
 
struct  CGAPaletteEntry
 
class  Copylock
 
class  DarkEngine
 
class  DarkSideC64MusicPlayer
 
class  DarkSideC64SFXPlayer
 
class  DarkSideOPLMusicPlayer
 
class  Debugger
 
class  DrillerC64SFXPlayer
 
class  DrillerEngine
 
class  DrillerOPLMusicPlayer
 
class  DrillerSIDPlayer
 
struct  ECD
 
class  EclipseAYMusicPlayer
 
class  EclipseC64MusicPlayer
 
class  EclipseC64SFXPlayer
 
class  EclipseEngine
 
class  EclipseOPLMusicPlayer
 
class  Entrance
 
class  EventManagerWrapper
 
struct  FCLExecutionFrame
 
class  FCLInstruction
 
struct  FCLKit16ExecutionState
 
struct  FCLKit16Loop
 
struct  FCLKit8ExecutionState
 
struct  FCLOpcode
 
struct  FCLPredicateState
 
class  Font
 
class  FreescapeEngine
 
class  GeometricObject
 
class  GlobalStructure
 
class  Group
 
class  Kit8Engine
 
class  KitEngine
 
class  MusicPlayer
 
class  Object
 
class  OpenGLShaderRenderer
 
class  OpenGLTexture
 
class  Renderer
 
struct  Riddle
 
struct  RiddleText
 
class  Sensor
 
class  SizedPCSpeaker
 
class  Sound
 
class  Texture
 
class  TinyGL2DTexture
 
class  TinyGL3DTexture
 
class  TinyGLRenderer
 
struct  Token
 
struct  WBAtariTableOffsets
 
struct  WBTableOffsets
 
struct  ZxTapeFile
 

Typedefs

typedef Common::HashMap< uint16, Object * > ObjectMap
 
typedef Common::Array< Object * > ObjectArray
 
typedef Common::HashMap< uint16, Area * > AreaMap
 
typedef Common::Array< byte * > ColorMap
 
typedef Common::HashMap< uint16, int32 > StateVars
 
typedef Common::HashMap< int, int > ColorReMap
 
typedef Common::Array< FCLInstruction > FCLInstructionVector
 
typedef Common::Array< ZxTapeFile > ZxTapeFileList
 

Enumerations

enum  CameraMovement { kForwardMovement, kBackwardMovement, kLeftMovement, kRightMovement }
 
enum  FreescapeAction {
  kActionNone, kActionEscape, kActionSave, kActionLoad,
  kActionToggleSound, kActionMoveUp, kActionMoveDown, kActionMoveLeft,
  kActionMoveRight, kActionShoot, kActionActivate, kActionIncreaseAngle,
  kActionDecreaseAngle, kActionChangeStepSize, kActionToggleRiseLower, kActionRiseOrFlyUp,
  kActionLowerOrFlyDown, kActionChangeMode, kActionSkip, kActionFaceForward,
  kActionRotateUp, kActionRotateDown, kActionRotateLeft, kActionRotateRight,
  kActionTurnBack, kActionInfoMenu, kActionIncreaseStepSize, kActionDecreaseStepSize,
  kActionToggleFlyMode, kActionToggleClipMode, kActionDeployDrillingRig, kActionCollectDrillingRig,
  kActionRollLeft, kActionRollRight, kActionRest, kActionRunMode,
  kActionWalkMode, kActionCrawlMode, kActionRunModifier, kActionSelectPrince,
  kActionSelectPrincess, kActionQuit, kActionToggleFlashlight, kActionToggleStereoscopic,
  kActionUnknownKey, kActionWait
}
 
enum  {
  kFreescapeDebugMove = 1, kFreescapeDebugParser, kFreescapeDebugCode, kFreescapeDebugMedia,
  kFreescapeDebugGroup
}
 
enum  { kFreescapeDefaultVolume = 192 }
 
enum  GameStateControl {
  kFreescapeGameStateStart, kFreescapeGameStatePlaying, kFreescapeGameStateDemo, kFreescapeGameStateEnd,
  kFreescapeGameStateRestart
}
 
enum  GameReleaseFlags {
  GF_AMIGA_RETAIL = (1 << 0), GF_AMIGA_BUDGET = (1 << 1), GF_ZX_RETAIL = (1 << 2), GF_ZX_BUDGET = (1 << 3),
  GF_ZX_DISC = (1 << 4), GF_CPC_RETAIL = (1 << 5), GF_CPC_RETAIL_ALT = (1 << 6), GF_CPC_BUDGET = (1 << 7),
  GF_CPC_VIRTUALWORLDS = (1 << 8), GF_ATARI_RETAIL = (1 << 9), GF_ATARI_BUDGET = (1 << 10), GF_C64_TAPE = (1 << 11),
  GF_C64_DISC = (1 << 12), GF_C64_PACKED = (1 << 13)
}
 
enum  { kVariableDarkEnding = 28, kVariableDarkECD = 29, kVariableActiveECDs = 60 }
 
enum  { kDarkEndingEvathDestroyed = 1, kDarkEndingECDsDestroyed = 2 }
 
enum  DarkFontSize { kDarkFontSmall, kDarkFontMedium, kDarkFontBig }
 
enum  DrillerFontSize { kDrillerFontSmall, kDrillerFontNormal }
 
enum  DrillerReleaseFlags { GF_AMIGA_MAGAZINE_DEMO = (1 << 0), GF_ATARI_MAGAZINE_DEMO = (1 << 1) }
 
enum  EclipseReleaseFlags { GF_ZX_DEMO_CRASH = (1 << 0), GF_ZX_DEMO_MICROHOBBY = (1 << 1) }
 
enum  { kVariableEclipse2SphinxParts = 1, kVariableEclipseAnkhs = 32 }
 
enum  FCLExecutionResult { kFCLFinished, kFCLYielded, kFCLPaused }
 
enum  {
  kConditionalShot = 1 << 0, kConditionalTimeout = 1 << 1, kConditionalCollided = 1 << 2, kConditionalActivated = 1 << 3,
  kConditionalSensed = 1 << 4, kConditionalFallen = 1 << 5, kConditionalCrushed = 1 << 6
}
 
enum  { k8bitGameBitTravelRock = 30 }
 
enum  {
  k8bitVariableCrawling = 30, k8bitVariableSpiritsDestroyed = 28, k8bitVariableEnergy = 62, k8bitVariableScore = 61,
  k8bitVariableShieldDrillerTank = 60, k8bitVariableEnergyDrillerTank = 59, k8bitVariableShieldDrillerJet = 58, k8bitVariableEnergyDrillerJet = 57,
  k8bitMaxVariable = 64
}
 
enum  ObjectType {
  kEntranceType = 0, kCubeType = 1, kSensorType = 2, kRectangleType = 3,
  kEastPyramidType = 4, kWestPyramidType = 5, kUpPyramidType = 6, kDownPyramidType = 7,
  kNorthPyramidType = 8, kSouthPyramidType = 9, kLineType = 10, kTriangleType = 11,
  kQuadrilateralType = 12, kPentagonType = 13, kHexagonType = 14, kGroupType = 15
}
 
enum  SIDRegs {
  kSIDV1FreqLo = 0x00, kSIDV1FreqHi = 0x01, kSIDV1PwLo = 0x02, kSIDV1PwHi = 0x03,
  kSIDV1Ctrl = 0x04, kSIDV1AD = 0x05, kSIDV1SR = 0x06, kSIDV2FreqLo = 0x07,
  kSIDV2FreqHi = 0x08, kSIDV2PwLo = 0x09, kSIDV2PwHi = 0x0A, kSIDV2Ctrl = 0x0B,
  kSIDV2AD = 0x0C, kSIDV2SR = 0x0D, kSIDV3FreqLo = 0x0E, kSIDV3FreqHi = 0x0F,
  kSIDV3PwLo = 0x10, kSIDV3PwHi = 0x11, kSIDV3Ctrl = 0x12, kSIDV3AD = 0x13,
  kSIDV3SR = 0x14, kSIDFilterLo = 0x15, kSIDFilterHi = 0x16, kSIDFilterCtrl = 0x17,
  kSIDVolume = 0x18
}
 

Functions

bool isEncodedCPCDirectColor (uint8 index)
 
uint8 encodeCPCDirectColor (uint8 index)
 
uint8 decodeCPCDirectColor (uint8 index)
 
Common::String shiftStr (const Common::String &str, int shift)
 
Common::String centerAndPadString (const Common::String &str, int size)
 
Graphics::ManagedSurface * readCPCImage (Common::SeekableReadStream *file, bool mode1)
 
Sound * createCastleC64Sound (Audio::Mixer *mixer, const Common::Array< byte > &data)
 
void enableCastleC64Sound (Sound *sound, bool enabled)
 
void updateCastleC64GhostSound (Sound *sound, bool active)
 
const Graphics::PixelFormat getRGBAPixelFormat ()
 
byte getCPCPixelMode1 (byte cpc_byte, int index)
 
byte getCPCPixelMode0 (byte cpc_byte, int index)
 
byte getCPCPixel (byte cpc_byte, int index, bool mode1)
 
Graphics::RendererType determinateRenderType ()
 
Renderer * CreateGfxOpenGL (int screenW, int screenH, Common::RenderMode renderMode, bool authenticGraphics)
 
Renderer * CreateGfxOpenGLShader (int screenW, int screenH, Common::RenderMode renderMode, bool authenticGraphics)
 
Renderer * CreateGfxTinyGL (int screenW, int screenH, Common::RenderMode renderMode)
 
Renderer * createRenderer (int screenW, int screenH, Common::RenderMode renderMode, bool authenticGraphics)
 
Common::String detokeniseFreescapeCondition (const Common::Array< uint16 > &tokenisedCondition, FCLInstructionVector &instructions, bool isAmigaAtari)
 
Common::String detokeniseKit8Condition (const Common::Array< byte > &tokenisedCondition, FCLInstructionVector &instructions)
 
Common::String detokeniseKit16Condition (const Common::Array< byte > &tokenisedCondition, FCLInstructionVector &instructions)
 
void normaliseKitOperands (FCLInstruction &instruction)
 
template<uint N>
const FCLOpcode * findFCLOpcode (const FCLOpcode(&opcodes)[N], byte opcode)
 
FCLInstructionVector * duplicateCondition (const FCLInstructionVector *condition)
 
Sound * createKitAdLibSound (Audio::Mixer *mixer, const Common::Array< byte > &data)
 
Math::AABB createPlayerAABB (Math::Vector3d const position, int playerHeight, float reductionHeight=0.0f)
 
float sweepAABB (Math::AABB const &a, Math::AABB const &b, Math::Vector3d const &direction, Math::Vector3d &normal)
 
Audio::AudioStream * makeWallyBebenStream (const byte *data, uint32 dataSize, int songNum=1, int rate=44100, bool stereo=true, const WBTableOffsets *offsets=nullptr)
 
MusicPlayer * makeWallyBebenAtariPlayer (const byte *data, uint32 dataSize, const WBAtariTableOffsets &offsets, int songNum=1)
 
bool extractZxSpectrumTapeFiles (Common::SeekableReadStream &stream, const char *prefix, ZxTapeFileList &files)
 
bool matchZxSpectrumTapeFiles (const ZxTapeFileList &files, const ADGameDescription &desc, uint md5Bytes=5000)
 
Common::Archive * makeZxSpectrumTapeArchive (const ADGameDescription &desc, const Common::Path &gamePath)
 

Variables

byte kEGADefaultPalette [16][3]
 
byte kCGAPaletteRedGreen [4][3]
 
byte kCGAPalettePinkBlue [4][3]
 
byte kCGAPalettePinkBlueBright [4][3]
 
byte kCGAPaletteRedGreenBright [4][3]
 
byte kHerculesPaletteGreen [2][3]
 
FreescapeEngine * g_freescape
 
Debugger * g_debugger
 
const uint8_t frq_lo [96]
 
const uint8_t frq_hi [96]
 
const uint8_t instrumentDataA0 []
 
const uint8_t instrumentDataA1 []
 
const int NUM_INSTRUMENTS
 
const uint8_t arpeggio_data []
 
const uint8_t *const pattern_addresses []
 
const int NUM_PATTERNS
 
const uint8_t tune_tempo_data []
 
const uint8_t *const tune_track_data [][3]
 
const int NUM_TUNES
 
const uint8_t initialSomethingData [][3]
 
const uint8_t initialInstrumentIndex []
 
const uint8_t initialSomethingElseData [][3]
 
const uint8_t initialCtrl0 []
 
const uint8_t initialPwDirection []
 
const uint8_t initialStuffData [][7]
 
const uint8_t initialThingsData [][7]
 
const uint8_t initialTwoCtr []
 
uint8 k8bitVariableShield
 
const WBAtariTableOffsets kEclipseAtariOffsets
 
const WBAtariTableOffsets kDarkSideAtariOffsets
 

Detailed Description

Shared music data for Castle Master backported music players.

Song data extracted from the default subtune in the C64 PSID. The order lists are expanded from the original repeat commands, while the pattern data remains in the original note/rest/instrument command format.

Dark Side song data, extracted from the C64 build (darkside.prg, load address $0400). Shared by the SID player and the AdLib rendition; the patterns are byte-identical to the ones in the Atari ST and Amiga modules.

Shared music data for Total Eclipse backported music players.

Song data extracted from the C64 version's Wally Beben music engine. The shared instrument table strips SID-only pulse-width fields, but the original pulse-width values are kept below for ports that can use them. This header is included by both the AY and OPL player implementations.

Function Documentation

◆ makeWallyBebenStream()

Audio::AudioStream* Freescape::makeWallyBebenStream ( const byte *  data,
uint32  dataSize,
int  songNum = 1,
int  rate = 44100,
bool  stereo = true,
const WBTableOffsets *  offsets = nullptr 
)

Create a music stream for the Wally Beben custom music engine used in the Amiga versions of Dark Side and Total Eclipse.

Parameters
dataRaw TEXT segment data (after 0x1C GEMDOS header)
dataSizeSize of the TEXT segment
songNumSong number to play (1 or 2)
rateOutput sample rate
stereoWhether to produce stereo output
offsetsTable offsets (nullptr = Dark Side defaults)
Returns
A new AudioStream, or nullptr on error

◆ makeWallyBebenAtariPlayer()

MusicPlayer* Freescape::makeWallyBebenAtariPlayer ( const byte *  data,
uint32  dataSize,
const WBAtariTableOffsets &  offsets,
int  songNum = 1 
)

Create a player for the Atari ST music engine used by Total Eclipse (TEMUSIC.ST) and Dark Side (DSMUSIC2.ST).

Parameters
dataRaw TEXT segment data, after the 0x1C GEMDOS header
offsetsTable offsets for this release
songNumSong number to play (1 or 2)