initial commit and version 1.0

moviepy/video/fx/FreezeRegion.py

@@ -0,0 +1,68 @@
+from dataclasses import dataclass
+
+from moviepy.Clip import Clip
+from moviepy.Effect import Effect
+from moviepy.video.compositing.CompositeVideoClip import CompositeVideoClip
+from moviepy.video.fx.Crop import Crop
+
+
+@dataclass
+class FreezeRegion(Effect):
+    """Freezes one region of the clip while the rest remains animated.
+
+    You can choose one of three methods by providing either `region`,
+    `outside_region`, or `mask`.
+
+    Parameters
+    ----------
+
+    t
+      Time at which to freeze the freezed region.
+
+    region
+      A tuple (x1, y1, x2, y2) defining the region of the screen (in pixels)
+      which will be freezed. You can provide outside_region or mask instead.
+
+    outside_region
+      A tuple (x1, y1, x2, y2) defining the region of the screen (in pixels)
+      which will be the only non-freezed region.
+
+    mask
+      If not None, will overlay a freezed version of the clip on the current clip,
+      with the provided mask. In other words, the "visible" pixels in the mask
+      indicate the freezed region in the final picture.
+
+    """
+
+    t: float = 0
+    region: tuple = None
+    outside_region: tuple = None
+    mask: Clip = None
+
+    def apply(self, clip: Clip) -> Clip:
+        """Apply the effect to the clip."""
+        if self.region is not None:
+            x1, y1, _x2, _y2 = self.region
+            freeze = (
+                clip.with_effects([Crop(*self.region)])
+                .to_ImageClip(t=self.t)
+                .with_duration(clip.duration)
+                .with_position((x1, y1))
+            )
+            return CompositeVideoClip([clip, freeze])
+
+        elif self.outside_region is not None:
+            x1, y1, x2, y2 = self.outside_region
+            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])
+
+        elif self.mask is not None:
+            freeze = (
+                clip.to_ImageClip(t=self.t)
+                .with_duration(clip.duration)
+                .with_mask(self.mask)
+            )
+            return CompositeVideoClip([clip, freeze])