A Java library for fetching and parsing rekordbox media exports and track analysis files.

or secondary options

This project uses the Kaitai Struct compiler with the help of a Maven plugin to create classes that can parse and output binary data structures in a convenient and efficient way. It uses them to create Java classes, because it was created to support Beat Link, but other projects can use them to output code for other languages.

It also uses the jrpcgen tool (which is part of the Remote Tea project), via another plugin, to generate classes that know how to talk to the non-standard NFSv2 file servers running in Link-capable players, so the rekordbox data can be reliably obtained even during big shows where all four players are in use.

Deep Symmetry’s projects are generously sponsored with hosting by Zulip, an open-source modern team chat app designed to keep both live and asynchronous conversations organized. Thanks to them, you can chat with our community, ask questions, get inspiration, and share your own ideas.

The file rekordbox_pdb.ksy contains the structure definitions needed to parse exported rekordbox databases (export.pdb files).

There is an Export Structure Analysis site describing the details of what we have learned about these file formats. Reading that will help make sense of the exploration tools and the objects returned by this library.

Exploring the Analysis

Each track in a rekordbox database also has ANLZnnnn.DAT and ANLZnnnn.EXT files associated with it, containing the beat grid, an index allowing rapid seeking to any time in variable-bit rate audio files, the waveforms, memory cues and loop points. The paths to these files are found inside the corresponding track record.

The structure definitions for these files are in rekordbox_anlz.ksy. You can use it with the Kaitai Struct Web IDE as described above to explore analysis files found in your own exported media.

Crate Digger is available through Maven Central, so to use it in your Maven project, all you need is to include the appropriate dependency.

Click the maven central badge above to view the repository entry for crate-digger. The proper format for including the latest release as a dependency in a variety of tools, including Leiningen if you are using beat-link from Clojure, can be found in the Dependency Information section.

There are two halves to what Crate Digger offers. The first is an ability to talk to the nonstandard Network File System servers that are running in Pioneer players, and ask them to deliver the rekordbox data export and track analysis files (programs like Beat Link need these files to provide smooth integrations with the music being performed). The second half is the ability to parse the contents of those files, as described above.

Retrieving Files

FileFetcher fetcher = FileFetcher.getInstance();
fetcher.fetch(playerAddress, mountPath, sourcePath, destination);

fetcher.removePlayer(playerAddress);

Parsing Structures

Database database = new Database(downloadedFile);
RekordboxPdb.TrackRow track = database.findTrack(1);
System.out.println(database.getText(track.title()));

Crate Digger uses slf4j to allow you to integrate it with whatever Java logging framework your project is using, so you will need to include the appropriate slf4j binding on your class path.

• There are still more tables to be figured out. Columns looks like the list of things that can be searched by, so perhaps it will hold some clues for how to find and use the index tables, which must exist because it would be horribly slow for the players to do a linear scan through the main sparse tables whenever they wanted a record.

• If we could figure out how to use the indices ourselves, we could avoid having to load the whole file and index it ourselves.

As noted above, he Maven project uses a plugin to run the the jrpcgen tool (which is part of the Remote Tea project) to generate Java classes to implement the ONC RPC specifications found in src/main/rpc. (These are used for communicating with the NFS servers in CDJs.) It also uses the Kaitai Struct Compiler through another plugin to generate Java classes that can parse the rekordbox databases it downloads from the players, based on the specifications found in src/main/kaitai.

These things happen for you automatically during the code generation phase of the Maven build. If you want to use something other than Maven, you will need to figure out how to configure and run the tools yourself.

I started out using pdfLaTeX to write and format the document, but then, at the recommendation of one of the Kaitai Struct developers, switched to XeLaTeX in order to take advantage of newer features. But over time some of the packages I was using, especially for tables, became unsupported and started having issues. So this and the dysentery project’s protocol analysis document have been ported to more modern Asciidoc source in the form of Antora sites.

To re-create (and even improve on) the byte field diagrams I was able to achieve in LaTeX, I ended up writing my own diagram generator, bytefied-svg, which runs as an Antora plugin with the help of David Jencks' generic-svg-extension.

This documentation site can be built alongside the dysentery project’s protocol analysis, by following the directions in that project.

If you have ideas, discoveries, or even code you’d like to share, that’s fantastic! Please take a look at the guidelines and get in touch!

Copyright © 2018–2023 Deep Symmetry, LLC

Distributed under the Eclipse Public License 2.0. By using this software in any fashion, you are agreeing to be bound by the terms of this license. You must not remove this notice, or any other, from this software. A copy of the license can be found in LICENSE within this project.

Secondary Licenses: This Source Code may also be made available under the following Secondary Licenses when the conditions for such availability set forth in the Eclipse Public License, v. 2.0 are satisfied: Mozilla Public License 2.0, or GNU Lesser General Public License v. 3.

Library and Build Tool Licenses