feat(lib): static image support #554

Soham-47 · 2025-06-29T09:41:38Z

Closes #553

Description

Feature/static image support

Check List

Check all the applicable boxes:

I understand that my contributions needs to pass the checks;
If I created new functions / methods, I documented them and add type hints;
If I modified already existing code, I updated the documentation accordingly;
The title of my pull request is a short description of the requested changes.

Screenshots

Note to reviewers

- Add SlideType enum to distinguish between video and image slides - Add static_image field to BaseSlideConfig with validation - Update BaseSlide._save_slides to handle static images - Add process_static_image utility function - Update Qt player to display static images using QLabel - Update HTML converter to use data-background-image for images - Update PowerPoint converter to use add_picture for images - Add example demonstrating static image usage

for more information, see https://pre-commit.ci

…tartfile

…e subprocess.run with shell=False, and add proper error handling

for more information, see https://pre-commit.ci

jeertmans

Hi @Soham-47, thanks for your PR and efforts!

This is quite some amount of work, and I didn't have time to review everything, but I already had some questions on your work.

Also, I see that tests are currently failing, but I don't know if the PR was already ready to be reviewed or not.

Thanks!

jeertmans · 2025-06-30T08:42:25Z

example_static_image.py

Nice to have examples, but I would rather have them put inside the documentation (so they do not flood the main folder, and can be rendered inside the docs).

jeertmans · 2025-06-30T08:42:55Z

manim_slides/config.py

@@ -209,12 +251,16 @@ def __wrapper__(*args: Any, **kwargs: Any) -> Any:  # noqa: N807
    def apply_dedent_notes(
        self,
    ) -> "BaseSlideConfig":
-        if self.dedent_notes:
+        if self.dedent_notes and self.notes is not None:


Good catch!

jeertmans · 2025-06-30T08:43:08Z

manim_slides/config.py

+    @field_validator("static_image")
+    @classmethod
+    def validate_static_image(cls, v: Any) -> Any:
+        if v is not None and cls.src is not None:
+            raise ValueError("Cannot set both 'src' and 'static_image'")
+        return v


jeertmans · 2025-06-30T08:47:01Z

manim_slides/config.py

+    src: Optional[str] = Field(None, description="Source video file path")
+    static_image: Optional[Union[str, Any]] = Field(
+        None, description="Static image file path or PIL Image object"
+    )
+    loop: bool = Field(False, description="Whether to loop the video")
+    notes: Optional[str] = Field(None, description="Speaker notes for this slide")
+    preload: bool = Field(True, description="Whether to preload the video")
+    aspect_ratio: Optional[float] = Field(None, description="Aspect ratio override")
+    fit: str = Field("contain", description="How to fit the video in the container")
+    background_color: Optional[str] = Field(None, description="Background color")
+    controls: bool = Field(True, description="Whether to show video controls")
+    autoplay: bool = Field(False, description="Whether to autoplay the video")
+    muted: bool = Field(True, description="Whether the video should be muted")
+    volume: float = Field(1.0, description="Video volume (0.0 to 1.0)")
+    playback_rate: float = Field(1.0, description="Video playback rate")
+    start_time: Optional[float] = Field(None, description="Start time in seconds")
+    end_time: Optional[float] = Field(None, description="End time in seconds")
+    poster: Optional[str] = Field(None, description="Poster image for the video")
+    width: Optional[str] = Field(None, description="Video width")
+    height: Optional[str] = Field(None, description="Video height")
+    class_name: Optional[str] = Field(None, description="CSS class name")
+    style: Optional[str] = Field(None, description="CSS style string")
+    data_attributes: Optional[dict[str, str]] = Field(
+        None, description="Additional data attributes"
+    )
+    custom_attributes: Optional[dict[str, str]] = Field(
+        None, description="Additional custom attributes"
+    )


