# Copyright 2022 The MediaPipe Authors. 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.
"""Tests for hand landmarker."""

import enum
from unittest import mock

from absl.testing import absltest
from absl.testing import parameterized
import numpy as np

from google.protobuf import text_format
from mediapipe.python._framework_bindings import image as image_module
from mediapipe.tasks.cc.components.containers.proto import landmarks_detection_result_pb2
from mediapipe.tasks.python.components.containers import landmark as landmark_module
from mediapipe.tasks.python.components.containers import landmark_detection_result as landmark_detection_result_module
from mediapipe.tasks.python.components.containers import rect as rect_module
from mediapipe.tasks.python.core import base_options as base_options_module
from mediapipe.tasks.python.test import test_utils
from mediapipe.tasks.python.vision import hand_landmarker
from mediapipe.tasks.python.vision.core import image_processing_options as image_processing_options_module
from mediapipe.tasks.python.vision.core import vision_task_running_mode as running_mode_module

_LandmarksDetectionResultProto = landmarks_detection_result_pb2.LandmarksDetectionResult
_BaseOptions = base_options_module.BaseOptions
_Rect = rect_module.Rect
_Landmark = landmark_module.Landmark
_NormalizedLandmark = landmark_module.NormalizedLandmark
_LandmarksDetectionResult = landmark_detection_result_module.LandmarksDetectionResult
_Image = image_module.Image
_HandLandmarker = hand_landmarker.HandLandmarker
_HandLandmarkerOptions = hand_landmarker.HandLandmarkerOptions
_HandLandmarkerResult = hand_landmarker.HandLandmarkerResult
_RUNNING_MODE = running_mode_module.VisionTaskRunningMode
_ImageProcessingOptions = image_processing_options_module.ImageProcessingOptions

_HAND_LANDMARKER_BUNDLE_ASSET_FILE = 'hand_landmarker.task'
_NO_HANDS_IMAGE = 'cats_and_dogs.jpg'
_TWO_HANDS_IMAGE = 'right_hands.jpg'
_THUMB_UP_IMAGE = 'thumb_up.jpg'
_THUMB_UP_LANDMARKS = 'thumb_up_landmarks.pbtxt'
_POINTING_UP_IMAGE = 'pointing_up.jpg'
_POINTING_UP_LANDMARKS = 'pointing_up_landmarks.pbtxt'
_POINTING_UP_ROTATED_IMAGE = 'pointing_up_rotated.jpg'
_POINTING_UP_ROTATED_LANDMARKS = 'pointing_up_rotated_landmarks.pbtxt'
_LANDMARKS_ERROR_TOLERANCE = 0.03
_HANDEDNESS_MARGIN = 0.05


def _get_expected_hand_landmarker_result(
    file_path: str) -> _HandLandmarkerResult:
  landmarks_detection_result_file_path = test_utils.get_test_data_path(
      file_path)
  with open(landmarks_detection_result_file_path, 'rb') as f:
    landmarks_detection_result_proto = _LandmarksDetectionResultProto()
    # Use this if a .pb file is available.
    # landmarks_detection_result_proto.ParseFromString(f.read())
    text_format.Parse(f.read(), landmarks_detection_result_proto)
    landmarks_detection_result = _LandmarksDetectionResult.create_from_pb2(
        landmarks_detection_result_proto)
  return _HandLandmarkerResult(
      handedness=[landmarks_detection_result.categories],
      hand_landmarks=[landmarks_detection_result.landmarks],
      hand_world_landmarks=[landmarks_detection_result.world_landmarks])


class ModelFileType(enum.Enum):
  FILE_CONTENT = 1
  FILE_NAME = 2


