[{"id":23533,"web_url":"https://patchwork.libcamera.org/comment/23533/","msgid":"<20220623070056.GC3309559@pyrite.rasen.tech>","date":"2022-06-23T07:00:56","subject":"Re: [libcamera-devel] [PATCH v4 03/12] ipa: libipa: algorithm: Add\n\tan algorithm registration mechanism","submitter":{"id":97,"url":"https://patchwork.libcamera.org/api/people/97/","name":"Nicolas Dufresne via libcamera-devel","email":"libcamera-devel@lists.libcamera.org"},"content":"Hi Laurent,\n\nOn Mon, Jun 20, 2022 at 04:42:56AM +0300, Laurent Pinchart wrote:\n> In order to allow dynamic instantiation of algorithms based on tuning\n> data files, add a mechanism to register algorithms with the IPA module.\n> The implementation relies on an AlgorithmFactory class and a\n> registration macro, similar to the pipeline handler registration\n> mechanism. The main difference is that the algorithm registration and\n> instantiation are implemented in the Module class instead of the\n> AlgorithmFactory class, making the factory an internal implementation\n> detail.\n> \n> Signed-off-by: Laurent Pinchart \n\nReviewed-by: Paul Elder \n\n> ---\n> src/ipa/libipa/algorithm.cpp | 54 ++++++++++++++++++++++++++++++++++++\n> src/ipa/libipa/algorithm.h | 41 ++++++++++++++++++++++++++-\n> src/ipa/libipa/module.cpp | 24 ++++++++++++++++\n> src/ipa/libipa/module.h | 33 ++++++++++++++++++++++\n> 4 files changed, 151 insertions(+), 1 deletion(-)\n> \n> diff --git a/src/ipa/libipa/algorithm.cpp b/src/ipa/libipa/algorithm.cpp\n> index 2df91e5d8fed..6e0bba56ecb2 100644\n> --- a/src/ipa/libipa/algorithm.cpp\n> +++ b/src/ipa/libipa/algorithm.cpp\n> @@ -32,6 +32,11 @@ namespace ipa {\n> * argument.\n> */\n> \n> +/**\n> + * \\typedef Algorithm::Module\n> + * \\brief The IPA module type for this class of algorithms\n> + */\n> +\n> /**\n> * \\fn Algorithm::configure()\n> * \\brief Configure the Algorithm given an IPAConfigInfo\n> @@ -94,6 +99,55 @@ namespace ipa {\n> * such that the algorithms use up to date state as required.\n> */\n> \n> +/**\n> + * \\class AlgorithmFactory\n> + * \\brief Registration of Algorithm classes and creation of instances\n> + *\n> + * To facilitate instantiation of Algorithm classes, the AlgorithmFactory class\n> + * implements auto-registration of algorithms with the IPA Module class. Each\n> + * Algorithm subclass shall register itself using the REGISTER_IPA_ALGORITHM()\n> + * macro, which will create a corresponding instance of an AlgorithmFactory\n> + * subclass and register it with the IPA Module.\n> + */\n> +\n> +/**\n> + * \\fn AlgorithmFactory::AlgorithmFactory()\n> + * \\brief Construct an algorithm factory\n> + * \\param[in] name Name of the algorithm class\n> + *\n> + * Creating an instance of the factory automatically registers is with the IPA\n> + * Module class, enabling creation of algorithm instances through\n> + * Module::createAlgorithm().\n> + *\n> + * The factory \\a name identifies the algorithm and shall be unique.\n> + */\n> +\n> +/**\n> + * \\fn AlgorithmFactory::name()\n> + * \\brief Retrieve the factory name\n> + * \\return The factory name\n> + */\n> +\n> +/**\n> + * \\fn AlgorithmFactory::create()\n> + * \\brief Create an instance of the Algorithm corresponding to the factory\n> + *\n> + * This virtual function is implemented by the REGISTER_IPA_ALGORITHM()\n> + * macro. It creates an algorithm instance.\n> + *\n> + * \\return A pointer to a newly constructed instance of the Algorithm subclass\n> + * corresponding to the factory\n> + */\n> +\n> +/**\n> + * \\def REGISTER_IPA_ALGORITHM\n> + * \\brief Register an algorithm with the IPA module\n> + * \\param[in] algorithm Class name of Algorithm derived class to register\n> + *\n> + * Register an Algorithm subclass with the IPA module to make it available for\n> + * instantiation through Module::createAlgorithm().\n> + */\n> +\n> } /* namespace ipa */\n> \n> } /* namespace libcamera */\n> diff --git a/src/ipa/libipa/algorithm.h b/src/ipa/libipa/algorithm.h\n> index fd2ffcfbc900..356c094976d4 100644\n> --- a/src/ipa/libipa/algorithm.h\n> +++ b/src/ipa/libipa/algorithm.h\n> @@ -6,14 +6,19 @@\n> */\n> #pragma once\n> \n> +#include \n> +#include \n> +\n> namespace libcamera {\n> \n> namespace ipa {\n> \n> -template\n> +template\n> class Algorithm\n> {\n> public:\n> +\tusing Module = _Module;\n> +\n> \tvirtual ~Algorithm() {}\n> \n> \tvirtual int configure([[maybe_unused]] typename Module::Context &context,\n> @@ -34,6 +39,40 @@ public:\n> \t}\n> };\n> \n> +template\n> +class AlgorithmFactory\n> +{\n> +public:\n> +\tAlgorithmFactory(const char *name)\n> +\t\t: name_(name)\n> +\t{\n> +\t\tModule::registerAlgorithm(this);\n> +\t}\n> +\n> +\tvirtual ~AlgorithmFactory() = default;\n> +\n> +\tconst std::string &name() const { return name_; }\n> +\n> +\tvirtual std::unique_ptr> create() const = 0;\n> +\n> +private:\n> +\tstd::string name_;\n> +};\n> +\n> +#define REGISTER_IPA_ALGORITHM(algorithm)\t\t\t\t\t\\\n> +class algorithm##Factory final : public AlgorithmFactory\t\\\n> +{\t\t\t\t\t\t\t\t\t\t\\\n> +public:\t\t\t\t\t\t\t\t\t\t\\\n> +\talgorithm##Factory() : AlgorithmFactory(#algorithm) {}\t\t\t\\\n> +\t\t\t\t\t\t\t\t\t\t\\\n> +\tstd::unique_ptr> create() const\t\\\n> +\t{\t\t\t\t\t\t\t\t\t\\\n> +\t\treturn std::make_unique();\t\t\t\t\\\n> +\t}\t\t\t\t\t\t\t\t\t\\\n> +};\t\t\t\t\t\t\t\t\t\t\\\n> +\t\t\t\t\t\t\t\t\t\t\\\n> +static algorithm##Factory global_##algorithm##Factory;\n> +\n> } /* namespace ipa */\n> \n> } /* namespace libcamera */\n> diff --git a/src/ipa/libipa/module.cpp b/src/ipa/libipa/module.cpp\n> index d03cc8ef03ed..451614fd04da 100644\n> --- a/src/ipa/libipa/module.cpp\n> +++ b/src/ipa/libipa/module.cpp\n> @@ -75,6 +75,30 @@ namespace ipa {\n> * \\brief The type of the IPA statistics and ISP results\n> */\n> \n> +/**\n> + * \\fn Module::createAlgorithm()\n> + * \\brief Create an instance of an Algorithm by name\n> + * \\param[in] name The algorithm name\n> + *\n> + * This function is the entry point to algorithm instantiation for the IPA\n> + * module. It creates and returns an instance of an algorithm identified by its\n> + * \\a name. If no such algorithm exists, the function returns nullptr.\n> + *\n> + * To make an algorithm available to the IPA module, it shall be registered with\n> + * the REGISTER_IPA_ALGORITHM() macro.\n> + *\n> + * \\return A new instance of the Algorithm subclass corresponding to the \\a name\n> + */\n> +\n> +/**\n> + * \\fn Module::registerAlgorithm()\n> + * \\brief Add an algorithm factory class to the list of available algorithms\n> + * \\param[in] factory Factory to use to construct the algorithm\n> + *\n> + * This function registers an algorithm factory. It is meant to be called by the\n> + * AlgorithmFactory constructor only.\n> + */\n> +\n> } /* namespace ipa */\n> \n> } /* namespace libcamera */\n> diff --git a/src/ipa/libipa/module.h b/src/ipa/libipa/module.h\n> index c4d778120408..f30fc33711bb 100644\n> --- a/src/ipa/libipa/module.h\n> +++ b/src/ipa/libipa/module.h\n> @@ -7,6 +7,12 @@\n> \n> #pragma once\n> \n> +#include \n> +#include \n> +#include \n> +\n> +#include \"algorithm.h\"\n> +\n> namespace libcamera {\n> \n> namespace ipa {\n> @@ -23,6 +29,33 @@ public:\n> \tusing Stats = _Stats;\n> \n> \tvirtual ~Module() {}\n> +\n> +\tstatic std::unique_ptr> createAlgorithm(const std::string &name)\n> +\t{\n> +\t\tfor (const AlgorithmFactory *factory : factories()) {\n> +\t\t\tif (factory->name() == name)\n> +\t\t\t\treturn factory->create();\n> +\t\t}\n> +\n> +\t\treturn nullptr;\n> +\t}\n> +\n> +\tstatic void registerAlgorithm(AlgorithmFactory *factory)\n> +\t{\n> +\t\tfactories().push_back(factory);\n> +\t}\n> +\n> +private:\n> +\tstatic std::vector *> &factories()\n> +\t{\n> +\t\t/*\n> +\t\t * The static factories map is defined inside the function to ensure\n> +\t\t * it gets initialized on first use, without any dependency on\n> +\t\t * link order.\n> +\t\t */\n> +\t\tstatic std::vector *> factories;\n> +\t\treturn factories;\n> +\t}\n> };\n> \n> } /* namespace ipa */\n> -- \n> Regards,\n> \n> Laurent Pinchart\n>","headers":{"Return-Path":"","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 A0DC2BD808\n\tfor ;\n\tThu, 23 Jun 2022 07:01:07 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id B542665635;\n\tThu, 23 Jun 2022 09:01:06 +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 5DDAF60412\n\tfor ;\n\tThu, 23 Jun 2022 09:01:04 +0200 (CEST)","from pyrite.rasen.tech (softbank114048060123.bbtec.net\n\t[114.48.60.123])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 9BD458F;\n\tThu, 23 Jun 2022 09:01:02 +0200 (CEST)"],"DKIM-Signature":["v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1655967666;\n\tbh=bD6bnxBElBQClf8nGELvXTdPcuLqyMNViWxynHmvxn0=;\n\th=Date:To:References:In-Reply-To:Subject:List-Id:List-Unsubscribe:\n\tList-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:Cc:\n\tFrom;\n\tb=J5NhkkaLTxIZli/+IzXySl+6WfwrZiRthu9kZidfv1f9bwLIDNQRz0uOWdJ+K0R8d\n\tQp1g7enr+KE6qCeQgCbOiobYW/2TWQI2VcV+4BMQ/sGrHGHgzcmOfB3A9dqRhww96B\n\tgGoFeTEoiLJgSpZ+sND9zoo7I1y4qAB7HIMDO02yoMuNxfjH+CzLp2ss+Vq6oRBIu0\n\toN+oJktcrPDZq0HBGmcCmLKoHjlUFHxiS2RTVOfVXe7D+/ke4TkccoIKI2mEC1Iv8p\n\tFwHr8BVwZ17aDPgwr6LR17P2raXamBTpP3IMEjzsgUSKHTHcS1Ipi4QApK8GYN5Xoq\n\tp0vwDicRlIpPA==","v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1655967663;\n\tbh=bD6bnxBElBQClf8nGELvXTdPcuLqyMNViWxynHmvxn0=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=ZJjF973nGT5vKvFgU9zzs1JZ8lwtnBohbZBUrb1TDSEObsHPynHvmadDEbK0bRxw0\n\tmKhkWlHInjGY/SbL9LEIoFqrlPCMGKk5C+YQ33UNg/RUtx94fluwIIczopoP2KA4W8\n\t6qpHkMtvQqBAbux8FG78IMgtJ+R7Xi4ZFlUQhxQ8="],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key; \n\tunprotected) header.d=ideasonboard.com\n\theader.i=@ideasonboard.com\n\theader.b=\"ZJjF973n\"; dkim-atps=neutral","Date":"Thu, 23 Jun 2022 16:00:56 +0900","To":"Laurent Pinchart ","Message-ID":"<20220623070056.GC3309559@pyrite.rasen.tech>","References":"<20220620014305.26778-1-laurent.pinchart@ideasonboard.com>\n\t<20220620014305.26778-4-laurent.pinchart@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=us-ascii","Content-Disposition":"inline","In-Reply-To":"<20220620014305.26778-4-laurent.pinchart@ideasonboard.com>","Subject":"Re: [libcamera-devel] [PATCH v4 03/12] ipa: libipa: algorithm: Add\n\tan algorithm registration mechanism","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","From":"Paul Elder via libcamera-devel ","Reply-To":"paul.elder@ideasonboard.com","Cc":"libcamera-devel@lists.libcamera.org","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}}]