# -*- coding: UTF-8 -*-
"""
:filename: sppas.src.annotations.Syll.sppassyll.py
:author: Brigitte Bigi
:contact: develop@sppas.org
:summary: SPPAS integration of Syllabification automatic annotation
.. _This file is part of SPPAS: <http://www.sppas.org/>
..
-------------------------------------------------------------------------
___ __ __ __ ___
/ | \ | \ | \ / the automatic
\__ |__/ |__/ |___| \__ annotation and
\ | | | | \ analysis
___/ | | | | ___/ of speech
Copyright (C) 2011-2021 Brigitte Bigi
Laboratoire Parole et Langage, Aix-en-Provence, France
Use of this software is governed by the GNU Public License, version 3.
SPPAS is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
SPPAS is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with SPPAS. If not, see <http://www.gnu.org/licenses/>.
This banner notice must not be removed.
-------------------------------------------------------------------------
"""
import os
import logging
from sppas.src.config import symbols
from sppas.src.config import annots
from sppas.src.config import info
from sppas.src.config import sppasUnicode
from sppas.src.anndata import sppasTrsRW
from sppas.src.anndata import sppasTranscription
from sppas.src.anndata import sppasTier
from sppas.src.anndata import sppasInterval
from sppas.src.anndata import sppasLocation
from sppas.src.anndata import sppasTag
from sppas.src.anndata import sppasLabel
from ..baseannot import sppasBaseAnnotation
from ..searchtier import sppasFindTier
from ..annotationsexc import AnnotationOptionError
from ..annotationsexc import EmptyOutputError
from ..annotationsexc import NoTierInputError
from .syllabify import Syllabifier
# ----------------------------------------------------------------------------
[docs]class sppasSyll(sppasBaseAnnotation):
"""SPPAS integration of the automatic syllabification annotation.
"""
[docs] def __init__(self, log=None):
"""Create a new sppasSyll instance with only the general rules.
Log is used for a better communication of the annotation process and its
results. If None, logs are redirected to the default logging system.
:param log: (sppasLog) Human-readable logs.
"""
super(sppasSyll, self).__init__("syllabify.json", log)
self.__syllabifier = Syllabifier()
# -----------------------------------------------------------------------
[docs] def load_resources(self, config_filename, **kwargs):
"""Fix the syllabification rules from a configuration file.
:param config_filename: Name of the configuration file with the rules
"""
self.__syllabifier = Syllabifier(config_filename)
# -----------------------------------------------------------------------
# Methods to fix options
# -----------------------------------------------------------------------
[docs] def fix_options(self, options):
"""Fix all options.
Available options are:
- usesintervals
- usesphons
- tiername
- createclasses
- createstructures
:param options: (sppasOption)
"""
for opt in options:
key = opt.get_key()
if "usesintervals" == key:
self.set_usesintervals(opt.get_value())
elif "usesphons" == key:
self.set_usesphons(opt.get_value())
elif "tiername" == key:
self.set_tiername(opt.get_value())
elif "createclasses" == key:
self.set_create_tier_classes(opt.get_value())
elif "pattern" in key:
self._options[key] = opt.get_value()
else:
raise AnnotationOptionError(key)
# ------------------------------------------------------------------------
[docs] def set_usesintervals(self, mode):
"""Fix the usesintervals option.
:param mode: (bool) If mode is set to True, the syllabification
operates inside specific (given) intervals.
"""
self._options['usesintervals'] = mode
# ----------------------------------------------------------------------
[docs] def set_usesphons(self, mode):
"""Fix the usesphons option.
:param mode: (str) If mode is set to True, the syllabification operates
by using only tier with phonemes.
"""
self._options['usesphons'] = mode
# ----------------------------------------------------------------------
[docs] def set_create_tier_classes(self, create=True):
"""Fix the createclasses option.
:param create: (bool)
"""
self._options['createclasses'] = create
# ----------------------------------------------------------------------
[docs] def set_tiername(self, tier_name):
"""Fix the tiername option.
:param tier_name: (str)
"""
self._options['tiername'] = sppasUnicode(tier_name).to_strip()
# ----------------------------------------------------------------------
# Syllabification of time-aligned phonemes stored into a tier
# ----------------------------------------------------------------------
[docs] def convert(self, phonemes, intervals=None):
"""Syllabify labels of a time-aligned phones tier.
:param phonemes: (sppasTier) time-aligned phonemes tier
:param intervals: (sppasTier)
:returns: (sppasTier)
"""
if intervals is None:
intervals = sppasSyll._phon_to_intervals(phonemes)
syllables = sppasTier("SyllAlign")
syllables.set_meta('syllabification_of_tier', phonemes.get_name())
for interval in intervals:
# get the index of the phonemes containing the begin
# of the interval
start_phon_idx = phonemes.lindex(
interval.get_lowest_localization())
if start_phon_idx == -1:
start_phon_idx = phonemes.mindex(
interval.get_lowest_localization(),
bound=-1)
# get the index of the phonemes containing the end of the interval
end_phon_idx = phonemes.rindex(interval.get_highest_localization())
if end_phon_idx == -1:
end_phon_idx = phonemes.mindex(
interval.get_highest_localization(),
bound=1)
# syllabify within the interval
if start_phon_idx != -1 and end_phon_idx != -1:
self.syllabify_interval(phonemes,
start_phon_idx,
end_phon_idx,
syllables)
else:
self.logfile.print_message(
(info(1224, "annotations")).format(interval),
indent=2, status=annots.warning)
return syllables
# ----------------------------------------------------------------------
[docs] def make_classes(self, syllables):
"""Create the tier with syllable classes.
:param syllables: (sppasTier)
"""
classes = sppasTier("SyllClassAlign")
classes.set_meta('syllabification_classes_of_tier',
syllables.get_name())
for syll in syllables:
location = syll.get_location().copy()
syll_tag = syll.get_best_tag()
class_tag = sppasTag(
self.__syllabifier.classes_phonetized(
syll_tag.get_typed_content()))
classes.create_annotation(location, sppasLabel(class_tag))
return classes
# ----------------------------------------------------------------------
[docs] def syllabify_interval(self, phonemes, from_p, to_p, syllables):
"""Perform the syllabification of one interval.
:param phonemes: (sppasTier)
:param from_p: (int) index of the first phoneme to be syllabified
:param to_p: (int) index of the last phoneme to be syllabified
:param syllables: (sppasTier)
"""
# create the sequence of phonemes to syllabify
p = list()
for ann in phonemes[from_p:to_p+1]:
tag = ann.get_best_tag()
p.append(tag.get_typed_content())
# create the sequence of syllables
s = self.__syllabifier.annotate(p)
# add the syllables into the tier
for i, syll in enumerate(s):
start_idx, end_idx = syll
# create the location
begin = phonemes[start_idx+from_p].get_lowest_localization().copy()
end = phonemes[end_idx+from_p].get_highest_localization().copy()
location = sppasLocation(sppasInterval(begin, end))
# create the label
syll_string = Syllabifier.phonetize_syllables(p, [syll])
label = sppasLabel(sppasTag(syll_string))
# add the syllable
syllables.create_annotation(location, label)
# ----------------------------------------------------------------------
# Apply the annotation on one given file
# -----------------------------------------------------------------------
# -----------------------------------------------------------------------
[docs] def run(self, input_files, output=None):
"""Run the automatic annotation process on an input.
:param input_files: (list of str) Time-aligned phonemes
:param output: (str) the output file name
:returns: (sppasTranscription)
"""
# Get the tier to syllabify
tier_input, intervals = self.get_inputs(input_files)
# Create the transcription result
trs_output = sppasTranscription(self.name)
trs_output.set_meta('syllabification_result_of', input_files[0])
# Syllabify the tier
if self._options['usesphons'] is True:
tier_syll = self.convert(tier_input)
trs_output.append(tier_syll)
if self._options['createclasses']:
trs_output.append(self.make_classes(tier_syll))
# Extra tier: syllabify between given intervals
if self._options['usesintervals'] is True:
if intervals is None:
self.logfile.print_message(
(info(1264, "annotations")).format(tiername=self._options['tiername']),
indent=2,
status=annots.warning)
else:
tier_syll_int = self.convert(tier_input, intervals)
tier_syll_int.set_name("SyllAlign-Intervals")
tier_syll_int.set_meta('syllabification_used_intervals',
intervals.get_name())
trs_output.append(tier_syll_int)
if self._options['createclasses']:
t = self.make_classes(tier_syll_int)
t.set_name("SyllClassAlign-Intervals")
trs_output.append(t)
# Save in a file
if output is not None:
if len(trs_output) > 0:
output_file = self.fix_out_file_ext(output)
parser = sppasTrsRW(output_file)
parser.write(trs_output)
return [output_file]
else:
raise EmptyOutputError
return trs_output
# ----------------------------------------------------------------------
[docs] def get_output_pattern(self):
"""Pattern this annotation uses in an output filename."""
return self._options.get("outputpattern", "-syll")
# -----------------------------------------------------------------------
# Utilities:
# -----------------------------------------------------------------------
@staticmethod
def _phon_to_intervals(phonemes):
"""Create the intervals to be syllabified.
we could use symbols.phone only, but for backward compatibility
we hardly add the symbols we previously used into SPPAS.
"""
stop = list(symbols.phone.keys())
stop.append('#')
stop.append('@@')
stop.append('+')
stop.append('gb')
stop.append('lg')
return phonemes.export_to_intervals(stop)