DiscIO: Move parts of Filesystem to the new file DiscExtractor

Source/Core/DiscIO/CMakeLists.txt

@@ -3,6 +3,7 @@ set(SRCS
   CISOBlob.cpp
   WbfsBlob.cpp
   CompressedBlob.cpp
+  DiscExtractor.cpp
   DiscScrubber.cpp
   DriveBlob.cpp
   Enums.cpp

Source/Core/DiscIO/DiscExtractor.cpp

@@ -0,0 +1,174 @@
+// Copyright 2017 Dolphin Emulator Project
+// Licensed under GPLv2+
+// Refer to the license.txt file included.
+
+#include "DiscIO/DiscExtractor.h"
+
+#include <algorithm>
+#include <cinttypes>
+#include <optional>
+
+#include "Common/CommonTypes.h"
+#include "DiscIO/Enums.h"
+#include "DiscIO/Filesystem.h"
+#include "DiscIO/Volume.h"
+
+namespace DiscIO
+{
+u64 ReadFile(const Volume& volume, const Partition& partition, const FileInfo* file_info,
+             u8* buffer, u64 max_buffer_size, u64 offset_in_file)
+{
+  if (!file_info || file_info->IsDirectory())
+    return 0;
+
+  if (offset_in_file >= file_info->GetSize())
+    return 0;
+
+  u64 read_length = std::min(max_buffer_size, file_info->GetSize() - offset_in_file);
+
+  DEBUG_LOG(DISCIO, "Reading %" PRIx64 " bytes at %" PRIx64 " from file %s. Offset: %" PRIx64
+                    " Size: %" PRIx32,
+            read_length, offset_in_file, file_info->GetPath().c_str(), file_info->GetOffset(),
+            file_info->GetSize());
+
+  volume.Read(file_info->GetOffset() + offset_in_file, read_length, buffer, partition);
+
+  return read_length;
+}
+
+bool ExportFile(const Volume& volume, const Partition& partition, const FileInfo* file_info,
+                const std::string& export_filename)
+{
+  if (!file_info || file_info->IsDirectory())
+    return false;
+
+  u64 remaining_size = file_info->GetSize();
+  u64 file_offset = file_info->GetOffset();
+
+  File::IOFile f(export_filename, "wb");
+  if (!f)
+    return false;
+
+  bool result = true;
+
+  while (remaining_size)
+  {
+    // Limit read size to 128 MB
+    size_t read_size = (size_t)std::min(remaining_size, (u64)0x08000000);
+
+    std::vector<u8> buffer(read_size);
+
+    result = volume.Read(file_offset, read_size, &buffer[0], partition);
+
+    if (!result)
+      break;
+
+    f.WriteBytes(&buffer[0], read_size);
+
+    remaining_size -= read_size;
+    file_offset += read_size;
+  }
+
+  return result;
+}
+
+bool ExportApploader(const Volume& volume, const Partition& partition,
+                     const std::string& export_folder)
+{
+  if (!IsDisc(volume.GetVolumeType()))
+    return false;
+
+  std::optional<u32> apploader_size = volume.ReadSwapped<u32>(0x2440 + 0x14, partition);
+  const std::optional<u32> trailer_size = volume.ReadSwapped<u32>(0x2440 + 0x18, partition);
+  constexpr u32 header_size = 0x20;
+  if (!apploader_size || !trailer_size)
+    return false;
+  *apploader_size += *trailer_size + header_size;
+  DEBUG_LOG(DISCIO, "Apploader size -> %x", *apploader_size);
+
+  std::vector<u8> buffer(*apploader_size);
+  if (volume.Read(0x2440, *apploader_size, buffer.data(), partition))
+  {
+    std::string export_name(export_folder + "/apploader.img");
+
+    File::IOFile apploader_file(export_name, "wb");
+    if (apploader_file)
+    {
+      apploader_file.WriteBytes(buffer.data(), *apploader_size);
+      return true;
+    }
+  }
+
+  return false;
+}
+
+std::optional<u64> GetBootDOLOffset(const Volume& volume, const Partition& partition)
+{
+  const Platform volume_type = volume.GetVolumeType();
+  if (!IsDisc(volume_type))
+    return {};
+
+  std::optional<u32> offset = volume.ReadSwapped<u32>(0x420, partition);
+  const u8 offset_shift = volume_type == Platform::WII_DISC ? 2 : 0;
+  return offset ? static_cast<u64>(*offset) << offset_shift : std::optional<u64>();
+}
+
+std::optional<u32> GetBootDOLSize(const Volume& volume, const Partition& partition, u64 dol_offset)
+{
+  if (!IsDisc(volume.GetVolumeType()))
+    return {};
+
+  u32 dol_size = 0;
+
+  // Iterate through the 7 code segments
+  for (u8 i = 0; i < 7; i++)
+  {
+    const std::optional<u32> offset = volume.ReadSwapped<u32>(dol_offset + 0x00 + i * 4, partition);
+    const std::optional<u32> size = volume.ReadSwapped<u32>(dol_offset + 0x90 + i * 4, partition);
+    if (!offset || !size)
+      return {};
+    dol_size = std::max(*offset + *size, dol_size);
+  }
+
+  // Iterate through the 11 data segments
+  for (u8 i = 0; i < 11; i++)
+  {
+    const std::optional<u32> offset = volume.ReadSwapped<u32>(dol_offset + 0x1c + i * 4, partition);
+    const std::optional<u32> size = volume.ReadSwapped<u32>(dol_offset + 0xac + i * 4, partition);
+    if (!offset || !size)
+      return {};
+    dol_size = std::max(*offset + *size, dol_size);
+  }
+
+  return dol_size;
+}
+
+bool ExportDOL(const Volume& volume, const Partition& partition, const std::string& export_folder)
+{
+  if (!IsDisc(volume.GetVolumeType()))
+    return false;
+
+  std::optional<u64> dol_offset = GetBootDOLOffset(volume, partition);
+  if (!dol_offset)
+    return false;
+  std::optional<u32> dol_size = GetBootDOLSize(volume, partition, *dol_offset);
+  if (!dol_size)
+    return false;
+
+  std::vector<u8> buffer(*dol_size);
+  if (volume.Read(*dol_offset, *dol_size, buffer.data(), partition))
+  {
+    std::string export_name(export_folder + "/boot.dol");
+
+    File::IOFile dol_file(export_name, "wb");
+    if (dol_file)
+    {
+      dol_file.WriteBytes(&buffer[0], *dol_size);
+      return true;
+    }
+  }
+
+  return false;
+}
+
+}  // namespace DiscIO

Source/Core/DiscIO/DiscExtractor.h

@@ -0,0 +1,27 @@
+// Copyright 2017 Dolphin Emulator Project
+// Licensed under GPLv2+
+// Refer to the license.txt file included.
+
+#pragma once
+
+#include <optional>
+
+#include "Common/CommonTypes.h"
+
+namespace DiscIO
+{
+class FileInfo;
+struct Partition;
+class Volume;
+
+u64 ReadFile(const Volume& volume, const Partition& partition, const FileInfo* file_info,
+             u8* buffer, u64 max_buffer_size, u64 offset_in_file = 0);
+bool ExportFile(const Volume& volume, const Partition& partition, const FileInfo* file_info,
+                const std::string& export_filename);
+bool ExportApploader(const Volume& volume, const Partition& partition,
+                     const std::string& export_folder);
+std::optional<u64> GetBootDOLOffset(const Volume& volume, const Partition& partition);
+std::optional<u32> GetBootDOLSize(const Volume& volume, const Partition& partition, u64 dol_offset);
+bool ExportDOL(const Volume& volume, const Partition& partition, const std::string& export_folder);
+
+}  // namespace DiscIO

Source/Core/DiscIO/DiscIO.vcxproj

@@ -39,6 +39,7 @@
     <ClCompile Include="Blob.cpp" />
     <ClCompile Include="CISOBlob.cpp" />
     <ClCompile Include="CompressedBlob.cpp" />
+    <ClCompile Include="DiscExtractor.cpp" />
     <ClCompile Include="DiscScrubber.cpp" />
     <ClCompile Include="DriveBlob.cpp" />
     <ClCompile Include="Enums.cpp" />
@@ -60,6 +61,7 @@
     <ClInclude Include="Blob.h" />
     <ClInclude Include="CISOBlob.h" />
     <ClInclude Include="CompressedBlob.h" />
+    <ClInclude Include="DiscExtractor.h" />
     <ClInclude Include="DiscScrubber.h" />
     <ClInclude Include="DriveBlob.h" />
     <ClInclude Include="Enums.h" />

Source/Core/DiscIO/DiscIO.vcxproj.filters

@@ -1,6 +1,9 @@
 <?xml version="1.0" encoding="utf-8"?>
 <Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <ItemGroup>
+    <Filter Include="DiscExtractor">
+      <UniqueIdentifier>{51cdf366-d3fe-464a-9f89-c9f1592a6f1c}</UniqueIdentifier>
+    </Filter>
     <Filter Include="DiscScrubber">
       <UniqueIdentifier>{3873659a-9a30-4a58-af9e-8dad7d7eb627}</UniqueIdentifier>
     </Filter>
@@ -75,6 +78,9 @@
     <ClCompile Include="TGCBlob.cpp">
       <Filter>Volume\Blob</Filter>
     </ClCompile>
+    <ClCompile Include="DiscExtractor.cpp">
+      <Filter>DiscExtractor</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="DiscScrubber.h">
@@ -134,6 +140,9 @@
     <ClInclude Include="TGCBlob.h">
       <Filter>Volume\Blob</Filter>
     </ClInclude>
+    <ClInclude Include="DiscExtractor.h">
+      <Filter>DiscExtractor</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <Text Include="CMakeLists.txt" />

Source/Core/DiscIO/DiscScrubber.cpp

@@ -2,6 +2,8 @@
 // Licensed under GPLv2+
 // Refer to the license.txt file included.
 
+#include "DiscIO/DiscScrubber.h"
+
 #include <algorithm>
 #include <cinttypes>
 #include <cstddef>
@@ -14,7 +16,8 @@
 #include "Common/CommonTypes.h"
 #include "Common/File.h"
 #include "Common/Logging/Log.h"
-#include "DiscIO/DiscScrubber.h"
+
+#include "DiscIO/DiscExtractor.h"
 #include "DiscIO/Filesystem.h"
 #include "DiscIO/Volume.h"
 
@@ -200,10 +203,10 @@ bool DiscScrubber::ParsePartitionData(const Partition& partition, PartitionHeade
               0x2440 + header->apploader_size + header->apploader_trailer_size);
 
   // DOL
-  const std::optional<u64> dol_offset = filesystem->GetBootDOLOffset();
+  const std::optional<u64> dol_offset = GetBootDOLOffset(*m_disc, partition);
   if (!dol_offset)
     return false;
-  const std::optional<u64> dol_size = filesystem->GetBootDOLSize(*dol_offset);
+  const std::optional<u64> dol_size = GetBootDOLSize(*m_disc, partition, *dol_offset);
   if (!dol_size)
     return false;
   header->dol_offset = *dol_offset;

Source/Core/DiscIO/FileSystemGCWii.cpp

@@ -330,148 +330,4 @@ std::unique_ptr<FileInfo> FileSystemGCWii::FindFileInfo(u64 disc_offset) const
   return nullptr;
 }
 
