chore: add readme and cleanup benches

Author: not-matthias

.github/workflows/codspeed.yml

@@ -18,18 +18,15 @@ jobs:
     steps:
       - uses: actions/checkout@v4
         with: 
-          token: ${{ secrets.PAT }}
           lfs: true
-      - run: git config --global url."https://not-matthias:${{ secrets.PAT }}@github.com".insteadOf "https://github.com"
+      - uses: extractions/setup-just@v2
 
       - name: Cache opencv
         uses: actions/cache@v3
         with:
           path: build-opencv
           key: ${{ runner.os }}-build-opencv
 
-      - uses: extractions/setup-just@v2
-
       # https://docs.opencv.org/4.x/d7/d9f/tutorial_linux_install.html
       - name: Build opencv
         run: |
@@ -49,12 +46,6 @@ jobs:
           ninja -j$(nproc)
           sudo ninja install
           
-      # - uses: Dovyski/[email protected]
-      #   with:
-      #     opencv-version: '4.0.0'
-      #     CMAKE_BUILD_TYPE: RelWithDebInfo
-      #     install-deps: false
-          
       - name: Build the benchmark target(s)
         run: |
           just build-instrumentation
@@ -75,15 +66,8 @@ jobs:
     steps:
       - uses: actions/checkout@v4
         with: 
-          token: ${{ secrets.PAT }}
           lfs: true
-      - run: git config --global url."https://not-matthias:${{ secrets.PAT }}@github.com".insteadOf "https://github.com"
-
       - uses: extractions/setup-just@v2
-      # - uses: Dovyski/[email protected]
-      #   with:
-      #     opencv-version: '4.0.0'
-      #     install-deps: false
 
       - run: sudo apt-get update && sudo apt install -y libopencv-dev
 
@@ -92,7 +76,6 @@ jobs:
           just build-walltime
           just run
 
-
       - name: Run the benchmarks
         uses: CodSpeedHQ/action@v3
         with:

CMakeLists.txt

@@ -2,19 +2,8 @@ cmake_minimum_required(VERSION 3.12)
 project( opencv-benchmarks VERSION 0.0.0 LANGUAGES CXX)
 find_package( OpenCV REQUIRED )
 include_directories( ${OpenCV_INCLUDE_DIRS} )
-add_executable(
-    cv-bench
-    src/main.cpp
-    src/classifier.cpp
-    src/color_conversion.cpp
-    src/edge_detection.cpp
-    src/filter.cpp
-    src/read_image.cpp
-    src/transform.cpp
-)
-target_link_libraries( cv-bench ${OpenCV_LIBS} )
-
 
+# Configure Google Benchmark
 include(FetchContent)
 set(BENCHMARK_DOWNLOAD_DEPENDENCIES ON)
 set(BENCHMARK_ENABLE_TESTING OFF)
@@ -26,4 +15,30 @@ FetchContent_Declare(
     GIT_TAG origin/main
 )
 FetchContent_MakeAvailable(google_benchmark)
-target_link_libraries(cv-bench benchmark::benchmark)
+
+# Configure the executables
+#
+set(BENCHMARKS classifier color filter image transform)
+foreach(benchmark IN LISTS BENCHMARKS)
+  add_executable(${benchmark} src/${benchmark}.cpp)
+  target_link_libraries(${benchmark}
+    benchmark::benchmark
+    ${OpenCV_LIBS}
+  )
+endforeach()
+
+
+add_custom_target(run_all_benchmarks
+  COMMAND ${CMAKE_COMMAND} -E echo "Running all benchmarks..."
+)
+
+# Make each benchmark depend on the run_all_benchmarks target
+foreach(benchmark IN LISTS BENCHMARKS)
+  add_custom_command(
+    TARGET run_all_benchmarks
+    POST_BUILD
+    COMMAND ${CMAKE_COMMAND} -E echo "Running ${benchmark}..."
+    COMMAND $<TARGET_FILE:${benchmark}>
+    WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+  )
+endforeach()

Justfile

@@ -2,7 +2,8 @@ clean:
     rm -rf build
 
 run:
-    ./build/cv-bench
+    cp -r assets/ build/
+    cmake --build ./build --target run_all_benchmarks
 
 build:
     mkdir -p build

README.md

@@ -1,7 +1,76 @@
 # opencv-benches
 
