+ UltraCompressor II (.uc2): read every UC2 release, create r2-readable archives

Compression.Tests/Compression.Tests.csproj

@@ -146,6 +146,10 @@
     <EmbeddedResource Include="Zfs\ReferenceVectors\*.gz;Zfs\ReferenceVectors\*.manifest">
       <LogicalName>ZfsVectors.%(Filename)%(Extension)</LogicalName>
     </EmbeddedResource>
+    <!-- UC2 archives written by the original UltraCompressor II (klauspost/uc2 testdata); see Uc2/ReferenceVectors/README.txt. -->
+    <EmbeddedResource Include="Uc2\ReferenceVectors\*.uc2;Uc2\ReferenceVectors\sums.txt">
+      <LogicalName>Uc2Vectors.%(Filename)%(Extension)</LogicalName>
+    </EmbeddedResource>
     <!-- G.722 streams FFmpeg 8.1.2 encoded and decoded; see Codecs/G722/ReferenceVectors/README.md. -->
     <EmbeddedResource Include="Codecs\G722\ReferenceVectors\*.pcm;Codecs\G722\ReferenceVectors\*.g722">
       <LogicalName>G722Vectors.%(Filename)%(Extension)</LogicalName>

Compression.Tests/FirmwareHex/FirmwareHexPayloadTests.cs

@@ -0,0 +1,37 @@
+using Compression.Registry;
+using FileFormat.FirmwareHex;
+
+namespace Compression.Tests.FirmwareHex;
+
+[TestFixture]
+public sealed class FirmwareHexPayloadTests {
+  [TestCase(false)]
+  [TestCase(true)]
+  public void Create_RejectsMultiplePayloadsWithoutWritingOutput(bool emptyFirst) {
+    var descriptor = new IntelHexFormatDescriptor();
+    using var output = new MemoryStream();
+    var inputs = new[] {
+      ArchiveInputInfo.InMemory("first.bin", emptyFirst ? [] : [1, 2, 3]),
+      ArchiveInputInfo.InMemory("second.bin", [9, 8, 7]),
+    };
+
+    Assert.Throws<InvalidDataException>(() =>
+      ((IArchiveCreatable)descriptor).Create(output, inputs, new FormatCreateOptions()));
+    Assert.That(output.Length, Is.Zero);
+  }
+
+  [Test]
+  public void Add_RejectsAnotherPayloadWithoutChangingTheArchive() {
+    var descriptor = new IntelHexFormatDescriptor();
+    using var archive = new MemoryStream();
+    ((IArchiveCreatable)descriptor).Create(archive,
+      [ArchiveInputInfo.InMemory("firmware.bin", [1, 2, 3])], new FormatCreateOptions());
+    var original = archive.ToArray();
+    archive.Position = 0;
+
+    Assert.Throws<InvalidDataException>(() => ((IArchiveModifiable)descriptor).Add(archive,
+      [ArchiveInputInfo.InMemory("ADD.BIN", [9, 8, 7])]));
+    Assert.That(archive.ToArray(), Is.EqualTo(original));
+  }
+
+}

Compression.Tests/Uc2/ReferenceVectors/LICENSE.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

Compression.Tests/Uc2/ReferenceVectors/README.md

