Show a patch.

GET /api/patches/21170/?format=api
HTTP 200 OK
Allow: GET, PUT, PATCH, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "id": 21170,
    "url": "https://patchwork.libcamera.org/api/patches/21170/?format=api",
    "web_url": "https://patchwork.libcamera.org/patch/21170/",
    "project": {
        "id": 1,
        "url": "https://patchwork.libcamera.org/api/projects/1/?format=api",
        "name": "libcamera",
        "link_name": "libcamera",
        "list_id": "libcamera_core",
        "list_email": "libcamera-devel@lists.libcamera.org",
        "web_url": "",
        "scm_url": "",
        "webscm_url": ""
    },
    "msgid": "<20240906063444.32772-3-umang.jain@ideasonboard.com>",
    "date": "2024-09-06T06:34:42",
    "name": "[v7,2/4] libcamera: converter: Add interface to support cropping capability",
    "commit_ref": null,
    "pull_url": null,
    "state": "superseded",
    "archived": false,
    "hash": "552a27fea4af8fd3da28636682bb643498a15bea",
    "submitter": {
        "id": 86,
        "url": "https://patchwork.libcamera.org/api/people/86/?format=api",
        "name": "Umang Jain",
        "email": "umang.jain@ideasonboard.com"
    },
    "delegate": null,
    "mbox": "https://patchwork.libcamera.org/patch/21170/mbox/",
    "series": [
        {
            "id": 4565,
            "url": "https://patchwork.libcamera.org/api/series/4565/?format=api",
            "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=4565",
            "date": "2024-09-06T06:34:40",
            "name": "libcamera: rkisp1: Plumb the ConverterDW100 converter",
            "version": 7,
            "mbox": "https://patchwork.libcamera.org/series/4565/mbox/"
        }
    ],
    "comments": "https://patchwork.libcamera.org/api/patches/21170/comments/",
    "check": "pending",
    "checks": "https://patchwork.libcamera.org/api/patches/21170/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 AF7C1C324C\n\tfor <parsemail@patchwork.libcamera.org>;\n\tFri,  6 Sep 2024 06:35:03 +0000 (UTC)",
            "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 7B3D4634EA;\n\tFri,  6 Sep 2024 08:35:01 +0200 (CEST)",
            "from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 4B7A7634E6\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tFri,  6 Sep 2024 08:34:57 +0200 (CEST)",
            "from localhost.localdomain (unknown\n\t[IPv6:2405:201:2015:f873:55f8:639e:8e9f:12ec])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id E1D9945B;\n\tFri,  6 Sep 2024 08:33:42 +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=\"ITHx5+Mu\"; dkim-atps=neutral",
        "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1725604423;\n\tbh=b3f12OxFuSNPSw0JCjU2mMZTQ/GC17VyIQ9qZYUzcKM=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=ITHx5+MuCnjtd5rR3ZTyB7ZUgYFeHi1OhlsR0arqbe6sHd2gW60gcb7HlORsZWGVY\n\tAq5nexzaf85fGwJcAfxsgO1UN/OEdfVnKUZquepToPA+RFKl8QqOUo1nuYmHNOavAf\n\tRJzzqpaDgJjAOHHGoHoz10KR8ClPX95ZYtWZMkAA=",
        "From": "Umang Jain <umang.jain@ideasonboard.com>",
        "To": "libcamera-devel@lists.libcamera.org",
        "Cc": "Umang Jain <umang.jain@ideasonboard.com>,\n\tPaul Elder <paul.elder@ideasonboard.com>",
        "Subject": "[PATCH v7 2/4] libcamera: converter: Add interface to support\n\tcropping capability",
        "Date": "Fri,  6 Sep 2024 12:04:42 +0530",
        "Message-ID": "<20240906063444.32772-3-umang.jain@ideasonboard.com>",
        "X-Mailer": "git-send-email 2.45.0",
        "In-Reply-To": "<20240906063444.32772-1-umang.jain@ideasonboard.com>",
        "References": "<20240906063444.32772-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 on its input, the interface\nshould support it by providing appropriate virtual functions. Provide\nFeature::InputCrop in Feature enumeration for the same.\n\nProvide virtual setInputCrop() and inputCropBounds() 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 ability\non its input, hence it needs to discovered during construction time.\nIf the capability to crop to identified successfully, the cropping\nbounds are determined during configure() time.\n\nSigned-off-by: Umang Jain <umang.jain@ideasonboard.com>\nReviewed-by: Paul Elder <paul.elder@ideasonboard.com>\n---\n include/libcamera/internal/converter.h        |   5 +\n .../internal/converter/converter_v4l2_m2m.h   |  13 ++-\n src/libcamera/converter.cpp                   |  38 +++++++\n .../converter/converter_v4l2_m2m.cpp          | 106 +++++++++++++++++-\n 4 files changed, 158 insertions(+), 4 deletions(-)",
    "diff": "diff --git a/include/libcamera/internal/converter.h b/include/libcamera/internal/converter.h\nindex 6623de4d..ffbb6f34 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 = 0,\n+\t\tInputCrop = (1 << 0),\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 setInputCrop(const Stream *stream, Rectangle *rect) = 0;\n+\tvirtual std::pair<Rectangle, Rectangle> inputCropBounds(const Stream *stream) = 0;\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 b9e59899..7d321c85 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,11 +58,15 @@ public:\n \tint queueBuffers(FrameBuffer *input,\n \t\t\t const std::map<const Stream *, FrameBuffer *> &outputs);\n \n+\tint setInputCrop(const Stream *stream, Rectangle *rect);\n+\tstd::pair<Rectangle, Rectangle> inputCropBounds(const Stream *stream);\n+\n private:\n \tclass V4L2M2MStream : protected Loggable\n \t{\n \tpublic:\n-\t\tV4L2M2MStream(V4L2M2MConverter *converter, const Stream *stream);\n+\t\tV4L2M2MStream(V4L2M2MConverter *converter, const Stream *stream,\n+\t\t\t      Features features);\n \n \t\tbool isValid() const { return m2m_ != nullptr; }\n \n@@ -75,6 +80,9 @@ private:\n \n \t\tint queueBuffers(FrameBuffer *input, FrameBuffer *output);\n \n+\t\tint setInputSelection(unsigned int target, Rectangle *rect);\n+\t\tstd::pair<Rectangle, Rectangle> inputCropBounds();\n+\n \tprotected:\n \t\tstd::string logPrefix() const override;\n \n@@ -88,6 +96,9 @@ private:\n \n \t\tunsigned int inputBufferCount_;\n \t\tunsigned int outputBufferCount_;\n+\n+\t\tstd::pair<Rectangle, Rectangle> inputCropBounds_;\n+\t\tFeatures features_;\n \t};\n \n \tstd::unique_ptr<V4L2M2MDevice> m2m_;\ndiff --git a/src/libcamera/converter.cpp b/src/libcamera/converter.cpp\nindex d7bb7273..7cb6532a 100644\n--- a/src/libcamera/converter.cpp\n+++ b/src/libcamera/converter.cpp\n@@ -11,6 +11,8 @@\n \n #include <libcamera/base/log.h>\n \n+#include <libcamera/stream.h>\n+\n #include \"libcamera/internal/media_device.h\"\n \n /**\n@@ -39,6 +41,8 @@ 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::InputCrop\n+ * \\brief Cropping capability at input is supported by the converter\n  */\n \n /**\n@@ -161,6 +165,40 @@ Converter::~Converter()\n  * \\return 0 on success or a negative error code otherwise\n  */\n \n+/**\n+ * \\fn Converter::setInputCrop()\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 apply and return the rectangle\n+ * that is actually applied\n+ *\n+ * Set the crop rectangle \\a rect for \\a stream provided the converter supports\n+ * cropping. The converter has the Feature::InputCrop flag in this case.\n+ *\n+ * The underlying hardware can adjust the rectangle supplied by the user\n+ * due to hardware constraints. Caller can inspect \\a rect to determine the\n+ * actual rectangle that has been applied by the converter, after this function\n+ * returns.\n+ *\n+ * \\return 0 on success or a negative error code otherwise\n+ */\n+\n+/**\n+ * \\fn Converter::inputCropBounds()\n+ * \\brief Retrieve the crop bounds for \\a stream\n+ * \\param[in] stream The output stream\n+ *\n+ * Retrieve the minimum and maximum crop bounds for \\a stream. The converter\n+ * should support cropping (Feature::InputCrop).\n+ *\n+ * The crop bounds depend on the configuration of the output stream hence, this\n+ * function should be called after the \\a stream has been configured using\n+ * configure().\n+ *\n+ * \\return A std::pair<Rectangle, Rectangle> containing minimum and maximum\n+ * crop bound respectively.\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 4f3e8ce4..1bf47ff9 100644\n--- a/src/libcamera/converter/converter_v4l2_m2m.cpp\n+++ b/src/libcamera/converter/converter_v4l2_m2m.cpp\n@@ -34,8 +34,9 @@ LOG_DECLARE_CATEGORY(Converter)\n  * V4L2M2MConverter::V4L2M2MStream\n  */\n \n-V4L2M2MConverter::V4L2M2MStream::V4L2M2MStream(V4L2M2MConverter *converter, const Stream *stream)\n-\t: converter_(converter), stream_(stream)\n+V4L2M2MConverter::V4L2M2MStream::V4L2M2MStream(V4L2M2MConverter *converter, const Stream *stream,\n+\t\t\t\t\t       Features features)\n+\t: converter_(converter), stream_(stream), features_(features)\n {\n \tm2m_ = std::make_unique<V4L2M2MDevice>(converter->deviceNode());\n \n@@ -97,6 +98,33 @@ int V4L2M2MConverter::V4L2M2MStream::configure(const StreamConfiguration &inputC\n \tinputBufferCount_ = inputCfg.bufferCount;\n \toutputBufferCount_ = outputCfg.bufferCount;\n \n+\tif (features_ & Feature::InputCrop) {\n+\t\tRectangle minCrop;\n+\t\tRectangle maxCrop;\n+\n+\t\t/* Find crop bounds */\n+\t\tminCrop.width = 1;\n+\t\tminCrop.height = 1;\n+\t\tmaxCrop.width = UINT_MAX;\n+\t\tmaxCrop.height = UINT_MAX;\n+\n+\t\tret = setInputSelection(V4L2_SEL_TGT_CROP, &minCrop);\n+\t\tif (ret) {\n+\t\t\tLOG(Converter, Error) << \"Could not query minimum selection crop\"\n+\t\t\t\t\t      << strerror(-ret);\n+\t\t\treturn ret;\n+\t\t}\n+\n+\t\tret = setInputSelection(V4L2_SEL_TGT_CROP, &maxCrop);\n+\t\tif (ret) {\n+\t\t\tLOG(Converter, Error) << \"Could not query maximum selection crop\"\n+\t\t\t\t\t      << strerror(-ret);\n+\t\t\treturn ret;\n+\t\t}\n+\n+\t\tinputCropBounds_ = { minCrop, maxCrop };\n+\t}\n+\n \treturn 0;\n }\n \n@@ -154,6 +182,20 @@ int V4L2M2MConverter::V4L2M2MStream::queueBuffers(FrameBuffer *input, FrameBuffe\n \treturn 0;\n }\n \n+int V4L2M2MConverter::V4L2M2MStream::setInputSelection(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+std::pair<Rectangle, Rectangle> V4L2M2MConverter::V4L2M2MStream::inputCropBounds()\n+{\n+\treturn inputCropBounds_;\n+}\n+\n std::string V4L2M2MConverter::V4L2M2MStream::logPrefix() const\n {\n \treturn stream_->configuration().toString();\n@@ -204,6 +246,34 @@ V4L2M2MConverter::V4L2M2MConverter(MediaDevice *media)\n \t\tm2m_.reset();\n \t\treturn;\n \t}\n+\n+\t/* Discover Feature::InputCrop */\n+\tRectangle maxCrop;\n+\tmaxCrop.width = UINT_MAX;\n+\tmaxCrop.height = UINT_MAX;\n+\n+\tret = m2m_->output()->setSelection(V4L2_SEL_TGT_CROP, &maxCrop);\n+\tif (!ret) {\n+\t\t/*\n+\t\t * Rectangles for cropping targets are defined even if the device\n+\t\t * does not support cropping. Their sizes and positions will be\n+\t\t * fixed in such cases.\n+\t\t *\n+\t\t * Set and inspect a crop equivalent to half of the maximum crop\n+\t\t * returned earlier. Use this to determine whether the crop on\n+\t\t * input is really supported.\n+\t\t */\n+\t\tRectangle halfCrop(maxCrop.size() / 2);\n+\n+\t\tret = m2m_->output()->setSelection(V4L2_SEL_TGT_CROP, &halfCrop);\n+\t\tif (!ret && halfCrop.width != maxCrop.width &&\n+\t\t    halfCrop.height != maxCrop.height) {\n+\t\t\tfeatures_ |= Feature::InputCrop;\n+\n+\t\t\tLOG(Converter, Info)\n+\t\t\t\t<< \"Converter supports cropping on its input\";\n+\t\t}\n+\t}\n }\n \n /**\n@@ -336,7 +406,7 @@ int V4L2M2MConverter::configure(const StreamConfiguration &inputCfg,\n \tfor (unsigned int i = 0; i < outputCfgs.size(); ++i) {\n \t\tconst StreamConfiguration &cfg = outputCfgs[i];\n \t\tstd::unique_ptr<V4L2M2MStream> stream =\n-\t\t\tstd::make_unique<V4L2M2MStream>(this, cfg.stream());\n+\t\t\tstd::make_unique<V4L2M2MStream>(this, cfg.stream(), features_);\n \n \t\tif (!stream->isValid()) {\n \t\t\tLOG(Converter, Error)\n@@ -373,6 +443,36 @@ int V4L2M2MConverter::exportBuffers(const Stream *stream, unsigned int count,\n \treturn iter->second->exportBuffers(count, buffers);\n }\n \n+/**\n+ * \\copydoc libcamera::Converter::setInputCrop\n+ */\n+int V4L2M2MConverter::setInputCrop(const Stream *stream, Rectangle *rect)\n+{\n+\tif (!(features_ & Feature::InputCrop))\n+\t\treturn -ENOTSUP;\n+\n+\tauto iter = streams_.find(stream);\n+\tif (iter == streams_.end()) {\n+\t\tLOG(Converter, Error) << \"Invalid output stream\";\n+\t\treturn -EINVAL;\n+\t}\n+\n+\treturn iter->second->setInputSelection(V4L2_SEL_TGT_CROP, rect);\n+}\n+\n+/**\n+ * \\copydoc libcamera::Converter::inputCropBounds\n+ */\n+std::pair<Rectangle, Rectangle>\n+V4L2M2MConverter::inputCropBounds(const Stream *stream)\n+{\n+\tauto iter = streams_.find(stream);\n+\tif (iter == streams_.end())\n+\t\treturn {};\n+\n+\treturn iter->second->inputCropBounds();\n+}\n+\n /**\n  * \\copydoc libcamera::Converter::start\n  */\n",
    "prefixes": [
        "v7",
        "2/4"
    ]
}