dolphin/Source/Core/DiscIO/VolumeDirectory.h

// Copyright 2008 Dolphin Emulator Project
// Licensed under GPLv2+
// Refer to the license.txt file included.

#pragma once

#include <map>
#include <memory>
#include <string>
#include <vector>

#include "Common/CommonTypes.h"
#include "DiscIO/Blob.h"
#include "DiscIO/Volume.h"

namespace File { struct FSTEntry; }

//
// --- this volume type is used for reading files directly from the hard drive ---
//

namespace DiscIO
{

class CVolumeDirectory : public IVolume
{
public:

	CVolumeDirectory(const std::string& _rDirectory, bool _bIsWii,
		const std::string& _rApploader = "", const std::string& _rDOL = "");

	~CVolumeDirectory();

	static bool IsValidDirectory(const std::string& _rDirectory);

	bool Read(u64 _Offset, u64 _Length, u8* _pBuffer, bool decrypt) const override;

	std::string GetUniqueID() const override;
	void SetUniqueID(const std::string& _ID);

	std::string GetMakerID() const override;

	u16 GetRevision() const override { return 0; }
	std::string GetInternalName() const override;
	std::map<IVolume::ELanguage, std::string> GetNames(bool prefer_long) const override;
	std::vector<u32> GetBanner(int* width, int* height) const override;
	void SetName(const std::string&);

	u64 GetFSTSize() const override;

	std::string GetApploaderDate() const override;
	EPlatform GetVolumeType() const override;

	ECountry GetCountry() const override;

	BlobType GetBlobType() const override;
	u64 GetSize() const override;
	u64 GetRawSize() const override;

	void BuildFST();

private:
	static std::string ExtractDirectoryName(const std::string& _rDirectory);

	void SetDiskTypeWii();
	void SetDiskTypeGC();

	bool SetApploader(const std::string& _rApploader);

	void SetDOL(const std::string& _rDOL);

	// writing to read buffer
	void WriteToBuffer(u64 _SrcStartAddress, u64 _SrcLength, const u8* _Src,
					   u64& _Address, u64& _Length, u8*& _pBuffer) const;

	void PadToAddress(u64 _StartAddress, u64& _Address, u64& _Length, u8*& _pBuffer) const;

	void Write32(u32 data, u32 offset, std::vector<u8>* const buffer);

	// FST creation
	void WriteEntryData(u32& entryOffset, u8 type, u32 nameOffset, u64 dataOffset, u64 length);
	void WriteEntryName(u32& nameOffset, const std::string& name);
	void WriteEntry(const File::FSTEntry& entry, u32& fstOffset, u32& nameOffset, u64& dataOffset, u32 parentEntryNum);

	// returns number of entries found in _Directory
	u64 AddDirectoryEntries(const std::string& _Directory, File::FSTEntry& parentEntry);

	std::string m_rootDirectory;

	std::map<u64, std::string> m_virtualDisk;

	u32 m_totalNameSize;

	bool m_is_wii;

	// GameCube has no shift, Wii has 2 bit shift
	u32 m_addressShift;

	// first address on disk containing file data
	u64 m_dataStartAddress;

	u64 m_fstNameOffset;
	std::vector<u8> m_FSTData;

	std::vector<u8> m_diskHeader;

	#pragma pack(push, 1)
	struct SDiskHeaderInfo
	{
		u32 debug_mntr_size;
		u32 simulated_mem_size;
		u32 arg_offset;
		u32 debug_flag;
		u32 track_location;
		u32 track_size;
		u32 country_code;
		u32 unknown;
		u32 unknown2;

		// All the data is byteswapped
		SDiskHeaderInfo()
		{
			debug_mntr_size = 0;
			simulated_mem_size = 0;
			arg_offset = 0;
			debug_flag = 0;
			track_location = 0;
			track_size = 0;
			country_code = 0;
			unknown = 0;
			unknown2 = 0;
		}
	};
	#pragma pack(pop)
	std::unique_ptr<SDiskHeaderInfo> m_diskHeaderInfo;

	std::vector<u8> m_apploader;
	std::vector<u8> m_DOL;

	u64 m_fst_address;
	u64 m_dol_address;

	static constexpr u8 ENTRY_SIZE = 0x0c;
	static constexpr u8 FILE_ENTRY = 0;
	static constexpr u8 DIRECTORY_ENTRY = 1;
	static constexpr u64 DISKHEADER_ADDRESS = 0;
	static constexpr u64 DISKHEADERINFO_ADDRESS = 0x440;
	static constexpr u64 APPLOADER_ADDRESS = 0x2440;
	static const size_t MAX_NAME_LENGTH = 0x3df;
	static const size_t MAX_ID_LENGTH = 6;
};

} // namespace