feat: add dynamic configs for background + progress loader during download process

Author: William9923

background/Minecraft.py

@@ -0,0 +1,11 @@
+from background.utils import Background
+
+
+class Minecraft(Background):
+    def __init__(self):
+        super().__init__(
+            "https://www.youtube.com/watch?v=n_Dv4JMiwK8",
+            "parkour.mp4",
+            "bbswitzer",
+            "center"
+        )

background/MotorGTA.py

@@ -0,0 +1,11 @@
+from background.utils import Background
+
+
+class MotorGTA(Background):
+    def __init__(self):
+        super().__init__(
+            "https://www.youtube.com/watch?v=vw5L4xCPy9Q",
+            "bike-parkour-gta.mp4",
+            "Achy Gaming",
+            lambda t : ('center', 480 + t)
+        )

background/RocketLeague.py

@@ -0,0 +1,11 @@
+from background.utils import Background
+
+
+class RocketLeague(Background):
+    def __init__(self):
+        super().__init__(
+            "https://www.youtube.com/watch?v=2X9QGY__0II",
+            "rocket_league.mp4",
+            "Orbital Gameplay",
+            "top"
+        )

background/__init__.py

@@ -0,0 +1,25 @@
+import imp
+from os import getenv
+
+from dotenv import load_dotenv
+
+from background.Minecraft import Minecraft
+from background.MotorGTA import MotorGTA
+from background.RocketLeague import RocketLeague
+from utils.console import print_substep
+
+CHOICE_DIR = {"motor-gta": MotorGTA, "rocket-league": RocketLeague, "minecraft": Minecraft}
+
+
+class BackgroundFactory:
+    def __new__(cls):
+        load_dotenv()
+        try:
+            CHOICE = getenv("BackgroundChoice").casefold()
+        except AttributeError:
+            print_substep("None (background) defined. Defaulting to 'minecraft.'")
+            CHOICE = "minecraft"
+        valid_keys = [key.lower() for key in CHOICE_DIR.keys()]
+        if CHOICE not in valid_keys:
+            raise ValueError(f"{CHOICE} is not valid. Please use one of these {valid_keys} options")
+        return CHOICE_DIR.get(CHOICE)()

background/swapper.py

@@ -0,0 +1,55 @@
+from os import listdir, path
+from pathlib import Path
+from pytube import YouTube
+from rich.progress import Progress
+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
+
+def download_background(background_option):
+    """Downloads the backgrounds/s video from YouTube."""
+    Path("./assets/backgrounds/").mkdir(parents=True, exist_ok=True)
+    # note: make sure the file name doesn't include an - in it
+    uri, filename, credit = background_option
+    if Path(f"assets/backgrounds/{credit}-{filename}").is_file():
+        return
+    print_step(
+        "We need to download the backgrounds videos. they are fairly large but it's only done once. 😎"
+    )
+    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(
+        "assets/backgrounds", filename=f"{credit}-{filename}"
+    )
+    print_substep("Background videos downloaded successfully! 🎉", style="bold green")
+
+class Background:
+    def __init__(self, uri, filename, credit, pos):
+        self.uri = uri
+        self.filename = filename
+        self.credit = credit
+        self.pos = pos
+
+        option = (self.uri, self.filename, self.credit)
+        download_background(option)
+
+    def get_img_clip_pos(self):
+        return self.pos
+
+    def get_filename(self):
+        return f"{self.credit}-{self.filename}"
+

background/utils.py

@@ -42,9 +42,9 @@ def main():
     reddit_object = get_subreddit_threads()
     length, number_of_comments = save_text_to_mp3(reddit_object)
     download_screenshots_of_reddit_posts(reddit_object, number_of_comments)
-    download_background()
-    chop_background_video(length)
-    make_final_video(number_of_comments, length)
+    bg = download_background()
+    chop_background_video(bg, length)
+    make_final_video(bg, number_of_comments, length)
 
 
 def run_many(times):

main.py

@@ -9,8 +9,10 @@
 
 from utils.console import print_step, print_substep
 
+from background.swapper import BackgroundFactory
 
