Allow disabling codecs at compile time

- Replace hard-coded defines in of_openfec_profile.h and some other
  files with of_build_config.h configured by cmake.

- Add relevant cmake options.

- If needed codecs are disabled, exclude corresponding tests.

- Add minimal build to CI.

Author: gavv

.github/workflows/build.yml

@@ -18,7 +18,7 @@ on:
 
 jobs:
 
-  build:
+  default-build:
     strategy:
       matrix:
         image: [ubuntu-latest, macos-latest]
@@ -53,9 +53,46 @@ jobs:
           cd build
           make DESTDIR=../dist install
 
+  minimal-build:
+    runs-on: ubuntu-latest
+    name: minimal-build
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: CMake
+        run: |
+          mkdir build
+          cd build
+          cmake \
+            -DOF_USE_REED_SOLOMON_CODEC=OFF \
+            -DOF_USE_REED_SOLOMON_2_M_CODEC=ON \
+            -DOF_USE_LDPC_STAIRCASE_CODEC=OFF \
+            -DOF_USE_2D_PARITY_MATRIX_CODEC=OFF \
+            -DOF_USE_LDPC_FROM_FILE_CODEC=OFF \
+            ..
+
+      - name: Make
+        run: |
+          cd build
+          make -j2
+
+      - name: Make test
+        run: |
+          cd build
+          make test
+
+      - name: Make install
+        run: |
+          cd build
+          make DESTDIR=../dist install
+
   release:
     if: startsWith(github.ref, 'refs/tags/v')
-    needs: [build]
+    needs: [default-build, minimal-build]
 
     runs-on: ubuntu-latest
     steps:

.gitignore

@@ -3,4 +3,6 @@
 /dist
 /perf_eval/descr_stats
 /pc/openfec.pc
+/src/lib_common/of_build_config.h
 ._*
+.justfile

applis/eperftool/sender.c

@@ -327,6 +327,7 @@ encode (void)
 		 * is above a certain threshold), so do not sent it since the codec already knows it.
 		 */
 		blk->ldpc_dont_send_last_repair = false;		/* by default */
+#ifdef OF_USE_LDPC_STAIRCASE_CODEC
 		if (codec_id == OF_CODEC_LDPC_STAIRCASE_STABLE) {
 			bool	lib_says_its_null;	/* boolean */
 
@@ -356,6 +357,7 @@ encode (void)
 			}
 #endif
 		}
+#endif
 		if (of_release_codec_instance(ses) != OF_STATUS_OK) {
 			OF_PRINT_ERROR(("ERROR: of_release_codec_instance() failed\n"))
 			goto error;
@@ -378,4 +380,3 @@ encode (void)
 error:
 	return OF_STATUS_ERROR;
 }
-

applis/howto_examples/simple_client_server/CMakeLists.txt

@@ -1,20 +1,24 @@
-file (GLOB simple_server_sources ./simple_server.c)
+if(OF_USE_REED_SOLOMON_2_M_CODEC AND OF_USE_LDPC_STAIRCASE_CODEC)
+  # simple_server
+  file (GLOB simple_server_sources ./simple_server.c)
 
-set(SIMPLE_SERVER_BIN ${EXECUTABLE_OUTPUT_PATH}/simple_server CACHE STRING "simple_server exe")
-add_executable(simple_server ${simple_server_sources})
+  set(SIMPLE_SERVER_BIN ${EXECUTABLE_OUTPUT_PATH}/simple_server CACHE STRING "simple_server exe")
+  add_executable(simple_server ${simple_server_sources})
 
-target_link_libraries(simple_server openfec m)
+  target_link_libraries(simple_server openfec m)
 
+  # simple_client
+  file (GLOB simple_client_sources ./simple_client.c)
 
-file (GLOB simple_client_sources ./simple_client.c)
+  set(SIMPLE_SERVER_BIN ${EXECUTABLE_OUTPUT_PATH}/simple_client CACHE STRING "simple_client exe")
+  add_executable(simple_client ${simple_client_sources})
 
-set(SIMPLE_SERVER_BIN ${EXECUTABLE_OUTPUT_PATH}/simple_client CACHE STRING "simple_client exe")
-add_executable(simple_client ${simple_client_sources})
+  target_link_libraries(simple_client openfec m)
 
