pyrekordbox 0.2.0__py3-none-any.whl → 0.2.2__py3-none-any.whl

pyrekordbox/anlz/file.py

@@ -8,9 +8,12 @@ from pathlib import Path
 from typing import Union
 from .tags import TAGS
 from . import structs
+from construct import Int16ub
 
 logger = logging.getLogger(__name__)
 
+XOR_MASK = bytearray.fromhex("CB E1 EE FA E5 EE AD EE E9 D2 E9 EB E1 E9 F3 E8 E9 F4 E1")
+
 
 class BuildFileLengthError(Exception):
     def __init__(self, struct, len_data):
@@ -103,6 +106,31 @@ class AnlzFile(abc.Mapping):
             # Get the four byte struct type
             tag_type = tag_data[:4].decode("ascii")
 
+            if tag_type == "PSSI":
+                # The version that rekordbox 6 *exports* is garbled with an XOR mask.
+                # All bytes after byte 17 (len_e) are XOR-masked with a pattern that is
+                # generated by adding the value of len_e to each byte of XOR_MASK
+
+                # Check if the file is garbled (only on exported files)
+                # For this we check the validity of mood and bank
+                # Mood: High=1, Mid=2, Low=3
+                # Bank: 1-8
+                mood = Int16ub.parse(tag_data[18:20])
+                bank = Int16ub.parse(tag_data[28:30])
+                if 1 <= mood <= 3 and 1 <= bank <= 8:
+                    logger.debug("PSSI is not garbled!")
+                else:
+                    logger.debug("PSSI is garbled!")
+                    # deobfuscate tag_data[18:] using xor with XOR_MASK+len_entries
+                    len_entries = Int16ub.parse(tag_data[16:])
+                    tag_data = bytearray(data[i : i + len(tag_data)])
+                    for x in range(len(tag_data[18:])):
+                        mask = XOR_MASK[x % len(XOR_MASK)] + len_entries
+                        if mask > 255:
+                            mask -= 256
+                        tag_data[x + 18] ^= mask
+                    tag_data = bytes(tag_data)
+
             try:
                 # Parse the struct
                 tag = TAGS[tag_type](tag_data)
@@ -178,6 +206,17 @@ class AnlzFile(abc.Mapping):
         else:
             return [tag for tag in self.tags if tag.name == item]
 
+    def __contains__(self, item):
+        if item.isupper() and len(item) == 4:
+            for tag in self.tags:
+                if item == tag.type:
+                    return True
+        else:
+            for tag in self.tags:
+                if item == tag.name:
+                    return True
+        return False
+
     def __repr__(self):
         return f"{self.__class__.__name__}({self.tag_types})"
 

pyrekordbox/anlz/structs.py