-def get_start_and_end_times(video_length:int, length_of_clip:int)->tuple[int,int]:
+
+def get_start_and_end_times(video_length: int, length_of_clip: int) -> tuple[int, int]:
     """Generates a random interval of time to be used as the beckground of the video.
 
     Args:
@@ -19,56 +21,32 @@ def get_start_and_end_times(video_length:int, length_of_clip:int)->tuple[int,int
 
     Returns:
         tuple[int,int]: Start and end time of the randomized interval
-    """    
+    """
     random_time = randrange(180, int(length_of_clip) - int(video_length))
     return random_time, random_time + video_length
 
 
 def download_background():
     """Downloads the backgrounds/s video from YouTube."""
-    Path("./assets/backgrounds/").mkdir(parents=True, exist_ok=True)
-    background_options = [  # uri , filename , credit
-        ("https://www.youtube.com/watch?v=n_Dv4JMiwK8", "parkour.mp4", "bbswitzer"),
-        # (
-        #    "https://www.youtube.com/watch?v=2X9QGY__0II",
-        #    "rocket_league.mp4",
-        #    "Orbital Gameplay",
-        # ),
-    ]
-    # note: make sure the file name doesn't include an - in it
-    if not len(listdir("./assets/backgrounds")) >= len(
-            background_options
-    ):  # if there are any background videos not installed
-        print_step(
-            "We need to download the backgrounds videos. they are fairly large but it's only done once. 😎"
-        )
-        print_substep("Downloading the backgrounds videos... please be patient 🙏 ")
-        for uri, filename, credit in background_options:
-            if Path(f"assets/backgrounds/{credit}-{filename}").is_file():
-                continue  # adds check to see if file exists before downloading
-            print_substep(f"Downloading {filename} from {uri}")
-            YouTube(uri).streams.filter(res="1080p").first().download(
-                "assets/backgrounds", filename=f"{credit}-{filename}"
-            )
+    bg = BackgroundFactory()
+    return bg
 
-        print_substep(
-            "Background videos downloaded successfully! 🎉", style="bold green"
-        )
 
-
-def chop_background_video(video_length:int):
+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:
         video_length (int): Length of the clip where the background footage is to be taken out of
-    """    
+    """
+
     print_step("Finding a spot in the backgrounds video to chop...✂️")
-    choice = random.choice(listdir("assets/backgrounds"))
+    choice = bg.get_filename()
     environ["background_credit"] = choice.split("-")[0]
 
     background = VideoFileClip(f"assets/backgrounds/{choice}")
 
-    start_time, end_time = get_start_and_end_times(video_length, background.duration)
+    start_time, end_time = get_start_and_end_times(
+        video_length, background.duration)
     try:
         ffmpeg_extract_subclip(
             f"assets/backgrounds/{choice}",

video_creation/background.py

@@ -20,18 +20,20 @@
 from utils.cleanup import cleanup
 from utils.console import print_step, print_substep
 
+
 console = Console()
 
 W, H = 1080, 1920
 
 
-def make_final_video(number_of_clips:int, length:int):
+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:
         number_of_clips (int): Index to end at when going through the screenshots
         length (int): Length of the video
-    """    
+    """
+
     print_step("Creating the final video 🎥")
     VideoFileClip.reW = lambda clip: clip.resize(width=W)
     VideoFileClip.reH = lambda clip: clip.resize(width=H)
@@ -64,19 +66,20 @@ def make_final_video(number_of_clips:int, length:int):
     if (
         opacity is None or float(opacity) >= 1
     ):  # opacity not set or is set to one OR MORE
+
         image_clips.insert(
             0,
             ImageClip("assets/temp/png/title.png")
             .set_duration(audio_clips[0].duration)
-            .set_position("center")
+            .set_position(bg.get_img_clip_pos())
             .resize(width=W - 100),
         )
     else:
         image_clips.insert(
             0,
             ImageClip("assets/temp/png/title.png")
             .set_duration(audio_clips[0].duration)
-            .set_position("center")
+            .set_position(bg.get_img_clip_pos())
             .resize(width=W - 100)
             .set_opacity(float(opacity)),
         )
@@ -88,14 +91,12 @@ def make_final_video(number_of_clips:int, length:int):
             image_clips.append(
                 ImageClip(f"assets/temp/png/comment_{i}.png")
                 .set_duration(audio_clips[i + 1].duration)
-                .set_position("center")
                 .resize(width=W - 100),
             )
         else:
             image_clips.append(
                 ImageClip(f"assets/temp/png/comment_{i}.png")
                 .set_duration(audio_clips[i + 1].duration)
-                .set_position("center")
                 .resize(width=W - 100)
                 .set_opacity(float(opacity)),
             )
@@ -110,16 +111,14 @@ def make_final_video(number_of_clips:int, length:int):
     #        .set_opacity(float(opacity)),
     #    )
     # else:
-    image_concat = concatenate_videoclips(image_clips).set_position(
-        ("center", "center")
-    )
+
+    image_concat = concatenate_videoclips(
+        image_clips).set_position(bg.get_img_clip_pos())
     image_concat.audio = audio_composite
     final = CompositeVideoClip([background_clip, image_concat])
 
-
     filename = f"{get_video_title()}.mp4"
 
-
     save_data(filename)
 
     if not exists("./results"):
@@ -147,12 +146,13 @@ def make_final_video(number_of_clips:int, length:int):
         f"Reddit title: {os.getenv('VIDEO_TITLE')} \n Background Credit: {os.getenv('background_credit')}"
     )
 
-def save_data(filename:str):
+
+def save_data(filename: str):
     """Saves the videos that have already been generated to a JSON file in video_creation/data/videos.json
 
     Args:
         filename (str): The finished video title name
-    """    
+    """
     with open("./video_creation/data/videos.json", "r+") as raw_vids:
         done_vids = json.load(raw_vids)
         if str(subreddit.submission.id) in [video["id"] for video in done_vids]:
@@ -168,14 +168,15 @@ def save_data(filename:str):
         raw_vids.seek(0)
         json.dump(done_vids, raw_vids, ensure_ascii=False, indent=4)
 
+
 def get_video_title() -> str:
     """Gets video title from env variable or gives it the name "final_video"
 
     Returns:
         str: Video title
-    """        
+    """
     title = os.getenv("VIDEO_TITLE") or "final_video"
     if len(title) <= 35:
         return title
     else:
-        return title[0:30] + "..."
+        return title[0:30] + "..."