chore(version): bump 5.0.0-rc1 to 5.0.0-rc2

Add 3 new themes: dracula, dark-contrast and white-contrast.

.bumpversion.cfg

@@ -1,5 +1,9 @@
 [bumpversion]
-current_version = 4.16.0
+current_version = 5.0.0-rc2
+parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(-rc(?P<release>\d+))?
+serialize = 
+	{major}.{minor}.{patch}-rc{release}
+	{major}.{minor}.{patch}
 commit = True
 message = chore(version): bump {current_version} to {new_version}
 

.github/workflows/clearcache.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Check out code
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Cleanup
       run: |

.github/workflows/codeql-analysis.yml

@@ -38,7 +38,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL

.github/workflows/coverage.yml

@@ -13,7 +13,7 @@ jobs:
       DISPLAY: :99
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Install Poetry
       run: pipx install poetry

.github/workflows/draft-pdf.yml

@@ -16,7 +16,7 @@ jobs:
     name: Paper Draft
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
     - name: Build draft PDF
       uses: openjournals/openjournals-draft-action@master
       with:

.github/workflows/languagetool.yml

@@ -8,7 +8,7 @@ jobs:
   languagetool_check:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: reviewdog/action-languagetool@v1
       with:
         reporter: github-pr-review

.github/workflows/pages.yml

@@ -32,7 +32,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
     - name: Install Poetry
       run: pipx install poetry
     - name: Install Python
@@ -56,18 +56,8 @@ jobs:
       id: cache-media-restore
       uses: actions/cache/restore@v3
       with:
-        path: media
-        key: ${{ runner.os }}-media
-    - name: Build animations
-      run: |
-        poetry run manim example.py ConvertExample BasicExample ThreeDExample
-    - name: Convert animations to HTML slides
-      run: |
-        poetry run manim-slides convert -v DEBUG ConvertExample docs/source/_static/slides.html -ccontrols=true
-        poetry run manim-slides convert -v DEBUG BasicExample docs/source/_static/basic_example.html -ccontrols=true
-        poetry run manim-slides convert -v DEBUG ThreeDExample docs/source/_static/three_d_example.html -ccontrols=true
-    - name: Show docs/source/_static/ dir content (video only)
-      run: tree -L 3 docs/source/_static/ -P '*.mp4'
+        path: docs/media
+        key: ${{ runner.os }}-docs-media
     - name: Clear cache
       run: |
         gh extension install actions/gh-actions-cache
@@ -78,7 +68,7 @@ jobs:
       id: cache-media-save
       uses: actions/cache/save@v3
       with:
-        path: media
+        path: docs/media
         key: ${{ steps.cache-media-restore.outputs.cache-primary-key }}
     - name: Build docs
       run: cd docs && poetry run make html

.github/workflows/python-publish.yml

@@ -13,7 +13,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Install Poetry
       run: pipx install poetry

.github/workflows/tests.yml

@@ -18,7 +18,7 @@ jobs:
       DISPLAY: :99
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Install Poetry
       run: pipx install poetry
@@ -46,7 +46,7 @@ jobs:
         poetry install --with test
 
     - name: Run pytest
-      run: poetry run pytest -x
+      run: poetry run pytest -x -n auto
 
   build-examples:
     strategy:
@@ -84,7 +84,7 @@ jobs:
       DISPLAY: :99
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Install Poetry
       run: pipx install poetry

.gitignore

@@ -17,7 +17,7 @@ videos/
 .manim-slides.toml
 
 slides/
-!tests/slides/
+!tests/data/slides/
 
 slides_assets/
 

.pre-commit-config.yaml

@@ -20,15 +20,16 @@ repos:
     exclude: poetry.lock
     args: [--autofix]
 - repo: https://github.com/psf/black
-  rev: 23.7.0
+  rev: 23.9.1
   hooks:
   - id: black
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.0.282
+  rev: v0.0.288
   hooks:
   - id: ruff
+    args: [--fix]
 - repo: https://github.com/pre-commit/mirrors-mypy
-  rev: v1.4.1
+  rev: v1.5.1
   hooks:
   - id: mypy
     additional_dependencies: [types-requests, types-setuptools]

CHANGELOG.md