class HandLandmarkerTest(parameterized.TestCase):

  def setUp(self):
    super().setUp()
    self.test_image = _Image.create_from_file(
        test_utils.get_test_data_path(_THUMB_UP_IMAGE))
    self.model_path = test_utils.get_test_data_path(
        _HAND_LANDMARKER_BUNDLE_ASSET_FILE)

  def _assert_actual_result_approximately_matches_expected_result(
      self, actual_result: _HandLandmarkerResult,
      expected_result: _HandLandmarkerResult):
    # Expects to have the same number of hands detected.
    self.assertLen(actual_result.hand_landmarks,
                   len(expected_result.hand_landmarks))
    self.assertLen(actual_result.hand_world_landmarks,
                   len(expected_result.hand_world_landmarks))
    self.assertLen(actual_result.handedness, len(expected_result.handedness))
    # Actual landmarks match expected landmarks.
    self.assertLen(actual_result.hand_landmarks[0],
                   len(expected_result.hand_landmarks[0]))
    actual_landmarks = actual_result.hand_landmarks[0]
    expected_landmarks = expected_result.hand_landmarks[0]
    for i, rename_me in enumerate(actual_landmarks):
      self.assertAlmostEqual(
          rename_me.x,
          expected_landmarks[i].x,
          delta=_LANDMARKS_ERROR_TOLERANCE)
      self.assertAlmostEqual(
          rename_me.y,
          expected_landmarks[i].y,
          delta=_LANDMARKS_ERROR_TOLERANCE)
    # Actual handedness matches expected handedness.
    actual_top_handedness = actual_result.handedness[0][0]
    expected_top_handedness = expected_result.handedness[0][0]
    self.assertEqual(actual_top_handedness.index, expected_top_handedness.index)
    self.assertEqual(actual_top_handedness.category_name,
                     expected_top_handedness.category_name)
    self.assertAlmostEqual(
        actual_top_handedness.score,
        expected_top_handedness.score,
        delta=_HANDEDNESS_MARGIN)

  def test_create_from_file_succeeds_with_valid_model_path(self):
    # Creates with default option and valid model file successfully.
    with _HandLandmarker.create_from_model_path(self.model_path) as landmarker:
      self.assertIsInstance(landmarker, _HandLandmarker)

  def test_create_from_options_succeeds_with_valid_model_path(self):
    # Creates with options containing model file successfully.
    base_options = _BaseOptions(model_asset_path=self.model_path)
    options = _HandLandmarkerOptions(base_options=base_options)
    with _HandLandmarker.create_from_options(options) as landmarker:
      self.assertIsInstance(landmarker, _HandLandmarker)

  def test_create_from_options_fails_with_invalid_model_path(self):
    # Invalid empty model path.
    with self.assertRaisesRegex(
        RuntimeError, 'Unable to open file at /path/to/invalid/model.tflite'):
      base_options = _BaseOptions(
          model_asset_path='/path/to/invalid/model.tflite')
      options = _HandLandmarkerOptions(base_options=base_options)
      _HandLandmarker.create_from_options(options)

  def test_create_from_options_succeeds_with_valid_model_content(self):
    # Creates with options containing model content successfully.
    with open(self.model_path, 'rb') as f:
      base_options = _BaseOptions(model_asset_buffer=f.read())
      options = _HandLandmarkerOptions(base_options=base_options)
      landmarker = _HandLandmarker.create_from_options(options)
      self.assertIsInstance(landmarker, _HandLandmarker)

  @parameterized.parameters(
      (ModelFileType.FILE_NAME,
       _get_expected_hand_landmarker_result(_THUMB_UP_LANDMARKS)),
      (ModelFileType.FILE_CONTENT,
       _get_expected_hand_landmarker_result(_THUMB_UP_LANDMARKS)))
  def test_detect(self, model_file_type, expected_detection_result):
    # Creates hand landmarker.
    if model_file_type is ModelFileType.FILE_NAME:
      base_options = _BaseOptions(model_asset_path=self.model_path)
    elif model_file_type is ModelFileType.FILE_CONTENT:
      with open(self.model_path, 'rb') as f:
        model_content = f.read()
      base_options = _BaseOptions(model_asset_buffer=model_content)
    else:
      # Should never happen
      raise ValueError('model_file_type is invalid.')

    options = _HandLandmarkerOptions(base_options=base_options)
    landmarker = _HandLandmarker.create_from_options(options)

    # Performs hand landmarks detection on the input.
    detection_result = landmarker.detect(self.test_image)
    # Comparing results.
    self._assert_actual_result_approximately_matches_expected_result(
        detection_result, expected_detection_result)
    # Closes the hand landmarker explicitly when the hand landmarker is not used
    # in a context.
    landmarker.close()

  @parameterized.parameters(
      (ModelFileType.FILE_NAME,
       _get_expected_hand_landmarker_result(_THUMB_UP_LANDMARKS)),
      (ModelFileType.FILE_CONTENT,
       _get_expected_hand_landmarker_result(_THUMB_UP_LANDMARKS)))
  def test_detect_in_context(self, model_file_type, expected_detection_result):
    # Creates hand landmarker.
    if model_file_type is ModelFileType.FILE_NAME:
      base_options = _BaseOptions(model_asset_path=self.model_path)
    elif model_file_type is ModelFileType.FILE_CONTENT:
      with open(self.model_path, 'rb') as f:
        model_content = f.read()
      base_options = _BaseOptions(model_asset_buffer=model_content)
    else:
      # Should never happen
      raise ValueError('model_file_type is invalid.')

    options = _HandLandmarkerOptions(base_options=base_options)
    with _HandLandmarker.create_from_options(options) as landmarker:
      # Performs hand landmarks detection on the input.
      detection_result = landmarker.detect(self.test_image)
      # Comparing results.
      self._assert_actual_result_approximately_matches_expected_result(
          detection_result, expected_detection_result)

  def test_detect_succeeds_with_num_hands(self):
    # Creates hand landmarker.
    base_options = _BaseOptions(model_asset_path=self.model_path)
    options = _HandLandmarkerOptions(base_options=base_options, num_hands=2)
    with _HandLandmarker.create_from_options(options) as landmarker:
      # Load the two hands image.
      test_image = _Image.create_from_file(
          test_utils.get_test_data_path(_TWO_HANDS_IMAGE))
      # Performs hand landmarks detection on the input.
      detection_result = landmarker.detect(test_image)
      # Comparing results.
      self.assertLen(detection_result.handedness, 2)

  def test_detect_succeeds_with_rotation(self):
    # Creates hand landmarker.
    base_options = _BaseOptions(model_asset_path=self.model_path)
    options = _HandLandmarkerOptions(base_options=base_options)
    with _HandLandmarker.create_from_options(options) as landmarker:
      # Load the pointing up rotated image.
      test_image = _Image.create_from_file(
          test_utils.get_test_data_path(_POINTING_UP_ROTATED_IMAGE))
      # Set rotation parameters using ImageProcessingOptions.
      image_processing_options = _ImageProcessingOptions(rotation_degrees=-90)
      # Performs hand landmarks detection on the input.
      detection_result = landmarker.detect(test_image, image_processing_options)
      expected_detection_result = _get_expected_hand_landmarker_result(
          _POINTING_UP_ROTATED_LANDMARKS)
      # Comparing results.
      self._assert_actual_result_approximately_matches_expected_result(
          detection_result, expected_detection_result)

  def test_detect_fails_with_region_of_interest(self):
    # Creates hand landmarker.
    base_options = _BaseOptions(model_asset_path=self.model_path)
    options = _HandLandmarkerOptions(base_options=base_options)
    with self.assertRaisesRegex(
        ValueError, "This task doesn't support region-of-interest."):
      with _HandLandmarker.create_from_options(options) as landmarker:
        # Set the `region_of_interest` parameter using `ImageProcessingOptions`.
        image_processing_options = _ImageProcessingOptions(
            region_of_interest=_Rect(0, 0, 1, 1))
        # Attempt to perform hand landmarks detection on the cropped input.
        landmarker.detect(self.test_image, image_processing_options)

  def test_empty_detection_outputs(self):
    options = _HandLandmarkerOptions(
        base_options=_BaseOptions(model_asset_path=self.model_path))
    with _HandLandmarker.create_from_options(options) as landmarker:
      # Load the image with no hands.
      no_hands_test_image = _Image.create_from_file(
          test_utils.get_test_data_path(_NO_HANDS_IMAGE))
      # Performs hand landmarks detection on the input.
      detection_result = landmarker.detect(no_hands_test_image)
      self.assertEmpty(detection_result.hand_landmarks)
      self.assertEmpty(detection_result.hand_world_landmarks)
      self.assertEmpty(detection_result.handedness)

  def test_missing_result_callback(self):
    options = _HandLandmarkerOptions(
        base_options=_BaseOptions(model_asset_path=self.model_path),
        running_mode=_RUNNING_MODE.LIVE_STREAM)
    with self.assertRaisesRegex(ValueError,
                                r'result callback must be provided'):
      with _HandLandmarker.create_from_options(options) as unused_landmarker:
        pass

  @parameterized.parameters((_RUNNING_MODE.IMAGE), (_RUNNING_MODE.VIDEO))
  def test_illegal_result_callback(self, running_mode):
    options = _HandLandmarkerOptions(
        base_options=_BaseOptions(model_asset_path=self.model_path),
        running_mode=running_mode,
        result_callback=mock.MagicMock())
    with self.assertRaisesRegex(ValueError,
                                r'result callback should not be provided'):
      with _HandLandmarker.create_from_options(options) as unused_landmarker:
        pass

  def test_calling_detect_for_video_in_image_mode(self):
    options = _HandLandmarkerOptions(
        base_options=_BaseOptions(model_asset_path=self.model_path),
        running_mode=_RUNNING_MODE.IMAGE)
    with _HandLandmarker.create_from_options(options) as landmarker:
      with self.assertRaisesRegex(ValueError,
                                  r'not initialized with the video mode'):
        landmarker.detect_for_video(self.test_image, 0)

  def test_calling_detect_async_in_image_mode(self):
    options = _HandLandmarkerOptions(
        base_options=_BaseOptions(model_asset_path=self.model_path),
        running_mode=_RUNNING_MODE.IMAGE)
    with _HandLandmarker.create_from_options(options) as landmarker:
      with self.assertRaisesRegex(ValueError,
                                  r'not initialized with the live stream mode'):
        landmarker.detect_async(self.test_image, 0)

  def test_calling_detect_in_video_mode(self):
    options = _HandLandmarkerOptions(
        base_options=_BaseOptions(model_asset_path=self.model_path),
        running_mode=_RUNNING_MODE.VIDEO)
    with _HandLandmarker.create_from_options(options) as landmarker:
      with self.assertRaisesRegex(ValueError,
                                  r'not initialized with the image mode'):
        landmarker.detect(self.test_image)

  def test_calling_detect_async_in_video_mode(self):
    options = _HandLandmarkerOptions(
        base_options=_BaseOptions(model_asset_path=self.model_path),
        running_mode=_RUNNING_MODE.VIDEO)
    with _HandLandmarker.create_from_options(options) as landmarker:
      with self.assertRaisesRegex(ValueError,
                                  r'not initialized with the live stream mode'):
        landmarker.detect_async(self.test_image, 0)

  def test_detect_for_video_with_out_of_order_timestamp(self):
    options = _HandLandmarkerOptions(
        base_options=_BaseOptions(model_asset_path=self.model_path),
        running_mode=_RUNNING_MODE.VIDEO)
    with _HandLandmarker.create_from_options(options) as landmarker:
      unused_result = landmarker.detect_for_video(self.test_image, 1)
      with self.assertRaisesRegex(
          ValueError, r'Input timestamp must be monotonically increasing'):
        landmarker.detect_for_video(self.test_image, 0)

  @parameterized.parameters(
      (_THUMB_UP_IMAGE, 0,
       _get_expected_hand_landmarker_result(_THUMB_UP_LANDMARKS)),
      (_POINTING_UP_IMAGE, 0,
       _get_expected_hand_landmarker_result(_POINTING_UP_LANDMARKS)),
      (_POINTING_UP_ROTATED_IMAGE, -90,
       _get_expected_hand_landmarker_result(_POINTING_UP_ROTATED_LANDMARKS)),
      (_NO_HANDS_IMAGE, 0, _HandLandmarkerResult([], [], [])))
  def test_detect_for_video(self, image_path, rotation, expected_result):
    test_image = _Image.create_from_file(
        test_utils.get_test_data_path(image_path))
    # Set rotation parameters using ImageProcessingOptions.
    image_processing_options = _ImageProcessingOptions(
        rotation_degrees=rotation)
    options = _HandLandmarkerOptions(
        base_options=_BaseOptions(model_asset_path=self.model_path),
        running_mode=_RUNNING_MODE.VIDEO)
    with _HandLandmarker.create_from_options(options) as landmarker:
      for timestamp in range(0, 300, 30):
        result = landmarker.detect_for_video(test_image, timestamp,
                                             image_processing_options)
        if result.hand_landmarks and result.hand_world_landmarks and result.handedness:
          self._assert_actual_result_approximately_matches_expected_result(
              result, expected_result)
        else:
          self.assertEqual(result, expected_result)

  def test_calling_detect_in_live_stream_mode(self):
    options = _HandLandmarkerOptions(
        base_options=_BaseOptions(model_asset_path=self.model_path),
        running_mode=_RUNNING_MODE.LIVE_STREAM,
        result_callback=mock.MagicMock())
    with _HandLandmarker.create_from_options(options) as landmarker:
      with self.assertRaisesRegex(ValueError,
                                  r'not initialized with the image mode'):
        landmarker.detect(self.test_image)

  def test_calling_detect_for_video_in_live_stream_mode(self):
    options = _HandLandmarkerOptions(
        base_options=_BaseOptions(model_asset_path=self.model_path),
        running_mode=_RUNNING_MODE.LIVE_STREAM,
        result_callback=mock.MagicMock())
    with _HandLandmarker.create_from_options(options) as landmarker:
      with self.assertRaisesRegex(ValueError,
                                  r'not initialized with the video mode'):
        landmarker.detect_for_video(self.test_image, 0)

  def test_detect_async_calls_with_illegal_timestamp(self):
    options = _HandLandmarkerOptions(
        base_options=_BaseOptions(model_asset_path=self.model_path),
        running_mode=_RUNNING_MODE.LIVE_STREAM,
        result_callback=mock.MagicMock())
    with _HandLandmarker.create_from_options(options) as landmarker:
      landmarker.detect_async(self.test_image, 100)
      with self.assertRaisesRegex(
          ValueError, r'Input timestamp must be monotonically increasing'):
        landmarker.detect_async(self.test_image, 0)

  @parameterized.parameters(
      (_THUMB_UP_IMAGE, 0,
       _get_expected_hand_landmarker_result(_THUMB_UP_LANDMARKS)),
      (_POINTING_UP_IMAGE, 0,
       _get_expected_hand_landmarker_result(_POINTING_UP_LANDMARKS)),
      (_POINTING_UP_ROTATED_IMAGE, -90,
       _get_expected_hand_landmarker_result(_POINTING_UP_ROTATED_LANDMARKS)),
      (_NO_HANDS_IMAGE, 0, _HandLandmarkerResult([], [], [])))
  def test_detect_async_calls(self, image_path, rotation, expected_result):
    test_image = _Image.create_from_file(
        test_utils.get_test_data_path(image_path))
    # Set rotation parameters using ImageProcessingOptions.
    image_processing_options = _ImageProcessingOptions(
        rotation_degrees=rotation)
    observed_timestamp_ms = -1

    def check_result(result: _HandLandmarkerResult, output_image: _Image,
                     timestamp_ms: int):
      if result.hand_landmarks and result.hand_world_landmarks and result.handedness:
        self._assert_actual_result_approximately_matches_expected_result(
            result, expected_result)
      else:
        self.assertEqual(result, expected_result)
      self.assertTrue(
          np.array_equal(output_image.numpy_view(), test_image.numpy_view()))
      self.assertLess(observed_timestamp_ms, timestamp_ms)
      self.observed_timestamp_ms = timestamp_ms

    options = _HandLandmarkerOptions(
        base_options=_BaseOptions(model_asset_path=self.model_path),
        running_mode=_RUNNING_MODE.LIVE_STREAM,
        result_callback=check_result)
    with _HandLandmarker.create_from_options(options) as landmarker:
      for timestamp in range(0, 300, 30):
        landmarker.detect_async(test_image, timestamp, image_processing_options)


if __name__ == '__main__':
  absltest.main()
