- Install Ruby
- Run:
sh -c "\$(curl -fsSL https://raw.githubusercontent.com/GabFitzgerald/terminal_app/master/run.sh.sh)ruby environment 2.7.0
colorize (> 0.8.1)> 1.2)
sounder (
test-unit (> 3.3)> 0.1.0)
tty (
tty-table (> 0.11.0)> 0.21.0)
tty-prompt (
- suitable ruby interpreter
- sound output e.g. speakers
https://github.com/GabFitzgerald/terminal_app
Ear training is an integral part of learning music, and being able to identify specific intervals accurately has many applications for musicians, such as playing songs by ear, freely being able to write down a tune they have in their head without using trial and error, and enhancing their understanding of music in general. The Terminal Ear Training application will help musicians, or anyone wanting to improve their musicianship by improving their sense of relative pitch. This is achieved by presenting the user with two recordings of notes played on the piano, and the user guesses the interval between them (e.g. major 3rd or perfect fifth).
The test also utilises effective repetitions so the user can focus on hearing specific intervals they get wrong. This is achieved by removing questions from the question bank once it is answered correctly, then the user is left to focus on questions they continue to get wrong. The test ends once all questions are answered correctly once. The user then has the option of creating custom tests using command line arguments, to further focus on specific intervals they may be struggling with.
At the end of each test, the program offers detailed feedback on the intervals the user was able to answer quickly and the intervals that took the highest number of tries and answer correctly.
The scope of this application is limited to referencing C4 as the first note for every question. It also only tests ascending intervals from C4 to C5. This means that only the notes in that range are stored as mp3 files in the source code. This is an opportunity for expanding the program later. Additionally, it only tests intervals with a one second delay. Opportunities for expansion would include ear testing notes played at the same time, recognising chord triads, and many more ear tests. It would also be an opportunity to base the ear tests closer to standard music examination boards such as AMEB, so that students can use this application while studying for their exams.
-
Interval Test
This feature presents the user with two notes, then the user inputs their guess. After selecting the difficulty, or customising the test using the command line input feature, the program will create a bank of questions (stored in an array), then randomly select a question and present it to the user. This is achieved by playing the present note of C, then playing the note corresponding to the interval above it. For example, if the program selects minor 2nd, it will play a C, followed by a C#. The user then gets the opportunity to input their response. They also have the option of repeating the interval. Once a response is entered, if it is wrong, the correct answer will be presented and a new random question is selected from the question bank. If the user was correct, the question is removed from the question bank. The quiz finishes once all questions have been answered right once and the question bank is empty. -
Detailed Test Feedback
After each ear test, the user will be given some feedback on the particular intervals they did well at, the intervals they need to improve and a final score is given. This feature is implemented by storing each random question in an array as the question is generated. The questions that they got right the first time appear once in the array, so that is how they are found. The questions they did worse at will appear the most number of times in the array. The final score percentage is calculated by dividing the length of the original question bank array by the total number of questions given. As questions are repeated when they are incorrect, this method gives an accurate score. This information is packaged together into a string and presented to the user once the test in complete. -
Custom Test
If the user wishes to test only specific intervals, the command line can be used to design a specific test. To do this, following the command to run, intervals that you want to be tested on can be added, space separated in semitones to the command line. The below code will test perfect 4th, perfect 5th, major 6th and octave.
ruby main.rb {space separated intervals (semitones)}
e.g. ruby main.rb 5 7 9 12When the application is run, the user will be presented the main menu screen. They can select 'How to Play', which will give them some information of how to play the game then loop them back to the main menu. They can select 'Play' which will begin the test or select 'Exit' which will end the program. These menu are selected with arrow keys, then pressing enter.
Once 'Play' is selected, unless a custom test was added, the user will select a difficulty. This decides the question bank. The questions are given as explained in Features. For each question, the user must input the exact shorthand answer from the 'How to Play' screen to get the question correct. For example, if they think it was a minor second, they must input 'm2', if they think it was a major 2nd, they must input 'M2'. The user also has the option of repeating the sound by inputing 'r', they can continue to input 'r' until any other text is input, which returns their instant feedback. If correct, they will be told they got the question right and the next question is presented. If they were not right, the correct answer is output to the screen and the next question is presented. This loops until there are no questions left and the quiz ends. The user's detailed feedback is the given, the program then loops back to the main menu, where they can play again, review the rules or exit the program.
Project management platform, Trello, link: https://trello.com/b/gZL9U85A/terminal-app-assignment