ShuriZma
/
dolphin
mirror of https://github.com/dolphin-emu/dolphin.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
dolphin/Source/Core/DiscIO/VolumeWad.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

91 lines
3.2 KiB
C
Raw Normal View History

Set copyright year to when a file was created
2015-05-24 04:55:12 +00:00
// Copyright 2008 Dolphin Emulator Project
Update license headers to GPLv2+
2015-05-17 23:08:10 +00:00
// Licensed under GPLv2+
New license header introduced for DiscIO, AudioCommon, InputCommon, VideoCommon, and Common projects.
2013-04-18 03:09:55 +00:00
// Refer to the license.txt file included.
add *.user, Win32, and x64 build dir to ignore list for DebuggerUICommon and Unit Tests add *.aps to ignore list for DolphinWX dir add eol-style native to 120 or so files git-svn-id: https://dolphin-emu.googlecode.com/svn/trunk@3689 8ced0084-cf51-0410-be5f-012b33b47a6e
2009-07-06 02:10:26 +00:00
Replace all include guard ifdefs with "#pragma once"
2014-02-10 18:54:46 +00:00
#pragma once
add *.user, Win32, and x64 build dir to ignore list for DebuggerUICommon and Unit Tests add *.aps to ignore list for DolphinWX dir add eol-style native to 120 or so files git-svn-id: https://dolphin-emu.googlecode.com/svn/trunk@3689 8ced0084-cf51-0410-be5f-012b33b47a6e
2009-07-06 02:10:26 +00:00
Return GetNames languages, to avoid hardcoded language lists in callers This makes the code cleaner and also leads to some user-visible changes: The wx game properties will no longer let the user select WAD languages that don't have any names. The Qt game list will now display names using the languages set in the configuration instead of always using English for PAL GC games and Japanese for WADs. If a WAD doesn't have a name in the user's preferred language, English is now selected as a fallback before Japanese.
2015-04-09 15:44:53 +00:00
#include <map>
DiscIO: Move some raw pointers over to unique_ptr
2014-08-31 13:34:58 +00:00
#include <memory>
DiscIO: Use std::optional for GetTitleID instead of pointer This makes the interface slightly cleaner and a bit more consistent with the other getters. Still not fully the same, since the others don't really handle failures with std::optional; but at least the value is returned by value now, as opposed to having the function take a pointer to a u64.
2017-06-03 19:29:08 +00:00
#include <optional>
Make DiscIO/ mostly IWYU clean (and fix errors in rest of the project detected by this change).
2014-02-21 00:47:53 +00:00
#include <string>
#include <vector>
#include "Common/CommonTypes.h"
Use ESFormats for TMDs We already have a TMDReader, so let's actually use it. And move ESFormats to IOS::ES, since it's definitely part of IOS. This adds a DiscIO dependency on Core which will be fixed in a follow-up PR.
2017-02-11 07:57:47 +00:00
#include "Core/IOS/ES/Formats.h"
Convert all includes to relative paths.
2014-02-17 10:18:15 +00:00
#include "DiscIO/Volume.h"
add *.user, Win32, and x64 build dir to ignore list for DebuggerUICommon and Unit Tests add *.aps to ignore list for DolphinWX dir add eol-style native to 120 or so files git-svn-id: https://dolphin-emu.googlecode.com/svn/trunk@3689 8ced0084-cf51-0410-be5f-012b33b47a6e
2009-07-06 02:10:26 +00:00
namespace DiscIO
{
DiscIO: Remove C/I/S prefixes from class names These prefixes were inconsistent with the rest of Dolphin. I'm also renaming VolumeWiiCrypted to VolumeWii because of 1113b13.
2017-06-06 09:49:01 +00:00
class BlobReader;
Move DiscIO enums to a new file At first there weren't many enums in Volume.h, but the number has been growing, and I'm planning to add one more for regions. To not make Volume.h too large, and to avoid needing to include Volume.h in code that doesn't use volume objects, I'm moving the enums to a new file. I'm also turning them into enum classes while I'm at it.
2016-07-06 18:33:05 +00:00
enum class BlobType;
enum class Country;
DiscIO: Use Common::Lazy for loading filesystems This simplifies FileMonitor a lot and also lets us clean up FilesystemPanel.
2017-08-02 16:16:56 +00:00
class FileSystem;
Move DiscIO enums to a new file At first there weren't many enums in Volume.h, but the number has been growing, and I'm planning to add one more for regions. To not make Volume.h too large, and to avoid needing to include Volume.h in code that doesn't use volume objects, I'm moving the enums to a new file. I'm also turning them into enum classes while I'm at it.
2016-07-06 18:33:05 +00:00
enum class Language;
DiscIO: Add GetRegion function and Region enum Instead of needing different switch cases for converting countries to regions in multiple places, we now only need a single country-to-region switch case (in DiscIO/Enums.cpp), and we get a nice Region type.
2016-12-23 17:41:21 +00:00
enum class Region;
Move DiscIO enums to a new file At first there weren't many enums in Volume.h, but the number has been growing, and I'm planning to add one more for regions. To not make Volume.h too large, and to avoid needing to include Volume.h in code that doesn't use volume objects, I'm moving the enums to a new file. I'm also turning them into enum classes while I'm at it.
2016-07-06 18:33:05 +00:00
enum class Platform;
DiscIO: Remove C/I/S prefixes from class names These prefixes were inconsistent with the rest of Dolphin. I'm also renaming VolumeWiiCrypted to VolumeWii because of 1113b13.
2017-06-06 09:49:01 +00:00
class VolumeWAD : public Volume
add *.user, Win32, and x64 build dir to ignore list for DebuggerUICommon and Unit Tests add *.aps to ignore list for DolphinWX dir add eol-style native to 120 or so files git-svn-id: https://dolphin-emu.googlecode.com/svn/trunk@3689 8ced0084-cf51-0410-be5f-012b33b47a6e
2009-07-06 02:10:26 +00:00
{
public:
DiscIO: Remove C/I/S prefixes from class names These prefixes were inconsistent with the rest of Dolphin. I'm also renaming VolumeWiiCrypted to VolumeWii because of 1113b13.
2017-06-06 09:49:01 +00:00
VolumeWAD(std::unique_ptr<BlobReader> reader);
VolumeWiiCrypted: Replace ChangePartition with a partition parameter By removing mutable state in VolumeWiiCrypted, this change makes partition-related code simpler. It also gets rid of other ugly things, like ISOProperties's "over 9000" loop that creates a list of partitions by trying possible combinations, and DiscScrubber's volume swapping that recreates the entire volume when it needs to change partition.
2015-06-13 10:51:24 +00:00
bool Read(u64 offset, u64 length, u8* buffer,
const Partition& partition = PARTITION_NONE) const override;
DiscIO: Use Common::Lazy for loading filesystems This simplifies FileMonitor a lot and also lets us clean up FilesystemPanel.
2017-08-02 16:16:56 +00:00
const FileSystem* GetFileSystem(const Partition& partition = PARTITION_NONE) const override;
DiscIO: Use std::optional for GetTitleID instead of pointer This makes the interface slightly cleaner and a bit more consistent with the other getters. Still not fully the same, since the others don't really handle failures with std::optional; but at least the value is returned by value now, as opposed to having the function take a pointer to a u64.
2017-06-03 19:29:08 +00:00
std::optional<u64> GetTitleID(const Partition& partition = PARTITION_NONE) const override;
VolumeWad: Implement GetTicket
2019-03-23 12:05:42 +00:00
const IOS::ES::TicketReader&
GetTicket(const Partition& partition = PARTITION_NONE) const override;
VolumeWiiCrypted: Cache TMDs and tickets
2017-05-20 16:33:36 +00:00
const IOS::ES::TMDReader& GetTMD(const Partition& partition = PARTITION_NONE) const override;
Volume: Add a GetCertificateChain function
2019-03-21 22:04:44 +00:00
const std::vector<u8>&
GetCertificateChain(const Partition& partition = PARTITION_NONE) const override;
DiscIO: Merge WiiWAD into VolumeWAD These two classes are very similar, so let's merge them.
2019-07-14 16:00:14 +00:00
std::vector<u8> GetContent(u16 index) const override;
VolumeVerifier: Verify WAD contents
2019-03-30 16:42:31 +00:00
std::vector<u64> GetContentOffsets() const override;
VolumeVerifier: Don't read data multiple times
2019-08-05 11:58:27 +00:00
bool CheckContentIntegrity(const IOS::ES::Content& content, const std::vector<u8>& encrypted_data,
const IOS::ES::TicketReader& ticket) const override;
Re-implement FixCommonKeyIndex for WAD files The old implementation of this was not able to distinguish between a title that had the common key index set to 1 because it actually was Korean and a title that had the common key index set to 1 due to fakesigning. This new implementation solves the problem by decrypting a content with each possible common key and checking which result matches the provided SHA-1 hash. The problem that the old implementation causes has only been reported to affect a certain pirated WAD of Chronos Twins DX (WC6EUP), but it's possible that the problem would start affecting more WADs if we add support for the vWii common key (which uses index 2). Adding support for the vWii common key would also prevent us from using the simpler solution of always forcing the index to 0 if the title is not Korean.
2019-07-14 13:01:07 +00:00
bool CheckContentIntegrity(const IOS::ES::Content& content, u64 content_offset,
const IOS::ES::TicketReader& ticket) const override;
IOS::ES::TicketReader GetTicketWithFixedCommonKey() const override;
VolumeWiiCrypted: Replace ChangePartition with a partition parameter By removing mutable state in VolumeWiiCrypted, this change makes partition-related code simpler. It also gets rid of other ugly things, like ISOProperties's "over 9000" loop that creates a list of partitions by trying possible combinations, and DiscScrubber's volume swapping that recreates the entire volume when it needs to change partition.
2015-06-13 10:51:24 +00:00
std::string GetGameID(const Partition& partition = PARTITION_NONE) const override;
Keep track of GameTDB ID separately from game ID The difference between Dolphin's game IDs and GameTDB's game IDs is that GameTDB uses four characters for non-disc titles, whereas Dolphin uses six characters for all titles. This fixes: - TitleDatabase considering Datel discs to be NHL Hitz 2002 - Gecko code downloading not working for discs with IDs starting with P - Cover downloading mixing up discs with channels (e.g. Mario Kart Wii and Mario Kart Channel) and making extra HTTP requests. (Android was actually doing a better job at this than DolphinQt!)
2019-02-23 16:49:06 +00:00
std::string GetGameTDBID(const Partition& partition = PARTITION_NONE) const override;
VolumeWiiCrypted: Replace ChangePartition with a partition parameter By removing mutable state in VolumeWiiCrypted, this change makes partition-related code simpler. It also gets rid of other ugly things, like ISOProperties's "over 9000" loop that creates a list of partitions by trying possible combinations, and DiscScrubber's volume swapping that recreates the entire volume when it needs to change partition.
2015-06-13 10:51:24 +00:00
std::string GetMakerID(const Partition& partition = PARTITION_NONE) const override;
DiscIO: Use std::optional in Volume and Blob
2017-06-04 08:33:14 +00:00
std::optional<u16> GetRevision(const Partition& partition = PARTITION_NONE) const override;
VolumeWiiCrypted: Replace ChangePartition with a partition parameter By removing mutable state in VolumeWiiCrypted, this change makes partition-related code simpler. It also gets rid of other ugly things, like ISOProperties's "over 9000" loop that creates a list of partitions by trying possible combinations, and DiscScrubber's volume swapping that recreates the entire volume when it needs to change partition.
2015-06-13 10:51:24 +00:00
std::string GetInternalName(const Partition& partition = PARTITION_NONE) const override
{
return "";
}
Move DiscIO enums to a new file At first there weren't many enums in Volume.h, but the number has been growing, and I'm planning to add one more for regions. To not make Volume.h too large, and to avoid needing to include Volume.h in code that doesn't use volume objects, I'm moving the enums to a new file. I'm also turning them into enum classes while I'm at it.
2016-07-06 18:33:05 +00:00
std::map<Language, std::string> GetLongNames() const override;
Reimplement custom PNG banners in game list Fixes https://bugs.dolphin-emu.org/issues/10938 and makes PNG banners available in DolphinQt2 for the first time.
2018-03-10 21:41:49 +00:00
std::vector<u32> GetBanner(u32* width, u32* height) const override;
VolumeWiiCrypted: Replace ChangePartition with a partition parameter By removing mutable state in VolumeWiiCrypted, this change makes partition-related code simpler. It also gets rid of other ugly things, like ISOProperties's "over 9000" loop that creates a list of partitions by trying possible combinations, and DiscScrubber's volume swapping that recreates the entire volume when it needs to change partition.
2015-06-13 10:51:24 +00:00
std::string GetApploaderDate(const Partition& partition = PARTITION_NONE) const override
{
return "";
}
Move DiscIO enums to a new file At first there weren't many enums in Volume.h, but the number has been growing, and I'm planning to add one more for regions. To not make Volume.h too large, and to avoid needing to include Volume.h in code that doesn't use volume objects, I'm moving the enums to a new file. I'm also turning them into enum classes while I'm at it.
2016-07-06 18:33:05 +00:00
Platform GetVolumeType() const override;
DiscIO: Add Volume::IsDatelDisc
2020-07-04 12:51:13 +00:00
bool IsDatelDisc() const override;
DolphinQt: Show a warning when launching an NKit disc image It is my opinion that nobody should use NKit disc images without being aware of the drawbacks of them. Since it seems like almost nobody who is using NKit disc images knows what NKit is (hmm, now how could that have happened...?), I am adding a warning to Dolphin so that you can't run NKit disc images without finding out about the drawbacks. In case someone really does want to use NKit disc images, the warning has a "Don't show this again" option. Unfortunately, I can't retroactively add the warning where it's most needed: in Dolphin 5.0, which does not support Wii NKit disc images.
2020-06-15 11:16:01 +00:00
bool IsNKit() const override;
DiscIO: Add GetRegion function and Region enum Instead of needing different switch cases for converting countries to regions in multiple places, we now only need a single country-to-region switch case (in DiscIO/Enums.cpp), and we get a nice Region type.
2016-12-23 17:41:21 +00:00
Region GetRegion() const override;
VolumeWiiCrypted: Replace ChangePartition with a partition parameter By removing mutable state in VolumeWiiCrypted, this change makes partition-related code simpler. It also gets rid of other ugly things, like ISOProperties's "over 9000" loop that creates a list of partitions by trying possible combinations, and DiscScrubber's volume swapping that recreates the entire volume when it needs to change partition.
2015-06-13 10:51:24 +00:00
Country GetCountry(const Partition& partition = PARTITION_NONE) const override;
Reformat all the things. Have fun with merge conflicts.
2016-06-24 08:43:46 +00:00
DiscIO: Add a way to get blob type
2015-09-27 12:01:12 +00:00
BlobType GetBlobType() const override;
clang-modernize -add-override
2014-03-08 00:54:44 +00:00
u64 GetSize() const override;
DiscIO: Add way of checking whether blob data size is accurate
2019-03-21 21:20:23 +00:00
bool IsSizeAccurate() const override;
clang-modernize -add-override
2014-03-08 00:54:44 +00:00
u64 GetRawSize() const override;
DiscIO: Deduplicate some VolumeGC/VolumeWii code
2020-06-04 18:33:52 +00:00
const BlobReader& GetBlobReader() const override;
add *.user, Win32, and x64 build dir to ignore list for DebuggerUICommon and Unit Tests add *.aps to ignore list for DolphinWX dir add eol-style native to 120 or so files git-svn-id: https://dolphin-emu.googlecode.com/svn/trunk@3689 8ced0084-cf51-0410-be5f-012b33b47a6e
2009-07-06 02:10:26 +00:00
private:
DiscIO: Remove C/I/S prefixes from class names These prefixes were inconsistent with the rest of Dolphin. I'm also renaming VolumeWiiCrypted to VolumeWii because of 1113b13.
2017-06-06 09:49:01 +00:00
std::unique_ptr<BlobReader> m_reader;
VolumeWad: Implement GetTicket
2019-03-23 12:05:42 +00:00
IOS::ES::TicketReader m_ticket;
Use ESFormats for TMDs We already have a TMDReader, so let's actually use it. And move ESFormats to IOS::ES, since it's definitely part of IOS. This adds a DiscIO dependency on Core which will be fixed in a follow-up PR.
2017-02-11 07:57:47 +00:00
IOS::ES::TMDReader m_tmd;
Volume: Add a GetCertificateChain function
2019-03-21 22:04:44 +00:00
std::vector<u8> m_cert_chain;
u32 m_cert_chain_offset = 0;
VolumeWad: Implement GetTicket
2019-03-23 12:05:42 +00:00
u32 m_ticket_offset = 0;
VolumeWad: In-class initialise member variables
2017-01-23 17:02:00 +00:00
u32 m_tmd_offset = 0;
VolumeVerifier: Verify WAD contents
2019-03-30 16:42:31 +00:00
u32 m_data_offset = 0;
VolumeWad: In-class initialise member variables
2017-01-23 17:02:00 +00:00
u32 m_opening_bnr_offset = 0;
u32 m_hdr_size = 0;
Volume: Add a GetCertificateChain function
2019-03-21 22:04:44 +00:00
u32 m_cert_chain_size = 0;
VolumeWad: Implement GetTicket
2019-03-23 12:05:42 +00:00
u32 m_ticket_size = 0;
VolumeWad: In-class initialise member variables
2017-01-23 17:02:00 +00:00
u32 m_tmd_size = 0;
u32 m_data_size = 0;
add *.user, Win32, and x64 build dir to ignore list for DebuggerUICommon and Unit Tests add *.aps to ignore list for DolphinWX dir add eol-style native to 120 or so files git-svn-id: https://dolphin-emu.googlecode.com/svn/trunk@3689 8ced0084-cf51-0410-be5f-012b33b47a6e
2009-07-06 02:10:26 +00:00
};
Reformat repo to clang-format 7.0 rules
2019-05-05 23:48:12 +00:00
} // namespace DiscIO