Skip to content

Latest commit

 

History

History
111 lines (78 loc) · 2.92 KB

README.md

File metadata and controls

111 lines (78 loc) · 2.92 KB
Raw

dawtool

dawtool parses and extracts data from Digital Audio Workstation (DAW) file formats.

It provides a high accuracy implementation of time marker extraction, including support for projects with tempo automation.

Supported formats:

  • Ableton Live set (.als) [v8-12]
  • FL Studio project (.flp) [v10-11, 20]
  • Cue sheet (.cue)

Just browsing? Here are a few points of interest in the codebase.

About

Time markers allow users to annotate the DAW timeline with text. Certain use cases benefit from the ability to export these annotations, such as timestamping a DJ mix, podcast, or film.

dawtool implements time marker export for DAWs that do not implement it natively, showcasing how DAWs can be extended through project file manipulation.

For more on how dawtool works, see the talk about it at the 2020 Audio Developer Conference.

Usage

Time markers are the only officially supported output. However much more of the formats are available through internal APIs, such as tempo automation data.

Python API

Simple API (Markers Only)

import sys
import dawtool

filename = sys.argv[1]
with open(filename, 'rb') as f:
    markers = dawtool.extract_markers(filename, f)
    for marker in markers:
        print(marker.time, marker.text)

Advanced API (Markers & Other Data)

import sys
import dawtool

filename = sys.argv[1]
with open(filename, 'rb') as f:
    # Load project based on file extension
    proj = dawtool.load_project(filename, f)
    # Parse project, recompute time markers
    proj.parse()
    # Access project data
    for marker in proj.markers:
        print(marker.time, marker.text)

Command line tool

$ dawtool -m my-dj-mix.als
00:00.000 nciku - peaceofmind
02:15.115 comfort - a n g e l _ w i n g s
05:18.654 rose bride rings - femme fatale
06:52.654 ranov - butterfly
08:47.077 scalade - tempura VIP
10:57.423 mirvs - defrosted

Installation

dawtool requires Python 3.7 or greater.

pip install git+https://github.com/offlinemark/dawtool

Status

dawtool is production ready. A hosted version has processed 10,000+ project files since March 2020.

Both the API and CLI should be considered unstable and subject to change.

Tempo automation is supported for linear automation only. Nonlinear automation may cause inaccuracies.

Credits

dawtool's .flp parser is based on work from the LMMS, PyDaw, and FLParser projects.