Merge pull request #196 from steven11sjf/bnvib

Added bnvib

README.md

@@ -51,7 +51,7 @@ Construct type definitions for Mercury Engine
 | BMSSTOC   | Missing              | Missing               | ✗      | ✗       |
 | BMTRE     | ✗              | ✗               | ✓      | ✓       |
 | BMTUN     | ✓              | ✓               | Missing      | Missing       |
-| BNVIB     | Missing              | Missing               | ✗      | ✗       |
+| BNVIB     | Missing              | Missing               | ✓      | ✓       |
 | BPSI      | ✗              | ✗               | ✗      | ✗       |
 | BPTDAT    | Missing              | Missing               | ✗      | ✗       |
 | BPTDEF    | Missing              | Missing               | ✗      | ✗       |

src/mercury_engine_data_structures/formats/__init__.py

@@ -30,6 +30,7 @@
 from mercury_engine_data_structures.formats.bmssd import Bmssd
 from mercury_engine_data_structures.formats.bmtre import Bmtre
 from mercury_engine_data_structures.formats.bmtun import Bmtun
+from mercury_engine_data_structures.formats.bnvib import Bnvib
 from mercury_engine_data_structures.formats.brem import Brem
 from mercury_engine_data_structures.formats.bres import Bres
 from mercury_engine_data_structures.formats.brev import Brev
@@ -80,6 +81,7 @@
     "BMSLINK": Bmslink,
     "BMSMD": Bmsmd,
     "BMTRE": Bmtre,
+    "BNVIB": Bnvib,
     "BRSA": Brsa,
     "BREM": Brem,
     "BRES": Bres,

src/mercury_engine_data_structures/formats/bnvib.py

@@ -0,0 +1,39 @@
+from enum import Enum
+
+import construct
+from construct.core import (
+    Byte,
+    Const,
+    Construct,
+    If,
+    Int16ul,
+    Int32ul,
+    PrefixedArray,
+    Struct,
+)
+
+from mercury_engine_data_structures.adapters.enum_adapter import EnumAdapter
+from mercury_engine_data_structures.formats.base_resource import BaseResource
+from mercury_engine_data_structures.game_check import Game
+
+# Standard switch format. https://switchbrew.org/wiki/BNVIB#Normal_Vibration
+
+class VibrationType(Enum):
+    NORMAL = 4
+    LOOP = 12
+    LOOPWAIT = 16
+
+BNVIB = Struct(
+    "vibration_type" / EnumAdapter(VibrationType, Int32ul),
+    "_magic" / Const(3, Int16ul),
+    "sample_rate" / Int16ul,
+    "loop_start" / If(construct.this.vibration_type != VibrationType.NORMAL, Int32ul),
+    "loop_end" / If(construct.this.vibration_type != VibrationType.NORMAL, Int32ul),
+    "loop_wait" / If(construct.this.vibration_type == VibrationType.LOOPWAIT, Int32ul),
+    "data" / PrefixedArray(Int32ul, Byte)
+)
+
+class Bnvib(BaseResource):
+    @classmethod
+    def construct_class(cls, target_game: Game) -> Construct:
+        return BNVIB

tests/formats/test_bnvib.py

@@ -0,0 +1,10 @@
+import pytest
+from tests.test_lib import parse_build_compare_editor
+
+from mercury_engine_data_structures import dread_data
+from mercury_engine_data_structures.formats.bnvib import Bnvib
+
+
+@pytest.mark.parametrize("bnvib_path", dread_data.all_files_ending_with(".bnvib"))
+def test_bgsnds(dread_file_tree, bnvib_path):
+    parse_build_compare_editor(Bnvib, dread_file_tree, bnvib_path)