Add docs link as link of repo

Disclaimer: This project is not affiliated with Pioneer Corp. or its related companies in any way and has been written independently! Pyrekordbox is licensed under the MIT license. The maintainers of the project are not liable for any damages to your Rekordbox library.

Pyrekordbox is a Python package for interacting with the library and export data of Pioneers Rekordbox DJ Software. It currently supports

Rekordbox v6 master.db database
Rekordbox XML database
Analysis files (ANLZ)
My-Setting files

Tested Rekordbox versions: 5.8.6 | 6.5.3 | 6.7.7

⚠️	This project is still under development and might contain bugs or have breaking API changes in the future. Check the changelog for recent changes!

🔧 Installation

Pyrekordbox is available on PyPI:

pip install pyrekordbox

Alternatively, it can be installed via GitHub

pip install git+https://github.com/dylanljones/pyrekordbox.git@VERSION

where VERSION is a release, tag or branch name.

Dependencies

Unlocking the new Rekordbox 6 master.db database file requires SQLCipher. Pyrekordbox makes no attempt to download/install SQLCipher, as it is a pure Python package - whereas the SQLCipher/sqlcipher3 installation is platform-dependent and can not be installed via pip.

Windows

SQLCipher can be used by building the libary against an amalgamation with sqlcipher3. For a detailed instruction, see the installation guide.

MacOS

For MacOS follow these steps:

Install Homebrew if you do not have it on your machine.
Install SQLCipher with brew install SQLCipher.
With the python environment you are using to run pyrekordbox active execute the following:

git clone https://github.com/coleifer/sqlcipher3
cd sqlcipher3
SQLCIPHER_PATH=$(brew info sqlcipher | awk 'NR==4 {print $1; exit}'); C_INCLUDE_PATH="$SQLCIPHER_PATH"/include LIBRARY_PATH="$SQLCIPHER_PATH"/lib python setup.py build
SQLCIPHER_PATH=$(brew info sqlcipher | awk 'NR==4 {print $1; exit}'); C_INCLUDE_PATH="$SQLCIPHER_PATH"/include LIBRARY_PATH="$SQLCIPHER_PATH"/lib python setup.py install

Make sure the C_INCLUDE and LIBRARY_PATH point to the installed SQLCipher path. It may differ on your machine. If you are having issues installing sqlcipher3 on M1 Macs please refer to the installation guide.

🚀 Quick-Start

Read the full documentation on ReadTheDocs!

❗	Please make sure to back up your Rekordbox collection before making changes with pyrekordbox or developing/testing new features. The backup dialog can be found under "File" > "Library" > "Backup Library"

Configuration

Pyrekordbox looks for installed Rekordbox versions and sets up the configuration automatically. The configuration can be checked by calling:

from pyrekordbox import show_config

show_config()

If for some reason the configuration fails the values can be updated by providing the paths to the directory where Pioneer applications are installed (pioneer_install_dir) and to the directory where Pioneer stores the application data (pioneer_app_dir)

from pyrekordbox.config import update_config

update_config("<pioneer_install_dir>", "<pioneer_app_dir>")

Alternatively the two paths can be specified in a configuration file under the section rekordbox. Supported configuration files are pyproject.toml, setup.cfg, pyrekordbox.toml, pyrekordbox.cfg and pyrekordbox.yaml.

Rekordbox 6 database

Rekordbox 6 now uses a SQLite database for storing the collection content. Unfortunatly, the new master.db SQLite database is encrypted using SQLCipher, which means it can't be used without the encryption key. However, since your data is stored and used locally, the key must be present on the machine running Rekordbox.

Pyrekordbox can unlock the new Rekordbox master.db SQLite database and provides an easy interface for accessing the data stored in it:

from pyrekordbox import Rekordbox6Database

db = Rekordbox6Database()

for content in db.get_content():
    print(content.Title, content.Artist.Name)

playlist = db.get_playlist()[0]
for song in playlist.Songs:
    content = song.Content
    print(content.Title, content.Artist.Name)

Fields in the Rekordbox database that are stored without linking to other tables can be changed via the corresponding property of the object:

content = db.get_content()[0]
content.Title = "New Title"

Some fields are stored as references to other tables, for example the artist of a track. Check the documentation of the corresponding object for more information. So far only a few tables support adding or deleting entries:

DjmdPlaylist: Playlists/Playlist Folders
DjmdSongPlaylist: Songs in a playlist
DjmdAlbum: Albums
DjmdArtist: Artists
DjmdGenre: Genres
DjmdLabel: Labels

If the automatic key extraction fails the command line interface of pyrekordbox provides a command for downloading the key from known sources and writing it to the cache file:

python -m pyrekordbox download-key

Once the key is cached the database can be opened without providing the key. The key can also be provided manually:

