Kaitai

.gitignore

@@ -5,3 +5,4 @@ build-xcode/
 editables/
 deps/
 .idea/
+build-codex/

CMakeLists.txt

@@ -72,6 +72,11 @@ FetchContent_Declare(readerwriterqueue
     SOURCE_DIR     ${CMAKE_SOURCE_DIR}/deps/readerwriterqueue
 )
 
+FetchContent_Declare(kaitai_runtime
+    GIT_REPOSITORY https://github.com/izzyreal/kaitai_struct_cpp_stl_runtime
+    GIT_TAG        cpp-serialization
+)
+
 FetchContent_Declare(json-schema-validator
     GIT_REPOSITORY https://github.com/pboettch/json-schema-validator.git
     GIT_TAG        2.3.0
@@ -101,6 +106,11 @@ target_include_directories(platform_folders INTERFACE
     $<BUILD_INTERFACE:${PlatformFolders_SOURCE_DIR}>
 )
 
+message(STATUS "Downloading kaitai runtime...")
+set(BUILD_TESTS OFF CACHE BOOL "" FORCE)
+FetchContent_MakeAvailable(kaitai_runtime)
+unset(BUILD_TESTS CACHE)
+
 if(NOT TARGET nlohmann_json::nlohmann_json)
     FetchContent_Declare(json
         URL https://github.com/nlohmann/json/releases/download/v3.12.0/json.tar.xz
@@ -179,7 +189,7 @@ target_include_directories(mpc PUBLIC
     ${readerwriterqueue_SOURCE_DIR}
 )
 
-target_link_libraries(mpc akaifat ghc_filesystem rtmidi samplerate platform_folders nlohmann_json::nlohmann_json nlohmann_json_schema_validator lodepng)
+target_link_libraries(mpc akaifat ghc_filesystem rtmidi samplerate platform_folders nlohmann_json::nlohmann_json nlohmann_json_schema_validator lodepng kaitai_struct_cpp_stl_runtime)
 
 if(MSVC)
   target_compile_options(mpc PRIVATE "/MP")

PARSERS.md

@@ -0,0 +1,105 @@
+# Kaitai Parser Maintenance
+
+This repo vendors generated C++ Kaitai parsers under:
+
+- `src/main/file/kaitai/generated`
+
+The source `.ksy` files live in:
+
+- `/Users/izmar/git/mpc2000xl_kaitai`
+
+The generator we use is the C++ write-capable compiler from:
+
+- `/Users/izmar/git/kaitai_struct`
+- branch: `cpp-serialization`
+
+## Formats currently generated
+
+- `mpc2000xl.snd.ksy`
+- `mpc2000xl.pgm.ksy`
+- `mpc2000xl.aps.ksy`
+- `standard_midi_file_with_running_status.ksy`
+- `mpc2000xl.mid.ksy`
+- `mpc2000xl.all.ksy`
+- `mpc60.set.v1.ksy`
+- `mpc60.snd.v1.ksy`
+- `mpc3000.snd.v2.ksy`
+- `mpc3000.seq.v3.ksy`
+- `mpc3000.all.v3.ksy`
+- `mpc60.seq.body.ksy`
+- `mpc60.seq.v2.ksy`
+- `mpc60.all.body.ksy`
+- `mpc60.all.v2.ksy`
+
+## Regenerate parsers
+
+From anywhere:
+
+```sh
+/Users/izmar/git/kaitai_struct/compiler/jvm/target/universal/stage/bin/kaitai-struct-compiler \
+  -t cpp_stl \
+  --cpp-standard 11 \
+  -w \
+  --outdir /Users/izmar/git/vmpc-juce/editables/mpc/src/main/file/kaitai/generated \
+  -I /Users/izmar/git/mpc2000xl_kaitai \
+  /Users/izmar/git/mpc2000xl_kaitai/mpc2000xl.snd.ksy \
+  /Users/izmar/git/mpc2000xl_kaitai/mpc2000xl.pgm.ksy \
+  /Users/izmar/git/mpc2000xl_kaitai/mpc2000xl.aps.ksy \
+  /Users/izmar/git/mpc2000xl_kaitai/standard_midi_file_with_running_status.ksy \
+  /Users/izmar/git/mpc2000xl_kaitai/mpc2000xl.mid.ksy \
+  /Users/izmar/git/mpc2000xl_kaitai/mpc2000xl.all.ksy \
+  /Users/izmar/git/mpc2000xl_kaitai/mpc60.set.v1.ksy \
+  /Users/izmar/git/mpc2000xl_kaitai/mpc60.snd.v1.ksy \
+  /Users/izmar/git/mpc2000xl_kaitai/mpc3000.snd.v2.ksy \
+  /Users/izmar/git/mpc2000xl_kaitai/mpc3000.seq.v3.ksy \
+  /Users/izmar/git/mpc2000xl_kaitai/mpc3000.all.v3.ksy \
+  /Users/izmar/git/mpc2000xl_kaitai/mpc60.seq.body.ksy \
+  /Users/izmar/git/mpc2000xl_kaitai/mpc60.seq.v2.ksy \
+  /Users/izmar/git/mpc2000xl_kaitai/mpc60.all.body.ksy \
+  /Users/izmar/git/mpc2000xl_kaitai/mpc60.all.v2.ksy
+```
+
+## Typical update flow
+
+1. Change the relevant `.ksy` file in `mpc2000xl_kaitai`.
+2. Regenerate the C++ outputs into `src/main/file/kaitai/generated`.
+3. If needed, update the integration layer in:
+   - `src/main/file/kaitai/SndIo.*`
+   - `src/main/file/kaitai/PgmIo.*`
+   - `src/main/file/kaitai/ApsIo.*`
+   - `src/main/file/kaitai/MidIo.*`
+   - `src/main/file/kaitai/AllIo.*`
+   - `src/main/file/kaitai/Mpc3000SeqIo.*`
+4. Run downstream tests.
+5. Commit both the `.ksy` change and the regenerated vendored C++.
+
+## Verify in editables/mpc
+
+Build tests. Use any build directory you want. Examples below use `build`:
+
+```sh
+cmake -G "Ninja Multi-Config" -B build
+cmake --build build --target mpc-tests --config Debug
+```
+
+Run the focused Kaitai suite:
+
+```sh
+./build/Debug/mpc-tests.app/Contents/MacOS/mpc-tests "[kaitai-snd],[kaitai-pgm],[kaitai-aps],[kaitai-mid],[kaitai-all],[kaitai-set]"
+```
+
+Run one format only if needed:
+
+```sh
+./build/Debug/mpc-tests.app/Contents/MacOS/mpc-tests "[kaitai-aps]"
+./build/Debug/mpc-tests.app/Contents/MacOS/mpc-tests "[kaitai-pgm]"
+./build/Debug/mpc-tests.app/Contents/MacOS/mpc-tests "[kaitai-snd]"
+./build/Debug/mpc-tests.app/Contents/MacOS/mpc-tests "[kaitai-mid]"
+./build/Debug/mpc-tests.app/Contents/MacOS/mpc-tests "[kaitai-all]"
+./build/Debug/mpc-tests.app/Contents/MacOS/mpc-tests "[kaitai-set]"
+```
+
+## Notes
+
+- Do not regenerate with upstream Kaitai compiler unless it has the same C++ serialization support as the `cpp-serialization` branch.
+- `generated/` is vendored on purpose. As far as `editables/mpc` is concerned, generated parsers are ordinary source files.

cmake/MpcResourceBundling.cmake

@@ -40,7 +40,7 @@ function(_bundle_resources)
 
   _generate_mpc_required_resource_manifest()
 
-  file(GLOB_RECURSE MPC_RESOURCES "${_mpc_resources_root}/*")
+  file(GLOB_RECURSE MPC_RESOURCES CONFIGURE_DEPENDS "${_mpc_resources_root}/*")
   list(FILTER MPC_RESOURCES EXCLUDE REGEX "\\.DS_Store$")
 
   if (APPLE)
@@ -62,7 +62,7 @@ function(_bundle_resources)
     target_link_libraries(mpc mpc::rc)
   endif()
 
-  file(GLOB_RECURSE MPC_TEST_RESOURCES "${_mpc_test_resources_root}/*")
+  file(GLOB_RECURSE MPC_TEST_RESOURCES CONFIGURE_DEPENDS "${_mpc_test_resources_root}/*")
   list(FILTER MPC_TEST_RESOURCES EXCLUDE REGEX "\\.DS_Store$")
 
   cmrc_add_resource_library(

resources/screens/layer2.json

@@ -93,6 +93,31 @@
  "fblabels" : [ null, null, "CLEAR", "CANCEL", "LOAD", null ],
  "fbtypes" : [ null, null, 1, 0, 1, null ]
 },
+"load-a-set":
+{
+ "fblabels" : [ null, null, "SOUND", "CANCEL", "LOAD", null ],
+ "fbtypes" : [ null, null, 1, 0, 1, null ]
+},
+"conversion-table":
+{
+ "labels" : [ "MPC60 Pad:", "Becomes note:" ],
+ "x" : [ 67, 67 ],
+ "y" : [ 15, 37 ],
+ "tfsize" : [ 90, 36 ],
+ "parameters" : [ "mpc60-pad", "becomes-note" ],
+ "fblabels" : [ null, null, null, "CANCEL", "DO IT", null ],
+ "fbtypes" : [ null, null, null, 0, 1, null ]
+},
+"load-a-set-replace-add":
+{
+ "labels" : [ ":" ],
+ "x" : [ 77 ],
+ "y" : [ 21 ],
+ "tfsize" : [ 60 ],
+ "parameters" : [ "load-replace-sound" ],
+ "fblabels" : [ null, null, "CLEAR", "CANCEL", "LOAD", null ],
+ "fbtypes" : [ null, null, 1, 0, 1, null ]
+},
 "save-all-file":
 {
  "labels" : [ "File\u00CEname:" ],

resources/screens/layer3.json

@@ -1,9 +1,30 @@
 {
+"load-a-sequence-play":
+{
+ "infowidgets" : [ "position" ],
+ "infosize" : [ 60 ],
+ "infox" : [ 95 ],
+ "infoy" : [ 28 ]
+},
 "file-exists":
 {
  "fblabels" : [ null, null, "REPLAC", "CANCEL", "RENAME", null],
  "fbtypes" : [ null, null, 1, 0, 1, null ]
 },
+"load-a-set-sound":
+{
+ "labels" : [ "MPC60 pad:" ],
+ "x" : [ 64 ],
+ "y" : [ 21 ],
+ "tfsize" : [ 90 ],
+ "parameters" : [ "mpc60-pad" ],
+ "infowidgets" : [ "file" ],
+ "infox" : [ 95 ],
+ "infoy" : [ 35 ],
+ "infosize" : [ 126 ],
+ "fblabels" : [ null, null, null, "CANCEL", "LOAD", null ],
+ "fbtypes" : [ null, null, null, 0, 1, null ]
+},
 "vmpc-record-jam":
 {
  "fblabels" : [ null, null, null, "CANCEL", "OK", null],