-target_link_libraries(simple_client openfec m)
-
-if(INSTALL_DEVTOOLS)
-  install(TARGETS simple_server simple_client
-    RUNTIME DESTINATION ${CMAKE_INSTALL_FULL_BINDIR}
-    COMPONENT applis)
-endif()
+  # install
+  if(INSTALL_DEVTOOLS)
+    install(TARGETS simple_server simple_client
+      RUNTIME DESTINATION ${CMAKE_INSTALL_FULL_BINDIR}
+      COMPONENT applis)
+  endif()
+endif(OF_USE_REED_SOLOMON_2_M_CODEC AND OF_USE_LDPC_STAIRCASE_CODEC)

applis/howto_examples/simple_client_server/simple_client.c

@@ -31,11 +31,20 @@
  * knowledge of the CeCILL-C license and that you accept its terms.
  */
 
-/* this is the decoder */
-#define OF_USE_DECODER
-
 #include "simple_client_server.h"
 
+#ifndef OF_USE_DECODER
+#error "OF_USE_DECODER undefined"
+#endif
+
+#ifndef OF_USE_REED_SOLOMON_2_M_CODEC
+#error "OF_USE_REED_SOLOMON_2_M_CODEC undefined"
+#endif
+
+#ifndef OF_USE_LDPC_STAIRCASE_CODEC
+#error "OF_USE_LDPC_STAIRCASE_CODEC undefined"
+#endif
+
 
 /*
  * Chose which decoding method to use... Both should be equivalent.
@@ -480,4 +489,3 @@ dump_buffer_32 (void	*buf,
 	}
 	printf("\n");
 }
-

applis/howto_examples/simple_client_server/simple_server.c

@@ -31,11 +31,20 @@
  * knowledge of the CeCILL-C license and that you accept its terms.
  */
 
-/* this is the encoder */
-#define OF_USE_ENCODER
-
 #include "simple_client_server.h"
 
+#ifndef OF_USE_ENCODER
+#error "OF_USE_ENCODER undefined"
+#endif
+
+#ifndef OF_USE_REED_SOLOMON_2_M_CODEC
+#error "OF_USE_REED_SOLOMON_2_M_CODEC undefined"
+#endif
+
+#ifndef OF_USE_LDPC_STAIRCASE_CODEC
+#error "OF_USE_LDPC_STAIRCASE_CODEC undefined"
+#endif
+
 
 /* Prototypes */
 
@@ -373,4 +382,3 @@ dump_buffer_32 (void	*buf,
 	}
 	printf("\n");
 }
-

src/CMakeLists.txt

@@ -1,4 +1,15 @@
-file (GLOB_RECURSE openfec_sources *)
+file(GLOB_RECURSE openfec_sources *)
+
+option(OF_USE_REED_SOLOMON_CODEC "Enable Reed-Solomon 2_8 codec" ON)
+option(OF_USE_REED_SOLOMON_2_M_CODEC "Enable Reed-Solomon 2_M codec" ON)
+option(OF_USE_LDPC_STAIRCASE_CODEC "Enable LDPC-Staircase codec" ON)
+option(OF_USE_2D_PARITY_MATRIX_CODEC "Enable 2d parity matrix codec" ON)
+option(OF_USE_LDPC_FROM_FILE_CODEC "Enable ldpc_from_file codec" OFF)
+
+option(ASSEMBLY_SSE_OPT "Enable SSE optimizations for XOR operations" OFF)
+
+configure_file(lib_common/of_build_config.h.in
+  ${CMAKE_CURRENT_SOURCE_DIR}/lib_common/of_build_config.h)
 
 # Use -DBUILD_STATIC_LIBS=ON to build static libraries instead of shared.
 option(BUILD_STATIC_LIBS "Build the static library" OFF)
@@ -10,14 +21,14 @@ else(BUILD_STATIC_LIBS)
 endif(BUILD_STATIC_LIBS)
 
 # From: $cmake --help-property SOVERSION
-#		For shared libraries VERSION and SOVERSION can be used to specify
-#		the build version and api version respectively.
+#    For shared libraries VERSION and SOVERSION can be used to specify
+#    the build version and api version respectively.
 #
 # Edit it as appropriate to be in line with the src/lib_common/of_openfec_api.c::more_about() version
 #
 set_target_properties(openfec PROPERTIES
-			VERSION 1.4.2
-			SOVERSION 1) 
+  VERSION 1.4.2
+  SOVERSION 1)
 
 # Feel free to edit as appropriate the "target_link_libraries".
 #
