added support for safmex on Apple using new LP64 version

Author: jananifernandez

CMakeLists.txt

@@ -20,7 +20,7 @@ if(NOT DEFINED SAF_PERFORMANCE_LIB AND NOT APPLE)
     message(FATAL_ERROR "You must define the SAF_PERFORMANCE_LIB environment variable")
 endif()
 if(NOT DEFINED SAF_PERFORMANCE_LIB AND APPLE)
-    set(SAF_PERFORMANCE_LIB "SAF_USE_APPLE_ACCELERATE")
+    set(SAF_PERFORMANCE_LIB "SAF_USE_APPLE_ACCELERATE_LP64")
 endif()
 #message(STATUS "PERFORMANCE LIB is ${SAF_PERFORMANCE_LIB}")
 if (NOT CMAKE_BUILD_TYPE OR CMAKE_BUILD_TYPE STREQUAL "")
@@ -47,8 +47,10 @@ if(MSVC)
     set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} /MP")
 elseif(APPLE)
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -stdlib=libc++") 
+    message(STATUS "Targeting both arm64 and x86_64.")
     set(CMAKE_OSX_ARCHITECTURES "arm64;x86_64")
-    set(CMAKE_OSX_DEPLOYMENT_TARGET "11.0")
+    message(STATUS "Targeting MacOS 12.0.")
+    set(CMAKE_OSX_DEPLOYMENT_TARGET "12.0")
 elseif(UNIX AND NOT APPLE AND NOT ANDROID)
     add_definitions(
         #-std=c++11

ChangeLog.txt

@@ -9,7 +9,18 @@ Major and/or breaking changes to the Spatial_Audio_Framework are listed here.
 For descriptions of minor changes and bug fixes, please refer to the git log.
 
 ====================================================================================================
-v1.3.4
+v1.3.5 (5th June 2025)
+ - Added the ability to select either the LP64 or ILP64 version of Apple Accelerate as the 
+   performance  library
+ - safmex (via SAF_BUILD_EXTRAS) now supports Apple Accelerate
+
+Breaking changes:
+
+The old flag "SAF_USE_APPLE_ACCELERATE" (which was always LP64), should be replaced with 
+"SAF_USE_APPLE_ACCELERATE_LP64" or "SAF_USE_APPLE_ACCELERATE_ILP64".
+
+====================================================================================================
+v1.3.4 (4th October 2025)
  - Added atomics support for the SAF examples (GCC and Clang) 
  - Updated saf_sofa_reader module with latest libmysofa version
  - Fixed memory leak in qmf and decor

README.md

@@ -23,12 +23,13 @@ The framework requires the following external libraries:
 
 In order to inform SAF which CBLAS/LAPACK supporting library/libraries you have linked to your project, simply add **one** of the following global pre-processor definitions:
 ```
-SAF_USE_INTEL_MKL_LP64        # great option, but only for x86 architectures (using the LP64 config [int32])
-SAF_USE_INTEL_MKL_ILP64       # great option, but only for x86 architectures (using the ILP64 config [int64])
-SAF_USE_OPEN_BLAS_AND_LAPACKE # good option, works on everything
-SAF_USE_APPLE_ACCELERATE      # good option (x86 and ARM), faster than OpenBLAS, but MacOSX only & slower than MKL
-SAF_USE_ATLAS                 # bad option (x86 and ARM), many LAPACK functions are missing
-SAF_USE...                    # please get in touch if you use something else! :-)
+SAF_USE_INTEL_MKL_LP64         # great option, but only for x86 architectures (using the LP64 config [int32])
+SAF_USE_INTEL_MKL_ILP64        # great option, but only for x86 architectures (using the ILP64 config [int64])
+SAF_USE_APPLE_ACCELERATE_LP64  # great option (x86 and ARM), but MacOSX only (using the LP64 config [int32])
+SAF_USE_APPLE_ACCELERATE_ILP64 # great option (x86 and ARM), but MacOSX only (using the ILP64 config [int64])
+SAF_USE_OPEN_BLAS_AND_LAPACKE  # good option, works on everything
+SAF_USE_ATLAS                  # bad option (x86 and ARM), many LAPACK functions are missing
+SAF_USE...                     # please get in touch if you use something else! :-)
 ```
 [Detailed instructions regarding how to build and link these libraries can be found here](docs/PERFORMANCE_LIBRARY_INSTRUCTIONS.md).
 

docs/FRAMEWORK_STRUCTURE.md

@@ -58,21 +58,14 @@ For more details, refer to: [**PERFORMANCE_LIBRARY_INSTRUCTIONS.md**](PERFORMANC
 
 In order to use the optional built-in [SOFA](https://www.sofaconventions.org/mediawiki/index.php/SOFA_(Spatially_Oriented_Format_for_Acoustics)) reader module (**saf_sofa_reader**), your project must also link against the [netCDF](https://www.unidata.ucar.edu/software/netcdf/) library (including its dependencies). 
 
-For more details, refer to: [**SOFA_READER_MODULE_DEPENDENCIES.md**](SOFA_READER_MODULE_DEPENDENCIES.md)
-
 Optionally, Intel's [Integrated Performance Primitives (IPP)](https://software.intel.com/content/www/us/en/develop/tools/integrated-performance-primitives.html) may be employed for the FFT with the following definition:
 ```
 SAF_USE_INTEL_IPP            
 ```
 
 ## Contributing
 
-Contributions are very much welcomed and encouraged. Please feel free to make suggestions, pull-requests, or get in touch (via leo.mccormack(at)aalto.fi or github "issues") if you would like to discuss additions to the framework. These additions can come in many forms; including:
-* bug fixes or optimisations to existing code
-* adding new functionality (which falls under the scope of an existing module) to an existing module
-* adding a new utility to the **saf_utilities** module or an entirely new module (see below)
-* using the framework to create new **examples**, **extras**, or unit tests
-* documentation improvements
+Contributions are very much welcomed and encouraged. Please feel free to make suggestions, pull-requests, or get in touch (via a GitHub "issue") if you would like to discuss additions to the framework.
 
 ## Module structure
 
@@ -170,4 +163,4 @@ Note: your module can only be added as a **core** module if it is free from larg
 
 All core modules must be released under the [ISC License](https://choosealicense.com/licenses/isc/) and only use third-party code that is provided under similar permissive licensing terms (ISC, MIT, BSD etc.). 
 
-Optional modules may be released under alternative licenses. If you would prefer (or are required) to release your module under a copyleft license, then you may do so. For example, the **saf_tracker** module is provided under the terms of the copyleft [GNU GPLv2 License](https://choosealicense.com/licenses/gpl-2.0/). However, please discuss with us if you wish to use a license other than ISC or GPLv2.
+Optional modules may be released under alternative licenses. If you would prefer (or are required) to release your module under a copyleft license, then you may do so. For example, the **saf_tracker** module is provided under the terms of the copyleft [GNU GPLv2 License](https://choosealicense.com/licenses/gpl-2.0/). 

docs/PERFORMANCE_LIBRARY_INSTRUCTIONS.md

@@ -5,12 +5,13 @@ The Spatial_Audio_Framework (SAF) requires any library (or combination of librar
 Currently, SAF supports [Intel MKL](https://software.intel.com/en-us/articles/free-ipsxe-tools-and-libraries), [OpenBLAS](https://github.com/xianyi/OpenBLAS), [Apple Accelerate](https://developer.apple.com/documentation/accelerate), and [ATLAS](http://math-atlas.sourceforge.net/). You may select which option you wish to use by adding one of the following pre-processor definitions:
 
 ```
-SAF_USE_INTEL_MKL_LP64        # great option, but only for x86 architectures (using the LP64 config [int32])
-SAF_USE_INTEL_MKL_ILP64       # great option, but only for x86 architectures (using the ILP64 config [int64])  
-SAF_USE_OPEN_BLAS_AND_LAPACKE # good option, works on everything
-SAF_USE_APPLE_ACCELERATE      # good option (x86 and ARM), faster than OpenBLAS, but MacOSX only & slower than MKL
-SAF_USE_ATLAS                 # bad option (x86 and ARM), many LAPACK functions are missing
-SAF_USE...                    # please get in touch if you use something else! :-)
+SAF_USE_INTEL_MKL_LP64         # great option, but only for x86 architectures (using the LP64 config [int32])
+SAF_USE_INTEL_MKL_ILP64        # great option, but only for x86 architectures (using the ILP64 config [int64])
+SAF_USE_APPLE_ACCELERATE_LP64  # great option (x86 and ARM), but MacOSX only (using the LP64 config [int32])
+SAF_USE_APPLE_ACCELERATE_ILP64 # great option (x86 and ARM), but MacOSX only (using the ILP64 config [int64])
+SAF_USE_OPEN_BLAS_AND_LAPACKE  # good option, works on everything
+SAF_USE_ATLAS                  # bad option (x86 and ARM), many LAPACK functions are missing
+SAF_USE...                     # please get in touch if you use something else! :-)
 ```
 
 ## SAF_USE_INTEL_MKL_LP64 or SAF_USE_INTEL_MKL_ILP64
@@ -139,12 +140,14 @@ cmake .. -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=0 -DBUILD_WITHOUT_LAPACK
 make 
 ```
 
-## SAF_USE_APPLE_ACCELERATE
+## SAF_USE_APPLE_ACCELERATE_LP64 or SAF_USE_APPLE_ACCELERATE_ILP64
 
 Only for MacOSX users. Simply link against the [**Accelerate**](https://developer.apple.com/documentation/accelerate) framework and you're good to go. 
 
 Note that Accelerate also includes an optimised DFT/FFT implementation and a number of additional vectorised utility functions which SAF is also able to make use of. 
 
+Adding ACCELERATE_NEW_LAPACK (supported in MacOS 13.3 or newer) is optional for SAF_USE_APPLE_ACCELERATE_LP64.
+However, both ACCELERATE_NEW_LAPACK and ACCELERATE_LAPACK_ILP64 are required for SAF_USE_APPLE_ACCELERATE_ILP64.
 
 ## SAF_USE_ATLAS
 

examples/src/ambi_bin/ambi_bin.c

@@ -487,9 +487,9 @@ void ambi_bin_process
                 /* Bake the rotation into the decoding matrix */
                 for(band = 0; band < HYBRID_BANDS; band++) {
                     cblas_cgemm(CblasRowMajor, CblasNoTrans, CblasNoTrans, NUM_EARS, nSH, nSH, &calpha,
-                                pars->M_dec[band], MAX_NUM_SH_SIGNALS,
-                                pData->M_rot, MAX_NUM_SH_SIGNALS, &cbeta,
-                                pars->M_dec_rot[band], MAX_NUM_SH_SIGNALS);
+                                (float_complex*)pars->M_dec[band], MAX_NUM_SH_SIGNALS,
+                                (float_complex*)pData->M_rot, MAX_NUM_SH_SIGNALS, &cbeta,
+                                (float_complex*)pars->M_dec_rot[band], MAX_NUM_SH_SIGNALS);
                 }
                 pData->recalc_M_rotFLAG = 0;
             }
@@ -498,7 +498,7 @@ void ambi_bin_process
         /* Apply the decoder to go from SH input to binaural output */
         for(band = 0; band < HYBRID_BANDS; band++) {
             cblas_cgemm(CblasRowMajor, CblasNoTrans, CblasNoTrans, NUM_EARS, TIME_SLOTS, nSH, &calpha,
-                        enableRot ? pars->M_dec_rot[band] : pars->M_dec[band], MAX_NUM_SH_SIGNALS,
+                        enableRot ? (float_complex*)pars->M_dec_rot[band] : (float_complex*)pars->M_dec[band], MAX_NUM_SH_SIGNALS,
                         FLATTEN2D(pData->SHframeTF[band]), TIME_SLOTS, &cbeta,
                         FLATTEN2D(pData->binframeTF[band]), TIME_SLOTS);
         }

examples/src/array2sh/array2sh.c

@@ -240,7 +240,7 @@ void array2sh_process
         /* Apply spherical harmonic transform (SHT) */
         for(band=0; band<HYBRID_BANDS; band++){
             cblas_cgemm(CblasRowMajor, CblasNoTrans, CblasNoTrans, nSH, TIME_SLOTS, Q, &calpha,
-                        pData->W[band], MAX_NUM_SENSORS,
+                        (float_complex*)pData->W[band], MAX_NUM_SENSORS,
                         FLATTEN2D(pData->inputframeTF[band]), TIME_SLOTS, &cbeta,
                         FLATTEN2D(pData->SHframeTF[band]), TIME_SLOTS);
         }

examples/src/array2sh/array2sh_internal.c

@@ -353,7 +353,7 @@ void array2sh_calculate_sht_matrix
             cblas_cgemm(CblasRowMajor, CblasNoTrans, CblasTrans, nSH, (arraySpecs->Q), nSH, &calpha,
                         diag_bN_inv_R, nSH,
                         pinv_Y_mic_cmplx, nSH, &cbeta,
-                        pData->W[band], MAX_NUM_SENSORS);
+                        (float_complex*)pData->W[band], MAX_NUM_SENSORS);
         }
         free(diag_bN_inv_R);
     }
@@ -509,7 +509,7 @@ void array2sh_calculate_sht_matrix
             cblas_cgemm(CblasRowMajor, CblasNoTrans, CblasTrans, nSH, (arraySpecs->Q), nSH, &calpha,
                         diag_bN_inv_R, nSH,
                         pinv_Y_mic_cmplx, nSH, &cbeta,
-                        pData->W[band], MAX_NUM_SENSORS);
+                        (float_complex*)pData->W[band], MAX_NUM_SENSORS);
         }
         free(diag_bN_inv_R);
     }

examples/src/panner/panner.c

@@ -267,9 +267,9 @@ void panner_process
             /* apply panning gains */
             for (band = 0; band < HYBRID_BANDS; band++) {
                 cblas_cgemm(CblasRowMajor, CblasTrans, CblasNoTrans, nLoudspeakers, TIME_SLOTS, nSources, &calpha,
-                    pData->G_src[band], MAX_NUM_OUTPUTS,
-                    FLATTEN2D(pData->inputframeTF[band]), TIME_SLOTS, &cbeta,
-                    outputTemp, TIME_SLOTS);
+                            (float_complex*)pData->G_src[band], MAX_NUM_OUTPUTS,
+                            FLATTEN2D(pData->inputframeTF[band]), TIME_SLOTS, &cbeta,
+                            (float_complex*)outputTemp, TIME_SLOTS);
                 for (i = 0; i < nLoudspeakers; i++)
                     for (t = 0; t < TIME_SLOTS; t++)
                         pData->outputframeTF[band][i][t] = ccaddf(pData->outputframeTF[band][i][t], outputTemp[i][t]);

examples/src/sldoa/sldoa_internal.c

@@ -177,7 +177,7 @@ void sldoa_estimateDoA
             cblas_cgemm(CblasRowMajor, CblasNoTrans, CblasNoTrans, 4, TIME_SLOTS, nSH, &calpha,
                         sec_c, nSH,
                         FLATTEN2D(SHframeTF), TIME_SLOTS, &cbeta,
-                        secSig, TIME_SLOTS);
+                        (float_complex*)secSig, TIME_SLOTS);
         }
 
         /* convert N3D to SN3D */