Updates to build with latest compilers and backport decode benchmark (#326)

.clang-tidy

@@ -22,8 +22,10 @@
 # -clang-diagnostic-unused-const-variable => Rationale: false warnings for constexpr in .h files
 # -clang-diagnostic-unused-command-line-argument => Rationale: false warning about option passed to MSVC
 # -clang-diagnostic-declaration-after-statement => Rationale: Target is C14 and higher
+# -clang-diagnostic-unsafe-buffer-usage => Rationale: Too many false warnings, access is verified with other tools.
 # -clang-analyzer-core.NonNullParamChecker => Rationale: cannot be effective disabled, already checked by other checkers.
 # -misc-non-private-member-variables-in-classes => Rationale: design can be ok, manual review is better
+# -misc-include-cleaner => complains about no direct includes
 # -modernize-use-trailing-return-type => Rationale: A style recommendation, this style is selected for CharLS
 # -readability-magic-numbers => Rationale: To critical rule, used numbers are logical
 # -readability-named-parameter => Rationale: to many non problematic warnings
@@ -72,7 +74,9 @@ Checks:          '*,
                   -clang-diagnostic-unused-const-variable,
                   -clang-diagnostic-unused-command-line-argument,
                   -clang-diagnostic-declaration-after-statement,
+                  -clang-diagnostic-unsafe-buffer-usage,
                   -clang-analyzer-core.NonNullParamChecker,
+                  -misc-include-cleaner,
                   -misc-non-private-member-variables-in-classes,
                   -modernize-use-trailing-return-type,
                   -readability-magic-numbers,

.editorconfig

@@ -8,6 +8,7 @@ root = true
 charset = utf-8
 indent_style = space
 trim_trailing_whitespace = true
+spelling_exclusion_path = spelling.dic
 
 [*.md]
 trim_trailing_whitespace = false

azure-pipelines.yml

@@ -208,22 +208,22 @@ jobs:
         CXX: g++-12
         Shared: 'ON'
 
-      Clang-12 Debug:
+      Clang-13 Debug:
         buildType: Debug
-        CC: clang-12
-        CXX: clang++-12
-        Shared: 'OFF'
-
-      Clang-13 Release:
-        buildType: Release
         CC: clang-13
         CXX: clang++-13
         Shared: 'OFF'
 
-      Clang-14 Release Shared:
+      Clang-14 Release:
         buildType: Release
         CC: clang-14
         CXX: clang++-14
+        Shared: 'OFF'
+
+      Clang-15 Release Shared:
+        buildType: Release
+        CC: clang-15
+        CXX: clang++-15
         Shared: 'ON'
 
   steps:

benchmark/benchmark.cpp

@@ -324,7 +324,9 @@ static void bm_resize_overwrite_buffer(benchmark::State& state)
 }
 BENCHMARK(bm_resize_overwrite_buffer);
 
+// Tips to run the benchmark tests:
 
-
+// To run a single benchmark:
+// benchmark --benchmark_filter=bm_decode
 
 BENCHMARK_MAIN();

benchmark/benchmark.vcxproj

@@ -276,6 +276,7 @@
   <ItemGroup>
     <ClCompile Include="benchmark.cpp" />
     <ClCompile Include="context_regular_mode.cpp" />
+    <ClCompile Include="decode.cpp" />
     <ClCompile Include="log2.cpp" />
   </ItemGroup>
   <ItemGroup>

benchmark/benchmark.vcxproj.filters

@@ -24,6 +24,9 @@
     <ClCompile Include="log2.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
+    <ClCompile Include="decode.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="context_regular_mode_v220.h">

benchmark/decode.cpp

@@ -0,0 +1,72 @@
+// Copyright (c) Team CharLS.
+// SPDX-License-Identifier: BSD-3-Clause
+
+#include <benchmark/benchmark.h>
+
+#include "../include/charls/charls.h"
+
+#include <fstream>
+#include <iomanip>
+#include <iostream>
+#include <vector>
+
+#pragma warning(disable : 26409) // Avoid calling new explicitly (triggered by BENCHMARK macro)
+
+using namespace charls;
+using std::ifstream;
+using std::ios;
+using std::vector;
+
+template<typename Container>
+void read(std::istream& input, Container& destination)
+{
+    input.read(reinterpret_cast<char*>(destination.data()), static_cast<std::streamsize>(destination.size()));
+}
+
+vector<uint8_t> read_file(const char* filename, long offset = 0, size_t bytes = 0)
+try
+{
+    ifstream input;
+    input.exceptions(ios::eofbit | ios::failbit | ios::badbit);
+    input.open(filename, ios::in | ios::binary);
+
+    input.seekg(0, ios::end);
+    const auto byte_count_file{static_cast<int>(input.tellg())};
+    input.seekg(offset, ios::beg);
+
+    if (offset < 0)
+    {
+        offset = static_cast<long>(byte_count_file - bytes);
+    }
+    if (bytes == 0)
+    {
+        bytes = static_cast<size_t>(byte_count_file) - offset;
+    }
+
+    vector<uint8_t> buffer(bytes);
+    read(input, buffer);
+
+    return buffer;
+}
+catch (const std::ifstream::failure&)
+{
+    std::cout << "Failed to open/read file: " << filename << "\n";
+    throw;
+}
+
+
+static void bm_decode(benchmark::State& state)
+{
+    const auto source{read_file("d:/benchmark-test-image.jls")};
+
+    // Pre-allocate the destination outside the measurement loop.
+    // std::vector initializes its elements and this step needs to be excluded from the measurement.
+    vector<uint8_t> destination(jpegls_decoder{source, true}.destination_size());
+
+    for (const auto _ : state)
+    {
+        jpegls_decoder decoder(source.data(), source.size());
+        decoder.decode(destination);
+    }
+}
+BENCHMARK(bm_decode);

benchmark/vcpkg.json

@@ -1,8 +1,5 @@
 {
-    "$schema": "https://raw.githubusercontent.com/microsoft/vcpkg/master/scripts/vcpkg.schema.json",
+  "$schema": "https://raw.githubusercontent.com/microsoft/vcpkg/master/scripts/vcpkg.schema.json",
-    "name": "charls-benchmark",
+  "dependencies": [ { "name": "benchmark", "version>=":"1.8.5" } ],
-    "version": "1.0.0",
+  "builtin-baseline": "3508985146f1b1d248c67ead13f8f54be5b4f5da"
-    "dependencies": [
+}
-      "benchmark"
-    ]
-  }

default.ruleset

@@ -12,6 +12,7 @@
     <Rule Id="C26485" Action="None" />
     <Rule Id="C26490" Action="None" />
     <Rule Id="C26492" Action="None" />
+    <Rule Id="C26493" Action="None" />
     <Rule Id="C26494" Action="None" />
   </Rules>
 </RuleSet>

default.ruleset.md

@@ -27,5 +27,8 @@ C26490: Don't use reinterpret_cast
 C26492: Don't use const_cast to cast away const (type.3).
 -> Rationale: required for some special cases.
 
+C26493: Don't use C-style casts (type.4).
+-> Rationale: False positives in Visual Studio 2022 17.11.0 Preview 3.0
+
 C26494: Variable 'x' is uninitialized. Always initialize an object
 -> Rationale: many false warnings, other analyzers are better.

spelling.dic

@@ -0,0 +1,2 @@
+jpegls
+charls