_common.h

Go to the documentation of this file.

/*
 * Copyright 2020 Leo McCormack
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * 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 __COMMON_H_INCLUDED__
#define __COMMON_H_INCLUDED__
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 201112L) && !defined(__STDC_NO_ATOMICS__)
  #include <stdatomic.h>
#endif
 
/* ========================================================================== */
/*                             Presets + Constants                            */
/* ========================================================================== */

typedef enum {
    SH_ORDER_FIRST = 1, 
    SH_ORDER_SECOND,    
    SH_ORDER_THIRD,     
    SH_ORDER_FOURTH,    
    SH_ORDER_FIFTH,     
    SH_ORDER_SIXTH,     
    SH_ORDER_SEVENTH,   
    SH_ORDER_EIGHTH,    
    SH_ORDER_NINTH,     
    SH_ORDER_TENTH      
} SH_ORDERS;
    
#define MAX_SH_ORDER ( 10 )
    
typedef enum {
    CH_ACN = 1, 
    CH_FUMA     
    
} CH_ORDER;
    
#define NUM_CH_ORDERINGS ( 2 )

typedef enum {
    NORM_N3D = 1,   
    NORM_SN3D,      
    NORM_FUMA       
    
} NORM_TYPES;
 
#define NUM_NORM_TYPES ( 3 )

typedef enum {
    MIC_PRESET_IDEAL = 1,
    MIC_PRESET_ZYLIA,
    MIC_PRESET_EIGENMIKE32,
    MIC_PRESET_DTU_MIC
 
}MIC_PRESETS;

typedef enum {
    LOUDSPEAKER_ARRAY_PRESET_DEFAULT = 1,
    LOUDSPEAKER_ARRAY_PRESET_STEREO,
    LOUDSPEAKER_ARRAY_PRESET_5PX,
    LOUDSPEAKER_ARRAY_PRESET_7PX,
    LOUDSPEAKER_ARRAY_PRESET_8PX,
    LOUDSPEAKER_ARRAY_PRESET_9PX,
    LOUDSPEAKER_ARRAY_PRESET_10PX,
    LOUDSPEAKER_ARRAY_PRESET_11PX,
    LOUDSPEAKER_ARRAY_PRESET_11PX_7_4,
    LOUDSPEAKER_ARRAY_PRESET_13PX,
    LOUDSPEAKER_ARRAY_PRESET_22PX,
    LOUDSPEAKER_ARRAY_PRESET_22P2_9_10_3,
    LOUDSPEAKER_ARRAY_PRESET_PROTOOLS_STEREO,
    LOUDSPEAKER_ARRAY_PRESET_PROTOOLS_LCR,
    LOUDSPEAKER_ARRAY_PRESET_PROTOOLS_QUAD,
    LOUDSPEAKER_ARRAY_PRESET_PROTOOLS_5_0,
    LOUDSPEAKER_ARRAY_PRESET_PROTOOLS_5_0_2,
    LOUDSPEAKER_ARRAY_PRESET_PROTOOLS_5_0_4,
    LOUDSPEAKER_ARRAY_PRESET_PROTOOLS_7_0,
    LOUDSPEAKER_ARRAY_PRESET_PROTOOLS_7_0_2,
    LOUDSPEAKER_ARRAY_PRESET_PROTOOLS_7_0_4,
    LOUDSPEAKER_ARRAY_PRESET_PROTOOLS_7_0_6,
    LOUDSPEAKER_ARRAY_PRESET_PROTOOLS_9_0_4,
    LOUDSPEAKER_ARRAY_PRESET_PROTOOLS_9_0_6,
    LOUDSPEAKER_ARRAY_PRESET_AALTO_MCC,
    LOUDSPEAKER_ARRAY_PRESET_AALTO_MCC_SUBSET,
    LOUDSPEAKER_ARRAY_PRESET_AALTO_APAJA,
    LOUDSPEAKER_ARRAY_PRESET_AALTO_LR,
    LOUDSPEAKER_ARRAY_PRESET_DTU_AVIL,
    LOUDSPEAKER_ARRAY_PRESET_ZYLIA_LAB,
    LOUDSPEAKER_ARRAY_PRESET_T_DESIGN_4,
    LOUDSPEAKER_ARRAY_PRESET_T_DESIGN_12,
    LOUDSPEAKER_ARRAY_PRESET_T_DESIGN_24,
    LOUDSPEAKER_ARRAY_PRESET_T_DESIGN_36,
    LOUDSPEAKER_ARRAY_PRESET_T_DESIGN_48,
    LOUDSPEAKER_ARRAY_PRESET_T_DESIGN_60,
    LOUDSPEAKER_ARRAY_PRESET_SPH_COV_9,
    LOUDSPEAKER_ARRAY_PRESET_SPH_COV_16,
    LOUDSPEAKER_ARRAY_PRESET_SPH_COV_25,
    LOUDSPEAKER_ARRAY_PRESET_SPH_COV_49,
    LOUDSPEAKER_ARRAY_PRESET_SPH_COV_64
 
}LOUDSPEAKER_ARRAY_PRESETS;

