Merge pull request #1570 from nicolasnoble/modconv

Adding modconv tool.

Author: nicolasnoble

Makefile

@@ -169,7 +169,7 @@ SUPPORT_SRCS += third_party/ucl/src/n2e_99.c third_party/ucl/src/alloc.c
 SUPPORT_SRCS += $(wildcard third_party/iec-60908b/*.c)
 OBJECTS := third_party/luajit/src/libluajit.a
 
-TOOLS = exe2elf exe2iso ps1-packer psyq-obj-parser
+TOOLS = exe2elf exe2iso modconv ps1-packer psyq-obj-parser
 
 ##############################################################################
 

azure-pipelines-cli.yml

@@ -64,8 +64,9 @@ steps:
       vsprojects/x64/ReleaseCLI/crashpad_handler.exe
       vsprojects/x64/ReleaseCLI/exe2elf.exe
       vsprojects/x64/ReleaseCLI/exe2iso.exe
-      vsprojects/x64/ReleaseCLI/psyq-obj-parser.exe
+      vsprojects/x64/ReleaseCLI/modconv.exe
       vsprojects/x64/ReleaseCLI/ps1-packer.exe
+      vsprojects/x64/ReleaseCLI/psyq-obj-parser.exe
       vsprojects/x64/ReleaseCLI/*.dll
     TargetFolder: '$(build.artifactStagingDirectory)/binaries'
 
@@ -83,11 +84,12 @@ steps:
       !**\crashpad_handler.exe
       !**\exe2elf.exe
       !**\exe2iso.exe
-      !**\pcsxrunner.exe
-      !**\pcsx-wrapper.exe
+      !**\modconv.exe
       !**\pcsx-redux.exe
-      !**\psyq-obj-parser.exe
+      !**\pcsx-wrapper.exe
+      !**\pcsxrunner.exe
       !**\ps1-packer.exe
+      !**\psyq-obj-parser.exe
       !third_party\**\*.exe
     searchFolder: '$(System.DefaultWorkingDirectory)'
     pathtoCustomTestAdapters: 'GoogleTestAdapter'

azure-pipelines.yml

@@ -72,8 +72,9 @@ steps:
       vsprojects/x64/ReleaseWithClangCL/crashpad_handler.exe
       vsprojects/x64/ReleaseWithClangCL/exe2elf.exe
       vsprojects/x64/ReleaseWithClangCL/exe2iso.exe
-      vsprojects/x64/ReleaseWithClangCL/psyq-obj-parser.exe
+      vsprojects/x64/ReleaseWithClangCL/modconv.exe
       vsprojects/x64/ReleaseWithClangCL/ps1-packer.exe
+      vsprojects/x64/ReleaseWithClangCL/psyq-obj-parser.exe
       vsprojects/x64/ReleaseWithClangCL/*.dll
     TargetFolder: '$(build.artifactStagingDirectory)/binaries'
 
@@ -91,11 +92,12 @@ steps:
       !**\crashpad_handler.exe
       !**\exe2elf.exe
       !**\exe2iso.exe
-      !**\pcsxrunner.exe
+      !**\modconv.exe
       !**\pcsx-redux.main
       !**\pcsx-redux.exe
-      !**\psyq-obj-parser.exe
+      !**\pcsxrunner.exe
       !**\ps1-packer.exe
+      !**\psyq-obj-parser.exe
       !third_party\**\*.exe
     searchFolder: '$(System.DefaultWorkingDirectory)'
     pathtoCustomTestAdapters: 'GoogleTestAdapter'

src/mips/modplayer/README.md

@@ -5,3 +5,5 @@ This code is a reverse engineering of the file MODPLAY.BIN, located in the zip f
 The current API behaves roughly the same the original one. The code should provide information about the alterations made to it.
 
 The demo song, "timewarped", written by [Jesster](https://modarchive.org/index.php?request=view_profile&query=69138), comes from [the modarchive](https://modarchive.org/index.php?request=view_by_moduleid&query=106481) with a [CC BY-NC-SA 3.0](https://creativecommons.org/licenses/by-nc-sa/3.0/) license, allowing non-commercial adaptations. The file has been converted from MOD to HIT using the MODCONV.EXE software provided by Hitmen.
+
+A modern recreation of the MODCONV.EXE software is available within the PCSX-Redux project itself. See the [modconv](https://github.com/grumpycoders/pcsx-redux/tree/main/tools/modconv) folder for more information.

src/mips/modplayer/modplayer.c

@@ -218,7 +218,7 @@ static void MOD_SetBPM(unsigned bpm) {
 
 static struct SPUChannelData s_channelData[24];
 
-uint32_t MOD_Load(const struct MODFileFormat* module) {
+static uint32_t loadInternal(const struct MODFileFormat* module, const uint8_t* sampleData) {
     SPUInit();
     MOD_Channels = MOD_Check(module);
 
@@ -241,8 +241,12 @@ uint32_t MOD_Load(const struct MODFileFormat* module) {
 
     MOD_ModuleData = (const uint8_t*)&module->patternTable[0];
 
-    SPUUploadInstruments(0x1010, MOD_ModuleData + 4 + 128 + MOD_Channels * 0x100 * (maxPatternID + 1),
-                         currentSpuAddress - 0x1010);
+    if (sampleData) {
+        SPUUploadInstruments(0x1010, sampleData, currentSpuAddress - 0x1010);
+    } else {
+        SPUUploadInstruments(0x1010, MOD_ModuleData + 4 + 128 + MOD_Channels * 0x100 * (maxPatternID + 1),
+                             currentSpuAddress - 0x1010);
+    }
 
     MOD_CurrentOrder = 0;
     MOD_CurrentPattern = module->patternTable[0];
@@ -274,6 +278,13 @@ uint32_t MOD_Load(const struct MODFileFormat* module) {
     return 4 + 128 + MOD_Channels * 0x100 * (maxPatternID + 1);
 }
 
+uint32_t MOD_Load(const struct MODFileFormat* module) { return loadInternal(module, NULL); }
+
+unsigned MOD_LoadEx(const struct MODFileFormat* module, const uint8_t* sampleData) {
+    loadInternal(module, sampleData);
+    return MOD_Channels;
+}
+
 void MOD_Silence() {
     SPUInit();
     for (unsigned i = 0; i < 24; i++) {

src/mips/modplayer/modplayer.h

@@ -76,6 +76,17 @@ unsigned MOD_Check(const struct MODFileFormat* module);
 // the SPU.
 uint32_t MOD_Load(const struct MODFileFormat* module);
 
+// Loads the specified module and gets it ready for
+// playback. The pointers have to be aligned to a
+// 4-bytes boundary. Will also setup the SPU. This
+// call is meant to be used with the separate .smp
+// file, which the new modconv.exe tool can generate.
+// Returns the number of channels from the module,
+// or 0 if the module is invalid. No relocation is
+// needed, and the sampleData pointer can simply be
+// freed after this call.
+unsigned MOD_LoadEx(const struct MODFileFormat* module, const uint8_t* sampleData);
+
 // Call this function periodically to play sound. The
 // frequency at which this is called will determine the
 // actual playback speed of the module. Most modules will

src/support/binstruct.h

@@ -29,6 +29,7 @@ SOFTWARE.
 #include <stdint.h>
 
 #include <bit>
+#include <stdexcept>
 #include <string>
 #include <tuple>
 #include <type_traits>
@@ -91,10 +92,6 @@ struct UInt64 : public BasicFieldType<uint64_t, std::endian::little> {
     static constexpr char const typeName[] = "uint64_t";
 };
 
-struct BEInt8 : public BasicFieldType<int8_t, std::endian::big> {
-    static constexpr char const typeName[] = "int8_t";
-};
-
 struct BEInt16 : public BasicFieldType<int16_t, std::endian::big> {
     static constexpr char const typeName[] = "int16_t";
 };
@@ -107,10 +104,6 @@ struct BEInt64 : public BasicFieldType<int64_t, std::endian::big> {
     static constexpr char const typeName[] = "int64_t";
 };
 
-struct BEUInt8 : public BasicFieldType<uint8_t, std::endian::big> {
-    static constexpr char const typeName[] = "uint8_t";
-};
-
 struct BEUInt16 : public BasicFieldType<uint16_t, std::endian::big> {
     static constexpr char const typeName[] = "uint16_t";
 };
@@ -160,11 +153,17 @@ struct CString {
         memcpy(value, v.data(), S);
         return *this;
     }
-    void set(const type &v) { memcpy(value, v.data(), S); }
+    void set(const type &v) {
+        value[S] = 0;
+        memcpy(value, v.data(), S);
+    }
     void serialize(IO<File> f) const { f->write(value, S); }
-    void deserialize(IO<File> f) { f->read(value, S); }
-    void reset() { memset(value, 0, S); }
-    char value[S];
+    void deserialize(IO<File> f) {
+        value[S] = 0;
+        f->read(value, S);
+    }
+    void reset() { memset(value, 0, S + 1); }
+    char value[S + 1];
 };
 
 template <typename FieldType, typename name>
@@ -183,6 +182,70 @@ struct StructField<StructType, irqus::typestring<C...>> : public StructType {
     typedef irqus::typestring<C...> fieldName;
 };
 
+template <typename FieldType, typename name, size_t N>
+struct RepeatedField;
+template <typename FieldType, char... C, size_t N>
+struct RepeatedField<FieldType, irqus::typestring<C...>, N> {
+    RepeatedField() {}
+    typedef irqus::typestring<C...> fieldName;
+    FieldType value[N];
+    FieldType &operator[](size_t i) {
+        if (i >= N) throw std::out_of_range("Index out of range");
+        return value[i];
+    }
+    const FieldType &operator[](size_t i) const {
+        if (i >= N) throw std::out_of_range("Index out of range");
+        return value[i];
+    }
+    void serialize(IO<File> f) const {
+        for (size_t i = 0; i < N; i++) {
+            value[i].serialize(f);
+        }
+    }
+    void deserialize(IO<File> f) {
+        for (size_t i = 0; i < N; i++) {
+            value[i].deserialize(f);
+        }
+    }
+    void reset() {
+        for (size_t i = 0; i < N; i++) {
+            value[i].reset();
+        }
+    }
+};
+
+template <typename FieldType, typename name, size_t N>
+struct RepeatedStruct;
+template <typename FieldType, char... C, size_t N>
+struct RepeatedStruct<FieldType, irqus::typestring<C...>, N> {
+    RepeatedStruct() {}
+    typedef irqus::typestring<C...> fieldName;
+    FieldType value[N];
+    FieldType &operator[](size_t i) {
+        if (i >= N) throw std::out_of_range("Index out of range");
+        return value[i];
+    }
+    const FieldType &operator[](size_t i) const {
+        if (i >= N) throw std::out_of_range("Index out of range");
+        return value[i];
+    }
+    void serialize(IO<File> f) const {
+        for (size_t i = 0; i < N; i++) {
+            value[i].serialize(f);
+        }
+    }
+    void deserialize(IO<File> f) {
+        for (size_t i = 0; i < N; i++) {
+            value[i].deserialize(f);
+        }
+    }
+    void reset() {
+        for (size_t i = 0; i < N; i++) {
+            value[i].reset();
+        }
+    }
+};
+
 template <typename name, typename... fields>
 class Struct;
 template <char... C, typename... fields>
@@ -208,8 +271,8 @@ class Struct<irqus::typestring<C...>, fields...> : private std::tuple<fields...>
     constexpr void reset() {}
     template <size_t index, typename FieldType, typename... nestedFields>
     constexpr void reset() {
-        FieldType &setting = std::get<index>(*this);
-        setting.reset();
+        FieldType &field = std::get<index>(*this);
+        field.reset();
         reset<index + 1, nestedFields...>();
     }
     template <size_t index>

tools/modconv/README.md

@@ -0,0 +1,22 @@
+# MODCONV
+This folder contains a modern recreation of the MODCONV.EXE software, which is used to convert MOD files to HIT files. The original software was [provided by Hitmen](http://hitmen.c02.at/html/psx_tools.html), without source code.
+
+This version has been written from scratch, without reverse engineering, as the file format is fairly simple to understand. This means that the output files will be slightly different from the original software.
+
+Its purpose is to convert [MOD files](https://en.wikipedia.org/wiki/Module_file) to HIT files, which can then be played by the [modplayer library available](https://github.com/grumpycoders/pcsx-redux/tree/main/src/mips/modplayer) in the PCSX-Redux project.
+
+## Usage
+```sh
+modconv input.mod [-s output.smp] [-a amp] -o output.hit
+```
+
+## Arguments
+| Argument | Type | Description |
+|-|-|-|
+| input.mod | mandatory | Specify the input mod file. |
+| -o output.hit | mandatory | Name of the output file. |
+| -s output.smp | optional | Name of the output samples data file. |
+| -a amp | optional | Amplification factor. Default is 175 |
+| -h | optional | Show help. |
+
+If the `-i` argument is not provided, the sample data will be written to the .hit file itself, and can be loaded with the `MOD_Load` function from the modplayer library or the old Hitmen implementation. If the `-i` argument is provided, the sample data will be written into a separate file. Both will need to be loaded with the `MOD_LoadEx` function from the modplayer library, and is not backwards compatible with the old Hitmen implementation. This allows the user to have a simple way to unload the samples data from the main ram after the call to `MOD_LoadEx`, only keeping the .hit file in memory.