Modulo12

Modulo12 is a novel SQL like language for parsing data and metadata about music (from midi and musicxml files).

The purpose of this language is to query facts about musicxml and midi files based of western music theory (e.g. queries of the form, get all the songs under a directory with a specific key signature or in tempo range) or metadata about the song's specific performance (get all songs that have guitars in it)

The way it works is you put your songs under a directory and then run a query of this form

select [input_file_types] from directory_containing_songs where (conditions);

Modulo12 will fetch all songs recursively under the directory and apply some conditions and then output the list of songs that match the conditions.

Wiki

The full wiki contains the language spec, philosophy and technical architecture of the project.

Examples

Some example commands for querying songs would be like

select * from directory_of_songs_path where tempo = 120 and song has lyrics friday;

select midi from directory_of_songs_path where song has instrument piano;

# NumBarLines is a function for the number of bars the song is subdivided into
select musicxml from directory_of_songs_path where numbarlines < 40;

select midi from directory_of_songs_path where key = Eb and tempo > 150;

Development

Pre requisites

Install SBT

To clone the project

git clone https://github.com/Khalian/Modulo12

For setting up and running sbt targets

# Start modulo12 sql repl
sbt run

# Clean up dependency cache
sbt clean

# SBT Compile
sbt compile

# Run tests
sbt test

# Format files
sbt scalafmt

# SBT repl server (once you start this you can just write test instead of full sbt and it will run in repl)
sbt

# SBT debug server (Note the 5005 is the remote jvm debug port. You can use your ide to hook to it and then debug tests by running test)
sbt -jvm-debug 5005

IDE Setup

IntelliJ

Install the following plugins for IntelliJ

1. Scala
2. Antlr

You can then setup it up either as a VCS project from github or as a scala project after you clone it out.

VSCode

# This command launches VS Code for development
sbt launchIDE

Please also search the VSCode market place to install the ANTLR4 grammar syntax support plugin

Vim

Vim is not really an IDE but you can use it for editing, you should install metals along with scala vim syntax highlighting

Metals

Scala Vim Syntax