{"id":17322,"url":"https://patchwork.libcamera.org/api/patches/17322/?format=json","web_url":"https://patchwork.libcamera.org/patch/17322/","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":"<20220908014200.28728-14-laurent.pinchart@ideasonboard.com>","date":"2022-09-08T01:41:41","name":"[libcamera-devel,v4,13/32] ipa: rkisp1: Sort documentation of the IPA context","commit_ref":null,"pull_url":null,"state":"superseded","archived":false,"hash":"0c16a3f89a3db55c3232ea8d2ffec0955278116a","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/?format=json","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/17322/mbox/","series":[{"id":3476,"url":"https://patchwork.libcamera.org/api/series/3476/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=3476","date":"2022-09-08T01:41:28","name":"ipa: Frame context queue, IPU3 & RkISP consolidation, and RkISP1 improvements","version":4,"mbox":"https://patchwork.libcamera.org/series/3476/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/17322/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/17322/checks/","tags":{},"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 F018DC327D\n\tfor ;\n\tThu, 8 Sep 2022 01:42:37 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id A28DD620CA;\n\tThu, 8 Sep 2022 03:42:37 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 0B957620B7\n\tfor ;\n\tThu, 8 Sep 2022 03:42:36 +0200 (CEST)","from pendragon.ideasonboard.com (62-78-145-57.bb.dnainternet.fi\n\t[62.78.145.57])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 860038F1\n\tfor ;\n\tThu, 8 Sep 2022 03:42:35 +0200 (CEST)"],"DKIM-Signature":["v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1662601357;\n\tbh=N7T7B+FpWNY9q84INn+Mg4WQ1LCrieqE2TwIP0e0YQc=;\n\th=To:Date:In-Reply-To:References:Subject:List-Id:List-Unsubscribe:\n\tList-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:\n\tFrom;\n\tb=hOfQA0AVBA3R2NSpidgFdQpBNfg08oaYado5uSojQWPalqroBHs9+RCo2aoEIO5SC\n\t7WD67hZRvTlO0IvLkz0FR/DWiuSFxje6wtJhN4ANUSQtjoYd1mXB+Az1bIgg/Rfbnx\n\tv4tttNj3adAqX/kga5tcebhmf2XEGozBLJk8biOwMRYIA0xjz+H28q7OPmidBCS2EB\n\tfG52Z9qbQ6+V0VHjQ0HNPIzEOUU0CFQplXaiGhBoA/zGkt7xJWX+bHKauBKbgD+Gfs\n\tfpiUFQHimxtR02VFvbIDOUokaLS2tvejPiL6G6HS51MEg9KzJK/Fi4lo7EghiLqSrA\n\t0nbtG4r5bWl6g==","v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1662601355;\n\tbh=N7T7B+FpWNY9q84INn+Mg4WQ1LCrieqE2TwIP0e0YQc=;\n\th=From:To:Subject:Date:In-Reply-To:References:From;\n\tb=OuX/9ierMSzahFfAPEMEsDFgyl9iugvbHc3LgEEfsGVACZhfJPxEFI/ZUDpsOxZ3z\n\tQn5g2wmtQs3oqeHSnffjfm2wyFmQb4JTfM4q3yVp53MxFmrPbEJsd+NpY5HR/MZRV2\n\t3KQbea5o9KyVy8gsE6c3FxEulhqE16C1mJ/CxWTc="],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key; \n\tunprotected) header.d=ideasonboard.com\n\theader.i=@ideasonboard.com\n\theader.b=\"OuX/9ier\"; dkim-atps=neutral","To":"libcamera-devel@lists.libcamera.org","Date":"Thu, 8 Sep 2022 04:41:41 +0300","Message-Id":"<20220908014200.28728-14-laurent.pinchart@ideasonboard.com>","X-Mailer":"git-send-email 2.35.1","In-Reply-To":"<20220908014200.28728-1-laurent.pinchart@ideasonboard.com>","References":"<20220908014200.28728-1-laurent.pinchart@ideasonboard.com>","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [PATCH v4 13/32] ipa: rkisp1: Sort documentation\n\tof the IPA context","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":"Laurent Pinchart via libcamera-devel\n\t","Reply-To":"Laurent Pinchart ","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "},"content":"The documentation of the IPA context structures is separate from the\ndocumentation of the structure members. Sort the documentation block to\ngroup members with their structure.\n\nSigned-off-by: Laurent Pinchart \n---\n src/ipa/rkisp1/ipa_context.cpp | 62 +++++++++++++++++-----------------\n 1 file changed, 31 insertions(+), 31 deletions(-)","diff":"diff --git a/src/ipa/rkisp1/ipa_context.cpp b/src/ipa/rkisp1/ipa_context.cpp\nindex f64af732260c..cc66bc70ac44 100644\n--- a/src/ipa/rkisp1/ipa_context.cpp\n+++ b/src/ipa/rkisp1/ipa_context.cpp\n@@ -24,37 +24,6 @@ namespace libcamera::ipa::rkisp1 {\n * may also be updated in the start() operation.\n */\n \n-/**\n- * \\struct IPAFrameContext\n- * \\brief Per-frame context for algorithms\n- *\n- * The frame context stores data specific to a single frame processed by the\n- * IPA. Each frame processed by the IPA has a context associated with it,\n- * accessible through the IPAContext structure.\n- *\n- * \\todo Detail how to access contexts for a particular frame\n- *\n- * Each of the fields in the frame context belongs to either a specific\n- * algorithm, or to the top-level IPA module. A field may be read by any\n- * algorithm, but should only be written by its owner.\n- */\n-\n-/**\n- * \\struct IPAContext\n- * \\brief Global IPA context data shared between all algorithms\n- *\n- * \\var IPAContext::configuration\n- * \\brief The IPA session configuration, immutable during the session\n- *\n- * \\var IPAContext::frameContext\n- * \\brief The frame context for the frame being processed\n- *\n- * \\todo While the frame context is supposed to be per-frame, this\n- * single frame context stores data related to both the current frame\n- * and the previous frames, with fields being updated as the algorithms\n- * are run. This needs to be turned into real per-frame data storage.\n- */\n-\n /**\n * \\var IPASessionConfiguration::agc\n * \\brief AGC parameters configuration of the IPA\n@@ -115,6 +84,21 @@ namespace libcamera::ipa::rkisp1 {\n * \\brief Sensor output resolution\n */\n \n+/**\n+ * \\struct IPAFrameContext\n+ * \\brief Per-frame context for algorithms\n+ *\n+ * The frame context stores data specific to a single frame processed by the\n+ * IPA. Each frame processed by the IPA has a context associated with it,\n+ * accessible through the IPAContext structure.\n+ *\n+ * \\todo Detail how to access contexts for a particular frame\n+ *\n+ * Each of the fields in the frame context belongs to either a specific\n+ * algorithm, or to the top-level IPA module. A field may be read by any\n+ * algorithm, but should only be written by its owner.\n+ */\n+\n /**\n * \\var IPAFrameContext::agc\n * \\brief Context for the Automatic Gain Control algorithm\n@@ -216,4 +200,20 @@ namespace libcamera::ipa::rkisp1 {\n * Algorithm::prepare() function of all algorithms.\n */\n \n+/**\n+ * \\struct IPAContext\n+ * \\brief Global IPA context data shared between all algorithms\n+ *\n+ * \\var IPAContext::configuration\n+ * \\brief The IPA session configuration, immutable during the session\n+ *\n+ * \\var IPAContext::frameContext\n+ * \\brief The frame context for the frame being processed\n+ *\n+ * \\todo While the frame context is supposed to be per-frame, this\n+ * single frame context stores data related to both the current frame\n+ * and the previous frames, with fields being updated as the algorithms\n+ * are run. This needs to be turned into real per-frame data storage.\n+ */\n+\n } /* namespace libcamera::ipa::rkisp1 */\n","prefixes":["libcamera-devel","v4","13/32"]}