{"id":20432,"url":"https://patchwork.libcamera.org/api/patches/20432/?format=json","web_url":"https://patchwork.libcamera.org/patch/20432/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/projects/1/?format=json","name":"libcamera","link_name":"libcamera","list_id":"libcamera_core","list_email":"libcamera-devel@lists.libcamera.org","web_url":"","scm_url":"","webscm_url":""},"msgid":"<20240627134656.582462-3-umang.jain@ideasonboard.com>","date":"2024-06-27T13:46:53","name":"[v4,2/5] libcamera: converter: Add interface to support cropping capability","commit_ref":null,"pull_url":null,"state":"superseded","archived":false,"hash":"f814fdbd2f86967ca16d4cfa56797d78e109211d","submitter":{"id":86,"url":"https://patchwork.libcamera.org/api/people/86/?format=json","name":"Umang Jain","email":"umang.jain@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/20432/mbox/","series":[{"id":4425,"url":"https://patchwork.libcamera.org/api/series/4425/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=4425","date":"2024-06-27T13:46:51","name":"libcamera: rkisp1: Plumb the ConverterDW100 converter","version":4,"mbox":"https://patchwork.libcamera.org/series/4425/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/20432/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/20432/checks/","tags":{},"headers":{"Return-Path":"<libcamera-devel-bounces@lists.libcamera.org>","X-Original-To":"parsemail@patchwork.libcamera.org","Delivered-To":"parsemail@patchwork.libcamera.org","Received":["from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id 2BF0EBDB1D\n\tfor <parsemail@patchwork.libcamera.org>;\n\tThu, 27 Jun 2024 13:47:10 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 6EB3862E22;\n\tThu, 27 Jun 2024 15:47:09 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 6E56062C98\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tThu, 27 Jun 2024 15:47:05 +0200 (CEST)","from fedora.local (unknown\n\t[IPv6:2405:201:2015:f873:c173:4b:4a04:3a21])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id D04EE593;\n\tThu, 27 Jun 2024 15:46:40 +0200 (CEST)"],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"IS5vXVLE\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1719496001;\n\tbh=sZqqtOY9dkVPh0SxU93GnQMq6s6m2kQMbOUPb+cU5Sc=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=IS5vXVLEEFTgabm2oIa5YLfXhX2PNM/YmCHe6NSlji8NTQ59PouNCVpS26/2Oxc/h\n\tRCXoRY70KqBZR+9gZGtRCS/HYoHUG+wwuDX2BfSyHqcg+aN7+rqGQ8YnMnF7rnbWM9\n\tUK2LwfBdSsm4li0uHJhvR8Nf3UqyaZNcSA0cTFLo=","From":"Umang Jain <umang.jain@ideasonboard.com>","To":"libcamera-devel@lists.libcamera.org","Cc":"Umang Jain <umang.jain@ideasonboard.com>","Subject":"[PATCH v4 2/5] libcamera: converter: Add interface to support\n\tcropping capability","Date":"Thu, 27 Jun 2024 19:16:53 +0530","Message-ID":"<20240627134656.582462-3-umang.jain@ideasonboard.com>","X-Mailer":"git-send-email 2.44.0","In-Reply-To":"<20240627134656.582462-1-umang.jain@ideasonboard.com>","References":"<20240627134656.582462-1-umang.jain@ideasonboard.com>","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"<libcamera-devel.lists.libcamera.org>","List-Unsubscribe":"<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>","List-Archive":"<https://lists.libcamera.org/pipermail/libcamera-devel/>","List-Post":"<mailto:libcamera-devel@lists.libcamera.org>","List-Help":"<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>","List-Subscribe":"<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>"},"content":"If the converter has cropping capability, the interface should support it\nby providing appropriate virtual functions. Provide Feature::Crop in\nFeature enumeration for the same.\n\nProvide virtual setCrop() and getCropBounds() interfaces so that\nthe converter can implement their own cropping functionality.\n\nThe V4L2M2MConverter implements these interfaces of the Converter\ninterface. Not all V4L2M2M converters will have cropping capability,\nhence Feature::Crop should be set while construction for all those\nconverters.\n\nFor implementing the getCropBounds(), V4L2VideoDevice needs\nto be extended to support VIDIOC_G_SELECTION via\nV4L2VideoDevice::getSelection().\n\nSigned-off-by: Umang Jain <umang.jain@ideasonboard.com>\n---\n include/libcamera/internal/converter.h        |  5 ++\n .../internal/converter/converter_v4l2_m2m.h   |  7 ++\n include/libcamera/internal/v4l2_videodevice.h |  1 +\n src/libcamera/converter.cpp                   | 35 ++++++++\n .../converter/converter_v4l2_m2m.cpp          | 85 +++++++++++++++++++\n src/libcamera/v4l2_videodevice.cpp            | 32 +++++++\n 6 files changed, 165 insertions(+)","diff":"diff --git a/include/libcamera/internal/converter.h b/include/libcamera/internal/converter.h\nindex 15bc7dca..deba75e3 100644\n--- a/include/libcamera/internal/converter.h\n+++ b/include/libcamera/internal/converter.h\n@@ -14,6 +14,7 @@\n #include <memory>\n #include <string>\n #include <tuple>\n+#include <utility>\n #include <vector>\n \n #include <libcamera/base/class.h>\n@@ -35,6 +36,7 @@ class Converter\n public:\n \tenum class Feature {\n \t\tNone = (1 << 0),\n+\t\tCrop = (1 << 1),\n \t};\n \n \tusing Features = Flags<Feature>;\n@@ -63,6 +65,9 @@ public:\n \tvirtual int queueBuffers(FrameBuffer *input,\n \t\t\t\t const std::map<const Stream *, FrameBuffer *> &outputs) = 0;\n \n+\tvirtual int setCrop(const Stream *stream, Rectangle *rect);\n+\tvirtual std::pair<Rectangle, Rectangle> getCropBounds(const Stream *stream);\n+\n \tSignal<FrameBuffer *> inputBufferReady;\n \tSignal<FrameBuffer *> outputBufferReady;\n \ndiff --git a/include/libcamera/internal/converter/converter_v4l2_m2m.h b/include/libcamera/internal/converter/converter_v4l2_m2m.h\nindex 91701dbe..e97fbdd2 100644\n--- a/include/libcamera/internal/converter/converter_v4l2_m2m.h\n+++ b/include/libcamera/internal/converter/converter_v4l2_m2m.h\n@@ -30,6 +30,7 @@ class Size;\n class SizeRange;\n class Stream;\n struct StreamConfiguration;\n+class Rectangle;\n class V4L2M2MDevice;\n \n class V4L2M2MConverter : public Converter\n@@ -57,6 +58,9 @@ public:\n \tint queueBuffers(FrameBuffer *input,\n \t\t\t const std::map<const Stream *, FrameBuffer *> &outputs);\n \n+\tint setCrop(const Stream *stream, Rectangle *rect);\n+\tstd::pair<Rectangle, Rectangle> getCropBounds(const Stream *stream);\n+\n private:\n \tclass V4L2M2MStream : protected Loggable\n \t{\n@@ -75,6 +79,9 @@ private:\n \n \t\tint queueBuffers(FrameBuffer *input, FrameBuffer *output);\n \n+\t\tint getSelection(unsigned int target, Rectangle *rect);\n+\t\tint setSelection(unsigned int target, Rectangle *rect);\n+\n \tprotected:\n \t\tstd::string logPrefix() const override;\n \ndiff --git a/include/libcamera/internal/v4l2_videodevice.h b/include/libcamera/internal/v4l2_videodevice.h\nindex 9057be08..506d6a65 100644\n--- a/include/libcamera/internal/v4l2_videodevice.h\n+++ b/include/libcamera/internal/v4l2_videodevice.h\n@@ -209,6 +209,7 @@ public:\n \tFormats formats(uint32_t code = 0);\n \n \tint setSelection(unsigned int target, Rectangle *rect);\n+\tint getSelection(unsigned int target, Rectangle *rect);\n \n \tint allocateBuffers(unsigned int count,\n \t\t\t    std::vector<std::unique_ptr<FrameBuffer>> *buffers);\ndiff --git a/src/libcamera/converter.cpp b/src/libcamera/converter.cpp\nindex 2dc7d984..19634e1c 100644\n--- a/src/libcamera/converter.cpp\n+++ b/src/libcamera/converter.cpp\n@@ -39,6 +39,9 @@ LOG_DEFINE_CATEGORY(Converter)\n  * \\brief Specify the features supported by the converter\n  * \\var Converter::Feature::None\n  * \\brief No extra features supported by the converter\n+ * \\var Converter::Feature::Crop\n+ * \\brief Cropping capability is supported by the converter\n+\n  */\n \n /**\n@@ -161,6 +164,38 @@ Converter::~Converter()\n  * \\return 0 on success or a negative error code otherwise\n  */\n \n+/**\n+ * \\brief Set the crop rectangle \\a rect for \\a stream\n+ * \\param[in] stream Pointer to output stream\n+ * \\param[inout] rect The crop rectangle to be applied\n+ *\n+ * Set the crop rectangle \\a rect for \\a stream provided the converter supports\n+ * cropping. The converter should have the Feature::Crop flag in this case.\n+ *\n+ * \\return 0 on success or a negative error code otherwise\n+ */\n+int Converter::setCrop([[maybe_unused]] const Stream *stream, [[maybe_unused]] Rectangle *rect)\n+{\n+\treturn 0;\n+}\n+\n+/**\n+ * \\brief Get the crop bounds \\a stream\n+ * \\param[in] stream Pointer to output stream\n+ *\n+ * Get the minimum and maximum crop bounds for \\a stream. The converter\n+ * should supporting cropping (Feature::Crop).\n+ *\n+ * \\return A std::pair<Rectangle, Rectangle> containining minimum and maximum\n+ * crop bound respectively.\n+ */\n+std::pair<Rectangle, Rectangle> Converter::getCropBounds([[maybe_unused]] const Stream *stream)\n+{\n+\tRectangle rect;\n+\n+\treturn { rect, rect };\n+}\n+\n /**\n  * \\var Converter::inputBufferReady\n  * \\brief A signal emitted when the input frame buffer completes\ndiff --git a/src/libcamera/converter/converter_v4l2_m2m.cpp b/src/libcamera/converter/converter_v4l2_m2m.cpp\nindex 4aeb7dd9..4bb625e9 100644\n--- a/src/libcamera/converter/converter_v4l2_m2m.cpp\n+++ b/src/libcamera/converter/converter_v4l2_m2m.cpp\n@@ -155,6 +155,24 @@ int V4L2M2MConverter::V4L2M2MStream::queueBuffers(FrameBuffer *input, FrameBuffe\n \treturn 0;\n }\n \n+int V4L2M2MConverter::V4L2M2MStream::setSelection(unsigned int target, Rectangle *rect)\n+{\n+\tint ret = m2m_->output()->setSelection(target, rect);\n+\tif (ret < 0)\n+\t\treturn ret;\n+\n+\treturn 0;\n+}\n+\n+int V4L2M2MConverter::V4L2M2MStream::getSelection(unsigned int target, Rectangle *rect)\n+{\n+\tint ret = m2m_->output()->getSelection(target, rect);\n+\tif (ret < 0)\n+\t\treturn ret;\n+\n+\treturn 0;\n+}\n+\n std::string V4L2M2MConverter::V4L2M2MStream::logPrefix() const\n {\n \treturn stream_->configuration().toString();\n@@ -375,6 +393,69 @@ int V4L2M2MConverter::exportBuffers(const Stream *stream, unsigned int count,\n \treturn iter->second->exportBuffers(count, buffers);\n }\n \n+/**\n+ * \\copydoc libcamera::Converter::setCrop\n+ */\n+int V4L2M2MConverter::setCrop(const Stream *stream, Rectangle *rect)\n+{\n+\tif (!(getFeatures() & Feature::Crop))\n+\t\treturn -ENOTSUP;\n+\n+\tauto iter = streams_.find(stream);\n+\tif (iter == streams_.end())\n+\t\treturn -EINVAL;\n+\n+\treturn iter->second->setSelection(V4L2_SEL_TGT_CROP, rect);\n+}\n+\n+/**\n+ * \\copydoc libcamera::Converter::getCropBounds\n+ */\n+std::pair<Rectangle, Rectangle>\n+V4L2M2MConverter::getCropBounds(const Stream *stream)\n+{\n+\tRectangle minCrop;\n+\tRectangle maxCrop;\n+\tint ret;\n+\n+\tauto iter = streams_.find(stream);\n+\tif (iter == streams_.end())\n+\t\treturn {};\n+\n+\tif (!(getFeatures() & Feature::Crop)) {\n+\t\tLOG(Converter, Error) << \"Crop functionality is not supported\";\n+\t\treturn {};\n+\t}\n+\n+\t/* Get the maximum crop bound */\n+\tret = iter->second->getSelection(V4L2_SEL_TGT_CROP_BOUNDS, &maxCrop);\n+\tif (ret) {\n+\t\tLOG(Converter, Error) << \"Failed to query maximum crop bound\";\n+\t\treturn {};\n+\t}\n+\n+\t/*\n+\t * Get the minimum crop bound by setting 1x1 crop rectangle. The returned\n+\t * rectangle should be them minimum crop supported by the driver.\n+\t */\n+\tminCrop.width = 1;\n+\tminCrop.height = 1;\n+\tret = setCrop(stream, &minCrop);\n+\tif (ret) {\n+\t\tLOG(Converter, Error) << \"Failed to query minimum crop bound\";\n+\t\treturn {};\n+\t}\n+\n+\t/* Reset the crop rectangle to maximum */\n+\tret = setCrop(stream, &maxCrop);\n+\tif (ret) {\n+\t\tLOG(Converter, Error) << \"Failed to reset the crop to \" << maxCrop.toString();\n+\t\treturn {};\n+\t}\n+\n+\treturn { minCrop, maxCrop };\n+}\n+\n /**\n  * \\copydoc libcamera::Converter::start\n  */\n@@ -448,6 +529,10 @@ int V4L2M2MConverter::queueBuffers(FrameBuffer *input,\n \treturn 0;\n }\n \n+/*\n+ * \\todo: This should be extended to include Feature::Flag to denote\n+ * what each converter supports feature-wise.\n+ */\n static std::initializer_list<std::string> compatibles = {\n \t\"mtk-mdp\",\n \t\"pxp\",\ndiff --git a/src/libcamera/v4l2_videodevice.cpp b/src/libcamera/v4l2_videodevice.cpp\nindex 4947aa3d..dfbfae2c 100644\n--- a/src/libcamera/v4l2_videodevice.cpp\n+++ b/src/libcamera/v4l2_videodevice.cpp\n@@ -1226,6 +1226,38 @@ int V4L2VideoDevice::setSelection(unsigned int target, Rectangle *rect)\n \treturn 0;\n }\n \n+/**\n+ * \\brief Get the selection rectangle \\a rect for \\a target\n+ * \\param[in] target The selection target defined by the V4L2_SEL_TGT_* flags\n+ * \\param[inout] rect The selection rectangle that has been queried\n+ *\n+ * \\todo Define a V4L2SelectionTarget enum for the selection target\n+ *\n+ * \\return 0 on success or a negative error code otherwise\n+ */\n+int V4L2VideoDevice::getSelection(unsigned int target, Rectangle *rect)\n+{\n+\tstruct v4l2_selection sel = {};\n+\n+\tsel.type = bufferType_;\n+\tsel.target = target;\n+\tsel.flags = 0;\n+\n+\tint ret = ioctl(VIDIOC_G_SELECTION, &sel);\n+\tif (ret < 0) {\n+\t\tLOG(V4L2, Error) << \"Unable to get rectangle \" << target\n+\t\t\t\t << \": \" << strerror(-ret);\n+\t\treturn ret;\n+\t}\n+\n+\trect->x = sel.r.left;\n+\trect->y = sel.r.top;\n+\trect->width = sel.r.width;\n+\trect->height = sel.r.height;\n+\n+\treturn 0;\n+}\n+\n int V4L2VideoDevice::requestBuffers(unsigned int count,\n \t\t\t\t    enum v4l2_memory memoryType)\n {\n","prefixes":["v4","2/5"]}