Source code for musif.musicxml.scoring

from typing import List, Optional, Tuple

from music21.stream.base import Part
from roman import fromRoman, toRoman

from musif.config import ExtractConfiguration

ROMAN_NUMERALS_FROM_1_TO_20 = [toRoman(i).upper() for i in range(1, 21)]



def to_abbreviation(part: Part, parts: List[Part], cfg: ExtractConfiguration) -> str:
    """
        Returns abbreviation name for a specific part based on the sound name
        
        Parameters
        ----------
        part:  str
            Part to get abbreviaton from
        parts: List[part]
            List of parts in the score
        cfg: ExtractConfiguration
            ExtractConfiguration object            
    """
    
    sound = extract_sound(part, cfg)
    return list(_extract_abbreviated_part(sound, part, parts, cfg))[0]




def extract_sound(part: Part, config: ExtractConfiguration) -> str:
    """
    Returns sound name for a specific part based on the sound name
    Part: VnI -> Sound name: Vn
    Parameters
    ----------
    part:  str
        Part to get abbreviaton from
    cfg: ExtractConfiguration
        ExtractConfiguration object            
    """
    
    instrument = part.getInstrument(returnDefault=False)
    sound_name = None
    if instrument is None or instrument.instrumentSound is None:
        sound_name = part.partName.strip().split(' ')[0]
        if sound_name not in config.sound_to_abbreviation:
            sound_name = _replace_naming_exceptions(sound_name, part)
            sound_name = sound_name if sound_name[-1] != 's' else sound_name[:-1]
    else:
        for instrument in instrument.instrumentSound.split(".")[::-1]:
            if (
                "flat" not in instrument
                and "sharp" not in instrument
                and len(instrument) > 2
            ):
                sound_name = instrument
                break
    if sound_name:
        sound_name = sound_name.replace('-', ' ').lower()
        sound_name = _replace_naming_exceptions(sound_name, part)
        return sound_name
    else:
        return ''


def _extract_abbreviated_part(sound: str, part: Part, parts: List[Part], config: ExtractConfiguration) -> Tuple[str, str, int]:
    if sound not in config.sound_to_abbreviation:
        abbreviation = part.partAbbreviation  # may contain I, II or whatever
        abbreviation_parts = abbreviation.split(" ")
        abbreviation = abbreviation_parts[0].lower().replace(".", "") + (
            abbreviation_parts[1] if len(abbreviation_parts) > 1 else ""
        )
    else:
        abbreviation = config.sound_to_abbreviation[sound]
    part_roman_number = _get_part_roman_number(
        part) or _get_part_roman_number_by_position(part, parts)
    other_number = _get_part_normal_number(part)
    part_number = fromRoman(part_roman_number) if part_roman_number else (other_number if other_number else 0)
    sound_abbreviation = abbreviation.split('(')[0]
    return abbreviation + (part_roman_number or ""), sound_abbreviation, part_number

def _get_part_normal_number(part: Part) -> Optional[str]:
    if '(' and ')' in part.partAbbreviation:
        return part.partAbbreviation.split('(')[1].split(')')[0]
    return None

def _get_part_roman_number(part: Part) -> Optional[str]:
    for number in ROMAN_NUMERALS_FROM_1_TO_20:
        if part.partAbbreviation.endswith(f". {number}") or part.partName.endswith(
            f" {number}"
        ):
            return number
    return None

def _get_part_roman_number_by_position(part: Part, parts: List[Part]) -> Optional[str]:
    same_sound_parts = [same_sound_part
                        for same_sound_part in parts
                        if part.getInstrument(returnDefault=False) == same_sound_part.getInstrument(returnDefault=False)]
    if len(same_sound_parts) > 1:
        for i, same_sound_part in enumerate(same_sound_parts, 1):
            if part.partName == same_sound_part.partName:
                return toRoman(i)
    return None


def _replace_naming_exceptions(sound: str, part: Part) -> str:
    if 'da caccia' in sound:
        sound = sound.replace('da caccia', '')
        if 'tromba' in sound:
            sound = 'horn'
    if 'bass' == sound:  # determines if voice or string instrument
        if len(part.lyrics()) == 0:
            sound = "basso continuo"
    if "french" in sound and "horn" in sound:
        sound = "horn"
    if "cello" in sound and "bass" in part.partName.lower():
        sound = "basso continuo"
    return sound