USD: Include USD library version in System Info

Pixar recently released USD 20.02 [1]. I think it's important for people
to be able to figure out which version of the USD library is used in
Blender.

[1] https://github.com/PixarAnimationStudios/USD/releases/tag/v20.02

This commit exposes the USD library information via `bpy.app.usd`, and
includes that info in the `system-info.txt` saved via Help → Save System
Info.

Reviewed by: brecht

Differential Revision: https://developer.blender.org/D6724

release/scripts/modules/sys_info.py

@@ -172,6 +172,13 @@ def write_sysinfo(filepath):
             else:
                 output.write("Blender was built without Alembic support\n")
 
+            usd = bpy.app.usd
+            output.write("USD: ")
+            if usd.supported:
+                output.write("%s\n" % usd.version_string)
+            else:
+                output.write("Blender was built without USD support\n")
+
             if not bpy.app.build_options.sdl:
                 output.write("SDL: Blender was built without SDL support\n")
 

source/blender/python/intern/CMakeLists.txt

@@ -56,6 +56,7 @@ set(SRC
   bpy_app_sdl.c
   bpy_app_timers.c
   bpy_app_translations.c
+  bpy_app_usd.c
   bpy_capi_utils.c
   bpy_driver.c
   bpy_gizmo_wrap.c
@@ -95,6 +96,7 @@ set(SRC
   bpy_app_sdl.h
   bpy_app_timers.h
   bpy_app_translations.h
+  bpy_app_usd.h
   bpy_capi_utils.h
   bpy_driver.h
   bpy_gizmo_wrap.h
@@ -309,6 +311,9 @@ endif()
 
 if(WITH_USD)
   add_definitions(-DWITH_USD)
+  list(APPEND INC
+    ../../usd
+  )
 endif()
 
 if(WITH_OPENIMAGEIO)

source/blender/python/intern/bpy_app.c

@@ -33,6 +33,7 @@
 #include "bpy_app_opensubdiv.h"
 #include "bpy_app_openvdb.h"
 #include "bpy_app_sdl.h"
+#include "bpy_app_usd.h"
 #include "bpy_app_build_options.h"
 
 #include "bpy_app_translations.h"
@@ -108,6 +109,7 @@ static PyStructSequence_Field app_info_fields[] = {
 
     /* submodules */
     {"alembic", "Alembic library information backend"},
+    {"usd", "USD library information backend"},
     {"ffmpeg", "FFmpeg library information backend"},
     {"ocio", "OpenColorIO library information backend"},
     {"oiio", "OpenImageIO library information backend"},
@@ -201,6 +203,7 @@ static PyObject *make_app_info(void)
 #endif
 
   SetObjItem(BPY_app_alembic_struct());
+  SetObjItem(BPY_app_usd_struct());
   SetObjItem(BPY_app_ffmpeg_struct());
   SetObjItem(BPY_app_ocio_struct());
   SetObjItem(BPY_app_oiio_struct());

source/blender/python/intern/bpy_app_usd.c

@@ -0,0 +1,107 @@
+/*
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * The Original Code is Copyright (C) 2020 Blender Foundation.
+ * All rights reserved.
+ */
+
+/** \file
+ * \ingroup pythonintern
+ */
+
+#include <Python.h>
+#include "BLI_utildefines.h"
+
+#include "bpy_app_usd.h"
+
+#include "../generic/py_capi_utils.h"
+
+#ifdef WITH_USD
+#  include "usd.h"
+#endif
+
+static PyTypeObject BlenderAppUSDType;
+
+static PyStructSequence_Field app_usd_info_fields[] = {
+    {"supported", "Boolean, True when Blender is built with USD support"},
+    {"version", "The USD version as a tuple of 3 numbers"},
+    {"version_string", "The USD version formatted as a string"},
+    {NULL},
+};
+
+static PyStructSequence_Desc app_usd_info_desc = {
+    "bpy.app.usd", /* name */
+    "This module contains information about the Universal Scene Description library Bender is "
+    "linked against",    /* doc */
+    app_usd_info_fields, /* fields */
+    ARRAY_SIZE(app_usd_info_fields) - 1,
+};
+
+static PyObject *make_usd_info(void)
+{
+  PyObject *usd_info = PyStructSequence_New(&BlenderAppUSDType);
+
+  if (usd_info == NULL) {
+    return NULL;
+  }
+
+  int pos = 0;
+
+#ifndef WITH_USD
+#  define SetStrItem(str) PyStructSequence_SET_ITEM(usd_info, pos++, PyUnicode_FromString(str))
+#endif
+
+#define SetObjItem(obj) PyStructSequence_SET_ITEM(usd_info, pos++, obj)
+
+#ifdef WITH_USD
+  const int curversion = USD_get_version();
+  const int major = curversion / 10000;
+  const int minor = (curversion / 100) % 100;
+  const int patch = curversion % 100;
+
+  SetObjItem(PyBool_FromLong(1));
+  SetObjItem(PyC_Tuple_Pack_I32(major, minor, patch));
+  SetObjItem(PyUnicode_FromFormat("%2d, %2d, %2d", major, minor, patch));
+#else
+  SetObjItem(PyBool_FromLong(0));
+  SetObjItem(PyC_Tuple_Pack_I32(0, 0, 0));
+  SetStrItem("Unknown");
+#endif
+
+  if (PyErr_Occurred()) {
+    Py_CLEAR(usd_info);
+    return NULL;
+  }
+
+#undef SetStrItem
+#undef SetObjItem
+
+  return usd_info;
+}
+
+PyObject *BPY_app_usd_struct(void)
+{
+  PyStructSequence_InitType(&BlenderAppUSDType, &app_usd_info_desc);
+
+  PyObject *ret = make_usd_info();
+
+  /* prevent user from creating new instances */
+  BlenderAppUSDType.tp_init = NULL;
+  BlenderAppUSDType.tp_new = NULL;
+  BlenderAppUSDType.tp_hash = (hashfunc)
+      _Py_HashPointer; /* without this we can't do set(sys.modules) [#29635] */
+
+  return ret;
+}

source/blender/python/intern/bpy_app_usd.h

@@ -0,0 +1,29 @@
+/*
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * The Original Code is Copyright (C) 2020 Blender Foundation.
+ * All rights reserved.
+ */
+
+/** \file
+ * \ingroup pythonintern
+ */
+
+#ifndef __BPY_APP_USD_H__
+#define __BPY_APP_USD_H__
+
+PyObject *BPY_app_usd_struct(void);
+
+#endif /* __BPY_APP_USD_H__ */

source/blender/usd/intern/usd_capi.cc

@@ -20,6 +20,7 @@
 #include "usd.h"
 #include "usd_hierarchy_iterator.h"
 
+#include <pxr/pxr.h>
 #include <pxr/usd/usd/stage.h>
 #include <pxr/usd/usdGeom/tokens.h>
 
@@ -216,3 +217,17 @@ bool USD_export(bContext *C,
 
   return export_ok;
 }
+
+int USD_get_version(void)
+{
+  /* USD 19.11 defines:
+   *
+   * #define PXR_MAJOR_VERSION 0
+   * #define PXR_MINOR_VERSION 19
+   * #define PXR_PATCH_VERSION 11
+   * #define PXR_VERSION 1911
+   *
+   * So the major version is implicit/invisible in the public version number.
+   */
+  return PXR_VERSION;
+}

source/blender/usd/usd.h

@@ -54,6 +54,8 @@ bool USD_export(struct bContext *C,
                 const struct USDExportParams *params,
                 bool as_background_job);
 
+int USD_get_version(void);
+
 #ifdef __cplusplus
 }
 #endif