-u64 FileSystemGCWii::ReadFile(const FileInfo* file_info, u8* buffer, u64 max_buffer_size,
-                              u64 offset_in_file) const
-{
-  if (!file_info || file_info->IsDirectory())
-    return 0;
-
-  if (offset_in_file >= file_info->GetSize())
-    return 0;
-
-  u64 read_length = std::min(max_buffer_size, file_info->GetSize() - offset_in_file);
-
-  DEBUG_LOG(DISCIO, "Reading %" PRIx64 " bytes at %" PRIx64 " from file %s. Offset: %" PRIx64
-                    " Size: %" PRIx32,
-            read_length, offset_in_file, file_info->GetPath().c_str(), file_info->GetOffset(),
-            file_info->GetSize());
-
-  m_volume->Read(file_info->GetOffset() + offset_in_file, read_length, buffer, m_partition);
-  return read_length;
-}
-
-bool FileSystemGCWii::ExportFile(const FileInfo* file_info,
-                                 const std::string& export_filename) const
-{
-  if (!file_info || file_info->IsDirectory())
-    return false;
-
-  u64 remaining_size = file_info->GetSize();
-  u64 file_offset = file_info->GetOffset();
-
-  File::IOFile f(export_filename, "wb");
-  if (!f)
-    return false;
-
-  bool result = true;
-
-  while (remaining_size)
-  {
-    // Limit read size to 128 MB
-    size_t read_size = (size_t)std::min(remaining_size, (u64)0x08000000);
-
-    std::vector<u8> buffer(read_size);
-
-    result = m_volume->Read(file_offset, read_size, &buffer[0], m_partition);
-
-    if (!result)
-      break;
-
-    f.WriteBytes(&buffer[0], read_size);
-
-    remaining_size -= read_size;
-    file_offset += read_size;
-  }
-
-  return result;
-}
-
-bool FileSystemGCWii::ExportApploader(const std::string& export_folder) const
-{
-  std::optional<u32> apploader_size = m_volume->ReadSwapped<u32>(0x2440 + 0x14, m_partition);
-  const std::optional<u32> trailer_size = m_volume->ReadSwapped<u32>(0x2440 + 0x18, m_partition);
-  constexpr u32 header_size = 0x20;
-  if (!apploader_size || !trailer_size)
-    return false;
-  *apploader_size += *trailer_size + header_size;
-  DEBUG_LOG(DISCIO, "Apploader size -> %x", *apploader_size);
-
-  std::vector<u8> buffer(*apploader_size);
-  if (m_volume->Read(0x2440, *apploader_size, buffer.data(), m_partition))
-  {
-    std::string export_name(export_folder + "/apploader.img");
-
-    File::IOFile apploader_file(export_name, "wb");
-    if (apploader_file)
-    {
-      apploader_file.WriteBytes(buffer.data(), *apploader_size);
-      return true;
-    }
-  }
-
-  return false;
-}
-
-std::optional<u64> FileSystemGCWii::GetBootDOLOffset() const
-{
-  std::optional<u32> offset = m_volume->ReadSwapped<u32>(0x420, m_partition);
-  return offset ? static_cast<u64>(*offset) << m_offset_shift : std::optional<u64>();
-}
-
-std::optional<u32> FileSystemGCWii::GetBootDOLSize(u64 dol_offset) const
-{
-  u32 dol_size = 0;
-
-  // Iterate through the 7 code segments
-  for (u8 i = 0; i < 7; i++)
-  {
-    const std::optional<u32> offset =
-        m_volume->ReadSwapped<u32>(dol_offset + 0x00 + i * 4, m_partition);
-    const std::optional<u32> size =
-        m_volume->ReadSwapped<u32>(dol_offset + 0x90 + i * 4, m_partition);
-    if (!offset || !size)
-      return {};
-    dol_size = std::max(*offset + *size, dol_size);
-  }
-
-  // Iterate through the 11 data segments
-  for (u8 i = 0; i < 11; i++)
-  {
-    const std::optional<u32> offset =
-        m_volume->ReadSwapped<u32>(dol_offset + 0x1c + i * 4, m_partition);
-    const std::optional<u32> size =
-        m_volume->ReadSwapped<u32>(dol_offset + 0xac + i * 4, m_partition);
-    if (!offset || !size)
-      return {};
-    dol_size = std::max(*offset + *size, dol_size);
-  }
-
-  return dol_size;
-}
-
-bool FileSystemGCWii::ExportDOL(const std::string& export_folder) const
-{
-  std::optional<u64> dol_offset = GetBootDOLOffset();
-  if (!dol_offset)
-    return false;
-  std::optional<u32> dol_size = GetBootDOLSize(*dol_offset);
-  if (!dol_size)
-    return false;
-
-  std::vector<u8> buffer(*dol_size);
-  if (m_volume->Read(*dol_offset, *dol_size, buffer.data(), m_partition))
-  {
-    std::string export_name(export_folder + "/boot.dol");
-
-    File::IOFile dol_file(export_name, "wb");
-    if (dol_file)
-    {
-      dol_file.WriteBytes(&buffer[0], *dol_size);
-      return true;
-    }
-  }
-
-  return false;
-}
-
 }  // namespace

