From patchwork Tue Apr 22 21:58:57 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bryan O'Donoghue X-Patchwork-Id: 23217 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 49B8BC327D for ; Tue, 22 Apr 2025 21:59:33 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 208A668ACB; Tue, 22 Apr 2025 23:59:31 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (2048-bit key; unprotected) header.d=linaro.org header.i=@linaro.org header.b="cg8Gm4fB"; dkim-atps=neutral Received: from mail-wm1-x336.google.com (mail-wm1-x336.google.com [IPv6:2a00:1450:4864:20::336]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 2365368ACD for ; Tue, 22 Apr 2025 23:59:27 +0200 (CEST) Received: by mail-wm1-x336.google.com with SMTP id 5b1f17b1804b1-43edecbfb94so59329255e9.1 for ; Tue, 22 Apr 2025 14:59:27 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1745359166; x=1745963966; darn=lists.libcamera.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=81Ng/LIxFB09YHT8LrVidJKxmT29lxMXyQw7vM5fRDM=; b=cg8Gm4fBmFMjKnmGKEyT4UqurNjdCA5P9sWmx/87Sk427PWVPcLx2yLIv5zTuZO8UD Cd35C/qvKYwkHQDEInsnPUPfLtHhTGw511sSyMqyWZc3BSZpcWFucGrojXKGRwmUpQDJ NBeyvuiLHyQXTydIBHMu5xHBNmrdZS3Gmq92lBlbw4aR5mcUz0lKCTQEFh7J8X7y7vSV xE4xWOCGxEOKPviIRr8f0vvS214bOHag4YUQG3MNnrznWzmckbxnHLfzz0PXN+TKxoci 2pCNMOAU3GmiVhVEWMP6K5SKtNCKlwl0gjWIfQ5Pg+AizfYy5qhDd0heZsXrVuptx6gh BdXg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1745359166; x=1745963966; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=81Ng/LIxFB09YHT8LrVidJKxmT29lxMXyQw7vM5fRDM=; b=TiKzvWxay02ugF0EEgh4jn/YviJIOSzsPm1ep/0TN9Y4I4sBve60jaDbAJw6GnwCxA ptFtuPDhUs8FjQwpctv5xLq1lUA0XuYMi0jsLdq2W7708xE0Hk3HtFu1k6aChpyAyCBk 8i2x9vs/ly/3I3bbWn31cstT7DfmfHD4kArFxmXpY2JlgKipjvfSGoYTDS9qFyUzEUri Mdv05FxAKxFQg7Ru1IQW5mjWD7vblDpmxIcB+Q4TvEnfkeU2DLU+OdCtVguu33rVCHtm QME203BP3LcOwNOowechM/K3pT5hv1hQM5yyJljTKFH0wjKoKe74vxuGO92kOO3DNsER Eg1g== X-Gm-Message-State: AOJu0YwoWi5dfoMEH3zrhrRy24uEpCBQT/2rhDiqeM2aSDNY/vW8MKHw VQk/CgJ6RPsvNCVm0MT+QCPNXx26jgFbuUd6vZMo5CjDtQVasVNtf/44bKkbVFPNfNew2SawIYx vjcI= X-Gm-Gg: ASbGnctrZpXLiobWj7D3G78XWZYKIxMngMGBsgoybEfXOUfBVbcZHoA3tbMFu7tL5QV cF3hbwKvWugdQ1suJOR7Y4DuPa/xIJkcfVkSRHB1ctARR6MEl2LOLcI74cAO3UmKkHJ7I4bel/s LGZhe8NWV/FkioMbars4ND9aUePuOnjQOiaZKme29qbjb/tplMRDEqXA4GZ2snp3cKajgH3ALXA knw3FAcu/F1tIg0mMARuujr5wLLnjGrRnRcuNFOrixHOkbfbq5iZNEAYQr4KBu6jOBRhQYm4igd fIcUMYMxfCGs7IidHFMqH791U4dyLEQzC7kUQDTJKlZ4miz7tA2cCShW+kRKgDpf2lpthOYe8dU RIy/ZXgjSiIeEJNsIyOkf X-Google-Smtp-Source: AGHT+IHwLIfGIollYB1itH5BH4CXaw9NF5DXkHW5/Fxrr/2PcMDLrzZ83lcZ5M/esgdaMQhtxBqtgg== X-Received: by 2002:a05:600c:548e:b0:440:6a5f:c31f with SMTP id 5b1f17b1804b1-4406ab93420mr151139435e9.11.1745359166430; Tue, 22 Apr 2025 14:59:26 -0700 (PDT) Received: from inspiron14p-linux.ht.home (188-141-3-146.dynamic.upc.ie. [188.141.3.146]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-44092d2eccesm2726615e9.20.2025.04.22.14.59.25 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 22 Apr 2025 14:59:25 -0700 (PDT) From: Bryan O'Donoghue To: libcamera-devel@lists.libcamera.org Cc: hdegoede@redhat.com, mzamazal@redhat.com, bryan.odonoghue@linaro.org, bod.linux@nxsw.ie, Kieran Bingham Subject: [PATCH 04/27] libcamera: swstats_cpu: Update statsProcessFn() / processLine0() documentation Date: Tue, 22 Apr 2025 22:58:57 +0100 Message-ID: <20250422215920.4297-5-bryan.odonoghue@linaro.org> X-Mailer: git-send-email 2.49.0 In-Reply-To: <20250422215920.4297-1-bryan.odonoghue@linaro.org> References: <20250422215920.4297-1-bryan.odonoghue@linaro.org> MIME-Version: 1.0 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: , Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" From: Hans de Goede Update the documentation of the statsProcessFn() / processLine0() src[] pointer argument to take into account that swstats_cpu may also be used with planar input data or with non Bayer single plane input data. The statsProcessFn typedef is private, so no documentation is generated for it. Move the new updated src[] pointer argument documentation to processLine0() so that it gets included in the generated docs. Reviewed-by: Kieran Bingham Reviewed-by: Milan Zamazal Signed-off-by: Hans de Goede Signed-off-by: Bryan O'Donoghue --- src/libcamera/software_isp/swstats_cpu.cpp | 27 +++++++++++----------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/src/libcamera/software_isp/swstats_cpu.cpp b/src/libcamera/software_isp/swstats_cpu.cpp index c520c806..a9a3e77a 100644 --- a/src/libcamera/software_isp/swstats_cpu.cpp +++ b/src/libcamera/software_isp/swstats_cpu.cpp @@ -71,6 +71,19 @@ namespace libcamera { * patternSize height == 1. * It'll process line 0 and 1 for input formats with patternSize height >= 2. * This function may only be called after a successful setWindow() call. + * + * This function takes an array of src pointers each pointing to a line in + * the source image. + * + * Bayer input data requires (patternSize_.height + 1) src pointers, with + * the middle element of the array pointing to the actual line being processed. + * Earlier element(s) will point to the previous line(s) and later element(s) + * to the next line(s). See the DebayerCpu::debayerFn documentation for details. + * + * Planar input data requires a src pointer for each plane, with src[0] pointing + * to the line in plane 0, etc. + * + * For non Bayer single plane input data only a single src pointer is required. */ /** @@ -89,20 +102,6 @@ namespace libcamera { * \brief Signals that the statistics are ready */ -/** - * \typedef SwStatsCpu::statsProcessFn - * \brief Called when there is data to get statistics from - * \param[in] src The input data - * - * These functions take an array of (patternSize_.height + 1) src - * pointers each pointing to a line in the source image. The middle - * element of the array will point to the actual line being processed. - * Earlier element(s) will point to the previous line(s) and later - * element(s) to the next line(s). - * - * See the documentation of DebayerCpu::debayerFn for more details. - */ - /** * \var unsigned int SwStatsCpu::ySkipMask_ * \brief Skip lines where this bitmask is set in y