ManimCommunity/manim

Remove `pydub` from dependencies

Open

#3968 opened on Oct 20, 2024

View on GitHub
 (7 comments) (2 reactions) (0 assignees)Python (17,820 stars) (1,378 forks)batch import
enhancementhelp wanted

Description

pydub is no longer actively maintained, and is now running into issues with audioop being removed in python 3.13. As such, we should try to remove it from our dependencies and implement the needed features ourselves.

From a quick look through the code, the main features needed to implement are:

  • AudioSegment.silent
  • AudioSegment.overlay
  • AudioSegment.from_file

https://github.com/ManimCommunity/manim/blob/ce1fff645d2b457919933c3f92cb6106fbb9b6a1/manim/scene/scene_file_writer.py#L330-L334

https://github.com/ManimCommunity/manim/blob/ce1fff645d2b457919933c3f92cb6106fbb9b6a1/manim/scene/scene_file_writer.py#L327

https://github.com/ManimCommunity/manim/blob/ce1fff645d2b457919933c3f92cb6106fbb9b6a1/manim/scene/scene_file_writer.py#L370

Contributor guide

Tech stack
python
Domain
backend
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PythonAudio processing basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the usage of pydub in scene file writer.py (lines 327, 330-334, 370). Understand the required AudioSegment.silent, overlay, and from file methods. Research alternatives for Python 3.13 compatibility (e.g., using the 'wave' module or 'librosa'). Implement the three functions, update imports, remove pydub from dependencies, and test with existing animations. Check comments in the issue for any further guidance.