Patch Detail
Show a patch.
GET /api/1.1/patches/20235/?format=api
{ "id": 20235, "url": "https://patchwork.libcamera.org/api/1.1/patches/20235/?format=api", "web_url": "https://patchwork.libcamera.org/patch/20235/", "project": { "id": 1, "url": "https://patchwork.libcamera.org/api/1.1/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": "<20240607080906.2684579-3-paul.elder@ideasonboard.com>", "date": "2024-06-07T08:09:05", "name": "[v6,2/3] ipa: libipa: Add MatrixInterpolator class", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": false, "hash": "4d2bcea3d3f2e1a73a592c6010dd956a58123a09", "submitter": { "id": 17, "url": "https://patchwork.libcamera.org/api/1.1/people/17/?format=api", "name": "Paul Elder", "email": "paul.elder@ideasonboard.com" }, "delegate": null, "mbox": "https://patchwork.libcamera.org/patch/20235/mbox/", "series": [ { "id": 4373, "url": "https://patchwork.libcamera.org/api/1.1/series/4373/?format=api", "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=4373", "date": "2024-06-07T08:09:03", "name": "ipa: rkisp1: Add crosstalk algorithm", "version": 6, "mbox": "https://patchwork.libcamera.org/series/4373/mbox/" } ], "comments": "https://patchwork.libcamera.org/api/patches/20235/comments/", "check": "pending", "checks": "https://patchwork.libcamera.org/api/patches/20235/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 F2E0EBD87C\n\tfor <parsemail@patchwork.libcamera.org>;\n\tFri, 7 Jun 2024 08:09:26 +0000 (UTC)", "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id A67BC65465;\n\tFri, 7 Jun 2024 10:09:25 +0200 (CEST)", "from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 8E87265460\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tFri, 7 Jun 2024 10:09:22 +0200 (CEST)", "from neptunite.hamster-moth.ts.net\n\t(h175-177-049-156.catv02.itscom.jp [175.177.49.156])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id D6409230;\n\tFri, 7 Jun 2024 10:09:11 +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=\"WY3NRchT\"; dkim-atps=neutral", "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1717747753;\n\tbh=2tpLXWpilVZg+xeReXieSdFyUxIqCv9tXG+Cvo8PNgw=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=WY3NRchTMVRaMFlDB1R3OAbbxOfTsVAp5UzafzfH9Bzg2iPlIPFjlYKD3MlfeWdxL\n\tXZTQtMdQa6GlUX529uax5A/eKCfKOHmBNuco/eatgMozyzb2AtDjJ/6bGy+mojMDF9\n\tx4C4yydHtOEZaIx4abc4LpWAo5yZ6oylMC0MOxVc=", "From": "Paul Elder <paul.elder@ideasonboard.com>", "To": "libcamera-devel@lists.libcamera.org", "Cc": "Paul Elder <paul.elder@ideasonboard.com>,\n\tStefan Klug <stefan.klug@ideasonboard.com>", "Subject": "[PATCH v6 2/3] ipa: libipa: Add MatrixInterpolator class", "Date": "Fri, 7 Jun 2024 17:09:05 +0900", "Message-Id": "<20240607080906.2684579-3-paul.elder@ideasonboard.com>", "X-Mailer": "git-send-email 2.39.2", "In-Reply-To": "<20240607080906.2684579-1-paul.elder@ideasonboard.com>", "References": "<20240607080906.2684579-1-paul.elder@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": "Add a class to encapsulate the functionality of fetching a matrix based\non an integer key, and interpolating if there is no exact match. This is\nexpected to be used by both color correction matrices / crosstalk\ncorrection as well as lens shading correction.\n\nA cache is included only for exact matches of the key. The caller is\nexpected to decide the tolererance for rounding.\n\nSigned-off-by: Paul Elder <paul.elder@ideasonboard.com>\nReviewed-by: Stefan Klug <stefan.klug@ideasonboard.com>\n\n---\nChanges in v6:\n- fix doxygen\n\nChanges in v5:\n- improve documentation\n- replace count() with find() != end() (in get())\n- add cache\n\nChanges in v4:\n- remove stray semicolons\n- read from the new yaml layout (which mirrors what we have at the\n moment for lsc), and add keys to make it more flexible\n\nChanges in v3:\n- add a constructor that takes a map of unsigned int -> matrix\n- s/unit/identity\n- clear matrices on reset and when reading from yaml\n- add assert at get()\n\nChanges in v2:\n- initialize to identity matrix\n- add a function to reset to identity matrix\n- other minor fixes\n---\n src/ipa/libipa/matrix_interpolator.cpp | 111 +++++++++++++++++++++\n src/ipa/libipa/matrix_interpolator.h | 131 +++++++++++++++++++++++++\n src/ipa/libipa/meson.build | 2 +\n 3 files changed, 244 insertions(+)\n create mode 100644 src/ipa/libipa/matrix_interpolator.cpp\n create mode 100644 src/ipa/libipa/matrix_interpolator.h", "diff": "diff --git a/src/ipa/libipa/matrix_interpolator.cpp b/src/ipa/libipa/matrix_interpolator.cpp\nnew file mode 100644\nindex 000000000..064af9b06\n--- /dev/null\n+++ b/src/ipa/libipa/matrix_interpolator.cpp\n@@ -0,0 +1,111 @@\n+/* SPDX-License-Identifier: BSD-2-Clause */\n+/*\n+ * Copyright (C) 2019, Raspberry Pi Ltd\n+ * Copyright (C) 2024, Paul Elder <paul.elder@ideasonboard.com>\n+ *\n+ * Helper class for interpolating maps of matrices\n+ */\n+#include \"matrix_interpolator.h\"\n+\n+#include <algorithm>\n+#include <string>\n+\n+#include <libcamera/base/log.h>\n+\n+#include \"libcamera/internal/yaml_parser.h\"\n+\n+#include \"matrix.h\"\n+\n+/**\n+ * \\file matrix_interpolator.h\n+ * \\brief Helper class for interpolating maps of matrices\n+ */\n+\n+namespace libcamera {\n+\n+LOG_DEFINE_CATEGORY(MatrixInterpolator)\n+\n+namespace ipa {\n+\n+/**\n+ * \\class MatrixInterpolator\n+ * \\brief Class for storing, retrieving, and interpolating matrices\n+ * \\tparam T Type of numerical values to be stored in the matrices\n+ * \\tparam R Number of rows in the matrices\n+ * \\tparam C Number of columns in the matrices\n+ *\n+ * The main use case is to pass a map from color temperatures to corresponding\n+ * matrices (eg. color correction), and then requesting a matrix for a specific\n+ * color temperature. This class will abstract away the interpolation portion.\n+ */\n+\n+/**\n+ * \\fn MatrixInterpolator::MatrixInterpolator(const std::map<unsigned int, Matrix<T, R, C>> &matrices)\n+ * \\brief Construct a matrix interpolator from a map of matrices\n+ * \\param matrices Map from which to construct the matrix interpolator\n+ */\n+\n+/**\n+ * \\fn MatrixInterpolator::reset()\n+ * \\brief Reset the matrix interpolator content to a single identity matrix\n+ */\n+\n+/**\n+ * \\fn int MatrixInterpolator<T, R, C>::readYaml(const libcamera::YamlObject &yaml)\n+ * \\brief Initialize an MatrixInterpolator instance from yaml\n+ * \\tparam T Type of data stored in the matrices\n+ * \\tparam R Number of rows of the matrices\n+ * \\tparam C Number of columns of the matrices\n+ * \\param[in] yaml The yaml object that contains the map of unsigned integers to matrices\n+ * \\param[in] key_name The name of the key in the yaml object\n+ * \\param[in] matrix_name The name of the matrix in the yaml object\n+ *\n+ * The yaml object is expected to be a list of maps. Each map has two or more\n+ * pairs: one of \\a key_name to the key value (usually color temperature), and\n+ * one or more of \\a matrix_name to the matrix. This is a bit difficult to\n+ * explain, so here is an example (in python, as it is easier to parse than\n+ * yaml):\n+ * [\n+ * {\n+ * 'ct': 2860,\n+ * 'ccm': [ 2.12089, -0.52461, -0.59629,\n+ * -0.85342, 2.80445, -0.95103,\n+ * -0.26897, -1.14788, 2.41685 ],\n+ * 'offsets': [ 0, 0, 0 ]\n+ * },\n+ *\n+ * {\n+ * 'ct': 2960,\n+ * 'ccm': [ 2.26962, -0.54174, -0.72789,\n+ * -0.77008, 2.60271, -0.83262,\n+ * -0.26036, -1.51254, 2.77289 ],\n+ * 'offsets': [ 0, 0, 0 ]\n+ * },\n+ *\n+ * {\n+ * 'ct': 3603,\n+ * 'ccm': [ 2.18644, -0.66148, -0.52496,\n+ * -0.77828, 2.69474, -0.91645,\n+ * -0.25239, -0.83059, 2.08298 ],\n+ * 'offsets': [ 0, 0, 0 ]\n+ * },\n+ * ]\n+ *\n+ * In this case, \\a key_name would be 'ct', and \\a matrix_name can be either\n+ * 'ccm' or 'offsets'. This way multiple matrix interpolators can be defined in\n+ * one set of color temperature ranges in the tuning file, and they can be\n+ * retrieved separately with the \\a matrix_name parameter.\n+ *\n+ * \\return Zero on success, negative error code otherwise\n+ */\n+\n+/**\n+ * \\fn Matrix<T, R, C> MatrixInterpolator<T, R, C>::get(unsigned int key)\n+ * \\brief Retrieve a matrix from the list of matrices, interpolating if necessary\n+ * \\param[in] key The unsigned integer key of the matrix to retrieve\n+ * \\return The matrix corresponding to the color temperature\n+ */\n+\n+} /* namespace ipa */\n+\n+} /* namespace libcamera */\ndiff --git a/src/ipa/libipa/matrix_interpolator.h b/src/ipa/libipa/matrix_interpolator.h\nnew file mode 100644\nindex 000000000..27ab532eb\n--- /dev/null\n+++ b/src/ipa/libipa/matrix_interpolator.h\n@@ -0,0 +1,131 @@\n+/* SPDX-License-Identifier: BSD-2-Clause */\n+/*\n+ * Copyright (C) 2019, Raspberry Pi Ltd\n+ * Copyright (C) 2024, Paul Elder <paul.elder@ideasonboard.com>\n+ *\n+ * Helper class for interpolating maps of matrices\n+ */\n+\n+#pragma once\n+\n+#include <algorithm>\n+#include <map>\n+#include <string>\n+#include <tuple>\n+\n+#include <libcamera/base/log.h>\n+\n+#include \"libcamera/internal/yaml_parser.h\"\n+\n+#include \"matrix.h\"\n+\n+namespace libcamera {\n+\n+LOG_DECLARE_CATEGORY(MatrixInterpolator)\n+\n+namespace ipa {\n+\n+#ifndef __DOXYGEN__\n+template<typename T, unsigned int R, unsigned int C,\n+\t std::enable_if_t<std::is_arithmetic_v<T>> * = nullptr>\n+#else\n+template<typename T, unsigned int R, unsigned int C>\n+#endif /* __DOXYGEN__ */\n+class MatrixInterpolator\n+{\n+public:\n+\tMatrixInterpolator()\n+\t{\n+\t\treset();\n+\t}\n+\n+\tMatrixInterpolator(const std::map<unsigned int, Matrix<T, R, C>> &matrices)\n+\t{\n+\t\tfor (const auto &pair : matrices)\n+\t\t\tmatrices_[pair.first] = pair.second;\n+\t}\n+\n+\t~MatrixInterpolator() {}\n+\n+\tvoid reset()\n+\t{\n+\t\tMatrix<T, R, C> identity;\n+\t\tmatrices_.clear();\n+\t\tmatrices_[0] = identity;\n+\t}\n+\n+\tint readYaml(const libcamera::YamlObject &yaml,\n+\t\t const std::string &key_name,\n+\t\t const std::string &matrix_name)\n+\t{\n+\t\tint ret;\n+\n+\t\tmatrices_.clear();\n+\n+\t\tif (!yaml.isList()) {\n+\t\t\tLOG(MatrixInterpolator, Error) << \"yaml object must be a list\";\n+\t\t\treturn -EINVAL;\n+\t\t}\n+\n+\t\tfor (const auto &value : yaml.asList()) {\n+\t\t\tunsigned int ct = std::stoul(value[key_name].get<std::string>(\"\"));\n+\t\t\tMatrix<T, R, C> matrix;\n+\t\t\tif ((ret = matrix.readYaml(value[matrix_name])) < 0) {\n+\t\t\t\tLOG(MatrixInterpolator, Error) << \"Failed to read matrix\";\n+\t\t\t\treturn ret;\n+\t\t\t}\n+\n+\t\t\tmatrices_[ct] = matrix;\n+\n+\t\t\tLOG(MatrixInterpolator, Debug)\n+\t\t\t\t<< \"Read matrix '\" << matrix_name << \"' for key '\"\n+\t\t\t\t<< key_name << \"' \" << ct << \": \"\n+\t\t\t\t<< matrices_[ct].toString();\n+\t\t}\n+\n+\t\tif (matrices_.size() < 1) {\n+\t\t\tLOG(MatrixInterpolator, Error) << \"Need at least one matrix\";\n+\t\t\treturn -EINVAL;\n+\t\t}\n+\n+\t\treturn 0;\n+\t}\n+\n+\tMatrix<T, R, C> get(unsigned int ct)\n+\t{\n+\t\tASSERT(matrices_.size() > 0);\n+\n+\t\tif (matrices_.size() == 1 ||\n+\t\t ct <= matrices_.begin()->first)\n+\t\t\treturn matrices_.begin()->second;\n+\n+\t\tif (ct >= matrices_.rbegin()->first)\n+\t\t\treturn matrices_.rbegin()->second;\n+\n+\t\tif (matrices_.find(ct) != matrices_.end())\n+\t\t\treturn matrices_[ct];\n+\n+\t\tif (cache_.find(ct) != cache_.end())\n+\t\t\treturn cache_[ct];\n+\n+\t\t/* The above four guarantee that this will succeed */\n+\t\tauto iter = matrices_.upper_bound(ct);\n+\t\tunsigned int ctUpper = iter->first;\n+\t\tunsigned int ctLower = (--iter)->first;\n+\n+\t\tdouble lambda = (ct - ctLower) / static_cast<double>(ctUpper - ctLower);\n+\t\tMatrix<T, R, C> ret =\n+\t\t\tlambda * matrices_[ctUpper] + (1.0 - lambda) * matrices_[ctLower];\n+\t\tcache_[ct] = ret;\n+\t\treturn ret;\n+\t}\n+\n+private:\n+\tstd::map<unsigned int, Matrix<T, R, C>> matrices_;\n+\n+\tstd::map<unsigned int, Matrix<T, R, C>> cache_;\n+};\n+\n+} /* namespace ipa */\n+\n+} /* namespace libcamera */\ndiff --git a/src/ipa/libipa/meson.build b/src/ipa/libipa/meson.build\nindex 2547a5b83..901d78549 100644\n--- a/src/ipa/libipa/meson.build\n+++ b/src/ipa/libipa/meson.build\n@@ -8,6 +8,7 @@ libipa_headers = files([\n 'fc_queue.h',\n 'histogram.h',\n 'matrix.h',\n+ 'matrix_interpolator.h',\n 'module.h',\n 'pwl.h',\n ])\n@@ -20,6 +21,7 @@ libipa_sources = files([\n 'fc_queue.cpp',\n 'histogram.cpp',\n 'matrix.cpp',\n+ 'matrix_interpolator.cpp',\n 'module.cpp',\n 'pwl.cpp',\n ])\n", "prefixes": [ "v6", "2/3" ] }