mik-automator 1.1.0__tar.gz

mik_automator-1.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 bvandrc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mik_automator-1.1.0/PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 2.4
+Name: mik-automator
+Version: 1.1.0
+Summary: Windows automator and database tools for Mixed In Key 11
+Author-email: bvandrc <bvandercar@outlook.com>
+License-Expression: MIT
+Project-URL: Repository, https://github.com/bvandrc/mik-automator
+Project-URL: Issues, https://github.com/bvandrc/mik-automator/issues
+Project-URL: Changelog, https://github.com/bvandrc/mik-automator/blob/main/CHANGELOG.md
+Keywords: mixed in key,mixedinkey,mik,dj,key detection,harmonic mixing,automation
+Classifier: Environment :: Win32 (MS Windows)
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Multimedia :: Sound/Audio :: Analysis
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pywinauto
+Requires-Dist: pywin32
+Requires-Dist: comtypes
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: pylint; extra == "dev"
+Requires-Dist: pyright; extra == "dev"
+Dynamic: license-file
+
+Windows automator and database tools for Mixed In Key 11.
+
+# Installation
+
+```bash
+pip install mik-automator
+```
+
+Windows only, Python 3.10+.
+
+If you installed it from GitHub as `mixed-in-key-automator`, uninstall that first (`pip uninstall mixed-in-key-automator`): both install the `mik_automator` package, so keeping both leaves them overwriting each other's files.
+
+# Usage
+
+## `mik_automator`
+
+Opens Mixed In Key (or connects to it if it's already open), adds a folder, waits for the analysis to finish, then closes it.
+
+```python
+from mik_automator import mik_automator
+
+mik_automator.run(r"C:\Users\me\Music\DJ Tracks")
+```
+
+It knows the analysis is done once Mixed In Key's database stops changing and the window closes without asking to confirm.
+
+## `mik_db`
+
+Reads and edits Mixed In Key's database (`MIKStore.db`) directly.
+
+- `rename_file(src, dest, names=None)`: points a song at its renamed file, so it keeps its analysis.
+- `remove_files(filepaths)` and `remove_missing_files()`: remove songs, so they're analyzed again when added, or because their file is gone.
+- `get_song_files()` and `get_files_missing_from_db(dir)`: read-only, safe while Mixed In Key is running.
+
+Run `python -m mik_automator.mik_db` to remove the songs whose files no longer exist.
+
+# Development
+
+```bash
+python -m venv .venv
+source .venv/Scripts/activate
+pip install -e ".[dev]"
+```
+
+Lint with `pylint $(git ls-files '*.py')` and `pyright`, and format with `black .`. CI runs all three on pull requests.
+
+# License
+
+[MIT](LICENSE)

mik_automator-1.1.0/README.md

@@ -0,0 +1,49 @@
+Windows automator and database tools for Mixed In Key 11.
+
+# Installation
+
+```bash
+pip install mik-automator
+```
+
+Windows only, Python 3.10+.
+
+If you installed it from GitHub as `mixed-in-key-automator`, uninstall that first (`pip uninstall mixed-in-key-automator`): both install the `mik_automator` package, so keeping both leaves them overwriting each other's files.
+
+# Usage
+
+## `mik_automator`
+
+Opens Mixed In Key (or connects to it if it's already open), adds a folder, waits for the analysis to finish, then closes it.
+
+```python
+from mik_automator import mik_automator
+
+mik_automator.run(r"C:\Users\me\Music\DJ Tracks")
+```
+
+It knows the analysis is done once Mixed In Key's database stops changing and the window closes without asking to confirm.
+
+## `mik_db`
+
+Reads and edits Mixed In Key's database (`MIKStore.db`) directly.
+
+- `rename_file(src, dest, names=None)`: points a song at its renamed file, so it keeps its analysis.
+- `remove_files(filepaths)` and `remove_missing_files()`: remove songs, so they're analyzed again when added, or because their file is gone.
+- `get_song_files()` and `get_files_missing_from_db(dir)`: read-only, safe while Mixed In Key is running.
+
+Run `python -m mik_automator.mik_db` to remove the songs whose files no longer exist.
+
+# Development
+
+```bash
+python -m venv .venv
+source .venv/Scripts/activate
+pip install -e ".[dev]"
+```
+
+Lint with `pylint $(git ls-files '*.py')` and `pyright`, and format with `black .`. CI runs all three on pull requests.
+
+# License
+
+[MIT](LICENSE)

mik_automator-1.1.0/pyproject.toml

@@ -0,0 +1,48 @@
+[build-system]
+requires = ["setuptools>=77.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "mik-automator"
+version = "1.1.0"
+description = "Windows automator and database tools for Mixed In Key 11"
+requires-python = ">= 3.10"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [
+    { name = "bvandrc", email = "bvandercar@outlook.com" },
+]
+keywords = ["mixed in key", "mixedinkey", "mik", "dj", "key detection", "harmonic mixing", "automation"]
+classifiers = [
+    "Environment :: Win32 (MS Windows)",
+    "Intended Audience :: End Users/Desktop",
+    "Operating System :: Microsoft :: Windows",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: Multimedia :: Sound/Audio :: Analysis",
+]
+# Windows only: pywinauto drives the app through UI Automation, and pywin32 sends it window messages
+dependencies = ["pywinauto", "pywin32", "comtypes"]
+
+[project.optional-dependencies]
+dev = ["black", "pylint", "pyright"]
+
+[project.urls]
+Repository = "https://github.com/bvandrc/mik-automator"
+Issues = "https://github.com/bvandrc/mik-automator/issues"
+Changelog = "https://github.com/bvandrc/mik-automator/blob/main/CHANGELOG.md"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["mik_automator*"]
+
+[tool.black]
+line-length = 120
+target-version = ["py310"]
+
+[tool.pyright]
+# Pyright doesn't read .gitignore, so a stale build/ left behind by `pip install .`
+# gets type-checked as a second copy of the source. Setting exclude replaces
+# Pyright's defaults, hence __pycache__ and dotted dirs are restated here.
+exclude = ["build", "dist", "**/__pycache__", "**/.*"]

mik_automator-1.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

mik_automator-1.1.0/src/mik_automator/mik_automator.py

@@ -0,0 +1,170 @@
+import glob
+import logging
+import os
+import time
+from pathlib import Path
+import ctypes
+from typing import Callable
+
+import win32con
+import win32gui
+from comtypes import COMError
+from pywinauto.application import Application, WindowSpecification
+from pywinauto.base_wrapper import BaseWrapper
+from pywinauto.findwindows import find_windows
+from pywinauto.remote_memory_block import RemoteMemoryBlock
+from pywinauto.timings import TimeoutError as WaitTimeoutError, wait_until, wait_until_passes
+
+from mik_automator import mik_db
+
+MIK_TITLE_RE = "Mixed In Key.*"
+
+
+def _get_exe_file():
+    root_dir = os.getenv("LOCALAPPDATA")
+    assert root_dir, "local appdata"
+    exe_files = glob.glob(
+        "Programs/Mixed In Key/Mixed In Key*/MixedInKey.exe",
+        root_dir=root_dir,
+        recursive=True,
+    )
+    assert len(exe_files) != 0, "mik .exe not found"
+    assert len(exe_files) == 1, "more than 1 mik .exe found"
+    return os.path.join(root_dir, exe_files[0])
+
+
+# Create window (or connect to existing)
+def _get_mik_window(create_new_if_not_open: bool):
+    app = Application(backend="uia")
+
+    for i in range(3):
+        try:
+            try:
+                app.connect(title_re=MIK_TITLE_RE)
+            except:  # pylint: disable=bare-except
+                if create_new_if_not_open:
+                    app.start(_get_exe_file())
+
+            window = app.top_window()
+            window.wait("ready", timeout=20)
+            window.wait("visible", timeout=20)
+            return window, app
+        except:  # pylint: disable=bare-except
+            if i == 2:
+                if create_new_if_not_open:  # otherwise, not finding it just means that it closed
+                    logging.error("Could not open MIK")
+                raise
+        time.sleep(3)
+    raise Exception("Could not open MIK")
+
+
+def _is_mik_open():
+    return len(find_windows(title_re=MIK_TITLE_RE)) > 0
+
+
+def _select_folder(dialog: BaseWrapper, dir: str):
+    """Selects a folder in a Browse For Folder dialog, which has no box to type a path in. The message's path is read
+    by the dialog's process, so it has to be written into that process's memory."""
+    path = ctypes.create_unicode_buffer(dir)
+    memory = RemoteMemoryBlock(dialog, ctypes.sizeof(path))
+    try:
+        memory.Write(path)
+        # 0x0467 is BFFM_SETSELECTIONW, the Windows message that selects a folder. True says it's given a path string.
+        win32gui.SendMessage(dialog.handle, 0x0467, True, memory.Address())
+    finally:
+        memory.CleanUp()
+
+
+def _add_folder(window: WindowSpecification, dir: str):
+    # Add Files button has no identifier, so open its dialog with the keyboard shortcut.
+    window.set_focus()
+    window.type_keys("^o")
+
+    # Add Folder button in dialog
+    add_folder_btn = window.child_window(best_match="ADD FOLDERButton")
+    add_folder_btn.click()
+
+    folder_browser_popup = window.child_window(best_match="Browse For Folder")
+    folder_browser_popup.wait("visible", timeout=20)
+    dialog = folder_browser_popup.wrapper_object()
+    _select_folder(dialog, os.path.abspath(dir))
+    time.sleep(1)
+
+    # OK after selected folder.
+    win32gui.PostMessage(dialog.handle, win32con.WM_COMMAND, win32con.IDOK, 0)
+
+
+def _retry_on_com_error(wait: Callable[[], object]):
+    """Runs a wait on the window, again if it fails with a COMError, which reading a control as it closes can raise."""
+    wait_until_passes(60 * 5, 1, wait, COMError)
+
+
+def _wait_for_files_added(window: WindowSpecification):
+    adding_files = window.child_window(best_match="Adding files to queue")
+    try:
+        _retry_on_com_error(lambda: adding_files.wait("visible", timeout=30))
+    except WaitTimeoutError:
+        pass  # a quick add's popup can be gone before we look
+    _retry_on_com_error(lambda: adding_files.wait_not("visible", timeout=60 * 5))
+    _retry_on_com_error(lambda: window.child_window(control_type="ProgressBar").wait_not("visible", timeout=60 * 5))
+
+
+def _get_db_state():
+    stat = os.stat(mik_db.db_file)
+    return stat.st_size, stat.st_mtime_ns
+
+
+def _wait_for_db_to_go_quiet(quiet_seconds: int):
+    """Waits until the database stops changing. It's written to as each track finishes, so changes mean it's analyzing."""
+    state = _get_db_state()
+    last_change_time = time.time()
+    while time.time() - last_change_time < quiet_seconds:
+        time.sleep(1)
+        new_state = _get_db_state()
+        if new_state != state:
+            state = new_state
+            last_change_time = time.time()
+
+
+def run(dir: str):
+    window, app = _get_mik_window(create_new_if_not_open=True)
+    # window.print_control_identifiers()
+
+    # Maximize window to make coordinate clicking consistent.
+    try:
+        maximize_btn = window.child_window(auto_id="MaximizeButton")
+        maximize_btn.click()
+    except:  # pylint: disable=bare-except
+        pass  # already maximized
+
+    window.child_window(control_type="ProgressBar").wait_not("visible", timeout=60 * 5)
+
+    _add_folder(window, dir)
+    _wait_for_files_added(window)
+
+    # Attempt to close once the database is quiet. If window closes, analysis done. If confirmation popup appears, a long
+    # analysis is still going, so wait for quiet again.
+    while True:
+        _wait_for_db_to_go_quiet(quiet_seconds=20)
+        close_button = window.child_window(auto_id="CloseButton")
+        close_button.click()
+        try:
+            # Window item gets all weird here, sometimes can't find the NO button. Re-connect to the window.
+            del app
+            window, app = _get_mik_window(create_new_if_not_open=False)
+            no_button = window.child_window(best_match="NOButton")
+            no_button.wait("visible", timeout=5)
+        except KeyboardInterrupt:
+            input("press any key to continue checking mik")
+            break
+        except Exception:  # pylint: disable=broad-exception-caught
+            # No confirmation popup, so it should be closing. Fails if it stays open, rather than leaving it analyzing.
+            wait_until(30, 1, _is_mik_open, False)
+            break
+        no_button.click()
+
+
+if __name__ == "__main__":
+    dir = os.path.join(Path.home(), "Music\\DJ Tracks")
+    print("adding dir: ", dir)
+    run(dir)

mik_automator-1.1.0/src/mik_automator/mik_db.py

@@ -0,0 +1,98 @@
+import os
+import glob
+import hashlib
+import sqlite3
+from contextlib import closing, contextmanager
+from pathlib import Path
+from typing import TypedDict
+
+appdata_dir = os.getenv("LOCALAPPDATA")
+assert appdata_dir, "local appdata"
+db_file = os.path.join(appdata_dir, "Mixed In Key", "Mixed In Key", "11.0", "MIKStore.db")
+
+AUDIO_EXTENSIONS = (".mp3", ".wav", ".flac", ".aif", ".aiff", ".m4a")
+
+
+class ArtistTitle(TypedDict):
+    artist: str
+    title: str
+
+
+@contextmanager
+def connect():
+    """Opens the MIK database, committing on success and always closing."""
+    connection = sqlite3.connect(db_file)
+    try:
+        with connection:
+            yield connection
+    finally:
+        connection.close()
+
+
+def get_song_files() -> set[str]:
+    """Returns every song's path, lowercased. Opens read-only, so it's safe while Mixed In Key is running."""
+    with closing(sqlite3.connect(f"{Path(db_file).as_uri()}?mode=ro", uri=True)) as connection:
+        return {row[0].lower() for row in connection.execute("SELECT File FROM Song")}
+
+
+def get_files_missing_from_db(dir: str) -> list[str]:
+    song_files = get_song_files()
+    files = (f for f in glob.iglob(os.path.join(dir, "**", "*"), recursive=True) if os.path.isfile(f))
+    return [f for f in files if os.path.splitext(f)[1].lower() in AUDIO_EXTENSIONS and f.lower() not in song_files]
+
+
+def get_file_path_hash(filepath: str, disk_serial: str) -> str:
+    """Same as Mixed In Key's: paths are tied to the disk, so they still match if the drive letter changes."""
+    id_string = f"{disk_serial}:{filepath.split(':', 1)[1]}" if disk_serial.strip() else filepath
+    return hashlib.md5(id_string.lower().encode("utf-8")).hexdigest().upper()
+
+
+def rename_file(src: str, dest: str, names: ArtistTitle | None = None) -> bool:
+    """Points a song at its renamed file, so it keeps its analysis. Returns whether the song was found.
+
+    Pass names when known, since filenames lose characters ("RÜFÜS DU SOL" is "RUFUS DU SOL"). Otherwise they come
+    from the filename, which must be "Artist - Title", as the file's tags may not be updated yet."""
+    if names is None:
+        filename = os.path.splitext(os.path.basename(dest))[0]
+        try:
+            artist, title = filename.split(" - ", 1)
+        except ValueError as e:
+            raise ValueError(f"couldn't parse {filename} as Artist - Title") from e
+        names = {"artist": artist, "title": title}
+
+    with connect() as connection:
+        row = connection.execute("SELECT DiskSerialNumber FROM Song WHERE File = ?", (src,)).fetchone()
+        if row is None:
+            return False
+        # src's file replaced whatever was at dest, so that song's row would be a duplicate
+        if src != dest:
+            connection.execute("DELETE FROM Song WHERE File = ?", (dest,))
+        connection.execute(
+            "UPDATE Song SET File = ?, FilePathHash = ?, ArtistName = ?, SongName = ? WHERE File = ?",
+            (dest, get_file_path_hash(dest, row[0]), names["artist"], names["title"], src),
+        )
+    return True
+
+
+def remove_files(filepaths: list[str]):
+    if len(filepaths) == 0:
+        return
+    with connect() as connection:
+        connection.executemany("DELETE FROM Song WHERE File = ?", [(filepath,) for filepath in filepaths])
+
+
+def remove_missing_files() -> list[str]:
+    """Removes songs whose file no longer exists. Skips files on drives that aren't connected. Returns the removed paths."""
+    with connect() as connection:
+        filepaths = [row[0] for row in connection.execute("SELECT File FROM Song")]
+
+    missing = [f for f in filepaths if os.path.exists(os.path.splitdrive(f)[0] + os.sep) and not os.path.exists(f)]
+    remove_files(missing)
+    return missing
+
+
+if __name__ == "__main__":
+    removed = remove_missing_files()
+    for filepath in removed:
+        print(filepath)
+    print(f"Removed {len(removed)} missing files")

mik_automator-1.1.0/src/mik_automator.egg-info/PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 2.4
+Name: mik-automator
+Version: 1.1.0
+Summary: Windows automator and database tools for Mixed In Key 11
+Author-email: bvandrc <bvandercar@outlook.com>
+License-Expression: MIT
+Project-URL: Repository, https://github.com/bvandrc/mik-automator
+Project-URL: Issues, https://github.com/bvandrc/mik-automator/issues
+Project-URL: Changelog, https://github.com/bvandrc/mik-automator/blob/main/CHANGELOG.md
+Keywords: mixed in key,mixedinkey,mik,dj,key detection,harmonic mixing,automation
+Classifier: Environment :: Win32 (MS Windows)
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Multimedia :: Sound/Audio :: Analysis
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pywinauto
+Requires-Dist: pywin32
+Requires-Dist: comtypes
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: pylint; extra == "dev"
+Requires-Dist: pyright; extra == "dev"
+Dynamic: license-file
+
+Windows automator and database tools for Mixed In Key 11.
+
+# Installation
+
+```bash
+pip install mik-automator
+```
+
+Windows only, Python 3.10+.
+
+If you installed it from GitHub as `mixed-in-key-automator`, uninstall that first (`pip uninstall mixed-in-key-automator`): both install the `mik_automator` package, so keeping both leaves them overwriting each other's files.
+
+# Usage
+
+## `mik_automator`
+
+Opens Mixed In Key (or connects to it if it's already open), adds a folder, waits for the analysis to finish, then closes it.
+
+```python
+from mik_automator import mik_automator
+
+mik_automator.run(r"C:\Users\me\Music\DJ Tracks")
+```
+
+It knows the analysis is done once Mixed In Key's database stops changing and the window closes without asking to confirm.
+
+## `mik_db`
+
+Reads and edits Mixed In Key's database (`MIKStore.db`) directly.
+
+- `rename_file(src, dest, names=None)`: points a song at its renamed file, so it keeps its analysis.
+- `remove_files(filepaths)` and `remove_missing_files()`: remove songs, so they're analyzed again when added, or because their file is gone.
+- `get_song_files()` and `get_files_missing_from_db(dir)`: read-only, safe while Mixed In Key is running.
+
+Run `python -m mik_automator.mik_db` to remove the songs whose files no longer exist.
+
+# Development
+
+```bash
+python -m venv .venv
+source .venv/Scripts/activate
+pip install -e ".[dev]"
+```
+
+Lint with `pylint $(git ls-files '*.py')` and `pyright`, and format with `black .`. CI runs all three on pull requests.
+
+# License
+
+[MIT](LICENSE)

mik_automator-1.1.0/src/mik_automator.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+pyproject.toml
+src/mik_automator/__init__.py
+src/mik_automator/mik_automator.py
+src/mik_automator/mik_db.py
+src/mik_automator.egg-info/PKG-INFO
+src/mik_automator.egg-info/SOURCES.txt
+src/mik_automator.egg-info/dependency_links.txt
+src/mik_automator.egg-info/requires.txt
+src/mik_automator.egg-info/top_level.txt

mik_automator-1.1.0/src/mik_automator.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

mik_automator-1.1.0/src/mik_automator.egg-info/requires.txt

@@ -0,0 +1,8 @@
+pywinauto
+pywin32
+comtypes
+
+[dev]
+black
+pylint
+pyright

mik_automator-1.1.0/src/mik_automator.egg-info/top_level.txt

@@ -0,0 +1 @@
+mik_automator