scripts/asr_eou/generate_noisy_eval_data.py

# Copyright (c) 2025, NVIDIA CORPORATION.  All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.


"""
This script is used to generate noisy evaluation data for ASR and end of utterance detection.

Example usage with a single manifest input:
python generate_noisy_eval_data.py \
    --config-path conf/ \
    --config-name data \
    output_dir=/path/to/output \
    data.manifest_filepath=/path/to/manifest.json \
    data.seed=42 \
    data.noise.manifest_path /path/to/noise_manifest.json


Example usage with multiple manifests matching a pattern:
python generate_noisy_eval_data.py \
    --config-path conf/ \
    --config-name data \
    output_dir=/path/to/output/dir \
    data.manifest_filepath=/path/to/manifest/dir/ \
    data.pattern="*.json" \
    data.seed=42 \
    data.noise.manifest_path /path/to/noise_manifest.json

"""

from copy import deepcopy
from pathlib import Path
from shutil import rmtree

import librosa
import lightning.pytorch as pl
import numpy as np
import soundfile as sf
import torch
import yaml
from lhotse.cut import MixedCut
from omegaconf import DictConfig, ListConfig, OmegaConf, open_dict
from tqdm import tqdm

from nemo.collections.asr.data.audio_to_eou_label_lhotse import LhotseSpeechToTextBpeEOUDataset
from nemo.collections.asr.parts.utils.manifest_utils import read_manifest, write_manifest
from nemo.collections.common.data.lhotse import get_lhotse_dataloader_from_config
from nemo.collections.common.parts.preprocessing import parsers
from nemo.core.config import hydra_runner
from nemo.utils import logging


@hydra_runner(config_path="conf/", config_name="data")
def main(cfg: DictConfig):
    """
    Generate noisy evaluation data for ASR and end of utterance detection.

    Args:
        cfg: DictConfig object containing the configuration.
    """
    # Seed everything for reproducibility
    seed = cfg.data.get('seed', None)
    if seed is None:
        seed = np.random.randint(0, 2**32 - 1)
        logging.info(f'No seed provided, using random seed: {seed}')
    logging.info(f'Setting random seed to {seed}')
    with open_dict(cfg):
        cfg.data.seed = seed
    logging.info(f'Hydra config: {OmegaConf.to_yaml(cfg)}')
    pl.seed_everything(seed)
    torch.manual_seed(seed)
    torch.cuda.manual_seed(seed)
    torch.cuda.manual_seed_all(seed)
    np.random.seed(seed)
    torch.backends.cudnn.deterministic = True
    torch.backends.cudnn.benchmark = False

    # Patch data config
    with open_dict(cfg.data):
        cfg.data.force_finite = True
        cfg.data.force_map_dataset = True
        cfg.data.shuffle = False
        cfg.data.check_tokenizer = False  # No need to check tokenizer in LhotseSpeechToTextBpeEOUDataset

    # Make output directory
    output_dir = Path(cfg.output_dir)
    if output_dir.exists() and cfg.get('overwrite', False):
        logging.info(f'Removing existing output directory: {output_dir}')
        rmtree(output_dir)
    if not output_dir.exists():
        logging.info(f'Creating output directory: {output_dir}')
        output_dir.mkdir(parents=True, exist_ok=True)

    # Dump the config to the output directory
    config = OmegaConf.to_container(cfg, resolve=True)
    with open(output_dir / 'config.yaml', 'w') as f:
        yaml.dump(config, f)
    logging.info(f'Config dumped to {output_dir / "config.yaml"}')

    if isinstance(cfg.data.manifest_filepath, (list, ListConfig)):
        manifest_list = [Path(x) for x in cfg.data.manifest_filepath]
    else:
        input_manifest_file = Path(cfg.data.manifest_filepath)
        if input_manifest_file.is_dir():
            pattern = cfg.data.get('pattern', '*.json')
            manifest_list = list(input_manifest_file.glob(pattern))
            if not manifest_list:
                raise ValueError(f"No files found in {input_manifest_file} matching pattern `{pattern}`")
        else:
            manifest_list = [Path(x) for x in str(input_manifest_file).split(",")]

    logging.info(f'Found {len(manifest_list)} manifest files to process...')

    for i, manifest_file in enumerate(manifest_list):
        logging.info(f'[{i+1}/{len(manifest_list)}] Processing {manifest_file}...')
        data_cfg = deepcopy(cfg.data)
        data_cfg.manifest_filepath = str(manifest_file)
        process_manifest(data_cfg, output_dir)