@@ -0,0 +1,18 @@
+# UltraCompressor II reference archives
+
+Written by the original UltraCompressor II (r2, PRO 2.3 and 2.37 beta, run in DOSBox-X), never by
+CompressionWorkbench. Taken unmodified from `testdata/oracle/` of
+[klauspost/uc2](https://github.com/klauspost/uc2) at revision
+`53622f89ada1cf0d4a69f91b653bdd44ec5b0f92` (LGPL-3.0, `LICENSE.txt` beside this file); `README.txt`
+is that directory's own description of how each archive was made, and `sums.txt` lists the first 8
+bytes of the SHA-256 of every stored file revision.
+
+| File | Made by | What it pins |
+| --- | --- | --- |
+| `r2_def.uc2` | UC r2 `UC A C:\DEF *.*` | default method, custom masters over the supermaster |
+| `r2_prot.uc2` | UC r2 `UC A -S -P` | damage-protection area after the component; subdirectories |
+| `r2_rev.uc2` | UC r2 `UC A` then `UC A -I` twice | three revisions of one name; the newest is listed |
+| `r2_tf.uc2`, `r2_tst.uc2`, `r2_tt.uc2` | UC r2 `-TF`, `-TST`, `-TT` | fast, tight and super-tight levels (the tight levels may pick delta methods) |
+| `v23_def.uc2` | UC PRO 2.3 | made-by 203 |
+| `v237b_lfn.uc2` | UC 2.37b `UC A -S` | `AIP:Win95 LongN` tags, CP437 names (`Café crème.txt`) |
+| `v237b_tt.uc2` | UC 2.37b `-TT` | 2.37b's encoder at the tight level |

Compression.Tests/Uc2/ReferenceVectors/README.txt

@@ -0,0 +1,36 @@
+Archives made by the original UltraCompressor II in DOSBox-X by
+TestOracleUC2ToGo (UC2_DOSBOX=... UC2_ORACLE_SAVE=1 go test -run OracleUC2ToGo).
+The corpus is generated by oracleCorpus in oracle_test.go; all files have
+mtime 2025-01-02 03:04:06 local time (VERS.TXT revision n: +n hours).
+Commands run in the source directory with UC2_ANONYMOUS=1, UC2_OK=OFF.
+sums.txt lists "archive sha256[:8] revision name" for every file revision
+(names UTF-8, decoded from CP437). "UC T -F" of all three versions accepts
+every archive. DOSBox-X on Windows converts mtimes to DOS time with the
+current UTC offset, so stored times may differ by the DST offset. Re-running
+with the same UTC offset reproduces the archives byte for byte.
+
+Versions: r2 = UC2 revision 2 (uc2r2.exe), v23 = UC2 PRO 2.3 (uc2pro.exe),
+v237b = UC 2.37 beta (uc237b.exe, stores Win95 long names).
+
+r2_def.uc2         8100 bytes  UC r2: UC A C:\DEF *.*
+r2_prot.uc2        8751 bytes  UC r2: UC A -S -P C:\PROT *.*
+r2_rev.uc2          286 bytes  UC r2: UC A C:\REV *.* ; UC A -I C:\REV *.* ; UC A -I C:\REV *.*
+r2_tf.uc2          8196 bytes  UC r2: UC A -S -TF C:\TF *.*
+r2_tn.uc2          8190 bytes  UC r2: UC A -S -TN C:\TN *.*
+r2_tst.uc2         8078 bytes  UC r2: UC A -S -TST C:\TST *.*
+r2_tt.uc2          8090 bytes  UC r2: UC A -S -TT C:\TT *.*
+v237b_def.uc2      8104 bytes  UC 2.37b: UC A C:\DEF *.*
+v237b_lfn.uc2       544 bytes  UC 2.37b: UC A -S C:\LFN *.*
+v237b_prot.uc2     8751 bytes  UC 2.37b: UC A -S -P C:\PROT *.*
+v237b_rev.uc2       286 bytes  UC 2.37b: UC A C:\REV *.* ; UC A -I C:\REV *.* ; UC A -I C:\REV *.*
+v237b_tf.uc2       8196 bytes  UC 2.37b: UC A -S -TF C:\TF *.*
+v237b_tn.uc2       8192 bytes  UC 2.37b: UC A -S -TN C:\TN *.*
+v237b_tst.uc2      8074 bytes  UC 2.37b: UC A -S -TST C:\TST *.*
+v237b_tt.uc2       8088 bytes  UC 2.37b: UC A -S -TT C:\TT *.*
+v23_def.uc2        8104 bytes  UC 2.3: UC A C:\DEF *.*
+v23_prot.uc2       8751 bytes  UC 2.3: UC A -S -P C:\PROT *.*
+v23_rev.uc2         286 bytes  UC 2.3: UC A C:\REV *.* ; UC A -I C:\REV *.* ; UC A -I C:\REV *.*
+v23_tf.uc2         8196 bytes  UC 2.3: UC A -S -TF C:\TF *.*
+v23_tn.uc2         8192 bytes  UC 2.3: UC A -S -TN C:\TN *.*
+v23_tst.uc2        8074 bytes  UC 2.3: UC A -S -TST C:\TST *.*
+v23_tt.uc2         8088 bytes  UC 2.3: UC A -S -TT C:\TT *.*