typedef enum {
    SOURCE_CONFIG_PRESET_DEFAULT = 1,
    SOURCE_CONFIG_PRESET_MONO,
    SOURCE_CONFIG_PRESET_STEREO,
    SOURCE_CONFIG_PRESET_5PX,
    SOURCE_CONFIG_PRESET_7PX,
    SOURCE_CONFIG_PRESET_8PX,
    SOURCE_CONFIG_PRESET_9PX,
    SOURCE_CONFIG_PRESET_10PX,
    SOURCE_CONFIG_PRESET_11PX,
    SOURCE_CONFIG_PRESET_11PX_7_4,
    SOURCE_CONFIG_PRESET_13PX,
    SOURCE_CONFIG_PRESET_22PX,
    SOURCE_CONFIG_PRESET_22P2_9_10_3,
    SOURCE_CONFIG_PRESET_PROTOOLS_STEREO,
    SOURCE_CONFIG_PRESET_PROTOOLS_LCR,
    SOURCE_CONFIG_PRESET_PROTOOLS_QUAD,
    SOURCE_CONFIG_PRESET_PROTOOLS_5_0,
    SOURCE_CONFIG_PRESET_PROTOOLS_5_0_2,
    SOURCE_CONFIG_PRESET_PROTOOLS_5_0_4,
    SOURCE_CONFIG_PRESET_PROTOOLS_7_0,
    SOURCE_CONFIG_PRESET_PROTOOLS_7_0_2,
    SOURCE_CONFIG_PRESET_PROTOOLS_7_0_4,
    SOURCE_CONFIG_PRESET_PROTOOLS_7_0_6,
    SOURCE_CONFIG_PRESET_PROTOOLS_9_0_4,
    SOURCE_CONFIG_PRESET_PROTOOLS_9_0_6,
    SOURCE_CONFIG_PRESET_AALTO_MCC,
    SOURCE_CONFIG_PRESET_AALTO_MCC_SUBSET,
    SOURCE_CONFIG_PRESET_AALTO_APAJA,
    SOURCE_CONFIG_PRESET_AALTO_LR,
    SOURCE_CONFIG_PRESET_DTU_AVIL,
    SOURCE_CONFIG_PRESET_ZYLIA_LAB,
    SOURCE_CONFIG_PRESET_T_DESIGN_4,
    SOURCE_CONFIG_PRESET_T_DESIGN_12,
    SOURCE_CONFIG_PRESET_T_DESIGN_24,
    SOURCE_CONFIG_PRESET_T_DESIGN_36,
    SOURCE_CONFIG_PRESET_T_DESIGN_48,
    SOURCE_CONFIG_PRESET_T_DESIGN_60,
    SOURCE_CONFIG_PRESET_SPH_COV_9,
    SOURCE_CONFIG_PRESET_SPH_COV_16,
    SOURCE_CONFIG_PRESET_SPH_COV_25,
    SOURCE_CONFIG_PRESET_SPH_COV_49,
    SOURCE_CONFIG_PRESET_SPH_COV_64
 
}SOURCE_CONFIG_PRESETS;

