Tony: a tool for melody transcription

h1. Reference

h2. Navigation

Several ways of navigating _Tony_ are available

* click and drag in the Main Pane to move the visible area

* click in the Selection Strip to move the playhead to the time you clicked on

* press left and right arrows to move the playhead forward and backward, respectively

* press Ctrl-left/Cntrl-right to move the playhead by one note (Ctrl is Command on Mac)

h2. Selection

Only time intervals can be selected. 

h3. Selecting an arbitrary time interval

* *click into Selection Strip and drag* selects the time interval you drag across.

* *Shift-click and drag in the Main Pane*, while used for pitch track correction, will also select the time interval you drag across.

h3. Selecting an interval coinciding with notes

* *double-click in Selection Strip* selects the time interval covered by the current note.

* *Shift-Ctrl-left and Shift-Ctrl-right* move the playhead by one note and select the time interval. (Ctrl is Command on Mac.)

h3. Select all

* *Ctrl-A* (Ctrl is Command on Mac.)

* *Edit Menu -> Select All*

h2. Correcting the pitch track

h3. Moving the pitch track by one octave

* select time interval in the Selection Strip, then press Ctrl-up or Ctrl-down. (Ctrl is Command on Mac.)

h3. Choosing alternative pitch track candidates

* select time interval in the Selection Strip, then press Ctrl-Enter to make alternative pitch tracks appear (in orange); Ctrl-up or Ctrl-down to choose; Ctrl-Enter to confirm choice. (Ctrl is Command on Mac.)

h1. Quick Starter Guide

Some guided tours to help you find your way around _Tony_.

h2. Guided Tour 1: First Steps

This mini-tutorial walks you through the complete process of using Tony to load an audio file, annotate the notes in it and export the notes to a .csv (comma-separated values) file.

# Start the _Tony_ program by double-clicking (or whatever you routinely do to open programs).

# Open an audio file of your choice. Mind that _Tony_ only deals with single melodies *without* accompaniment, so choose a little bit of accompanied solo singing or the like.

# Upon opening of the file, _Tony_ will automatically analyse the file using "pYin":/projects/pyin pitch and note extraction, and pitches and notes should appear. _If no pitch track and notes occur, please see Analysis Settings and Visualisation, below._

# Get comfortable moving around and playback... a few suggestions:

#* play audio by clicking on the play button in the top toolbar, or simply by pressing the space bar on your keyboard

#* use the Navigate tool to move around in the audio file: simply left-click and drag in the main pane

#* try navigating with the keyboard, too. The left and right cursor keys will move the play head

# Get comfortable with different visualisations and sonifications:

#* try switching (toggling) different visualisations on and off in the bottom toolbar: waveform, pitch track (the black line), note track (the blue boxes), spectrogram (the gray-scale background)

#* try switching on the pitch track sonification (sound representation) by toggling the loudspeaker symbol next to the pitch track symbol in the bottom toolbar -- you should be able to hear a funny sine-like tone at the same pitch as the original audio when sonification is on.

#* turn off pitch track sonification, and turn on note track sonification -- what's the difference?

#* you can switch the original audio on and off too (next to the waveform)

#* what effect does the pan wheel (the one with the green circle) have on sonification? -- you can choose where in the stereo image to sonify the sounds: left, right, or anywhere in between.

h2. Guided Tour 2: Splitting, Merging and Deleting Notes

When you load an audio file, Tony will provide you with a first note track. It's rare that the note track is perfect; here I talk you through but you can easily correct it and save it.

# Make sure you can see the note track in blue. If not, turn note visualisation on.

# Splitting a note using the Edit Tool. Choose a note and split it:

#* select the Edit Tool from the top toolbar (alternatively you can type "2" on your keyboard)

#* move the mouse over a note; in the middle bottom of the note the mouse pointer will turn into an upward arrow -- if it does that, left-click, and you'll have split a note!

#* note that the two resulting notes will have different frequencies (Tony automatically calculates the pitch from the underlying pitch track)

