#!/usr/bin/env python3
# Copyright    2022  Xiaomi Corp.        (authors: Fangjun Kuang)
#              2023  Brno University of Technology  (authors: Karel Veselý)
#
# See ../../../../LICENSE for clarification regarding multiple authors
#
# 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 checks the following assumptions of the generated manifest:

- Single supervision per cut
- Supervision time bounds are within Cut time bounds
- Duration of Cut and Superivion are equal

We will add more checks later if needed.

Usage example:

    python3 ./local/validate_manifest.py \
            ./data/fbank/librispeech_cuts_train-clean-100.jsonl.gz

(Based on: `librispeech/ASR/local/validate_manifest.py`)
"""

import argparse
import logging
from pathlib import Path

from lhotse import CutSet, load_manifest_lazy
from lhotse.cut import Cut
from lhotse.dataset.speech_recognition import validate_for_asr


def get_args():
    parser = argparse.ArgumentParser()

    parser.add_argument(
        "cutset_manifest",
        type=Path,
        help="Path to the manifest file",
    )

    return parser.parse_args()


def validate_one_supervision_per_cut(c: Cut):
    if len(c.supervisions) != 1:
        raise ValueError(f"{c.id} has {len(c.supervisions)} supervisions")


def validate_supervision_and_cut_time_bounds(c: Cut):
    tol = 2e-3  # same tolerance as in 'validate_for_asr()'
    s = c.supervisions[0]

    # Supervision start time is relative to Cut ...
    # https://lhotse.readthedocs.io/en/v0.10_e/cuts.html
    if s.start < -tol:
        raise ValueError(
            f"{c.id}: Supervision start time {s.start} must not be negative."
        )
    if s.start > tol:
        raise ValueError(
            f"{c.id}: Supervision start time {s.start} "
            "is not at the beginning of the Cut. "
            "Please apply `lhotse cut trim-to-supervisions`."
        )
    if c.start + s.end > c.end + tol:
        raise ValueError(
            f"{c.id}: Supervision end time {c.start+s.end} is larger "
            f"than cut end time {c.end}"
        )

    if s.duration != c.duration:
        raise ValueError(
            f"{c.id}: Cut duration {c.duration} and supervision duration "
            f"{s.duration} must be the same.\n"
            f"The difference causes problems in the training code : "
            f"+/- 1 frame in `x`, `x_lens` in `Zipformer::forward()`.\n"
            f"Did you forget to apply `trim_to_supervisions()` ?"
        )


def main():
    args = get_args()

    manifest = args.cutset_manifest
    logging.info(f"Validating {manifest}")

    assert manifest.is_file(), f"{manifest} does not exist"
    cut_set = load_manifest_lazy(manifest)
    assert isinstance(cut_set, CutSet)

    try:
        for c in cut_set:
            validate_one_supervision_per_cut(c)
            validate_supervision_and_cut_time_bounds(c)

        # Validation from K2 training
        # - checks supervision start is 0
        # - checks supervision.duration is not longer than cut.duration
        # - there is tolerance 2ms
        validate_for_asr(cut_set)
    except BaseException as e:
        logging.error(str(e))
        raise


if __name__ == "__main__":
    formatter = "%(asctime)s %(levelname)s [%(filename)s:%(lineno)d] %(message)s"

    logging.basicConfig(format=formatter, level=logging.INFO)

    main()
