Merge branch 'main' of https://github.com/mos9527/PyCriCodecsEx

Author: mos9527

CriCodecsEx/crilayla.cpp

@@ -22,6 +22,13 @@ See also:
 #include <stdlib.h>
 #include <string.h>
 
+unsigned fourCC(const char a, const char b, const char c, const char d) {
+	return (a << 0) | (b << 8) | (c << 16) | (d << 24);
+};
+const unsigned CRILAYLA_LO = fourCC('C', 'R', 'I', 'L');
+const unsigned CRILAYLA_HI = fourCC('A', 'Y', 'L', 'A');
+const unsigned long long CRILAYLA_MAGIC =  CRILAYLA_LO | (unsigned long long)CRILAYLA_HI << 32uLL;
+
 struct crilayla_header{
     unsigned long long crilayla;
     unsigned int decompress_size;
@@ -186,7 +193,7 @@ unsigned int layla_comp(unsigned char *dest, int *destLen, unsigned char *src, i
         return 0; // Underflow    
     *destLen = *destLen - m; dest += m;
     // CRIL AYLA srcLen-0x100 destLen
-    int l[] = { 0x4c495243,0x414c5941,srcLen - 0x100,*destLen };
+    int l[] = { (int)CRILAYLA_LO,(int)CRILAYLA_HI,srcLen - 0x100,*destLen };
     for (j = 0; j<4; j++)
     {
         for (i = 0; i<4; i++)
@@ -210,7 +217,7 @@ PyObject* CriLaylaDecompress(PyObject* self, PyObject* d){
 	unsigned char *data = (unsigned char *)PyBytes_AsString(d);
 	crilayla_header header = *(crilayla_header*)data;
 
-    if (header.crilayla != 0x414c59434152494cULL) {
+    if (header.crilayla != CRILAYLA_MAGIC) {
         PyErr_SetString(PyExc_ValueError, "Invalid CRILAYLA header.");
         return NULL;
     }

PyCriCodecsEx/__init__.py

@@ -1 +1 @@
-__version__ = "0.0.4"
+__version__ = "0.0.5"

PyCriCodecsEx/acb.py

@@ -197,10 +197,17 @@ def awb(self) -> AWB:
         return AWB(awb_path.open('rb'))
 
 
-    def get_waveforms(self) -> List[HCACodec | ADXCodec | Tuple[AcbEncodeTypes, int, int, int,  bytes]]:
+    def get_waveforms(self, **kwargs) -> List[HCACodec | ADXCodec | Tuple[AcbEncodeTypes, int, int, int,  bytes]]:
         """Returns a list of decoded waveforms.
 
         Item may be a codec (if known), or a tuple of (Codec ID, Channel Count, Sample Count, Sample Rate, Raw data).
+
+        Additional keyword arguments are passed to the codec constructors. e.g. for encrypted HCA payloads,
+        you may do the following:
+        ```python
+        get_waveforms(key=..., subkey=...)
+        ```
+        See also the respective docs (ADXCodec, HCACodec) for more details.
         """
         CODEC_TABLE = {
             AcbEncodeTypes.ADX: ADXCodec,
@@ -213,7 +220,7 @@ def get_waveforms(self) -> List[HCACodec | ADXCodec | Tuple[AcbEncodeTypes, int,
             encode = AcbEncodeTypes(wav.EncodeType)
             codec = (CODEC_TABLE.get(encode, None))
             if codec:
-                wavs.append(codec(awb.get_file_at(wav.MemoryAwbId)))
+                wavs.append(codec(awb.get_file_at(wav.MemoryAwbId), **kwargs))
             else:
                 wavs.append((encode, wav.NumChannels, wav.NumSamples, wav.SamplingRate, awb.get_file_at(wav.MemoryAwbId)))
         return wavs

PyCriCodecsEx/adx.py

@@ -57,7 +57,7 @@ def __init__(self, stream: str | bytes, filename: str = "default.adx", bitdepth:
 
         Args:
             stream (str | bytes): Path to the ADX or WAV file, or a BinaryIO stream. WAV files will be automatically encoded with the given settings first.
-            filename (str, optional): Output filename. Defaults to "default.adx".
+            filename (str, optional): Filename, used by USMBuilder. Defaults to "default.adx".
             bitdepth (int, optional): Audio bit depth within [2,15]. Defaults to 4.
         """
         if type(stream) == str:

PyCriCodecsEx/hca.py

@@ -332,7 +332,7 @@ def __init__(self, stream: str | bytes, filename: str = "default.hca", quality:
 
         Args:
             stream (str | bytes): Path to the HCA or WAV file, or a BinaryIO stream. WAV files will be automatically encoded with the given settings first.
-            filename (str, optional): USM filename. Defaults to "default.hca".
+            filename (str, optional): Filename, used by USMBuilder. Defaults to "default.hca".
             quality (CriHcaQuality, optional): Encoding quality. Defaults to CriHcaQuality.High.
             key (int, optional): HCA key. Defaults to 0.
             subkey (int, optional): HCA subkey. Defaults to 0.

PyCriCodecsEx/usm.py

@@ -13,11 +13,7 @@
 import tempfile
 
 # Big thanks and credit for k0lb3 and 9th helping me write this specific code.
-# Also credit for the original C++ code from Nyagamon/bnnm.
-
-# Apparently there is an older USM format called SofDec? This is for SofDec2 though.
-# Extraction working only for now, although check https://github.com/donmai-me/WannaCRI/
-# code for a complete breakdown of the USM format.
+# Also credit for the original C++ code from Nyagamon/bnnm and https://github.com/donmai-me/WannaCRI/
 
 class USMCrypt:
     """USM related crypto functions"""

Tests/CPK/README.md

@@ -7,4 +7,9 @@ default.cpk
 │
 └───subdir
         niko-512.png
-```
+```
+### compressed.cpk
+```
+compressed.cpk
+     niko.png
+```

Tests/CPK/compressed.cpk

@@ -2,10 +2,10 @@
 from . import sample_file_path, temp_file_path
 from PyCriCodecsEx.cpk import CPK, CPKBuilder
 
-def test_cpk_unpack():     
+def cpk_unpack(fname):     
     # Extract CPK content
     cpkdir = temp_file_path('cpk')
-    cpk = CPK(sample_file_path('CPK/default.cpk'))
+    cpk = CPK(sample_file_path(fname))
     for f in cpk.files:
         dst = os.path.join(cpkdir, f.path)
         os.makedirs(os.path.dirname(dst), exist_ok=True)
@@ -29,5 +29,12 @@ def progress_callback(stage: str, current: int, total: int):
     cpk.save(temp_file_path('rebuild.cpk'))
     print('Repack done.')
 
+def test_cpk_regular():
+    cpk_unpack('CPK/default.cpk')
+
+def test_cpk_compressed():
+    cpk_unpack('CPK/compressed.cpk')
+
 if __name__ == "__main__":
-    test_cpk_unpack()
+    test_cpk_regular()
+    test_cpk_compressed()

Tests/test_CPK.py

@@ -1,3 +1,5 @@
+# TODO: Fix CRILAYLA Compression
+# Decompression is tested in test_CPK.py
 import os
 from . import sample_file_path, temp_file_path
 from CriCodecsEx import CriLaylaCompress, CriLaylaDecompress