PyCriCodecsEx 0.0.1__cp311-cp311-win32.whl → 0.0.3__cp311-cp311-win32.whl

PyCriCodecsEx/utf.py

@@ -1,11 +1,14 @@
 from typing import BinaryIO, TypeVar, Type, List
+from copy import deepcopy
 
 T = TypeVar("T")
+Ty = TypeVar("Ty", bound="UTFViewer")
 from io import BytesIO, FileIO
 from struct import unpack, calcsize, pack
 from PyCriCodecsEx.chunk import *
 
 class UTF:
+    """Use this class to unpack @UTF table binary payload."""
 
     _dictarray: list
 
@@ -21,11 +24,11 @@ class UTF:
     recursive: bool
     encoding : str = 'utf-8'
 
-    def __init__(self, stream, recursive=False):
+    def __init__(self, stream : str | BinaryIO, recursive=False):
         """Unpacks UTF table binary payload
 
         Args:
-            stream (Union[str, bytes]): The input stream or file path to read the UTF table from.
+            stream (Union[str | BinaryIO]): The input stream or file path to read the UTF table from.
             recursive (bool): Whether to recursively unpack nested UTF tables.
         """
         if type(stream) == str:
@@ -288,6 +291,7 @@ class UTF:
         return self._dictarray
 
 class UTFBuilder:
+    """Use this class to build UTF table binary payloads from a `dictarray`."""
 
     encoding: str
     dictarray: list
