From 2da06ab16687a93fe2df73372ed17bfa2dc48a3b Mon Sep 17 00:00:00 2001
From: Brett Williams <blw1138@mac.com>
Date: Tue, 25 Oct 2022 15:28:51 -0700
Subject: [PATCH] RenderWorker cleanup and add camera methods to
 BlenderRenderWorker

---
 server.py                    |  3 +-
 utilities/aerender_worker.py | 26 ++++++-------
 utilities/blender_worker.py  | 72 ++++++++++++++++++++++--------------
 utilities/ffmpeg_worker.py   | 25 +++++++------
 utilities/render_worker.py   | 43 +++++++++++----------
 5 files changed, 93 insertions(+), 76 deletions(-)

diff --git a/server.py b/server.py
index 04855de..2bad2b1 100755
--- a/server.py
+++ b/server.py
@@ -240,7 +240,8 @@ def renderer_info():
     renderer_data = {}
     for r in RenderWorkerFactory.supported_renderers():
         renderer_class = RenderWorkerFactory.class_for_name(r)
-        renderer_data[r] = {'version': renderer_class.version(),
+        renderer_data[r] = {'available': renderer_class.renderer_path() is not None,
+                            'version': renderer_class.version(),
                             'supported_extensions': renderer_class.supported_extensions,
                             'supported_export_formats': renderer_class.supported_export_formats}
     return renderer_data
diff --git a/utilities/aerender_worker.py b/utilities/aerender_worker.py
index 614c610..50a51ba 100644
--- a/utilities/aerender_worker.py
+++ b/utilities/aerender_worker.py
@@ -1,4 +1,4 @@
-#! /usr/bin/python
+#!/usr/bin/env python3
 import glob
 import json
 import re
@@ -19,18 +19,6 @@ def aerender_path():
 
 class AERenderWorker(BaseRenderWorker):
 
-    @classmethod
-    def version(cls):
-        version = None
-        try:
-            x = subprocess.Popen([aerender_path(), '-version'], stdout=subprocess.PIPE)
-            x.wait()
-            ver_out = str(x.stdout.read().strip())
-            version = ver_out.split(" ")[-1].strip()
-        except Exception as e:
-            logging.error('failed getting version: {}'.format(e))
-        return version
-
     renderer = 'After Effects'
     render_engine = 'aerender'
     supported_extensions = ['.aep']
@@ -47,6 +35,18 @@ class AERenderWorker(BaseRenderWorker):
         self.progress_history = []
         self.attributes = {}
 
+    @classmethod
+    def version(cls):
+        version = None
+        try:
+            render_path = cls.renderer_path()
+            if render_path:
+                ver_out = subprocess.check_output([render_path, '-version'])
+                version = ver_out.decode('utf-8').split(" ")[-1].strip()
+        except Exception as e:
+            logging.error(f'Failed to get {cls.renderer} version: {e}')
+        return version
+
     def _generate_subprocess(self):
 
         if os.path.exists('nexrender-cli-macos'):
diff --git a/utilities/blender_worker.py b/utilities/blender_worker.py
index 2b4016d..54a8d19 100644
--- a/utilities/blender_worker.py
+++ b/utilities/blender_worker.py
@@ -1,24 +1,10 @@
-#! /usr/bin/python
+#!/usr/bin/env python3
 import re
-import time
-
 from utilities.render_worker import *
 
-SUPPORTED_FORMATS = ['TGA', 'RAWTGA', 'JPEG', 'IRIS', 'IRIZ', 'AVIRAW', 'AVIJPEG', 'PNG', 'BMP', 'HDR', 'TIFF',
-                     'OPEN_EXR', 'OPEN_EXR_MULTILAYER', 'MPEG', 'CINEON', 'DPX', 'DDS', 'JP2']
-
 
 class BlenderRenderWorker(BaseRenderWorker):
 
-    def version(self):
-        version = None
-        try:
-            ver_out = subprocess.check_output([self.renderer_path(), '-v']).decode('utf-8')
-            version = ver_out.splitlines()[0].replace('Blender', '').strip()
-        except Exception as e:
-            logger.error("Failed to get Blender version: {}".format(e))
-        return version
-
     renderer = 'Blender'
     render_engine = 'blender'
     supported_extensions = ['.blend']
@@ -31,7 +17,8 @@ class BlenderRenderWorker(BaseRenderWorker):
                                                   ignore_extensions=False, args=args)
 
         self.engine = self.args.get('engine', 'BLENDER_EEVEE').upper()
