Merge pull request #1402 from johnhaddon/vdbPyBind

VDBObject bindings : Adapt for OpenVDB 10.1

Author: johnhaddon

Changes

@@ -1,6 +1,11 @@
 10.5.x.x (relative to 10.5.4.2)
 ========
 
+Features
+--------
+
+- PyBindConverter : Added new class providing interoperability between Boost Python bindings and PyBind11 bindings.
+
 Improvements
 ------------
 
@@ -10,6 +15,7 @@ Fixes
 -----
 
 - CompoundObject : Fixed crashes in Python bindings caused by passing `None` as a key.
+- VDBObject : Fixed Python bindings for OpenVDB 10.1.
 
 10.5.4.2 (relative to 10.5.4.1)
 ========

include/IECorePython/PyBindConverter.h

@@ -0,0 +1,102 @@
+
+//////////////////////////////////////////////////////////////////////////
+//
+//  Copyright (c) 2024, Cinesite VFX Ltd. All rights reserved.
+//
+//  Redistribution and use in source and binary forms, with or without
+//  modification, are permitted provided that the following conditions are
+//  met:
+//
+//      * Redistributions of source code must retain the above
+//        copyright notice, this list of conditions and the following
+//        disclaimer.
+//
+//      * Redistributions in binary form must reproduce the above
+//        copyright notice, this list of conditions and the following
+//        disclaimer in the documentation and/or other materials provided with
+//        the distribution.
+//
+//      * Neither the name of John Haddon nor the names of
+//        any other contributors to this software may be used to endorse or
+//        promote products derived from this software without specific prior
+//        written permission.
+//
+//  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+//  IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+//  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+//  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+//  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+//  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+//  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+//  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+//  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+//  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+//  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+//
+//////////////////////////////////////////////////////////////////////////
+
+#ifndef IECOREPYTHON_PYBINDCONVERTER_H
+#define IECOREPYTHON_PYBINDCONVERTER_H
+
+#include "boost/python.hpp"
+
+#include "pybind11/pybind11.h"
+
+namespace IECorePython
+{
+
+// Registers `boost::python` converters for types
+// wrapped using PyBind11.
+template<typename T>
+struct PyBindConverter
+{
+
+	static void registerConverters()
+	{
+		boost::python::to_python_converter<T, ToPyBind>();
+		boost::python::converter::registry::push_back(
+			&FromPyBind::convertible,
+			&FromPyBind::construct,
+			boost::python::type_id<T>()
+		);
+	}
+
+	private :
+
+		struct ToPyBind
+		{
+			static PyObject *convert( const T &t )
+			{
+				pybind11::object o = pybind11::cast( t );
+				Py_INCREF( o.ptr() );
+				return o.ptr();
+			}
+		};
+
+		struct FromPyBind
+		{
+
+			static void *convertible( PyObject *object )
+			{
+				pybind11::handle handle( object );
+				return handle.cast<T>() ? object : nullptr;
+			}
+
+			static void construct( PyObject *object, boost::python::converter::rvalue_from_python_stage1_data *data )
+			{
+				void *storage = ( ( boost::python::converter::rvalue_from_python_storage<T> * ) data )->storage.bytes;
+				T *t = new( storage ) T;
+				data->convertible = storage;
+
+				pybind11::handle handle( object );
+				*t = handle.cast<T>();
+			}
+
+		};
+
+};
+
+} // namespace IECorePython
+
+#endif // IECOREPYTHON_PYBINDCONVERTER_H
+

src/IECoreVDB/bindings/IECoreVDBModule.cpp

@@ -41,10 +41,19 @@
 
 #include "IECoreVDB/VDBObject.h"
 
+// OpenVDB 10.0 and earlier used `boost::python` for its Python bindings, but
+// this was switched to PyBind11 in OpenVDB 10.1. We need to take a different
+// approach to binding VDBObject's grid accessors in each case.
+#if OPENVDB_LIBRARY_MAJOR_VERSION_NUMBER > 10 || OPENVDB_LIBRARY_MAJOR_VERSION_NUMBER == 10 && OPENVDB_LIBRARY_MINOR_VERSION_NUMBER >= 1
+#include "IECorePython/PyBindConverter.h"
+#define IECOREVDB_USE_PYBIND
+#endif
 
 using namespace boost::python;
 using namespace IECoreVDB;
 
+#ifndef IECOREVDB_USE_PYBIND
+
 namespace
 {
 
@@ -118,18 +127,6 @@ openvdb::GridBase::Ptr getGridFromPyObject( const boost::python::object &gridObj
 
 } // namespace iepyopenvdb
 
-
-boost::python::list gridNames( VDBObject::Ptr vdbObject )
-{
-	boost::python::list result;
-	std::vector<std::string> names = vdbObject->gridNames();
-	for( const auto &name : names )
-	{
-		result.append( name );
-	}
-	return result;
-}
-
 boost::python::object findGrid( VDBObject::Ptr vdbObject, const std::string &gridName )
 {
 	openvdb::GridBase::Ptr grid = vdbObject->findGrid( gridName );
@@ -151,17 +148,44 @@ void insertGrid( VDBObject::Ptr vdbObject, boost::python::object pyObject )
 
 } // namespace
 
+#endif // #ifndef IECOREVDB_USE_PYBIND
+
+namespace
+{
+
+boost::python::list gridNames( VDBObject::Ptr vdbObject )
+{
+	boost::python::list result;
+	std::vector<std::string> names = vdbObject->gridNames();
+	for( const auto &name : names )
+	{
+		result.append( name );
+	}
+	return result;
+}
+
+} // namespace
+
 BOOST_PYTHON_MODULE( _IECoreVDB )
 {
 
+#ifdef IECOREVDB_USE_PYBIND
+	IECorePython::PyBindConverter<openvdb::GridBase::Ptr>::registerConverters();
+#endif
+
 	IECorePython::RunTimeTypedClass<VDBObject>()
 		.def(init<const std::string &>())
 		.def(init<>())
 		.def("gridNames", &::gridNames)
 		.def("metadata", &VDBObject::metadata)
 		.def("removeGrid", &VDBObject::removeGrid)
+#ifdef IECOREVDB_USE_PYBIND
+		.def( "findGrid", (openvdb::GridBase::Ptr (VDBObject::*)( const std::string &name ))&VDBObject::findGrid )
+		.def( "insertGrid", &VDBObject::insertGrid )
+#else
 		.def("findGrid", &::findGrid)
 		.def("insertGrid", &::insertGrid)
+#endif
 		.def("unmodifiedFromFile", &VDBObject::unmodifiedFromFile)
 		.def("fileName", &VDBObject::fileName)
 		;

test/IECoreVDB/VDBObjectTest.py

@@ -35,6 +35,7 @@
 ##########################################################################
 
 import os
+import unittest
 import imath
 
 import IECore
@@ -240,10 +241,10 @@ def incValue( value ) :
 
 		d = smoke.findGrid( "density" )
 
-		d2Value = list( d2.citerAllValues() )[0]
-		dValue = list( d.citerAllValues() )[0]
+		d2Value = next( d2.citerAllValues() )
+		dValue = next( d.citerAllValues() )
 
-		self.assertEqual( d2Value['value'], dValue['value'] + 1 )
+		self.assertEqual( d2Value.value, dValue.value + 1 )
 
 		# we've requested mutable grids from both vdb objects so they could have been edited.
 		self.assertFalse( smoke.unmodifiedFromFile() )