saf.h

Go to the documentation of this file.

/*
 * Copyright 2018-2021 Leo McCormack
 *
 * This software is dual-licensed.
 *
 * ISC License ( https://choosealicense.com/licenses/isc/ ):
 *   By default, this software is governed permissively under the terms of the
 *   ISC license; since all of the core (non-optional) modules are licensed as
 *   such. Also note that all third-party code, which has been adapted or
 *   adopted by the core modules, is also provided under similar permissive
 *   licensing terms (MIT, BSD, WOL, etc.). The specific license employed by
 *   each third-party code is stated clearly in the code comments at the point
 *   of its inclusion, and also in the "dependencies/third-party-licenses"
 *   folder.
 *
 * GNU GPLv2 License ( https://choosealicense.com/licenses/gpl-2.0/ ):
 *   Including and enabling certain optional modules, which are instead provided
 *   under the copy-left GNU GPLv2 license, will mean that the use of this
 *   software is instead governed by the GNU GPLv2 licencing terms.
 *
 * Note that the license employed by each module is stated clearly below. For
 * more information, refer to the license terms found at the top of each source
 * and header file.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 */
 
#ifndef SAF_H_INCLUDED
#define SAF_H_INCLUDED
 
/*  doxygen module definitions: */
/* ========================================================================== */
/*                                SAF License                                 */
/* ========================================================================== */
 
/* The license governing SAF is configuration dependent */
#if defined(SAF_ENABLE_TRACKER_MODULE) || defined(SAF_ENABLE_HADES_MODULE)
# define SAF_LICENSE_STRING "GNU GPLv2"
#else
# define SAF_LICENSE_STRING "ISC"
#endif
 
 
/* ========================================================================== */
/*                                SAF Version                                 */
/* ========================================================================== */
/* Note that this version info is also scanned and employed by CMakeLists.txt */
 
#define SAF_VERSION_MAJOR 1        
#define SAF_VERSION_MINOR 3        
#define SAF_VERSION_PATCH 2        
#define SAF_VERSION_SPECIAL ""     
#define MKSTRING_(s) #s            
#define MKSTRING(s) MKSTRING_(s)   
#define SAF_VERSION ((SAF_VERSION_MAJOR << 16) + (SAF_VERSION_MINOR << 8) + \
                    SAF_VERSION_PATCH)
 
#define SAF_VERSION_STRING MKSTRING(SAF_VERSION_MAJOR) "." MKSTRING( \
                           SAF_VERSION_MINOR) "." MKSTRING(SAF_VERSION_PATCH) \
                           "" SAF_VERSION_SPECIAL
 
#define SAF_VERSION_LICENSE_STRING "SAF Version: " SAF_VERSION_STRING \
                                   ", License: "   SAF_LICENSE_STRING "\n"
 
#define SAF_VERSION_BANNER \
  "     _____     _____     _____                                         \n" \
  "   (  ____ ) (  ___  ) (  ____ )                                       \n" \
  "   | ( __ |/ | ( _ ) | | ( _  |/                                       \n" \
  "   (_____  ) |  ___  | |  __)                                          \n" \
  "   /|____) | | |   | | | |                                             \n" \
  "   (_______) |_|   |_| |_|   (Version: " SAF_VERSION_STRING ", License:"   \
  " " SAF_LICENSE_STRING ")                                               \n"
 
 
/* ========================================================================== */
/*                                Core Modules                                */
/* ========================================================================== */
 
#define SAF_UTILITIES_MODULE
#include "../modules/saf_utilities/saf_utilities.h"
 
#define SAF_CDF4SAP_MODULE
#include "../modules/saf_cdf4sap/saf_cdf4sap.h"
 
#define SAF_HOA_MODULE
#include "../modules/saf_hoa/saf_hoa.h"
 
#define SAF_HRIR_MODULE
#include "../modules/saf_hrir/saf_hrir.h"
 
#define SAF_REVERB_MODULE
#include "../modules/saf_reverb/saf_reverb.h"
 
#define SAF_SH_MODULE
#include "../modules/saf_sh/saf_sh.h"
 
#define SAF_VBAP_MODULE
#include "../modules/saf_vbap/saf_vbap.h"
 
 
/* ========================================================================== */
/*                              Optional Modules                              */
/* ========================================================================== */
 
#ifdef SAF_ENABLE_SOFA_READER_MODULE
# define SAF_SOFA_READER_MODULE
# include "../modules/saf_sofa_reader/saf_sofa_reader.h"
#endif /* SAF_ENABLE_SOFA_READER_MODULE */
 
#ifdef SAF_ENABLE_TRACKER_MODULE
# define SAF_TRACKER_MODULE
# include "../modules/saf_tracker/saf_tracker.h"
#endif /* SAF_ENABLE_TRACKER_MODULE */
 
#ifdef SAF_ENABLE_HADES_MODULE
# define SAF_HADES_MODULE
# include "../modules/saf_hades/saf_hades.h"
#endif /* SAF_ENABLE_HADES_MODULE */
 
 
#endif /* SAF_H_INCLUDED */