Move from with_effect to with_effects

moviepy/Clip.py

@@ -9,7 +9,7 @@
 import numpy as np
 import proglog
 
-from typing import Union, List, TYPE_CHECKING
+from typing import List, TYPE_CHECKING
 
 if TYPE_CHECKING:
     from moviepy.Effect import Effect
@@ -185,18 +185,15 @@ def time_transform(self, time_func, apply_to=None, keep_duration=False):
             keep_duration=keep_duration,
         )
 
-    def with_effect(self, effects: Union['Effect', List['Effect']]):
+    def with_effects(self, effects: List['Effect']):
         """Return a copy of the current clip with the effects applied
 
-        >>> new_clip = clip.with_effect(vfx.Resize(0.2, method="bilinear"))
+        >>> new_clip = clip.with_effects([vfx.Resize(0.2, method="bilinear")])
 
         You can also pass multiple effect as a list
 
-        >>> clip.with_effect([vfx.VolumeX(0.5), vfx.Resize(0.3), vfx.Mirrorx()])
+        >>> clip.with_effects([afx.VolumeX(0.5), vfx.Resize(0.3), vfx.Mirrorx()])
         """
-        if not isinstance(effects, list) :
-            effects = [effects]
-
         new_clip = self.copy()
         for effect in effects :
             # We always copy effect before using it, see Effect.copy
@@ -327,7 +324,7 @@ def with_fps(self, fps, change_duration=False):
         if change_duration:
             from moviepy.video.fx.MultiplySpeed import MultiplySpeed
 
-            newclip = self.with_effect(MultiplySpeed(fps / self.fps))
+            newclip = self.with_effects(MultiplySpeed(fps / self.fps))
         else:
             newclip = self.copy()
 
@@ -659,4 +656,4 @@ def __mul__(self, n):
 
         from moviepy.video.fx.Loop import Loop
 
-        return self.with_effect(Loop(n))
+        return self.with_effects(Loop(n))

moviepy/Effect.py

@@ -1,6 +1,5 @@
 from abc import ABCMeta, abstractmethod
 from moviepy.Clip import Clip
-from dataclasses import dataclass
 import copy as _copy
 
 class Effect(metaclass=ABCMeta):

moviepy/__init__.py

@@ -2,13 +2,11 @@
 can be directly imported like `from moviepy import VideoFileClip`.
 
 In particular it loads all effects from the video.fx and audio.fx folders
-and turns them into VideoClip and AudioClip methods, so that instead of
-``clip.fx(vfx.resize, 2)`` or ``vfx.resize(clip, 2)``
-you can write ``clip.resize(2)``.
+and turns them into VideoClip and AudioClip methods, where method name is effect
+name in snake_case preceeded by ``with_``
 """
 
 import inspect
-import copy
 
 from moviepy.audio import fx as afx
 from moviepy.audio.AudioClip import (
@@ -42,23 +40,23 @@
 
 # Black magic to transforms the effects into Clip methods so that
 # they can be called with clip.resize(width=500) instead of
-# clip.with_effect(vfx.Resize(width=500))
+# clip.with_effects([vfx.Resize(width=500)])
 # We use a lot of inspect + closure + setattr + python scope magic 
 audio_fxs = inspect.getmembers(afx, inspect.isclass)
 video_fxs = inspect.getmembers(vfx, inspect.isclass) + audio_fxs
 
 def add_effect_as_method(to_klass, method_name, eklass) :
     def effect_call(clip, *args, **kwargs):
-        return clip.with_effect(eklass(*args, **kwargs).copy())
+        return clip.with_effects([eklass(*args, **kwargs).copy()])
 
     setattr(to_klass, method_name, effect_call)
 
 for name, effect_class in video_fxs :
-    camel_name = re.sub('(?!^)([A-Z]+)', r'_\1', name).lower()
+    camel_name = 'with_' + re.sub('(?!^)([A-Z]+)', r'_\1', name).lower()
     add_effect_as_method(VideoClip, camel_name, effect_class)
 
 for name, effect_class in audio_fxs :
-    camel_name = re.sub('(?!^)([A-Z]+)', r'_\1', name).lower()
+    camel_name = 'with_' + re.sub('(?!^)([A-Z]+)', r'_\1', name).lower()
     add_effect_as_method(AudioClip, camel_name, effect_class)
 
 # Add display in notebook to video and audioclip

moviepy/audio/fx/AudioDelay.py

@@ -34,16 +34,16 @@ class AudioDelay(Effect) :
     --------
 
     >>> from moviepy import *
-    >>> videoclip = AudioFileClip('myaudio.wav').with_effect(
+    >>> videoclip = AudioFileClip('myaudio.wav').with_effects([
     ...     afx.AudioDelay(offset=.2, n_repeats=10, decayment=.2)
-    ... )
+    ... ])
 
     >>> # stereo A note
     >>> make_frame = lambda t: np.array(
     ...     [np.sin(440 * 2 * np.pi * t), np.sin(880 * 2 * np.pi * t)]
     ... ).T
     ... clip = AudioClip(make_frame=make_frame, duration=0.1, fps=44100)
-    ... clip = clip.with_effect(afx.AudioDelay(offset=.2, n_repeats=11, decay=0))
+    ... clip = clip.with_effects([afx.AudioDelay(offset=.2, n_repeats=11, decay=0)])
     """
 
     offset: float = 0.2
