feat: finishing background config + progress bar when downloading video

Author: William9923

background/AssasinCreed.py

@@ -0,0 +1,11 @@
+from background.utils import Background
+
+
+class AssasinCreed(Background):
+    def __init__(self):
+        super().__init__(
+            "https://www.youtube.com/watch?v=pDkH7odN9dc",
+            "assasin_creed.mp4",
+            "Woofioo60",
+            lambda t : ("center", 480 + t)
+        )

background/RocketLeague.py

@@ -7,5 +7,5 @@ def __init__(self):
             "https://www.youtube.com/watch?v=2X9QGY__0II",
             "rocket_league.mp4",
             "Orbital Gameplay",
-            "top"
+            lambda t : ('center', 480 + t)
         )

background/swapper.py

@@ -6,9 +6,10 @@
 from background.Minecraft import Minecraft
 from background.MotorGTA import MotorGTA
 from background.RocketLeague import RocketLeague
+from background.AssasinCreed import AssasinCreed
 from utils.console import print_substep
 
-CHOICE_DIR = {"motor-gta": MotorGTA, "rocket-league": RocketLeague, "minecraft": Minecraft}
+CHOICE_DIR = {"motor-gta": MotorGTA, "rocket-league": RocketLeague, "minecraft": Minecraft, "ac": AssasinCreed}
 
 
 class BackgroundFactory:

background/utils.py

@@ -1,23 +1,26 @@
 from os import listdir, path
 from pathlib import Path
-from pytube import YouTube
+from pytube import YouTube, Stream
+from pytube.cli import on_progress
 from rich.progress import Progress
+from tqdm import tqdm
 from utils.console import print_step, print_substep
 
 class DownloaderProgressBar:
-    def __init__(self):
-        self.bar = Progress(transient=True)
-        self.task = self.bar.add_task("Downloading background video...", total=100)
-        self.p = 0
-    def progress_function(self,stream, chunk, bytes_remaining):
-        percentage = lambda rem, total : (float(rem) / float(total)) * float(100)
-        size = stream.filesize
-        p = 0
-        with self.bar as progress:
-            while p <= 100 and not progress.finished:
-                p = 100.0 - percentage(bytes_remaining, size)
-                progress.update(self.task, advance=p)
-                self.p = p
+    """
+    Show download progress for pytube. 
+    Code ref from StackOverflow. It's so efficient, that it's probably the best way to do it.
+    # Although, it is edited to use less threads.
+    """
+
+    def start(self, video):
+        self.pbar = tqdm(total=video.filesize, unit="bytes")
+        
+    def progress_function(self,stream: Stream, data_chunk: bytes, bytes_remaining: int) -> None:
+        self.pbar.update(len(data_chunk))
+
+    def close(self):
+        self.pbar.close()
 
 def download_background(background_option):
     """Downloads the backgrounds/s video from YouTube."""
@@ -32,13 +35,27 @@ def download_background(background_option):
     print_substep("Downloading the backgrounds videos... please be patient 🙏 ")
     print_substep(f"Downloading {filename} from {uri}")
     pbar = DownloaderProgressBar()
-    YouTube(uri, on_progress_callback=pbar.progress_function).streams.filter(res="1080p").first().download(
+    video = YouTube(uri, on_progress_callback=pbar.progress_function).streams.filter(res="1080p").first()
+    pbar.start(video)
+    video.download(
         "assets/backgrounds", filename=f"{credit}-{filename}"
     )
+    pbar.close()
     print_substep("Background videos downloaded successfully! 🎉", style="bold green")
 
 class Background:
-    def __init__(self, uri, filename, credit, pos):
+    """Calls the given TTS engine to reduce code duplication and allow multiple TTS engines.
+
+    Args:
+        uri             : The URI for the video (Youtube)
+        filename        : The local filename to save the downloaded mp4 video. Must be a valid filename.
+        credit          : The owner of the video.
+        pos (Optional)  : The position of the image clip in the video. Please follow this ref to manipulate image position in the background freely (https://zulko.github.io/moviepy/ref/VideoClip/VideoClip.html?highlight=imageclip#moviepy.video.VideoClip.VideoClip.set_position)
+
+    Notes:
+        Make sure that the Youtube video source must have 1080p options.
+    """
+    def __init__(self, uri, filename, credit, pos="center"):
         self.uri = uri
         self.filename = filename
         self.credit = credit

video_creation/background.py

@@ -36,6 +36,7 @@ def chop_background_video(bg, video_length: int):
     """Generates the background footage to be used in the video and writes it to assets/temp/background.mp4
 
     Args:
+        bg                : Background Obj 
         video_length (int): Length of the clip where the background footage is to be taken out of
     """
 

video_creation/final_video.py

@@ -30,6 +30,7 @@ def make_final_video(bg, number_of_clips: int, length: int):
     """Gathers audio clips, gathers all screenshots, stitches them together and saves the final video to assets/temp
 
     Args:
+        bg (Background): The background object for the final video
         number_of_clips (int): Index to end at when going through the screenshots
         length (int): Length of the video
     """