@@ -40,7 +51,7 @@ install(TARGETS openfec DESTINATION ${CMAKE_INSTALL_FULL_LIBDIR})
 install(
     DIRECTORY ${PROJECT_SOURCE_DIR}/src/
     DESTINATION ${CMAKE_INSTALL_FULL_INCLUDEDIR}/openfec
-    FILES_MATCHING PATTERN "*.h*")
+    FILES_MATCHING PATTERN "*.h")
 
 include(TestBigEndian)
 test_big_endian(BIG_ENDIAN)

src/lib_advanced/ldpc_from_file/of_codec_profile.h

@@ -33,7 +33,7 @@
 
 /****** GENERAL SETUP OPTIONS; EDIT AS APPROPRIATE ****************************/
 
-#define OF_USE_LDPC_FROM_FILE_CODEC
+#include "../../lib_common/of_build_config.h"
 
 #define READ_MATRIX_FILE
 

src/lib_common/of_build_config.h.in

@@ -0,0 +1,101 @@
+/*
+ * OpenFEC.org AL-FEC Library.
+ * (c) Copyright 2009 - 2012 INRIA - All rights reserved
+ * (c) Copyright 2024 Roc Streaming authors
+ *
+ * This software is governed by the CeCILL-C license under French law and
+ * abiding by the rules of distribution of free software.  You can  use,
+ * modify and/ or redistribute the software under the terms of the CeCILL-C
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and  rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty  and the software's author,  the holder of the
+ * economic rights,  and the successive licensors  have only  limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading,  using,  modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean  that it is complicated to manipulate,  and  that  also
+ * therefore means  that it is reserved for developers  and  experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and,  more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL-C license and that you accept its terms.
+ */
+
+#ifndef OF_BUILD_CONFIG_H
+#define OF_BUILD_CONFIG_H
+
+/*
+ * Here we enable or disable encoder and decoder support.
+ */
+#define OF_USE_ENCODER
+#define OF_USE_DECODER
+
+/*
+ * Here we enable or disable certain codecs (a.k.a. FEC schemes).
+ *
+ * By default most codecs are enabled.
+ *
+ * Disabling codecs prevents the compiler to read associated code
+ * during compilation.
+ *
+ * Removing codecs known to be useless can be important for highly
+ * specialized usage of OpenFEC, like embedded systems.
+ *
+ * Removing codecs may be also needed due to licensing issues.
+ */
+#cmakedefine OF_USE_REED_SOLOMON_CODEC
+#cmakedefine OF_USE_REED_SOLOMON_2_M_CODEC
+#cmakedefine OF_USE_LDPC_STAIRCASE_CODEC
+#cmakedefine OF_USE_2D_PARITY_MATRIX_CODEC
+#cmakedefine OF_USE_LDPC_FROM_FILE_CODEC
+
+/*
+ * Here we enable or disable certain solving systems.
+ *
+ * By default all systems are considered.
+ *
+ * Note that the above codecs require certain solving systems.
+ * For instance, LDPC-staircase requires IT decoding, and ML
+ * decoding is highly recommended for improved performances.
+ *
+ * Removing solving systems known to be useless can be important
+ * for highly specialized usage of OpenFEC, like embedded systems.
+ */
+#define OF_USE_LINEAR_BINARY_CODES_UTILS
+#define OF_USE_GALOIS_FIELD_CODES_UTILS
+
+/*
+ * Define if you want to enable the use of the ML (Maximum Likelyhood) decoding.
+ * If enabled, in practice decoding will start with IT decoding and end with ML
+ * decoding (in this case a Gaussian Elimination) if needed.
+ *
+ * Warning: ML decoding enables to reach the best erasure recovery capabilities,
+ * at the expense of potentially significant computation loads, depending on
+ * the size and complexity of the simplified system at the end of IT decoding.
+ *
+ * See the MAX_NB_SOURCE_SYMBOLS_DEFAULT/MAX_NB_ENCODING_SYMBOLS_DEFAULT
+ * constants that enable to limit the computation overheads.
+ */
+#define ML_DECODING
+
+/*
+ * Define if you need SSE optimizations for XOR operations.
+ * This is useful for PC usage, with processors that support this
+ * extension (i.e. all the processors except the very old ones).
+ *
+ * NB: if SSE is not defined, then we'll use regular XOR operations,
+ * either on 32 bit or 64 bit integers depending on the operating
+ * system.
+ */
+#cmakedefine ASSEMBLY_SSE_OPT
+
+#endif // OF_BUILD_CONFIG_H