@@ -57,7 +57,7 @@ def apply(self, clip: Clip) -> Clip:
             [
                 clip.copy(),
                 *[
-                    clip.with_start((rep + 1) * self.offset).with_effect(MultiplyVolume(decayments[rep + 1]))
+                    clip.with_start((rep + 1) * self.offset).with_effects([MultiplyVolume(decayments[rep + 1])])
                     for rep in range(self.n_repeats)
                 ],
             ]

moviepy/audio/fx/AudioFadeIn.py

@@ -22,7 +22,7 @@ class AudioFadeIn(Effect) :
     --------
 
     >>> clip = VideoFileClip("media/chaplin.mp4")
-    >>> clip.with_effect(AudioFadeIn("00:00:06"))
+    >>> clip.with_effects([vfx.AudioFadeIn("00:00:06")])
     """
 
     duration: float

moviepy/audio/fx/AudioFadeOut.py

@@ -23,7 +23,7 @@ class AudioFadeOut(Effect) :
     --------
 
     >>> clip = VideoFileClip("media/chaplin.mp4")
-    >>> clip.with_effect(afx.AudioFadeOut("00:00:06"))
+    >>> clip.with_effects([afx.AudioFadeOut("00:00:06")])
     """
 
     duration: float

moviepy/audio/fx/AudioLoop.py

@@ -18,7 +18,7 @@ class AudioLoop(Effect) :
     >>> from moviepy import *
     >>> videoclip = VideoFileClip('myvideo.mp4')
     >>> music = AudioFileClip('music.ogg')
-    >>> audio = music.with_effect(afx.AudioLoop(duration=videoclip.duration))
+    >>> audio = music.with_effects([afx.AudioLoop(duration=videoclip.duration)])
     >>> videoclip.with_audio(audio)
 
     """

moviepy/audio/fx/AudioNormalize.py

@@ -16,7 +16,7 @@ class AudioNormalize(Effect) :
     --------
 
     >>> from moviepy import *
-    >>> videoclip = VideoFileClip('myvideo.mp4').with_effect(afx.AudioNormalize())
+    >>> videoclip = VideoFileClip('myvideo.mp4').with_effects([afx.AudioNormalize()])
 
     """
 
@@ -26,4 +26,4 @@ def apply(self, clip: Clip) -> Clip:
         if max_volume == 0:
             return clip
         else:
-            return clip.with_effect(MultiplyVolume(1 / max_volume))
+            return clip.with_effects(MultiplyVolume(1 / max_volume))

