Merged in bugfix/burnins_current_frame_fix (pull request #506)

bugfix/burnins current frame fix

Approved-by: Milan Kolar <milan@orbi.tools>

pype/scripts/otio_burnin.py

@@ -1,17 +1,14 @@
 import os
 import sys
 import re
-import datetime
 import subprocess
 import json
 import opentimelineio_contrib.adapters.ffmpeg_burnins as ffmpeg_burnins
 from pypeapp.lib import config
-from pype import api as pype
-from subprocess import Popen, PIPE
-# FFmpeg in PATH is required
+from pypeapp import Logger
 
 
-log = pype.Logger().get_logger("BurninWrapper", "burninwrap")
+log = Logger().get_logger("BurninWrapper", "burninwrap")
 
 
 ffmpeg_path = os.environ.get("FFMPEG_PATH")
@@ -41,6 +38,7 @@ TIMECODE = (
 
 MISSING_KEY_VALUE = "N/A"
 CURRENT_FRAME_KEY = "{current_frame}"
+CURRENT_FRAME_SPLITTER = "_-_CURRENT_FRAME_-_"
 TIME_CODE_KEY = "{timecode}"
 
 
@@ -136,7 +134,9 @@ class ModifiedBurnins(ffmpeg_burnins.Burnins):
         if options_init:
             self.options_init.update(options_init)
 
-    def add_text(self, text, align, frame_start=None, options=None):
+    def add_text(
+        self, text, align, frame_start=None, frame_end=None, options=None
+    ):
         """
         Adding static text to a filter.
 
@@ -152,11 +152,15 @@ class ModifiedBurnins(ffmpeg_burnins.Burnins):
         if frame_start:
             options["frame_offset"] = frame_start
 
+        # `frame_end` is only for meassurements of text position
+        if frame_end:
+            options["frame_end"] = frame_end
+
         self._add_burnin(text, align, options, DRAWTEXT)
 
     def add_timecode(
-        self, align, frame_start=None, frame_start_tc=None, text=None,
-        options=None
+        self, align, frame_start=None, frame_end=None, frame_start_tc=None,
+        text=None, options=None
     ):
         """
         Convenience method to create the frame number expression.
@@ -174,6 +178,10 @@ class ModifiedBurnins(ffmpeg_burnins.Burnins):
         if frame_start:
             options["frame_offset"] = frame_start
 
+        # `frame_end` is only for meassurements of text position
+        if frame_end:
+            options["frame_end"] = frame_end
+
         if not frame_start_tc:
             frame_start_tc = options["frame_offset"]
 
@@ -197,10 +205,31 @@ class ModifiedBurnins(ffmpeg_burnins.Burnins):
         :param enum align: alignment, must use provided enum flags
         :param dict options:
         """
+
+        final_text = text
+        text_for_size = text
+        if CURRENT_FRAME_SPLITTER in text:
+            frame_start = options["frame_offset"]
+            frame_end = options.get("frame_end", frame_start)
+            if not frame_start:
+                replacement_final = replacement_size = str(MISSING_KEY_VALUE)
+            else:
+                replacement_final = "\\'{}\\'".format(
+                    r'%%{eif\:n+%d\:d}' % frame_start
+                )
+                replacement_size = str(frame_end)
+
+            final_text = final_text.replace(
+                CURRENT_FRAME_SPLITTER, replacement_final
+            )
+            text_for_size = text_for_size.replace(
+                CURRENT_FRAME_SPLITTER, replacement_size
+            )
+
         resolution = self.resolution
         data = {
             'text': (
-                text
+                final_text
                 .replace(",", r"\,")
                 .replace(':', r'\:')
             ),
@@ -208,7 +237,7 @@ class ModifiedBurnins(ffmpeg_burnins.Burnins):
             'size': options['font_size']
         }
         timecode_text = options.get("timecode") or ""
-        text_for_size = text + timecode_text
+        text_for_size += timecode_text
         data.update(options)
         data.update(
             ffmpeg_burnins._drawtext(align, resolution, text_for_size, options)
@@ -272,7 +301,7 @@ class ModifiedBurnins(ffmpeg_burnins.Burnins):
         )
         print(command)
 
-        proc = Popen(command, shell=True)
+        proc = subprocess.Popen(command, shell=True)
         proc.communicate()
         if proc.returncode != 0:
             raise RuntimeError("Failed to render '%s': %s'"
@@ -368,6 +397,7 @@ def burnins_from_data(
     burnin = ModifiedBurnins(input_path, options_init=options_init)
 
     frame_start = data.get("frame_start")
+    frame_end = data.get("frame_end")
     frame_start_tc = data.get('frame_start_tc', frame_start)
 
     stream = burnin._streams[0]
@@ -382,7 +412,7 @@ def burnins_from_data(
 
     # Check frame start and add expression if is available
     if frame_start is not None:
-        data[CURRENT_FRAME_KEY[1:-1]] = r'%%{eif\:n+%d\:d}' % frame_start
+        data[CURRENT_FRAME_KEY[1:-1]] = CURRENT_FRAME_SPLITTER
 
     if frame_start_tc is not None:
         data[TIME_CODE_KEY[1:-1]] = TIME_CODE_KEY
@@ -432,7 +462,7 @@ def burnins_from_data(
 
         # Handle timecode differently
         if has_timecode:
-            args = [align, frame_start, frame_start_tc]
+            args = [align, frame_start, frame_end, frame_start_tc]
             if not value.startswith(TIME_CODE_KEY):
                 value_items = value.split(TIME_CODE_KEY)
                 text = value_items[0].format(**data)
@@ -442,7 +472,7 @@ def burnins_from_data(
             continue
 
         text = value.format(**data)
-        burnin.add_text(text, align, frame_start)
+        burnin.add_text(text, align, frame_start, frame_end)
 
     codec_args = ""
     if codec_data: