chord-composer-interface

CLI for Chord Composer (Tool for structuring chord progressions and patterns).

The philosophy behind Chord Composer is to make a lightweight, portable, and accessible tool to structure chord patterns and progressions for music composition ideas. It must fit into common digital music writing workflows and not hinder the creative process of the user.

This is a interface for the Chord Composer.

Features

Describe compositions with patterns in YAML.
Export composition patterns to MIDI clips.
Playback composition patterns with a piano in the command line.
Command line interface.
Cross-platform.
Languages:
- English
- Português (Translation by Marco)
- 简体中文 (Translation by Ariel)

Future Work

Build a terminal user interface.
Support more languages (including pirate).

Command line arguments

Chord Composer 0.1.2
Cj <unsignedbytebite@gmail.com>
A music composition tool for structuring chord progressions and patterns.

USAGE:
    chord-composer-interface [SUBCOMMAND]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

SUBCOMMANDS:
    chords      Print the list of supported chords and their intervals.
    export      Export composition patterns to .MID.
    help        Prints this message or the help of the given subcommand(s)
    play        Playback patterns in a composition.
    template    Export a composition arrangement YAML template

Playback patterns in a composition.

USAGE:
    chord-composer-interface play [FLAGS] [OPTIONS] <COMPOSITION_FILE>

FLAGS:
    -h, --help               Prints help information
        --metronome          Play a metronome during playback.
        --ticker-bar         Prints the current time on each bar change.
        --ticker-beat        Prints the current time on each beat change.
        --ticker-interval    Prints the current time on each beat interval change.
    -V, --version            Prints version information

OPTIONS:
        --pattern <pattern>        Play a pattern
        --start-bar <start-bar>    The bar to start playback from

ARGS:
    <COMPOSITION_FILE>    The YAML composition arrangement file.

Export composition patterns to .MID.

USAGE:
    chord-composer-interface export <COMPOSITION_FILE>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

ARGS:
    <COMPOSITION_FILE>    The YAML composition arrangement file.

Build steps

Install Rust.

Clone this repo with Git. e.g

git clone https://github.com/unsignedbytebite/chord-composer.git

Run cargo test in the repo's directory to ensure it's working. e.g
```
cargo test
```
Open ./examples/ and run/look at the example scripts to see how to use Chord Composer e.g
```
cd ./examples/
./play_composition.sh
```

Build Features

eng - Build with English strings.
pt - Build with Portugeuse strings.
zhn - Build with Chinese(Simplified) strings.

Composition Parameters `YAML` file

The schema for the composition parameters YAML file are outlined below in this template.

# Name of the composition
name: default_composition

# The default master parameters of the composition. 
# New master pattern can be assigned to a pattern that overrides
# the default master values.
master:
    # The musical key to transpose the chords. 
    # Supported values: C, C#, D, D#, E, F, F#, G, G#, A, A#, B
    key: F# 

    # The beats per minute of the composition.
    time: 120

    # The time signature of the composition.
    # Beat numerator supported values: must be > 0.
    # Beat denominator supported values: 2, 4, 8, 16, 32, 64 
    # e.g 3/8 is supported, 0/7 is not supported.
    signature: [4, 4]

# Composition defined chords.
chords:
    # [chord_name, [chord intervals]].
    - [custom1, [0, 3, 8]]
    - [custom2, [0, 5]]

# The composition's chord patterns/progressions.
patterns:
    - name: part_a
      # Each pattern event = [bar, beat, beat interval, chord name, chord transpose].
      pattern:
          - [1, 1, 1, MAJOR_SEVENTH, 0]
          - [1, 3, 1, custom1, 0]
          - [2, 1, 1, MAJOR_NINTH, 0]
          - [2, 3, 1, custom1, 0]
          - [3, 1, 1, MAJOR_SEVENTH, 3]
          - [3, 2, 1, custom1, 0]
          - [4, 1, 1, MAJOR_NINTH, -3]
          - [4, 2, 1, ?, 0] # ? = Select a random user defined chord.

    - name: part_b
      master:
          signature: [4, 8]
          key: C#
          time: 69
      # Each pattern event = [bar, beat, beat interval, chord name, chord transpose].
      pattern:
          - [1, 1, 1, MAJOR_SEVENTH, 0]
          - [1, 2, 1, custom1, 0]
          - [2, 1, 1, MAJOR_NINTH, 0]
          - [2, 2, 1, custom1, 0]
          - [3, 1, 1, MAJOR_SEVENTH, 3]
          - [3, 2, 1, custom1, 0]
          - [4, 1, 1, MAJOR_NINTH, -3]
          - [4, 2, 1, ??, 0] #?? = Select a random chord from user defined and internal defined chord.

unsignedbytebite/chord-composer-interface