#!/usr/bin/env python3 # Copyright 2021 Wen-Chin Huang and Tomoki Hayashi # Copyright 2022 Shuai Guo # Apache 2.0 (http://www.apache.org/licenses/LICENSE-2.0) """Evaluate log-F0 RMSE between generated and groundtruth audios based on World.""" import argparse import fnmatch import logging import multiprocessing as mp import os from math import log2, pow from typing import Dict, List import librosa import numpy as np import pysptk import pyworld as pw import soundfile as sf from fastdtw import fastdtw from scipy import spatial def _Hz2Semitone(freq): """_Hz2Semitone.""" A4 = 440 C0 = A4 * pow(2, -4.75) name = ["C", "C#", "D", "D#", "E", "F", "F#", "G", "G#", "A", "A#", "B"] if freq == 0: return "Sil" # silence else: h = round(12 * log2(freq / C0)) octave = h // 12 n = h % 12 return name[n] + "_" + str(octave) def _Hz2Flag(freq): if freq == 0: return False else: return True def find_files( root_dir: str, query: List[str] = ["*.flac", "*.wav"], include_root_dir: bool = True ): """Find files recursively. Args: root_dir (str): Root root_dir to find. query (List[str]): Query to find. include_root_dir (bool): If False, root_dir name is not included. Returns: List[str]: List of found filenames. """ files = [] for root, dirnames, filenames in os.walk(root_dir, followlinks=True): for q in query: for filename in fnmatch.filter(filenames, q): files.append(os.path.join(root, filename)) if not include_root_dir: files = [file_.replace(root_dir + "/", "") for file_ in files] return files def world_extract( x: np.ndarray, fs: int, f0min: int = 40, f0max: int = 800, n_fft: int = 512, n_shift: int = 256, mcep_dim: int = 25, mcep_alpha: float = 0.41, ): """Extract World-based acoustic features. Args: x (ndarray): 1D waveform array. fs (int): Minimum f0 value (default=40). f0 (int): Maximum f0 value (default=800). n_shift (int): Shift length in point (default=256). n_fft (int): FFT length in point (default=512). n_shift (int): Shift length in point (default=256). mcep_dim (int): Dimension of mel-cepstrum (default=25). mcep_alpha (float): All pass filter coefficient (default=0.41). Returns: ndarray: Mel-cepstrum with the size (N, n_fft). ndarray: F0 sequence (N,). """ # extract features x = x.astype(np.float64) f0, time_axis = pw.harvest( x, fs, f0_floor=f0min, f0_ceil=f0max, frame_period=n_shift / fs * 1000, ) sp = pw.cheaptrick(x, f0, time_axis, fs, fft_size=n_fft) if mcep_dim is None or mcep_alpha is None: mcep_dim, mcep_alpha = _get_best_mcep_params(fs) mcep = pysptk.sp2mc(sp, mcep_dim, mcep_alpha) return mcep, f0 def _get_basename(path: str): return os.path.splitext(os.path.split(path)[-1])[0] def _get_best_mcep_params(fs: int): # -> Tuple[int, float] if fs == 16000: return 23, 0.42 elif fs == 22050: return 34, 0.45 elif fs == 24000: return 34, 0.46 elif fs == 44100: return 39, 0.53 elif fs == 48000: return 39, 0.55 else: raise ValueError(f"Not found the setting for {fs}.") def calculate( file_list: List[str], gt_file_list: List[str], args: argparse.Namespace, f0_rmse_dict: Dict[str, float], semitone_acc_dict: Dict[str, float], vuv_err_dict: Dict[str, float], ): """Calculate log-F0 RMSE.""" for i, gen_path in enumerate(file_list): corresponding_list = list( filter(lambda gt_path: _get_basename(gt_path) in gen_path, gt_file_list) ) assert len(corresponding_list) == 1 gt_path = corresponding_list[0] gt_basename = _get_basename(gt_path) # load wav file as int16 gen_x, gen_fs = sf.read(gen_path, dtype="int16") gt_x, gt_fs = sf.read(gt_path, dtype="int16") fs = gen_fs if gen_fs != gt_fs: gt_x = librosa.resample(gt_x.astype(np.float), gt_fs, gen_fs) # extract ground truth and converted features gen_mcep, gen_f0 = world_extract( x=gen_x, fs=fs, f0min=args.f0min, f0max=args.f0max, n_fft=args.n_fft, n_shift=args.n_shift, mcep_dim=args.mcep_dim, mcep_alpha=args.mcep_alpha, ) gt_mcep, gt_f0 = world_extract( x=gt_x, fs=fs, f0min=args.f0min, f0max=args.f0max, n_fft=args.n_fft, n_shift=args.n_shift, mcep_dim=args.mcep_dim, mcep_alpha=args.mcep_alpha, ) # DTW _, path = fastdtw(gen_mcep, gt_mcep, dist=spatial.distance.euclidean) twf = np.array(path).T gen_f0_dtw = gen_f0[twf[0]] gt_f0_dtw = gt_f0[twf[1]] # Semitone ACC semitone_GT = np.array([_Hz2Semitone(_f0) for _f0 in gt_f0_dtw]) semitone_predict = np.array([_Hz2Semitone(_f0) for _f0 in gen_f0_dtw]) semitone_ACC = float((semitone_GT == semitone_predict).sum()) / len(semitone_GT) semitone_acc_dict[gt_basename] = semitone_ACC # VUV ERR vuv_GT = np.array([_Hz2Flag(_f0) for _f0 in gt_f0_dtw]) vuv_predict = np.array([_Hz2Flag(_f0) for _f0 in gen_f0_dtw]) vuv_ERR = float((vuv_GT != vuv_predict).sum()) / len(vuv_GT) vuv_err_dict[gt_basename] = vuv_ERR # Get voiced part nonzero_idxs = np.where((gen_f0_dtw != 0) & (gt_f0_dtw != 0))[0] gen_f0_dtw_voiced = np.log(gen_f0_dtw[nonzero_idxs]) gt_f0_dtw_voiced = np.log(gt_f0_dtw[nonzero_idxs]) # log F0 RMSE log_f0_rmse = np.sqrt(np.mean((gen_f0_dtw_voiced - gt_f0_dtw_voiced) ** 2)) f0_rmse_dict[gt_basename] = log_f0_rmse def get_parser() -> argparse.Namespace: """Get argument parser.""" parser = argparse.ArgumentParser(description="Evaluate Mel-cepstrum distortion.") parser.add_argument( "--gen_wavdir_or_wavscp", type=str, help="Path of directory or wav.scp for generated waveforms.", ) parser.add_argument( "--gt_wavdir_or_wavscp", type=str, help="Path of directory or wav.scp for ground truth waveforms.", ) parser.add_argument( "--outdir", type=str, help="Path of directory to write the results.", ) # analysis related parser.add_argument( "--mcep_dim", default=None, type=int, help=( "Dimension of mel cepstrum coefficients. " "If None, automatically set to the best dimension for the sampling." ), ) parser.add_argument( "--mcep_alpha", default=None, type=float, help=( "All pass constant for mel-cepstrum analysis. " "If None, automatically set to the best dimension for the sampling." ), ) parser.add_argument( "--n_fft", default=1024, type=int, help="The number of FFT points.", ) parser.add_argument( "--n_shift", default=256, type=int, help="The number of shift points.", ) parser.add_argument( "--f0min", default=40, type=int, help="Minimum f0 value.", ) parser.add_argument( "--f0max", default=800, type=int, help="Maximum f0 value.", ) parser.add_argument( "--nj", default=16, type=int, help="Number of parallel jobs.", ) parser.add_argument( "--verbose", default=1, type=int, help="Verbosity level. Higher is more logging.", ) return parser def main(): """Run log-F0 RMSE calculation in parallel.""" args = get_parser().parse_args() # logging info if args.verbose > 1: logging.basicConfig( level=logging.DEBUG, format="%(asctime)s (%(module)s:%(lineno)d) %(levelname)s: %(message)s", ) elif args.verbose > 0: logging.basicConfig( level=logging.INFO, format="%(asctime)s (%(module)s:%(lineno)d) %(levelname)s: %(message)s", ) else: logging.basicConfig( level=logging.WARN, format="%(asctime)s (%(module)s:%(lineno)d) %(levelname)s: %(message)s", ) logging.warning("Skip DEBUG/INFO messages") # find files if os.path.isdir(args.gen_wavdir_or_wavscp): gen_files = sorted(find_files(args.gen_wavdir_or_wavscp)) else: with open(args.gen_wavdir_or_wavscp) as f: gen_files = [line.strip().split(None, 1)[1] for line in f.readlines()] if gen_files[0].endswith("|"): raise ValueError("Not supported wav.scp format.") if os.path.isdir(args.gt_wavdir_or_wavscp): gt_files = sorted(find_files(args.gt_wavdir_or_wavscp)) else: with open(args.gt_wavdir_or_wavscp) as f: gt_files = [line.strip().split(None, 1)[1] for line in f.readlines()] if gt_files[0].endswith("|"): raise ValueError("Not supported wav.scp format.") # Get and divide list if len(gen_files) == 0: raise FileNotFoundError("Not found any generated audio files.") if len(gen_files) > len(gt_files): raise ValueError( "#groundtruth files are less than #generated files " f"(#gen={len(gen_files)} vs. #gt={len(gt_files)}). " "Please check the groundtruth directory." ) logging.info("The number of utterances = %d" % len(gen_files)) file_lists = np.array_split(gen_files, args.nj) file_lists = [f_list.tolist() for f_list in file_lists] # multi processing with mp.Manager() as manager: log_f0_rmse_dict = manager.dict() semitone_acc_dict = manager.dict() vuv_err_dict = manager.dict() processes = [] for f in file_lists: p = mp.Process( target=calculate, args=( f, gt_files, args, log_f0_rmse_dict, semitone_acc_dict, vuv_err_dict, ), ) p.start() processes.append(p) # wait for all process for p in processes: p.join() # convert to standard list log_f0_rmse_dict = dict(log_f0_rmse_dict) semitone_acc_dict = dict(semitone_acc_dict) vuv_err_dict = dict(vuv_err_dict) # calculate statistics mean_log_f0_rmse = np.mean(np.array([v for v in log_f0_rmse_dict.values()])) std_log_f0_rmse = np.std(np.array([v for v in log_f0_rmse_dict.values()])) logging.info( f"Average - log_F0-RMSE: {mean_log_f0_rmse:.4f} ± {std_log_f0_rmse:.4f}" ) mean_semitone_acc = np.mean(np.array([v for v in semitone_acc_dict.values()])) logging.info(f"Average - Semitone_ACC: {mean_semitone_acc*100:.2f}%") mean_vuv_err = np.mean(np.array([v for v in vuv_err_dict.values()])) logging.info(f"Average - VUV_ERROR: {mean_vuv_err*100:.2f}%") # write results if args.outdir is None: if os.path.isdir(args.gen_wavdir_or_wavscp): args.outdir = args.gen_wavdir_or_wavscp else: args.outdir = os.path.dirname(args.gen_wavdir_or_wavscp) os.makedirs(args.outdir, exist_ok=True) with open(f"{args.outdir}/utt2log_f0", "w") as f: for utt_id in sorted(log_f0_rmse_dict.keys()): log_f0_rmse = log_f0_rmse_dict[utt_id] semitone_ACC = semitone_acc_dict[utt_id] vuv_ERR = vuv_err_dict[utt_id] f.write( f"{utt_id} log_f0_rmse: {log_f0_rmse:.4f}, Semitone_ACC:" f" {semitone_ACC*100:.2f}%, VUV_ERROR: {vuv_ERR*100:.2f}\n" ) with open(f"{args.outdir}/avg_result.txt", "w") as f: f.write(f"#utterances: {len(gen_files)}\n") f.write( f"Average - log_F0-RMSE: {mean_log_f0_rmse:.4f} ± {std_log_f0_rmse:.4f}\n" ) f.write(f"Average - Semitone_ACC: {mean_semitone_acc*100:.2f}%\n") f.write(f"Average - VUV_ERROR: {mean_vuv_err*100:.2f}%\n") logging.info("Successfully finished F0 related evaluation.") if __name__ == "__main__": main()