+A benchmarking suite for comparing performance of various opencv library components using Google Benchmark.
+
+## Requirements
+
+- CMake 3.14+
+- C++14 compiler
+- OpenCV 4.x
+- [Just](https://github.com/casey/just) command runner
+- Ninja
+
+## Build
+
+Using the just command runner:
+```bash
+just clean    # Make sure that there's no 'build/' dir
+just build
+just run
+```
+
+Or by doing it manually:
+```bash
+mkdir build && cd build
+
+# Without codspeed
+cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo ..
+
+# With Codspeed instrumentation
+cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo -DCODSPEED_MODE=instrumentation ..
+
+# With regular timing based benchmarks
+cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo -DCODSPEED_MODE=walltime ..
+
+make
+```
+
+## Run
+
+```bash
+cp -r assets/ build/
+
+# Run individual component benchmarks
+./build/classifier
+./build/color
+./build/filter
+./build/image
+./build/transform
+
+# Run all benchmarks with a single command
+cmake --build ./build --target run_all_benchmarks
+
+# Pass arguments to all benchmarks
+cmake --build . --target run_all_benchmarks -- --benchmark_filter=BM_Boost
+
+# Run with regex filter
+./build/transform --benchmark_filter="BM_Rotate"
+
+# List available benchmarks
+./build/transform --benchmark_list_tests
+```
+
+
+## Benchmark Categories
+
+- **Classifier**: Detects objects in images.
+- **Color**: Converts colors between different color spaces.
+- **Image**: Everything related to image processing
+- **Filter**: Applies various image filters (e.g. blur, sharpen, edge detection).
+- **Transform**: Performs image transformations (e.g. rotation, scaling, cropping, ...)
 
 ## References
 
-https://docs.opencv.org/4.x/db/df5/tutorial_linux_gcc_cmake.html
-https://docs.opencv.org/4.x/d7/d9f/tutorial_linux_install.html
+- https://docs.opencv.org/4.x/db/df5/tutorial_linux_gcc_cmake.html
+- https://docs.opencv.org/4.x/d7/d9f/tutorial_linux_install.html
+- https://docs.opencv.org/4.x/index.html

src/classifier.cpp

@@ -61,3 +61,5 @@ BENCHMARK_DEFINE_F(ClassifierFixture, BM_ClassifyCat)(benchmark::State& state) {
   }
 }
 BENCHMARK_REGISTER_F(ClassifierFixture, BM_ClassifyCat);
+
+BENCHMARK_MAIN();

src/color.cpp

@@ -0,0 +1,57 @@
+#include <benchmark/benchmark.h>
+#include <opencv2/opencv.hpp>
+#include "fixtures.hpp"
+
+BENCHMARK_DEFINE_F(ImageFixture, BM_ColorConversion)
+(benchmark::State& state) {
+  // Get the color conversion code from the argument
+  int conversionCode = state.range(0);
+
+  for (auto _ : state) {
+    cv::Mat output;
+    cv::cvtColor(img, output, conversionCode);
+    benchmark::DoNotOptimize(output.data);
+  }
+}
+
+BENCHMARK_DEFINE_F(ImageFixture, BM_ColorConversion_MultiStep)
+(benchmark::State& state) {
+  for (auto _ : state) {
+    cv::Mat temp, output;
+    cv::cvtColor(img, temp, cv::COLOR_BGR2HSV);
+    cv::cvtColor(temp, output, cv::COLOR_HSV2RGB);
+    benchmark::DoNotOptimize(output.data);
+  }
+}
+
+BENCHMARK_DEFINE_F(ImageFixture, BM_ChannelOperations)
+(benchmark::State& state) {
+  for (auto _ : state) {
+    std::vector<cv::Mat> channels;
+    cv::split(img, channels);
+    cv::Mat merged;
+    cv::merge(channels, merged);
+    benchmark::DoNotOptimize(merged.data);
+  }
+}
+
+BENCHMARK_DEFINE_F(ImageFixture, BM_ColorConversion_BitDepth)
+(benchmark::State& state) {
+  for (auto _ : state) {
+    cv::Mat float_img, output;
+    img.convertTo(float_img, CV_32F, 1.0 / 255.0);
+    cv::cvtColor(float_img, output, cv::COLOR_BGR2HSV);
+    benchmark::DoNotOptimize(output.data);
+  }
+}
+
+BENCHMARK_REGISTER_F(ImageFixture, BM_ColorConversion)
+    ->Arg(cv::COLOR_BGR2GRAY)  // Test BGR to Grayscale
+    ->Arg(cv::COLOR_BGR2HSV)   // Test BGR to HSV
+    ->Arg(cv::COLOR_BGR2Lab)   // Test BGR to Lab
+    ->Arg(cv::COLOR_BGR2RGB);  // Test BGR to RGB
+BENCHMARK_REGISTER_F(ImageFixture, BM_ColorConversion_MultiStep);
+BENCHMARK_REGISTER_F(ImageFixture, BM_ChannelOperations);
+BENCHMARK_REGISTER_F(ImageFixture, BM_ColorConversion_BitDepth);
+
+BENCHMARK_MAIN();