/* This file is part of Magnum. Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022 Vladimír Vondruš Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ #include #include #include #include /** @todo drop once we have our string casters */ #include #include #include #include #include #include "Corrade/Containers/PythonBindings.h" #include "Corrade/Containers/StridedArrayViewPythonBindings.h" #include "Magnum/PythonBindings.h" #include "corrade/pluginmanager.h" #include "magnum/bootstrap.h" namespace magnum { namespace { template PyObject* implicitlyConvertibleToImageView(PyObject* obj, PyTypeObject*) { py::detail::make_caster> caster; if(!caster.load(obj, false)) { return nullptr; } Trade::ImageData& data = caster; if(data.isCompressed()) { PyErr_SetString(PyExc_RuntimeError, "image is compressed"); throw py::error_already_set{}; } auto r = pyCastButNotShitty(pyImageViewHolder(ImageView(data), py::reinterpret_borrow(obj))).release().ptr(); return r; } template void imageData(py::class_>& c) { /* Missing APIs: Dimensions */ /* These two are quite hacky attempts to bring the ImageData -> ImageView conversion operator functionality here. Using py::implicitly_convertible alone doesn't work as it only calls conversion constructors exposed to Python, and we can't expose such a thing to Python because ImageView is defined in the `magnum` module while this is `magnum.trade`, and that would mean a cyclic dependency. Instead, I took the guts of py::implicitly_convertible and instead of calling into Python I'm calling the C++ conversion operator directly myself. That alone is not enough, as this implicit conversion is only chosen if the target type has a Python-exposed constructor that takes a type that's implicitly convertible from the source type. Ugh. If this ever breaks with a pybind update, I'm probably going to reimplement this in a pure duck-typed fashion. I hope not tho. */ { auto tinfo = py::detail::get_type_info(typeid(ImageView)); CORRADE_INTERNAL_ASSERT(tinfo); tinfo->implicit_conversions.push_back(implicitlyConvertibleToImageView); } { auto tinfo = py::detail::get_type_info(typeid(ImageView)); CORRADE_INTERNAL_ASSERT(tinfo); tinfo->implicit_conversions.push_back(implicitlyConvertibleToImageView); } c /* There are no constructors at the moment --- expecting those types get only created by importers. (It would also need the Array type and movability figured out, postponing that to later.) */ /* Properties */ .def_property_readonly("is_compressed", &Trade::ImageData::isCompressed, "Whether the image is compressed") .def_property_readonly("storage", [](Trade::ImageData& self) { if(self.isCompressed()) { PyErr_SetString(PyExc_AttributeError, "image is compressed"); throw py::error_already_set{}; } return self.storage(); }, "Storage of pixel data") .def_property_readonly("format", [](Trade::ImageData& self) { if(self.isCompressed()) { PyErr_SetString(PyExc_AttributeError, "image is compressed"); throw py::error_already_set{}; } return self.format(); }, "Format of pixel data") .def_property_readonly("pixel_size", [](Trade::ImageData& self) { if(self.isCompressed()) { PyErr_SetString(PyExc_AttributeError, "image is compressed"); throw py::error_already_set{}; } return self.pixelSize(); }, "Pixel size (in bytes)") .def_property_readonly("size", [](Trade::ImageData& self) { return PyDimensionTraits::from(self.size()); }, "Image size") .def_property_readonly("data", [](Trade::ImageData& self) { return Containers::pyArrayViewHolder(self.data(), py::cast(self)); }, "Image data") .def_property_readonly("pixels", [](Trade::ImageData& self) { if(self.isCompressed()) { PyErr_SetString(PyExc_AttributeError, "image is compressed"); throw py::error_already_set{}; } return Containers::pyArrayViewHolder(Containers::PyStridedArrayView{self.pixels()}, py::cast(self)); }, "View on pixel data"); } /* For some reason having ...Args as the second (and not last) template argument does not work. So I'm listing all variants here ... which are exactly two, in fact. */ template R checkOpened(Trade::AbstractImporter& self) { if(!self.isOpened()) { PyErr_SetString(PyExc_AssertionError, "no file opened"); throw py::error_already_set{}; } return (self.*f)(); } template R checkOpened(Trade::AbstractImporter& self, Arg1 arg1) { if(!self.isOpened()) { PyErr_SetString(PyExc_AssertionError, "no file opened"); throw py::error_already_set{}; } return (self.*f)(arg1); } /** @todo drop this in favor of our own string caster */ template R checkOpenedString(Trade::AbstractImporter& self, const std::string& arg1) { if(!self.isOpened()) { PyErr_SetString(PyExc_AssertionError, "no file opened"); throw py::error_already_set{}; } return (self.*f)(arg1); } template R checkOpenedBounds(Trade::AbstractImporter& self, UnsignedInt id) { if(!self.isOpened()) { PyErr_SetString(PyExc_AssertionError, "no file opened"); throw py::error_already_set{}; } if(id >= (self.*bounds)()) { PyErr_SetNone(PyExc_IndexError); throw py::error_already_set{}; } return (self.*f)(id); } /** @todo drop this in favor of our own string caster */ template std::string checkOpenedBoundsReturnsString(Trade::AbstractImporter& self, UnsignedInt id) { if(!self.isOpened()) { PyErr_SetString(PyExc_AssertionError, "no file opened"); throw py::error_already_set{}; } if(id >= (self.*bounds)()) { PyErr_SetNone(PyExc_IndexError); throw py::error_already_set{}; } return (self.*f)(id); } template(Trade::AbstractImporter::*f)(UnsignedInt), UnsignedInt(Trade::AbstractImporter::*bounds)() const> R checkOpenedBoundsResult(Trade::AbstractImporter& self, UnsignedInt id) { if(!self.isOpened()) { PyErr_SetString(PyExc_AssertionError, "no file opened"); throw py::error_already_set{}; } if(id >= (self.*bounds)()) { PyErr_SetNone(PyExc_IndexError); throw py::error_already_set{}; } /** @todo log redirection -- but we'd need assertions to not be part of that so when it dies, the user can still see why */ Containers::Optional out = (self.*f)(id); if(!out) { PyErr_SetString(PyExc_RuntimeError, "import failed"); throw py::error_already_set{}; } return *std::move(out); } template(Trade::AbstractImporter::*f)(UnsignedInt, UnsignedInt), UnsignedInt(Trade::AbstractImporter::*bounds)() const, UnsignedInt(Trade::AbstractImporter::*levelBounds)(UnsignedInt)> R checkOpenedBoundsResult(Trade::AbstractImporter& self, UnsignedInt id, UnsignedInt level) { if(!self.isOpened()) { PyErr_SetString(PyExc_AssertionError, "no file opened"); throw py::error_already_set{}; } if(id >= (self.*bounds)()) { PyErr_SetNone(PyExc_IndexError); throw py::error_already_set{}; } if(level >= (self.*levelBounds)(id)) { PyErr_SetNone(PyExc_IndexError); throw py::error_already_set{}; } /** @todo log redirection -- but we'd need assertions to not be part of that so when it dies, the user can still see why */ Containers::Optional out = (self.*f)(id, level); if(!out) { PyErr_SetString(PyExc_RuntimeError, "import failed"); throw py::error_already_set{}; } return *std::move(out); } /** @todo drop std::string in favor of our own string caster */ template void checkResult(Trade::AbstractImageConverter& self, const T& image, const std::string& filename) { /** @todo log redirection -- but we'd need assertions to not be part of that so when it dies, the user can still see why */ bool out = (self.*f)(image, filename); if(!out) { PyErr_SetString(PyExc_RuntimeError, "conversion failed"); throw py::error_already_set{}; } } } void trade(py::module_& m) { m.doc() = "Data format exchange"; /* AbstractImporter depends on this */ py::module_::import("corrade.pluginmanager"); py::class_{m, "MeshData", "Mesh data"} .def_property_readonly("primitive", &Trade::MeshData::primitive, "Primitive") .def_property_readonly("is_indexed", &Trade::MeshData::isIndexed, "Whether the mesh is indexed") .def_property_readonly("vertex_count", &Trade::MeshData::vertexCount) .def_property_readonly("index_count", &Trade::MeshData::indexCount) .def_property_readonly("attribute_count", static_cast(&Trade::MeshData::attributeCount)); py::class_ imageData1D{m, "ImageData1D", "One-dimensional image data"}; py::class_ imageData2D{m, "ImageData2D", "Two-dimensional image data"}; py::class_ imageData3D{m, "ImageData3D", "Three-dimensional image data"}; imageData(imageData1D); imageData(imageData2D); imageData(imageData3D); /* Importer. Skipping file callbacks and openState as those operate with void*. Leaving the name as AbstractImporter (instead of Importer) to avoid needless name differences and because in the future there *might* be pure Python importers (not now tho). */ py::class_> abstractImporter{m, "AbstractImporter", "Interface for importer plugins"}; corrade::plugin(abstractImporter); abstractImporter /** @todo features (once moved outside of the importer) */ .def_property_readonly("is_opened", &Trade::AbstractImporter::isOpened, "Whether any file is opened") .def("open_data", [](Trade::AbstractImporter& self, Containers::ArrayView data) { /** @todo log redirection -- but we'd need assertions to not be part of that so when it dies, the user can still see why */ if(self.openData(data)) return; PyErr_SetString(PyExc_RuntimeError, "opening data failed"); throw py::error_already_set{}; }, "Open raw data", py::arg("data")) /** @todo drop std::string in favor of our own string caster */ .def("open_file", [](Trade::AbstractImporter& self, const std::string& filename) { /** @todo log redirection -- but we'd need assertions to not be part of that so when it dies, the user can still see why */ if(self.openFile(filename)) return; PyErr_Format(PyExc_RuntimeError, "opening %s failed", filename.data()); throw py::error_already_set{}; }, "Open a file", py::arg("filename")) .def("close", &Trade::AbstractImporter::close, "Close currently opened file") /** @todo all other data types */ .def_property_readonly("mesh_count", checkOpened, "Mesh count") .def("mesh_level_count", checkOpenedBounds, "Mesh level count", py::arg("id")) .def("mesh_for_name", checkOpenedString, "Mesh ID for given name") .def("mesh_name", checkOpenedBoundsReturnsString<&Trade::AbstractImporter::meshName, &Trade::AbstractImporter::meshCount>, "Mesh name", py::arg("id")) .def("mesh", checkOpenedBoundsResult, "Mesh", py::arg("id"), py::arg("level") = 0) /** @todo mesh_attribute_for_name / mesh_attribute_name */ /** @todo access by name, not just name -> id resolving */ .def_property_readonly("image1d_count", checkOpened, "One-dimensional image count") .def_property_readonly("image2d_count", checkOpened, "Two-dimensional image count") .def_property_readonly("image3d_count", checkOpened, "Three-dimensional image count") .def("image1d_level_count", checkOpenedBounds, "One-dimensional image level count", py::arg("id")) .def("image2d_level_count", checkOpenedBounds, "Two-dimensional image level count", py::arg("id")) .def("image3d_level_count", checkOpenedBounds, "Three-dimensional image level count", py::arg("id")) .def("image1d_for_name", checkOpenedString, "One-dimensional image ID for given name") .def("image2d_for_name", checkOpenedString, "Two-dimensional image ID for given name") .def("image3d_for_name", checkOpenedString, "Three-dimensional image ID for given name") .def("image1d_name", checkOpenedBoundsReturnsString<&Trade::AbstractImporter::image1DName, &Trade::AbstractImporter::image1DCount>, "One-dimensional image name", py::arg("id")) .def("image2d_name", checkOpenedBoundsReturnsString<&Trade::AbstractImporter::image2DName, &Trade::AbstractImporter::image2DCount>, "Two-dimensional image name", py::arg("id")) .def("image3d_name", checkOpenedBoundsReturnsString< &Trade::AbstractImporter::image3DName, &Trade::AbstractImporter::image3DCount>, "Three-dimensional image name", py::arg("id")) .def("image1d", checkOpenedBoundsResult, "One-dimensional image", py::arg("id"), py::arg("level") = 0) .def("image2d", checkOpenedBoundsResult, "Two-dimensional image", py::arg("id"), py::arg("level") = 0) .def("image3d", checkOpenedBoundsResult, "Three-dimensional image", py::arg("id"), py::arg("level") = 0); py::class_, PluginManager::AbstractManager> importerManager{m, "ImporterManager", "Manager for importer plugins"}; corrade::manager(importerManager); /* Image converter */ py::class_> abstractImageConverter{m, "AbstractImageConverter", "Interface for image converter plugins"}; abstractImageConverter .def("convert_to_file", checkResult, "Convert a 1D image to a file", py::arg("image"), py::arg("filename")) .def("convert_to_file", checkResult, "Convert a 2D image to a file", py::arg("image"), py::arg("filename")) .def("convert_to_file", checkResult, "Convert a 3D image to a file", py::arg("image"), py::arg("filename")); corrade::plugin(abstractImageConverter); py::class_, PluginManager::AbstractManager> imageConverterManager{m, "ImageConverterManager", "Manager for image converter plugins"}; corrade::manager(imageConverterManager); } } #ifndef MAGNUM_BUILD_STATIC /* TODO: remove declaration when https://github.com/pybind/pybind11/pull/1863 is released */ extern "C" PYBIND11_EXPORT PyObject* PyInit_trade(); PYBIND11_MODULE(trade, m) { magnum::trade(m); } #endif