daedalus/Source/Core/ROM.h

/*
Copyright (C) 2001 StrmnNrmn

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 program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

*/

#pragma once

#ifndef CORE_ROM_H_
#define CORE_ROM_H_

#include "Core/ROMImage.h"

#include <string>
#include <filesystem>
class RomID
{
	public:
		RomID()
		{
			CRC[0] = 0;
			CRC[1] = 0;
			CountryID = 0;
		}

		RomID( u32 crc1, u32 crc2, u8 country_id )
		{
			CRC[0] = crc1;
			CRC[1] = crc2;
			CountryID = country_id;
		}

		explicit RomID( const ROMHeader & header )
		{
			CRC[0] = header.CRC1;
			CRC[1] = header.CRC2;
			CountryID = header.CountryID;
		}

		bool Empty() const
		{
			return CRC[0] == 0 && CRC[1] == 0 && CountryID == 0;
		}

		bool operator==( const RomID & id ) const		{ return Compare( id ) == 0; }
		bool operator!=( const RomID & id ) const		{ return Compare( id ) != 0; }
		bool operator<( const RomID & rhs ) const		{ return Compare( rhs ) < 0; }

		s32 Compare( const RomID & rhs ) const
		{
			s32		diff;

			diff = CRC[0] - rhs.CRC[0];
			if( diff != 0 )
				return diff;

			diff = CRC[1] - rhs.CRC[1];
			if( diff != 0 )
				return diff;

			diff = CountryID - rhs.CountryID;
			if( diff != 0 )
				return diff;

			return 0;
		}

		u32		CRC[2];
		u8		CountryID;
};

#include "RomFile/RomSettings.h"

struct SRomPreferences;

// Increase this everytime you add a new hack, don't forget to add it in gGameHackNames too !!!
//
//
//*****************************************************************************
//	Hacks for games etc.
//*****************************************************************************
enum EGameHacks : uint16_t
{
	NO_GAME_HACK = 0,
	GOLDEN_EYE,
	SUPER_BOWLING,
	ZELDA_OOT,
	ZELDA_MM,
	TARZAN,
	PMARIO,
	GEX_GECKO,
	WONDER_PROJECTJ2,
	ANIMAL_CROSSING,
	CHAMELEON_TWIST_2,
	CLAY_FIGHTER_63,
	BODY_HARVEST,
	AIDYN_CRONICLES,
	ISS64,
	DKR,
	YOSHI,
	EXTREME_G2,
	BUCK_BUMBLE,
	WORMS_ARMAGEDDON,
	SIN_PUNISHMENT,
	DK64,
	BANJO_TOOIE,
	WCW_NITRO,
	MAX_HACK_NAMES	//DONT CHANGE THIS! AND SHOULD BE LAST ENTRY
};

//*****************************************************************************
//
//*****************************************************************************
struct RomInfo
{
	std::filesystem::path	mFileName;
	RomID			mRomID;					// The RomID (unique to this rom)

	ROMHeader		rh;						// Copy of the ROM header, correctly byteswapped
	RomSettings 	settings;				// Settings for this rom
	u32				TvType;					// OS_TV_NTSC etc
	ECicType		cic_chip;				// CIC boot chip type
	union
	{
		u32 HACKS_u32;
		struct
		{
			EGameHacks	GameHacks:16;			// Hacks for specific games
			u32			LOAD_T1_HACK:1;			//LOAD T1 texture hack
			u32			T1_HACK:1;				//T1 texture hack
			u32			ZELDA_HACK:1;			//for both MM and OOT
			u32			TLUT_HACK:1;			//Texture look up table hack for palette
			u32			ALPHA_HACK:1;			//HACK for AIDYN CHRONICLES
			u32			DISABLE_LBU_OPT:1;		//Disable memory optimation for
			u32			DISABLE_SIM_CVT_D_S:1;	//Hack to disable sim-CVT_D_S
			u32			SET_ROUND_MODE:1;		//Hack to set rounding mode for the PSP
			u32			Pad8:1;	//free
			u32			Pad9:1;	//free
			u32			PadA:1;	//free
			u32			PadB:1;	//free
			u32			PadC:1;	//free
			u32			PadD:1;	//free
			u32			PadE:1;	//free
			u32			PadF:1;	//free
		};
	};
};

//*****************************************************************************
// Functions
//*****************************************************************************
bool ROM_ReBoot();
void ROM_Unload();
bool ROM_LoadFile();
void ROM_UnloadFile();
bool ROM_LoadFile(const RomID & rom_id, const RomSettings & settings, const SRomPreferences & preferences );

bool ROM_GetRomDetailsByFilename( const std::filesystem::path &filename, RomID * id, u32 * rom_size, ECicType * boot_type );
bool ROM_GetRomDetailsByID( const RomID & id, u32 * rom_size, ECicType * boot_type );
bool ROM_GetRomName( const std::filesystem::path &filename, std::string & game_name );

const char *	ROM_GetCountryNameFromID( u8 country_id );
u32				ROM_GetTvTypeFromID( u8 country_id );
const char *	ROM_GetCicTypeName( ECicType cic_type );

//*****************************************************************************
// Externs (urgh)
//*****************************************************************************
extern RomInfo g_ROM;

#if defined(DAEDALUS_ENABLE_DYNAREC_PROFILE)
extern u32 g_dwNumFrames;
#endif

#endif // CORE_ROM_H_