-        self.export_format = self.args.get('export_format', 'JPEG')
+        self.export_format = self.args.get('export_format', None) or 'JPEG'
+        self.camera = self.args.get('camera', None)
         self.frame = 0
 
         self.render_all_frames = self.args.get('render_all_frames', False)
@@ -43,24 +30,34 @@ class BlenderRenderWorker(BaseRenderWorker):
         self.time_remaining = None
         self.frame_percent_complete = 0.0
 
-    def generate_preview(self, blend_file):
-        pass
+    @classmethod
+    def version(cls):
+        version = None
+        try:
+            render_path = cls.renderer_path()
+            if render_path:
+                ver_out = subprocess.check_output([render_path, '-v'])
+                version = ver_out.decode('utf-8').splitlines()[0].replace('Blender', '').strip()
+        except Exception as e:
+            logging.error(f'Failed to get {cls.renderer} version: {e}')
+        return version
 
     def _generate_subprocess(self):
 
-        if self.export_format not in self.supported_export_formats:
-            raise ValueError("Unsupported format for Blender: {}".format(self.export_format))
+        cmd = [self.renderer_path(), '-b', self.input]
+
+        if self.camera:
+            cmd.extend(['--python-expr', f"import bpy;bpy.context.scene.camera = bpy.data.objects['{self.camera}'];"])
+
+        cmd.extend(['-E', self.engine, '-o', self.output, '-F', self.export_format])
+
+        # all frames or single
+        cmd.extend(['-a'] if self.render_all_frames else ['-f', str(self.frame)])
 
-        if self.render_all_frames:
-            cmd = [self.renderer_path(), '-b', self.input, '-E', self.engine, '-o', self.output,
-                   '-F', self.export_format, '-a']
-        else:
-            cmd = [self.renderer_path(), '-b', self.input, '-E', self.engine, '-o', self.output,
-                   '-F', self.export_format, '-f', str(self.frame)]
         return cmd
 
     def _parse_stdout(self, line):
-        import re
+
         pattern = re.compile(
             r'Fra:(?P<frame>\d*).*Mem:(?P<memory>\S+).*Time:(?P<time>\S+)(?:.*Remaining:)?(?P<remaining>\S*)')
         found = pattern.search(line)
@@ -120,7 +117,8 @@ class BlenderRenderWorker(BaseRenderWorker):
 def run_python_expression_in_blend(path, python_expression):
     if os.path.exists(path):
         try:
-            return subprocess.run(['blender', '-b', path, '--python-expr', python_expression], capture_output=True)
+            return subprocess.run([BlenderRenderWorker.renderer_path(), '-b', path, '--python-expr', python_expression],
+                                  capture_output=True)
         except Exception as e:
             logger.warning(f"Error running python expression in blender: {e}")
             pass
@@ -155,6 +153,24 @@ def pack_blender_files(path):
     return None
 
 
+def get_cameras_in_scene(path):
+    cam_script = "import bpy;print('CAM:' + str([x.name + '@' + str(x.lens) for x in bpy.data.cameras]))"
+
+    try:
+        results = run_python_expression_in_blend(path, cam_script)
+
+        result_text = results.stdout.decode()
+        p = re.compile('CAM:\[(.*)\]')
+        match = p.search(result_text)
+        if match:
+            cameras = match.group(1).replace("'", "").split(",")
+            cameras = [{'name': x.split('@')[0].strip(), 'lens': x.split('@')[-1].strip()} for x in cameras]
+            return cameras
+    except Exception as e:
+        logger.error(f'Error getting file details for .blend file: {e}')
+    return None
+
+
 if __name__ == '__main__':
 
     # x = pack_blender_files('/Users/brett/Blender Files/temple_animatic.blend')
diff --git a/utilities/ffmpeg_worker.py b/utilities/ffmpeg_worker.py
index 7ee2588..e544a68 100644
--- a/utilities/ffmpeg_worker.py
+++ b/utilities/ffmpeg_worker.py
@@ -1,4 +1,4 @@
-import logging
+#!/usr/bin/env python3
 import re
 import time
 import ffmpeg
@@ -7,17 +7,6 @@ from utilities.render_worker import *
 
 class FFMPEGRenderWorker(BaseRenderWorker):
 
