Skip to content

Commit

Permalink
Merge pull request #13 from rogersachan/master
Browse files Browse the repository at this point in the history
Format and fix README
  • Loading branch information
corbanbrook committed Oct 6, 2018
2 parents 2720171 + aaa6b46 commit 2e872b5
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 40 deletions.
File renamed without changes.
66 changes: 26 additions & 40 deletions README → README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@

Spectrotune
# Spectrotune

Spectrotune is a Processing application ( http://www.processing.org ) which scans a
Spectrotune is a [Processing](https://www.processing.org) application which scans a
polyphonic audio source (in wav, mp3, etc formats), performs pitch detection and
outputs to MIDI.

Expand All @@ -28,10 +27,10 @@ Spectrotune offers adjustable options to help improve pitch detection, including
* MIDI octave channel segmenting - route each octave to its own MIDI channel.


Install and Basic Usage (Max OS X Standalone Application):
## Install and Basic Usage (macOS Standalone Application):

Spectrotune is now available in a standalone application for Mac OSX which you can download
at http://github.com/corbanbrook/spectrotune/downloads
Spectrotune is now available in a standalone application for macOS which you can download
from [Downloads/Releases](https://github.com/corbanbrook/spectrotune/downloads)

* Open DMG file.

Expand All @@ -44,27 +43,29 @@ Install and Basic Usage (Max OS X Standalone Application):

* Record with MIDI sequencer.

Currently only exported as an application for Max OS X as I dont have any other platforms to
Currently only exported as an application for macOS as I dont have any other platforms to
test on. If you want a standalone application for Windows or Linux please send me a request or
install processing and export the application yourself.

If you wish to play with the source code you can follow the instructions below to install
processing and the required libraries.


Processing Install (all platforms):
## Processing Install (all platforms):

* Install processing ( http://www.processing.org )
* Install [processing](https://www.processing.org)

* Install rwmidi ( http://ruinwesen.com/support-files/rwmidi-0.1c.zip )
* Install [rwmidi](https://web.archive.org/web/20110606063738/http://ruinwesen.com/support-files/rwmidi-0.1c.zip)

* Install ControlP5 ( http://www.sojamo.de/libraries/controlP5/ )
* Install [ControlP5](http://www.sojamo.de/libraries/controlP5/)

* Clone Spectrotune and place inside your Processing Sketchbook directory

```
cd ~/Documents/Processing (this is where I keep mine)
git clone git://github.com/corbanbrook/spectrotune.git

git clone https://github.com/corbanbrook/spectrotune.git
```

* Make sure your operating systems MIDI interface is configured properly.

* Put audio files (wav, mp3, etc) you wish to open in the 'music' folder within the route of the sketch.
Expand All @@ -79,30 +80,15 @@ Processing Install (all platforms):
the input and pass on to any soft synth, or hardware synth.


Keyboard Commands:

0-7 Octave filter: toggle octaves 0 to 7 On/Off

p Pitch Class Profile (PCP) toggle On/Off

e Linear EQ toggle On/Off

h Harmonic Filter toggle On/Off

m Mute audio toggle On/Off

n MIDI output toggle On/Off

SPACE Pause/Play toggle

RIGHT Peak Threshold Increase/decrease
/LEFT

ESC Quit


@corban weare.buildingsky.net
________________________________________________________________________________

Copyright (c) 2009 Corban Brook, released under the MIT license

## Keyboard Commands:
| Command | Result |
|-------|---------------------------------------------|
| 0-7 | Octave filter: toggle octaves 0 to 7 On/Off |
| p | Pitch Class Profile (PCP) toggle On/Off |
| e | Linear EQ toggle On/Off |
| h | Harmonic Filter toggle On/Off |
| m | Mute audio toggle On/Off |
| n | MIDI output toggle On/Off |
| SPACE | Pause/Play toggle |
| RIGHT/LEFT | Peak Threshold Increase/decrease |
| ESC | Quit |

0 comments on commit 2e872b5

Please sign in to comment.