# MIT License
#
# Copyright (C) 2022. Huawei Technologies Co., Ltd. All rights reserved.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
import logging
import sys
import gymnasium as gym
import numpy as np
try:
from moviepy.editor import ImageClip, ImageSequenceClip
except (ImportError, ModuleNotFoundError):
logging.warning(sys.exc_info())
logging.warning(
"You may not have installed the [gym] dependencies required to capture the video. Install them first with the `smarts[gym]` extras."
)
raise
import shutil
import time
from pathlib import Path
[docs]class GifRecorder:
"""
Uses images (such as from gym's ``"rgb_array"``) to create a gif file.
"""
def __init__(self, video_name_folder: str, env: gym.Env):
timestamp_str = time.strftime("%Y%m%d-%H%M%S")
self.frame_folder = (
video_name_folder + "_" + timestamp_str
) # folder that uses to contain temporary frame images, will be deleted after the gif is created.
self.env = env
Path.mkdir(
Path(self.frame_folder), exist_ok=True
) # create temporary frame images folder if not exists.
self._video_root_path = str(
Path(video_name_folder).parent
) # path of the video file
self._video_name = str(Path(video_name_folder).name) # name of the video
[docs] def capture_frame(self, step_num: int, image: np.ndarray):
"""
Create image according to the ``"rgb_array"`` and store it with step number in the destination folder
"""
with ImageClip(image) as image_clip:
image_clip.save_frame(
f"{self.frame_folder}/{self._video_name}_{step_num}.jpeg"
)
[docs] def generate_gif(self):
"""
Use the images in the same folder to create a gif file.
"""
with ImageSequenceClip(self.frame_folder, fps=10) as clip:
clip.write_gif(f"{self._video_root_path}/{self._video_name}.gif")
clip.close()
[docs] def close_recorder(self):
"""
close the recorder by deleting the image folder.
"""
shutil.rmtree(self.frame_folder, ignore_errors=True)