db = Rekordbox6Database(key="<insert key here>")

Rekordbox XML

The Rekordbox XML database is used for importing (and exporting) Rekordbox collections including track metadata and playlists. They can also be used to share playlists between two databases.

Pyrekordbox can read and write Rekordbox XML databases.

from pyrekordbox.rbxml import RekordboxXml

xml = RekordboxXml("database.xml")

track = xml.get_track(0)    # Get track by index (or TrackID)
track_id = track.TrackID    # Access via attribute
name = track["Name"]        # or dictionary syntax

path = "/path/to/file.mp3"
track = xml.add_track(path) # Add new track
track["Name"] = "Title"     # Add attributes to new track
track["TrackID"] = 10       # Types are handled automatically

# Get playlist (folder) by path
pl = xml.get_playlist("Folder", "Sub Playlist")
keys = pl.get_tracks()  # Get keys of tracks in playlist
ktype = pl.key_type     # Key can either be TrackID or Location

# Add tracks and sub-playlists (folders)
pl.add_track(track.TrackID)
pl.add_playlist("Sub Sub Playlist")

Rekordbox ANLZ files

Rekordbox stores analysis information of the tracks in the collection in specific files, which also get exported to decives used by Pioneer professional DJ equipment. The files have names like ANLZ0000 and come with the extensions .DAT, .EXT or .2EX. They include waveforms, beat grids (information about the precise time at which each beat occurs), time indices to allow efficient seeking to specific positions inside variable bit-rate audio streams, and lists of memory cues and loop points.

Pyrekordbox can parse all three analysis files, although not all the information of the tracks can be extracted yet.

from pyrekordbox.anlz import AnlzFile

anlz = AnlzFile.parse_file("ANLZ0000.DAT")
beat_grid = anlz.get("beat_grid")
path_tags = anlz.getall_tags("path")

Changing and creating the Rekordbox analysis files is planned as well, but for that the full structure of the analysis files has to be understood.

Unsupported ANLZ tags:

PCOB
PCO2
PSSI
PWV6
PWV7
PWVC

Rekordbox My-Settings

Rekordbox stores the user settings in *SETTING.DAT files, which get exported to USB devices. These files are either in the PIONEERdirectory of a USB drive (device exports), but are also present for on local installations of Rekordbox 6. The setting files store the settings found on the "DJ System" > "My Settings" page of the Rekordbox preferences. These include language, LCD brightness, tempo fader range, crossfader curve and other settings for Pioneer professional DJ equipment.

Pyrekordbox supports both parsing and writing My-Setting files.

from pyrekordbox.mysettings import read_mysetting_file

mysett = read_mysetting_file("MYSETTINGS.DAT")
sync = mysett.get("sync")
quant = mysett.get("quantize")

The DEVSETTING.DAT file is still not supported

💡 File formats

A summary of the Rekordbox file formats can be found in the documentation:

💻 Development

If you encounter an issue or want to contribute to pyrekordbox, please feel free to get in touch, open an issue or create a new pull request! A guide for contributing to pyrekordbox and the commit-message style can be found in CONTRIBUTING.

For general questions or discussions about Rekordbox, please use GitHub Discussions instead of opening an issue.

Pyrekordbox is tested on Windows and MacOS, however some features can't be tested in the CI setup since it requires a working Rekordbox installation.

🔗 Related Projects and References

crate-digger: Java library for fetching and parsing rekordbox exports and track analysis files.
rekordcrate: Library for parsing Pioneer Rekordbox device exports
supbox: Get the currently playing track from Rekordbox v6 as Audio Hijack Shoutcast/Icecast metadata, display in your OBS video broadcast or export as JSON.
Deep Symmetry has an extensive analysis of Rekordbox's ANLZ and .edb export file formats https://djl-analysis.deepsymmetry.org/djl-analysis
rekordcrate reverse engineered the format of the Rekordbox MySetting files https://holzhaus.github.io/rekordcrate/rekordcrate/setting/index.html
rekordcloud went into detail about the internals of Rekordbox 6 https://rekord.cloud/blog/technical-inspection-of-rekordbox-6-and-its-new-internals.
supbox has a nice implementation on finding the Rekordbox 6 database key https://github.com/gabek/supbox

dylanljones / pyrekordbox Goto Github PK

pyrekordbox's Introduction

🔧 Installation

Dependencies

Windows

MacOS

🚀 Quick-Start

Configuration

Rekordbox 6 database

Rekordbox XML

Rekordbox ANLZ files

Rekordbox My-Settings

💡 File formats

💻 Development

🔗 Related Projects and References

pyrekordbox's People

Contributors

Stargazers

Watchers

Forkers

pyrekordbox's Issues

Describe the bug

To Reproduce

Recommend Projects

Recommend Topics

Recommend Org