@@ -195,8 +195,6 @@ PWV5 = Struct(
 
 # -- Song Structure Tag (PSSI) ---------------------------------------------------------
 
-# FixMe: Implement reverse XOR mask to descramble values
-
 SongStructureEntry = Struct(
     "index" / Int16ub,
     "beat" / Int16ub,
@@ -221,11 +219,11 @@ SongStructureEntry = Struct(
 PSSI = Struct(
     "len_entry_bytes" /  Const(24, Int32ub),
     "len_entries" / Int16ub,
-    "mood" / Bytes(2),
+    "mood" / Int16ub,
     "u1" / Bytes(6),
-    "end_beat" / Bytes(2),
+    "end_beat" / Int16ub,
     "u2" / Bytes(2),
-    "bank" / Bytes(1),
+    "bank" / Int8ub,
     "u3" / Bytes(1),
     "entries" / Array(this.len_entries, SongStructureEntry),
 )

pyrekordbox/config.py

@@ -15,6 +15,7 @@ import logging
 import base64
 import blowfish
 import json
+import packaging.version
 import xml.etree.cElementTree as xml
 from pathlib import Path
 from typing import Union
@@ -247,6 +248,7 @@ def _get_rb_config(
     pioneer_install_dir: Path,
     pioneer_app_dir: Path,
     major_version: int,
+    application_dirname: str = "",
 ) -> dict:
     """Get the program configuration for a given Rekordbox major version.
 
@@ -258,33 +260,55 @@ def _get_rb_config(
         The path of the Pioneer application data directory.
     major_version : int
         The major version of Rekordbox.
+    application_dirname : str, optional
+        The name of the Rekordbox application directory. If not given, the latest
+        Rekordbox installation directory for major version `major_version` is used.
 
     Returns
     -------
     config : dict
         The program configuration.
     """
-    # Get latest Rekordbox installation directory for major release `major_version`
-
-    # Find all 'V.x.x' version strings in dir names
-    versions = list()
-    for p in pioneer_install_dir.iterdir():
-        name = p.name
-        if name.startswith("rekordbox"):
-            ver_str = name.replace("rekordbox", "").strip()
-            if ver_str.startswith(str(major_version)):
-                versions.append(ver_str)
-    # Get latest 'V.x.x' version string and assure there is one
-    versions.sort(key=lambda s: list(map(int, s.split("."))))
-    try:
-        rb_version = versions[-1]
-    except IndexError:
-        raise FileNotFoundError(
-            f"No Rekordbox {major_version} folder found in installation "
-            f"directory '{pioneer_install_dir}'"
-        )
-    # Name of the Rekordbox application directory in `pioneer_install_dir`
-    rb_prog_dir = pioneer_install_dir / f"rekordbox {rb_version}"
+    if application_dirname:
+        # Applitcation dirname is given, only extract version from it
+        # `major_version` is compared to the version string
+        rb_version = application_dirname.replace("rekordbox", "").strip()
+        rb_version = rb_version.replace(".app", "")
+        if not rb_version.startswith(str(major_version)):
+            raise ValueError(
+                f"Major version is {major_version}, but the supplied application "
+                f"dirname is '{application_dirname}'"
+            )
+        rb_prog_dir = pioneer_install_dir / application_dirname
+        if not rb_prog_dir.exists():
+            raise InvalidApplicationDirname(
+                f"The supplied application dirname '{application_dirname}' does not "
+                f"exist in '{pioneer_install_dir}'"
+            )
+    else:
+        # Get latest Rekordbox installation directory for major release `major_version`
+
+        # Find all 'V.x.x' version strings in dir names
+        versions = list()
+        for p in pioneer_install_dir.iterdir():
+            name = p.name
+            if name.startswith("rekordbox"):
+                ver_str = name.replace("rekordbox", "").strip()
+                ver_str = ver_str.replace(".app", "")
+                if ver_str.startswith(str(major_version)):
+                    v = packaging.version.parse(ver_str)
+                    versions.append(v)
+        # Get latest 'V.x.x' version string and assure there is one
+        versions.sort()  # key=lambda s: list(map(int, s.split("."))))
+        try:
+            rb_version = str(versions[-1])
+        except IndexError:
+            raise FileNotFoundError(
+                f"No Rekordbox {major_version} folder found in installation "
+                f"directory '{pioneer_install_dir}'"
+            )
+        # Name of the Rekordbox application directory in `pioneer_install_dir`
+        rb_prog_dir = pioneer_install_dir / f"rekordbox {rb_version}"
 
     # Check installation directory
     if not rb_prog_dir.exists():
@@ -318,10 +342,12 @@ def _get_rb_config(
     return conf
 
 
-def _get_rb5_config(pioneer_prog_dir: Path, pioneer_app_dir: Path) -> dict:
+def _get_rb5_config(
+    pioneer_prog_dir: Path, pioneer_app_dir: Path, dirname: str = ""
+) -> dict:
     """Get the program configuration for Rekordbox v5.x.x."""
     major_version = 5
-    conf = _get_rb_config(pioneer_prog_dir, pioneer_app_dir, major_version)
+    conf = _get_rb_config(pioneer_prog_dir, pioneer_app_dir, major_version, dirname)
     return conf
 
 
@@ -377,10 +403,12 @@ def write_db6_key_cache(key: str) -> None:  # pragma: no cover
     __config__["rekordbox6"]["dp"] = key
 
 
-def _get_rb6_config(pioneer_prog_dir: Path, pioneer_app_dir: Path) -> dict:
+def _get_rb6_config(
+    pioneer_prog_dir: Path, pioneer_app_dir: Path, dirname: str = ""
+) -> dict:
     """Get the program configuration for Rekordbox v6.x.x."""
     major_version = 6
-    conf = _get_rb_config(pioneer_prog_dir, pioneer_app_dir, major_version)
+    conf = _get_rb_config(pioneer_prog_dir, pioneer_app_dir, major_version, dirname)
 
     # Read Rekordbox 6 'options.json' and check db_path
     opts = read_rekordbox6_options(pioneer_app_dir)
@@ -488,6 +516,8 @@ def read_pyrekordbox_configuration():
 def update_config(
     pioneer_install_dir: Union[str, Path] = None,
     pioneer_app_dir: Union[str, Path] = None,
+    rb5_install_dirname: str = "",
+    rb6_install_dirname: str = "",
 ):
     """Update the pyrekordbox configuration.
 
@@ -508,6 +538,12 @@ def update_config(
         The path to the Pioneer application directory. This is where the application
         user data of Pioneer programs is stored. By default, the normal location of
         the Pioneer application data is used.
+    rb5_install_dirname : str, optional
+        The name of the Rekordbox 5 installation directory. By default, the normal
+        directory name is used (Windows: 'rekordbox 5.x.x', macOS: 'rekordbox 5.app').
+    rb6_install_dirname : str, optional
+        The name of the Rekordbox 6 installation directory. By default, the normal
+        directory name is used (Windows: 'rekordbox 6.x.x', macOS: 'rekordbox 6.app').
     """
     # Read config file
     conf = read_pyrekordbox_configuration()
@@ -515,6 +551,10 @@ def update_config(
         pioneer_install_dir = conf["pioneer-install-dir"]
     if pioneer_app_dir is None and "pioneer-app-dir" in conf:
         pioneer_app_dir = conf["pioneer-app-dir"]
+    if not rb5_install_dirname and "rekordbox5-install-dirname" in conf:
+        rb5_install_dirname = conf["rekordbox5-install-dirname"]
+    if not rb6_install_dirname and "rekordbox6-install-dirname" in conf:
+        rb6_install_dirname = conf["rekordbox6-install-dirname"]
 
     # Pioneer installation directory
     try:
@@ -534,14 +574,18 @@ def update_config(
 
     # Update Rekordbox 5 config
     try:
-        conf = _get_rb5_config(pioneer_install_dir, pioneer_app_dir)
+        conf = _get_rb5_config(
+            pioneer_install_dir, pioneer_app_dir, rb5_install_dirname
+        )
         __config__["rekordbox5"].update(conf)
     except FileNotFoundError as e:
         logger.info(e)
 
     # Update Rekordbox 6 config
     try:
-        conf = _get_rb6_config(pioneer_install_dir, pioneer_app_dir)
+        conf = _get_rb6_config(
+            pioneer_install_dir, pioneer_app_dir, rb6_install_dirname
+        )
         __config__["rekordbox6"].update(conf)
     except FileNotFoundError as e:
         logger.info(e)