moviepy/audio/fx/MultiplyStereoVolume.py

@@ -16,8 +16,8 @@ class MultiplyStereoVolume(Effect) :
 
     >>> from moviepy import AudioFileClip
     >>> music = AudioFileClip('music.ogg')
-    >>> audio_r = music.with_effect(afx.MultiplyStereoVolume(left=0, right=1))  # mute left channel/s
-    >>> audio_h = music.with_effect(afx.MultiplyStereoVolume(left=0.5, right=0.5)))  # half audio
+    >>> audio_r = music.with_effects([afx.MultiplyStereoVolume(left=0, right=1)])  # mute left channel/s
+    >>> audio_h = music.with_effects([afx.MultiplyStereoVolume(left=0.5, right=0.5)])  # half audio
     """
 
     left: float = 1

moviepy/audio/fx/MultiplyVolume.py

@@ -32,11 +32,11 @@ class MultiplyVolume(Effect) :
     >>> from moviepy import AudioFileClip
     >>>
     >>> music = AudioFileClip('music.ogg')
-    >>> doubled_audio_clip = clip.with_effect(MultiplyVolume(2))  # doubles audio volume
-    >>> half_audio_clip = clip.with_effect(MultiplyVolume(0.5))  # half audio
+    >>> doubled_audio_clip = clip.with_effects([afx.MultiplyVolume(2)])  # doubles audio volume
+    >>> half_audio_clip = clip.with_effects([afx.MultiplyVolume(0.5)])  # half audio
     >>>
     >>> # silenced clip during one second at third
-    >>> silenced_clip = clip.with_effect(MultiplyVolume(0, start_time=2, end_time=3))
+    >>> silenced_clip = clip.with_effects([afx.MultiplyVolume(0, start_time=2, end_time=3)])
     """
 
     factor: float

moviepy/decorators.py

@@ -75,22 +75,6 @@ def audio_video_effect(func, effect, clip, *args, **kwargs):
         return clip
     else:
         return func(effect, clip, *args, **kwargs)
-
-@decorator.decorator
-def audio_video_fx(func, clip, *args, **kwargs):
-    """Use an audio function on a video/audio clip.
-
-    This decorator tells that the function func (audioclip -> audioclip)
-    can be also used on a video clip, at which case it returns a
-    videoclip with unmodified video and modified audio.
-    """
-    if hasattr(clip, "audio"):
-        new_clip = clip.copy()
-        if clip.audio is not None:
-            new_clip.audio = func(clip.audio, *args, **kwargs)
-        return new_clip
-    else:
-        return func(clip, *args, **kwargs)
 
 
 def preprocess_args(fun, varnames):

moviepy/video/VideoClip.py

@@ -16,7 +16,10 @@
 import threading
 from moviepy.video.io.ffplay_previewer import ffplay_preview_video
 
