make-ffmpeg: Refactor code

make-ffmpeg.py

@@ -4,16 +4,234 @@
 import os
 import sys
 import subprocess
-import schedulelib
 import argparse
-import shlex
-from PIL import ImageFont
-from configparser import ConfigParser
-import json
-import platform
 import ssl
+from configparser import ConfigParser
+from pathlib import PurePath
+import platform
+
+from PIL import ImageFont
+import schedulelib
 ssl._create_default_https_context = ssl._create_unverified_context
 
+
+class TextConfig:
+    inpoint: float
+    outpoint: float
+    x: int
+    y: int
+
+    use_fontfile: bool
+    fontfile: str
+    fontfile_path: str
+    fontfamily: str
+
+    fontsize: int
+    fontcolor: str = "#ffffff"
+
+    def parse(self, cparser_sect, use_fontfile: bool):
+        self.inpoint = cparser_sect.getfloat('in')
+        self.outpoint = cparser_sect.getfloat('out')
+        self.x = cparser_sect.getint('x')
+        self.y = cparser_sect.getint('y')
+
+        self.use_fontfile = use_fontfile
+        if use_fontfile:
+            self.fontfile = cparser_sect.get('fontfile')
+            self.fontfile_path = str(PurePath(args.project, self.fontfile).as_posix())
+
+            if not os.path.exists(self.fontfile_path):
+                error("Font file {} in Project Path is missing".format(self.fontfile_path))
+        else:
+            self.fontfamily = cparser_sect.get('fontfamily')
+
+        self.fontsize = cparser_sect.getint('fontsize')
+        self.fontcolor = cparser_sect.get('fontcolor', self.fontcolor)
+
+    def fit_text(self, text: str):
+        global translation_font
+        translation_font = ImageFont.truetype(
+            self.fontfile_path, size=self.fontsize, encoding="unic")
+
+        # TODO: Make this work with font family as well!
+
+        return fit_text(text, (1920-self.x-100))
+
+    def get_ffmpeg_filter(self, inout_type: str, text: str):
+        filter_str = "drawtext=enable='between({},{},{})'".format(
+            inout_type, self.inpoint, self.outpoint)
+
+        if self.use_fontfile:
+            filter_str += ":fontfile='{}'".format(self.fontfile_path)
+        else:
+            filter_str += ":font='{}'".format(self.fontfamily)
+
+        filter_str += ":fontsize={0}:fontcolor={1}:x={2}:y={3}:text='{4}'".format(
+            self.fontsize, self.fontcolor, self.x, self.y, text)
+
+        return filter_str
+
+
+class Config:
+    schedule: str
+    template_file: str  # video background
+    alpha: bool = False
+    prores: bool = False
+    use_fontfile: bool = False
+    inout_type: str = "t"  # in and out time format: t for seconds, n for frame number
+
+    fileext: str
+
+    title: TextConfig
+    speaker: TextConfig
+    text: TextConfig
+    text_text: str = ""  # additional text
+
+
+def parse_config(filename) -> Config:
+    if not os.path.exists(filename):
+        error("config.ini file in Project Path is missing")
+
+    conf = Config()
+
+    cparser = ConfigParser()
+    cparser.read(filename)
+
+    defaults = cparser['default']
+    conf.schedule = defaults.get('schedule')
+    infile = PurePath(args.project, defaults.get('template'))
+    conf.template_file = str(infile)
+    conf.alpha = defaults.getboolean('alpha', conf.alpha)
+    conf.prores = defaults.getboolean('prores', conf.prores)
+    conf.use_fontfile = defaults.get('fontfile', conf.use_fontfile)
+    conf.inout_type = defaults.get('inout', conf.inout_type)
+
+    conf.title = TextConfig()
+    conf.title.parse(cparser['title'], conf.use_fontfile)
+    conf.speaker = TextConfig()
+    conf.speaker.parse(cparser['speaker'], conf.use_fontfile)
+    conf.text = TextConfig()
+    conf.text.parse(cparser['text'], conf.use_fontfile)
+
+    conf.text_text = cparser['text'].get('text', '')
+
+    conf.fileext = infile.suffix
+
+    if not os.path.exists(conf.template_file):
+        error("Template file {} in Project Path is missing".format(conf.template_file))
+
+    if conf.alpha and conf.fileext != '.mov':
+        error("Alpha can only be rendered with .mov source files")
+
+    if not args.project:
+        error("The Project Path is a required argument")
+
+    if not args.debug and not conf.schedule:
+        error("Either specify --debug or supply a schedule in config.ini")
+
+    return conf
+
+
+def error(err_str):
+    print("##################################################")
+    print(err_str)
+    print("##################################################")
+    print()
+    parser.print_help()
+    sys.exit(1)
+
+
+def describe_event(event):
+    return "#{}: {}".format(event['id'], event['title'])
+
+
+def event_print(event, message):
+    print("{} – {}".format(describe_event(event), message))
+
+
+def fit_text(string: str, frame_width):
+    split_line = [x.strip() for x in string.split()]
+    lines = ""
+    line = ""
+    for word in split_line:
+        left, top, right, bottom = translation_font.getbbox(" ".join([line, word]))
+        width, height = right - left, bottom - top
+        if width > (frame_width - (2 * 6)):
+            lines += line.strip() + "\n"
+            line = ""
+
+        line += word + " "
+
+    lines += line.strip()
+    return lines
+
+
+def ffmpeg_escape_str(text: str) -> str:
+    text = text.replace(':', "\:")  # the ffmpeg command needs colons to be escaped
+    return text
+
+
+def enqueue_job(conf: Config, event):
+    event_id = str(event['id'])
+
+    outfile = str(PurePath(args.project, event_id + '.ts'))
+    outfile_mov = str(PurePath(args.project, event_id + '.mov'))
+
+    if event_id in args.skip:
+        event_print(event, "skipping " + str(event['id']))
+        return
+    if (os.path.exists(outfile) or os.path.exists(outfile_mov)) and not args.force:
+        event_print(event, "file exist, skipping " + str(event['id']))
+        return
+
+    event_title = str(event['title'])
+    event_personnames = str(event['personnames'])
+    event_title = event_title.replace('"', '\\"')
+    event_title = event_title.replace('\'', '')
+    event_personnames = event_personnames.replace('"', '\\"')
+
+    title = ffmpeg_escape_str(conf.title.fit_text(event_title))
+    speakers = ffmpeg_escape_str(conf.speaker.fit_text(event_personnames))
+    text = ffmpeg_escape_str(conf.text_text)
+
+    if args.debug:
+        print('Title: ', title)
+        print('Speaker: ', speakers)
+
+    if platform.system() == 'Windows':
+        ffmpeg_path = './ffmpeg.exe'
+    else:
+        ffmpeg_path = 'ffmpeg'
+
+    videofilter = conf.title.get_ffmpeg_filter(conf.inout_type, title) + ","
+    videofilter += conf.speaker.get_ffmpeg_filter(conf.inout_type, speakers) + ","
+    videofilter += conf.text.get_ffmpeg_filter(conf.inout_type, text)
+
+    cmd = [ffmpeg_path, '-y', '-i', conf.template_file, '-vf', videofilter]
+
+    if conf.fileext == '.mov' and conf.alpha:
+        if conf.prores:
+            cmd += ['-vcodec', 'prores_ks', '-pix_fmt', 'yuva444p10le', '-profile:v',
+                    '4444', '-shortest', '-movflags', 'faststart', '-f', 'mov', outfile_mov]
+        else:
+            cmd += ['-shortest', '-c:v', 'qtrle', '-movflags',
+                    'faststart', '-f', 'mov', outfile_mov]
+    else:
+        cmd += ['-map', '0:0', '-c:v', 'mpeg2video', '-q:v', '2', '-aspect', '16:9', '-map',
+                '0:1', '-c:a', 'mp2', '-b:a', '384k', '-shortest', '-f', 'mpegts', outfile]
+
+    if args.debug:
+        print(cmd)
+
+    subprocess.check_call(cmd,
+                          stderr=subprocess.STDOUT,
+                          stdout=subprocess.DEVNULL
+                          )
+
+    return event_id
+
+
+if __name__ == "__main__":
     # Parse arguments
     parser = argparse.ArgumentParser(
         description='C3VOC Intro-Outro-Generator - Variant which renders only using video filters in ffmpeg',
@@ -57,83 +275,7 @@ args = parser.parse_args()
     if (args.skip is None):
         args.skip = []
 
-
+    config = parse_config(PurePath(args.project, 'config.ini'))
-def headline(str):
-    print("##################################################")
-    print(str)
-    print("##################################################")
-    print()
-
-
-def error(str):
-    headline(str)
-    parser.print_help()
-    sys.exit(1)
-
-
-cparser = ConfigParser()
-cparser.read(os.path.join(os.path.dirname(args.project), 'config.ini'))
-template = cparser['default']['template']
-alpha = cparser['default']['alpha']
-prores = cparser['default']['prores']
-fontfile = cparser['default']['fontfile']  # use a font file instead of a font family
-inout = cparser['default']['inout']  # in and out time format: t for seconds, n for frame number
-
-title_in = cparser['title']['in']
-title_out = cparser['title']['out']
-title_fontfamily = cparser['title']['fontfamily']
-title_fontfile = cparser['title']['fontfile']
-title_fontsize = cparser['title']['fontsize']
-title_fontcolor = cparser['title']['fontcolor']
-title_x = cparser['title']['x']
-title_y = cparser['title']['y']
-
-speaker_in = cparser['speaker']['in']
-speaker_out = cparser['speaker']['out']
-speaker_fontfamily = cparser['speaker']['fontfamily']
-speaker_fontfile = cparser['speaker']['fontfile']
-speaker_fontsize = cparser['speaker']['fontsize']
-speaker_fontcolor = cparser['speaker']['fontcolor']
-speaker_x = cparser['speaker']['x']
-speaker_y = cparser['speaker']['y']
-
-text_in = cparser['text']['in']
-text_out = cparser['text']['out']
-text_fontfamily = cparser['text']['fontfamily']
-text_fontfile = cparser['text']['fontfile']
-text_fontsize = cparser['text']['fontsize']
-text_fontcolor = cparser['text']['fontcolor']
-text_x = cparser['text']['x']
-text_y = cparser['text']['y']
-text_text = cparser['text']['text']
-
-font_t = os.path.join(os.path.dirname(args.project), title_fontfile)
-font_s = os.path.join(os.path.dirname(args.project), speaker_fontfile)
-font_tt = os.path.join(os.path.dirname(args.project), text_fontfile)
-
-fileformat = os.path.splitext(template)[1]
-infile = os.path.join(os.path.dirname(args.project), template)
-
-schedule = cparser['default']['schedule']
-
-if not (os.path.exists(os.path.join(args.project, template))):
-    error("Template file {} in Project Path is missing".format(template))
-
-for ffile in (title_fontfile, speaker_fontfile, text_fontfile):
-    if not (os.path.exists(os.path.join(args.project, ffile))):
-        error("Font file {} in Project Path is missing".format(ffile))
-
-if not (os.path.exists(os.path.join(args.project, 'config.ini'))):
-    error("config.ini file in Project Path is missing")
-
-if alpha == 'true' and not fileformat == '.mov':
-    error("Alpha can only be rendered with .mov source files")
-
-if not args.project:
-    error("The Project Path is a required argument")
-
-if not args.debug and not schedule:
-    error("Either specify --debug or supply a schedule in config.ini")
 
     if args.debug:
         persons = ['Thomas Roth', 'Dmitry Nedospasov', 'Josh Datko',]
@@ -147,148 +289,7 @@ if args.debug:
         }]
 
     else:
