[34/36] libcamera: software_isp: Rename "measure" option to "benchmark"
diff mbox series

Message ID 20260113000808.15395-35-laurent.pinchart@ideasonboard.com
State New
Headers show
Series
  • libcamera: Global configuration file improvements
Related show

Commit Message

Laurent Pinchart Jan. 13, 2026, 12:08 a.m. UTC
The software ISP "measure" configuration option doesn't clearly indicate
what it measures. Rename it to "benchmark" to match the name of the
class that handles it and make it self-explicit.

While at it, improve the documentation slightly by replacing "per-frame
time measurement" with "performance measurement".

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 Documentation/runtime_configuration.rst  | 10 +++++-----
 src/libcamera/software_isp/benchmark.cpp | 10 +++++-----
 2 files changed, 10 insertions(+), 10 deletions(-)

Comments

Barnabás Pőcze Jan. 14, 2026, 9:43 a.m. UTC | #1
2026. 01. 13. 1:08 keltezéssel, Laurent Pinchart írta:
> The software ISP "measure" configuration option doesn't clearly indicate
> what it measures. Rename it to "benchmark" to match the name of the
> class that handles it and make it self-explicit.
> 
> While at it, improve the documentation slightly by replacing "per-frame
> time measurement" with "performance measurement".
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> ---

Reviewed-by: Barnabás Pőcze <barnabas.pocze@ideasonboard.com>


>   Documentation/runtime_configuration.rst  | 10 +++++-----
>   src/libcamera/software_isp/benchmark.cpp | 10 +++++-----
>   2 files changed, 10 insertions(+), 10 deletions(-)
> 
> diff --git a/Documentation/runtime_configuration.rst b/Documentation/runtime_configuration.rst
> index b4386cd2ef4b..8c920978648d 100644
> --- a/Documentation/runtime_configuration.rst
> +++ b/Documentation/runtime_configuration.rst
> @@ -48,7 +48,7 @@ file structure:
>               software_isp: # true/false
>       software_isp:
>         copy_input_buffer: # true/false
> -      measure:
> +      benchmark:
>           skip: # non-negative integer, frames to skip initially
>           number: # non-negative integer, frames to measure
>   
> @@ -81,7 +81,7 @@ Configuration file example
>                software_isp: true
>        software_isp:
>          copy_input_buffer: false
> -       measure:
> +       benchmark:
>            skip: 50
>            number: 30
>   
> @@ -155,13 +155,13 @@ software_isp.copy_input_buffer
>   
>      Example value: ``false``
>   
> -software_isp.measure.skip, software_isp.measure.number
> -   Define per-frame time measurement parameters in software ISP. `skip`
> +software_isp.benchmark.skip, software_isp.benchmark.number
> +   Define performance measurement parameters for the software ISP. `skip`
>      defines how many initial frames are skipped before starting the
>      measurement; `number` defines how many frames then participate in the
>      measurement.
>   
> -   Set `software_isp.measure.number` to 0 to disable the measurement.
> +   Set `software_isp.benchmark.number` to 0 to disable the measurement.
>   
>      Example `skip` value: ``50``
>   
> diff --git a/src/libcamera/software_isp/benchmark.cpp b/src/libcamera/software_isp/benchmark.cpp
> index b15ddd66e26f..47bd58727ac3 100644
> --- a/src/libcamera/software_isp/benchmark.cpp
> +++ b/src/libcamera/software_isp/benchmark.cpp
> @@ -34,11 +34,11 @@ Benchmark::Benchmark(const CameraManager &cm)
>   	const GlobalConfiguration &configuration = cm._d()->configuration();
>   
>   	skipBeforeMeasure_ = configuration.option<unsigned int>(
> -						{ "software_isp", "measure", "skip" })
> -							.value_or(skipBeforeMeasure_);
> -	framesToMeasure_ = configuration.option<unsigned int>(
> -						{ "software_isp", "measure", "number" })
> -							.value_or(framesToMeasure_);
> +						{ "software_isp", "benchmark", "skip" })
> +					  .value_or(skipBeforeMeasure_);
> +        framesToMeasure_ = configuration.option<unsigned int>(
> +						{ "software_isp", "benchmark", "number" })
> +					.value_or(framesToMeasure_);
>   }
>   
>   Benchmark::~Benchmark()

Patch
diff mbox series

diff --git a/Documentation/runtime_configuration.rst b/Documentation/runtime_configuration.rst
index b4386cd2ef4b..8c920978648d 100644
--- a/Documentation/runtime_configuration.rst
+++ b/Documentation/runtime_configuration.rst
@@ -48,7 +48,7 @@  file structure:
             software_isp: # true/false
     software_isp:
       copy_input_buffer: # true/false
-      measure:
+      benchmark:
         skip: # non-negative integer, frames to skip initially
         number: # non-negative integer, frames to measure
 
@@ -81,7 +81,7 @@  Configuration file example
              software_isp: true
      software_isp:
        copy_input_buffer: false
-       measure:
+       benchmark:
          skip: 50
          number: 30
 
@@ -155,13 +155,13 @@  software_isp.copy_input_buffer
 
    Example value: ``false``
 
-software_isp.measure.skip, software_isp.measure.number
-   Define per-frame time measurement parameters in software ISP. `skip`
+software_isp.benchmark.skip, software_isp.benchmark.number
+   Define performance measurement parameters for the software ISP. `skip`
    defines how many initial frames are skipped before starting the
    measurement; `number` defines how many frames then participate in the
    measurement.
 
-   Set `software_isp.measure.number` to 0 to disable the measurement.
+   Set `software_isp.benchmark.number` to 0 to disable the measurement.
 
    Example `skip` value: ``50``
 
diff --git a/src/libcamera/software_isp/benchmark.cpp b/src/libcamera/software_isp/benchmark.cpp
index b15ddd66e26f..47bd58727ac3 100644
--- a/src/libcamera/software_isp/benchmark.cpp
+++ b/src/libcamera/software_isp/benchmark.cpp
@@ -34,11 +34,11 @@  Benchmark::Benchmark(const CameraManager &cm)
 	const GlobalConfiguration &configuration = cm._d()->configuration();
 
 	skipBeforeMeasure_ = configuration.option<unsigned int>(
-						{ "software_isp", "measure", "skip" })
-							.value_or(skipBeforeMeasure_);
-	framesToMeasure_ = configuration.option<unsigned int>(
-						{ "software_isp", "measure", "number" })
-							.value_or(framesToMeasure_);
+						{ "software_isp", "benchmark", "skip" })
+					  .value_or(skipBeforeMeasure_);
+        framesToMeasure_ = configuration.option<unsigned int>(
+						{ "software_isp", "benchmark", "number" })
+					.value_or(framesToMeasure_);
 }
 
 Benchmark::~Benchmark()