initial

PicoLoaderConverter/.gitignore

@@ -0,0 +1,367 @@
+## Ignore Visual Studio temporary files, build results, and
+## files generated by popular Visual Studio add-ons.
+##
+## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
+
+# User-specific files
+*.rsuser
+*.suo
+*.user
+*.userosscache
+*.sln.docstates
+
+# User-specific files (MonoDevelop/Xamarin Studio)
+*.userprefs
+
+# Mono auto generated files
+mono_crash.*
+
+# Build results
+[Dd]ebug/
+[Dd]ebugPublic/
+[Rr]elease/
+[Rr]eleases/
+x64/
+x86/
+[Ww][Ii][Nn]32/
+[Aa][Rr][Mm]/
+[Aa][Rr][Mm]64/
+bld/
+[Bb]in/
+[Oo]bj/
+[Oo]ut/
+[Ll]og/
+[Ll]ogs/
+
+# Visual Studio 2015/2017 cache/options directory
+.vs/
+.idea/
+# Uncomment if you have tasks that create the project's static files in wwwroot
+#wwwroot/
+
+# Visual Studio 2017 auto generated files
+Generated\ Files/
+
+# MSTest test Results
+[Tt]est[Rr]esult*/
+[Bb]uild[Ll]og.*
+
+# NUnit
+*.VisualState.xml
+TestResult.xml
+nunit-*.xml
+
+# Build Results of an ATL Project
+[Dd]ebugPS/
+[Rr]eleasePS/
+dlldata.c
+
+# Benchmark Results
+BenchmarkDotNet.Artifacts/
+
+# .NET Core
+project.lock.json
+project.fragment.lock.json
+artifacts/
+
+# ASP.NET Scaffolding
+ScaffoldingReadMe.txt
+
+# StyleCop
+StyleCopReport.xml
+
+# Files built by Visual Studio
+*_i.c
+*_p.c
+*_h.h
+*.ilk
+*.meta
+*.obj
+*.iobj
+*.pch
+*.pdb
+*.ipdb
+*.pgc
+*.pgd
+*.rsp
+*.sbr
+*.tlb
+*.tli
+*.tlh
+*.tmp
+*.tmp_proj
+*_wpftmp.csproj
+*.log
+*.vspscc
+*.vssscc
+.builds
+*.pidb
+*.svclog
+*.scc
+
+# Chutzpah Test files
+_Chutzpah*
+
+# Visual C++ cache files
+ipch/
+*.aps
+*.ncb
+*.opendb
+*.opensdf
+*.sdf
+*.cachefile
+*.VC.db
+*.VC.VC.opendb
+
+# Visual Studio profiler
+*.psess
+*.vsp
+*.vspx
+*.sap
+
+# Visual Studio Trace Files
+*.e2e
+
+# TFS 2012 Local Workspace
+$tf/
+
+# Guidance Automation Toolkit
+*.gpState
+
+# ReSharper is a .NET coding add-in
+_ReSharper*/
+*.[Rr]e[Ss]harper
+*.DotSettings.user
+
+# TeamCity is a build add-in
+_TeamCity*
+
+# DotCover is a Code Coverage Tool
+*.dotCover
+
+# AxoCover is a Code Coverage Tool
+.axoCover/*
+!.axoCover/settings.json
+
+# Coverlet is a free, cross platform Code Coverage Tool
+coverage*.json
+coverage*.xml
+coverage*.info
+
+# Visual Studio code coverage results
+*.coverage
+*.coveragexml
+
+# NCrunch
+_NCrunch_*
+.*crunch*.local.xml
+nCrunchTemp_*
+
+# MightyMoose
+*.mm.*
+AutoTest.Net/
+
+# Web workbench (sass)
+.sass-cache/
+
+# Installshield output folder
+[Ee]xpress/
+
+# DocProject is a documentation generator add-in
+DocProject/buildhelp/
+DocProject/Help/*.HxT
+DocProject/Help/*.HxC
+DocProject/Help/*.hhc
+DocProject/Help/*.hhk
+DocProject/Help/*.hhp
+DocProject/Help/Html2
+DocProject/Help/html
+
+# Click-Once directory
+publish/
+
+# Publish Web Output
+*.[Pp]ublish.xml
+*.azurePubxml
+# Note: Comment the next line if you want to checkin your web deploy settings,
+# but database connection strings (with potential passwords) will be unencrypted
+*.pubxml
+*.publishproj
+
+# Microsoft Azure Web App publish settings. Comment the next line if you want to
+# checkin your Azure Web App publish settings, but sensitive information contained
+# in these scripts will be unencrypted
+PublishScripts/
+
+# NuGet Packages
+*.nupkg
+# NuGet Symbol Packages
+*.snupkg
+# The packages folder can be ignored because of Package Restore
+**/[Pp]ackages/*
+# except build/, which is used as an MSBuild target.
+!**/[Pp]ackages/build/
+# Uncomment if necessary however generally it will be regenerated when needed
+#!**/[Pp]ackages/repositories.config
+# NuGet v3's project.json files produces more ignorable files
+*.nuget.props
+*.nuget.targets
+
+# Microsoft Azure Build Output
+csx/
+*.build.csdef
+
+# Microsoft Azure Emulator
+ecf/
+rcf/
+
+# Windows Store app package directories and files
+AppPackages/
+BundleArtifacts/
+Package.StoreAssociation.xml
+_pkginfo.txt
+*.appx
+*.appxbundle
+*.appxupload
+
+# Visual Studio cache files
+# files ending in .cache can be ignored
+*.[Cc]ache
+# but keep track of directories ending in .cache
+!?*.[Cc]ache/
+
+# Others
+ClientBin/
+~$*
+*~
+*.dbmdl
+*.dbproj.schemaview
+*.jfm
+*.pfx
+*.publishsettings
+orleans.codegen.cs
+
+# Including strong name files can present a security risk
+# (https://github.com/github/gitignore/pull/2483#issue-259490424)
+#*.snk
+
+# Since there are multiple workflows, uncomment next line to ignore bower_components
+# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
+#bower_components/
+
+# RIA/Silverlight projects
+Generated_Code/
+
+# Backup & report files from converting an old project file
+# to a newer Visual Studio version. Backup files are not needed,
+# because we have git ;-)
+_UpgradeReport_Files/
+Backup*/
+UpgradeLog*.XML
+UpgradeLog*.htm
+ServiceFabricBackup/
+*.rptproj.bak
+
+# SQL Server files
+*.mdf
+*.ldf
+*.ndf
+
+# Business Intelligence projects
+*.rdl.data
+*.bim.layout
+*.bim_*.settings
+*.rptproj.rsuser
+*- [Bb]ackup.rdl
+*- [Bb]ackup ([0-9]).rdl
+*- [Bb]ackup ([0-9][0-9]).rdl
+
+# Microsoft Fakes
+FakesAssemblies/
+
+# GhostDoc plugin setting file
+*.GhostDoc.xml
+
+# Node.js Tools for Visual Studio
+.ntvs_analysis.dat
+node_modules/
+
+# Visual Studio 6 build log
+*.plg
+
+# Visual Studio 6 workspace options file
+*.opt
+
+# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
+*.vbw
+
+# Visual Studio LightSwitch build output
+**/*.HTMLClient/GeneratedArtifacts
+**/*.DesktopClient/GeneratedArtifacts
+**/*.DesktopClient/ModelManifest.xml
+**/*.Server/GeneratedArtifacts
+**/*.Server/ModelManifest.xml
+_Pvt_Extensions
+
+# Paket dependency manager
+.paket/paket.exe
+paket-files/
+
+# FAKE - F# Make
+.fake/
+
+# CodeRush personal settings
+.cr/personal
+
+# Python Tools for Visual Studio (PTVS)
+__pycache__/
+*.pyc
+
+# Cake - Uncomment if you are using it
+# tools/**
+# !tools/packages.config
+
+# Tabs Studio
+*.tss
+
+# Telerik's JustMock configuration file
+*.jmconfig
+
+# BizTalk build output
+*.btp.cs
+*.btm.cs
+*.odx.cs
+*.xsd.cs
+
+# OpenCover UI analysis results
+OpenCover/
+
+# Azure Stream Analytics local run output
+ASALocalRun/
+
+# MSBuild Binary and Structured Log
+*.binlog
+
+# NVidia Nsight GPU debugger configuration file
+*.nvuser
+
+# MFractors (Xamarin productivity tool) working folder
+.mfractor/
+
+# Local History for Visual Studio
+.localhistory/
+
+# BeatPulse healthcheck temp database
+healthchecksdb
+
+# Backup folder for Package Reference Convert tool in Visual Studio 2017
+MigrationBackup/
+
+# Ionide (cross platform F# VS Code tools) working folder
+.ionide/
+
+# Fody - auto-generated XML schema
+FodyWeavers.xsd
+
+# Wavefront obj resources
+!*/Resources/Models/*.obj

PicoLoaderConverter/PicoLoaderConverter/plctypes.py

@@ -0,0 +1,165 @@
+
+from dataclasses import dataclass
+from enum import IntEnum
+from math import log
+import struct
+
+
+__all__ = [ 'CardSaveType', 'DSProtectVersion', 'HexInt', 'BinInt'
+          , 'SaveListEntry', 'CsvSaveListEntry'
+          , 'ApListEntry', 'CsvApListEntry'
+          ]
+
+
+class CardSaveType_(IntEnum):
+    NONE = 0
+    EEPROM = 1
+    FLASH = 2
+    NAND = 3
+
+    def __str__(self):
+        return self.name.lower()
+
+def CardSaveType(s):
+    if isinstance(s, str):
+        return CardSaveType_(['none', 'eeprom', 'flash', 'nand'].index(s))
+    return CardSaveType_(s)
+
+class DSProtectVersion_(IntEnum):
+    V1_06 = 0
+    V1_05 = 1
+    V1_08 = 2
+    V1_10 = 3
+    V1_20 = 4
+    V1_22 = 5
+    V1_23 = 6
+    V1_23Z = 7
+    V1_25 = 8
+    V1_26 = 9
+    V1_27 = 10
+    V1_28 = 11
+    V2_00 = 12
+    V2_01 = 13
+    V2_03 = 14
+    V2_05 = 15
+    V2_00s = 16
+    V2_01s = 17
+    V2_03s = 18
+    V2_05s = 19
+
+    def __str__(self) -> str:
+        return self.name[1:].replace('_', '.')
+
+def DSProtectVersion(s):
+    if isinstance(s, str):
+        v = DSProtectVersion_.__members__.get("V" + s.replace('.', '_'))
+        if v is None:
+            raise ValueError("Can't convert '%s' to DSProtectVersion!" % s)
+        return v
+    return DSProtectVersion_(s)
+
+
+
+def serialize_u24(v: int) -> bytes:
+    return bytes((v & 0xff, (v >> 8) & 0xff, (v >> 16) & 0x24))
+
+def serialize_gamecode(gc: str) -> int:
+    enc = gc.encode()
+    if len(gc) != 4 or len(enc) != 4:
+        raise ValueError("gamecode '%s' must be an ASCII string of length 4"%gc)
+    return struct.unpack('<I', enc)[0]
+
+
+def HexInt(x): return int(x, 0)  # input CSV has 0x prefixes for hex numbers
+def BinInt(x): return int(x, 2)
+
+
+@dataclass
+class SaveListEntry:  # little endian
+    gameCode: int  # u32
+    saveType: CardSaveType  # u8
+    saveSize: int  # u8
+    # padding: u16
+
+    def __init__(self, gameCode: int, saveType: CardSaveType, saveSize: int):
+        super().__init__()
+        self.gameCode = gameCode & 0xffff_ffff
+        self.saveType = saveType
+
+        if saveSize & (saveSize - 1):
+            raise ValueError("saveSize %d not a power of two!" % saveSize)
+
+        self.saveSize = 0 if saveSize == 0 else (saveSize.bit_length() - 1)
+
+    def serialize(self) -> bytes:
+        r = struct.pack('<IBBH', self.gameCode, int(self.saveType), self.saveSize, 0)
+        assert len(r) == 8, r
+        return r
+
+@dataclass
+class CsvSaveListEntry:
+    gameCode: str
+    saveType: str
+    saveSize: HexInt
+
+    def tobinary(self) -> SaveListEntry:
+        return SaveListEntry(serialize_gamecode(self.gameCode),
+                             CardSaveType(self.saveType), self.saveSize)
+
+
+@dataclass
+class ApListEntry:  # little endian
+    gameCode: int  # u32
+    gameVersion: int  # 5 bits
+    dsprotVersion: DSProtectVersion_  # 5 bits
+    dsprotFuncMask: int  # 6 bits
+    regularOvlId: int  # u16
+    sOvlId: int  # u16
+    regularOffset: int  # u24
+    sOffset: int  # u24
+
+    OVERLAY_ID_STATIC_ARM9 = 0xfffe
+    OVERLAY_ID_INVALID = 0xffff
+
+    def __init__(self, gameCode: int, gameVersion: int, dsprotVersion: DSProtectVersion_,
+                 dsprotFuncMask: int, regularOvlId: int, sOvlId: int,
+                 regularOffset: int, sOffset: int):
+        super().__init__()
+        self.gameCode = gameCode & 0xffff_ffff
+        self.gameVersion = gameVersion & 0x1f
+        self.dsprotVersion = dsprotVersion
+        self.dsprotFuncMask = dsprotFuncMask & 0x3f
+        self.regularOvlId = regularOvlId & 0xffff
+        self.sOvlId = sOvlId & 0xffff
+        self.regularOffset = regularOffset & 0xff_ffff
+        self.sOffset = sOffset & 0xff_ffff
+
+    def serialize(self) -> bytes:
+        info = (self.gameVersion & 0x1f) \
+             | ((int(self.dsprotVersion) & 0x1f) << 5) \
+             | ((self.dsprotFuncMask & 0x3f) << 10)
+
+        r = struct.pack('<IHHH3B3B', self.gameCode, info,
+                        self.regularOvlId, self.sOvlId,
+                        *serialize_u24(self.regularOffset),
+                        *serialize_u24(self.sOffset))
+        assert len(r) == 16, len(r)
+        return r
+
+@dataclass
+class CsvApListEntry:
+    gameCode: str
+    gameVersion: int
+    dsprotVersion: str
+    dsprotFuncMask: BinInt
+    regularOvlId: int
+    regularOffset: HexInt
+    sOvlId: int
+    sOffset: HexInt
+
+    def tobinary(self) -> ApListEntry:
+        return ApListEntry(serialize_gamecode(self.gameCode), self.gameVersion,
+                           DSProtectVersion(self.dsprotVersion),
+                           self.dsprotFuncMask, self.regularOvlId, self.sOvlId,
+                           self.regularOffset, self.sOffset)
+

PicoLoaderConverter/PicoLoaderConverter/program.py

@@ -0,0 +1,71 @@
+
+import argparse, csv
+
+from PicoLoaderConverter.plctypes import *
+
+
+def scsv_parse_struct_table(f, typ):
+    annot = typ.__annotations__
+    header = f.readline().strip().split(';')
+
+    for x in header:
+        assert x in annot, (x, annot)
+    for k in annot.keys():
+        assert k in header, (k, header)
+
+    csvr = csv.DictReader(f, fieldnames=header, delimiter=';')
+
+    for row in csvr:
+        parsed = dict((k, annot[k](v)) for (k, v) in row.items())
+        yield typ(**parsed)
+
+
+def run_aplist(args) -> int|None:
+    intable = list(scsv_parse_struct_table(args.input, CsvApListEntry))
+    intable.sort(key=lambda e: e.gameVersion)
+    intable.sort(key=lambda e: e.gameCode)  # alphabetic sort, ie can't compare these as integers!
+
+    for e in intable:
+        args.output.write(e.tobinary().serialize())
+
+
+def run_savelist(args) -> int|None:
+    intable = list(scsv_parse_struct_table(args.input, CsvSaveListEntry))
+    intable.sort(key=lambda e: e.gameCode)  # alphabetic sort, ie can't compare these as integers!
+
+    for e in intable:
+        args.output.write(e.tobinary().serialize())
+
+
+def main() -> int|None:
+    parser = argparse.ArgumentParser()
+
+    subparsers = parser.add_subparsers(dest="verb", help="subcommand")
+
+    aplist = subparsers.add_parser("aplist", help="")
+
+    aplist.add_argument('-i', "--input", type=argparse.FileType('r'), help="Input .csv file", required=True)
+    aplist.add_argument('-o', "--output", type=argparse.FileType('wb'), help="Output .bin file", required=True)
+
+    savelist = subparsers.add_parser("savelist", help="")
+
+    savelist.add_argument('-i', "--input", type=argparse.FileType('r'), help="Input .csv file", required=True)
+    savelist.add_argument('-o', "--output", type=argparse.FileType('wb'), help="Output .bin file", required=True)
+
+    args = parser.parse_args()
+
+    verb = {
+        'aplist': run_aplist,
+        'savelist': run_savelist
+    }.get(args.verb)
+
+    if verb is None:
+        print("ERROR: invalid verb?!")
+        return 1
+
+    return verb(args)
+
+
+if __name__ == '__main__':
+    exit(main() or 0)
+

PicoLoaderConverter/pyproject.toml

@@ -0,0 +1,37 @@
+[project]
+name = "PicoLoaderConverter"
+version = "0.1.0"
+description = "Converts AP-list and savetype-list CSV files to binary format"
+#readme = "README.md"
+license = 'MIT'
+keywords = []
+
+authors = [
+  {name = "Gericom", email = "fnouwt2@gmail.com"},
+  {name = "PoroCYon", email = "p@pcy.be"},
+]
+maintainers = [
+  {name = "PoroCYon", email = "p@pcy.be"},
+]
+
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Operating System :: POSIX :: Linux",
+  "Operating System :: Microsoft :: Windows",
+  "Environment :: Console",
+  "Typing :: Typed"
+]
+
+dependencies = [
+]
+
+requires-python = ">= 3.9"
+
+[project.scripts]
+PicoLoaderConverter = "PicoLoaderConverter.program:main"