@@ -0,0 +1,79 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+<!-- start changelog -->
+
+## [v5 (Unreleased)](https://github.com/jeertmans/languagetool-rust/compare/v4.16.0...HEAD)
+
+Prior to v5, there was no real CHANGELOG other than the GitHub releases,
+with most of the content automatically generated by GitHub from merged
+pull requests.
+
+In an effort to better document changes, this CHANGELOG document is now created.
+
+### Added
+
+- Added the following option aliases to `manim-slides present`:
+  `-F` and `--full-screen` for `fullscreen`,
+  `-H` for `--hide-mouse`,
+  and `-S` for `--screen-number`.
+  [#243](https://github.com/jeertmans/manim-slides/pull/243)
+- Added a full screen key binding (defaults to <kbd>F</kbd>) in the
+  presenter.
+  [#243](https://github.com/jeertmans/manim-slides/pull/243)
+- Added support for including code from a file in Manim Slides
+  Sphinx directive.
+  [#261](https://github.com/jeertmans/manim-slides/pull/261)
+
+### Changed
+
+- Automatically concatenate all animations from a slide into one.
+  This is a **breaking change** because the config file format is
+  different from the previous one. For migration help, see associated PR.
+  [#242](https://github.com/jeertmans/manim-slides/pull/242)
+- Changed the player interface to only use PySide6, and not a combination of
+  PySide6 and OpenCV. A few features have been removed (see removed section),
+  but the new player should be much easier to maintain and more performant,
+  than its predecessor.
+  [#243](https://github.com/jeertmans/manim-slides/pull/243)
+- Changed the slide config format to exclude unecessary information.
+  `StypeType` is removed in favor to one boolean `loop` field. This is
+  a **breaking change** and one should re-render the slides to apply changes.
+  [#243](https://github.com/jeertmans/manim-slides/pull/243)
+- Renamed key bindings in the config. This is a **breaking change** and one
+  should either manually rename them (see list below) or re-init a config.
+  List of changes: `CONTINUE` to `NEXT`, `BACK` to `PREVIOUS`, and
+  `REWIND` to `REPLAY`.
+  [#243](https://github.com/jeertmans/manim-slides/pull/243)
+- Conversion to HTML now uses Jinja2 templating. The template file has
+  been modified accordingly, and old templates will not work anymore.
+  This is a **breaking change**.
+  [#271](https://github.com/jeertmans/manim-slides/pull/271)
+- Bumped RevealJS' default version to v4.6.1, and added three new themes.
+  [#272](https://github.com/jeertmans/manim-slides/pull/272)
+
+### Fixed
+
+- Patched enums in `manim_slides/convert.py` to correctly call `str`'s
+  `__str__` method, and not the `Enum` one.
+  This bug was discovered by
+  [@alexanderskulikov](https://github.com/alexanderskulikov) in
+  [#253](https://github.com/jeertmans/manim-slides/discussions/253), caused by
+  Python 3.11's change in how `Enum` work.
+  [#257](https://github.com/jeertmans/manim-slides/pull/257).
+
+### Removed
+
+- Removed `--start-at-animation-number` option from `manim-slides present`.
+  [#242](https://github.com/jeertmans/manim-slides/pull/242)
+- Removed the following options from `manim-slides present`:
+  `--resolution`, `--record-to`, `--resize-mode`, and `--background-color`.
+  [#243](https://github.com/jeertmans/manim-slides/pull/243)
+- Removed `PERF` verbosity level because not used anymore.
+  [#245](https://github.com/jeertmans/manim-slides/pull/245)
+
+<!-- end changelog -->

CITATION.cff

@@ -29,4 +29,4 @@ keywords:
   - PowerPoint
   - Python
 license: MIT
-version: v4.16.0
+version: v5.0.0-rc2

docs/source/changelog.md

@@ -1,3 +1,6 @@
 # Changelog
 
-Changes between releases are listed in Manim Slides' [Github releases](https://github.com/jeertmans/manim-slides/releases). You can read the [latest release here](https://github.com/jeertmans/manim-slides/releases).
+```{include} ../../CHANGELOG.md
+:start-after: <!-- start changelog -->
+:end-before: <!-- end changelog -->
+```

docs/source/index.md

@@ -23,16 +23,18 @@ og:description: Manim Slides makes creating slides with Manim super easy!
 
 Manim Slides makes creating slides with Manim super easy!
 
-In a [very few steps](./quickstart), you can create slides and present them either using the GUI, or your browser.
+In a [very few steps](./quickstart),
+you can create slides and present them either using the GUI, or your browser.
 
 
-Slide through the demo below to get a quick glimpse on what you can do with Manim Slides.
-
-
-<!-- From: https://faq.dailymotion.com/hc/en-us/articles/360022841393-How-to-preserve-the-player-aspect-ratio-on-a-responsive-page -->
-
-<div style="position:relative;padding-bottom:56.25%;"> <iframe style="width:100%;height:100%;position:absolute;left:0px;top:0px;" frameborder="0" width="100%" height="100%" allowfullscreen allow="autoplay" src="_static/slides.html"></iframe></div>
+Slide through the demo below to get a quick glimpse on what you can do with
+Manim Slides.
 
+```{eval-rst}
+.. manim-slides:: ../../example.py:ConvertExample
+    :hide_source:
+    :quality: high
+```
 
 ```{toctree}
 :hidden:

docs/source/quickstart.md

@@ -16,6 +16,10 @@
 
 The output slides should look this this:
 
-<div style="position:relative;padding-bottom:56.25%;"> <iframe style="width:100%;height:100%;position:absolute;left:0px;top:0px;" frameborder="0" width="100%" height="100%" allowfullscreen allow="autoplay" src="_static/basic_example.html"></iframe></div>
+```{eval-rst}
+.. manim-slides:: ../../example.py:BasicExample
+    :hide_source:
+    :quality: high
+```
 
 For more advanced examples, see the [Examples](reference/examples) section.

docs/source/reference/examples.md

@@ -29,9 +29,11 @@ where `-ccontrols=true` indicates that we want to display the blue navigation ar
 
 Basic example from quickstart.
 
-<div style="position:relative;padding-bottom:56.25%;"> <iframe style="width:100%;height:100%;position:absolute;left:0px;top:0px;" frameborder="0" width="100%" height="100%" allowfullscreen allow="autoplay" src="../_static/basic_example.html"></iframe></div>
-
 ```{eval-rst}
+.. manim-slides:: ../../../example.py:BasicExample
+    :hide_source:
+    :quality: high
+
 .. literalinclude:: ../../../example.py
    :language: python
    :linenos:
@@ -40,13 +42,16 @@ Basic example from quickstart.
 
 ## 3D Example
 
-Example using 3D camera. As Manim and ManimGL handle 3D differently, definitions are slightly different.
-
-<div style="position:relative;padding-bottom:56.25%;"> <iframe style="width:100%;height:100%;position:absolute;left:0px;top:0px;" frameborder="0" width="100%" height="100%" allowfullscreen allow="autoplay" src="../_static/three_d_example.html"></iframe></div>
+Example using 3D camera. As Manim and ManimGL handle 3D differently,
+definitions are slightly different.
 
 ### With Manim
 
 ```{eval-rst}
+.. manim-slides:: ../../../example.py:ThreeDExample
+    :hide_source:
+    :quality: high
+
 .. literalinclude:: ../../../example.py
    :language: python
    :linenos:
@@ -95,19 +100,23 @@ And later use this class anywhere in your code:
 :linenos:
 
 class SubclassExample(MovingCameraSlide):
+    """Example taken from ManimCE's docs."""
+
     def construct(self):
-        eq1 = MathTex("x", "=", "1")
-        eq2 = MathTex("x", "=", "2")
+        self.camera.frame.save_state()
 
-        self.play(Write(eq1))
+        ax = Axes(x_range=[-1, 10], y_range=[-1, 10])
+        graph = ax.plot(lambda x: np.sin(x), color=WHITE, x_range=[0, 3 * PI])
 
+        dot_1 = Dot(ax.i2gp(graph.t_min, graph))
+        dot_2 = Dot(ax.i2gp(graph.t_max, graph))
+        self.add(ax, graph, dot_1, dot_2)
+
+        self.play(self.camera.frame.animate.scale(0.5).move_to(dot_1))
         self.next_slide()
-
-        self.play(
-            TransformMatchingTex(eq1, eq2),
-            self.camera.frame.animate.scale(0.5)
-        )
-
+        self.play(self.camera.frame.animate.move_to(dot_2))
+        self.next_slide()
+        self.play(Restore(self.camera.frame))
         self.wait()
 ```
 
@@ -116,13 +125,46 @@ If you do not plan to reuse `MovingCameraSlide` more than once, then you can
 directly write the `construct` method in the body of `MovingCameraSlide`.
 :::
 
+```{eval-rst}
+.. manim-slides:: SubclassExample
+    :hide_source:
+    :quality: high
+
+    from manim import *
+    from manim_slides import Slide
+
+
+    class MovingCameraSlide(Slide, MovingCameraScene):
+        pass
+
+    class SubclassExample(MovingCameraSlide):
+        def construct(self):
+            self.camera.frame.save_state()
+
+            ax = Axes(x_range=[-1, 10], y_range=[-1, 10])
+            graph = ax.plot(lambda x: np.sin(x), color=WHITE, x_range=[0, 3 * PI])
+
+            dot_1 = Dot(ax.i2gp(graph.t_min, graph))
+            dot_2 = Dot(ax.i2gp(graph.t_max, graph))
+            self.add(ax, graph, dot_1, dot_2)
+
+            self.play(self.camera.frame.animate.scale(0.5).move_to(dot_1))
+            self.next_slide()
+            self.play(self.camera.frame.animate.move_to(dot_2))
+            self.next_slide()
+            self.play(Restore(self.camera.frame))
+            self.wait()
+```
+
 ## Advanced Example
 
 A more advanced example is `ConvertExample`, which is used as demo slide and tutorial.
 
-<div style="position:relative;padding-bottom:56.25%;"> <iframe style="width:100%;height:100%;position:absolute;left:0px;top:0px;" frameborder="0" width="100%" height="100%" allowfullscreen allow="autoplay" src="../_static/slides.html"></iframe></div>
-
 ```{eval-rst}
+.. manim-slides:: ../../../example.py:ConvertExample
+    :hide_source:
+    :quality: high
+
 .. literalinclude:: ../../../example.py
    :language: python
    :linenos:

docs/source/reference/sharing.md

@@ -131,9 +131,9 @@ and it there to preserve the original aspect ratio (16:9).
 
 ### Sharing ONE HTML file
 
-A future feature, that will be available once
-[#122](https://github.com/jeertmans/manim-slides/issues/122) is solved, will be
-to include all animations as data URI encoded, within the HTML file itself.
+If you set the `data_uri` option to `true` (with `-cdata_uri=true`),
+all animations will be data URI encoded, making the HTML a self-contained
+presentation file that can be shared on its own.
 
 ### Over the internet
 

example.py

@@ -2,16 +2,14 @@
 # type: ignore
 import sys
 
-if "manim" in sys.modules:
-    from manim import *
-
-    MANIMGL = False
-elif "manimlib" in sys.modules:
+if "manimlib" in sys.modules:
     from manimlib import *
 
     MANIMGL = True
 else:
-    raise ImportError("This script must be run with either `manim` or `manimgl`")
+    from manim import *
+
+    MANIMGL = False
 
 from manim_slides import Slide, ThreeDSlide
 

manim_slides/__version__.py

@@ -1 +1 @@
-__version__ = "4.16.0"
+__version__ = "5.0.0-rc2"

manim_slides/commons.py

@@ -54,10 +54,10 @@ def verbosity_option(function: F) -> F:
         "-v",
         "--verbosity",
         type=click.Choice(
-            ["PERF", "DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"],
+            ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"],
             case_sensitive=False,
         ),
-        help="Verbosity of CLI output. PERF will log performances (timing) information.",
+        help="Verbosity of CLI output.",
         default=None,
         expose_value=False,
         envvar="MANIM_SLIDES_VERBOSITY",

manim_slides/config.py

@@ -1,11 +1,7 @@
-import hashlib
 import json
 import shutil
-import subprocess
-import tempfile
-from enum import Enum
 from pathlib import Path
-from typing import Any, Dict, List, Optional, Set, Tuple, Union
+from typing import Any, Callable, Dict, List, Optional, Set, Tuple
 
 import rtoml
 from pydantic import (
@@ -13,42 +9,40 @@ from pydantic import (
     Field,
     FilePath,
     PositiveInt,
+    PrivateAttr,
     field_validator,
     model_validator,
 )
 from pydantic_extra_types.color import Color
 from PySide6.QtCore import Qt
 
-from .defaults import FFMPEG_BIN
 from .logger import logger
 
-
-def merge_basenames(files: List[FilePath]) -> Path:
-    """
-    Merge multiple filenames by concatenating basenames.
-    """
-    logger.info(f"Generating a new filename for animations: {files}")
-
-    dirname: Path = files[0].parent
-    ext = files[0].suffix
-
-    basenames = (file.stem for file in files)
-
-    basenames_str = ",".join(f"{len(b)}:{b}" for b in basenames)
-
-    # We use hashes to prevent too-long filenames, see issue #123:
-    # https://github.com/jeertmans/manim-slides/issues/123
-    basename = hashlib.sha256(basenames_str.encode()).hexdigest()
-
-    return dirname.joinpath(basename + ext)
+Receiver = Callable[..., Any]
 
 
-class Key(BaseModel):  # type: ignore
+class Signal(BaseModel):  # type: ignore[misc]
+    __receivers: List[Receiver] = PrivateAttr(default_factory=list)
+
+    def connect(self, receiver: Receiver) -> None:
+        self.__receivers.append(receiver)
+
+    def disconnect(self, receiver: Receiver) -> None:
+        self.__receivers.remove(receiver)
+
+    def emit(self, *args: Any) -> None:
+        for receiver in self.__receivers:
+            receiver(*args)
+
+
+class Key(BaseModel):  # type: ignore[misc]
     """Represents a list of key codes, with optionally a name."""
 
     ids: List[PositiveInt] = Field(unique=True)
     name: Optional[str] = None
 
+    __signal: Signal = PrivateAttr(default_factory=Signal)
+
     @field_validator("ids")
     @classmethod
     def ids_is_non_empty_set(cls, ids: Set[Any]) -> Set[Any]:
@@ -67,14 +61,22 @@ class Key(BaseModel):  # type: ignore
 
         return m
 
+    @property
+    def signal(self) -> Signal:
+        return self.__signal
 
-class Keys(BaseModel):  # type: ignore
+    def connect(self, function: Receiver) -> None:
+        self.__signal.connect(function)
+
+
+class Keys(BaseModel):  # type: ignore[misc]
     QUIT: Key = Key(ids=[Qt.Key_Q], name="QUIT")
-    CONTINUE: Key = Key(ids=[Qt.Key_Right], name="CONTINUE / NEXT")
-    BACK: Key = Key(ids=[Qt.Key_Left], name="BACK")
-    REVERSE: Key = Key(ids=[Qt.Key_V], name="REVERSE")
-    REWIND: Key = Key(ids=[Qt.Key_R], name="REWIND")
     PLAY_PAUSE: Key = Key(ids=[Qt.Key_Space], name="PLAY / PAUSE")
+    NEXT: Key = Key(ids=[Qt.Key_Right], name="NEXT")
+    PREVIOUS: Key = Key(ids=[Qt.Key_Left], name="PREVIOUS")
+    REVERSE: Key = Key(ids=[Qt.Key_V], name="REVERSE")
+    REPLAY: Key = Key(ids=[Qt.Key_R], name="REPLAY")
+    FULL_SCREEN: Key = Key(ids=[Qt.Key_F], name="TOGGLE FULL SCREEN")
     HIDE_MOUSE: Key = Key(ids=[Qt.Key_H], name="HIDE / SHOW MOUSE")
 
     @model_validator(mode="before")
@@ -98,8 +100,21 @@ class Keys(BaseModel):  # type: ignore
 
         return self
 
+    def dispatch_key_function(self) -> Callable[[PositiveInt], None]:
+        _dispatch = {}
 
-class Config(BaseModel):  # type: ignore
+        for _, key in self:
+            for _id in key.ids:
+                _dispatch[_id] = key.signal
+
+        def dispatch(key: PositiveInt) -> None:
+            if signal := _dispatch.get(key, None):
+                signal.emit()
+
+        return dispatch
+
+
+class Config(BaseModel):  # type: ignore[misc]
     """General Manim Slides config"""
 
     keys: Keys = Keys()
@@ -118,18 +133,10 @@ class Config(BaseModel):  # type: ignore
         return self
 
 
-class SlideType(str, Enum):
-    slide = "slide"
-    loop = "loop"
-    last = "last"
-
-
-class SlideConfig(BaseModel):  # type: ignore
-    type: SlideType
+class PreSlideConfig(BaseModel):  # type: ignore
     start_animation: int
     end_animation: int
-    number: int
-    terminated: bool = Field(False, exclude=True)
+    loop: bool = False
 
     @field_validator("start_animation", "end_animation")
     @classmethod
@@ -138,19 +145,12 @@ class SlideConfig(BaseModel):  # type: ignore
             raise ValueError("Animation index (start or end) cannot be negative")
         return v
 
-    @field_validator("number")
-    @classmethod
-    def number_is_strictly_posint(cls, v: int) -> int:
-        if v <= 0:
-            raise ValueError("Slide number cannot be negative or zero")
-        return v
-
-    @model_validator(mode="before")
+    @model_validator(mode="after")
     def start_animation_is_before_end(
-        cls, values: Dict[str, Union[SlideType, int, bool]]
-    ) -> Dict[str, Union[SlideType, int, bool]]:
-        if values["start_animation"] >= values["end_animation"]:  # type: ignore
-            if values["start_animation"] == values["end_animation"] == 0:
+        cls, pre_slide_config: "PreSlideConfig"
+    ) -> "PreSlideConfig":
+        if pre_slide_config.start_animation >= pre_slide_config.end_animation:
+            if pre_slide_config.start_animation == pre_slide_config.end_animation == 0:
                 raise ValueError(
                     "You have to play at least one animation (e.g., `self.wait()`) before pausing. If you want to start paused, use the approriate command-line option when presenting. IMPORTANT: when using ManimGL, `self.wait()` is not considered to be an animation, so prefer to directly use `self.play(...)`."
                 )
@@ -159,25 +159,27 @@ class SlideConfig(BaseModel):  # type: ignore
                 "Start animation index must be strictly lower than end animation index"
             )
 
-        return values
-
-    def is_slide(self) -> bool:
-        return self.type == SlideType.slide
-
-    def is_loop(self) -> bool:
-        return self.type == SlideType.loop
-
-    def is_last(self) -> bool:
-        return self.type == SlideType.last
+        return pre_slide_config
 
     @property
     def slides_slice(self) -> slice:
         return slice(self.start_animation, self.end_animation)
 
 
-class PresentationConfig(BaseModel):  # type: ignore
+class SlideConfig(BaseModel):  # type: ignore[misc]
+    file: FilePath
+    rev_file: FilePath
+    loop: bool = False
+
+    @classmethod
+    def from_pre_slide_config_and_files(
+        cls, pre_slide_config: PreSlideConfig, file: Path, rev_file: Path
+    ) -> "SlideConfig":
+        return cls(file=file, rev_file=rev_file, loop=pre_slide_config.loop)
+
+
+class PresentationConfig(BaseModel):  # type: ignore[misc]
     slides: List[SlideConfig] = Field(min_length=1)
-    files: List[FilePath]
     resolution: Tuple[PositiveInt, PositiveInt] = (1920, 1080)
     background_color: Color = "black"
 
@@ -187,12 +189,15 @@ class PresentationConfig(BaseModel):  # type: ignore
         with open(path, "r") as f:
             obj = json.load(f)
 
-            if files := obj.get("files", None):
-                # First parent is ../slides
-                # so we take the parent of this parent
-                parent = Path(path).parents[1]
-                for i in range(len(files)):
-                    files[i] = parent / files[i]
+            slides = obj.setdefault("slides", [])
+            parent = path.parent.parent  # Never fails, but parents[1] can fail
+
+            for slide in slides:
+                if file := slide.get("file", None):
+                    slide["file"] = parent / file
+
+                if rev_file := slide.get("rev_file", None):
+                    slide["rev_file"] = parent / rev_file
 
             return cls.model_validate(obj)  # type: ignore
 
@@ -201,104 +206,25 @@ class PresentationConfig(BaseModel):  # type: ignore
         with open(path, "w") as f:
             f.write(self.model_dump_json(indent=2))
 
-    @model_validator(mode="after")
-    def animation_indices_match_files(
-        cls, config: "PresentationConfig"
-    ) -> "PresentationConfig":
-        files = config.files
-        slides = config.slides
-
-        n_files = len(files)
-
-        for slide in slides:
-            if slide.end_animation > n_files:
-                raise ValueError(
-                    f"The following slide's contains animations not listed in files {files}: {slide}"
-                )
-
-        return config
-
-    def copy_to(self, dest: Path, use_cached: bool = True) -> "PresentationConfig":
+    def copy_to(self, folder: Path, use_cached: bool = True) -> "PresentationConfig":
         """
         Copy the files to a given directory.
         """
-        n = len(self.files)
-        for i in range(n):
-            file = self.files[i]
-            dest_path = dest / self.files[i].name
-            self.files[i] = dest_path
-            if use_cached and dest_path.exists():
-                logger.debug(f"Skipping copy of {file}, using cached copy")
-                continue
-            logger.debug(f"Copying {file} to {dest_path}")
-            shutil.copy(file, dest_path)
+        for slide_config in self.slides:
+            file = slide_config.file
+            rev_file = slide_config.rev_file
 
-        return self
+            dest = folder / file.name
+            rev_dest = folder / rev_file.name
 
-    def concat_animations(
-        self, dest: Optional[Path] = None, use_cached: bool = True
-    ) -> "PresentationConfig":
-        """
-        Concatenate animations such that each slide contains one animation.
-        """
+            slide_config.file = dest
+            slide_config.rev_file = rev_dest
 
-        dest_paths = []
+            if not use_cached or not dest.exists():
+                shutil.copy(file, dest)
 
-        for i, slide_config in enumerate(self.slides):
-            files = self.files[slide_config.slides_slice]
-
-            slide_config.start_animation = i
-            slide_config.end_animation = i + 1
-
-            if len(files) > 1:
-                dest_path = merge_basenames(files)
-                dest_paths.append(dest_path)
-
-                if use_cached and dest_path.exists():
-                    logger.debug(f"Concatenated animations already exist for slide {i}")
-                    continue
-
-                f = tempfile.NamedTemporaryFile(mode="w", delete=False)
-                f.writelines(f"file '{path.absolute()}'\n" for path in files)
-                f.close()
-
-                command: List[str] = [
-                    str(FFMPEG_BIN),
-                    "-f",
-                    "concat",
-                    "-safe",
-                    "0",
-                    "-i",
-                    f.name,
-                    "-c",
-                    "copy",
-                    str(dest_path),
-                    "-y",
-                ]
-                logger.debug(" ".join(command))
-                process = subprocess.Popen(
-                    command, stdout=subprocess.PIPE, stderr=subprocess.PIPE
-                )
-                output, error = process.communicate()
-
-                if output:
-                    logger.debug(output.decode())
-
-                if error:
-                    logger.debug(error.decode())
-
-                if not dest_path.exists():
-                    raise ValueError(
-                        "could not properly concatenate animations, use `-v INFO` for more details"
-                    )
-
-            else:
-                dest_paths.append(files[0])
-
-        self.files = dest_paths
-
-        if dest:
-            return self.copy_to(dest)
+            if not use_cached or not rev_dest.exists():
+                shutil.copy(rev_file, rev_dest)
 
         return self
 

manim_slides/convert.py

@@ -9,12 +9,13 @@ from base64 import b64encode
 from enum import Enum
 from importlib import resources
 from pathlib import Path
-from typing import Any, Callable, Dict, Generator, List, Optional, Type, Union
+from typing import Any, Callable, Dict, List, Optional, Type, Union
 
 import click
 import cv2
 import pptx
 from click import Context, Parameter
+from jinja2 import Template
 from lxml import etree
 from PIL import Image
 from pydantic import (
@@ -29,35 +30,12 @@ from pydantic import (
 from pydantic_core import CoreSchema, core_schema
 from tqdm import tqdm
 
-from . import data
+from . import templates
 from .commons import folder_path_option, verbosity_option
 from .config import PresentationConfig
 from .logger import logger
 from .present import get_scenes_presentation_config
 
-DATA_URI_FIX = r"""
-// Fix found by @t-fritsch on GitHub
-// see: https://github.com/hakimel/reveal.js/discussions/3362#discussioncomment-6651475.
-function fixBase64VideoBackground(event) {
-    // event.previousSlide, event.currentSlide, event.indexh, event.indexv
-    if (event.currentSlide.getAttribute('data-background-video')) {
-        const background = Reveal.getSlideBackground(event.indexh, event.indexv),
-            video = background.querySelector('video'),
-            sources = video.querySelectorAll('source');
-
-        sources.forEach((source, i) => {
-            const src = source.getAttribute('src');
-            if(src.match(/^data:video.*;base64$/)){
-                const nextSrc = sources[i+1]?.getAttribute('src');
-                video.setAttribute('src', `${src},${nextSrc}`);
-            }
-        });
-    }
-}
-Reveal.on( 'ready', fixBase64VideoBackground );
-Reveal.on( 'slidechanged', fixBase64VideoBackground );
-"""
-
 
 def open_with_default(file: Path) -> None:
     system = platform.system()
@@ -86,7 +64,7 @@ def validate_config_option(
     return config
 
 
-def data_uri(file: Path) -> str:
+def file_to_data_uri(file: Path) -> str:
     """
     Reads a video and returns the corresponding data-uri.
     """
@@ -140,43 +118,48 @@ class Str(str):
     def __str__(self) -> str:
         """Ensures that the string is correctly quoted."""
         if self in ["true", "false", "null"]:
-            return super().__str__()
+            return self
         else:
             return f"'{super().__str__()}'"
 
 
+class StrEnum(Enum):
+    def __str__(self) -> str:
+        return str(self.value)
+
+
 Function = str  # Basically, anything
 
 
-class JsTrue(str, Enum):
+class JsTrue(str, StrEnum):
     true = "true"
 
 
-class JsFalse(str, Enum):
+class JsFalse(str, StrEnum):
     false = "false"
 
 
-class JsBool(Str, Enum):  # type: ignore
+class JsBool(Str, StrEnum):  # type: ignore
     true = "true"
     false = "false"
 
 
-class JsNull(Str, Enum):  # type: ignore
+class JsNull(Str, StrEnum):  # type: ignore
     null = "null"
 
 
-class ControlsLayout(Str, Enum):  # type: ignore
+class ControlsLayout(Str, StrEnum):  # type: ignore
     edges = "edges"
     bottom_right = "bottom-right"
 
 
-class ControlsBackArrows(Str, Enum):  # type: ignore
+class ControlsBackArrows(Str, StrEnum):  # type: ignore
     faded = "faded"
     hidden = "hidden"
     visibly = "visibly"
 
 
-class SlideNumber(Str, Enum):  # type: ignore
+class SlideNumber(Str, StrEnum):  # type: ignore
     true = "true"
     false = "false"
     hdotv = "h.v"
@@ -185,24 +168,24 @@ class SlideNumber(Str, Enum):  # type: ignore
     candt = "c/t"
 
 
-class ShowSlideNumber(Str, Enum):  # type: ignore
+class ShowSlideNumber(Str, StrEnum):  # type: ignore
     all = "all"
     print = "print"
     speaker = "speaker"
 
 
-class KeyboardCondition(Str, Enum):  # type: ignore
+class KeyboardCondition(Str, StrEnum):  # type: ignore
     null = "null"
     focused = "focused"
 
 
-class NavigationMode(Str, Enum):  # type: ignore
+class NavigationMode(Str, StrEnum):  # type: ignore
     default = "default"
     linear = "linear"
     grid = "grid"
 
 
-class AutoPlayMedia(Str, Enum):  # type: ignore
+class AutoPlayMedia(Str, StrEnum):  # type: ignore
     null = "null"
     true = "true"
     false = "false"
@@ -211,25 +194,25 @@ class AutoPlayMedia(Str, Enum):  # type: ignore
 PreloadIframes = AutoPlayMedia
 
 
-class AutoAnimateMatcher(Str, Enum):  # type: ignore
+class AutoAnimateMatcher(Str, StrEnum):  # type: ignore
     null = "null"
 
 
-class AutoAnimateEasing(Str, Enum):  # type: ignore
+class AutoAnimateEasing(Str, StrEnum):  # type: ignore
     ease = "ease"
 
 
 AutoSlide = Union[PositiveInt, JsFalse]
 
 
-class AutoSlideMethod(Str, Enum):  # type: ignore
+class AutoSlideMethod(Str, StrEnum):  # type: ignore
     null = "null"
 
 
 MouseWheel = Union[JsNull, float]
 
 
-class Transition(Str, Enum):  # type: ignore
+class Transition(Str, StrEnum):  # type: ignore
     none = "none"
     fade = "fade"
     slide = "slide"
@@ -238,13 +221,13 @@ class Transition(Str, Enum):  # type: ignore
     zoom = "zoom"
 
 
-class TransitionSpeed(Str, Enum):  # type: ignore
+class TransitionSpeed(Str, StrEnum):  # type: ignore
     default = "default"
     fast = "fast"
     slow = "slow"
 
 
-class BackgroundSize(Str, Enum):  # type: ignore
+class BackgroundSize(Str, StrEnum):  # type: ignore
     # From: https://developer.mozilla.org/en-US/docs/Web/CSS/background-size
     # TODO: support more background size
     contain = "contain"
@@ -254,11 +237,11 @@ class BackgroundSize(Str, Enum):  # type: ignore
 BackgroundTransition = Transition
 
 
-class Display(Str, Enum):  # type: ignore
+class Display(Str, StrEnum):  # type: ignore
     block = "block"
 
 
-class RevealTheme(str, Enum):
+class RevealTheme(str, StrEnum):
     black = "black"
     white = "white"
     league = "league"
@@ -270,6 +253,9 @@ class RevealTheme(str, Enum):
     soralized = "solarized"
     blood = "blood"
     moon = "moon"
+    black_contrast = "black-contrast"
+    white_contrast = "white-contrast"
+    dracula = "dracula"
 
 
 class RevealJS(Converter):
@@ -353,44 +339,20 @@ class RevealJS(Converter):
     hide_cursor_time: int = 5000
     # Add. options
     background_color: str = "black"  # TODO: use pydantic.color.Color
-    reveal_version: str = "4.4.0"
+    reveal_version: str = "4.6.1"
     reveal_theme: RevealTheme = RevealTheme.black
     title: str = "Manim Slides"
     model_config = ConfigDict(use_enum_values=True, extra="forbid")
 
-    def get_sections_iter(self, assets_dir: Path) -> Generator[str, None, None]:
-        """Generates a sequence of sections, one per slide, that will be included into the html template."""
-        for presentation_config in self.presentation_configs:
-            for slide_config in presentation_config.slides:
-                file = presentation_config.files[slide_config.start_animation]
-
-                logger.debug(f"Writing video section with file {file}")
-
-                if self.data_uri:
-                    file = data_uri(file)
-                else:
-                    file = assets_dir / file.name
-
-                # TODO: document this
-                # Videos are muted because, otherwise, the first slide never plays correctly.
-                # This is due to a restriction in playing audio without the user doing anything.
-                # Later, this might be useful to only mute the first video, or to make it optional.
-                # Read more about this:
-                #   https://developer.mozilla.org/en-US/docs/Web/Media/Autoplay_guide#autoplay_and_autoplay_blocking
-                if slide_config.is_loop():
-                    yield f'<section data-background-size={self.background_size.value} data-background-color="{presentation_config.background_color}" data-background-video="{file}" data-background-video-muted data-background-video-loop></section>'
-                else:
-                    yield f'<section data-background-size={self.background_size.value} data-background-color="{presentation_config.background_color}" data-background-video="{file}" data-background-video-muted></section>'
-
     def load_template(self) -> str:
         """Returns the RevealJS HTML template as a string."""
         if isinstance(self.template, Path):
             return self.template.read_text()
 
         if sys.version_info < (3, 9):
-            return resources.read_text(data, "revealjs_template.html")
+            return resources.read_text(templates, "revealjs.html")
 
-        return resources.files(data).joinpath("revealjs_template.html").read_text()
+        return resources.files(templates).joinpath("revealjs.html").read_text()
 
     def open(self, file: Path) -> bool:
         return webbrowser.open(file.absolute().as_uri())
@@ -399,9 +361,6 @@ class RevealJS(Converter):
         """Converts this configuration into a RevealJS HTML presentation, saved to DEST."""
         if self.data_uri:
             assets_dir = Path("")  # Actually we won't care.
-
-            for presentation_config in self.presentation_configs:
-                presentation_config.concat_animations()
         else:
             dirname = dest.parent
             basename = dest.stem
@@ -417,20 +376,16 @@ class RevealJS(Converter):
             full_assets_dir.mkdir(parents=True, exist_ok=True)
 
             for presentation_config in self.presentation_configs:
-                presentation_config.concat_animations().copy_to(full_assets_dir)
+                presentation_config.copy_to(full_assets_dir)
 
         with open(dest, "w") as f:
-            sections = "".join(self.get_sections_iter(assets_dir))
+            revealjs_template = Template(self.load_template())
 
-            revealjs_template = self.load_template()
+            options = self.dict()
+            options["assets_dir"] = assets_dir
 
-            if self.data_uri:
-                data_uri_fix = DATA_URI_FIX
-            else:
-                data_uri_fix = ""
-
-            content = revealjs_template.format(
-                sections=sections, data_uri_fix=data_uri_fix, **self.dict()
+            content = revealjs_template.render(
+                file_to_data_uri=file_to_data_uri, **options
             )
 
             f.write(content)
@@ -470,15 +425,14 @@ class PDF(Converter):
         images = []
 
         for i, presentation_config in enumerate(self.presentation_configs):
-            presentation_config.concat_animations()
             for slide_config in tqdm(
                 presentation_config.slides,
                 desc=f"Generating video slides for config {i + 1}",
                 leave=False,
             ):
-                file = presentation_config.files[slide_config.start_animation]
-
-                images.append(read_image_from_video_file(file, self.frame_index))
+                images.append(
+                    read_image_from_video_file(slide_config.file, self.frame_index)
+                )
 
         images[0].save(
             dest,
@@ -531,7 +485,7 @@ class PowerPoint(Converter):
             return etree.ElementBase.xpath(el, query, namespaces=nsmap)
 
         def save_first_image_from_video_file(file: Path) -> Optional[str]:
-            cap = cv2.VideoCapture(str(file))
+            cap = cv2.VideoCapture(file.as_posix())
             ret, frame = cap.read()
 
             if ret:
@@ -543,13 +497,12 @@ class PowerPoint(Converter):
                 return None
 
         for i, presentation_config in enumerate(self.presentation_configs):
-            presentation_config.concat_animations()
             for slide_config in tqdm(
                 presentation_config.slides,
                 desc=f"Generating video slides for config {i + 1}",
                 leave=False,
             ):
-                file = presentation_config.files[slide_config.start_animation]
+                file = slide_config.file
 
                 mime_type = mimetypes.guess_type(file)[0]
 

manim_slides/data/revealjs_template.html

@@ -1,290 +0,0 @@
-<!doctype html>
-<html>
-
-  <head>
-    <meta charset="utf-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no">
-
-    <title>{title}</title>
-
-    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/reveal.js/{reveal_version}/reveal.min.css">
-    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/reveal.js/{reveal_version}/theme/{reveal_theme}.min.css">
-
-    <!-- Theme used for syntax highlighting of code -->
-    <!-- <link rel="stylesheet" href="lib/css/zenburn.css"> -->
-    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/styles/zenburn.min.css">
-
-    <!-- <link rel="stylesheet" href="index.css"> -->
-  </head>
-
-  <body>
-    <div class="reveal">
-      <div class="slides">
-        {sections}
-      </div>
-    </div>
-
-    <script src="https://cdnjs.cloudflare.com/ajax/libs/reveal.js/{reveal_version}/reveal.min.js"></script>
-
-    <!-- To include plugins, see: https://revealjs.com/plugins/ -->
-
-    <!-- <script src="index.js"></script> -->
-    <script>
-        Reveal.initialize({{
-           // The "normal" size of the presentation, aspect ratio will
-           // be preserved when the presentation is scaled to fit different
-           // resolutions. Can be specified using percentage units.
-           width: {width},
-           height: {height},
-
-           // Factor of the display size that should remain empty around
-           // the content
-           margin: {margin},
-
-           // Bounds for smallest/largest possible scale to apply to content
-           minScale: {min_scale},
-           maxScale: {max_scale},
-
-           // Display presentation control arrows
-           controls: {controls},
-
-           // Help the user learn the controls by providing hints, for example by
-           // bouncing the down arrow when they first encounter a vertical slide
-           controlsTutorial: {controls_tutorial},
-
-           // Determines where controls appear, "edges" or "bottom-right"
-           controlsLayout: {controls_layout},
-
-           // Visibility rule for backwards navigation arrows; "faded", "hidden"
-           // or "visible"
-           controlsBackArrows: {controls_back_arrows},
-
-           // Display a presentation progress bar
-           progress: {progress},
-
-           // Display the page number of the current slide
-           // - true:    Show slide number
-           // - false:   Hide slide number
-           //
-           // Can optionally be set as a string that specifies the number formatting:
-           // - "h.v":   Horizontal . vertical slide number (default)
-           // - "h/v":   Horizontal / vertical slide number
-           // - "c":   Flattened slide number
-           // - "c/t":   Flattened slide number / total slides
-           //
-           // Alternatively, you can provide a function that returns the slide
-           // number for the current slide. The function should take in a slide
-           // object and return an array with one string [slideNumber] or
-           // three strings [n1,delimiter,n2]. See #formatSlideNumber().
-           slideNumber: {slide_number},
-
-           // Can be used to limit the contexts in which the slide number appears
-           // - "all":      Always show the slide number
-           // - "print":    Only when printing to PDF
-           // - "speaker":  Only in the speaker view
-           showSlideNumber: {show_slide_number},
-
-           // Use 1 based indexing for # links to match slide number (default is zero
-           // based)
-           hashOneBasedIndex: {hash_one_based_index},
-
-           // Add the current slide number to the URL hash so that reloading the
-           // page/copying the URL will return you to the same slide
-           hash: {hash},
-
-           // Flags if we should monitor the hash and change slides accordingly
-           respondToHashChanges: {respond_to_hash_changes},
-
-           // Push each slide change to the browser history.  Implies `hash: true`
-           history: {history},
-
-           // Enable keyboard shortcuts for navigation
-           keyboard: {keyboard},
-
-           // Optional function that blocks keyboard events when retuning false
-           //
-           // If you set this to 'focused', we will only capture keyboard events
-           // for embedded decks when they are in focus
-           keyboardCondition: {keyboard_condition},
-
-           // Disables the default reveal.js slide layout (scaling and centering)
-           // so that you can use custom CSS layout
-           disableLayout: {disable_layout},
-
-           // Enable the slide overview mode
-           overview: {overview},
-
-           // Vertical centering of slides
-           center: {center},
-
-           // Enables touch navigation on devices with touch input
-           touch: {touch},
-
-           // Loop the presentation
-           loop: {loop},
-
-           // Change the presentation direction to be RTL
-           rtl: {rtl},
-
-           // Changes the behavior of our navigation directions.
-           //
-           // "default"
-           // Left/right arrow keys step between horizontal slides, up/down
-           // arrow keys step between vertical slides. Space key steps through
-           // all slides (both horizontal and vertical).
-           //
-           // "linear"
-           // Removes the up/down arrows. Left/right arrows step through all
-           // slides (both horizontal and vertical).
-           //
-           // "grid"
-           // When this is enabled, stepping left/right from a vertical stack
-           // to an adjacent vertical stack will land you at the same vertical
-           // index.
-           //
-           // Consider a deck with six slides ordered in two vertical stacks:
-           // 1.1    2.1
-           // 1.2    2.2
-           // 1.3    2.3
-           //
-           // If you're on slide 1.3 and navigate right, you will normally move
-           // from 1.3 -> 2.1. If "grid" is used, the same navigation takes you
-           // from 1.3 -> 2.3.
-           navigationMode: {navigation_mode},
-
-           // Randomizes the order of slides each time the presentation loads
-           shuffle: {shuffle},
-
-           // Turns fragments on and off globally
-           fragments: {fragments},
-
-           // Flags whether to include the current fragment in the URL,
-           // so that reloading brings you to the same fragment position
-           fragmentInURL: {fragment_in_url},
-
-           // Flags if the presentation is running in an embedded mode,
-           // i.e. contained within a limited portion of the screen
-           embedded: {embedded},
-
-           // Flags if we should show a help overlay when the question-mark
-           // key is pressed
-           help: {help},
-
-           // Flags if it should be possible to pause the presentation (blackout)
-           pause: {pause},
-
-           // Flags if speaker notes should be visible to all viewers
-           showNotes: {show_notes},
-
-           // Global override for autolaying embedded media (video/audio/iframe)
-           // - null:   Media will only autoplay if data-autoplay is present
-           // - true:   All media will autoplay, regardless of individual setting
-           // - false:  No media will autoplay, regardless of individual setting
-           autoPlayMedia: {auto_play_media},
-
-           // Global override for preloading lazy-loaded iframes
-           // - null:   Iframes with data-src AND data-preload will be loaded when within
-           //           the viewDistance, iframes with only data-src will be loaded when visible
-           // - true:   All iframes with data-src will be loaded when within the viewDistance
-           // - false:  All iframes with data-src will be loaded only when visible
-           preloadIframes: {preload_iframes},
-
-           // Can be used to globally disable auto-animation
-           autoAnimate: {auto_animate},
-
-           // Optionally provide a custom element matcher that will be
-           // used to dictate which elements we can animate between.
-           autoAnimateMatcher: {auto_animate_matcher},
-
-           // Default settings for our auto-animate transitions, can be
-           // overridden per-slide or per-element via data arguments
-           autoAnimateEasing: {auto_animate_easing},
-           autoAnimateDuration: {auto_animate_duration},
-           autoAnimateUnmatched: {auto_animate_unmatched},
-
-           // CSS properties that can be auto-animated. Position & scale
-           // is matched separately so there's no need to include styles
-           // like top/right/bottom/left, width/height or margin.
-           autoAnimateStyles: {auto_animate_styles},
-
-           // Controls automatic progression to the next slide
-           // - 0:      Auto-sliding only happens if the data-autoslide HTML attribute
-           //           is present on the current slide or fragment
-           // - 1+:     All slides will progress automatically at the given interval
-           // - false:  No auto-sliding, even if data-autoslide is present
-           autoSlide: {auto_slide},
-
-           // Stop auto-sliding after user input
-           autoSlideStoppable: {auto_slide_stoppable},
-
-           // Use this method for navigation when auto-sliding (defaults to navigateNext)
-           autoSlideMethod: {auto_slide_method},
-
-           // Specify the average time in seconds that you think you will spend
-           // presenting each slide. This is used to show a pacing timer in the
-           // speaker view
-           defaultTiming: {default_timing},
-
-           // Enable slide navigation via mouse wheel
-           mouseWheel: {mouse_wheel},
-
-           // Opens links in an iframe preview overlay
-           // Add `data-preview-link` and `data-preview-link="false"` to customise each link
-           // individually
-           previewLinks: {preview_links},
-
-           // Exposes the reveal.js API through window.postMessage
-           postMessage: {post_message},
-
-           // Dispatches all reveal.js events to the parent window through postMessage
-           postMessageEvents: {post_message_events},
-
-           // Focuses body when page changes visibility to ensure keyboard shortcuts work
-           focusBodyOnPageVisibilityChange: {focus_body_on_page_visibility_change},
-
-           // Transition style
-           transition: {transition}, // none/fade/slide/convex/concave/zoom
-
-           // Transition speed
-           transitionSpeed: {transition_speed}, // default/fast/slow
-
-           // Transition style for full page slide backgrounds
-           backgroundTransition: {background_transition}, // none/fade/slide/convex/concave/zoom
-
-           // The maximum number of pages a single slide can expand onto when printing
-           // to PDF, unlimited by default
-           pdfMaxPagesPerSlide: {pdf_max_pages_per_slide},
-
-           // Prints each fragment on a separate slide
-           pdfSeparateFragments: {pdf_separate_fragments},
-
-           // Offset used to reduce the height of content within exported PDF pages.
-           // This exists to account for environment differences based on how you
-           // print to PDF. CLI printing options, like phantomjs and wkpdf, can end
-           // on precisely the total height of the document whereas in-browser
-           // printing has to end one pixel before.
-           pdfPageHeightOffset: {pdf_page_height_offset},
-
-           // Number of slides away from the current that are visible
-           viewDistance: {view_distance},
-
-           // Number of slides away from the current that are visible on mobile
-           // devices. It is advisable to set this to a lower number than
-           // viewDistance in order to save resources.
-           mobileViewDistance: {mobile_view_distance},
-
-           // The display mode that will be used to show slides
-           display: {display},
-
-           // Hide cursor if inactive
-           hideInactiveCursor: {hide_inactive_cursor},
-
-           // Time before the cursor is hidden (in ms)
-           hideCursorTime: {hide_cursor_time}
-        }});
-
-        {data_uri_fix}
-    </script>
-  </body>
-
-</html>

manim_slides/docs/manim_slides_directive.py

@@ -1,6 +1,6 @@
 # type: ignore
 r"""
-A directive for including Manim slides in a Sphinx document
+A directive for including Manim Slides in a Sphinx document
 ===========================================================
 
 .. warning::
@@ -70,12 +70,25 @@ render scenes that are defined within doctests, for example::
         ...     def construct(self):
         ...         self.play(Create(dot))
 
+A third application is to render scenes from another specific file::
+
+    .. manim-slides:: file.py:FileExample
+        :hide_source:
+        :quality: high
+
+.. warning::
+
+    The code will be executed with the current working directory
+    being the same as the one containing the source file. This being said,
+    you should probably not include examples that rely on external files, since
+    relative paths risk to be broken.
+
 Options
 -------
 
 Options can be passed as follows::
 
-    .. manim-slides:: <Class name>
+    .. manim-slides:: <file>:<Class name>
         :<option name>: <value>
 
 The following configuration options are supported by the
@@ -110,6 +123,7 @@ import re
 import sys
 from pathlib import Path
 from timeit import timeit
+from typing import Tuple
 
 import jinja2
 from docutils import nodes
@@ -211,7 +225,17 @@ class ManimSlidesDirective(Directive):
 
         global classnamedict
 
-        clsname = self.arguments[0]
+        def split_file_cls(arg: str) -> Tuple[Path, str]:
+            if ":" in arg:
+                file, cls = arg.split(":", maxsplit=1)
+                _, file = self.state.document.settings.env.relfn2path(file)
+                return Path(file), cls
+            else:
+                return None, arg
+
+        arguments = [split_file_cls(arg) for arg in self.arguments]
+
+        clsname = arguments[0][1]
         if clsname not in classnamedict:
             classnamedict[clsname] = 1
         else:
@@ -271,20 +295,24 @@ class ManimSlidesDirective(Directive):
             "output_file": output_file,
         }
 
-        user_code = self.content
+        if file := arguments[0][0]:
+            user_code = file.absolute().read_text().splitlines()
+        else:
+            user_code = self.content
+
         if user_code[0].startswith(">>> "):  # check whether block comes from doctest
             user_code = [
                 line[4:] for line in user_code if line.startswith((">>> ", "... "))
             ]
 
         code = [
-            "from manim import *",
             *user_code,
             f"{clsname}().render()",
         ]
 
         try:
             with tempconfig(example_config):
+                print(f"Rendering {clsname}...")
                 run_time = timeit(lambda: exec("\n".join(code), globals()), number=1)
                 video_dir = config.get_dir("video_dir")
         except Exception as e:
@@ -306,9 +334,6 @@ class ManimSlidesDirective(Directive):
         RevealJS(presentation_configs=presentation_configs, controls="true").convert_to(
             destfile
         )
-        # shutil.copyfile(filesrc, destfile)
-
-        print("CLASS NAME:", clsname)
 
         rendered_template = jinja2.Template(TEMPLATE).render(
             clsname=clsname,
@@ -400,6 +425,7 @@ TEMPLATE = r"""
 
 .. raw:: html
 
+    <!-- From: https://faq.dailymotion.com/hc/en-us/articles/360022841393-How-to-preserve-the-player-aspect-ratio-on-a-responsive-page -->
 
     <div style="position:relative;padding-bottom:56.25%;">
         <iframe

manim_slides/logger.py

@@ -7,7 +7,6 @@ import logging
 
 from rich.console import Console
 from rich.logging import RichHandler
-from rich.theme import Theme
 
 __all__ = ["logger", "make_logger"]
 
@@ -36,9 +35,8 @@ def make_logger() -> logging.Logger:
     RichHandler.KEYWORDS = HIGHLIGHTED_KEYWORDS
     rich_handler = RichHandler(
         show_time=True,
-        console=Console(theme=Theme({"logging.level.perf": "magenta"})),
+        console=Console(),
     )
-    logging.addLevelName(5, "PERF")
     logger = logging.getLogger("manim-slides")
     logger.setLevel(logging.getLogger("manim").level)
     logger.addHandler(rich_handler)

manim_slides/present/__init__.py

@@ -0,0 +1,303 @@
+import signal
+import sys
+from pathlib import Path
+from typing import List, Optional, Tuple
+
+import click
+from click import Context, Parameter
+from pydantic import ValidationError
+from PySide6.QtCore import Qt
+from PySide6.QtWidgets import QApplication
+
+from ..commons import config_path_option, folder_path_option, verbosity_option
+from ..config import Config, PresentationConfig
+from ..logger import logger
+from .player import Player
+
+ASPECT_RATIO_MODES = {
+    "keep": Qt.KeepAspectRatio,
+    "ignore": Qt.IgnoreAspectRatio,
+}
+
+
+@click.command()
+@folder_path_option
+@click.help_option("-h", "--help")
+@verbosity_option
+def list_scenes(folder: Path) -> None:
+    """List available scenes."""
+
+    for i, scene in enumerate(_list_scenes(folder), start=1):
+        click.secho(f"{i}: {scene}", fg="green")
+
+
+def _list_scenes(folder: Path) -> List[str]:
+    """Lists available scenes in given directory."""
+    scenes = []
+
+    for filepath in folder.glob("*.json"):
+        try:
+            _ = PresentationConfig.from_file(filepath)
+            scenes.append(filepath.stem)
+        except (
+            Exception
+        ) as e:  # Could not parse this file as a proper presentation config
+            logger.warn(
+                f"Something went wrong with parsing presentation config `{filepath}`: {e}"
+            )
+
+    logger.debug(f"Found {len(scenes)} valid scene configuration files in `{folder}`.")
+
+    return scenes
+
+
+def prompt_for_scenes(folder: Path) -> List[str]:
+    """Prompts the user to select scenes within a given folder."""
+
+    scene_choices = dict(enumerate(_list_scenes(folder), start=1))
+
+    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: Optional[str]) -> List[str]:
+        indices = list(map(int, (value or "").strip().replace(" ", "").split(",")))
+
+        if not all(0 < i <= len(scene_choices) for i in indices):
+            raise click.UsageError("Please only enter numbers displayed on the screen.")
+
+        return [scene_choices[i] for i in indices]
+
+    if len(scene_choices) == 0:
+        raise click.UsageError(
+            "No scenes were found, are you in the correct directory?"
+        )
+
+    while True:
+        try:
+            scenes = click.prompt("Choice(s)", value_proc=value_proc)
+            return scenes  # type: ignore
+        except ValueError as e:
+            raise click.UsageError(str(e))
+
+
+def get_scenes_presentation_config(
+    scenes: List[str], folder: Path
+) -> List[PresentationConfig]:
+    """Returns a list of presentation configurations based on the user input."""
+
+    if len(scenes) == 0:
+        scenes = prompt_for_scenes(folder)
+
+    presentation_configs = []
+    for scene in scenes:
+        config_file = folder / f"{scene}.json"
+        if not config_file.exists():
+            raise click.UsageError(
+                f"File {config_file} does not exist, check the scene name and make sure to use Slide as your scene base class"
+            )
+        try:
+            presentation_configs.append(PresentationConfig.from_file(config_file))
+        except ValidationError as e:
+            raise click.UsageError(str(e))
+
+    return presentation_configs
+
+
+def start_at_callback(
+    ctx: Context, param: Parameter, values: str
+) -> Tuple[Optional[int], ...]:
+    if values == "(None, None)":
+        return (None, None)
+
+    def str_to_int_or_none(value: str) -> Optional[int]:
+        if value.lower().strip() == "":
+            return None
+        else:
+            try:
+                return int(value)
+            except ValueError:
+                raise click.BadParameter(
+                    f"start index can only be an integer or an empty string, not `{value}`",
+                    ctx=ctx,
+                    param=param,
+                )
+
+    values_tuple = values.split(",")
+    n_values = len(values_tuple)
+    if n_values == 2:
+        return tuple(map(str_to_int_or_none, values_tuple))
+
+    raise click.BadParameter(
+        f"exactly 2 arguments are expected but you gave {n_values}, please use commas to separate them",
+        ctx=ctx,
+        param=param,
+    )
+
+
+@click.command()
+@click.argument("scenes", nargs=-1)
+@config_path_option
+@folder_path_option
+@click.option("--start-paused", is_flag=True, help="Start paused.")
+@click.option(
+    "-F",
+    "--full-screen",
+    "--fullscreen",
+    "full_screen",
+    is_flag=True,
+    help="Toggle full screen mode.",
+)
+@click.option(
+    "-s",
+    "--skip-all",
+    is_flag=True,
+    help="Skip all slides, useful the test if slides are working. "
+    "Automatically sets `--exit-after-last-slide` to True.",
+)
+@click.option(
+    "--exit-after-last-slide",
+    is_flag=True,
+    help="At the end of last slide, the application will be exited.",
+)
+@click.option(
+    "-H",
+    "--hide-mouse",
+    is_flag=True,
+    help="Hide mouse cursor.",
+)
+@click.option(
+    "--aspect-ratio",
+    type=click.Choice(["keep", "ignore"], case_sensitive=False),
+    default="keep",
+    help="Set the aspect ratio mode to be used when rescaling the video.",
+    show_default=True,
+)
+@click.option(
+    "--sa",
+    "--start-at",
+    "start_at",
+    metavar="<SCENE,SLIDE>",
+    type=str,
+    callback=start_at_callback,
+    default=(None, None),
+    help="Start presenting at (x, y), equivalent to --sacn x --sasn y, "
+    "and overrides values if not None.",
+)
+@click.option(
+    "--sacn",
+    "--start-at-scene-number",
+    "start_at_scene_number",
+    metavar="INDEX",
+    type=int,
+    default=0,
+    help="Start presenting at a given scene number (0 is first, -1 is last).",
+)
+@click.option(
+    "--sasn",
+    "--start-at-slide-number",
+    "start_at_slide_number",
+    metavar="INDEX",
+    type=int,
+    default=0,
+    help="Start presenting at a given slide number (0 is first, -1 is last).",
+)
+@click.option(
+    "-S",
+    "--screen",
+    "screen_number",
+    metavar="NUMBER",
+    type=int,
+    default=None,
+    help="Presents content on the given screen (a.k.a. display).",
+)
+@click.help_option("-h", "--help")
+@verbosity_option
+def present(
+    scenes: List[str],
+    config_path: Path,
+    folder: Path,
+    start_paused: bool,
+    full_screen: bool,
+    skip_all: bool,
+    exit_after_last_slide: bool,
+    hide_mouse: bool,
+    aspect_ratio: str,
+    start_at: Tuple[Optional[int], Optional[int], Optional[int]],
+    start_at_scene_number: int,
+    start_at_slide_number: int,
+    screen_number: Optional[int] = None,
+) -> None:
+    """
+    Present SCENE(s), one at a time, in order.
+
+    Each SCENE parameter must be the name of a Manim scene,
+    with existing SCENE.json config file.
+
+    You can present the same SCENE multiple times by repeating the parameter.
+
+    Use ``manim-slide list-scenes`` to list all available
+    scenes in a given folder.
+    """
+
+    if skip_all:
+        exit_after_last_slide = True
+
+    presentation_configs = get_scenes_presentation_config(scenes, folder)
+
+    if config_path.exists():
+        try:
+            config = Config.from_file(config_path)
+        except ValidationError as e:
+            raise click.UsageError(str(e))
+    else:
+        logger.debug("No configuration file found, using default configuration.")
+        config = Config()
+
+    if start_at[0]:
+        start_at_scene_number = start_at[0]
+
+    if start_at[1]:
+        start_at_scene_number = start_at[1]
+
+    if maybe_app := QApplication.instance():
+        app = maybe_app
+    else:
+        app = QApplication(sys.argv)
+
+    app.setApplicationName("Manim Slides")
+
+    if screen_number is not None:
+        try:
+            screen = app.screens()[screen_number]
+        except IndexError:
+            logger.error(
+                f"Invalid screen number {screen_number}, "
+                f"allowed values are from 0 to {len(app.screens())-1} (incl.)"
+            )
+            screen = None
+    else:
+        screen = None
+
+    player = Player(
+        config,
+        presentation_configs,
+        start_paused=start_paused,
+        full_screen=full_screen,
+        skip_all=skip_all,
+        exit_after_last_slide=exit_after_last_slide,
+        hide_mouse=hide_mouse,
+        aspect_ratio_mode=ASPECT_RATIO_MODES[aspect_ratio],
+        presentation_index=start_at_scene_number,
+        slide_index=start_at_slide_number,
+        screen=screen,
+    )
+
+    player.show()
+
+    signal.signal(signal.SIGINT, signal.SIG_DFL)
+    sys.exit(app.exec_())

manim_slides/present/player.py

@@ -0,0 +1,346 @@
+from pathlib import Path
+from typing import Any, List, Optional
+
+from PySide6.QtCore import Qt, QUrl, Signal, Slot
+from PySide6.QtGui import QCloseEvent, QIcon, QKeyEvent, QScreen
+from PySide6.QtMultimedia import QMediaPlayer
+from PySide6.QtMultimediaWidgets import QVideoWidget
+from PySide6.QtWidgets import QDialog, QGridLayout, QLabel, QMainWindow
+
+from ..config import Config, PresentationConfig, SlideConfig
+from ..logger import logger
+from ..resources import *  # noqa: F401, F403
+
+WINDOW_NAME = "Manim Slides"
+
+
+class Info(QDialog):  # type: ignore[misc]
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+
+        layout = QGridLayout()
+        self.scene_label = QLabel()
+        self.slide_label = QLabel()
+
+        layout.addWidget(QLabel("Scene:"), 1, 1)
+        layout.addWidget(QLabel("Slide:"), 2, 1)
+        layout.addWidget(self.scene_label, 1, 2)
+        layout.addWidget(self.slide_label, 2, 2)
+        self.setLayout(layout)
+        self.setFixedWidth(150)
+        self.setFixedHeight(80)
+
+        if parent := self.parent():
+            self.closeEvent = parent.closeEvent
+            self.keyPressEvent = parent.keyPressEvent
+
+
+class Player(QMainWindow):  # type: ignore[misc]
+    presentation_changed: Signal = Signal()
+    slide_changed: Signal = Signal()
+
+    def __init__(
+        self,
+        config: Config,
+        presentation_configs: List[PresentationConfig],
+        *,
+        start_paused: bool = False,
+        full_screen: bool = False,
+        skip_all: bool = False,
+        exit_after_last_slide: bool = False,
+        hide_mouse: bool = False,
+        aspect_ratio_mode: Qt.AspectRatioMode = Qt.KeepAspectRatio,
+        presentation_index: int = 0,
+        slide_index: int = 0,
+        screen: Optional[QScreen] = None,
+    ):
+        super().__init__()
+
+        # Wizard's config
+
+        self.config = config
+
+        # Presentation configs
+
+        self.presentation_configs = presentation_configs
+        self.__current_presentation_index = 0
+        self.__current_slide_index = 0
+        self.__current_file: Path = self.current_slide_config.file
+
+        self.current_presentation_index = presentation_index
+        self.current_slide_index = slide_index
+
+        self.__playing_reversed_slide = False
+
+        # Widgets
+
+        if screen:
+            self.setScreen(screen)
+            self.move(screen.geometry().topLeft())
+
+        if full_screen:
+            self.setWindowState(Qt.WindowFullScreen)
+        else:
+            w, h = self.current_presentation_config.resolution
+            geometry = self.geometry()
+            geometry.setWidth(w)
+            geometry.setHeight(h)
+            self.setGeometry(geometry)
+
+        if hide_mouse:
+            self.setCursor(Qt.BlankCursor)
+
+        self.setWindowTitle(WINDOW_NAME)
+        self.icon = QIcon(":/icon.png")
+        self.setWindowIcon(self.icon)
+
+        self.video_widget = QVideoWidget()
+        self.video_widget.setAspectRatioMode(aspect_ratio_mode)
+        self.setCentralWidget(self.video_widget)
+
+        self.media_player = QMediaPlayer(self)
+        self.media_player.setVideoOutput(self.video_widget)
+
+        self.presentation_changed.connect(self.presentation_changed_callback)
+        self.slide_changed.connect(self.slide_changed_callback)
+
+        self.info = Info(parent=self)
+
+        # Connecting key callbacks
+
+        self.config.keys.QUIT.connect(self.quit)
+        self.config.keys.PLAY_PAUSE.connect(self.play_pause)
+        self.config.keys.NEXT.connect(self.next)
+        self.config.keys.PREVIOUS.connect(self.previous)
+        self.config.keys.REVERSE.connect(self.reverse)
+        self.config.keys.REPLAY.connect(self.replay)
+        self.config.keys.FULL_SCREEN.connect(self.full_screen)
+        self.config.keys.HIDE_MOUSE.connect(self.hide_mouse)
+
+        self.dispatch = self.config.keys.dispatch_key_function()
+
+        # Misc
+
+        self.exit_after_last_slide = exit_after_last_slide
+
+        # Setting-up everything
+
+        if skip_all:
+
+            def media_status_changed(status: QMediaPlayer.MediaStatus) -> None:
+                self.media_player.setLoops(1)  # Otherwise looping slides never end
+                if status == QMediaPlayer.EndOfMedia:
+                    self.load_next_slide()
+
+            self.media_player.mediaStatusChanged.connect(media_status_changed)
+
+        if self.current_slide_config.loop:
+            self.media_player.setLoops(-1)
+
+        self.load_current_media(start_paused=start_paused)
+
+        self.presentation_changed.emit()
+        self.slide_changed.emit()
+
+    """
+    Properties
+    """
+
+    @property
+    def presentations_count(self) -> int:
+        return len(self.presentation_configs)
+
+    @property
+    def current_presentation_index(self) -> int:
+        return self.__current_presentation_index
+
+    @current_presentation_index.setter
+    def current_presentation_index(self, index: int) -> None:
+        if 0 <= index < self.presentations_count:
+            self.__current_presentation_index = index
+        elif -self.presentations_count <= index < 0:
+            self.__current_presentation_index = index + self.presentations_count
+        else:
+            logger.warn(f"Could not set presentation index to {index}")
+            return
+
+        self.presentation_changed.emit()
+
+    @property
+    def current_presentation_config(self) -> PresentationConfig:
+        return self.presentation_configs[self.current_presentation_index]
+
+    @property
+    def current_slides_count(self) -> int:
+        return len(self.current_presentation_config.slides)
+
+    @property
+    def current_slide_index(self) -> int:
+        return self.__current_slide_index
+
+    @current_slide_index.setter
+    def current_slide_index(self, index: int) -> None:
+        if 0 <= index < self.current_slides_count:
+            self.__current_slide_index = index
+        elif -self.current_slides_count <= index < 0:
+            self.__current_slide_index = index + self.current_slides_count
+        else:
+            logger.warn(f"Could not set slide index to {index}")
+            return
+
+        self.slide_changed.emit()
+
+    @property
+    def current_slide_config(self) -> SlideConfig:
+        return self.current_presentation_config.slides[self.current_slide_index]
+
+    @property
+    def current_file(self) -> Path:
+        return self.__current_file
+
+    @current_file.setter
+    def current_file(self, file: Path) -> None:
+        self.__current_file = file
+
+    @property
+    def playing_reversed_slide(self) -> bool:
+        return self.__playing_reversed_slide
+
+    @playing_reversed_slide.setter
+    def playing_reversed_slide(self, playing_reversed_slide: bool) -> None:
+        self.__playing_reversed_slide = playing_reversed_slide
+
+    """
+    Loading slides
+    """
+
+    def load_current_media(self, start_paused: bool = False) -> None:
+        url = QUrl.fromLocalFile(self.current_file)
+        self.media_player.setSource(url)
+
+        if start_paused:
+            self.media_player.pause()
+        else:
+            self.media_player.play()
+
+    def load_current_slide(self) -> None:
+        slide_config = self.current_slide_config
+        self.current_file = slide_config.file
+
+        if slide_config.loop:
+            self.media_player.setLoops(-1)
+        else:
+            self.media_player.setLoops(1)
+
+        self.load_current_media()
+
+    def load_previous_slide(self) -> None:
+        self.playing_reversed_slide = False
+
+        if self.current_slide_index > 0:
+            self.current_slide_index -= 1
+        elif self.current_presentation_index > 0:
+            self.current_presentation_index -= 1
+            self.current_slide_index = self.current_slides_count - 1
+        else:
+            logger.info("No previous slide.")
+            return
+
+        self.load_current_slide()
+
+    def load_next_slide(self) -> None:
+        if self.playing_reversed_slide:
+            self.playing_reversed_slide = False
+        elif self.current_slide_index < self.current_slides_count - 1:
+            self.current_slide_index += 1
+        elif self.current_presentation_index < self.presentations_count - 1:
+            self.current_presentation_index += 1
+            self.current_slide_index = 0
+        elif self.exit_after_last_slide:
+            self.quit()
+        else:
+            logger.info("No more slide to play.")
+            return
+
+        self.load_current_slide()
+
+    def load_reversed_slide(self) -> None:
+        self.playing_reversed_slide = True
+        self.current_file = self.current_slide_config.rev_file
+        self.load_current_media()
+
+    """
+    Key callbacks and slots
+    """
+
+    @Slot()
+    def presentation_changed_callback(self) -> None:
+        index = self.current_presentation_index
+        count = self.presentations_count
+        self.info.scene_label.setText(f"{index+1:4d}/{count:4<d}")
+
+    @Slot()
+    def slide_changed_callback(self) -> None:
+        index = self.current_slide_index
+        count = self.current_slides_count
+        self.info.slide_label.setText(f"{index+1:4d}/{count:4<d}")
+
+    def show(self) -> None:
+        super().show()
+        self.info.show()
+
+    @Slot()
+    def quit(self) -> None:
+        logger.info("Closing gracefully...")
+        self.info.deleteLater()
+        self.deleteLater()
+
+    @Slot()
+    def next(self) -> None:
+        if self.media_player.playbackState() == QMediaPlayer.PausedState:
+            self.media_player.play()
+        else:
+            self.load_next_slide()
+
+    @Slot()
+    def previous(self) -> None:
+        self.load_previous_slide()
+
+    @Slot()
+    def reverse(self) -> None:
+        self.load_reversed_slide()
+
+    @Slot()
+    def replay(self) -> None:
+        self.media_player.setPosition(0)
+        self.media_player.play()
+
+    @Slot()
+    def play_pause(self) -> None:
+        state = self.media_player.playbackState()
+        if state == QMediaPlayer.PausedState:
+            self.media_player.play()
+        elif state == QMediaPlayer.PlayingState:
+            self.media_player.pause()
+
+    @Slot()
+    def full_screen(self) -> None:
+        if self.windowState() == Qt.WindowFullScreen:
+            self.setWindowState(Qt.WindowNoState)
+        else:
+            self.setWindowState(Qt.WindowFullScreen)
+
+    @Slot()
+    def hide_mouse(self) -> None:
+        if self.cursor().shape() == Qt.BlankCursor:
+            self.setCursor(Qt.ArrowCursor)
+        else:
+            self.setCursor(Qt.BlankCursor)
+
+    def closeEvent(self, event: QCloseEvent) -> None:
+        self.quit()
+
+    def keyPressEvent(self, event: QKeyEvent) -> None:
+        key = event.key()
+        self.dispatch(key)
+        event.accept()

manim_slides/slide.py

@@ -1,6 +1,4 @@
 import platform
-import shutil
-import subprocess
 from pathlib import Path
 from typing import (
     Any,
@@ -17,10 +15,9 @@ from warnings import warn
 import numpy as np
 from tqdm import tqdm
 
-from .config import PresentationConfig, SlideConfig, SlideType
+from .config import PresentationConfig, PreSlideConfig, SlideConfig
 from .defaults import FOLDER_PATH
 from .manim import (
-    FFMPEG_BIN,
     LEFT,
     MANIMGL,
     AnimationGroup,
@@ -32,20 +29,7 @@ from .manim import (
     config,
     logger,
 )
-
-
-def reverse_video_file(src: Path, dst: Path) -> None:
-    """Reverses a video file, writting the result to `dst`."""
-    command = [str(FFMPEG_BIN), "-y", "-i", str(src), "-vf", "reverse", str(dst)]
-    logger.debug(" ".join(command))
-    process = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
-    output, error = process.communicate()
-
-    if output:
-        logger.debug(output.decode())
-
-    if error:
-        logger.debug(error.decode())
+from .utils import concatenate_video_files, merge_basenames, reverse_video_file
 
 
 class Slide(Scene):  # type:ignore
@@ -69,7 +53,7 @@ class Slide(Scene):  # type:ignore
         super().__init__(*args, **kwargs)
 
         self.__output_folder: Path = output_folder
-        self.__slides: List[SlideConfig] = []
+        self.__slides: List[PreSlideConfig] = []
         self.__current_slide = 1
         self.__current_animation = 0
         self.__loop_start_animation: Optional[int] = None
@@ -99,7 +83,11 @@ class Slide(Scene):  # type:ignore
         if MANIMGL:
             return self.camera_config["background_color"].hex  # type: ignore
         else:
-            return config["background_color"].hex  # type: ignore
+            color = config["background_color"]
+            if hex_color := getattr(color, "hex", None):
+                return hex_color  # type: ignore
+            else:  # manim>=0.18, see https://github.com/ManimCommunity/manim/pull/3020
+                return color.to_hex()  # type: ignore
 
     @property
     def __resolution(self) -> Tuple[int, int]:
@@ -369,11 +357,9 @@ class Slide(Scene):  # type:ignore
             self.wait(self.wait_time_between_slides)
 
         self.__slides.append(
-            SlideConfig(
-                type=SlideType.slide,
+            PreSlideConfig(
                 start_animation=self.__pause_start_animation,
                 end_animation=self.__current_animation,
-                number=self.__current_slide,
             )
         )
         self.__current_slide += 1
@@ -400,15 +386,13 @@ class Slide(Scene):  # type:ignore
             len(self.__slides) > 0
             and self.__current_animation == self.__slides[-1].end_animation
         ):
-            self.__slides[-1].type = SlideType.last
             return
 
         self.__slides.append(
-            SlideConfig(
-                type=SlideType.last,
+            PreSlideConfig(
                 start_animation=self.__pause_start_animation,
                 end_animation=self.__current_animation,
-                number=self.__current_slide,
+                loop=self.__loop_start_animation is not None,
             )
         )
 
@@ -458,11 +442,10 @@ class Slide(Scene):  # type:ignore
             self.__loop_start_animation is not None
         ), "You have to start a loop before ending it"
         self.__slides.append(
-            SlideConfig(
-                type=SlideType.loop,
+            PreSlideConfig(
                 start_animation=self.__loop_start_animation,
                 end_animation=self.__current_animation,
-                number=self.__current_slide,
+                loop=True,
             )
         )
         self.__current_slide += 1
@@ -484,51 +467,57 @@ class Slide(Scene):  # type:ignore
 
         scene_files_folder.mkdir(parents=True, exist_ok=True)
 
-        files = []
-        for src_file in tqdm(
-            self.__partial_movie_files,
-            desc=f"Copying animation files to '{scene_files_folder}' and generating reversed animations",
-            leave=self.__leave_progress_bar,
-            ascii=True if platform.system() == "Windows" else None,
-            disable=not self.__show_progress_bar,
-        ):
-            if src_file is None and not MANIMGL:
-                # This happens if rendering with -na,b (manim only)
-                # where animations not in [a,b] will be skipped
-                # but animations before a will have a None src_file
-                continue
-
-            dst_file = scene_files_folder / src_file.name
-            rev_file = scene_files_folder / f"{src_file.stem}_reversed{src_file.suffix}"
-
-            # We only copy animation if it was not present
-            if not use_cache or not dst_file.exists():
-                shutil.copyfile(src_file, dst_file)
-
-            # We only reverse video if it was not present
-            if not use_cache or not rev_file.exists():
-                reverse_video_file(src_file, rev_file)
-
-            files.append(dst_file)
+        # When rendering with -na,b (manim only)
+        # the animations not in [a,b] will be skipped,
+        # but animation before a will have a None source file.
+        files: List[Path] = list(filter(None, self.__partial_movie_files))
 
+        # We must filter slides that end before the animation offset
         if offset := self.__start_at_animation_number:
             self.__slides = [
                 slide for slide in self.__slides if slide.end_animation > offset
             ]
-
             for slide in self.__slides:
-                slide.start_animation -= offset
+                slide.start_animation = max(0, slide.start_animation - offset)
                 slide.end_animation -= offset
 
+        slides: List[SlideConfig] = []
+
+        for pre_slide_config in tqdm(
+            self.__slides,
+            desc=f"Concatenating animation files to '{scene_files_folder}' and generating reversed animations",
+            leave=self.__leave_progress_bar,
+            ascii=True if platform.system() == "Windows" else None,
+            disable=not self.__show_progress_bar,
+        ):
+            slide_files = files[pre_slide_config.slides_slice]
+
+            file = merge_basenames(slide_files)
+            dst_file = scene_files_folder / file.name
+            rev_file = scene_files_folder / f"{file.stem}_reversed{file.suffix}"
+
+            # We only concat animations if it was not present
+            if not use_cache or not dst_file.exists():
+                concatenate_video_files(slide_files, dst_file)
+
+            # We only reverse video if it was not present
+            if not use_cache or not rev_file.exists():
+                reverse_video_file(dst_file, rev_file)
+
+            slides.append(
+                SlideConfig.from_pre_slide_config_and_files(
+                    pre_slide_config, dst_file, rev_file
+                )
+            )
+
         logger.info(
-            f"Copied {len(files)} animations to '{scene_files_folder.absolute()}' and generated reversed animations"
+            f"Generated {len(slides)} slides to '{scene_files_folder.absolute()}'"
         )
 
         slide_path = self.__output_folder / f"{scene_name}.json"
 
         PresentationConfig(
-            slides=self.__slides,
-            files=files,
+            slides=slides,
             resolution=self.__resolution,
             background_color=self.__background_color,
         ).to_file(slide_path)

manim_slides/templates/revealjs.html

@@ -0,0 +1,329 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no">
+
+    <title>{{ title }}</title>
+
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/reveal.js/{{ reveal_version }}/reveal.min.css">
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/reveal.js/{{ reveal_version }}/theme/{{ reveal_theme }}.min.css">
+
+    <!-- Theme used for syntax highlighting of code -->
+    <!-- <link rel="stylesheet" href="lib/css/zenburn.css"> -->
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/styles/zenburn.min.css">
+
+    <!-- <link rel="stylesheet" href="index.css"> -->
+  </head>
+
+  <body>
+    <div class="reveal">
+      <div class="slides">
+        {%- for presentation_config in presentation_configs -%}
+          {% set outer_loop = loop %}
+          {%- for slide_config in presentation_config.slides -%}
+            {%- if data_uri -%}
+              {% set file = file_to_data_uri(slide_config.file) %}
+            {%- else -%}
+              {% set file = assets_dir / slide_config.file.name %}
+            {%- endif -%}
+            <section
+              data-background-size={{ background_size }}
+              data-background-color="{{ presentation_config.background_color }}"
+              data-background-video="{{ file }}"
+              {% if loop.index == 1 and outer_loop.index == 1 -%}
+                data-background-video-muted
+              {%- endif -%}
+              {% if slide_config.loop -%}
+                data-background-video-loop
+              {%- endif -%}>
+            </section>
+          {%- endfor -%}
+        {%- endfor -%}
+      </div>
+    </div>
+
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/reveal.js/{{ reveal_version }}/reveal.min.js"></script>
+
+    <!-- To include plugins, see: https://revealjs.com/plugins/ -->
+
+    <!-- <script src="index.js"></script> -->
+    <script>
+      Reveal.initialize({
+        // The "normal" size of the presentation, aspect ratio will
+        // be preserved when the presentation is scaled to fit different
+        // resolutions. Can be specified using percentage units.
+        width: {{ width }},
+        height: {{ height }},
+
+        // Factor of the display size that should remain empty around
+        // the content
+        margin: {{ margin }},
+
+        // Bounds for smallest/largest possible scale to apply to content
+        minScale: {{ min_scale }},
+        maxScale: {{ max_scale }},
+
+        // Display presentation control arrows
+        controls: {{ controls }},
+
+        // Help the user learn the controls by providing hints, for example by
+        // bouncing the down arrow when they first encounter a vertical slide
+        controlsTutorial: {{ controls_tutorial }},
+
+        // Determines where controls appear, "edges" or "bottom-right"
+        controlsLayout: {{ controls_layout }},
+
+        // Visibility rule for backwards navigation arrows; "faded", "hidden"
+        // or "visible"
+        controlsBackArrows: {{ controls_back_arrows }},
+
+        // Display a presentation progress bar
+        progress: {{ progress }},
+
+        // Display the page number of the current slide
+        // - true:    Show slide number
+        // - false:   Hide slide number
+        //
+        // Can optionally be set as a string that specifies the number formatting:
+        // - "h.v":   Horizontal . vertical slide number (default)
+        // - "h/v":   Horizontal / vertical slide number
+        // - "c":   Flattened slide number
+        // - "c/t":   Flattened slide number / total slides
+        //
+        // Alternatively, you can provide a function that returns the slide
+        // number for the current slide. The function should take in a slide
+        // object and return an array with one string [slideNumber] or
+        // three strings [n1,delimiter,n2]. See #formatSlideNumber().
+        slideNumber: {{ slide_number }},
+
+        // Can be used to limit the contexts in which the slide number appears
+        // - "all":      Always show the slide number
+        // - "print":    Only when printing to PDF
+        // - "speaker":  Only in the speaker view
+        showSlideNumber: {{ show_slide_number }},
+
+        // Use 1 based indexing for # links to match slide number (default is zero
+        // based)
+        hashOneBasedIndex: {{ hash_one_based_index }},
+
+        // Add the current slide number to the URL hash so that reloading the
+        // page/copying the URL will return you to the same slide
+        hash: {{ hash }},
+
+        // Flags if we should monitor the hash and change slides accordingly
+        respondToHashChanges: {{ respond_to_hash_changes }},
+
+        // Push each slide change to the browser history.  Implies `hash: true`
+        history: {{ history }},
+
+        // Enable keyboard shortcuts for navigation
+        keyboard: {{ keyboard }},
+
+        // Optional function that blocks keyboard events when retuning false
+        //
+        // If you set this to 'focused', we will only capture keyboard events
+        // for embedded decks when they are in focus
+        keyboardCondition: {{ keyboard_condition }},
+
+        // Disables the default reveal.js slide layout (scaling and centering)
+        // so that you can use custom CSS layout
+        disableLayout: {{ disable_layout }},
+
+        // Enable the slide overview mode
+        overview: {{ overview }},
+
+        // Vertical centering of slides
+        center: {{ center }},
+
+        // Enables touch navigation on devices with touch input
+        touch: {{ touch }},
+
+        // Loop the presentation
+        loop: {{ loop }},
+
+        // Change the presentation direction to be RTL
+        rtl: {{ rtl }},
+
+        // Changes the behavior of our navigation directions.
+        //
+        // "default"
+        // Left/right arrow keys step between horizontal slides, up/down
+        // arrow keys step between vertical slides. Space key steps through
+        // all slides (both horizontal and vertical).
+        //
+        // "linear"
+        // Removes the up/down arrows. Left/right arrows step through all
+        // slides (both horizontal and vertical).
+        //
+        // "grid"
+        // When this is enabled, stepping left/right from a vertical stack
+        // to an adjacent vertical stack will land you at the same vertical
+        // index.
+        //
+        // Consider a deck with six slides ordered in two vertical stacks:
+        // 1.1    2.1
+        // 1.2    2.2
+        // 1.3    2.3
+        //
+        // If you're on slide 1.3 and navigate right, you will normally move
+        // from 1.3 -> 2.1. If "grid" is used, the same navigation takes you
+        // from 1.3 -> 2.3.
+        navigationMode: {{ navigation_mode }},
+
+        // Randomizes the order of slides each time the presentation loads
+        shuffle: {{ shuffle }},
+
+        // Turns fragments on and off globally
+        fragments: {{ fragments }},
+
+        // Flags whether to include the current fragment in the URL,
+        // so that reloading brings you to the same fragment position
+        fragmentInURL: {{ fragment_in_url }},
+
+        // Flags if the presentation is running in an embedded mode,
+        // i.e. contained within a limited portion of the screen
+        embedded: {{ embedded }},
+
+        // Flags if we should show a help overlay when the question-mark
+        // key is pressed
+        help: {{ help }},
+
+        // Flags if it should be possible to pause the presentation (blackout)
+        pause: {{ pause }},
+
+        // Flags if speaker notes should be visible to all viewers
+        showNotes: {{ show_notes }},
+
+        // Global override for autolaying embedded media (video/audio/iframe)
+        // - null:   Media will only autoplay if data-autoplay is present
+        // - true:   All media will autoplay, regardless of individual setting
+        // - false:  No media will autoplay, regardless of individual setting
+        autoPlayMedia: {{ auto_play_media }},
+
+        // Global override for preloading lazy-loaded iframes
+        // - null:   Iframes with data-src AND data-preload will be loaded when within
+        //           the viewDistance, iframes with only data-src will be loaded when visible
+        // - true:   All iframes with data-src will be loaded when within the viewDistance
+        // - false:  All iframes with data-src will be loaded only when visible
+        preloadIframes: {{ preload_iframes }},
+
+        // Can be used to globally disable auto-animation
+        autoAnimate: {{ auto_animate }},
+
+        // Optionally provide a custom element matcher that will be
+        // used to dictate which elements we can animate between.
+        autoAnimateMatcher: {{ auto_animate_matcher }},
+
+        // Default settings for our auto-animate transitions, can be
+        // overridden per-slide or per-element via data arguments
+        autoAnimateEasing: {{ auto_animate_easing }},
+        autoAnimateDuration: {{ auto_animate_duration }},
+        autoAnimateUnmatched: {{ auto_animate_unmatched }},
+
+        // CSS properties that can be auto-animated. Position & scale
+        // is matched separately so there's no need to include styles
+        // like top/right/bottom/left, width/height or margin.
+        autoAnimateStyles: {{ auto_animate_styles }},
+
+        // Controls automatic progression to the next slide
+        // - 0:      Auto-sliding only happens if the data-autoslide HTML attribute
+        //           is present on the current slide or fragment
+        // - 1+:     All slides will progress automatically at the given interval
+        // - false:  No auto-sliding, even if data-autoslide is present
+        autoSlide: {{ auto_slide }},
+
+        // Stop auto-sliding after user input
+        autoSlideStoppable: {{ auto_slide_stoppable }},
+
+        // Use this method for navigation when auto-sliding (defaults to navigateNext)
+        autoSlideMethod: {{ auto_slide_method }},
+
+        // Specify the average time in seconds that you think you will spend
+        // presenting each slide. This is used to show a pacing timer in the
+        // speaker view
+        defaultTiming: {{ default_timing }},
+
+        // Enable slide navigation via mouse wheel
+        mouseWheel: {{ mouse_wheel }},
+
+        // Opens links in an iframe preview overlay
+        // Add `data-preview-link` and `data-preview-link="false"` to customise each link
+        // individually
+        previewLinks: {{ preview_links }},
+
+        // Exposes the reveal.js API through window.postMessage
+        postMessage: {{ post_message }},
+
+        // Dispatches all reveal.js events to the parent window through postMessage
+        postMessageEvents: {{ post_message_events }},
+
+        // Focuses body when page changes visibility to ensure keyboard shortcuts work
+        focusBodyOnPageVisibilityChange: {{ focus_body_on_page_visibility_change }},
+
+        // Transition style
+        transition: {{ transition }}, // none/fade/slide/convex/concave/zoom
+
+        // Transition speed
+        transitionSpeed: {{ transition_speed }}, // default/fast/slow
+
+        // Transition style for full page slide backgrounds
+        backgroundTransition: {{ background_transition }}, // none/fade/slide/convex/concave/zoom
+
+        // The maximum number of pages a single slide can expand onto when printing
+        // to PDF, unlimited by default
+        pdfMaxPagesPerSlide: {{ pdf_max_pages_per_slide }},
+
+        // Prints each fragment on a separate slide
+        pdfSeparateFragments: {{ pdf_separate_fragments }},
+
+        // Offset used to reduce the height of content within exported PDF pages.
+        // This exists to account for environment differences based on how you
+        // print to PDF. CLI printing options, like phantomjs and wkpdf, can end
+        // on precisely the total height of the document whereas in-browser
+        // printing has to end one pixel before.
+        pdfPageHeightOffset: {{ pdf_page_height_offset }},
+
+        // Number of slides away from the current that are visible
+        viewDistance: {{ view_distance }},
+
+        // Number of slides away from the current that are visible on mobile
+        // devices. It is advisable to set this to a lower number than
+        // viewDistance in order to save resources.
+        mobileViewDistance: {{ mobile_view_distance }},
+
+        // The display mode that will be used to show slides
+        display: {{ display }},
+
+        // Hide cursor if inactive
+        hideInactiveCursor: {{ hide_inactive_cursor }},
+
+        // Time before the cursor is hidden (in ms)
+        hideCursorTime: {{ hide_cursor_time }}
+      });
+
+      {% if data_uri %}
+        // Fix found by @t-fritsch on GitHub
+        // see: https://github.com/hakimel/reveal.js/discussions/3362#discussioncomment-6651475.
+        function fixBase64VideoBackground(event) {
+          // event.previousSlide, event.currentSlide, event.indexh, event.indexv
+          if (event.currentSlide.getAttribute('data-background-video')) {
+            const background = Reveal.getSlideBackground(event.indexh, event.indexv),
+              video = background.querySelector('video'),
+              sources = video.querySelectorAll('source');
+
+            sources.forEach((source, i) => {
+              const src = source.getAttribute('src');
+              if(src.match(/^data:video.*;base64$/)) {
+                const nextSrc = sources[i+1]?.getAttribute('src');
+                video.setAttribute('src', `${src},${nextSrc}`);
+              }
+            });
+          }
+        }
+        Reveal.on( 'ready', fixBase64VideoBackground );
+        Reveal.on( 'slidechanged', fixBase64VideoBackground );
+      {% endif %}
+    </script>
+  </body>
+</html>

manim_slides/utils.py

@@ -0,0 +1,80 @@
+import hashlib
+import subprocess
+import tempfile
+from pathlib import Path
+from typing import List
+
+from .manim import FFMPEG_BIN, logger
+
+
+def concatenate_video_files(files: List[Path], dest: Path) -> None:
+    """
+    Concatenate multiple video files into one.
+    """
+
+    f = tempfile.NamedTemporaryFile(mode="w", delete=False)
+    f.writelines(f"file '{path.absolute()}'\n" for path in files)
+    f.close()
+
+    command: List[str] = [
+        str(FFMPEG_BIN),
+        "-f",
+        "concat",
+        "-safe",
+        "0",
+        "-i",
+        f.name,
+        "-c",
+        "copy",
+        str(dest),
+        "-y",
+    ]
+    logger.debug(" ".join(command))
+    process = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+    output, error = process.communicate()
+
+    if output:
+        logger.debug(output.decode())
+
+    if error:
+        logger.debug(error.decode())
+
+    if not dest.exists():
+        raise ValueError(
+            "could not properly concatenate files, use `-v DEBUG` for more details"
+        )
+
+
+def merge_basenames(files: List[Path]) -> Path:
+    """
+    Merge multiple filenames by concatenating basenames.
+    """
+
+    dirname: Path = files[0].parent
+    ext = files[0].suffix
+
+    basenames = list(file.stem for file in files)
+
+    basenames_str = ",".join(f"{len(b)}:{b}" for b in basenames)
+
+    # We use hashes to prevent too-long filenames, see issue #123:
+    # https://github.com/jeertmans/manim-slides/issues/123
+    basename = hashlib.sha256(basenames_str.encode()).hexdigest()
+
+    logger.debug(f"Generated a new basename for basenames: {basenames} -> '{basename}'")
+
+    return dirname.joinpath(basename + ext)
+
+
+def reverse_video_file(src: Path, dst: Path) -> None:
+    """Reverses a video file, writting the result to `dst`."""
+    command = [str(FFMPEG_BIN), "-y", "-i", str(src), "-vf", "reverse", str(dst)]
+    logger.debug(" ".join(command))
+    process = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+    output, error = process.communicate()
+
+    if output:
+        logger.debug(output.decode())
+
+    if error:
+        logger.debug(error.decode())

manim_slides/wizard.py

@@ -72,7 +72,7 @@ class Wizard(QWidget):  # type: ignore
             # Create label for key name information
             label = QLabel()
             key_info = value["name"] or key
-            label.setText(key_info)
+            label.setText(key_info.title())
             self.layout.addWidget(label, i, 0)
 
             # Create button that will pop-up a dialog and ask to input a new key

pyproject.toml

@@ -43,18 +43,17 @@ packages = [
 ]
 readme = "README.md"
 repository = "https://github.com/jeertmans/manim-slides"
-version = "4.16.0"
+version = "5.0.0-rc2"
 
 [tool.poetry.dependencies]
 click = "^8.1.3"
 click-default-group = "^1.2.2"
 docutils = {version = "^0.20.1", optional = true}
 ipython = {version = ">=8.12.2", optional = true}
-jinja2 = {version = "^3.1.2", optional = true}
+jinja2 = "^3.1.2"
 lxml = "^4.9.2"
 manim = {version = "^0.17.3", optional = true}
 manimgl = {version = "^1.6.1", optional = true}
-notebook = {version = "^7.0.2", optional = true}
 numpy = "^1.19"
 opencv-python = "^4.6.0.66"
 pillow = "^9.5.0"
@@ -72,7 +71,7 @@ tqdm = "^4.64.1"
 magic = ["manim", "ipython"]
 manim = ["manim"]
 manimgl = ["manimgl"]
-sphinx-directive = ["docutils", "jinja2", "manim"]
+sphinx-directive = ["docutils", "manim"]
 
 [tool.poetry.group.dev]
 optional = true

tests/conftest.py

@@ -1,13 +1,62 @@
+import random
+import string
 from pathlib import Path
-from typing import Iterator
+from typing import Generator, Iterator, List
 
 import pytest
 
+from manim_slides.config import PresentationConfig
 from manim_slides.logger import make_logger
 
-_ = make_logger()  # This is run so that "PERF" level is created
+_ = make_logger()  # This is run so that logger is created
 
 
 @pytest.fixture
-def folder_path() -> Iterator[Path]:
-    yield (Path(__file__).parent / "slides").resolve()
+def data_folder() -> Iterator[Path]:
+    path = (Path(__file__).parent / "data").resolve()
+    assert path.exists()
+    yield path
+
+
+@pytest.fixture
+def slides_folder(data_folder: Path) -> Iterator[Path]:
+    path = (data_folder / "slides").resolve()
+    assert path.exists()
+    yield path
+
+
+@pytest.fixture
+def slides_file(data_folder: Path) -> Iterator[Path]:
+    path = (data_folder / "slides.py").resolve()
+    assert path.exists()
+    yield path
+
+
+def random_path(
+    length: int = 20,
+    dirname: Path = Path("./media/videos/example"),
+    suffix: str = ".mp4",
+    touch: bool = False,
+) -> Path:
+    basename = "".join(random.choices(string.ascii_letters, k=length))
+
+    filepath = dirname.joinpath(basename + suffix)
+
+    if touch:
+        filepath.touch()
+
+    return filepath
+
+
+@pytest.fixture
+def paths() -> Generator[List[Path], None, None]:
+    random.seed(1234)
+
+    yield [random_path() for _ in range(20)]
+
+
+@pytest.fixture
+def presentation_config(
+    slides_folder: Path,
+) -> Generator[PresentationConfig, None, None]:
+    yield PresentationConfig.from_file(slides_folder / "BasicSlide.json")

tests/data/slides.py

@@ -0,0 +1,24 @@
+# flake8: noqa: F403, F405
+# type: ignore
+from manim import *
+
+from manim_slides import Slide
+
+
+class BasicSlide(Slide):
+    def construct(self):
+        circle = Circle(radius=3, color=BLUE)
+        dot = Dot()
+
+        self.play(GrowFromCenter(circle))
+        self.next_slide()
+
+        self.start_loop()
+        self.play(MoveAlongPath(dot, circle), run_time=2, rate_func=linear)
+        self.wait(2.0)
+        self.end_loop()
+
+        self.play(dot.animate.move_to(ORIGIN))
+        self.next_slide()
+
+        self.play(self.wipe(Group(dot, circle), []))

tests/data/slides/BasicSlide.json

@@ -0,0 +1,29 @@
+{
+  "slides": [
+    {
+      "file": "slides/files/BasicSlide/275756d906c706ca0125660866bb925b8927e2b2589d31a7a578079b70076ef4.mp4",
+      "rev_file": "slides/files/BasicSlide/275756d906c706ca0125660866bb925b8927e2b2589d31a7a578079b70076ef4_reversed.mp4",
+      "loop": false
+    },
+    {
+      "file": "slides/files/BasicSlide/05b94f634a049cd83daa9b47e483183d1ccdbc485687cee79c6ffbd4f02698da.mp4",
+      "rev_file": "slides/files/BasicSlide/05b94f634a049cd83daa9b47e483183d1ccdbc485687cee79c6ffbd4f02698da_reversed.mp4",
+      "loop": true
+    },
+    {
+      "file": "slides/files/BasicSlide/d09707faa0d68c55e98c628c5da51d66c92d0f79ac48647526817c377f843810.mp4",
+      "rev_file": "slides/files/BasicSlide/d09707faa0d68c55e98c628c5da51d66c92d0f79ac48647526817c377f843810_reversed.mp4",
+      "loop": false
+    },
+    {
+      "file": "slides/files/BasicSlide/c10cc5deb3630a8259712288913b2bd6e79d093356d379d518cc929812194bd9.mp4",
+      "rev_file": "slides/files/BasicSlide/c10cc5deb3630a8259712288913b2bd6e79d093356d379d518cc929812194bd9_reversed.mp4",
+      "loop": false
+    }
+  ],
+  "resolution": [
+    854,
+    480
+  ],
+  "background_color": "black"
+}

tests/slides/BasicExample.json

@@ -1,32 +0,0 @@
-{
-  "slides": [
-    {
-      "type": "slide",
-      "start_animation": 0,
-      "end_animation": 1,
-      "number": 1
-    },
-    {
-      "type": "loop",
-      "start_animation": 1,
-      "end_animation": 2,
-      "number": 2
-    },
-    {
-      "type": "last",
-      "start_animation": 2,
-      "end_animation": 3,
-      "number": 3
-    }
-  ],
-  "files": [
-    "slides/files/BasicExample/1413466013_3346521118_223132457.mp4",
-    "slides/files/BasicExample/1672018281_3136302242_2191168284.mp4",
-    "slides/files/BasicExample/1672018281_1369283980_3942561600.mp4"
-  ],
-  "resolution": [
-    1920,
-    1080
-  ],
-  "background_color": "black"
-}

tests/test_commons.py

@@ -95,7 +95,7 @@ def test_folder_path_option() -> None:
 
 @pytest.mark.parametrize(
     ("verbosity",),
-    [("PeRF",), ("DEBUG",), ("info",), ("waRNING",), ("eRRor",), ("CrItIcAl",)],
+    [("DEBUG",), ("info",), ("waRNING",), ("eRRor",), ("CrItIcAl",)],
 )
 def test_valid_verbosity_option(verbosity: str) -> None:
     @click.command()

tests/test_config.py

@@ -1,80 +1,9 @@
-import random
-import string
-import tempfile
-from pathlib import Path
-from typing import Any, Generator, List
+from typing import Any
 
 import pytest
 from pydantic import ValidationError
 
-from manim_slides.config import (
-    Key,
-    PresentationConfig,
-    SlideConfig,
-    SlideType,
-    merge_basenames,
-)
-
-
-def random_path(
-    length: int = 20,
-    dirname: Path = Path("./media/videos/example"),
-    suffix: str = ".mp4",
-    touch: bool = False,
-) -> Path:
-    basename = "".join(random.choices(string.ascii_letters, k=length))
-
-    filepath = dirname.joinpath(basename + suffix)
-
-    if touch:
-        filepath.touch()
-
-    return filepath
-
-
-@pytest.fixture
-def paths() -> Generator[List[Path], None, None]:
-    random.seed(1234)
-
-    yield [random_path() for _ in range(20)]
-
-
-@pytest.fixture
-def presentation_config(paths: List[Path]) -> Generator[PresentationConfig, None, None]:
-    dirname = Path(tempfile.mkdtemp())
-    files = [random_path(dirname=dirname, touch=True) for _ in range(10)]
-
-    slides = [
-        SlideConfig(
-            type=SlideType.slide,
-            start_animation=0,
-            end_animation=5,
-            number=1,
-        ),
-        SlideConfig(
-            type=SlideType.loop,
-            start_animation=5,
-            end_animation=6,
-            number=2,
-        ),
-        SlideConfig(
-            type=SlideType.last,
-            start_animation=6,
-            end_animation=10,
-            number=3,
-        ),
-    ]
-
-    yield PresentationConfig(
-        slides=slides,
-        files=files,
-    )
-
-
-def test_merge_basenames(paths: List[Path]) -> None:
-    path = merge_basenames(paths)
-    assert path.suffix == paths[0].suffix
-    assert path.parent == paths[0].parent
+from manim_slides.config import Key, PresentationConfig
 
 
 class TestKey:

tests/test_convert.py

@@ -1,6 +1,126 @@
+from enum import EnumMeta
+
 import pytest
 
-from manim_slides.convert import PDF, Converter, PowerPoint, RevealJS
+from manim_slides.convert import (
+    PDF,
+    AutoAnimateEasing,
+    AutoAnimateMatcher,
+    AutoPlayMedia,
+    AutoSlideMethod,
+    BackgroundSize,
+    BackgroundTransition,
+    ControlsBackArrows,
+    ControlsLayout,
+    Converter,
+    Display,
+    JsBool,
+    JsFalse,
+    JsNull,
+    JsTrue,
+    KeyboardCondition,
+    NavigationMode,
+    PowerPoint,
+    PreloadIframes,
+    RevealJS,
+    RevealTheme,
+    ShowSlideNumber,
+    SlideNumber,
+    Transition,
+    TransitionSpeed,
+)
+
+
+@pytest.mark.parametrize(
+    ("enum_type",),
+    [
+        (JsTrue,),
+        (JsFalse,),
+        (JsBool,),
+        (JsNull,),
+        (ControlsLayout,),
+        (ControlsBackArrows,),
+        (SlideNumber,),
+        (ShowSlideNumber,),
+        (KeyboardCondition,),
+        (NavigationMode,),
+        (AutoPlayMedia,),
+        (PreloadIframes,),
+        (AutoAnimateMatcher,),
+        (AutoAnimateEasing,),
+        (AutoSlideMethod,),
+        (Transition,),
+        (TransitionSpeed,),
+        (BackgroundSize,),
+        (BackgroundTransition,),
+        (Display,),
+        (RevealTheme,),
+    ],
+)
+def test_format_enum(enum_type: EnumMeta) -> None:
+    for enum in enum_type:  # type: ignore[var-annotated]
+        expected = str(enum)
+        got = f"{enum}"
+
+        assert expected == got
+
+        got = "{enum}".format(enum=enum)
+
+        assert expected == got
+
+        got = format(enum, "")
+
+        assert expected == got
+
+
+@pytest.mark.parametrize(
+    ("enum_type",),
+    [
+        (ControlsLayout,),
+        (ControlsBackArrows,),
+        (SlideNumber,),
+        (ShowSlideNumber,),
+        (KeyboardCondition,),
+        (NavigationMode,),
+        (AutoPlayMedia,),
+        (PreloadIframes,),
+        (AutoAnimateMatcher,),
+        (AutoAnimateEasing,),
+        (AutoSlideMethod,),
+        (Transition,),
+        (TransitionSpeed,),
+        (BackgroundSize,),
+        (BackgroundTransition,),
+        (Display,),
+    ],
+)
+def test_quoted_enum(enum_type: EnumMeta) -> None:
+    for enum in enum_type:  # type: ignore[var-annotated]
+        if enum in ["true", "false", "null"]:
+            continue
+
+        expected = "'" + enum.value + "'"
+        got = str(enum)
+
+        assert expected == got
+
+
+@pytest.mark.parametrize(
+    ("enum_type",),
+    [
+        (JsTrue,),
+        (JsFalse,),
+        (JsBool,),
+        (JsNull,),
+        (RevealTheme,),
+    ],
+)
+def test_unquoted_enum(enum_type: EnumMeta) -> None:
+    for enum in enum_type:  # type: ignore[var-annotated]
+        expected = enum.value
+        got = str(enum)
+
+        assert expected == got
 
 
 class TestConverter:

tests/test_main.py

@@ -16,29 +16,29 @@ def test_help() -> None:
     assert results.exit_code == 0
 
 
-def test_defaults_to_present(folder_path: Path) -> None:
+def test_defaults_to_present(slides_folder: Path) -> None:
     runner = CliRunner()
 
     with runner.isolated_filesystem():
         results = runner.invoke(
-            cli, ["BasicExample", "--folder", str(folder_path), "-s"]
+            cli, ["BasicSlide", "--folder", str(slides_folder), "-s"]
         )
 
         assert results.exit_code == 0
 
 
-def test_present(folder_path: Path) -> None:
+def test_present(slides_folder: Path) -> None:
     runner = CliRunner()
 
     with runner.isolated_filesystem():
         results = runner.invoke(
-            cli, ["present", "BasicExample", "--folder", str(folder_path), "-s"]
+            cli, ["present", "BasicSlide", "--folder", str(slides_folder), "-s"]
         )
 
         assert results.exit_code == 0
 
 
-def test_convert(folder_path: Path) -> None:
+def test_convert(slides_folder: Path) -> None:
     runner = CliRunner()
 
     with runner.isolated_filesystem():
@@ -46,10 +46,10 @@ def test_convert(folder_path: Path) -> None:
             cli,
             [
                 "convert",
-                "BasicExample",
+                "BasicSlide",
                 "basic_example.html",
                 "--folder",
-                str(folder_path),
+                str(slides_folder),
             ],
         )
 
@@ -71,7 +71,7 @@ def test_init() -> None:
         assert results.exit_code == 0
 
 
-def test_list_scenes(folder_path: Path) -> None:
+def test_list_scenes(slides_folder: Path) -> None:
     runner = CliRunner()
 
     with runner.isolated_filesystem():
@@ -80,12 +80,12 @@ def test_list_scenes(folder_path: Path) -> None:
             [
                 "list-scenes",
                 "--folder",
-                str(folder_path),
+                str(slides_folder),
             ],
         )
 
         assert results.exit_code == 0
-        assert "BasicExample" in results.output
+        assert "BasicSlide" in results.output
 
 
 def test_wizard() -> None:

tests/test_slide.py

@@ -1,7 +1,12 @@
+from pathlib import Path
+
 import pytest
+from click.testing import CliRunner
 from manim import Text
+from manim.__main__ import main as cli
 from pydantic import ValidationError
 
+from manim_slides.config import PresentationConfig
 from manim_slides.slide import Slide
 
 
@@ -14,6 +19,41 @@ def assert_construct(cls: type) -> type:
     return Wrapper
 
 
+def test_render_basic_examples(
+    slides_file: Path, presentation_config: PresentationConfig
+) -> None:
+    runner = CliRunner()
+
+    with runner.isolated_filesystem():
+        results = runner.invoke(cli, [str(slides_file), "BasicSlide", "-ql"])
+
+        assert results.exit_code == 0
+
+        local_slides_folder = Path("slides")
+
+        assert local_slides_folder.exists()
+
+        local_config_file = local_slides_folder / "BasicSlide.json"
+
+        assert local_config_file.exists()
+
+        local_presentation_config = PresentationConfig.from_file(local_config_file)
+
+        assert len(local_presentation_config.slides) == len(presentation_config.slides)
+
+        assert (
+            local_presentation_config.background_color
+            == presentation_config.background_color
+        )
+
+        assert (
+            local_presentation_config.background_color
+            == presentation_config.background_color
+        )
+
+        assert local_presentation_config.resolution == presentation_config.resolution
+
+
 class TestSlide:
     @assert_construct
     class TestLoop(Slide):

tests/test_utils.py

@@ -0,0 +1,23 @@
+from pathlib import Path
+from typing import List
+
+from manim_slides.utils import merge_basenames
+
+
+def test_merge_basenames(paths: List[Path]) -> None:
+    path = merge_basenames(paths)
+    assert path.suffix == paths[0].suffix
+    assert path.parent == paths[0].parent
+
+
+def test_merge_basenames_same_with_different_parent_directories(
+    paths: List[Path],
+) -> None:
+    d1 = Path("a/b/c")
+    d2 = Path("d/e/f")
+    p1 = d1 / "one.txt"
+    p2 = d1 / "a/b/c/two.txt"
+    p3 = d2 / "d/e/f/one.txt"
+    p4 = d2 / "d/e/f/two.txt"
+
+    assert merge_basenames([p1, p2]).name == merge_basenames([p3, p4]).name