-    events = list(schedulelib.events(schedule))
+        events = list(schedulelib.events(config.schedule))
-
-
-def describe_event(event):
-    return "#{}: {}".format(event['id'], event['title'])
-
-
-def event_print(event, message):
-    print("{} – {}".format(describe_event(event), message))
-
-
-def fmt_command(command, **kwargs):
-    args = {}
-    for key, value in kwargs.items():
-        args[key] = shlex.quote(value)
-
-    command = command.format(**args)
-    return shlex.split(command)
-
-
-def run(command, **kwargs):
-    return subprocess.check_call(
-        fmt_command(command, **kwargs),
-        stderr=subprocess.STDOUT,
-        stdout=subprocess.DEVNULL)
-
-
-def fit_text(string: str, frame_width):
-    split_line = [x.strip() for x in string.split()]
-    lines = ""
-    w = 0
-    line_num = 0
-    line = ""
-    for word in split_line:
-        left, top, right, bottom = translation_font.getbbox(" ".join([line, word]))
-        width, height = right - left, bottom - top
-        if width > (frame_width - (2 * 6)):
-            lines += line.strip() + "\n"
-            line = ""
-
-        line += word + " "
-
-    lines += line.strip()
-    return lines
-
-
-def fit_title(string: str, fontsize: int, x_offset: int):
-    global translation_font
-    translation_font = ImageFont.truetype(
-        font_t, size=fontsize, encoding="unic")
-    title = fit_text(string, (1920-x_offset-100))
-
-    return title
-
-
-def fit_speaker(string: str, fontsize: int, x_offset: int):
-    global translation_font
-    translation_font = ImageFont.truetype(
-        font_s, size=fontsize, encoding="unic")
-    speaker = fit_text(string, (1920-x_offset-100))
-
-    return speaker
-
-
-def enqueue_job(event):
-    event_id = str(event['id'])
-    if event_id in args.skip:
-        event_print(event, "skipping " + str(event['id']))
-        return
-    if (os.path.exists(os.path.join(args.project, event_id + '.ts')) or os.path.exists(os.path.join(args.project, event_id + '.mov'))) and not args.force:
-        event_print(event, "file exist, skipping " + str(event['id']))
-        return
-
-    event_title = str(event['title'])
-    event_personnames = str(event['personnames'])
-    event_title = event_title.replace('"', '\\"')
-    event_title = event_title.replace('\'', '')
-    event_personnames = event_personnames.replace('"', '\\"')
-
-    t = fit_title(event_title, int(title_fontsize), int(title_x))
-    t = t.replace(':', "\:")  # the ffmpeg command needs colons to be escaped
-    s = fit_speaker(event_personnames, int(speaker_fontsize), int(speaker_x))
-
-    if args.debug:
-        print('Title: ', t)
-        print('Speaker: ', s)
-
-    outfile = os.path.join(os.path.dirname(args.project), event_id + '.ts')
-
-    if platform.system() == 'Windows':
-        ffmpeg_path = './ffmpeg.exe'
-        font_t_win = "/".join(font_t.split("\\"))
-        font_s_win = "/".join(font_s.split("\\"))
-        font_tt_win = "/".join(font_tt.split("\\"))
-    else:
-        ffmpeg_path = 'ffmpeg'
-
-    if fontfile == 'true':
-        if platform.system() == 'Windows':
-            videofilter = "drawtext=enable='between({8},{0},{1})':fontfile='{2}':fontsize={3}:fontcolor={4}:x={5}:y={6}:text='{7}',".format(
-                title_in, title_out, font_t_win, title_fontsize, title_fontcolor, title_x, title_y, t, inout)
-            videofilter += "drawtext=enable='between({8},{0},{1})':fontfile='{2}':fontsize={3}:fontcolor={4}:x={5}:y={6}:text='{7}',".format(
-                speaker_in, speaker_out, font_s_win, speaker_fontsize, speaker_fontcolor, speaker_x, speaker_y, s, inout)
-            videofilter += "drawtext=enable='between({8},{0},{1})':fontfile='{2}':fontsize={3}:fontcolor={4}:x={5}:y={6}:text='{7}'".format(
-                text_in, text_out, font_tt_win, text_fontsize, text_fontcolor, text_x, text_y, text_text, inout)
-        else:
-            videofilter = "drawtext=enable='between({8},{0},{1})':fontfile='{2}':fontsize={3}:fontcolor={4}:x={5}:y={6}:text='{7}',".format(
-                title_in, title_out, font_t, title_fontsize, title_fontcolor, title_x, title_y, t, inout)
-            videofilter += "drawtext=enable='between({8},{0},{1})':fontfile='{2}':fontsize={3}:fontcolor={4}:x={5}:y={6}:text='{7}',".format(
-                speaker_in, speaker_out, font_s, speaker_fontsize, speaker_fontcolor, speaker_x, speaker_y, s, inout)
-            videofilter += "drawtext=enable='between({8},{0},{1})':fontfile='{2}':fontsize={3}:fontcolor={4}:x={5}:y={6}:text='{7}'".format(
-                text_in, text_out, font_tt, text_fontsize, text_fontcolor, text_x, text_y, text_text, inout)
-    else:
-        videofilter = "drawtext=enable='between({8},{0},{1})':font='{2}':fontsize={3}:fontcolor={4}:x={5}:y={6}:text='{7}',".format(
-            title_in, title_out, title_fontfamily, title_fontsize, title_fontcolor, title_x, title_y, t, inout)
-        videofilter += "drawtext=enable='between({8},{0},{1})':font='{2}':fontsize={3}:fontcolor={4}:x={5}:y={6}:text='{7}',".format(
-            speaker_in, speaker_out, speaker_fontfamily, speaker_fontsize, speaker_fontcolor, speaker_x, speaker_y, s, inout)
-        videofilter += "drawtext=enable='between({8},{0},{1})':font='{2}':fontsize={3}:fontcolor={4}:x={5}:y={6}:text='{7}'".format(
-            text_in, text_out, text_fontfamily, text_fontsize, text_fontcolor, text_x, text_y, text_text, inout)
-
-    if fileformat == '.mov':
-        if alpha == 'true':
-            if prores == 'true':
-                cmd = '{3} -y -i "{0}" -vf "{1}" -vcodec prores_ks -pix_fmt yuva444p10le -profile:v 4444 -shortest -movflags faststart -f mov "{2}"'.format(
-                    infile, videofilter, outfile, ffmpeg_path)
-            else:
-                cmd = '{3} -y -i "{0}" -vf "{1}" -shortest -c:v qtrle -movflags faststart -f mov "{2}"'.format(
-                    infile, videofilter, outfile, ffmpeg_path)
-        else:
-            cmd = '{3} -y -i "{0}" -vf "{1}" -map 0:0 -c:v mpeg2video -q:v 2 -aspect 16:9 -map 0:1 -c:a mp2 -b:a 384k -shortest -f mpegts "{2}"'.format(
-                infile, videofilter, outfile, ffmpeg_path)
-    else:
-        cmd = '{3} -y -i "{0}" -vf "{1}" -map 0:0 -c:v mpeg2video -q:v 2 -aspect 16:9 -map 0:1 -c:a mp2 -b:a 384k -shortest -f mpegts "{2}"'.format(
-            infile, videofilter, outfile, ffmpeg_path)
-
-    if args.debug:
-        print(cmd)
-
-    run(cmd)
-
-    return event_id
-
 
     if args.ids:
         if len(args.ids) == 1:
@@ -301,7 +302,6 @@ else:
         else:
             print("enqueuing {} jobs".format(len(events)))
 
-
     for event in events:
         if args.ids and event['id'] not in args.ids:
             continue
@@ -312,10 +312,9 @@ for event in events:
 
         event_print(event, "enqueued as " + str(event['id']))
 
-    job_id = enqueue_job(event)
+        job_id = enqueue_job(config, event)
         if not job_id:
             event_print(event, "job was not enqueued successfully, skipping postprocessing")
             continue
 
-
     print('all done')