Add REUSE compatibility (#338)

- Follow the best practices of https://reuse.software/ to ensure BSD-3 licence is correctly applied.
- Add a badge to README.md
- Note: remove arm build as the CI pipeline is broken for this architecture

.github/workflows/reuse.yml

@@ -0,0 +1,16 @@
+# SPDX-FileCopyrightText: © 2024 Team CharLS
+# SPDX-License-Identifier: BSD-3-Clause
+
+name: REUSE Compliance Check
+
+on: [push, pull_request]
+
+jobs:
+  reuse-compliance-check:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: REUSE Compliance Check
+      uses: fsfe/reuse-action@v5

CHANGELOG.md

@@ -1,3 +1,8 @@
+<!--
+  SPDX-FileCopyrightText: © 2017 Team CharLS
+  SPDX-License-Identifier: BSD-3-Clause
+-->
+
 # Changelog
 
 All notable changes to this project are documented in this file.

CMakeLists.txt

@@ -1,7 +1,7 @@
 # Copyright (c) Team CharLS.
 # SPDX-License-Identifier: BSD-3-Clause
 
-cmake_minimum_required(VERSION 3.16...3.30)
+cmake_minimum_required(VERSION 3.16...3.31)
 
 # Extract the version info from version.h
 file(READ "include/charls/version.h" version)

CharLS.sln.DotSettings

@@ -98,6 +98,7 @@
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=nightshot/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=NODISCARD/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=NOLINTNEXTLINE/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=optin/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=opto/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=oversized/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=palettised/@EntryIndexedValue">True</s:Boolean>

Directory.Build.props

@@ -1,4 +1,8 @@
-<?xml version="1.0" encoding="utf-8"?>
+<!--
+  SPDX-FileCopyrightText: © 2017 Team CharLS
+  SPDX-License-Identifier: BSD-3-Clause
+-->
+
 <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <PropertyGroup>
     <!-- Build to a folder outside the source folders, making it easier to clean. -->

LICENSES/BSD-3-Clause.txt

@@ -0,0 +1,11 @@
+Copyright (c) <year> <owner>. 
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -1,9 +1,14 @@
+<!--
+  SPDX-FileCopyrightText: © 2014 Team CharLS
+  SPDX-License-Identifier: BSD-3-Clause
+-->
 
 <img src="https://raw.githubusercontent.com/team-charls/charls/main/doc/jpeg_ls_logo.png" alt="JPEG-LS Logo" width="100"/>
 
 # CharLS
 
 [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://raw.githubusercontent.com/team-charls/charls/main/LICENSE.md)
+[![REUSE status](https://api.reuse.software/badge/github.com/team-charls/charls)](https://api.reuse.software/info/github.com/team-charls/charls)
 [![Build status](https://ci.appveyor.com/api/projects/status/yq0naf3v2m8nfa8r/branch/main?svg=true)](https://ci.appveyor.com/project/vbaderks/charls/branch/main)
 [![Build Status](https://dev.azure.com/team-charls/charls/_apis/build/status/team-charls.charls?branchName=main)](https://dev.azure.com/team-charls/charls/_build/latest?definitionId=2&branchName=main)
 [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=team-charls_charls&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=team-charls_charls)
@@ -43,7 +48,7 @@ The following JPEG-LS options are not supported by the CharLS implementation. Mo
 
 #### Note about JPEG-LS part 2
 
-After releasing the original baseline JPEG-LS standard ISO 14495-1:1999, ISO released an extension to the JPEG-LS standard called ISO/IEC 14495-2:2003: "Lossless and near-lossless compression of continuous-tone still images: Extensions". Currently CharLS doesn't support these extensions.
+After releasing the original baseline JPEG-LS standard ISO 14495-1:1999, ISO released an extension to the JPEG-LS standard called ISO/IEC 14495-2:2003: "Lossless and near-lossless compression of continuous-tone still images: Extensions". CharLS doesn't support this extension.
 
 ## Supported platforms
 
@@ -61,7 +66,6 @@ The code is regularly compiled/tested on Windows and 64 bit Linux. Additionally,
 | MSVC          | >= 2019                |
 | Apple Clang   | >= 12                  |
 
-
 ## Getting Started
 
 With [vcpkg](https://github.com/Microsoft/vcpkg) on Windows

REUSE.toml

@@ -0,0 +1,43 @@
+# SPDX-FileCopyrightText: © 2024 Team CharLS
+# SPDX-License-Identifier: BSD-3-Clause
+
+# This is a configuration file for the reuse lint tool. It allows specifing license info
+# for files that cannot be extended with such info.
+
+version = 1
+
+[[annotations]]
+path = [
+    "**.jls",
+    "**.bmp",
+    "**.png",
+    "**.pgm",
+    "**.ppm",
+    "**.raw",
+    "**.vcxproj",
+    "**.filters",
+    "**.cd",
+    "**.json",
+    "**app.manifest",
+    "spelling.dic",
+    "default.ruleset",
+    "src/charls.version",
+    "CharLS.sln",
+    "CharLS.sln.DotSettings",
+    "test/MR2_UNC"
+]
+precedence = "aggregate"
+SPDX-FileCopyrightText = "© 2024 Team CharLS"
+SPDX-License-Identifier = "BSD-3-Clause"
+
+[[annotations]]
+path = [
+    "test/conformance/README.md",
+    "test/conformance/*.jls",
+    "test/conformance/*.pgm",
+    "test/conformance/*.ppm",
+]
+precedence = "aggregate"
+SPDX-FileCopyrightText = "Copyright (c) Hewlett-Packard Company 1995-1999"
+SPDX-License-Identifier = "BSD-3-Clause"
+

SECURITY.md

@@ -1,3 +1,8 @@
+<!--
+  SPDX-FileCopyrightText: © 2019 Team CharLS
+  SPDX-License-Identifier: BSD-3-Clause
+-->
+
 # Security Policy
 
 ## Supported Versions

appveyor.yml

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: © 2015 Team CharLS
+# SPDX-License-Identifier: BSD-3-Clause
+
 version: 2.1.1.{build}
 os: Visual Studio 2019
 configuration:

azure-pipelines.yml

@@ -95,11 +95,6 @@ jobs:
         Architecture: x86
         Shared: 'OFF'
 
-      ARM Release:
-        BuildType: Release
-        Architecture: x64_arm
-        Shared: 'OFF'
-
       ARM64 Release:
         BuildType: Release
         Architecture: x64_arm64

benchmark/README.md

@@ -1,3 +1,8 @@
+<!--
+  SPDX-FileCopyrightText: © 2022 Team CharLS
+  SPDX-License-Identifier: BSD-3-Clause
+-->
+
 # Benchmark
 
 The Visual Studio project in this folder contains benchmarks to analyze different way of

default.ruleset.md

@@ -1,28 +1,42 @@
+<!--
+  SPDX-FileCopyrightText: © 2018 Team CharLS
+  SPDX-License-Identifier: BSD-3-Clause
+-->
+
 # Comments on disabled Visual Studio C++ Core Guidelines Rules
 
-C26426: Global initializer calls a non-constexpr function 'xxx'
--> Rationale: many false warnings. CharLS is a library, globals are correctly initialized.
+This document contains the rationales why some Microsoft
+C++ warnings are disabled in the file default.ruleset
+It is not possible to add this info to the .ruleset file itself as edit actions
+with the VS GUI would cause the comments to get lost.
+Most of disabled rules\warning are based on the C++ Core Guidelines that require
+usage of the gsl helper library.
 
-C26429: Symbol 'xxx' is never tested for nullness, it can be marked as not_null (f.23).
--> Rationale: Prefast attributes are better.
+## Warnings
 
-C26446: Prefer to use gsl::at() instead of unchecked subscript operator.
- -> Rationale: CharLS require good performance, gsl:at() cannot be used. debug STL already checks.
+- C26426: Global initializer calls a non-constexpr function 'xxx'  
+**Rationale**: many false warnings. CharLS is a library, globals are correctly initialized.
 
-C26459: You called an STL function '' with a raw pointer parameter. Consider wrapping your range in a gsl::span and pass as a span iterator (stl.1)
-Rationale: gsl:span() cannot be used. Update to std:span when available (C++20).
+- C26429: Symbol 'xxx' is never tested for nullness, it can be marked as not_null (f.23).  
+**Rationale**: Prefast attributes are better.
 
-C26472: Don't use static_cast for arithmetic conversions
- -> Rationale: can only be solved with gsl::narrow_cast
+- C26446: Prefer to use gsl::at() instead of unchecked subscript operator.  
+ **Rationale**: CharLS require good performance, gsl:at() cannot be used. debug STL already checks.
 
-C26481: Do not pass an array as a single pointer.
--> Rationale: gsl::span is not available.
+- C26459: You called an STL function '' with a raw pointer parameter. Consider wrapping your range in a gsl::span and pass as a span iterator (stl.1)  
+**Rationale**: gsl:span() cannot be used. Update to std:span when available (C++20).
 
-C26482: Only index into arrays using constant expressions.
--> Rationale: static analysis can verify access, std::array during runtime (debug)
+- C26472: Don't use static_cast for arithmetic conversions  
+ **Rationale**: can only be solved with gsl::narrow_cast
 
-C26490: Don't use reinterpret_cast
--> Rationale: required to cast unsigned char\* to char\*.
+- C26481: Do not pass an array as a single pointer.  
+**Rationale**: gsl::span is not available.
 
-C26494: Variable 'x' is uninitialized. Always initialize an object
--> Rationale: many false warnings, other analyzers are better.
+- C26482: Only index into arrays using constant expressions.  
+**Rationale**: static analysis can verify access, std::array during runtime (debug)
+
+- C26490: Don't use reinterpret_cast  
+**Rationale**: required to cast unsigned char\* to char\*.
+
+- C26494: Variable 'x' is uninitialized. Always initialize an object  
+**Rationale**: many false warnings, already covered with other analyzers.

doc/requirements.md

@@ -1,3 +1,8 @@
+<!--
+  SPDX-FileCopyrightText: © 2020 Team CharLS
+  SPDX-License-Identifier: BSD-3-Clause
+-->
+
 # Style and Design
 
 ## Introduction

doc/style_and_design.md

@@ -1,3 +1,8 @@
+<!--
+  SPDX-FileCopyrightText: © 2014 Team CharLS
+  SPDX-License-Identifier: BSD-3-Clause
+-->
+
 # Style and Design
 
 ## Introduction

fuzzing/libfuzzer/README.md

@@ -1,3 +1,8 @@
+<!--
+  SPDX-FileCopyrightText: © 2023 Team CharLS
+  SPDX-License-Identifier: BSD-3-Clause
+-->
+
 # Instructions to fuzz CharLS with LibFuzzer
 
 - It is in general recommended to fuzz the release builds.

samples/README.md

@@ -1,3 +1,8 @@
+<!--
+  SPDX-FileCopyrightText: © 2021 Team CharLS
+  SPDX-License-Identifier: BSD-3-Clause
+-->
+
 The C/C++ samples applications are created for simplicity and to demonstrate
 how the use the CharLS API. They are not production quality. In particular they
-should not be installed in binary distribution as reference command line utils
+should not be installed in binary distribution as reference command line utils.

src/charls-template.pc

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: © 2020 Team CharLS
+# SPDX-License-Identifier: BSD-3-Clause
+
 prefix=@CMAKE_INSTALL_PREFIX@
 exec_prefix=${prefix}
 libdir=${prefix}/@CMAKE_INSTALL_LIBDIR@

unittest/CodeCoverage.runsettings

@@ -1,4 +1,8 @@
-<?xml version="1.0" encoding="utf-8"?>
+<!--
+  SPDX-FileCopyrightText: © 2023 Team CharLS
+  SPDX-License-Identifier: BSD-3-Clause
+-->
+
 <RunSettings>
   <DataCollectionRunSettings>
     <DataCollectors>