Merge pull request #1593 from propilideno/master

Added Background Audio Feature, new results tree, and new toml config

README.md

@@ -70,7 +70,7 @@ In its current state, this bot does exactly what it needs to do. However, improv
 I have tried to simplify the code so anyone can read it and start contributing at any skill level. Don't be shy :) contribute!
 
 - [ ] Creating better documentation and adding a command line interface.
-- [ ] Allowing the user to choose background music for their videos.
+- [x] Allowing the user to choose background music for their videos.
 - [x] Allowing users to choose a reddit thread instead of being randomized.
 - [x] Allowing users to choose a background that is picked instead of the Minecraft one.
 - [x] Allowing users to choose between any subreddit.

main.py

@@ -16,8 +16,9 @@ from utils.console import print_markdown, print_step
 from utils.id import id
 from utils.version import checkversion
 from video_creation.background import (
-    download_background,
-    chop_background_video,
+    download_background_video,
+    download_background_audio,
+    chop_background,
     get_background_config,
 )
 from video_creation.final_video import make_final_video
@@ -51,9 +52,13 @@ def main(POST_ID=None) -> None:
     length, number_of_comments = save_text_to_mp3(reddit_object)
     length = math.ceil(length)
     get_screenshots_of_reddit_posts(reddit_object, number_of_comments)
-    bg_config = get_background_config()
-    download_background(bg_config)
-    chop_background_video(bg_config, length, reddit_object)
+    bg_config = {
+        "video": get_background_config("video"),
+        "audio": get_background_config("audio"),
+    }
+    download_background_video(bg_config["video"])
+    download_background_audio(bg_config["audio"])
+    chop_background(bg_config, length, reddit_object)
     try:
         make_final_video(number_of_comments, length, reddit_object, bg_config)
     except ffmpeg.Error as e:
@@ -133,4 +138,4 @@ if __name__ == "__main__":
             f"Error: {err} \n"
             f'Config: {config["settings"]}'
         )
-        raise err
+        raise err

utils/.config.template.toml

