From patchwork Tue May 30 09:20:16 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tomi Valkeinen X-Patchwork-Id: 18661 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id B7B8BC3213 for ; Tue, 30 May 2023 09:21:03 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 787886287F; Tue, 30 May 2023 11:21:03 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org; s=mail; t=1685438463; bh=PltyImOLae7tYoV0O4X3/qeWYKQH+YvzD+u+TI6Fqls=; h=To:Date:In-Reply-To:References:Subject:List-Id:List-Unsubscribe: List-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To: From; b=b6+HObCkXMbJFyKePIIuOhJr59bT7mZoQM+EvQ5iWvmIL0vDn1StKtAxUnB9h7D2x K3jtvKmhi5jSP6ACKfdlantEwbGMgRlcJuWEvinVDn1+7n6ksodsJ1omFVUOd6wGbd qUmlziU3EQNLYnzIFvFWX/LdLtbtbj38rRBCulQIP6aWragNzh4fpBrs1reoDNDMA1 xTYsb3FxDwptqyrCI+Fugt6fjNlZ6IUwSfiXtV9dA0qBFDUmvIoD0OFvNnlTqpFh25 Qsunj+dFKLD7HMVdfkstOjEUvsbtreX5DViczuyOI5fZe8YCOog4ULNrRrprNurt7x yhe0AkaIzQgkA== Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id B831A6287D for ; Tue, 30 May 2023 11:20:58 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="EFvzvG+K"; dkim-atps=neutral Received: from desky.lan (91-154-35-171.elisa-laajakaista.fi [91.154.35.171]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id AC3A07F3; Tue, 30 May 2023 11:20:37 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1685438438; bh=PltyImOLae7tYoV0O4X3/qeWYKQH+YvzD+u+TI6Fqls=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=EFvzvG+Kz9T9Hlb1Pm2/NCnmuHIwLFyymBJGkBGQvoUVLu4JQmlUoSZiJGqR4Jdwg K8/lccl/5K+xu7MratR5Ma2hb53BZchoqjE5QpUkWIOHw6CeJov5MgQZgSn6MSo5yp 6CO6ZQ6MsYkpsJ3KXp1FQOBHlkkf3c5nN2nrcZp0= To: libcamera-devel@lists.libcamera.org Date: Tue, 30 May 2023 12:20:16 +0300 Message-Id: <20230530092016.34953-6-tomi.valkeinen@ideasonboard.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20230530092016.34953-1-tomi.valkeinen@ideasonboard.com> References: <20230530092016.34953-1-tomi.valkeinen@ideasonboard.com> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH 5/5] py: Move to mainline pybind11 version X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-Patchwork-Original-From: Tomi Valkeinen via libcamera-devel From: Tomi Valkeinen Reply-To: Tomi Valkeinen Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" We are using pybind11 'smart_holder' branch to solve the Camera destructor issue (see the comment in this patch, or the commit that originally added Python bindings support). As it would be very nice to use the mainline pybind11 (which is packaged in distributions), this patch adds a workaround allowing us to move to the mainline pybind11 version. The workaround is simply creating a custom holder class, used only for the Camera, which wraps around the shared_ptr. This makes the compiler happy. Moving to mainline pybdin11 is achieved with: - Change the pybind11 wrap to point to the mainline pybdind11 version - Change the meson.build file to use a system-installed pybind11 if available, and use the pybind11 subproject as a fallback. The fallback is there as a convenience, as pybind11 may not be available in pre-packaged form in all environments. Signed-off-by: Tomi Valkeinen --- src/py/libcamera/meson.build | 11 ++-- src/py/libcamera/py_camera_manager.h | 2 +- src/py/libcamera/py_color_space.cpp | 2 +- src/py/libcamera/py_controls_generated.cpp.in | 2 +- src/py/libcamera/py_enums.cpp | 2 +- src/py/libcamera/py_formats_generated.cpp.in | 2 +- src/py/libcamera/py_geometry.cpp | 2 +- src/py/libcamera/py_helpers.h | 2 +- src/py/libcamera/py_main.cpp | 52 +++++++++++++++++-- .../libcamera/py_properties_generated.cpp.in | 2 +- src/py/libcamera/py_transform.cpp | 2 +- subprojects/.gitignore | 2 +- subprojects/pybind11.wrap | 18 ++++--- 13 files changed, 76 insertions(+), 25 deletions(-) diff --git a/src/py/libcamera/meson.build b/src/py/libcamera/meson.build index f87b1b4d..9d86d8bf 100644 --- a/src/py/libcamera/meson.build +++ b/src/py/libcamera/meson.build @@ -7,10 +7,15 @@ if not py3_dep.found() subdir_done() endif -pycamera_enabled = true +pybind11_dep = dependency('pybind11', required : get_option('pycamera'), + fallback : ['pybind11', 'pybind11_dep']) + +if not pybind11_dep.found() + pycamera_enabled = false + subdir_done() +endif -pybind11_proj = subproject('pybind11') -pybind11_dep = pybind11_proj.get_variable('pybind11_dep') +pycamera_enabled = true pycamera_sources = files([ 'py_camera_manager.cpp', diff --git a/src/py/libcamera/py_camera_manager.h b/src/py/libcamera/py_camera_manager.h index 3525057d..3574db23 100644 --- a/src/py/libcamera/py_camera_manager.h +++ b/src/py/libcamera/py_camera_manager.h @@ -9,7 +9,7 @@ #include -#include +#include using namespace libcamera; diff --git a/src/py/libcamera/py_color_space.cpp b/src/py/libcamera/py_color_space.cpp index a8301e3d..5201121a 100644 --- a/src/py/libcamera/py_color_space.cpp +++ b/src/py/libcamera/py_color_space.cpp @@ -9,7 +9,7 @@ #include #include -#include +#include #include namespace py = pybind11; diff --git a/src/py/libcamera/py_controls_generated.cpp.in b/src/py/libcamera/py_controls_generated.cpp.in index cb8442ba..18fa57d9 100644 --- a/src/py/libcamera/py_controls_generated.cpp.in +++ b/src/py/libcamera/py_controls_generated.cpp.in @@ -9,7 +9,7 @@ #include -#include +#include namespace py = pybind11; diff --git a/src/py/libcamera/py_enums.cpp b/src/py/libcamera/py_enums.cpp index 96d4beef..803c4e7e 100644 --- a/src/py/libcamera/py_enums.cpp +++ b/src/py/libcamera/py_enums.cpp @@ -7,7 +7,7 @@ #include -#include +#include namespace py = pybind11; diff --git a/src/py/libcamera/py_formats_generated.cpp.in b/src/py/libcamera/py_formats_generated.cpp.in index b88807f3..a3f7f94d 100644 --- a/src/py/libcamera/py_formats_generated.cpp.in +++ b/src/py/libcamera/py_formats_generated.cpp.in @@ -9,7 +9,7 @@ #include -#include +#include namespace py = pybind11; diff --git a/src/py/libcamera/py_geometry.cpp b/src/py/libcamera/py_geometry.cpp index 84b0cb08..5c2aeac4 100644 --- a/src/py/libcamera/py_geometry.cpp +++ b/src/py/libcamera/py_geometry.cpp @@ -11,7 +11,7 @@ #include #include -#include +#include #include namespace py = pybind11; diff --git a/src/py/libcamera/py_helpers.h b/src/py/libcamera/py_helpers.h index cd31e2cc..983969df 100644 --- a/src/py/libcamera/py_helpers.h +++ b/src/py/libcamera/py_helpers.h @@ -7,7 +7,7 @@ #include -#include +#include pybind11::object controlValueToPy(const libcamera::ControlValue &cv); libcamera::ControlValue pyToControlValue(const pybind11::object &ob, libcamera::ControlType type); diff --git a/src/py/libcamera/py_main.cpp b/src/py/libcamera/py_main.cpp index c66b90cd..bbae7a99 100644 --- a/src/py/libcamera/py_main.cpp +++ b/src/py/libcamera/py_main.cpp @@ -17,7 +17,7 @@ #include #include -#include +#include #include #include @@ -33,6 +33,50 @@ namespace libcamera { LOG_DEFINE_CATEGORY(Python) } +/* + * This is a holder class used only for the Camera class, for the sole purpose + * of avoiding the compilation issue with Camera's private destructor. + * + * pybind11 requires a public destructor for classes held with shared_ptrs, even + * in cases where the public destructor is not strictly needed. The current + * understanding is that there are the following options to solve the problem: + * + * - Use pybind11 'smart_holder' branch. The downside is that 'smart_holder' + * is not the mainline branch, and not available in distributions. + * - https://github.com/pybind/pybind11/pull/2067 + * - Make the Camera destructor public + * - Something like the PyCameraSmartPtr here, which adds a layer, hiding the + * issue. + */ +template +class PyCameraSmartPtr +{ +public: + using element_type = T; + + PyCameraSmartPtr() + { + } + + explicit PyCameraSmartPtr(T *) + { + throw std::runtime_error("invalid SmartPtr constructor call"); + } + + explicit PyCameraSmartPtr(std::shared_ptr p) + : ptr_(p) + { + } + + T *get() const { return ptr_.get(); } + + operator std::shared_ptr() const { return ptr_; } + +private: + std::shared_ptr ptr_; +}; + +PYBIND11_DECLARE_HOLDER_TYPE(T, PyCameraSmartPtr); /* * Note: global C++ destructors can be ran on this before the py module is @@ -65,8 +109,8 @@ PYBIND11_MODULE(_libcamera, m) * https://pybind11.readthedocs.io/en/latest/advanced/misc.html#avoiding-c-types-in-docstrings */ - auto pyCameraManager = py::class_(m, "CameraManager"); - auto pyCamera = py::class_(m, "Camera"); + auto pyCameraManager = py::class_>(m, "CameraManager"); + auto pyCamera = py::class_>(m, "Camera"); auto pyCameraConfiguration = py::class_(m, "CameraConfiguration"); auto pyCameraConfigurationStatus = py::enum_(pyCameraConfiguration, "Status"); auto pyStreamConfiguration = py::class_(m, "StreamConfiguration"); @@ -271,7 +315,7 @@ PYBIND11_MODULE(_libcamera, m) .def("range", &StreamFormats::range); pyFrameBufferAllocator - .def(py::init>(), py::keep_alive<1, 2>()) + .def(py::init>(), py::keep_alive<1, 2>()) .def("allocate", [](FrameBufferAllocator &self, Stream *stream) { int ret = self.allocate(stream); if (ret < 0) diff --git a/src/py/libcamera/py_properties_generated.cpp.in b/src/py/libcamera/py_properties_generated.cpp.in index 044b2b2a..e49b6e91 100644 --- a/src/py/libcamera/py_properties_generated.cpp.in +++ b/src/py/libcamera/py_properties_generated.cpp.in @@ -9,7 +9,7 @@ #include -#include +#include namespace py = pybind11; diff --git a/src/py/libcamera/py_transform.cpp b/src/py/libcamera/py_transform.cpp index 08783e29..f3a0bfaf 100644 --- a/src/py/libcamera/py_transform.cpp +++ b/src/py/libcamera/py_transform.cpp @@ -9,7 +9,7 @@ #include #include -#include +#include #include namespace py = pybind11; diff --git a/subprojects/.gitignore b/subprojects/.gitignore index 0a8fd3a6..ebe59479 100644 --- a/subprojects/.gitignore +++ b/subprojects/.gitignore @@ -4,4 +4,4 @@ /libyaml /libyuv /packagecache -/pybind11 +/pybind11-* diff --git a/subprojects/pybind11.wrap b/subprojects/pybind11.wrap index dd02687b..96ec57a1 100644 --- a/subprojects/pybind11.wrap +++ b/subprojects/pybind11.wrap @@ -1,11 +1,13 @@ -# SPDX-License-Identifier: CC0-1.0 - -[wrap-git] -url = https://github.com/pybind/pybind11.git -# This is the head of 'smart_holder' branch -revision = aebdf00cd060b871c5a1e0c2cf4a333503dd0431 -depth = 1 -patch_directory = pybind11 +[wrap-file] +directory = pybind11-2.10.4 +source_url = https://github.com/pybind/pybind11/archive/refs/tags/v2.10.4.tar.gz +source_filename = pybind11-2.10.4.tar.gz +source_hash = 832e2f309c57da9c1e6d4542dedd34b24e4192ecb4d62f6f4866a737454c9970 +patch_filename = pybind11_2.10.4-1_patch.zip +patch_url = https://wrapdb.mesonbuild.com/v2/pybind11_2.10.4-1/get_patch +patch_hash = 9489d0cdc1244078a3108c52b4591a6f07f3dc30ca7299d3a3c42b84fa763396 +source_fallback_url = https://github.com/mesonbuild/wrapdb/releases/download/pybind11_2.10.4-1/pybind11-2.10.4.tar.gz +wrapdb_version = 2.10.4-1 [provide] pybind11 = pybind11_dep