-from typing import List
+from typing import Union, List, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from moviepy.Effect import Effect
 
 from moviepy.Clip import Clip
 from moviepy.decorators import (
@@ -618,7 +621,7 @@ def preview(
     # -----------------------------------------------------------------
     # F I L T E R I N G
 
-    def subfx(self, fx, start_time=0, end_time=None, **kwargs):
+    def with_sub_effect(self, effects: List['Effect'], start_time=0, end_time=None, **kwargs):
         """Apply a transformation to a part of the clip.
 
         Returns a new clip in which the function ``fun`` (clip->clip)
@@ -630,11 +633,11 @@ def subfx(self, fx, start_time=0, end_time=None, **kwargs):
 
         >>> # The scene between times t=3s and t=6s in ``clip`` will be
         >>> # be played twice slower in ``new_clip``
-        >>> new_clip = clip.subapply(lambda c:c.multiply_speed(0.5) , 3,6)
+        >>> new_clip = clip.with_sub_effect(MultiplySpeed(0.5), 3, 6)
 
         """
         left = None if (start_time == 0) else self.with_subclip(0, start_time)
-        center = self.with_subclip(start_time, end_time).fx(fx, **kwargs)
+        center = self.with_subclip(start_time, end_time).with_effects(effects, **kwargs)
         right = None if (end_time is None) else self.with_subclip(start_time=end_time)
 
         clips = [clip for clip in [left, center, right] if clip is not None]
@@ -644,6 +647,7 @@ def subfx(self, fx, start_time=0, end_time=None, **kwargs):
 
         return concatenate_videoclips(clips).with_start(self.start)
 
+
     # IMAGE FILTERS
 
     def image_transform(self, image_func, apply_to=None):
@@ -993,7 +997,7 @@ def __matmul__(self, n):
             return NotImplemented
 
         from moviepy.video.fx.Rotate import Rotate
-        return self.with_effect(Rotate(n))
+        return self.with_effects(Rotate(n))
 
     def __and__(self, mask):
         return self.with_mask(mask)

moviepy/video/fx/CrossFadeIn.py

@@ -20,7 +20,7 @@ def apply(self, clip: Clip) -> Clip:
             clip = clip.with_add_mask()
 
         clip.mask.duration = clip.duration
-        clip.mask = clip.mask.with_effect(FadeIn(self.duration))
+        clip.mask = clip.mask.with_effects([FadeIn(self.duration)])
 
         return clip
 

moviepy/video/fx/CrossFadeOut.py

@@ -20,7 +20,7 @@ def apply(self, clip: Clip) -> Clip:
             clip = clip.with_add_mask()
 
         clip.mask.duration = clip.duration
-        clip.mask = clip.mask.with_effect(FadeOut(self.duration))
+        clip.mask = clip.mask.with_effects([FadeOut(self.duration)])
 
         return clip
 

moviepy/video/fx/FreezeRegion.py

@@ -42,7 +42,7 @@ def apply(self, clip: Clip) -> Clip:
         if self.region is not None:
               x1, y1, x2, y2 = self.region
               freeze = (
-                  clip.with_effect(Crop(*self.region))
+                  clip.with_effects(Crop(*self.region))
                   .to_ImageClip(t=self.t)
                   .with_duration(clip.duration)
                   .with_position((x1, y1))
@@ -51,7 +51,7 @@ def apply(self, clip: Clip) -> Clip:
 
         elif self.outside_region is not None:
             x1, y1, x2, y2 = self.outside_region
-            animated_region = clip.with_effect(Crop(*self.outside_region)).with_position((x1, y1))
+            animated_region = clip.with_effects(Crop(*self.outside_region)).with_position((x1, y1))
             freeze = clip.to_ImageClip(t=self.t).with_duration(clip.duration)
             return CompositeVideoClip([freeze, animated_region])
 

moviepy/video/fx/MasksAnd.py

@@ -22,9 +22,9 @@ class MasksAnd(Effect) :
     Examples
     --------
 
-    >>> clip = ColorClip(color=(255, 0, 0), size=(1, 1))  # red
-    >>> mask = ColorClip(color=(0, 255, 0), size=(1, 1))  # green
-    >>> masked_clip = clip.fx(mask_and, mask)             # black
+    >>> clip = ColorClip(color=(255, 0, 0), size=(1, 1))      # red
+    >>> mask = ColorClip(color=(0, 255, 0), size=(1, 1))      # green
+    >>> masked_clip = clip.with_effects([vfx.MasksAnd(mask)]) # black
     >>> masked_clip.get_frame(0)
     [[[0 0 0]]]
     """

moviepy/video/fx/MasksOr.py

@@ -22,9 +22,9 @@ class MasksOr(Effect) :
     Examples
     --------
 
-    >>> clip = ColorClip(color=(255, 0, 0), size=(1, 1))  # red
-    >>> mask = ColorClip(color=(0, 255, 0), size=(1, 1))  # green
-    >>> masked_clip = clip.fx(mask_or, mask)              # yellow
+    >>> clip = ColorClip(color=(255, 0, 0), size=(1, 1))     # red
+    >>> mask = ColorClip(color=(0, 255, 0), size=(1, 1))     # green
+    >>> masked_clip = clip.with_effects([vfx.MasksOr(mask)]) # yellow
     >>> masked_clip.get_frame(0)
     [[[255 255   0]]]
     """

moviepy/video/fx/Resize.py

@@ -29,10 +29,10 @@ def __init__(self, new_size=None, height=None, width=None, apply_to_mask=True) :
         Examples
         --------
 
-        >>> myClip.with_effect(vfx.Resize((460,720))) # New resolution: (460,720)
-        >>> myClip.with_effect(vfx.Resize(0.6)) # width and height multiplied by 0.6
-        >>> myClip.with_effect(vfx.Resize(width=800)) # height computed automatically.
-        >>> myClip.with_effect(vfx.Resize(lambda t : 1+0.02*t)) # slow swelling of the clip
+        >>> myClip.with_effects([vfx.Resize((460,720))]) # New resolution: (460,720)
+        >>> myClip.with_effects([vfx.Resize(0.6)]) # width and height multiplied by 0.6
+        >>> myClip.with_effects([vfx.Resize(width=800)]) # height computed automatically.
+        >>> myClip.with_effects([vfx.Resize(lambda t : 1+0.02*t)]) # slow swelling of the clip
         """
         self.new_size = new_size
         self.height = height
@@ -83,7 +83,7 @@ def filter(get_frame, t):
                     filter, keep_duration=True, apply_to=(["mask"] if self.apply_to_mask else [])
                 )
                 if self.apply_to_mask and clip.mask is not None:
-                    newclip.mask = newclip.mask.with_effect(Resize(clip.mask, self.new_size, apply_to_mask=False))
+                    newclip.mask = newclip.mask.with_effects([Resize(clip.mask, self.new_size, apply_to_mask=False)])
 
                 return newclip
 
@@ -96,7 +96,7 @@ def filter(get_frame, t):
                 def func(t):
                     return 1.0 * int(self.height(t)) / h
 
-                return clip.with_effect(Resize(func))
+                return clip.with_effects(Resize(func))
 
             else:
                 new_size = [w * self.height / h, self.height]
@@ -107,7 +107,7 @@ def func(t):
                 def func(t):
                     return 1.0 * self.width(t) / w
 
-                return clip.with_effect(Resize(func))
+                return clip.with_effects(Resize(func))
 
             else:
                 new_size = [self.width, h * self.width / w]
@@ -128,6 +128,6 @@ def image_filter(pic):
         new_clip = clip.image_transform(image_filter)
 
         if self.apply_to_mask and clip.mask is not None:
-            new_clip.mask = clip.with_effect(Resize(clip.mask, self.new_size, apply_to_mask=False))
+            new_clip.mask = clip.with_effects(Resize(clip.mask, self.new_size, apply_to_mask=False))
 
         return new_clip

moviepy/video/fx/SlideIn.py

@@ -29,15 +29,15 @@ class SlideIn(Effect):
     >>>
     >>> clips = [... make a list of clips]
     >>> slided_clips = [
-    ...     CompositeVideoClip([clip.with_effect(vfx.SlideIn(1, "left"))])
+    ...     CompositeVideoClip([clip.with_effects([vfx.SlideIn(1, "left")])])
     ...     for clip in clips
     ... ]
     >>> final_clip = concatenate_videoclips(slided_clips, padding=-1)
     >>>
     >>> clip = ColorClip(
     ...     color=(255, 0, 0), duration=1, size=(300, 300)
     ... ).with_fps(60)
-    >>> final_clip = CompositeVideoClip([clip.with_effect(vfx.SlideIn(1, "right"))])
+    >>> final_clip = CompositeVideoClip([clip.with_effects([vfx.SlideIn(1, "right")])])
     """
 
     duration: float