-    @classmethod
-    def version(cls):
-        version = None
-        try:
-            ver_out = subprocess.check_output([cls.renderer_path(), '-version']).decode('utf-8')
-            match = re.match(".*version\s*(\S+)\s*Copyright", ver_out)
-            version = match.groups()[0]
-        except Exception as e:
-            logger.error("Failed to get FFMPEG version: {}".format(e))
-        return version
-
     renderer = 'ffmpeg'
     render_engine = 'ffmpeg'
 
@@ -38,6 +27,18 @@ class FFMPEGRenderWorker(BaseRenderWorker):
         # Stats
         self.current_frame = -1
 
+    @classmethod
+    def version(cls):
+        version = None
+        try:
+            ver_out = subprocess.check_output([cls.renderer_path(), '-version']).decode('utf-8')
+            match = re.match(".*version\s*(\S+)\s*Copyright", ver_out)
+            if match:
+                version = match.groups()[0]
+        except Exception as e:
+            logger.error("Failed to get FFMPEG version: {}".format(e))
+        return version
+
     def _generate_subprocess(self):
 
         cmd = [self.renderer_path(), '-y', '-stats', '-i', self.input]
diff --git a/utilities/render_worker.py b/utilities/render_worker.py
index 5e4d848..30a8f7a 100644
--- a/utilities/render_worker.py
+++ b/utilities/render_worker.py
@@ -1,3 +1,4 @@
+#!/usr/bin/env python3
 import io
 import logging
 import os
@@ -35,10 +36,6 @@ class BaseRenderWorker(object):
     install_paths = []
     supported_export_formats = []
 
-    @classmethod
-    def version(cls):
-        raise NotImplementedError("Unknown version")
-
     def __init__(self, input_path, output_path, args=None, ignore_extensions=True):
 
         if not ignore_extensions:
@@ -52,7 +49,6 @@ class BaseRenderWorker(object):
         self.output = output_path
         self.args = args or {}
         self.date_created = datetime.now()
-        self.attributes = {}
         self.renderer_version = self.version()
 
         # Ranges
@@ -63,7 +59,6 @@ class BaseRenderWorker(object):
         self.log_path = None
         self.start_time = None
         self.end_time = None
-        self.last_error = None
 
         # History
         self.status = RenderStatus.NOT_STARTED
@@ -79,17 +74,21 @@ class BaseRenderWorker(object):
         self.is_finished = False
         self.last_output = None
 
+    @classmethod
+    def version(cls):
+        raise NotImplementedError("Unknown version")
+
     @classmethod
     def renderer_path(cls):
         path = None
         try:
             path = subprocess.check_output(['which', cls.render_engine]).decode('utf-8').strip()
-        except Exception as e:
+        except subprocess.CalledProcessError:
             for p in cls.install_paths:
                 if os.path.exists(p):
                     path = p
-            # if not path:
-            #     logger.error("Failed to get path to {}: {}".format(self.renderer, e))
+        except Exception as e:
+            logging.exception(e)
         return path
 
     def _generate_subprocess(self):
@@ -215,6 +214,15 @@ class BaseRenderWorker(object):
 
 class RenderWorkerFactory:
 
+    @staticmethod
+    def supported_classes():
+        # to add support for any additional RenderWorker classes, import their classes and add to list here
+        from utilities.blender_worker import BlenderRenderWorker
+        from utilities.aerender_worker import AERenderWorker
+        from utilities.ffmpeg_worker import FFMPEGRenderWorker
+        classes = [BlenderRenderWorker, AERenderWorker, FFMPEGRenderWorker]
+        return classes
+
     @staticmethod
     def create_worker(renderer, input_path, output_path, args=None):
         worker_class = RenderWorkerFactory.class_for_name(renderer)
@@ -222,23 +230,14 @@ class RenderWorkerFactory:
 
     @staticmethod
     def supported_renderers():
-        return ['aerender', 'blender', 'ffmpeg']
+        return [x.render_engine for x in RenderWorkerFactory.supported_classes()]
 
     @staticmethod
     def class_for_name(name):
-
-        from utilities.blender_worker import BlenderRenderWorker
-        from utilities.aerender_worker import AERenderWorker
-        from utilities.ffmpeg_worker import FFMPEGRenderWorker
-
         name = name.lower()
-
-        if "blender" == name:
-            return BlenderRenderWorker
-        elif "aerender" == name:
-            return AERenderWorker
-        elif "ffmpeg" == name:
-            return FFMPEGRenderWorker
+        for render_class in RenderWorkerFactory.supported_classes():
+            if render_class.render_engine == name:
+                return render_class
 
         raise LookupError(f'Cannot find class for name: {name}')