Replace config.h with SpatialaudioConfig.h

This new file has properly prefixed defines preventing name
clashes with macros defined in library consumer build systems.

Additionally a new define is added that hints if the library was built
statically, needed to properly disable API imports in that case,
on Windows.

Author: ePirat

CMakeLists.txt

@@ -17,7 +17,6 @@ set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake/Modules/")
 
 # Dependencies
 find_package(MySofa QUIET)
-set(HAVE_MYSOFA ${MYSOFA_FOUND})
 
 # Spatialaudio library
 add_library(spatialaudio)
@@ -130,9 +129,28 @@ target_sources(spatialaudio
             include/SpatialaudioAPI.h
 )
 
+# Generate config header
+set(SPATIALAUDIO_SUPPORTS_SOFA ${MYSOFA_FOUND})
+set(SPATIALAUDIO_SUPPORTS_MIT_HRTF ${HAVE_MIT_HRTF})
+set(SPATIALAUDIO_STATIC $<STREQUAL:$<TARGET_PROPERTY,spatialaudio:TYPE>,STATIC_LIBRARY>)
+
+configure_file(
+    "include/SpatialaudioConfig.h.in"
+    "include/SpatialaudioConfig.h"
+)
+
+target_sources(spatialaudio
+    PUBLIC
+        FILE_SET generated_headers
+        TYPE HEADERS
+        BASE_DIRS $<TARGET_PROPERTY:BINARY_DIR>/include
+        FILES
+            $<TARGET_PROPERTY:BINARY_DIR>/include/SpatialaudioConfig.h
+)
+
 target_include_directories(spatialaudio
     PRIVATE
-        ${CMAKE_CURRENT_BINARY_DIR}
+        $<TARGET_PROPERTY:BINARY_DIR>/include
 )
 target_compile_definitions(spatialaudio
     PRIVATE
@@ -148,11 +166,6 @@ if(MYSOFA_FOUND)
     target_link_libraries(spatialaudio ${MYSOFA_LIBRARIES})
 endif(MYSOFA_FOUND)
 
-configure_file(
-    "${CMAKE_CURRENT_SOURCE_DIR}/include/config.h.in"
-    "${CMAKE_CURRENT_BINARY_DIR}/config.h"
-)
-
 configure_file(
     "${CMAKE_CURRENT_SOURCE_DIR}/cmake/spatialaudio.pc.cmake"
     "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.pc"
@@ -164,6 +177,8 @@ install(TARGETS spatialaudio
     ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
     FILE_SET HEADERS
         DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/spatialaudio
+    FILE_SET generated_headers
+        DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/spatialaudio
 )
 install(FILES "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.pc"
     DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig)

Changelog.md

@@ -61,3 +61,5 @@
 - CMake: Removed the `BUILD_STATIC_LIBS` option. Use the `BUILD_SHARED_LIBS`
   option to control if share or static libraries should be built. If both are
   needed, build twice explicitly.
+- The `config.h` header file was removed in favor of `SpatialaudioConfig.h` with
+  properly prefixed defines to prevent name clashes.

include/SpatialaudioAPI.h

@@ -10,6 +10,8 @@
 #ifndef SPATIALAUDIO_API_H
 #define SPATIALAUDIO_API_H
 
+#include "SpatialaudioConfig.h"
+
 #if defined(__GNUC__) && (__GNUC__ >= 4)
 // GCC/Clang symbol visibility
 # define SPATIALAUDIO_EXPORT __attribute__((__visibility__("default")))

include/SpatialaudioConfig.h.in

@@ -0,0 +1,30 @@
+/*############################################################################*/
+/*#                                                                          #*/
+/*#  Config information about the libspatialaudio build                      #*/
+/*#                                                                          #*/
+/*#  Author(s):     Marvin Scholz                                            #*/
+/*#  Licence:       LGPL + proprietary                                       #*/
+/*#                                                                          #*/
+/*############################################################################*/
+
+#ifndef SPATIALAUDIO_CONFIG_H
+#define SPATIALAUDIO_CONFIG_H
+
+// True if libspatialaudio was built with libmysofa support
+#cmakedefine01 SPATIALAUDIO_SUPPORTS_SOFA
+
+// True if libspatialaudio was built with the integrated MIT HRTF
+#cmakedefine01 SPATIALAUDIO_SUPPORTS_MIT_HRTF
+
+// Defined if libspatialaudio was built statically
+//
+// This is merely a hint, as both the shared and
+// static library could be built, in which case this
+// would be unset and is expected to be set correctly
+// by library consumers as only there it can be known
+// against which library is linked.
+#ifndef SPATIALAUDIO_STATIC
+#cmakedefine SPATIALAUDIO_STATIC
+#endif
+
+#endif /* SPATIALAUDIO_CONFIG_H */

include/config.h.in

@@ -1,9 +1,11 @@
 #ifndef MIT_HRTF_H
 #define MIT_HRTF_H
 
-#include "hrtf.h"
+#include "SpatialaudioConfig.h"
+
+#if SPATIALAUDIO_SUPPORTS_MIT_HRTF
 
-#ifdef HAVE_MIT_HRTF
+#include "hrtf.h"
 
 namespace spaudio {
 

include/hrtf/mit_hrtf.h

@@ -1,9 +1,9 @@
 #ifndef SOFA_HRTF_H
 #define SOFA_HRTF_H
 
-#include "config.h"
+#include "SpatialaudioConfig.h"
 
-#ifdef HAVE_MYSOFA
+#if SPATIALAUDIO_SUPPORTS_SOFA
 
 #include <string>
 

include/hrtf/sofa_hrtf.h

@@ -1,6 +1,8 @@
 config_h = configure_file(
-    output : 'config.h',
-    configuration : conf_data
+    input : 'SpatialaudioConfig.h.in',
+    output : 'SpatialaudioConfig.h',
+    configuration : conf_data,
+    format :  'cmake',
 )
 
 # Public header files that are installed

include/meson.build

@@ -15,15 +15,19 @@ conf_data = configuration_data()
 
 libmysofa_dep = dependency('libmysofa', required : get_option('libmysofa'))
 if libmysofa_dep.found()
-    conf_data.set('HAVE_MYSOFA', 1)
+    conf_data.set('SPATIALAUDIO_SUPPORTS_SOFA', 1)
     dependencies += libmysofa_dep
 endif
 
 if get_option('mit_hrtf').allowed()
-    conf_data.set('HAVE_MIT_HRTF', 1)
+    conf_data.set('SPATIALAUDIO_SUPPORTS_MIT_HRTF', 1)
     add_languages('c', native: false)
 endif
 
+if get_option('default_library') == 'static'
+    conf_data.set('SPATIALAUDIO_STATIC', 1)
+endif
+
 subdir('include')
 subdir('source')
 

meson.build

@@ -14,7 +14,7 @@
 /*############################################################################*/
 
 
-#include "config.h"
+#include "SpatialaudioConfig.h"
 
 #include <iostream>
 
@@ -385,15 +385,15 @@ namespace spaudio {
     {
         HRTF* p_hrtf;
 
-#ifdef HAVE_MYSOFA
-# ifdef HAVE_MIT_HRTF
+#if SPATIALAUDIO_SUPPORTS_SOFA
+# if SPATIALAUDIO_SUPPORTS_MIT_HRTF
         if (HRTFPath == "")
             p_hrtf = new MIT_HRTF(nSampleRate);
         else
 # endif
             p_hrtf = new SOFA_HRTF(HRTFPath, nSampleRate);
 #else
-# ifdef HAVE_MIT_HRTF
+# if SPATIALAUDIO_SUPPORTS_MIT_HRTF
         p_hrtf = new MIT_HRTF(nSampleRate);
         (void)HRTFPath;
 # else