summaryrefslogtreecommitdiffstats
path: root/libFDK/include/common_fix.h
diff options
context:
space:
mode:
authorDave Burke <daveburke@google.com>2012-04-17 09:51:45 -0700
committerDave Burke <daveburke@google.com>2012-04-17 23:04:43 -0700
commit9bf37cc9712506b2483650c82d3c41152337ef7e (patch)
tree77db44e2bae06e3d144b255628be2b7a55c581d3 /libFDK/include/common_fix.h
parenta37315fe10ee143d6d0b28c19d41a476a23e63ea (diff)
downloadfdk-aac-9bf37cc9712506b2483650c82d3c41152337ef7e.tar.gz
fdk-aac-9bf37cc9712506b2483650c82d3c41152337ef7e.tar.bz2
fdk-aac-9bf37cc9712506b2483650c82d3c41152337ef7e.zip
Fraunhofer AAC codec.
License boilerplate update to follow. Change-Id: I2810460c11a58b6d148d84673cc031f3685e79b5
Diffstat (limited to 'libFDK/include/common_fix.h')
-rw-r--r--libFDK/include/common_fix.h324
1 files changed, 324 insertions, 0 deletions
diff --git a/libFDK/include/common_fix.h b/libFDK/include/common_fix.h
new file mode 100644
index 0000000..c5cbd8a
--- /dev/null
+++ b/libFDK/include/common_fix.h
@@ -0,0 +1,324 @@
+/*************************** Fraunhofer IIS FDK Tools **********************
+
+ (C) Copyright Fraunhofer IIS (2002)
+ All Rights Reserved
+
+ Please be advised that this software and/or program delivery is
+ Confidential Information of Fraunhofer and subject to and covered by the
+
+ Fraunhofer IIS Software Evaluation Agreement
+ between Google Inc. and Fraunhofer
+ effective and in full force since March 1, 2012.
+
+ You may use this software and/or program only under the terms and
+ conditions described in the above mentioned Fraunhofer IIS Software
+ Evaluation Agreement. Any other and/or further use requires a separate agreement.
+
+
+ $Id$
+ Author(s): M. Lohwasser, M. Gayer
+ Description: Flexible fixpoint library configuration
+
+ This software and/or program is protected by copyright law and international
+ treaties. Any reproduction or distribution of this software and/or program,
+ or any portion of it, may result in severe civil and criminal penalties, and
+ will be prosecuted to the maximum extent possible under law.
+
+******************************************************************************/
+
+#ifndef _COMMON_FIX_H
+#define _COMMON_FIX_H
+
+#include "FDK_archdef.h"
+#include "machine_type.h"
+
+/* ***** Start of former fix.h ****** */
+
+/* Configure fractional or integer arithmetic */
+ #define FIX_FRACT 0 /* Define this to "1" to use fractional arithmetic simulation in class fract instead of integer arithmetic */
+ /* 1 for debug with extra runtime overflow checking. */
+
+/* Truncate -1.0 to -1.0 + 1/(D)FRACT_FIX_SCALE */
+//#define FRACT_TRUNC_MINUSONE
+
+/* Define bit sizes of integer fixpoint fractional data types */
+#define FRACT_BITS 16 /* single precision */
+#define DFRACT_BITS 32 /* double precision */
+#define ACCU_BITS 40 /* double precision plus overflow */
+
+/* Fixpoint equivalent type fot PCM audio time domain data. */
+#if defined(SAMPLE_BITS)
+#if (SAMPLE_BITS == DFRACT_BITS)
+ #define FIXP_PCM FIXP_DBL
+ #define FX_PCM2FX_DBL(x) ((FIXP_DBL)(x))
+ #define FX_DBL2FX_PCM(x) ((INT_PCM)(x))
+#elif (SAMPLE_BITS == FRACT_BITS)
+ #define FIXP_PCM FIXP_SGL
+ #define FX_PCM2FX_DBL(x) FX_SGL2FX_DBL((FIXP_SGL)(x))
+ #define FX_DBL2FX_PCM(x) FX_DBL2FX_SGL(x)
+#else
+ #error SAMPLE_BITS different from FRACT_BITS or DFRACT_BITS not implemented!
+#endif
+#endif
+
+/* ****** End of former fix.h ****** */
+
+#define SGL_MASK ((1UL<<FRACT_BITS)-1) /* 16bit: (2^16)-1 = 0xFFFF */
+
+#define MAX_SHIFT_SGL (FRACT_BITS-1) /* maximum possible shift for FIXP_SGL values */
+#define MAX_SHIFT_DBL (DFRACT_BITS-1) /* maximum possible shift for FIXP_DBL values */
+
+/* Scale factor from/to float/fixpoint values. DO NOT USE THESE VALUES AS SATURATION LIMITS !! */
+#define FRACT_FIX_SCALE ((INT64(1)<<(FRACT_BITS-1)))
+#define DFRACT_FIX_SCALE ((INT64(1)<<(DFRACT_BITS-1)))
+
+/* Max and Min values for saturation purposes. DO NOT USE THESE VALUES AS SCALE VALUES !! */
+#define MAXVAL_SGL ((signed)0x00007FFF) /* this has to be synchronized to FRACT_BITS */
+#define MINVAL_SGL ((signed)0xFFFF8000) /* this has to be synchronized to FRACT_BITS */
+#define MAXVAL_DBL ((signed)0x7FFFFFFF) /* this has to be synchronized to DFRACT_BITS */
+#define MINVAL_DBL ((signed)0x80000000) /* this has to be synchronized to DFRACT_BITS */
+
+
+#define FX_DBL2FXCONST_SGL(val) ( ( ((((val) >> (DFRACT_BITS-FRACT_BITS-1)) + 1) > (((LONG)1<<FRACT_BITS)-1)) && ((LONG)(val) > 0) ) ? \
+ (FIXP_SGL)(SHORT)(((LONG)1<<(FRACT_BITS-1))-1):(FIXP_SGL)(SHORT)((((val) >> (DFRACT_BITS-FRACT_BITS-1)) + 1) >> 1) )
+
+
+
+#define shouldBeUnion union /* unions are possible */
+
+ typedef SHORT FIXP_SGL;
+ typedef LONG FIXP_DBL;
+
+/* macros for compile-time conversion of constant float values to fixedpoint */
+#define FL2FXCONST_SPC FL2FXCONST_DBL
+
+#ifdef FRACT_TRUNC_MINUSONE
+#define MINVAL_DBL_CONST MINVAL_DBL+1
+#define MINVAL_SGL_CONST MINVAL_SGL+1
+#else
+#define MINVAL_DBL_CONST MINVAL_DBL
+#define MINVAL_SGL_CONST MINVAL_SGL
+#endif
+
+#define FL2FXCONST_SGL(val) \
+(FIXP_SGL)( ( (val) >= 0) ? \
+((( (double)(val) * (FRACT_FIX_SCALE) + 0.5 ) >= (double)(MAXVAL_SGL) ) ? (SHORT)(MAXVAL_SGL) : (SHORT)( (double)(val) * (double)(FRACT_FIX_SCALE) + 0.5)) : \
+((( (double)(val) * (FRACT_FIX_SCALE) - 0.5) <= (double)(MINVAL_SGL_CONST) ) ? (SHORT)(MINVAL_SGL_CONST) : (SHORT)( (double)(val) * (double)(FRACT_FIX_SCALE) - 0.5)) )
+
+#define FL2FXCONST_DBL(val) \
+(FIXP_DBL)( ( (val) >= 0) ? \
+((( (double)(val) * (DFRACT_FIX_SCALE) + 0.5 ) >= (double)(MAXVAL_DBL) ) ? (LONG)(MAXVAL_DBL) : (LONG)( (double)(val) * (double)(DFRACT_FIX_SCALE) + 0.5)) : \
+((( (double)(val) * (DFRACT_FIX_SCALE) - 0.5) <= (double)(MINVAL_DBL_CONST) ) ? (LONG)(MINVAL_DBL_CONST) : (LONG)( (double)(val) * (double)(DFRACT_FIX_SCALE) - 0.5)) )
+
+/* macros for runtime conversion of float values to integer fixedpoint. NO OVERFLOW CHECK!!! */
+#define FL2FX_SPC FL2FX_DBL
+#define FL2FX_SGL(val) ( (val)>0.0f ? (SHORT)( (val)*(float)(FRACT_FIX_SCALE)+0.5f ) : (SHORT)( (val)*(float)(FRACT_FIX_SCALE)-0.5f ) )
+#define FL2FX_DBL(val) ( (val)>0.0f ? (LONG)( (val)*(float)(DFRACT_FIX_SCALE)+0.5f ) : (LONG)( (val)*(float)(DFRACT_FIX_SCALE)-0.5f ) )
+
+/* macros for runtime conversion of fixedpoint values to other fixedpoint. NO ROUNDING!!! */
+#define FX_ACC2FX_SGL(val) ((FIXP_SGL)((val)>>(ACCU_BITS-FRACT_BITS)))
+#define FX_ACC2FX_DBL(val) ((FIXP_DBL)((val)>>(ACCU_BITS-DFRACT_BITS)))
+#define FX_SGL2FX_ACC(val) ((FIXP_ACC)((LONG)(val)<<(ACCU_BITS-FRACT_BITS)))
+#define FX_SGL2FX_DBL(val) ((FIXP_DBL)((LONG)(val)<<(DFRACT_BITS-FRACT_BITS)))
+#define FX_DBL2FX_SGL(val) ((FIXP_SGL)((val)>>(DFRACT_BITS-FRACT_BITS)))
+
+/* ############################################################# */
+
+/* macros for runtime conversion of integer fixedpoint values to float. */
+/* This is just for temporary use and should not be required in a final version! */
+
+/* #define FX_DBL2FL(val) ((float)(pow(2.,-31.)*(float)val)) */ /* version #1 */
+#define FX_DBL2FL(val) ((float)((double)(val)/(double)DFRACT_FIX_SCALE)) /* version #2 - identical to class dfract cast from dfract to float */
+
+/* ############################################################# */
+#include "fixmul.h"
+
+FDK_INLINE LONG fMult(SHORT a, SHORT b) { return fixmul_SS(a, b); }
+FDK_INLINE LONG fMult(SHORT a, LONG b) { return fixmul_SD(a, b); }
+FDK_INLINE LONG fMult(LONG a, SHORT b) { return fixmul_DS(a, b); }
+FDK_INLINE LONG fMult(LONG a, LONG b) { return fixmul_DD(a, b); }
+FDK_INLINE LONG fPow2(LONG a) { return fixpow2_D(a); }
+FDK_INLINE LONG fPow2(SHORT a) { return fixpow2_S(a); }
+
+FDK_INLINE INT fMultI(LONG a, SHORT b) { return ( (INT)(((1<<(FRACT_BITS-2)) +
+ fixmuldiv2_DD(a,((INT)b<<FRACT_BITS)))>>(FRACT_BITS-1)) ); }
+
+FDK_INLINE INT fMultIfloor(LONG a, INT b) { return ( (INT)((1 +
+ fixmuldiv2_DD(a,(b<<FRACT_BITS))) >> (FRACT_BITS-1)) ); }
+
+FDK_INLINE INT fMultIceil(LONG a, INT b) { return ( (INT)(((INT)0x7fff +
+ fixmuldiv2_DD(a,(b<<FRACT_BITS))) >> (FRACT_BITS-1)) ); }
+
+FDK_INLINE LONG fMultDiv2(SHORT a, SHORT b) { return fixmuldiv2_SS(a, b); }
+FDK_INLINE LONG fMultDiv2(SHORT a, LONG b) { return fixmuldiv2_SD(a, b); }
+FDK_INLINE LONG fMultDiv2(LONG a, SHORT b) { return fixmuldiv2_DS(a, b); }
+FDK_INLINE LONG fMultDiv2(LONG a, LONG b) { return fixmuldiv2_DD(a, b); }
+FDK_INLINE LONG fPow2Div2(LONG a) { return fixpow2div2_D(a); }
+FDK_INLINE LONG fPow2Div2(SHORT a) { return fixpow2div2_S(a); }
+
+FDK_INLINE LONG fMultDiv2BitExact(LONG a, LONG b) { return fixmuldiv2BitExact_DD(a, b); }
+FDK_INLINE LONG fMultDiv2BitExact(SHORT a, LONG b) { return fixmuldiv2BitExact_SD(a, b); }
+FDK_INLINE LONG fMultDiv2BitExact(LONG a, SHORT b) { return fixmuldiv2BitExact_DS(a, b); }
+FDK_INLINE LONG fMultBitExact(LONG a, LONG b) { return fixmulBitExact_DD(a, b); }
+FDK_INLINE LONG fMultBitExact(SHORT a, LONG b) { return fixmulBitExact_SD(a, b); }
+FDK_INLINE LONG fMultBitExact(LONG a, SHORT b) { return fixmulBitExact_DS(a, b); }
+
+/* ******************************************************************************** */
+#include "abs.h"
+
+FDK_INLINE FIXP_DBL fAbs(FIXP_DBL x)
+ { return fixabs_D(x); }
+FDK_INLINE FIXP_SGL fAbs(FIXP_SGL x)
+ { return fixabs_S(x); }
+
+/* workaround for TI C6x compiler but not for TI ARM9E compiler */
+#if (!defined(__TI_COMPILER_VERSION__) || defined(__TI_TMS470_V5__)) && !defined(__x86_64__)
+FDK_INLINE INT fAbs(INT x)
+ { return fixabs_I(x); }
+#endif
+
+/* ******************************************************************************** */
+
+#include "clz.h"
+
+FDK_INLINE INT fNormz(FIXP_DBL x)
+ { return fixnormz_D(x); }
+FDK_INLINE INT fNormz(FIXP_SGL x)
+ { return fixnormz_S(x); }
+FDK_INLINE INT fNorm(FIXP_DBL x)
+ { return fixnorm_D(x); }
+FDK_INLINE INT fNorm(FIXP_SGL x)
+ { return fixnorm_S(x); }
+
+
+/* ******************************************************************************** */
+/* ******************************************************************************** */
+/* ******************************************************************************** */
+
+#include "clz.h"
+#define fixp_abs(x) fAbs(x)
+#define fixMin(a,b) fMin(a,b)
+#define fixMax(a,b) fMax(a,b)
+#define CntLeadingZeros(x) fixnormz_D(x)
+#define CountLeadingBits(x) fixnorm_D(x)
+
+#include "fixmadd.h"
+
+/* y = (x+0.5*a*b) */
+FDK_INLINE FIXP_DBL fMultAddDiv2(FIXP_DBL x, FIXP_DBL a, FIXP_DBL b)
+ { return fixmadddiv2_DD(x, a, b); }
+FDK_INLINE FIXP_DBL fMultAddDiv2(FIXP_DBL x, FIXP_SGL a, FIXP_DBL b)
+ { return fixmadddiv2_SD(x, a, b); }
+FDK_INLINE FIXP_DBL fMultAddDiv2(FIXP_DBL x, FIXP_DBL a, FIXP_SGL b)
+ { return fixmadddiv2_DS(x, a, b); }
+FDK_INLINE FIXP_DBL fMultAddDiv2(FIXP_DBL x, FIXP_SGL a, FIXP_SGL b)
+ { return fixmadddiv2_SS(x, a, b); }
+
+FDK_INLINE FIXP_DBL fPow2AddDiv2(FIXP_DBL x, FIXP_DBL a)
+ { return fixpadddiv2_D(x, a); }
+FDK_INLINE FIXP_DBL fPow2AddDiv2(FIXP_DBL x, FIXP_SGL a)
+ { return fixpadddiv2_S(x, a); }
+
+
+/* y = 2*(x+0.5*a*b) = (2x+a*b) */
+FDK_INLINE FIXP_DBL fMultAdd(FIXP_DBL x, FIXP_DBL a, FIXP_DBL b)
+ { return fixmadd_DD(x, a, b); }
+inline FIXP_DBL fMultAdd(FIXP_DBL x, FIXP_SGL a, FIXP_DBL b)
+ { return fixmadd_SD(x, a, b); }
+inline FIXP_DBL fMultAdd(FIXP_DBL x, FIXP_DBL a, FIXP_SGL b)
+ { return fixmadd_DS(x, a, b); }
+inline FIXP_DBL fMultAdd(FIXP_DBL x, FIXP_SGL a, FIXP_SGL b)
+ { return fixmadd_SS(x, a, b); }
+
+inline FIXP_DBL fPow2Add(FIXP_DBL x, FIXP_DBL a)
+ { return fixpadd_D(x, a); }
+inline FIXP_DBL fPow2Add(FIXP_DBL x, FIXP_SGL a)
+ { return fixpadd_S(x, a); }
+
+
+/* y = (x-0.5*a*b) */
+inline FIXP_DBL fMultSubDiv2(FIXP_DBL x, FIXP_DBL a, FIXP_DBL b)
+ { return fixmsubdiv2_DD(x, a, b); }
+inline FIXP_DBL fMultSubDiv2(FIXP_DBL x, FIXP_SGL a, FIXP_DBL b)
+ { return fixmsubdiv2_SD(x, a, b); }
+inline FIXP_DBL fMultSubDiv2(FIXP_DBL x, FIXP_DBL a, FIXP_SGL b)
+ { return fixmsubdiv2_DS(x, a, b); }
+inline FIXP_DBL fMultSubDiv2(FIXP_DBL x, FIXP_SGL a, FIXP_SGL b)
+ { return fixmsubdiv2_SS(x, a, b); }
+
+/* y = 2*(x-0.5*a*b) = (2*x-a*b) */
+FDK_INLINE FIXP_DBL fMultSub(FIXP_DBL x, FIXP_DBL a, FIXP_DBL b)
+ { return fixmsub_DD(x, a, b); }
+inline FIXP_DBL fMultSub(FIXP_DBL x, FIXP_SGL a, FIXP_DBL b)
+ { return fixmsub_SD(x, a, b); }
+inline FIXP_DBL fMultSub(FIXP_DBL x, FIXP_DBL a, FIXP_SGL b)
+ { return fixmsub_DS(x, a, b); }
+inline FIXP_DBL fMultSub(FIXP_DBL x, FIXP_SGL a, FIXP_SGL b)
+ { return fixmsub_SS(x, a, b); }
+
+FDK_INLINE FIXP_DBL fMultAddDiv2BitExact(FIXP_DBL x, FIXP_DBL a, FIXP_DBL b)
+ { return fixmadddiv2BitExact_DD(x, a, b); }
+FDK_INLINE FIXP_DBL fMultAddDiv2BitExact(FIXP_DBL x, FIXP_SGL a, FIXP_DBL b)
+ { return fixmadddiv2BitExact_SD(x, a, b); }
+FDK_INLINE FIXP_DBL fMultAddDiv2BitExact(FIXP_DBL x, FIXP_DBL a, FIXP_SGL b)
+ { return fixmadddiv2BitExact_DS(x, a, b); }
+FDK_INLINE FIXP_DBL fMultSubDiv2BitExact(FIXP_DBL x, FIXP_DBL a, FIXP_DBL b)
+ { return fixmsubdiv2BitExact_DD(x, a, b); }
+FDK_INLINE FIXP_DBL fMultSubDiv2BitExact(FIXP_DBL x, FIXP_SGL a, FIXP_DBL b)
+ { return fixmsubdiv2BitExact_SD(x, a, b); }
+FDK_INLINE FIXP_DBL fMultSubDiv2BitExact(FIXP_DBL x, FIXP_DBL a, FIXP_SGL b)
+ { return fixmsubdiv2BitExact_DS(x, a, b); }
+
+#include "fixminmax.h"
+
+FDK_INLINE FIXP_DBL fMin(FIXP_DBL a, FIXP_DBL b)
+ { return fixmin_D(a,b); }
+FDK_INLINE FIXP_DBL fMax(FIXP_DBL a, FIXP_DBL b)
+ { return fixmax_D(a,b); }
+
+FDK_INLINE FIXP_SGL fMin(FIXP_SGL a, FIXP_SGL b)
+ { return fixmin_S(a,b); }
+FDK_INLINE FIXP_SGL fMax(FIXP_SGL a, FIXP_SGL b)
+ { return fixmax_S(a,b); }
+
+/* workaround for TI C6x compiler but not for TI ARM9E */
+#if ((!defined(__TI_COMPILER_VERSION__) || defined(__TI_TMS470_V5__)) && !defined(__x86_64__)) || (FIX_FRACT == 1)
+FDK_INLINE INT fMax(INT a, INT b)
+ { return fixmax_I(a,b); }
+FDK_INLINE INT fMin(INT a, INT b)
+ { return fixmin_I(a,b); }
+#endif
+
+inline UINT fMax(UINT a, UINT b)
+ { return fixmax_UI(a,b); }
+inline UINT fMin(UINT a, UINT b)
+ { return fixmin_UI(a,b); }
+
+/* Complex data types */
+typedef shouldBeUnion {
+ /* vector representation for arithmetic */
+ struct {
+ FIXP_SGL re;
+ FIXP_SGL im;
+ } v;
+ /* word representation for memory move */
+ LONG w;
+} FIXP_SPK;
+
+typedef shouldBeUnion {
+ /* vector representation for arithmetic */
+ struct {
+ FIXP_DBL re;
+ FIXP_DBL im;
+ } v;
+ /* word representation for memory move */
+ INT64 w;
+} FIXP_DPK;
+
+#include "fixmul.h"
+#include "fixmadd.h"
+#include "cplx_mul.h"
+#include "scale.h"
+#include "fixpoint_math.h"
+
+#endif