src/birdears/questions/harmonicinterval.py
from .. import CHROMATIC_TYPE
from ..logger import log_event
from ..questionbase import QuestionBase
from ..questionbase import register_question_class
from ..interval import Interval
from ..sequence import Sequence
from ..resolution import Resolution
from ..prequestion import PreQuestion
from ..note_and_pitch import Chord
from ..note_and_pitch import get_pitch_by_number
from random import choice
@register_question_class
class HarmonicIntervalQuestion(QuestionBase):
"""Implements a Harmonic Interval test.
"""
name = 'harmonic'
def __init__(self, mode='major', tonic='C', octave=4, descending=False,
chromatic=False, n_octaves=1, valid_intervals=CHROMATIC_TYPE,
user_durations=None, prequestion_method='none',
resolution_method='nearest_tonic', *args, **kwargs):
"""Inits the class.
Args:
mode (str): A string representing the mode of the question.
Eg., 'major' or 'minor'
tonic (str): A string representing the tonic of the question,
eg.: 'C'; if omitted, it will be selected randomly.
octave (int): A scienfic octave notation, for example, 4 for 'C4';
if not present, it will be randomly chosen.
descending (bool): Is the question direction in descending, ie.,
intervals have lower pitch than the tonic.
chromatic (bool): If the question can have (True) or not (False)
chromatic intervals, ie., intervals not in the diatonic scale
of tonic/mode.
n_octaves (int): Maximum number of octaves of the question.
valid_intervals (list): A list with intervals (int) valid for
random choice, 1 is 1st, 2 is second etc. Eg. [1, 4, 5] to
allow only tonics, fourths and fifths.
user_durations (str): A string with 9 comma-separated `int` or
`float`s to set the default duration for the notes played. The
values are respectively for: pre-question duration (1st),
pre-question delay (2nd), and pre-question pos-delay (3rd);
question duration (4th), question delay (5th), and question
pos-delay (6th); resolution duration (7th), resolution
delay (8th), and resolution pos-delay (9th).
duration is the duration in of the note in seconds; delay is
the time to wait before playing the next note, and pos_delay is
the time to wait after all the notes of the respective sequence
have been played. If any of the user durations is `n`, the
default duration for the type of question will be used instead.
Example::
"2,0.5,1,2,n,0,2.5,n,1"
prequestion_method (str): Method of playing a cadence or the
exercise tonic before the question so to affirm the question
musical tonic key to the ear. Valid ones are registered in the
`birdears.prequestion.PREQUESION_METHODS` global dict.
resolution_method (str): Method of playing the resolution of an
exercise. Valid ones are registered in the
`birdears.resolution.RESOLUTION_METHODS` global dict.
"""
default_durations = {
'preq': {'duration': 3, 'delay': 0.5, 'pos_delay': 1},
'quest': {'duration': 3, 'delay': 0.5, 'pos_delay': 0},
'resol': {'duration': 2.5, 'delay': 0.5, 'pos_delay': 1}
}
super(HarmonicIntervalQuestion, self).\
__init__(mode=mode, tonic=tonic, octave=octave,
descending=descending, chromatic=chromatic,
n_octaves=n_octaves, valid_intervals=valid_intervals,
user_durations=user_durations,
prequestion_method=prequestion_method,
resolution_method=resolution_method,
default_durations=default_durations, *args, **kwargs)
self.is_harmonic = True
self.random_pitch = choice(self.allowed_pitches)
self.interval = Interval(self.tonic_pitch, self.random_pitch)
self.pre_question = self.make_pre_question(method=prequestion_method)
self.question = self.make_question()
self.resolution = self.make_resolution(method=resolution_method)
def make_pre_question(self, method):
prequestion = PreQuestion(method=method, question=self)
return prequestion()
def make_question(self):
harmonic_interval = Chord([self.tonic_pitch, self.random_pitch])
question = Sequence([harmonic_interval], **self.durations['quest'])
return question
def make_resolution(self, method):
resolve = Resolution(method=method, question=self)
resolution = resolve()
return resolution
def play_question(self, callback=None, end_callback=None,
*args, **kwargs):
# Other threads can call a thread’s join() method. This blocks the
# calling thread until the thread whose join() method is called is
# terminated.
# https://docs.python.org/3/library/threading.html#thread-objects
self.display.update({'main_display': 'Listen to the tonality.'})
self.pre_question.play(callback=callback, end_callback=end_callback,
*args, **kwargs)
self.question.play(callback=None, end_callback=end_callback,
*args, **kwargs)
self.display.update({'main_display': 'What is the interval?'})
def play_resolution(self, callback=None, end_callback=None,
*args, **kwargs):
thread = self.resolution.play(callback=callback,
end_callback=end_callback,
*args, **kwargs)
thread.join()
def check_question(self, user_input_char):
"""Checks whether the given answer is correct.
"""
user_semitones = self.keyboard_index.index(user_input_char[0])
user_semitones_plus_diretion = \
(user_semitones * -1) if self.is_descending else (user_semitones)
user_pitch = get_pitch_by_number(int(self.tonic_pitch) +
user_semitones_plus_diretion)
user_interval = Interval(self.tonic_pitch, user_pitch)['data'][2]
user_note = str(user_pitch)
correct_semitones = abs(int(self.interval['semitones']))
correct_pitch = self.random_pitch
correct_interval = Interval(self.tonic_pitch,
self.random_pitch)['data'][2]
correct_note = str(self.random_pitch)
is_correct = user_pitch == correct_pitch
signal = ('x', '✓')[is_correct] # u2713; False==0, True==1
extra_response_str = """\
“{ci}” ({to}─{cn})
user {si} “{ui}” ({to}─{un})
{st} semitones
""".format(ci=correct_interval,
to=str(self.tonic_pitch),
cn=correct_note,
si=signal,
ui=user_interval,
un=user_note,
st=correct_semitones)
response = {
'is_correct': is_correct,
'user_interval': user_interval,
'correct_interval': correct_interval,
'user_response_str': user_interval,
'correct_response_str': correct_interval,
'extra_response_str': extra_response_str,
}
return response