{"id":19678,"url":"https://patchwork.libcamera.org/api/patches/19678/?format=json","web_url":"https://patchwork.libcamera.org/patch/19678/","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":"<20240311141524.27192-17-hdegoede@redhat.com>","date":"2024-03-11T14:15:20","name":"[v5,16/18] libcamera: Add \"Software ISP benchmarking\" documentation","commit_ref":null,"pull_url":null,"state":"superseded","archived":false,"hash":"4fa2f0fc22db6cb7e82c6d68e6a0f21e8dec434f","submitter":{"id":102,"url":"https://patchwork.libcamera.org/api/people/102/?format=json","name":"Hans de Goede","email":"hdegoede@redhat.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/19678/mbox/","series":[{"id":4214,"url":"https://patchwork.libcamera.org/api/series/4214/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=4214","date":"2024-03-11T14:15:04","name":"libcamera: introduce Software ISP and Software IPA","version":5,"mbox":"https://patchwork.libcamera.org/series/4214/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/19678/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/19678/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 CCAE8C32C4\n\tfor ;\n\tMon, 11 Mar 2024 14:15:59 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 7D9D462C9A;\n\tMon, 11 Mar 2024 15:15:59 +0100 (CET)","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 772FB62CA1\n\tfor ;\n\tMon, 11 Mar 2024 15:15:56 +0100 (CET)","from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com\n\t[66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS\n\t(version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id\n\tus-mta-62-WUt-xPmjPm2paV0o7SCNoA-1; Mon, 11 Mar 2024 10:15:52 -0400","from smtp.corp.redhat.com\n\t(int-mx07.intmail.prod.int.rdu2.redhat.com [10.11.54.7])\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 mimecast-mx02.redhat.com (Postfix) with ESMTPS id AD84887280A;\n\tMon, 11 Mar 2024 14:15:51 +0000 (UTC)","from x1.localdomain.com (unknown [10.39.195.37])\n\tby smtp.corp.redhat.com (Postfix) with ESMTP id 8CA321C060A6;\n\tMon, 11 Mar 2024 14:15:50 +0000 (UTC)"],"Authentication-Results":"lancelot.ideasonboard.com;\n\tdkim=fail reason=\"signature verification failed\" (1024-bit key;\n\tunprotected) header.d=redhat.com header.i=@redhat.com\n\theader.b=\"TZoesmFw\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com;\n\ts=mimecast20190719; t=1710166555;\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=y+ppHpQfm+xVtulYhLvDzFaT9lsG+dqIR3B1w+7Akvs=;\n\tb=TZoesmFwdPy1LN0ylhDLbe8QBnAAieqM997KRocF9wUkj1C6bEO5fk+O4CFxaBSekpQnsi\n\tjlRS1VKmi/cUlq3AfbaOuR79KOoIQihXng7CssRomVwpj6JvMGg8Tgret0V6rv9T71D77R\n\tpUdr8A48fIaN6nKYqNASwOu6BLrVVzo=","X-MC-Unique":"WUt-xPmjPm2paV0o7SCNoA-1","From":"Hans de Goede ","To":"libcamera-devel@lists.libcamera.org","Subject":"[PATCH v5 16/18] libcamera: Add \"Software ISP benchmarking\"\n\tdocumentation","Date":"Mon, 11 Mar 2024 15:15:20 +0100","Message-ID":"<20240311141524.27192-17-hdegoede@redhat.com>","In-Reply-To":"<20240311141524.27192-1-hdegoede@redhat.com>","References":"<20240311141524.27192-1-hdegoede@redhat.com>","MIME-Version":"1.0","X-Scanned-By":"MIMEDefang 3.4.1 on 10.11.54.7","X-Mimecast-Spam-Score":"0","X-Mimecast-Originator":"redhat.com","Content-Type":"text/plain; charset=UTF-8","Content-Transfer-Encoding":"8bit","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","Cc":"Maxime Ripard , Pavel Machek ,\n\tBryan O'Donoghue ","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "},"content":"Add a \"Software ISP benchmarking\" documentation section which describes\nthe performance/power consumption measurements used during\nthe Software ISP's development.\n\nReviewed-by: Milan Zamazal \nSigned-off-by: Hans de Goede \n---\nChanges in v5:\n- Add \"text\" / \"shell\" as language to the code-block:: directives\n to fix build failure with older sphinx versions\n---\n Documentation/index.rst | 1 +\n Documentation/meson.build | 1 +\n Documentation/software-isp-benchmarking.rst | 82 +++++++++++++++++++++\n 3 files changed, 84 insertions(+)\n create mode 100644 Documentation/software-isp-benchmarking.rst","diff":"diff --git a/Documentation/index.rst b/Documentation/index.rst\nindex 63fac72d..5442ae75 100644\n--- a/Documentation/index.rst\n+++ b/Documentation/index.rst\n@@ -24,3 +24,4 @@\n Lens driver requirements \n Python Bindings \n Camera Sensor Model \n+ SoftwareISP Benchmarking \ndiff --git a/Documentation/meson.build b/Documentation/meson.build\nindex 7a58fec8..3872e0a8 100644\n--- a/Documentation/meson.build\n+++ b/Documentation/meson.build\n@@ -80,6 +80,7 @@ if sphinx.found()\n 'lens_driver_requirements.rst',\n 'python-bindings.rst',\n 'sensor_driver_requirements.rst',\n+ 'software-isp-benchmarking.rst',\n '../README.rst',\n ]\n \ndiff --git a/Documentation/software-isp-benchmarking.rst b/Documentation/software-isp-benchmarking.rst\nnew file mode 100644\nindex 00000000..b2803953\n--- /dev/null\n+++ b/Documentation/software-isp-benchmarking.rst\n@@ -0,0 +1,82 @@\n+.. SPDX-License-Identifier: CC-BY-SA-4.0\n+\n+.. _software-isp-benchmarking:\n+\n+Software ISP benchmarking\n+=========================\n+\n+The Software ISP is particularly sensitive to performance regressions\n+therefore it is a good idea to always benchmark the Software ISP\n+before and after making changes to it and ensure that there are\n+no performance regressions.\n+\n+DebayerCpu class builtin benchmark\n+----------------------------------\n+\n+The DebayerCpu class has a builtin benchmark. This benchmark\n+measures the time spent on processing (collecting statistics\n+and debayering) only, it does not measure the time spent on\n+capturing or outputting the frames.\n+\n+The builtin benchmark always runs. So this can be used by simply\n+running \"cam\" or \"qcam\" with a pipeline using the Software ISP.\n+\n+When it runs it will skip measuring the first 30 frames to\n+allow the caches and the CPU temperature (turbo-ing) to warm-up\n+and then it measures 30 fps and shows the total and per frame\n+processing time using an info level log message:\n+\n+.. code-block:: text\n+\n+ INFO Debayer debayer_cpu.cpp:907 Processed 30 frames in 244317us, 8143 us/frame\n+\n+To get stable measurements it is advised to disable any other processes which\n+may cause significant CPU usage (e.g. disable wifi, bluetooth and browsers).\n+When possible it is also advisable to disable CPU turbo-ing and\n+frequency-scaling.\n+\n+For example when benchmarking on a Lenovo ThinkPad X1 Yoga Gen 8, with\n+the charger plugged in, the CPU can be fixed to run at 2 GHz using:\n+\n+.. code-block:: shell\n+\n+ sudo x86_energy_perf_policy --turbo-enable 0\n+ sudo cpupower frequency-set -d 2GHz -u 2GHz\n+\n+with these settings the builtin bench reports a processing time of ~7.8ms/frame\n+on this laptop for FHD SGRBG10 (unpacked) bayer data.\n+\n+Measuring power consumption\n+---------------------------\n+\n+Since the Software ISP is often used on mobile devices it is also\n+important to measure power consumption and ensure that that does\n+not regress.\n+\n+For example to measure power consumption on a Lenovo ThinkPad X1 Yoga Gen 8\n+it needs to be running on battery and it should be configured with its\n+platform-profile (/sys/firmware/acpi/platform_profile) set to balanced and\n+with its default turbo and frequency-scaling behavior to match real world usage.\n+\n+Then start qcam to capture a FHD picture at 30 fps and position the qcam window\n+so that it is fully visible. After this run the following command to monitor\n+the power consumption:\n+\n+.. code-block:: shell\n+\n+ watch -n 10 cat /sys/class/power_supply/BAT0/power_now /sys/class/hwmon/hwmon6/fan?_input\n+\n+Note this not only measures the power consumption in µW it also monitors\n+the speed of this laptop's 2 fans. This is important because depending on\n+the ambient temperature the 2 fans may spin up while testing and this\n+will cause an additional power consumption of approx. 0.5 W messing up\n+the measurement.\n+\n+After starting qcam + the watch command let the laptop sit without using\n+it for 2 minutes for the readings to stabilize. Then check that the fans\n+have not turned on and manually take a couple of consecutive power readings\n+and avarage these.\n+\n+On the example Lenovo ThinkPad X1 Yoga Gen 8 laptop this results in\n+a measured power consumption of approx. 13 W while running qcam versus\n+approx. 4-5 W while setting idle with its OLED panel on.\n","prefixes":["v5","16/18"]}