{"id":21572,"url":"https://patchwork.libcamera.org/api/1.1/patches/21572/?format=json","web_url":"https://patchwork.libcamera.org/patch/21572/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/1.1/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":"<20241009200110.275544-2-hdegoede@redhat.com>","date":"2024-10-09T20:01:07","name":"[RFC,1/4] libcamera: swstats_cpu: Update statsProcessFn() / processLine0() documentation","commit_ref":null,"pull_url":null,"state":"superseded","archived":false,"hash":"c0b0044db5a2947d522938c71bb1d10b3806dc1d","submitter":{"id":102,"url":"https://patchwork.libcamera.org/api/1.1/people/102/?format=json","name":"Hans de Goede","email":"hdegoede@redhat.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/21572/mbox/","series":[{"id":4678,"url":"https://patchwork.libcamera.org/api/1.1/series/4678/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=4678","date":"2024-10-09T20:01:06","name":"libcamera: swstats_cpu: Add processFrame() method","version":1,"mbox":"https://patchwork.libcamera.org/series/4678/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/21572/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/21572/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 CB0CEC32DE\n\tfor ;\n\tWed, 9 Oct 2024 20:01:20 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 6885363538;\n\tWed, 9 Oct 2024 22:01:20 +0200 (CEST)","from us-smtp-delivery-124.mimecast.com\n\t(us-smtp-delivery-124.mimecast.com [170.10.133.124])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id EA7356536B\n\tfor ;\n\tWed, 9 Oct 2024 22:01:17 +0200 (CEST)","from mx-prod-mc-04.mail-002.prod.us-west-2.aws.redhat.com\n\t(ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63])\n\tby relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3,\n\tcipher=TLS_AES_256_GCM_SHA384) id us-mta-230-Qawf0pugPNK9pUYdgSJY9A-1;\n\tWed, 09 Oct 2024 16:01:15 -0400","from mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com\n\t(mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com\n\t[10.30.177.17])\n\t(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)\n\tkey-exchange X25519 server-signature RSA-PSS (2048 bits)\n\tserver-digest SHA256) (No client certificate requested)\n\tby mx-prod-mc-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix)\n\twith ESMTPS\n\tid CEF1C1955E74 for ;\n\tWed, 9 Oct 2024 20:01:14 +0000 (UTC)","from shalem.redhat.com (unknown [10.39.192.36])\n\tby mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix)\n\twith ESMTP id 752451956052; Wed, 9 Oct 2024 20:01:13 +0000 (UTC)"],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=redhat.com header.i=@redhat.com\n\theader.b=\"EtT1q3GO\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com;\n\ts=mimecast20190719; t=1728504076;\n\th=from:from:reply-to:subject:subject:date:date:message-id:message-id:\n\tto:to:cc:cc:mime-version:mime-version:content-type:content-type:\n\tcontent-transfer-encoding:content-transfer-encoding:\n\tin-reply-to:in-reply-to:references:references;\n\tbh=Y3PBAl8a/9s+7kky/ScLh6VGLJnq1s+yD4ufFlDHpEs=;\n\tb=EtT1q3GOxJU95tR0QwPzn4bgnTZ4SvgS+bTjZUu+SctdL0WPvF/eYhFTYXKZzLVpwe/+c8\n\tpld0IMBLggYJxqYqAYp68V04U9fNi21uG8kZh2YtF5M9NgTZ5pZulBcpU1cUT2EfwJrZbh\n\tzRz/7eC6qJki0tooL53GG1PZJz4ZLf4=","X-MC-Unique":"Qawf0pugPNK9pUYdgSJY9A-1","From":"Hans de Goede ","To":"libcamera-devel@lists.libcamera.org","Cc":"Milan Zamazal , Maxime Ripard , \n\tHans de Goede ","Subject":"[RFC 1/4] libcamera: swstats_cpu: Update statsProcessFn() /\n\tprocessLine0() documentation","Date":"Wed, 9 Oct 2024 22:01:07 +0200","Message-ID":"<20241009200110.275544-2-hdegoede@redhat.com>","In-Reply-To":"<20241009200110.275544-1-hdegoede@redhat.com>","References":"<20241009200110.275544-1-hdegoede@redhat.com>","MIME-Version":"1.0","X-Scanned-By":"MIMEDefang 3.0 on 10.30.177.17","X-Mimecast-Spam-Score":"0","X-Mimecast-Originator":"redhat.com","Content-Transfer-Encoding":"8bit","Content-Type":"text/plain; charset=\"US-ASCII\"; x-default=true","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","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "},"content":"Update the documentation of the statsProcessFn() / processLine0() src[]\npointer argument to take into account that swstats_cpu may also be used\nwith planar input data or with non Bayer single plane input data.\n\nThe statsProcessFn typedef is private, so no documentation is generated\nfor it. Move the new updated src[] pointer argument documentation to\nprocessLine0() so that it gets included in the generated docs.\n\nSigned-off-by: Hans de Goede \n---\n src/libcamera/software_isp/swstats_cpu.cpp | 27 +++++++++++-----------\n 1 file changed, 13 insertions(+), 14 deletions(-)","diff":"diff --git a/src/libcamera/software_isp/swstats_cpu.cpp b/src/libcamera/software_isp/swstats_cpu.cpp\nindex c520c806..a9a3e77a 100644\n--- a/src/libcamera/software_isp/swstats_cpu.cpp\n+++ b/src/libcamera/software_isp/swstats_cpu.cpp\n@@ -71,6 +71,19 @@ namespace libcamera {\n * patternSize height == 1.\n * It'll process line 0 and 1 for input formats with patternSize height >= 2.\n * This function may only be called after a successful setWindow() call.\n+ *\n+ * This function takes an array of src pointers each pointing to a line in\n+ * the source image.\n+ *\n+ * Bayer input data requires (patternSize_.height + 1) src pointers, with\n+ * the middle element of the array pointing to the actual line being processed.\n+ * Earlier element(s) will point to the previous line(s) and later element(s)\n+ * to the next line(s). See the DebayerCpu::debayerFn documentation for details.\n+ *\n+ * Planar input data requires a src pointer for each plane, with src[0] pointing\n+ * to the line in plane 0, etc.\n+ *\n+ * For non Bayer single plane input data only a single src pointer is required.\n */\n \n /**\n@@ -89,20 +102,6 @@ namespace libcamera {\n * \\brief Signals that the statistics are ready\n */\n \n-/**\n- * \\typedef SwStatsCpu::statsProcessFn\n- * \\brief Called when there is data to get statistics from\n- * \\param[in] src The input data\n- *\n- * These functions take an array of (patternSize_.height + 1) src\n- * pointers each pointing to a line in the source image. The middle\n- * element of the array will point to the actual line being processed.\n- * Earlier element(s) will point to the previous line(s) and later\n- * element(s) to the next line(s).\n- *\n- * See the documentation of DebayerCpu::debayerFn for more details.\n- */\n-\n /**\n * \\var unsigned int SwStatsCpu::ySkipMask_\n * \\brief Skip lines where this bitmask is set in y\n","prefixes":["RFC","1/4"]}