feat(cli): reverse videos on the fly

Author: jeertmans

README.md

@@ -65,6 +65,7 @@ Default keybindings to control the presentation:
 | Right Arrow |    Continue/Next Slide   |
 |  Left Arrow |      Previous Slide      |
 |      R      | Re-Animate Current Slide |
+|      V      |   Reverse Current Slide  |
 |   Spacebar  |        Play/Pause        |
 |      Q      |           Quit           |
 
@@ -122,10 +123,10 @@ Here are a few things that I implemented (or that I'm planning to implement) on
 - [x] Only one cli (to rule them all)
 - [x] User can easily generate dummy config file
 - [x] Config file path can be manually set
-- [ ] Play animation in reverse [#9](https://github.com/galatolofederico/manim-presentation/issues/9)
+- [x] Play animation in reverse [#9](https://github.com/galatolofederico/manim-presentation/issues/9)
 - [x] Handle 3D scenes out of the box
 - [ ] Generate docs online
-- [ ] Fix the quality problem on Windows platforms with `fullscreen` flag
+- [x] Fix the quality problem on Windows platforms with `fullscreen` flag
 
 ## Contributions and license
 

manim_slides/__version__.py

@@ -1 +1 @@
-__version__ = "3.0.1"
+__version__ = "3.1.0"

manim_slides/config.py

@@ -23,6 +23,7 @@ class Config(BaseModel):
     QUIT: Key = Key(ids=[ord("q")], name="QUIT")
     CONTINUE: Key = Key(ids=[RIGHT_ARROW_KEY_CODE], name="CONTINUE / NEXT")
     BACK: Key = Key(ids=[LEFT_ARROW_KEY_CODE], name="BACK")
+    REVERSE: Key = Key(ids=[ord("v")], name="REVERSE")
     REWIND: Key = Key(ids=[ord("r")], name="REWIND")
     PLAY_PAUSE: Key = Key(ids=[32], name="PLAY / PAUSE")
 
@@ -33,7 +34,7 @@ def ids_are_unique_across_keys(cls, values):
         for key in values.values():
             if len(ids.intersection(key.ids)) != 0:
                 raise ValueError(
-                    f"Two or more keys share a common key code: please make sure each key has distinc key codes"
+                    "Two or more keys share a common key code: please make sure each key has distinc key codes"
                 )
             ids.update(key.ids)
 

manim_slides/main.py

@@ -2,7 +2,7 @@
 from click_default_group import DefaultGroup
 
 from . import __version__
-from .present import present
+from .present import list_scenes, present
 from .wizard import init, wizard
 
 
@@ -13,6 +13,7 @@ def cli():
     pass
 
 
+cli.add_command(list_scenes)
 cli.add_command(present)
 cli.add_command(wizard)
 cli.add_command(init)

manim_slides/present.py

@@ -42,7 +42,9 @@ class Presentation:
     def __init__(self, config, last_frame_next: bool = False):
         self.last_frame_next = last_frame_next
         self.slides = config["slides"]
-        self.files = [reverse_video_path(path) for path in config["files"]]
+        self.files = [path for path in config["files"]]
+        self.reverse = False
+        self.reversed_slide = -1
 
         self.lastframe = []
 
@@ -80,22 +82,34 @@ def prev(self):
         self.current_slide_i = max(0, self.current_slide_i - 1)
         self.rewind_slide()
 
-    def reserve_slide(self):
-        pass
+    def reverse_slide(self):
+        self.rewind_slide(reverse=True)
 
-    def rewind_slide(self):
+    def rewind_slide(self, reverse: bool = False):
+        self.reverse = reverse
         self.current_animation = self.current_slide["start_animation"]
         self.current_cap.set(cv2.CAP_PROP_POS_FRAMES, 0)
 
-    def load_this_cap(self, cap_number):
-        if self.caps[cap_number] == None:
+    def load_this_cap(self, cap_number: int):
+        if (
+            self.caps[cap_number] is None
+            or (self.reverse and self.reversed_slide != cap_number)
+            or (not self.reverse and self.reversed_slide == cap_number)
+        ):
             # unload other caps
             for i in range(len(self.caps)):
-                if self.caps[i] != None:
+                if not self.caps[i] is None:
                     self.caps[i].release()
                     self.caps[i] = None
             # load this cap
-            self.caps[cap_number] = cv2.VideoCapture(self.files[cap_number])
+            file = self.files[cap_number]
+            if self.reverse:
+                self.reversed_slide = cap_number
+                file = "{}_reversed{}".format(*os.path.splitext(file))
+            else:
+                self.reversed_slide = -1
+
+            self.caps[cap_number] = cv2.VideoCapture(file)
 
     @property
     def current_slide(self):
@@ -174,7 +188,9 @@ def __init__(self, presentations, config, start_paused=False, fullscreen=False):
 
         if platform.system() == "Windows":
             user32 = ctypes.windll.user32
-            self.screen_width, self.screen_height = user32.GetSystemMetrics(0), user32.GetSystemMetrics(1)
+            self.screen_width, self.screen_height = user32.GetSystemMetrics(
+                0
+            ), user32.GetSystemMetrics(1)
 
         if fullscreen:
             cv2.namedWindow("Video", cv2.WND_PROP_FULLSCREEN)
@@ -287,6 +303,9 @@ def handle_key(self):
             else:
                 self.current_presentation.prev()
                 self.state = State.PLAYING
+        elif self.config.REVERSE.match(key):
+            self.current_presentation.reverse_slide()
+            self.state = State.PLAYING
         elif self.config.REWIND.match(key):
             self.current_presentation.rewind_slide()
             self.state = State.PLAYING
@@ -296,28 +315,33 @@ def quit(self):
         sys.exit()
 
 
-"""
 @click.command()
 @click.option(
     "--folder",
     default=FOLDER_PATH,
     type=click.Path(exists=True, file_okay=False),
     help="Set slides folder.",
 )
-"""
 @click.help_option("-h", "--help")
 def list_scenes(folder):
+    """List available scenes."""
+
+    for i, scene in enumerate(_list_scenes(folder), start=1):
+        click.secho(f"{i}: {scene}", fg="green")
+
+
+def _list_scenes(folder):
     scenes = []
 
     for file in os.listdir(folder):
         if file.endswith(".json"):
-            scenes.append(os.path.basename(file)[:-4])
+            scenes.append(os.path.basename(file)[:-5])
 
     return scenes
 
 
 @click.command()
-@click.option("--scenes", nargs=-1, prompt=True)
+@click.argument("scenes", nargs=-1)
 @config_path_option
 @click.option(
     "--folder",
@@ -337,19 +361,36 @@ def present(scenes, config_path, folder, start_paused, fullscreen, last_frame_ne
     """Present the different scenes."""
 
     if len(scenes) == 0:
-        print("ICI")
-        scene_choices = list_scenes(folder)
+        scene_choices = _list_scenes(folder)
 
         scene_choices = dict(enumerate(scene_choices, start=1))
-        choices = [str(i) for i in scene_choices.keys()]
+
+        for i, scene in scene_choices.items():
+            click.secho(f"{i}: {scene}", fg="green")
+
+        click.echo()
+
+        click.echo("Choose number corresponding to desired scene/arguments.")
+        click.echo("(Use comma separated list for multiple entries)")
 
         def value_proc(value: str):
-            raise ValueError("Value:")
-        
-        print(scene_choices)
-        
-        scenes = click.prompt("Choose a scene", value_proc=value_proc)
-        
+            indices = list(map(int, value.strip().replace(" ", "").split(",")))
+
+            if not all(map(lambda i: 0 < i <= len(scene_choices), indices)):
+                raise ValueError("Please only enter numbers displayed on the screen.")
+
+            return [scene_choices[i] for i in indices]
+
+        if len(scene_choices) == 0:
+            raise ValueError("No scenes were found, are you in the correct directory?")
+
+        while True:
+            try:
+                scenes = click.prompt("Choice(s)", value_proc=value_proc)
+                break
+            except ValueError as e:
+                click.secho(e, fg="red")
+
     presentations = list()
     for scene in scenes:
         config_file = os.path.join(folder, f"{scene}.json")

manim_slides/slide.py

@@ -91,11 +91,12 @@ def render(self, *args, **kwargs):
         scene_name = type(self).__name__
         scene_files_folder = os.path.join(files_folder, scene_name)
 
-        if os.path.exists(scene_files_folder):
-            shutil.rmtree(scene_files_folder)
+        old_animation_files = set()
 
         if not os.path.exists(scene_files_folder):
             os.mkdir(scene_files_folder)
+        else:
+            old_animation_files.update(os.listdir(scene_files_folder))
 
         files = list()
         for src_file in tqdm(
@@ -105,10 +106,25 @@ def render(self, *args, **kwargs):
             ascii=True if platform.system() == "Windows" else None,
             disable=config["progress_bar"] == "none",
         ):
-            dst_file = os.path.join(scene_files_folder, os.path.basename(src_file))
-            shutil.copyfile(src_file, dst_file)
-            rev_file = reverse_video_path(dst_file)
-            reverse_video_file(src_file, rev_file)
+            filename = os.path.basename(src_file)
+            _hash, ext = os.path.splitext(filename)
+
+            rev_filename = f"{_hash}_reversed{ext}"
+
+            dst_file = os.path.join(scene_files_folder, filename)
+            # We only copy animation if it was not present
+            if filename in old_animation_files:
+                old_animation_files.remove(filename)
+            else:
+                shutil.copyfile(src_file, dst_file)
+
+            # We only reverse video if it was not present
+            if rev_filename in old_animation_files:
+                old_animation_files.remove(rev_filename)
+            else:
+                rev_file = os.path.join(scene_files_folder, rev_filename)
+                reverse_video_file(src_file, rev_file)
+
             files.append(dst_file)
 
         logger.info(

setup.py

@@ -2,7 +2,7 @@
 
 import setuptools
 
-from .__version__ import __version__ as version
+from manim_slides import __version__ as version
 
 if sys.version_info < (3, 7):
     raise RuntimeError("This package requires Python 3.7+")