def read_header(cls, score_file, symbtr_name=None):
"""
Reads the metadata in the header of the SymbTr-mu2 scores.
Parameters
----------
score_file : str
The path of the SymbTr score
symbtr_name : str, optional
The name of the score in SymbTr naming convention
(makam--form--usul--name--composer).
Returns
----------
dict
A dictionary storing the metadata extracted from the header
list of str
The names of the columns in the mu2 file
bool
True if the metadata in the mu2 header is valid/consistent,
False otherwise
"""
if symbtr_name is None:
symbtr_name = Mu2Reader.get_symbtr_name_from_filepath(score_file)
makam_slug = symbtr_name.split('--')[0]
with open(score_file, "rb") as f:
reader = csv.reader(f, delimiter='\t')
header_row = [unicode(cell, 'utf-8') for cell in next(reader,
None)]
header = dict()
is_tempo_unit_valid = True
is_key_sig_valid = True
for row_temp in reader:
row = [unicode(cell, 'utf-8') for cell in row_temp]
code = int(row[0])
if code == 50:
is_key_sig_valid = Mu2Reader.read_makam_key_signature_row(
header, is_key_sig_valid, makam_slug, row, symbtr_name)
elif code == 51:
header['usul'] = {'mu2_name': row[7],
'mertebe': int(row[3]),
'number_of_pulses': int(row[2])}
elif code == 52:
is_tempo_unit_valid = cls._read_tempo_row(
row, symbtr_name, header, is_tempo_unit_valid)
elif code == 56:
header['usul']['subdivision'] = {'mertebe': int(row[3]),
'number_of_pulses':
int(row[2])}
elif code == 57:
header['form'] = {'mu2_name': row[7]}
elif code == 58:
header['composer'] = {'mu2_name': row[7]}
elif code == 59:
header['lyricist'] = {'mu2_name': row[7]}
elif code == 60:
header['title'] = {'mu2_title': row[7]}
elif code == 62:
header['genre'] = 'folk' if row[7] == 'E' else 'classical'
elif code == 63:
header['notation'] = row[7]
elif code in range(50, 64):
warnings.warn(u'Unparsed code: {0!s}'.
format(' '.join(row)), stacklevel=2)
else: # end of header
break
# get the metadata
slugs = MetadataExtractor.get_slugs(symbtr_name)
for attr in ['makam', 'form', 'usul']:
MetadataExtractor.add_attribute_slug(header, slugs, attr)
header['title']['symbtr_slug'] = slugs['name']
header['composer']['symbtr_slug'] = slugs['composer']
# validate the header content
is_attr_meta_valid = MetadataExtractor.validate_makam_form_usul(
header, symbtr_name)
is_header_valid = (is_tempo_unit_valid and is_attr_meta_valid and
is_key_sig_valid)
return header, header_row, is_header_valid