@@ -33,9 +33,10 @@ resolution_w = { optional = false, default = 1080, example = 1440, explantation
 resolution_h = { optional = false, default = 1920, example = 2560, explantation = "Sets the height in pixels of the final video" }
 
 [settings.background]
-background_choice = { optional = true, default = "minecraft", example = "rocket-league", options = ["minecraft", "gta", "rocket-league", "motor-gta", "csgo-surf", "cluster-truck", "minecraft-2","multiversus","fall-guys","steep", "random", ""], explanation = "Sets the background for the video based on game name" }
-background_audio = { optional = true, type = "bool", default = false, example = false, options = [true, false,], explanation = "Sets a audio to play in the background (put a background.mp3 file in the assets/backgrounds directory for it to be used.)" }
-background_audio_volume = { optional = true, type = "float", default = 0.3, example = 0.1, explanation="Sets the volume of the background audio. only used if the background_audio is also set to true" }
+background_video = { optional = true, default = "minecraft", example = "rocket-league", options = ["minecraft", "gta", "rocket-league", "motor-gta", "csgo-surf", "cluster-truck", "minecraft-2","multiversus","fall-guys","steep", ""], explanation = "Sets the background for the video based on game name" }
+background_audio = { optional = true, default = "lofi", example = "chill-summer", options = ["lofi","lofi-2","chill-summer",""], explanation = "Sets the background audio for the video" }
+background_audio_volume = { optional = true, type = "float", nmin = 0, nmax = 1, default = 0.15, example = 0.05, explanation="Sets the volume of the background audio. If you don't want background audio, set it to 0.", oob_error = "The volume HAS to be between 0 and 1", input_error = "The volume HAS to be a float number between 0 and 1"}
+enable_extra_audio = { optional = true, type = "bool", default = false, example = false, explanation="Used if you want to render another video without background audio in a separate folder", input_error = "The value HAS to be true or false"}
 background_thumbnail = { optional = true, type = "bool", default = false, example = false, options = [true, false,], explanation = "Generate a thumbnail for the video (put a thumbnail.png file in the assets/backgrounds directory.)" }
 background_thumbnail_font_family = { optional = true, default = "arial", example = "arial", explanation = "Font family for the thumbnail text" }
 background_thumbnail_font_size = { optional = true, type = "int", default = 96, example = 96, explanation = "Font size in pixels for the thumbnail text" }

utils/background_audios.json

@@ -0,0 +1,18 @@
+{
+    "__comment": "Supported Backgrounds Audio. Can add/remove background audio here...",
+    "lofi": [
+        "https://www.youtube.com/watch?v=LTphVIore3A",
+        "lofi.mp3",
+        "Super Lofi World"
+    ],
+    "lofi-2":[
+        "https://www.youtube.com/watch?v=BEXL80LS0-I",
+        "lofi-2.mp3",
+        "stompsPlaylist"
+    ],
+    "chill-summer":[
+        "https://www.youtube.com/watch?v=EZE8JagnBI8",
+        "chill-summer.mp3",
+        "Mellow Vibes Radio"
+    ]
+}

video_creation/background.py

@@ -3,28 +3,38 @@ import random
 import re
 from pathlib import Path
 from random import randrange
-from typing import Any, Tuple
+from typing import Any, Tuple,Dict
 
-from moviepy.editor import VideoFileClip
+from moviepy.editor import VideoFileClip,AudioFileClip
 from moviepy.video.io.ffmpeg_tools import ffmpeg_extract_subclip
 from utils import settings
 from utils.console import print_step, print_substep
 import yt_dlp
 
-# Load background videos
-with open("./utils/backgrounds.json") as json_file:
-    background_options = json.load(json_file)
+def load_background_options():
+    background_options = {}
+    # Load background videos
+    with open("./utils/background_videos.json") as json_file:
+        background_options["video"] = json.load(json_file)
 
-# Remove "__comment" from backgrounds
-background_options.pop("__comment", None)
+    # Load background audios
+    with open("./utils/background_audios.json") as json_file:
+        background_options["audio"] = json.load(json_file)
+    
+    # Remove "__comment" from backgrounds
+    del background_options["video"]["__comment"]
+    del background_options["audio"]["__comment"]
+    
+    # Add position lambda function
+    # (https://zulko.github.io/moviepy/ref/VideoClip/VideoClip.html#moviepy.video.VideoClip.VideoClip.set_position)
+    for name in list(background_options["video"].keys()):
+        pos = background_options["video"][name][3]
 
-# Add position lambda function
-# (https://zulko.github.io/moviepy/ref/VideoClip/VideoClip.html#moviepy.video.VideoClip.VideoClip.set_position)
-for name in list(background_options.keys()):
-    pos = background_options[name][3]
+        if pos != "center":
+            background_options["video"][name][3] = lambda t: ("center", pos + t)
+
+    return background_options
 
-    if pos != "center":
-        background_options[name][3] = lambda t: ("center", pos + t)
 
 
 def get_start_and_end_times(video_length: int, length_of_clip: int) -> Tuple[int, int]:
@@ -41,11 +51,11 @@ def get_start_and_end_times(video_length: int, length_of_clip: int) -> Tuple[int
     return random_time, random_time + video_length
 
 
-def get_background_config():
+def get_background_config(mode: str):
     """Fetch the background/s configuration"""
     try:
         choice = str(
-            settings.config["settings"]["background"]["background_choice"]
+            settings.config["settings"]["background"][f"background_{mode}"]
         ).casefold()
     except AttributeError:
         print_substep("No background selected. Picking random background'")
@@ -53,18 +63,17 @@ def get_background_config():
 
     # Handle default / not supported background using default option.
     # Default : pick random from supported background.
-    if not choice or choice not in background_options or choice == "random":
-        choice = random.choice(list(background_options.keys()))
-
-    return background_options[choice]
+    if not choice or choice not in background_options[mode]:
+        choice = random.choice(list(background_options[mode].keys()))
 
+    return background_options[mode][choice]
 
-def download_background(background_config: Tuple[str, str, str, Any]):
+def download_background_video(background_config: Tuple[str, str, str, Any]):
     """Downloads the background/s video from YouTube."""
-    Path("./assets/backgrounds/").mkdir(parents=True, exist_ok=True)
+    Path("./assets/backgrounds/video/").mkdir(parents=True, exist_ok=True)
     # note: make sure the file name doesn't include an - in it
     uri, filename, credit, _ = background_config
-    if Path(f"assets/backgrounds/{credit}-{filename}").is_file():
+    if Path(f"assets/backgrounds/video/{credit}-{filename}").is_file():
         return
     print_step(
         "We need to download the backgrounds videos. they are fairly large but it's only done once. 😎"
@@ -73,7 +82,7 @@ def download_background(background_config: Tuple[str, str, str, Any]):
     print_substep(f"Downloading {filename} from {uri}")
     ydl_opts = {
         'format': "bestvideo[height<=1080][ext=mp4]",
-        "outtmpl": f"assets/backgrounds/{credit}-{filename}",
+        "outtmpl": f"assets/backgrounds/video/{credit}-{filename}",
         "retries": 10,
     }
 
@@ -81,34 +90,71 @@ def download_background(background_config: Tuple[str, str, str, Any]):
         ydl.download(uri)
     print_substep("Background video downloaded successfully! 🎉", style="bold green")
 
+def download_background_audio(background_config: Tuple[str, str, str]):
+    """Downloads the background/s audio from YouTube."""
+    Path("./assets/backgrounds/audio/").mkdir(parents=True, exist_ok=True)
+    # note: make sure the file name doesn't include an - in it
+    uri, filename, credit = background_config
+    if Path(f"assets/backgrounds/audio/{credit}-{filename}").is_file():
+        return
+    print_step(
+        "We need to download the backgrounds audio. they are fairly large but it's only done once. 😎"
+    )
+    print_substep("Downloading the backgrounds audio... please be patient 🙏 ")
+    print_substep(f"Downloading {filename} from {uri}")
+    ydl_opts = {
+        'outtmpl': f'./assets/backgrounds/audio/{credit}-{filename}',
+        'format': 'bestaudio/best',
+        'extract_audio': True,
+    }
 
-def chop_background_video(
-    background_config: Tuple[str, str, str, Any], video_length: int, reddit_object: dict
+    with yt_dlp.YoutubeDL(ydl_opts) as ydl:
+        ydl.download([uri])
+
+    print_substep("Background audio downloaded successfully! 🎉", style="bold green")
+
+
+
+def chop_background(
+    background_config: Dict[str,Tuple], video_length: int, reddit_object: dict
 ):
-    """Generates the background footage to be used in the video and writes it to assets/temp/background.mp4
+    """Generates the background audio and footage to be used in the video and writes it to assets/temp/background.mp3 and assets/temp/background.mp4
 
     Args:
-        background_config (Tuple[str, str, str, Any]) : Current background configuration
+        background_config (Dict[str,Tuple]]) : Current background configuration
         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 = f"{background_config[2]}-{background_config[1]}"
     id = re.sub(r"[^\w\s-]", "", reddit_object["thread_id"])
-    background = VideoFileClip(f"assets/backgrounds/{choice}")
 
-    start_time, end_time = get_start_and_end_times(video_length, background.duration)
+    if(settings.config["settings"]["background"][f"background_audio_volume"] == 0):
+        print_step("Volume was set to 0. Skipping background audio creation . . .")
+    else:
+        print_step("Finding a spot in the backgrounds audio to chop...✂️")
+        audio_choice = f"{background_config['audio'][2]}-{background_config['audio'][1]}"
+        background_audio = AudioFileClip(f"assets/backgrounds/audio/{audio_choice}")
+        start_time_audio, end_time_audio = get_start_and_end_times(video_length, background_audio.duration)
+        background_audio = background_audio.subclip(start_time_audio,end_time_audio)
+        background_audio.write_audiofile(f"assets/temp/{id}/background.mp3")
+
+    print_step("Finding a spot in the backgrounds video to chop...✂️")
+    video_choice = f"{background_config['video'][2]}-{background_config['video'][1]}"
+    background_video = VideoFileClip(f"assets/backgrounds/video/{video_choice}")
+    start_time_video, end_time_video = get_start_and_end_times(video_length, background_video.duration)
+    # Extract video subclip
     try:
         ffmpeg_extract_subclip(
-            f"assets/backgrounds/{choice}",
-            start_time,
-            end_time,
+            f"assets/backgrounds/video/{video_choice}",
+            start_time_video,
+            end_time_video,
             targetname=f"assets/temp/{id}/background.mp4",
         )
     except (OSError, IOError):  # ffmpeg issue see #348
         print_substep("FFMPEG issue. Trying again...")
-        with VideoFileClip(f"assets/backgrounds/{choice}") as video:
-            new = video.subclip(start_time, end_time)
+        with VideoFileClip(f"assets/backgrounds/video/{video_choice}") as video:
+            new = video.subclip(start_time_video, end_time_video)
             new.write_videofile(f"assets/temp/{id}/background.mp4")
     print_substep("Background video chopped successfully!", style="bold green")
-    return background_config[2]
+    return background_config["video"][2]
+
+# Create a tuple for downloads background (background_audio_options, background_video_options)
+background_options = load_background_options()

video_creation/final_video.py

@@ -4,7 +4,7 @@ import re
 import shutil
 from os.path import exists # Needs to be imported specifically
 from typing import Final
-from typing import Tuple, Any
+from typing import Tuple, Any, Dict
 
 import ffmpeg
 import translators as ts
@@ -103,12 +103,34 @@ def prepare_background(reddit_id: str, W: int, H: int) -> str:
         exit()
     return output_path
 
+def merge_background_audio(audio: ffmpeg, reddit_id: str):
+    """Gather an audio and merge with assets/backgrounds/background.mp3
+    Args:
+        audio (ffmpeg): The TTS final audio but without background.
+        reddit_id (str): The ID of subreddit
+    """
+    background_audio_volume = settings.config["settings"]["background"]["background_audio_volume"]
+    if (background_audio_volume == 0):
+        return audio # Return the original audio
+    else:
+        # sets volume to config
+        bg_audio = (
+            ffmpeg.input(f"assets/temp/{reddit_id}/background.mp3")
+            .filter(
+                "volume",
+                background_audio_volume,
+            )
+        )
+        # Merges audio and background_audio
+        merged_audio = ffmpeg.filter([audio, bg_audio], "amix", duration="longest")
+        return merged_audio # Return merged audio
+
 
 def make_final_video(
     number_of_clips: int,
     length: int,
     reddit_obj: dict,
-    background_config: Tuple[str, str, str, Any],
+    background_config: Dict[str,Tuple],
 ):
     """Gathers audio clips, gathers all screenshots, stitches them together and saves the final video to assets/temp
     Args:
@@ -122,6 +144,10 @@ def make_final_video(
     H: Final[int] = int(settings.config["settings"]["resolution_h"])
 
     reddit_id = re.sub(r"[^\w\s-]", "", reddit_obj["thread_id"])
+
+    allowOnlyTTSFolder: bool = settings.config["settings"]["background"]["enable_extra_audio"] \
+                            and settings.config["settings"]["background"]["background_audio_volume"] != 0
+
     print_step("Creating the final video 🎥")
 
     background_clip = ffmpeg.input(prepare_background(reddit_id, W=W, H=H))
@@ -177,35 +203,7 @@ def make_final_video(
 
     screenshot_width = int((W * 45) // 100)
     audio = ffmpeg.input(f"assets/temp/{reddit_id}/audio.mp3")
-    # adds background audio
-    if settings.config["settings"]["background"]["background_audio"]:
-        if not exists("assets/backgrounds/background.mp3"):
-            print_substep(
-                "No audio file found called background.mp3 in assets/backgrounds", "red"
-            )
-        else:
-            if (
-                    not settings.config["settings"]["background"]["background_audio_volume"]
-                    or settings.config["settings"]["background"]["background_audio_volume"] == 0
-                    or settings.config["settings"]["background"]["background_audio_volume"] == ""
-            ):
-                print_substep(
-                    "Background audio volume is set to 0, not adding background audio",
-                    "red",
-                )
-            else:
-                # sets volume to config
-                bg_audio = (
-                    ffmpeg.input("assets/backgrounds/background.mp3")
-                    .filter(
-                        "volume",
-                        settings.config["settings"]["background"]["background_audio_volume"],
-                    )
-                )
-                # merges audio and bg_audio
-                merged_audio = ffmpeg.filter([audio, bg_audio], "amix", duration="longest")
-                # sets final audio to merged audio
-                audio = merged_audio
+    final_audio = merge_background_audio(audio,reddit_id)
 
     image_clips = list()
 
@@ -287,15 +285,19 @@ def make_final_video(
     subreddit = settings.config["reddit"]["thread"]["subreddit"]
 
     if not exists(f"./results/{subreddit}"):
-        print_substep("The results folder didn't exist so I made it")
+        print_substep("The 'results' folder could not be found so it was automatically created.")
         os.makedirs(f"./results/{subreddit}")
+    
+    if not exists(f"./results/{subreddit}/OnlyTTS") and allowOnlyTTSFolder:
+        print_substep("The 'OnlyTTS' folder could not be found so it was automatically created.")
+        os.makedirs(f"./results/{subreddit}/OnlyTTS")
 
     # create a thumbnail for the video
     settingsbackground = settings.config["settings"]["background"]
 
     if settingsbackground["background_thumbnail"]:
         if not exists(f"./results/{subreddit}/thumbnails"):
-            print_substep("The results/thumbnails folder didn't exist so I made it")
+            print_substep("The 'results/thumbnails' folder could not be found so it was automatically created.")
             os.makedirs(f"./results/{subreddit}/thumbnails")
         # get the first file with the .png extension from assets/backgrounds and use it as a background for the thumbnail
         first_image = next(
@@ -329,7 +331,7 @@ def make_final_video(
                 f"Thumbnail - Building Thumbnail in assets/temp/{reddit_id}/thumbnail.png"
             )
 
-    text = f"Background by {background_config[2]}"
+    text = f"Background by {background_config['video'][2]}"
     background_clip = ffmpeg.drawtext(
         background_clip,
         text=text,
@@ -349,15 +351,14 @@ def make_final_video(
         old_percentage = pbar.n
         pbar.update(status - old_percentage)
 
-    path = f"results/{subreddit}/{filename}"
-    path = path[:251]
-    path = path + ".mp4"
-
+    defaultPath = f"results/{subreddit}"
     with ProgressFfmpeg(length, on_update_example) as progress:
+        path = defaultPath + f"/{filename}"
+        path = path[:251] + ".mp4" #Prevent a error by limiting the path length, do not change this.
         ffmpeg.output(
             background_clip,
-            audio,
-            path,
+            final_audio,
+            path, 
             f="mp4",
             **{
                 "c:v": "h264",
@@ -371,13 +372,36 @@ def make_final_video(
             capture_stdout=False,
             capture_stderr=False,
         )
-
     old_percentage = pbar.n
     pbar.update(100 - old_percentage)
+    if(allowOnlyTTSFolder):
+        path = defaultPath + f"/OnlyTTS/{filename}"
+        path = path[:251] + ".mp4" #Prevent a error by limiting the path length, do not change this.
+        print_step("Rendering the Only TTS Video 🎥")
+        with ProgressFfmpeg(length, on_update_example) as progress:
+            ffmpeg.output(
+                background_clip,
+                audio,
+                path,
+                f="mp4",
+                **{
+                    "c:v": "h264",
+                    "b:v": "20M",
+                    "b:a": "192k",
+                    "threads": multiprocessing.cpu_count(),
+                },
+            ).overwrite_output().global_args("-progress", progress.output_file.name).run(
+                quiet=True,
+                overwrite_output=True,
+                capture_stdout=False,
+                capture_stderr=False,
+            )
+        old_percentage = pbar.n
+        pbar.update(100 - old_percentage)
     pbar.close()
 
-    save_data(subreddit, filename + ".mp4", title, idx, background_config[2])
+    save_data(subreddit, filename + ".mp4", title, idx, background_config['video'][2])
     print_step("Removing temporary files 🗑")
     cleanups = cleanup(reddit_id)
     print_substep(f"Removed {cleanups} temporary files 🗑")
-    print_step("Done! 🎉 The video is in the results folder 📁")
+    print_step("Done! 🎉 The video is in the results folder 📁")