-
Notifications
You must be signed in to change notification settings - Fork 38
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
93 changed files
with
6,056 additions
and
3,046 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,308 +1,109 @@ | ||
| bl_info = { | ||
| 'name': 'Mitsuba-Blender', | ||
| 'author': 'Baptiste Nicolet, Dorian Ros, Rami Tabbara', | ||
| 'version': (0, 1), | ||
| 'blender': (2, 93, 0), | ||
| 'author': 'Baptiste Nicolet, Dorian Ros, Rami Tabbara, Sébastien Speierer', | ||
| 'version': (1, 0), | ||
| 'blender': (4, 0, 0), | ||
| 'category': 'Render', | ||
| 'location': 'File menu, render engine menu', | ||
| 'description': 'Mitsuba integration for Blender', | ||
| 'wiki_url': 'https://github.com/mitsuba-renderer/mitsuba-blender/wiki', | ||
| 'tracker_url': 'https://github.com/mitsuba-renderer/mitsuba-blender/issues/new/choose', | ||
| 'warning': 'alpha', | ||
| } | ||
|
|
||
| import bpy | ||
| from bpy.props import StringProperty, BoolProperty | ||
| from bpy.types import Operator, AddonPreferences | ||
| from bpy.utils import register_class, unregister_class | ||
|
|
||
| import os | ||
| import sys | ||
| import subprocess | ||
|
|
||
| from . import io, engine | ||
|
|
||
| DEPS_MITSUBA_VERSION = '3.5.0' | ||
| # Required Mitsuba version | ||
| MI_VERSION = [3, 6, 0] | ||
|
|
||
| def get_addon_preferences(context): | ||
| return context.preferences.addons[__name__].preferences | ||
|
|
||
| def init_mitsuba(context): | ||
| # Make sure we can load mitsuba from blender | ||
| try: | ||
| os.environ['DRJIT_NO_RTLD_DEEPBIND'] = 'True' | ||
| should_reload_mitsuba = 'mitsuba' in sys.modules | ||
| import mitsuba | ||
| # If mitsuba was already loaded and we change the path, we need to reload it, since the import above will be ignored | ||
| if should_reload_mitsuba: | ||
| import importlib | ||
| importlib.reload(mitsuba) | ||
| mitsuba.set_variant('scalar_rgb') | ||
| # Set the global threading environment | ||
| from mitsuba import ThreadEnvironment | ||
| bpy.types.Scene.thread_env = ThreadEnvironment() | ||
| return True | ||
| except ModuleNotFoundError: | ||
| return False | ||
| import os, importlib | ||
| import bpy | ||
|
|
||
| def try_register_mitsuba(context): | ||
| prefs = get_addon_preferences(context) | ||
| prefs.mitsuba_dependencies_status_message = '' | ||
| from . import engine | ||
| from . import exporter | ||
| from . import importer | ||
| from . import operators | ||
| from . import panels | ||
| from . import properties | ||
| from . import utils | ||
| from . import logging | ||
|
|
||
| could_init_mitsuba = False | ||
| if prefs.using_mitsuba_custom_path: | ||
| update_additional_custom_paths(prefs, context) | ||
| could_init_mitsuba = init_mitsuba(context) | ||
| if could_init_mitsuba: | ||
| import mitsuba | ||
| prefs.mitsuba_custom_version = mitsuba.__version__ | ||
| if prefs.has_valid_mitsuba_custom_version: | ||
| prefs.mitsuba_dependencies_status_message = f'Found custom Mitsuba v{prefs.mitsuba_custom_version}.' | ||
| else: | ||
| prefs.mitsuba_dependencies_status_message = f'Found custom Mitsuba v{prefs.mitsuba_custom_version}. Supported version is v{DEPS_MITSUBA_VERSION}.' | ||
| else: | ||
| prefs.mitsuba_dependencies_status_message = 'Failed to load custom Mitsuba. Please verify the path to the build directory.' | ||
| elif prefs.has_pip_dependencies: | ||
| if prefs.has_valid_dependencies_version: | ||
| could_init_mitsuba = init_mitsuba(context) | ||
| if could_init_mitsuba: | ||
| import mitsuba | ||
| prefs.mitsuba_dependencies_status_message = f'Found pip Mitsuba v{mitsuba.__version__}.' | ||
| else: | ||
| prefs.mitsuba_dependencies_status_message = 'Failed to load Mitsuba package.' | ||
| else: | ||
| prefs.mitsuba_dependencies_status_message = f'Found pip Mitsuba v{prefs.installed_dependencies_version}. Supported version is v{DEPS_MITSUBA_VERSION}.' | ||
| else: | ||
| prefs.mitsuba_dependencies_status_message = 'Mitsuba dependencies not installed.' | ||
| initialized = False | ||
|
|
||
| prefs.is_mitsuba_initialized = could_init_mitsuba | ||
| # Register the add-on preferences panel first, to have access to it | ||
| bpy.utils.register_class(panels.addon.MitsubaPreferences) | ||
|
|
||
| if could_init_mitsuba: | ||
| io.register() | ||
| engine.register() | ||
| def register(context=bpy.context): | ||
| global initialized | ||
| initialized = False | ||
|
|
||
| return could_init_mitsuba | ||
| # Lookup add-on preferences | ||
| prefs = context.preferences.addons['mitsuba_blender'].preferences | ||
|
|
||
| def try_unregister_mitsuba(): | ||
| ''' | ||
| Try unregistering Addon classes. | ||
| This may fail if Mitsuba wasn't found, hence the try catch guard | ||
| ''' | ||
| try: | ||
| io.unregister() | ||
| engine.unregister() | ||
| return True | ||
| except RuntimeError: | ||
| # Make sure a path is specified for Mitsuba | ||
| if prefs.mitsuba_path == '': | ||
| prefs.mitsuba_status_message = 'Failed to initialize Mitsuba: invalid Mitsuba path!' | ||
| prefs.initialized = False | ||
| return False | ||
|
|
||
| def try_reload_mitsuba(context): | ||
| try_unregister_mitsuba() | ||
| if try_register_mitsuba(context): | ||
| # Save user preferences | ||
| bpy.ops.wm.save_userpref() | ||
|
|
||
| def ensure_pip(): | ||
| result = subprocess.run([sys.executable, '-m', 'ensurepip'], capture_output=True) | ||
| return result.returncode == 0 | ||
|
|
||
| def check_pip_dependencies(context): | ||
| prefs = get_addon_preferences(context) | ||
| result = subprocess.run([sys.executable, '-m', 'pip', 'list'], capture_output=True) | ||
|
|
||
| prefs.has_pip_dependencies = False | ||
| prefs.has_valid_dependencies_version = False | ||
|
|
||
| if result.returncode == 0: | ||
| output_str = result.stdout.decode('utf-8') | ||
| lines = output_str.splitlines(keepends=False) | ||
| for line in lines: | ||
| parts = line.split() | ||
| if len(parts) >= 2 and parts[0] == 'mitsuba': | ||
| prefs.has_pip_dependencies = True | ||
| prefs.installed_dependencies_version = parts[1] | ||
|
|
||
| def clean_additional_custom_paths(self, context): | ||
| # Remove old values from system PATH and sys.path | ||
| if self.additional_python_path in sys.path: | ||
| sys.path.remove(self.additional_python_path) | ||
| if self.additional_path and self.additional_path in os.environ['PATH']: | ||
| items = os.environ['PATH'].split(os.pathsep) | ||
| items.remove(self.additional_path) | ||
| os.environ['PATH'] = os.pathsep.join(items) | ||
|
|
||
| def update_additional_custom_paths(self, context): | ||
| build_path = bpy.path.abspath(self.mitsuba_custom_path) | ||
| if len(build_path) > 0: | ||
| clean_additional_custom_paths(self, context) | ||
|
|
||
| # Add path to the binaries to the system PATH | ||
| self.additional_path = build_path | ||
| if self.additional_path not in os.environ['PATH']: | ||
| os.environ['PATH'] += os.pathsep + self.additional_path | ||
|
|
||
| # Add path to python libs to sys.path | ||
| self.additional_python_path = os.path.join(build_path, 'python') | ||
| if self.additional_python_path not in sys.path: | ||
| # NOTE: We insert in the first position here, so that the custom path | ||
| # supersede the pip version | ||
| sys.path.insert(0, self.additional_python_path) | ||
|
|
||
| class MITSUBA_OT_install_pip_dependencies(Operator): | ||
| bl_idname = 'mitsuba.install_pip_dependencies' | ||
| bl_label = 'Install Mitsuba pip dependencies' | ||
| bl_description = 'Use pip to install the add-on\'s required dependencies' | ||
|
|
||
| @classmethod | ||
| def poll(cls, context): | ||
| prefs = get_addon_preferences(context) | ||
| return not prefs.has_pip_dependencies or not prefs.has_valid_dependencies_version | ||
|
|
||
| def execute(self, context): | ||
| result = subprocess.run([sys.executable, '-m', 'pip', 'install', f'mitsuba=={DEPS_MITSUBA_VERSION}', '--force-reinstall'], capture_output=False) | ||
| if result.returncode != 0: | ||
| self.report({'ERROR'}, f'Failed to install Mitsuba with return code {result.returncode}.') | ||
| return {'CANCELLED'} | ||
|
|
||
| check_pip_dependencies(context) | ||
| # Update the Python path to include Mitsuba and Mitsuba | ||
| utils.update_python_paths(prefs.mitsuba_path) | ||
|
|
||
| try_reload_mitsuba(context) | ||
|
|
||
| return {'FINISHED'} | ||
|
|
||
| def update_using_mitsuba_custom_path(self, context): | ||
| self.require_restart = True | ||
| if self.using_mitsuba_custom_path: | ||
| update_mitsuba_custom_path(self, context) | ||
| else: | ||
| clean_additional_custom_paths(self, context) | ||
|
|
||
| def update_mitsuba_custom_path(self, context): | ||
| if self.is_mitsuba_initialized: | ||
| self.require_restart = True | ||
| if self.using_mitsuba_custom_path and len(self.mitsuba_custom_path) > 0: | ||
| update_additional_custom_paths(self, context) | ||
| if not self.is_mitsuba_initialized: | ||
| try_reload_mitsuba(context) | ||
|
|
||
| def update_installed_dependencies_version(self, context): | ||
| self.has_valid_dependencies_version = self.installed_dependencies_version == DEPS_MITSUBA_VERSION | ||
|
|
||
| def update_mitsuba_custom_version(self, context): | ||
| self.has_valid_mitsuba_custom_version = self.mitsuba_custom_version == DEPS_MITSUBA_VERSION | ||
|
|
||
| class MitsubaPreferences(AddonPreferences): | ||
| bl_idname = __name__ | ||
|
|
||
| is_mitsuba_initialized : BoolProperty( | ||
| name = 'Is Mitsuba initialized', | ||
| ) | ||
|
|
||
| has_pip_dependencies : BoolProperty( | ||
| name = 'Has pip dependencies installed', | ||
| ) | ||
|
|
||
| installed_dependencies_version : StringProperty( | ||
| name = 'Installed Mitsuba dependencies version string', | ||
| default = '', | ||
| update = update_installed_dependencies_version, | ||
| ) | ||
|
|
||
| has_valid_dependencies_version : BoolProperty( | ||
| name = 'Has the correct version of dependencies' | ||
| ) | ||
|
|
||
| mitsuba_dependencies_status_message : StringProperty( | ||
| name = 'Mitsuba dependencies status message', | ||
| default = '', | ||
| ) | ||
|
|
||
| require_restart : BoolProperty( | ||
| name = 'Require a Blender restart', | ||
| ) | ||
|
|
||
| # Advanced settings | ||
|
|
||
| using_mitsuba_custom_path : BoolProperty( | ||
| name = 'Using custom Mitsuba path', | ||
| update = update_using_mitsuba_custom_path, | ||
| ) | ||
|
|
||
| mitsuba_custom_path : StringProperty( | ||
| name = 'Custom Mitsuba path', | ||
| description = 'Path to the custom Mitsuba build directory', | ||
| default = '', | ||
| subtype = 'DIR_PATH', | ||
| update = update_mitsuba_custom_path, | ||
| ) | ||
|
|
||
| mitsuba_custom_version : StringProperty( | ||
| name = 'Custom Mitsuba build version', | ||
| default = '', | ||
| update = update_mitsuba_custom_version, | ||
| ) | ||
|
|
||
| has_valid_mitsuba_custom_version : BoolProperty( | ||
| name = 'Has the correct version of custom Mitsuba build' | ||
| ) | ||
|
|
||
| additional_path : StringProperty( | ||
| name = 'Addition to PATH', | ||
| default = '', | ||
| subtype = 'DIR_PATH', | ||
| ) | ||
|
|
||
| additional_python_path : StringProperty( | ||
| name = 'Addition to sys.path', | ||
| default = '', | ||
| subtype = 'DIR_PATH', | ||
| ) | ||
|
|
||
| def draw(self, context): | ||
| layout = self.layout | ||
|
|
||
| row = layout.row() | ||
| icon = 'ERROR' | ||
| row.alert = True | ||
| if self.require_restart: | ||
| self.mitsuba_dependencies_status_message = 'A restart is required to apply the changes.' | ||
| elif self.is_mitsuba_initialized and (not self.using_mitsuba_custom_path or (self.using_mitsuba_custom_path and self.has_valid_mitsuba_custom_version)): | ||
| icon = 'CHECKMARK' | ||
| row.alert = False | ||
| row.label(text=self.mitsuba_dependencies_status_message, icon=icon) | ||
| # Test Mitsuba module | ||
| try: | ||
| os.environ['DRJIT_NO_RTLD_DEEPBIND'] = 'True' | ||
| import mitsuba as mi | ||
| mi.set_variant(*[v for v in mi.variants() if not v.startswith('scalar')]) | ||
|
|
||
| # Check Mitsuba version | ||
| v = [int(v) for v in mi.__version__.split('.')] | ||
| valid_version = False | ||
| if v[0] > MI_VERSION[0]: | ||
| valid_version = True | ||
| elif v[0] == MI_VERSION[0]: | ||
| if v[1] > MI_VERSION[1]: | ||
| valid_version = True | ||
| elif v[1] == MI_VERSION[1]: | ||
| if v[2] >= MI_VERSION[2]: | ||
| valid_version = True | ||
| if not valid_version: | ||
| prefs.mitsuba_status_message = f'Need to upgrade your Mitsuba installation! (found {mitsuba_version}, need >= {MI_VERSION})' | ||
| prefs.initialized = False | ||
| else: | ||
| # Set the global threading environment | ||
| bpy.types.Scene.thread_env = mi.ThreadEnvironment() | ||
| prefs.initialized = True | ||
| except ModuleNotFoundError as e: | ||
| prefs.mitsuba_status_message = str(e) | ||
| prefs.initialized = False | ||
|
|
||
| operator_text = 'Install dependencies' | ||
| if self.has_pip_dependencies and not self.has_valid_dependencies_version: | ||
| operator_text = 'Update dependencies' | ||
| layout.operator(MITSUBA_OT_install_pip_dependencies.bl_idname, text=operator_text) | ||
| if not prefs.initialized: | ||
| prefs.mitsuba_status_message = f'Failed to register the mitsuba_blender addon: {prefs.mitsuba_status_message}' | ||
| print(prefs.mitsuba_status_message) | ||
| return | ||
|
|
||
| box = layout.box() | ||
| box.label(text='Advanced Settings') | ||
| box.prop(self, 'using_mitsuba_custom_path', text=f'Use custom Mitsuba path (Supported version is v{DEPS_MITSUBA_VERSION})') | ||
| if self.using_mitsuba_custom_path: | ||
| box.prop(self, 'mitsuba_custom_path') | ||
| initialized = True | ||
|
|
||
| classes = ( | ||
| MITSUBA_OT_install_pip_dependencies, | ||
| MitsubaPreferences, | ||
| ) | ||
| # Register plugins to Mitsuba | ||
| from . import plugins | ||
|
|
||
| def register(): | ||
| for cls in classes: | ||
| register_class(cls) | ||
| logging.register() | ||
|
|
||
| context = bpy.context | ||
| prefs = get_addon_preferences(context) | ||
| prefs.require_restart = False | ||
| prefs.mitsuba_status_message = 'Successfully initialized Mitsuba' | ||
| logging.info(f'mitsuba_blender registered (with mitsuba v{mi.MI_VERSION}, path={mi.__path__[0]})') | ||
|
|
||
| if not ensure_pip(): | ||
| raise RuntimeError('Cannot activate mitsuba-blender add-on. Python pip module cannot be initialized.') | ||
| engine.register() | ||
| exporter.register() | ||
| operators.register() | ||
| panels.register() | ||
| properties.register() | ||
|
|
||
| check_pip_dependencies(context) | ||
| if try_register_mitsuba(context): | ||
| import mitsuba | ||
| print(f'mitsuba-blender v{".".join(str(e) for e in bl_info["version"])}{bl_info["warning"] if "warning" in bl_info else ""} registered (with mitsuba v{mitsuba.__version__})') | ||
| # Reload Mitsuba to make sure we are up-to-date with the code | ||
| import mitsuba | ||
| importlib.reload(mitsuba) | ||
|
|
||
| def unregister(): | ||
| for cls in classes: | ||
| unregister_class(cls) | ||
| try_unregister_mitsuba() | ||
| global initialized | ||
| if initialized: | ||
| bpy.types.Scene.thread_env = None | ||
| engine.unregister() | ||
| exporter.unregister() | ||
| operators.unregister() | ||
| panels.unregister() | ||
| properties.unregister() | ||
| logging.unregister() |
Oops, something went wrong.