Add global flag --transparent-bg to generate output images with transparent background

Signed-off-by: Jacob Stopak <jacob@initialcommit.io>

Author: initialcommit-io

git_sim/__main__.py

@@ -39,6 +39,11 @@ def main(
         "--light-mode",
         help="Enable light-mode with white background",
     ),
+    transparent_bg: bool = typer.Option(
+        settings.transparent_bg,
+        "--transparent-bg",
+        help="Make background transparent",
+    ),
     logo: pathlib.Path = typer.Option(
         settings.logo,
         help="The path to a custom logo to use in the animation intro/outro",
@@ -138,6 +143,7 @@ def main(
     settings.auto_open = auto_open
     settings.img_format = img_format
     settings.light_mode = light_mode
+    settings.transparent_bg = transparent_bg
     settings.logo = logo
     settings.low_quality = low_quality
     settings.max_branches_per_commit = max_branches_per_commit
@@ -183,6 +189,9 @@ def main(
     if settings.light_mode:
         config.background_color = WHITE
 
+    if settings.transparent_bg:
+        settings.img_format = ImgFormat.png
+
     t = datetime.datetime.fromtimestamp(time.time()).strftime("%m-%d-%y_%H-%M-%S")
     config.output_file = "git-sim-" + ctx.invoked_subcommand + "_" + t + ".mp4"
 

git_sim/animations.py

@@ -46,6 +46,18 @@ def handle_animations(scene: Scene) -> None:
             image_file_path = os.path.join(
                 os.path.join(settings.media_dir, "images"), image_file_name
             )
+            if settings.transparent_bg:
+                unsharp_image = cv2.GaussianBlur(image, (0, 0), 3)
+                image = cv2.addWeighted(image, 1.5, unsharp_image, -0.5, 0)
+
+                tmp = cv2.cvtColor(image, cv2.COLOR_BGR2GRAY)
+                if settings.light_mode:
+                    _, alpha = cv2.threshold(tmp, 225, 255, cv2.THRESH_BINARY_INV)
+                else:
+                    _, alpha = cv2.threshold(tmp, 25, 255, cv2.THRESH_BINARY)
+                b, g, r = cv2.split(image)
+                rgba = [b, g, r, alpha]
+                image = cv2.merge(rgba, 4)
             cv2.imwrite(image_file_path, image)
             if (
                 not settings.stdout

git_sim/git_sim_base_command.py

@@ -53,6 +53,12 @@ def __init__(self):
         self.logo = m.ImageMobject(settings.logo)
         self.logo.width = 3
 
+        self.fill_opacity = 0.25
+        self.ref_fill_opacity = 0.25
+        if settings.transparent_bg:
+            self.fill_opacity = 0.5
+            self.ref_fill_opacity = 1.0
+
     def init_repo(self):
         try:
             self.repo = Repo(search_parent_directories=True)
@@ -224,14 +230,14 @@ def get_centers(self):
 
     def draw_commit(self, commit, i, prevCircle, shift=numpy.array([0.0, 0.0, 0.0])):
         if commit == "dark":
-            commitFill = m.WHITE if settings.light_mode else m.BLACK
+            commit_fill = m.WHITE if settings.light_mode else m.BLACK
         elif len(commit.parents) <= 1:
-            commitFill = m.RED
+            commit_fill = m.RED
         else:
-            commitFill = m.GRAY
-
+            commit_fill = m.GRAY
+        
         circle = m.Circle(
-            stroke_color=commitFill, fill_color=commitFill, fill_opacity=0.25
+            stroke_color=commit_fill, fill_color=commit_fill, fill_opacity=self.fill_opacity
         )
         circle.height = 1
 
@@ -363,7 +369,7 @@ def build_commit_id_and_message(self, commit, i):
 
     def draw_head(self, commit, i, commitId):
         if commit.hexsha == self.repo.head.commit.hexsha:
-            headbox = m.Rectangle(color=m.BLUE, fill_color=m.BLUE, fill_opacity=0.25)
+            headbox = m.Rectangle(color=m.BLUE, fill_color=m.BLUE, fill_opacity=self.ref_fill_opacity)
             headbox.width = 1
             headbox.height = 0.4
             if settings.highlight_commit_messages:
@@ -423,7 +429,7 @@ def draw_branch(self, commit, i, make_branches_remote=False):
                 branchRec = m.Rectangle(
                     color=m.GREEN,
                     fill_color=m.GREEN,
-                    fill_opacity=0.25,
+                    fill_opacity=self.ref_fill_opacity,
                     height=0.4,
                     width=branchText.width + 0.25,
                 )
@@ -468,7 +474,7 @@ def draw_tag(self, commit, i):
                     tagRec = m.Rectangle(
                         color=m.YELLOW,
                         fill_color=m.YELLOW,
-                        fill_opacity=0.25,
+                        fill_opacity=self.ref_fill_opacity,
                         height=0.4,
                         width=tagText.width + 0.25,
                     )
@@ -954,7 +960,7 @@ def setup_and_draw_parent(
         draw_arrow=True,
         color=m.RED,
     ):
-        circle = m.Circle(stroke_color=color, fill_color=color, fill_opacity=0.25)
+        circle = m.Circle(stroke_color=color, fill_color=color, fill_opacity=self.ref_fill_opacity)
         circle.height = 1
         circle.next_to(
             self.drawnCommits[child.hexsha],
@@ -1033,7 +1039,7 @@ def draw_ref(self, commit, top, i=0, text="HEAD", color=m.BLUE):
         refbox = m.Rectangle(
             color=color,
             fill_color=color,
-            fill_opacity=0.25,
+            fill_opacity=self.ref_fill_opacity,
             height=0.4,
             width=refText.width + 0.25,
         )

git_sim/settings.py

@@ -26,6 +26,7 @@ class Settings(BaseSettings):
     img_format: ImgFormat = ImgFormat.jpg
     INFO_STRING = "Simulating: git"
     light_mode = False
+    transparent_bg = False
     logo = pathlib.Path(__file__).parent.resolve() / "logo.png"
     low_quality = False
     max_branches_per_commit = 1