@@ -302,7 +306,7 @@ class UTFBuilder:
 
     def __init__(
         self,
-        dictarray: list[dict],
+        dictarray_src: list[dict],
         encrypt: bool = False,
         encoding: str = "utf-8",
         table_name: str = "PyCriCodecs_table",
@@ -311,14 +315,14 @@ class UTFBuilder:
         """Packs UTF payload back into their binary form
         
         Args:
-            dictarray: A list of dictionaries representing the UTF table.
+            dictarray_src: list[dict]: A list of dictionaries representing the UTF table.
             encrypt: Whether to encrypt the table (default: False).
             encoding: The character encoding to use (default: "utf-8").
             table_name: The name of the table (default: "PyCriCodecs_table").
             ignore_recursion: Whether to ignore recursion when packing (default: False).
         """
-        assert type(dictarray) == list, "dictarray must be a list of dictionaries (see UTF.dictarray)."
-
+        assert type(dictarray_src) == list, "dictarray must be a list of dictionaries (see UTF.dictarray)."
+        dictarray = deepcopy(dictarray_src)
         # Preprocess for nested dictarray types
         def dfs(payload: list[dict], name: str) -> None:
             for dict in range(len(payload)):
@@ -589,36 +593,18 @@ class UTFBuilder:
         return dataarray
 
 class UTFViewer:
+    """Use this class to create dataclass-like access to `dictarray`s."""
+
     _payload: dict
 
     def __init__(self, payload):
         """Construct a non-owning read-write, deletable view of a UTF table dictarray.
+
         Nested classes are supported.
-        Sorting (using .sort()) is done in-place and affects the original payload.
 
-        Example:
-        ```python
-            class CueNameTable(UTFViewer):
-                CueName : str
-                CueIndex : int
-            class ACBTable(UTFViewer):
-                CueNameTable : List[CueNameTable]
-                Awb : AWB
-            src = ACB(ACB_sample)
-            payload = ACBTable(src.payload)
-            >>> Referencing items through Python is allowed
-            name = payload.CueNameTable
-            >>> Lists can be indexed
-            name_str = name[0].CueName
-            >>> Deleting items from lists is also allowed
-            src.view.CueNameTable.pop(1)
-            src.view.CueTable.pop(1)
-            >>> The changes will be reflected in the original UTF payload
-            
-            See __new__ for the actual constructor.
-        ```
+        Sorting (using .sort()) is done in-place and affects the original payload.
         """
-        assert isinstance(payload, dict), "Payload must be a dictionary."
+        assert isinstance(payload, dict), "payload must be a dictionary."
         super().__setattr__("_payload", payload)
 
     def __getattr__(self, item):
@@ -643,7 +629,9 @@ class UTFViewer:
     def __setattr__(self, item, value):
         payload = super().__getattribute__("_payload")
         if item not in payload:
-            raise AttributeError(f"{item} not in payload")
+            raise AttributeError(f"{item} not in payload. UTFViewer should not store extra states")
+        if isinstance(value, dict) or isinstance(value, list):
+            raise AttributeError(f"Dict or list assignment is not allowed as this may potentially change the table layout. Access by elements and use list APIs instead")
         typeof, _ = payload[item]
         payload[item] = (typeof, value)
 
@@ -659,9 +647,9 @@ class UTFViewer:
 
     class ListView(list):
         _payload : List[dict]
-        def __init__(self, payload: list[T]):
+        def __init__(self, clazz : Type[Ty], payload: list[Ty]):
             self._payload = payload
-            super().__init__([UTFViewer(item) for item in payload])
+            super().__init__([clazz(item) for item in payload])
 
         def pop(self, index = -1):
             self._payload.pop(index)
@@ -669,7 +657,7 @@ class UTFViewer:
         
         def append(self, o : "UTFViewer"):
             if len(self):
-                assert type(self[0]) == type(o), "all items in the list must be of the same type."
+                assert isinstance(o, UTFViewer) and type(self[0]) == type(o), "all items in the list must be of the same type, and must be an instance of UTFViewer."
             self._payload.append(o._payload)
             return super().append(o)
         
@@ -677,9 +665,9 @@ class UTFViewer:
             for item in iterable:
                 self.append(item)
 
-        def insert(self, index, o : "UTFViewer"):
+        def insert(self, index, o : "UTFViewer"):         
             if len(self):
-                assert type(self[0]) == type(o), "all items in the list must be of the same type."            
+                assert isinstance(o, UTFViewer) and type(self[0]) == type(o), "all items in the list must be of the same type, and must be an instance of UTFViewer."
             self._payload.insert(index, o._payload)
             return super().insert(index, o)
 
@@ -698,7 +686,7 @@ class UTFViewer:
             self._payload[:] = [self._payload[i] for x,i in p]     
             self[:] = [x for x,i in p]            
 
-    def __new__(cls: Type[T], payload: list | dict, **args) -> T | List[T]:
+    def __new__(cls: Type[Ty], payload: list | dict, **args) -> Ty | List[Ty]:
         if isinstance(payload, list):
-            return UTFViewer.ListView(payload)
+            return UTFViewer.ListView(cls, payload)
         return super().__new__(cls)

pycricodecsex-0.0.3.dist-info/METADATA

@@ -0,0 +1,35 @@
+Metadata-Version: 2.4
+Name: PyCriCodecsEx
+Version: 0.0.3
+Summary: Criware formats library for Python
+Home-page: https://mos9527.github.io/PyCriCodecsEx/
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: usm
+Requires-Dist: ffmpeg-python; extra == "usm"
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-python
+Dynamic: summary
+
+PyCriCodecsEx
+---
+A continuation of @Youjose's work on Criware formats. Feautres are still in flux and subject to change. When in doubt, Refer to the [original repo](https://github.com/Youjose/PyCriCodecs) for more information.
+
+Detailed documentation, installation instructions are available at https://mos9527.com/PyCriCodecsEx
+
+
+# Credits
+- https://github.com/Youjose/PyCriCodecs
+- https://github.com/Mikewando/PyCriCodecs ([PR#1 on USM](https://github.com/mos9527/PyCriCodecsEx/pull/1))
+- https://github.com/donmai-me/WannaCRI
+- https://github.com/vgmstream/vgmstream
+- https://github.com/K0lb3/UnityPy (For CI script)

pycricodecsex-0.0.3.dist-info/RECORD

@@ -0,0 +1,15 @@
+CriCodecsEx.cp311-win32.pyd,sha256=HRG3LEkKVD--EV5Oc16VgJnhi3TC_JndeFWgrmnyYb8,68096
+PyCriCodecsEx/__init__.py,sha256=4dCrvStS1OgE3Vlcv-qx5-TAo377yOMEToEqCi-PwY4,23
+PyCriCodecsEx/acb.py,sha256=nOWggyQTPOBArzRp_7VRO9TY1diLxr2mRPKQd-sd2s0,10723
+PyCriCodecsEx/adx.py,sha256=s3gJBgKrwWjUahrxSJEy1GNHJrdz3iaylgr0TyTIi7M,5967
+PyCriCodecsEx/awb.py,sha256=t6owuEOH3Be31iBuEMwriOh0cPdVtpzsNbTPfLwg_cc,6363
+PyCriCodecsEx/chunk.py,sha256=xmc92tONmXpdbOW2g-KckTeppTXFo8Km0J95UYbbvQg,2810
+PyCriCodecsEx/cpk.py,sha256=bMJgvzPInM95R9dEdhHGW65jR9tFBKUacyOwZS2gOyA,38206
+PyCriCodecsEx/hca.py,sha256=BamujR3tRxMmgnPAYpUOamzOUOBs5hXWhkcBnj7Eeh4,19445
+PyCriCodecsEx/usm.py,sha256=LWSXXkfV1FZpymV0X6UH-lyS5gV6ecBHlLLXXXN9wMc,36972
+PyCriCodecsEx/utf.py,sha256=0LBzpIbJiyL_4KOf_QpEJytr3PbHj8_M4Bd-Lay4wuk,28247
+pycricodecsex-0.0.3.dist-info/licenses/LICENSE,sha256=B47Qr_82CmMyuL-wNFAH_P6PNJWaonv5dxo9MfgjEXw,1083
+pycricodecsex-0.0.3.dist-info/METADATA,sha256=buywcqSll1E63mnWNtEgwHiyAY8NbvMyP8CDLXAJLH0,1291
+pycricodecsex-0.0.3.dist-info/WHEEL,sha256=Ri8zddKrjGdgjlj1OpSsvpDnvHfnQhMQWi3E_v2pqng,97
+pycricodecsex-0.0.3.dist-info/top_level.txt,sha256=mSrrEse9hT0s6nl-sWAQWAhNRuZ6jo98pbFoN3L2MXk,26
+pycricodecsex-0.0.3.dist-info/RECORD,,

pycricodecsex-0.0.1.dist-info/METADATA

@@ -1,81 +0,0 @@
-Metadata-Version: 2.4
-Name: PyCriCodecsEx
-Version: 0.0.1
-Summary: Criware formats library for Python
-Home-page: https://github.com/mos9527/PyCriCodecsEx
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Provides-Extra: usm
-Requires-Dist: ffmpeg-python; extra == "usm"
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: license-file
-Dynamic: provides-extra
-Dynamic: requires-python
-Dynamic: summary
-
-# PyCriCodecsEx
-A continuation of @Youjose's work on Criware formats. Feautres are still in flux and subject to change. When in doubt, Refer to the [original repo](https://github.com/Youjose/PyCriCodecs) for more information.
-
-# Installation
-```bash
-pip install PyCriCodecsEx
-```
-
-For USM features, you need `ffmpeg` installed and available in your PATH. See also https://github.com/kkroening/ffmpeg-python?tab=readme-ov-file#installing-ffmpeg
-
-## Features
-If not otherwise mentioned, all features marked with [x] are considered working, and has been verified with official tools.
-
-### ACB Cue sheets (also AWB)
-- [x] Editing & Saving (Scripting APIs. Helper functions TODO. see examples in [Tests](https://github.com/mos9527/PyCriCodecsEx/tree/main/Tests))
-### USM Sofdec2 (Encode & Decode)
-#### Audio Stream
-For audio to be muxed in, you need a PCM WAV sample with NO metadata, which can be produced with e.g.:
-```bash
-ffmpeg -i input.mp3 -vn -c:a pcm_s16le -map_metadata -1 output.wav
-```
-Decoding and Encoded format can be the following:
-- [x] HCA
-- [x] ADX
-#### Video Stream
-**NOTE**: You definitely want to tweak these encode settings a bit.
-- [x] Sofdec Prime (MPEG1, from `.m1v` container)
-    - Prepare source file with: `ffmpeg -i <input_file> -c:v mpeg1video -an <output_file>.m1v`
-- [x] H264 (from `.h264` raw container)
-    - Prepare source file with: `ffmpeg -i <input_file> -c:v libx264 -an <output_file>.h264`
-- [x] VP9 (from `.ivf` container)
-    - Prepare source file with: `ffmpeg -i <input_file> -c:v libvpx -an <output_file>.ivf`
-### HCA Audio Codec
-- [x] Decoding (up to version 3.0)
-- [x] Encoding (up to version 3.0)
-### ADX Audio Codec
-- [x] Decoding
-- [x] Encoding
-### CPK
-- [x] Unpacking
-- [x] Packing
-
-## Roadmap
-- [ ] ACB Extraction (Massive TODO. see also https://github.com/mos9527/PyCriCodecsEx/blob/main/Research/ACBSchema.py)
-- [ ] Interface for encode tasks (CLI then maybe GUI?)
-- [ ] Documentation
-- [ ] C/C++ port + FFI
-## Currently Known Bugs
-- USM seeking does not work. Though most games don't use it anyways.
-- Not important, and might not fix: ADX encoding and decoding at higher bitdepths (11-15) adds popping noise.
-- Some CPK's that has the same filename for every file in the entry will overwrite each other.
-- Probably many more I am unaware of, report if you find any.
-
-# Credits
-- https://github.com/Youjose/PyCriCodecs
-- https://github.com/Mikewando/PyCriCodecs ([PR#1 on USM](https://github.com/mos9527/PyCriCodecsEx/pull/1))
-- https://github.com/donmai-me/WannaCRI
-- https://github.com/vgmstream/vgmstream
-- https://github.com/K0lb3/UnityPy (For CI script)

pycricodecsex-0.0.1.dist-info/RECORD

@@ -1,15 +0,0 @@
-CriCodecsEx.cp311-win32.pyd,sha256=vNU5Znkk844dYwph88LlPvWAC8RuC4s_1E7_NDXPe4s,68096
-PyCriCodecsEx/__init__.py,sha256=ry5O5SW74ugwOUMKSV2_LbWjYa8B0IEvUm7S-lHPA2c,23
-PyCriCodecsEx/acb.py,sha256=v0CxjveQewxUWuila1O0qDGcAfvOxqnzYqAL4AHneqU,2706
-PyCriCodecsEx/adx.py,sha256=KnL4wy1ccoc6uHYZVino7cJQB2pMn4BbRhpH3r527TY,777
-PyCriCodecsEx/awb.py,sha256=p68tVqZOorOE1Js-w1Sqy4GMvu9gxzlBgUL2LAUNEqU,5657
-PyCriCodecsEx/chunk.py,sha256=nrRUANDFZ1LDszHEGDDnQDuNnAB_kGCzbpC7bsgtjqc,2504
-PyCriCodecsEx/cpk.py,sha256=AKShN6P7p70i3GQfKKS-VH3mkbexOLfHEJrjuxS0SQQ,37692
-PyCriCodecsEx/hca.py,sha256=lSslLyv1D1zM_kHFyOlKpbM7qzghmJDYRd-isP8qcyg,14192
-PyCriCodecsEx/usm.py,sha256=X4mv-3ksiX10C6EDACpu-dwRn9eSy3wmY7of2aO7eiA,46216
-PyCriCodecsEx/utf.py,sha256=Yp1Le3AS7UC4So_sGO39N5X5D23X7MsWugHo52npwR0,28256
-pycricodecsex-0.0.1.dist-info/licenses/LICENSE,sha256=B47Qr_82CmMyuL-wNFAH_P6PNJWaonv5dxo9MfgjEXw,1083
-pycricodecsex-0.0.1.dist-info/METADATA,sha256=Z4KAoITGoFoNhiiJ_YXSnrBE--W51_Q-pXt3lerFMX8,3324
-pycricodecsex-0.0.1.dist-info/WHEEL,sha256=Ri8zddKrjGdgjlj1OpSsvpDnvHfnQhMQWi3E_v2pqng,97
-pycricodecsex-0.0.1.dist-info/top_level.txt,sha256=mSrrEse9hT0s6nl-sWAQWAhNRuZ6jo98pbFoN3L2MXk,26
-pycricodecsex-0.0.1.dist-info/RECORD,,