def process_manifest(data_cfg: DictConfig, output_dir: Path):
    """
    Process a manifest file and generate noisy evaluation data.

    Args:
        data_cfg: Configuration.
        output_dir: Output directory.
    """
    # Load the input manifest
    input_manifest = read_manifest(data_cfg.manifest_filepath)
    logging.info(f'Found {len(input_manifest)} items in input manifest: {data_cfg.manifest_filepath}')
    manifest_parent_dir = Path(data_cfg.manifest_filepath).parent
    if Path(input_manifest[0]["audio_filepath"]).is_absolute():
        output_audio_dir = output_dir / 'wav'
        flatten_audio_path = True
    else:
        output_audio_dir = output_dir
        flatten_audio_path = False

    if "random_padding" in data_cfg and data_cfg.random_padding.pad_distribution == "constant":
        is_constant_padding = True
        pre_pad_dur = data_cfg.random_padding.pre_pad_duration
    else:
        is_constant_padding = False
        pre_pad_dur = None

    # Load the dataset
    tokenizer = parsers.make_parser()  # dummy tokenizer
    dataset = LhotseSpeechToTextBpeEOUDataset(cfg=data_cfg, tokenizer=tokenizer, return_cuts=True)

    dataloader = get_lhotse_dataloader_from_config(
        config=data_cfg,
        global_rank=0,
        world_size=1,
        dataset=dataset,
        tokenizer=tokenizer,
    )

    # Generate noisy evaluation data
    manifest = []
    for i, batch in enumerate(tqdm(dataloader, desc="Generating noisy evaluation data")):
        audio_batch, audio_len_batch, cuts_batch = batch
        audio_batch = audio_batch.cpu().numpy()
        audio_len_batch = audio_len_batch.cpu().numpy()

        for j in range(len(cuts_batch)):
            cut = cuts_batch[j]
            if isinstance(cut, MixedCut):
                cut = cut.first_non_padding_cut

            manifest_item = {}
            for k, v in cut.custom.items():
                if k == "dataloading_info":
                    continue
                manifest_item[k] = v
            audio = audio_batch[j][: audio_len_batch[j]]
            audio_file = cut.recording.sources[0].source

            if flatten_audio_path:
                output_audio_file = output_audio_dir / str(audio_file).replace('/', '_')[:255]  # type: Path
            else:
                output_audio_file = output_audio_dir / Path(audio_file).relative_to(manifest_parent_dir)  # type: Path

            output_audio_file.parent.mkdir(parents=True, exist_ok=True)
            sf.write(output_audio_file, audio, dataset.sample_rate)

            manifest_item["audio_filepath"] = str(output_audio_file.relative_to(output_audio_dir))
            manifest_item["offset"] = 0
            manifest_item["duration"] = audio.shape[0] / dataset.sample_rate

            if is_constant_padding:
                # Adjust the sou_time and eou_time for constant padding
                if 'sou_time' in manifest_item and 'eou_time' in manifest_item:
                    if not isinstance(manifest_item['sou_time'], list):
                        manifest_item['sou_time'] = manifest_item['sou_time'] + pre_pad_dur
                        manifest_item['eou_time'] = manifest_item['eou_time'] + pre_pad_dur
                    else:
                        manifest_item['sou_time'] = [x + pre_pad_dur for x in manifest_item['sou_time']]
                        manifest_item['eou_time'] = [x + pre_pad_dur for x in manifest_item['eou_time']]
                else:
                    # add sou_time and eou_time to the manifest item
                    manifest_item['sou_time'] = pre_pad_dur
                    manifest_item['eou_time'] = pre_pad_dur + librosa.get_duration(filename=audio_file)

            manifest.append(manifest_item)

    # Write the output manifest
    output_manifest_file = output_dir / Path(data_cfg.manifest_filepath).name
    write_manifest(output_manifest_file, manifest)
    logging.info(f'Output manifest written to {output_manifest_file}')


if __name__ == "__main__":
    main()