rbox 0.1.4

Rust library for interacting with the local and export data of Pioneers Rekordbox DJ software
Documentation

⚠️ Disclaimer: This project is not affiliated with Pioneer DJ, AlphaTheta Corp., or any related entities. The maintainers and contributors assume no liability for any data loss or damage to your Rekordbox library. "Rekordbox" is a registered trademark of AlphaTheta Corporation.

rbox is a high-performance Rust library for seamlessly interacting with Pioneer DJ's Rekordbox software data. It supports the following Rekordbox files:

  • Rekordbox database: Query and update the Rekordbox v6/v7 master.db database through a type-safe ORM
  • XML database: Read and write Rekordbox XML database files
  • Analysis Files: Read and write ANLZ files containing waveforms, beat grids, hot cues and more
  • Settings Access: Read and write My-Setting files

🔧 Installation

rbox is available on Cargo. Run the following Cargo command in your project directory:

cargo add rbox

or add the following line to your Cargo.toml:

rbox = "0.1.4"

🚀 Quick-Start

❗ Caution: Please make sure to back up your Rekordbox collection before making changes to rekordbox data. The backup dialog can be found under "File" > "Library" > "Backup Library"

Rekordbox 6/7 database

Rekordbox 6 and 7 use a SQLite database for storing the collection content. Unfortunatly, the 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.

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

use rbox::prelude::*;

fn main() -> anyhow::Result<()> {
    let mut db = MasterDb::open()?;
    let contents = db.get_content()?;
    for content in contents {
        println!("{:?}", content);
    }
    Ok(())
}

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.

rbox can read and write Rekordbox XML databases.

use rbox::prelude::*;

fn main() -> anyhow::Result<()> {
    let mut xml = RekordboxXml::load("database.xml");
    let tracks = xml.get_tracks();
    for track in tracks {
        println!("{:?}", track);
    }
    Ok(())
}

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.

rbox can parse and write all three analysis files.

use rbox::prelude::*;

fn main() -> anyhow::Result<()> {
    let mut anlz = Anlz::load("ANLZ0000.DAT")?;
    let grid = anlz.get_beat_grid().unwrap();
    for beat in grid {
        println!("Beat: {} Tempo: {} Time: {}", beat.beat_number, beat.tempo, beat.time);
    }
    Ok(())
}

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.

rbox supports both parsing and writing of My-Setting files.

use rbox::prelude::*;
use rbox::settings::Quantize;

fn main() -> anyhow::Result<()> {
    let mut sett = Setting::load("MYSETTING.DAT")?;
    println!("Quantize: {}", sett.get_quantize()?);
    sett.set_quantize(Quantize::Off)?;
    sett.dump()?;
    Ok(())
}

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Sponsor

If rbox has helped you or saved you time, consider supporting its development - every coffee makes a difference!

BuyMeACoffee