typedef enum {
    STATIC_BEAM_TYPE_CARDIOID = 1,  
    STATIC_BEAM_TYPE_HYPERCARDIOID, 
    STATIC_BEAM_TYPE_MAX_EV         
 
} STATIC_BEAM_TYPES;

#define NUM_STATIC_BEAM_TYPES ( 3 )

typedef enum {
    HFOV_360 = 1, 
    HFOV_180,     
    HFOV_90,      
    HFOV_60       
 
}HFOV_OPTIONS;

typedef enum {
    ASPECT_RATIO_2_1 = 1, 
    ASPECT_RATIO_16_9,    
    ASPECT_RATIO_4_3      
 
}ASPECT_RATIO_OPTIONS;
    
typedef enum {
    CODEC_STATUS_INITIALISED = 0, 
    CODEC_STATUS_NOT_INITIALISED, 
    CODEC_STATUS_INITIALISING     
}CODEC_STATUS;

typedef enum {
    PROC_STATUS_ONGOING = 0, 
    PROC_STATUS_NOT_ONGOING  
}PROC_STATUS;

#define PROGRESSBARTEXT_CHAR_LENGTH ( 256 )

#define MAX_NUM_CHANNELS ( 128 )

#define MAX_NUM_INPUTS ( MAX_NUM_CHANNELS )

#define MAX_NUM_OUTPUTS ( MAX_NUM_CHANNELS )

#define MAX_NUM_SH_SIGNALS ( MAX_NUM_CHANNELS )
 
#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 201112L) && !defined(__STDC_NO_ATOMICS__)
  typedef _Atomic CH_ORDER                  _Atomic_CH_ORDER;
  typedef _Atomic NORM_TYPES                _Atomic_NORM_TYPES;
  typedef _Atomic SH_ORDERS                 _Atomic_SH_ORDERS;
  typedef _Atomic MIC_PRESETS               _Atomic_MIC_PRESETS;
  typedef _Atomic LOUDSPEAKER_ARRAY_PRESETS _Atomic_LOUDSPEAKER_ARRAY_PRESETS;
  typedef _Atomic SOURCE_CONFIG_PRESETS     _Atomic_SOURCE_CONFIG_PRESETS;
  typedef _Atomic STATIC_BEAM_TYPES         _Atomic_STATIC_BEAM_TYPES;
  typedef _Atomic HFOV_OPTIONS              _Atomic_HFOV_OPTIONS;
  typedef _Atomic ASPECT_RATIO_OPTIONS      _Atomic_ASPECT_RATIO_OPTIONS;
  typedef _Atomic CODEC_STATUS              _Atomic_CODEC_STATUS;
  typedef _Atomic PROC_STATUS               _Atomic_PROC_STATUS;
#else
  typedef CH_ORDER                  _Atomic_CH_ORDER;
  typedef NORM_TYPES                _Atomic_NORM_TYPES;
  typedef SH_ORDERS                 _Atomic_SH_ORDERS;
  typedef MIC_PRESETS               _Atomic_MIC_PRESETS;
  typedef LOUDSPEAKER_ARRAY_PRESETS _Atomic_LOUDSPEAKER_ARRAY_PRESETS;
  typedef SOURCE_CONFIG_PRESETS     _Atomic_SOURCE_CONFIG_PRESETS;
  typedef STATIC_BEAM_TYPES         _Atomic_STATIC_BEAM_TYPES;
  typedef HFOV_OPTIONS              _Atomic_HFOV_OPTIONS;
  typedef ASPECT_RATIO_OPTIONS      _Atomic_ASPECT_RATIO_OPTIONS;
  typedef CODEC_STATUS              _Atomic_CODEC_STATUS;
  typedef PROC_STATUS               _Atomic_PROC_STATUS;
#endif
 
 
#ifdef __cplusplus
} /* extern "C" { */
#endif /* __cplusplus */
 
#endif /* __COMMON_H_INCLUDED__ */