Source/Core/DiscIO/FileSystemGCWii.h

@@ -93,14 +93,6 @@ public:
   std::unique_ptr<FileInfo> FindFileInfo(const std::string& path) const override;
   std::unique_ptr<FileInfo> FindFileInfo(u64 disc_offset) const override;
 
-  u64 ReadFile(const FileInfo* file_info, u8* buffer, u64 max_buffer_size,
-               u64 offset_in_file) const override;
-  bool ExportFile(const FileInfo* file_info, const std::string& export_filename) const override;
-  bool ExportApploader(const std::string& export_folder) const override;
-  bool ExportDOL(const std::string& export_folder) const override;
-  std::optional<u64> GetBootDOLOffset() const override;
-  std::optional<u32> GetBootDOLSize(u64 dol_offset) const override;
-
 private:
   bool m_valid;
   u32 m_offset_shift;

Source/Core/DiscIO/Filesystem.h

@@ -120,14 +120,6 @@ public:
   // Returns nullptr if not found
   virtual std::unique_ptr<FileInfo> FindFileInfo(u64 disc_offset) const = 0;
 
-  virtual u64 ReadFile(const FileInfo* file_info, u8* buffer, u64 max_buffer_size,
-                       u64 offset_in_file = 0) const = 0;
-  virtual bool ExportFile(const FileInfo* file_info, const std::string& export_filename) const = 0;
-  virtual bool ExportApploader(const std::string& export_folder) const = 0;
-  virtual bool ExportDOL(const std::string& export_folder) const = 0;
-  virtual std::optional<u64> GetBootDOLOffset() const = 0;
-  virtual std::optional<u32> GetBootDOLSize(u64 dol_offset) const = 0;
-
   virtual const Partition GetPartition() const { return m_partition; }
 protected:
   const Volume* const m_volume;

