From patchwork Tue Sep 27 02:36:22 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 17424 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id C7514C0DA4 for ; Tue, 27 Sep 2022 02:37:21 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 8A6A46229C; Tue, 27 Sep 2022 04:37:21 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org; s=mail; t=1664246241; bh=aMX5dVngiw9idpMcT8CjifyACs0RdcM1BPf9T5FsCyc=; h=To:Date:In-Reply-To:References:Subject:List-Id:List-Unsubscribe: List-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To: From; b=XW1wkG3DIop74arimqt16zq53VzR95HPz371aOCAMoU2dIy8fCQJkaKDIytoyZKJY ELNokTrDJjEk5hN3Y0ftBmYkvEVp2kv2NZLwqJ/XlVSKzgwvSVDkqnoH+sQKt4bjoE VxqNMLOFM5RSIXajXSIbxq7XSwEjxy/d2aug3CSd1Nk6smGSJgf38tsXOtFNCoZUUz cATbBu7hG4rYd/L+BepreeMpxQYw1LLurfSHrPVhIuAPieLWLHClcDoWyRjIackPmL FsinMXmbS5D4HGIjRzY+MCDcPSoh/mCBRAD45hFpYcWqL5/AQHFFe18Qw0RGzeTZbd 0T4HzYi4jTR5Q== Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id ED33C6228D for ; Tue, 27 Sep 2022 04:37:18 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="t7s2jtOe"; dkim-atps=neutral Received: from pendragon.ideasonboard.com (62-78-145-57.bb.dnainternet.fi [62.78.145.57]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 6C318E5 for ; Tue, 27 Sep 2022 04:37:18 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1664246238; bh=aMX5dVngiw9idpMcT8CjifyACs0RdcM1BPf9T5FsCyc=; h=From:To:Subject:Date:In-Reply-To:References:From; b=t7s2jtOeHXHzJNbXCQPpMWbygpRevp1Bq4v8oKuEnwy4BNFq9gPdOx+QYGLoGsojs TVaaP7Kshqxate7lmuHroK/hpYpLavQZpR1znVutXrJPnP7GIfO06qLuXWnZZDsG2z XZ03HNzDCALXB/LPPIXrEhbieTJWELp8JkLPVAi4= To: libcamera-devel@lists.libcamera.org Date: Tue, 27 Sep 2022 05:36:22 +0300 Message-Id: <20220927023642.12341-14-laurent.pinchart@ideasonboard.com> X-Mailer: git-send-email 2.35.1 In-Reply-To: <20220927023642.12341-1-laurent.pinchart@ideasonboard.com> References: <20220927023642.12341-1-laurent.pinchart@ideasonboard.com> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH v5 13/33] ipa: rkisp1: Sort documentation of the IPA context X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-Patchwork-Original-From: Laurent Pinchart via libcamera-devel From: Laurent Pinchart Reply-To: Laurent Pinchart Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" The documentation of the IPA context structures is separate from the documentation of the structure members. Sort the documentation block to group members with their structure. Signed-off-by: Laurent Pinchart Reviewed-by: Kieran Bingham Reviewed-by: Jacopo Mondi --- src/ipa/rkisp1/ipa_context.cpp | 62 +++++++++++++++++----------------- 1 file changed, 31 insertions(+), 31 deletions(-) diff --git a/src/ipa/rkisp1/ipa_context.cpp b/src/ipa/rkisp1/ipa_context.cpp index f64af732260c..cc66bc70ac44 100644 --- a/src/ipa/rkisp1/ipa_context.cpp +++ b/src/ipa/rkisp1/ipa_context.cpp @@ -24,37 +24,6 @@ namespace libcamera::ipa::rkisp1 { * may also be updated in the start() operation. */ -/** - * \struct IPAFrameContext - * \brief Per-frame context for algorithms - * - * The frame context stores data specific to a single frame processed by the - * IPA. Each frame processed by the IPA has a context associated with it, - * accessible through the IPAContext structure. - * - * \todo Detail how to access contexts for a particular frame - * - * Each of the fields in the frame context belongs to either a specific - * algorithm, or to the top-level IPA module. A field may be read by any - * algorithm, but should only be written by its owner. - */ - -/** - * \struct IPAContext - * \brief Global IPA context data shared between all algorithms - * - * \var IPAContext::configuration - * \brief The IPA session configuration, immutable during the session - * - * \var IPAContext::frameContext - * \brief The frame context for the frame being processed - * - * \todo While the frame context is supposed to be per-frame, this - * single frame context stores data related to both the current frame - * and the previous frames, with fields being updated as the algorithms - * are run. This needs to be turned into real per-frame data storage. - */ - /** * \var IPASessionConfiguration::agc * \brief AGC parameters configuration of the IPA @@ -115,6 +84,21 @@ namespace libcamera::ipa::rkisp1 { * \brief Sensor output resolution */ +/** + * \struct IPAFrameContext + * \brief Per-frame context for algorithms + * + * The frame context stores data specific to a single frame processed by the + * IPA. Each frame processed by the IPA has a context associated with it, + * accessible through the IPAContext structure. + * + * \todo Detail how to access contexts for a particular frame + * + * Each of the fields in the frame context belongs to either a specific + * algorithm, or to the top-level IPA module. A field may be read by any + * algorithm, but should only be written by its owner. + */ + /** * \var IPAFrameContext::agc * \brief Context for the Automatic Gain Control algorithm @@ -216,4 +200,20 @@ namespace libcamera::ipa::rkisp1 { * Algorithm::prepare() function of all algorithms. */ +/** + * \struct IPAContext + * \brief Global IPA context data shared between all algorithms + * + * \var IPAContext::configuration + * \brief The IPA session configuration, immutable during the session + * + * \var IPAContext::frameContext + * \brief The frame context for the frame being processed + * + * \todo While the frame context is supposed to be per-frame, this + * single frame context stores data related to both the current frame + * and the previous frames, with fields being updated as the algorithms + * are run. This needs to be turned into real per-frame data storage. + */ + } /* namespace libcamera::ipa::rkisp1 */