# Splitting a note at the play head without using the Edit Tool. Choose another note and split that too, but now in a different way:

#* put the play head where you want it by using the left/right arrows or a single left-click in the selection pane (just under the main pane)

#* then go to the Edit menu and click "Split Note". There's a keyboard shortcut for this as well: simply type "/" (a slash)

# Merging two or more notes into one. Choose two notes, and merge them into one:

## Select the region with the notes you want to delete by clicking and dragging in the selection pane (just under the main pane)

## On your keyboard, press the backslash key, or, in the Edit menu, choose Merge Notes

# Deleting a note. To delete a note using the Edit Tool, move the mouse to the bottom of the note (as if you wanted to split it), press the Shift key and click. That is: deleting is like splitting with the Shift key pressed.

# Deleting multiple notes. To delete multiple notes, do the following:

## Select the region with the notes you want to delete by clicking and dragging in the selection pane (just under the main pane)

## On your keyboard, press the Backspace key, or, in the Edit menu, choose Delete Notes.

h2. Guided Tour 3: Creating, Shortening and Extending Notes

# Extending or shortening a note. Choose a note at the end of a phrase and try to make it longer or shorter.

#* when in Edit Tool mode, you can grab a note end (onset or offset) and drag to shorten or to extend the note

# Create a Note. There are two ways of making a note

## in Edit Mode, double click into the main pane at a time position where there's no other note -- a note will be created

## in Edit or Navigate Mode, select a time region in the selection pane, then, on your keyboard, press "=". Alternatively, you can go to the Edit Menu and choose "Form Note From Selection"

# The same goes for the pitch track... try it!

h2. Guided Tour 4: Exporting and Saving

There are multiple ways to save your annotations. You can try all!

# First, you can save the whole _Tony_ "session", that is, a  document which saves the extracted pitches, notes and your changes (but not the audio!), so that if you want to resume work later, you can simply open that session file in _Tony_. Sessions files end in ".ton". You can save by using the File menu, then choosing "Save Session As...", and you will have to choose a name for the file you want to save. 

#* If you want to save a ".ton" file where your audio file is, then it's even easier: simply choose Save Session To Audio Path, and _Tony_ will save a session at the same place and name as the audio file, but with the file extension ".ton".

# Saving only the note track. Try saving the note track, by choosing the File menu, then Export Note Data... . This will save the note data as a text file with commas between the values, a so-called comma-separated values file with the extension ".csv".

#* save a file test.csv and open it in a text editor or in a spread sheet. You will see that the first column provides note onsets (in seconds), the second column the note frequencies (Hz), the third column the note durations (seconds), and the fourth column... is currently just a weird value. Sorry.

# Saving only the pitch track. Works pretty much in the same way as saving the note track.

#* The result is different, however: you have only three columns in your .csv file: timestamp (in seconds) and frequency (Hz)

h1. Menus

h2. File Menu

h2. Edit Menu

h2. View Menu

h2. Analysis Menu

The "Analysis" menu allows you to re-analyse the audio for pitches and notes and to choose some analysis settings.

* *Analyse Now!* will run "pYin":/projects/pyin to extract pitches and notes and replaces all currently annotated pitches and notes. While you can undo this, you might still want to consider carefully whether to use this option if you have put a lot of work into annotating notes or pitches.

* *Auto-Analyse New Audio*. _Tony_ will, by default, analyse any new audio that you load. If you do not want this behaviour, you can de-select it here.

* *Unbiased Timing (slow)*. By default the "pYin":/projects/pyin analysis is based on ordinary YIN, which has a funky asymmetric window and introduces a small timing bias of up to 5ms. If you need zero time bias, then tick this item. This will be much slower, since this option cannot use the Fast Fourier Transform.

* *Penalise Soft Pitches*: this option is on by default and reduces the impact of very low-amplitude content, effectively suppressing some spurious pitches. If you don't want this, untick.

h1. Toolbars

not covered (yet?)