Skip to main content

Utilities for music discography folders (stats, BBCode, normalize).

Project description

trackerhelper

English documentation. For Russian, see README.ru.md.

Utilities for music discography folders (for example, Albums/* and Singles/*):

  • dr.ps1 automates foobar2000 Dynamic Range (DR) scans and saves logs per release.
  • trackerhelper is a CLI that scans releases, summarizes durations, and generates BBCode templates. It can match *_dr.txt logs and optionally upload cover.jpg to FastPic.

Project docs:

  • docs/ARCHITECTURE.md
  • docs/DATA_FLOW.md
  • docs/CONTRIBUTING.md

Code layout (developer notes):

  • trackerhelper/cli/ CLI parsing and subcommands
  • trackerhelper/app/ use-case orchestration
  • trackerhelper/domain/ pure models and business rules
  • trackerhelper/infra/ external tools and filesystem adapters
  • trackerhelper/formatting/ BBCode and output formatting

Requirements

dr.ps1 (Windows)

WARNING: You must enable automatic DR log saving in foobar2000, otherwise dr.ps1 will not see the log file.

  • Windows 10/11
  • PowerShell 5+ (or PowerShell 7+)
  • foobar2000 installed (standard or portable)
  • DR Meter component installed
  • Automatic DR log writing enabled

If DR Meter saves logs to a global folder, dr.ps1 will not see them because it expects the log inside the release folder (or staging copy when the source is read-only).

trackerhelper (Windows / Linux / macOS)

  • Python 3.10+
  • ffprobe from ffmpeg available in PATH
  • requests (used for FastPic uploads in release, installed with the package)
  • rich (CLI progress output, installed with the package)

Check:

ffprobe -version

Recommended folder structure

Example:

DiscographyRoot/
  Albums/
    Album Name - 2019/
      01 - Track.flac
      02 - Track.flac
    Another Album - 2021/
      ...
  Singles/
    Single Name - 2020/
      ...

Notes:

  • Group is the first path segment (for example Albums or Singles). Other groups are supported and printed separately.
  • A release is any folder with at least one supported audio file.
  • Year in the release folder name can be Title - 2024 and is used for BBCode output.

Install

pip install trackerhelper

Developer install from repo:

git clone https://github.com/pryid/trackerhelper
cd trackerhelper
pip install -e .

On Windows, if PowerShell blocks scripts, you can allow them for the current user:

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

Usage

More examples: examples/README.md. Progress bars are shown only on TTY; disable with --no-progress.

1) DR logs via foobar2000 (dr.ps1)

Basic run

.\dr.ps1 -Root "D:\Music\Artist"

By default the script:

  • looks for releases in Root\Albums\* and Root\Singles\* if those groups exist,
  • otherwise treats Root\* as releases,
  • copies each release into a local staging folder only when the source is read-only (for example SMB),
  • runs foobar2000 context menu command Measure Dynamic Range,
  • waits for a foo_dr*.txt|log file inside the release folder (or staging if read-only),
  • copies the log into the reports folder.

Where reports are saved

If -OutDir is not set, reports go to:

  • %USERPROFILE%\Music\DR

File name: <release_name>_dr.txt (release name comes from the folder name; invalid characters are replaced with _).

If foobar2000 is portable or not in the default location

.\dr.ps1 -Root "D:\Music\Artist" -FoobarPath "D:\Apps\foobar2000\foobar2000.exe"

Common parameters

  • -Root (required) release root folder
  • -FoobarPath path to foobar2000.exe if auto-detect fails
  • -CommandName exact context menu command name (default: "Measure Dynamic Range")
  • -Groups release groups (default: Albums, Singles)
  • -Ext audio extensions list
  • -TimeoutSec max wait per release (default: 1800 seconds)
  • -LogNameRegex log filename regex (default: ^foo_dr.*\.(txt|log)$)
  • -OutDir output folder for final *_dr.txt
  • -StageRoot staging folder location (used only for read-only sources)
  • -KeepStage keep staging folder (useful for debugging)
  • -ShowFoobar show foobar window (default is minimized)

Example for read-only source (SMB)

.\dr.ps1 -Root "\\NAS\Music\Artist" -OutDir "D:\Reports\DR"

2) Duration stats and BBCode (trackerhelper)

Basic stats (grouped output)

trackerhelper stats "/path/to/DiscographyRoot"

Output per release includes:

  • duration
  • track count (only files where duration was read)
  • bit depth and sample rate (if ffprobe returns values)
  • a warning line if some tracks were skipped because metadata could not be read

The end prints Total: ....

Include tracks directly under root

By default the root is not treated as a release. To include it:

trackerhelper stats "/path/to/DiscographyRoot" --include-root

Add extra extensions (repeatable)

trackerhelper stats "/path/to/DiscographyRoot" --ext .ape --ext .tak

Machine-readable stats

trackerhelper stats "/path/to/DiscographyRoot" --json
trackerhelper stats "/path/to/DiscographyRoot" --csv

--json summary also includes:

  • scanned_audio_files
  • unreadable_audio_files

Per-release JSON includes:

  • unreadable_track_count

--csv release rows include an unreadable_track_count column.

Per-track stats

trackerhelper stats "/path/to/DiscographyRoot" --json --per-track
trackerhelper stats "/path/to/DiscographyRoot" --csv --per-track

Per-track output contains only tracks where metadata was read successfully.

Write stats to a file

trackerhelper stats "/path/to/DiscographyRoot" --json --output "/tmp/stats.json"

Output files must be outside the music root.

Normalize release folder names

Dry run by default:

trackerhelper normalize "/path/to/DiscographyRoot"

Apply changes:

trackerhelper normalize "/path/to/DiscographyRoot" --apply

Formats:

  • single release: Artist - Album (Year)
  • multiple releases: Year - Artist - Album

Note: normalize uses audio tags for album and artist, and the year from the folder name. If tags or year are missing, the folder is skipped.

Generate a BBCode discography template

trackerhelper release "/path/to/DiscographyRoot"

By default BBCode labels are Russian. Use English output:

trackerhelper release "/path/to/DiscographyRoot" --lang en

Disable FastPic cover upload:

trackerhelper release "/path/to/DiscographyRoot" --no-cover

Output file is written to the current working directory as:

  • <root_folder_name>.txt

Custom output path:

trackerhelper release "/path/to/DiscographyRoot" --output "/tmp/release.txt"

Output files must be outside the music root.

Report missing covers / DR logs

trackerhelper release "/path/to/DiscographyRoot" --report-missing
trackerhelper release "/path/to/DiscographyRoot" --report-missing "/tmp/missing_report.txt"

Output files must be outside the music root.

The report includes:

  • releases missing cover.jpg
  • releases where cover upload failed
  • whether cover uploads were skipped (--no-cover or cover upload unavailable)
  • releases without matching DR logs

The template keeps placeholders like ROOT_COVER_URL, GENRE, Service, YEAR. Russian output uses ЛЕЙБЛ for the label placeholder, English output uses LABEL.

Add DR reports to BBCode

If you already have *_dr.txt (for example from dr.ps1), pass the log directory:

trackerhelper release "/path/to/DiscographyRoot" --dr-dir "C:\Users\<you>\Music\DR"

The tool tries to match DR logs by folder name (several name patterns plus whitespace/dash normalization). If no report is found, BBCode keeps info.

FastPic cover upload (optional)

If the release folder contains cover.jpg (case-insensitive), release uploads the cover to FastPic and inserts the direct link. If not found or upload fails, it keeps COVER_URL.

If cover uploads are disabled with --no-cover, or cover upload support is unavailable, BBCode keeps COVER_URL and the missing-assets report marks cover uploads as skipped.

3) Formatting-only mode (--synthetic)

trackerhelper stats "/any/path" --synthetic
trackerhelper release "/any/path" --synthetic

4) Detect duplicate releases by audio fingerprints (trackerhelper dedupe)

trackerhelper dedupe --roots Albums Singles

You can also pass absolute paths:

trackerhelper dedupe --roots "/music/Artist/Albums" "/music/Artist/Singles"

Options:

  • --move-to DIR move duplicate releases to a folder
  • --delete delete duplicate releases (dangerous)
  • --json output JSON to stdout
  • --csv output CSV to stdout
  • --jsonl output JSON Lines to stdout
  • --output PATH write JSON/CSV/JSONL to a file
  • --plan-out PATH write a plan JSON to apply later
  • --apply-plan PATH apply a previously generated plan
  • --dry-run do not move/delete releases

Reports and output files must be outside the protected scan area. With sibling roots such as Albums and Singles, this also includes their common parent directory.

Note: --apply-plan requires either --move-to or --delete.

If a root path does not exist, it is skipped with a warning. If no valid roots remain, the command exits with an error.

If --out-dir is not set, dedupe picks a safe reports directory automatically. It uses ./_dedupe_reports when that path is outside the protected scan area.

--synthetic uses synthetic data from trackerhelper/app/synthetic_dataset.py and lets you check formatting without real files or ffprobe.

Troubleshooting

dr.ps1: log does not appear

Most common reasons:

  • automatic log writing is not enabled in DR Meter;
  • DR Meter saves logs outside the release folder.

For diagnostics:

.\dr.ps1 -Root "D:\Music\Artist" -LogNameRegex ".*\.(txt|log)$" -KeepStage

Check what files are created inside the release folder (or the staging folder if the source is read-only).

dr.ps1: "cannot find foobar2000.exe"

Provide the path manually:

.\dr.ps1 -Root "D:\Music\Artist" -FoobarPath "D:\Apps\foobar2000\foobar2000.exe"

trackerhelper: Error: ffprobe not found

Install ffmpeg and add it to PATH so ffprobe is available.

trackerhelper: bit depth / sample rate = unknown or mixed

This is normal:

  • some formats do not provide these fields or ffprobe does not return them;
  • a release may contain mixed parameters so it shows mixed.

trackerhelper: Audio files found, but metadata could not be read.

This means audio files were found, but ffprobe could not extract duration metadata from any of them. Check the files themselves and verify that ffprobe can read them directly.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

trackerhelper-0.4.5.tar.gz (39.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

trackerhelper-0.4.5-py3-none-any.whl (48.8 kB view details)

Uploaded Python 3

File details

Details for the file trackerhelper-0.4.5.tar.gz.

File metadata

  • Download URL: trackerhelper-0.4.5.tar.gz
  • Upload date:
  • Size: 39.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for trackerhelper-0.4.5.tar.gz
Algorithm Hash digest
SHA256 f83432a7c9292f88fd2c4a7ffc9074aa822785c52d2ac411e9aef6a5c154d3f2
MD5 7fa89dca3a3d8f914ccb17636c114bd0
BLAKE2b-256 9a035cbdb216ce5577e8d3d1e1f2a578c1c0807dbbf06ff23b52c261913b57e1

See more details on using hashes here.

Provenance

The following attestation bundles were made for trackerhelper-0.4.5.tar.gz:

Publisher: publish.yml on pryid/trackerhelper

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file trackerhelper-0.4.5-py3-none-any.whl.

File metadata

  • Download URL: trackerhelper-0.4.5-py3-none-any.whl
  • Upload date:
  • Size: 48.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for trackerhelper-0.4.5-py3-none-any.whl
Algorithm Hash digest
SHA256 de43a587af3d882cb386f1a8d837f7a2b5fefea16778fa33f92bec63e6aeac92
MD5 2126e041783c5b74c2ef6c69ccabec19
BLAKE2b-256 6930e42856f5196038237ceee6549bea2798051996768f720e4afa693a11a7d9

See more details on using hashes here.

Provenance

The following attestation bundles were made for trackerhelper-0.4.5-py3-none-any.whl:

Publisher: publish.yml on pryid/trackerhelper

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page