Much of those are HTML-specific variables, which I am not a great fan of to over-complexity the config file format. Maybe it would be better to create subclasses for format-specific configs. E.g., BaseSlideconfig would have three new fields: html_config: HTMLConfig, qt_config: QtConfig and pptx_config: PPTXConfig`. Those class will then be able to hold more fined-grained config options for each type of presentation format.

jeertmans · 2025-06-30T08:48:03Z

manim_slides/config.py

+# Forward reference for PIL Image type
+PILImage = Any  # Will be properly typed when PIL is imported


I think you can use the TYPE_CHECKING + try import trick to have static type checker work with this.

jeertmans · 2025-06-30T08:49:31Z

manim_slides/convert.py

    b64 = b64encode(file.read_bytes()).decode("ascii")
-    mime_type = mimetypes.guess_type(file)[0] or "video/mp4"
+    mime_type = mimetypes.guess_type(file)[0] or "application/octet-stream"


What's the motivation to change this?

jeertmans · 2025-06-30T08:52:37Z

manim_slides/templates/revealjs.html

I see you remove third-person conjugation in some places, but still add third-person in other places. Maybe we should unify this?

The historical reason why it's like that is that it is copied and pasted from RevealJS' docs, which is not really unified.

jeertmans · 2025-06-30T08:53:15Z

static_image.png

Same comment as for the example file: we should put those in the docs' assets.

jeertmans · 2025-06-30T08:53:24Z

static_image2.png

Same as above.

SohamSaha47 and others added 13 commits June 29, 2025 14:31

Add static image support to manim-slides

a7e8a60

chore(fmt): auto fixes from pre-commit.com hooks

61ae225

for more information, see https://pre-commit.ci

Fix linting issues and improve code quality

f05e153

Resolve merge conflicts

96cdee6

Fix missing Union import

1e7bca0

Fix final mypy errors with type ignore comments

a9c7609

chore(fmt): auto fixes from pre-commit.com hooks

c6d0dc8

for more information, see https://pre-commit.ci

Remove unused type ignore comment

563cc57

Resolve merge conflict and remove unused type ignore comment for os.s…

5fcecca

…tartfile

Silence mypy warning for os.startfile with type ignore comment

c4ef635

Fix security issues in open_with_default function: validate paths, us…

e8a476a

…e subprocess.run with shell=False, and add proper error handling

chore(fmt): auto fixes from pre-commit.com hooks

02eb2ca

for more information, see https://pre-commit.ci

jeertmans reviewed Jun 30, 2025

View reviewed changes

jeertmans added enhancement New feature or request html-convert Related to converting to HTML slides pptx-convert Related to converting to PowerPoint slides lib Related to the library (a.k.a. module) qt Related to Qt (or its Python binding) labels Jul 2, 2025

jeertmans changed the title ~~Feature/static image support~~ feat(lib): static image support Jul 2, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat(lib): static image support #554

feat(lib): static image support #554

Uh oh!

Soham-47 commented Jun 29, 2025 •

edited

Loading

Uh oh!

jeertmans left a comment

Uh oh!

jeertmans Jun 30, 2025

Uh oh!

jeertmans Jun 30, 2025

Uh oh!

jeertmans Jun 30, 2025

Uh oh!

jeertmans Jun 30, 2025

Uh oh!

jeertmans Jun 30, 2025

Uh oh!

jeertmans Jun 30, 2025

Uh oh!

jeertmans Jun 30, 2025

Uh oh!

jeertmans Jun 30, 2025

Uh oh!

jeertmans Jun 30, 2025

Uh oh!

Uh oh!

		# Forward reference for PIL Image type
		PILImage = Any # Will be properly typed when PIL is imported

Uh oh!

feat(lib): static image support #554

Are you sure you want to change the base?

feat(lib): static image support #554

Uh oh!

Conversation

Soham-47 commented Jun 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Closes #553

Description

Check List

Screenshots

Note to reviewers

Uh oh!

jeertmans left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Soham-47 commented Jun 29, 2025 •

edited

Loading