Source/Core/DiscIO/VolumeGC.cpp

@@ -16,7 +16,9 @@
 #include "Common/Logging/Log.h"
 #include "Common/MsgHandler.h"
 #include "Common/StringUtil.h"
+
 #include "DiscIO/Blob.h"
+#include "DiscIO/DiscExtractor.h"
 #include "DiscIO/Enums.h"
 #include "DiscIO/Filesystem.h"
 #include "DiscIO/Volume.h"
@@ -190,8 +192,8 @@ void VolumeGC::LoadBannerFile() const
     return;
   }
 
-  if (file_size !=
-      file_system->ReadFile(file_info.get(), reinterpret_cast<u8*>(&banner_file), file_size))
+  if (file_size != ReadFile(*this, PARTITION_NONE, file_info.get(),
+                            reinterpret_cast<u8*>(&banner_file), file_size))
   {
     WARN_LOG(DISCIO, "Could not read opening.bnr.");
     return;

Source/Core/DiscIO/VolumeWii.cpp

@@ -24,6 +24,7 @@
 #include "Common/Swap.h"
 
 #include "DiscIO/Blob.h"
+#include "DiscIO/DiscExtractor.h"
 #include "DiscIO/Enums.h"
 #include "DiscIO/Filesystem.h"
 #include "DiscIO/Volume.h"
@@ -274,8 +275,8 @@ std::map<Language, std::string> VolumeWii::GetLongNames() const
 
   std::vector<u8> opening_bnr(NAMES_TOTAL_BYTES);
   std::unique_ptr<FileInfo> file_info = file_system->FindFileInfo("opening.bnr");
-  opening_bnr.resize(
-      file_system->ReadFile(file_info.get(), opening_bnr.data(), opening_bnr.size(), 0x5C));
+  opening_bnr.resize(ReadFile(*this, GetGamePartition(), file_info.get(), opening_bnr.data(),
+                              opening_bnr.size(), 0x5C));
   return ReadWiiNames(opening_bnr);
 }