【安富莱DSP教程】第22章 math_help中函数的使用

席萌0209

特别说明：完整45期数字信号处理教程，原创高性能示波器代码全开源地址：链接

第22章 math_help中函数的使用

    本期教程主要讲解math_help文件中函数的使用，这个文件也是ARM官方提供的，这些函数相对都比较容易，同时使用频率也很高。希望初学的同学学习并掌握。
    22.1 函数讲解
    22.3 总结

22.1 函数讲解

22.1.1 函数目录

    在文件math_help文件中主要有以下函数：

1. float arm_snr_f32(float *pRef, float *pTest,  uint32_t buffSize);  
2. void arm_float_to_q12_20(float *pIn, q31_t * pOut, uint32_t numSamples);
3. void arm_provide_guard_bits_q15(q15_t *input_buf, uint32_t blockSize, uint32_t guard_bits);
4. void arm_provide_guard_bits_q31(q31_t *input_buf, uint32_t blockSize, uint32_t guard_bits);
5. void arm_float_to_q14(float *pIn, q15_t *pOut, uint32_t numSamples);
6. void arm_float_to_q30(float *pIn, q31_t *pOut, uint32_t numSamples);
7. void arm_clip_f32(float *pIn, uint32_t numSamples);
8. uint32_t arm_calc_guard_bits(uint32_t num_adds);
9. void arm_apply_guard_bits (float32_t * pIn, uint32_t numSamples, uint32_t guard_bits);
10. uint32_t arm_compare_fixed_q15(q15_t *pIn, q15_t * pOut, uint32_t numSamples);
11. uint32_t arm_compare_fixed_q31(q31_t *pIn, q31_t *pOut, uint32_t numSamples);
12. uint32_t arm_calc_2pow(uint32_t guard_bits);

复制代码

22.1.2 arm_snr_f32

    这个函数用于求信噪比：

1. /**                                                                                                   (1)
2. * @brief  Caluclation of SNR
3. * @param  float*     Pointer to the reference buffer
4. * @param  float*    Pointer to the test buffer
5. * @param  uint32_t    total number of samples
6. * @return float    SNR
7. * The function Caluclates signal to noise ratio for the reference output
8. * and test output
9. */
11. float arm_snr_f32(float *pRef, float *pTest, uint32_t buffSize)
12. {
13.   float EnergySignal = 0.0, EnergyError = 0.0;
14.   uint32_t i;
15.   float SNR;
16.   int temp;
17.   int *test;
19.   for (i = 0; i < buffSize; i++)
20.     {
21.        /* Checking for a NAN value in pRef array */
22.   test =   (int *)(&pRef[i]);
23.       temp =  *test;
25.   if(temp == 0x7FC00000)
26.   {
27.        return(0);
28.   }
30.   /* Checking for a NAN value in pTest array */
31.   test =   (int *)(&pTest[i]);
32.       temp =  *test;
34.   if(temp == 0x7FC00000)
35.   {
36.        return(0);
37.   }
38.       EnergySignal += pRef[i] * pRef[i];
39.       EnergyError += (pRef[i] - pTest[i]) * (pRef[i] - pTest[i]);
40.     }
42. /* Checking for a NAN value in EnergyError */
43. test =   (int *)(&EnergyError);
44.     temp =  *test;
46.     if(temp == 0x7FC00000)
47.     {
48.        return(0);
49.     }
51.   SNR = 10 * log10 (EnergySignal / EnergyError);                                                       (2)
53.   return (SNR);
55. }

复制代码

1. 这里先补充一些信噪比方面的基础知识：
    信噪比，即SNR（Signal to Noise Ratio），又称为讯噪比。反映摄像机成像的抗干扰能力，反应在画质上就是画面是否干净无噪点；狭义来讲是指放大器的输出信号的功率与同时输出的噪声功率的比，常常用分贝数表示，设备的信噪比越高表明它产生的杂音越少。一般来说，信噪比越大，说明混在信号里的噪声越小，声音回放的音质量越高，否则相反。信噪比一般不应该低于70dB，高保真音箱的信噪比应达到110dB以上。公式如下：


    关于信噪比更详细的知识，大家可以查阅相关资料进行了解。
2. 这里实现的就是上面所说的信噪比公式。

席萌0209

22.1.3 arm_float_to_q12_20

1. /**
2. * @brief  Converts float to fixed in q12.20 format                                                    (1)
3. * @param  uint32_t     number of samples in the buffer
4. * @return none
5. * The function converts floating point values to fixed point(q12.20) values
6. */
8. void arm_float_to_q12_20(float *pIn, q31_t * pOut, uint32_t numSamples)
9. {
10.   uint32_t i;
12.   for (i = 0; i < numSamples; i++)
13.     {
14.   /* 1048576.0f corresponds to pow(2, 20) */
15.       pOut[i] = (q31_t) (pIn[i] * 1048576.0f);                                                        (2)
17.       pOut[i] += pIn[i] > 0 ? 0.5 : -0.5;
19.       if (pIn[i] == (float) 1.0)
20.         {
21.           pOut[i] = 0x000FFFFF;
22.         }
23.     }
24. }

复制代码

1. 这个函数用于将浮点数转换成Q12.20格式的数据。
2. 浮点数转换成Q12.20格式需要乘以2^20，然后再做舍入处理，特别注意这里的浮点数末尾要加符号f，这样才能保证是单精度。

22.1.4 arm_provide_guard_bits_q15

1. /**
2. * @brief  Provide guard bits for Input buffer
3. * @param  q15_t*         Pointer to input buffer
4. * @param  uint32_t     blockSize
5. * @param  uint32_t     guard_bits
6. * @return none
7. * The function Provides the guard bits for the buffer
8. * to avoid overflow
9. */
11. void arm_provide_guard_bits_q15 (q15_t * input_buf, uint32_t blockSize,
12.                             uint32_t guard_bits)
13. {
14.   uint32_t i;
16.   for (i = 0; i < blockSize; i++)
17.     {
18.       input_buf[i] = input_buf[i] >> guard_bits;
19.     }
20. }

复制代码

1. 这个函数用于给q15_t类型的数据提供保护位，防止溢出。从函数的实现上看，保护位的实现是通过右移数据实现的。

22.1.5  arm_provide_guard_bits_q31

1. /**
2. * @brief  Provide guard bits for Input buffer
3. * @param  q31_t*     Pointer to input buffer
4. * @param  uint32_t     blockSize
5. * @param  uint32_t     guard_bits
6. * @return none
7. * The function Provides the guard bits for the buffer
8. * to avoid overflow
9. */
11. void arm_provide_guard_bits_q31 (q31_t * input_buf,
12. uint32_t blockSize,
13.                                  uint32_t guard_bits)
14. {
15.   uint32_t i;
17.   for (i = 0; i < blockSize; i++)
18.     {
19.       input_buf[i] = input_buf[i] >> guard_bits;
20.     }
21. }

复制代码

1. 这个函数用于给q31_t类型的数据提供保护位，防止溢出。从函数的实现上看，保护位的实现是通过右移数据实现的。

席萌0209

22.1.6 arm_float_to_q14

1. /**
2. * @brief  Converts float to fixed q14
3. * @param  uint32_t     number of samples in the buffer
4. * @return none
5. * The function converts floating point values to fixed point values
6. */
8. void arm_float_to_q14 (float *pIn, q15_t * pOut,
9.                        uint32_t numSamples)
10. {
11.   uint32_t i;
13.   for (i = 0; i < numSamples; i++)
14.     {
15.   /* 16384.0f corresponds to pow(2, 14) */
16.       pOut[i] = (q15_t) (pIn[i] * 16384.0f);
18.       pOut[i] += pIn[i] > 0 ? 0.5 : -0.5;
20.       if (pIn[i] == (float) 2.0)
21.         {
22.           pOut[i] = 0x7FFF;
23.         }
25.     }
27. }

复制代码

1. 这个函数用于将浮点数转换成Q14格式的数据。
2. 浮点数转换成Q14格式需要乘以2^14，然后再做舍入处理，特别注意这里的浮点数末尾要加符号f，这样才能保证是单精度。

22.1.7 arm_float_to_q30

1. /**
2. * @brief  Converts float to fixed q30 format
3. * @param  uint32_t     number of samples in the buffer
4. * @return none
5. * The function converts floating point values to fixed point values
6. */
8. void arm_float_to_q29 (float *pIn, q31_t * pOut,
9.    uint32_t numSamples)
10. {
11.   uint32_t i;
13.   for (i = 0; i < numSamples; i++)
14.     {
15.   /* 1073741824.0f corresponds to pow(2, 30) */
16.       pOut[i] = (q31_t) (pIn[i] * 536870912.0f);
18.       pOut[i] += pIn[i] > 0 ? 0.5 : -0.5;
20.       if (pIn[i] == (float) 4.0)
21.         {
22.           pOut[i] = 0x7FFFFFFF;
23.         }
24.     }
25. }

复制代码

1. 这个函数用于将浮点数转换成Q30格式的数据。
2. 浮点数转换成Q30格式需要乘以2^30，然后再做舍入处理，特别注意这里的浮点数末尾要加符号f，这样才能保证是单精度。

22.1.8 arm_calc_guard_bits

1. /**
2. * @brief  Caluclates number of guard bits
3. * @param  uint32_t     number of additions
4. * @return none
5. * The function Caluclates the number of guard bits  
6. * depending on the numtaps
7. */
9. uint32_t arm_calc_guard_bits (uint32_t num_adds)
10. {
11.   uint32_t i = 1, j = 0;
13.   if (num_adds == 1)
14.     {
15.       return (0);
16.     }
18.   while (i < num_adds)
19.     {
20.       i = i * 2;
21.       j++;
22.     }
24.   return (j);
25. }

复制代码

1. 这个函数是根据加数的个数来计算最终结果需要的保护位格式，从而防止溢出。

席萌0209

22.1.9  arm_apply_guard_bits

1. /**
2. * @brief  Converts Q15 to floating-point
3. * @param  uint32_t     number of samples in the buffer
4. * @return none
5. */
7. void arm_apply_guard_bits (float32_t * pIn,
8.    uint32_t numSamples,
9.    uint32_t guard_bits)
10. {
11.   uint32_t i;
13.   for (i = 0; i < numSamples; i++)
14.     {
15.       pIn[i] = pIn[i] * arm_calc_2pow(guard_bits);
16.     }
17. }

复制代码

1. 这个函数不是很理解在实际应用中的作用。

22.1.10  arm_calc_2pow

1. /**
2. * @brief  Calculates pow(2, numShifts)
3. * @param  uint32_t     number of shifts
4. * @return pow(2, numShifts)
5. */
6. uint32_t arm_calc_2pow(uint32_t numShifts)
7. {
9.   uint32_t i, val = 1;
11.   for (i = 0; i < numShifts; i++)
12.     {
13.       val = val * 2;
14.     }
16.   return(val);
17. }

复制代码

1. 这个函数用于求解2的n次方。

22.1.11  arm_compare_fixed_q15

1. /**
2. * @brief  Compare MATLAB Reference Output and ARM Test output
3. * @param  q15_t*     Pointer to Ref buffer
4. * @param  q15_t*     Pointer to Test buffer
5. * @param  uint32_t     number of samples in the buffer
6. * @return none
7. */
9. uint32_t arm_compare_fixed_q15(q15_t *pIn, q15_t * pOut, uint32_t numSamples)
10. {
11.   uint32_t i;
12.   int32_t diff, diffCrnt = 0;
13.   uint32_t maxDiff = 0;
15.   for (i = 0; i < numSamples; i++)
16.   {
17.       diff = pIn[i] - pOut[i];
18.       diffCrnt = (diff > 0) ? diff : -diff;
20. if(diffCrnt > maxDiff)
21. {
22. maxDiff = diffCrnt;
23. }
24.   }
26.   return(maxDiff);
27. }

复制代码

1. 这个函数用于对比matlab和ARM实际计算的输出，并返回最大的差值（Q15）。

22.1.12  arm_compare_fixed_q15

1. /**
2. * @brief  Compare MATLAB Reference Output and ARM Test output
3. * @param  q31_t*     Pointer to Ref buffer
4. * @param  q31_t*     Pointer to Test buffer
5. * @param  uint32_t     number of samples in the buffer
6. * @return none
7. */
9. uint32_t arm_compare_fixed_q31(q31_t *pIn, q31_t * pOut, uint32_t numSamples)
10. {
11.   uint32_t i;
12.   int32_t diff, diffCrnt = 0;
13.   uint32_t maxDiff = 0;
15.   for (i = 0; i < numSamples; i++)
16.   {
17.       diff = pIn[i] - pOut[i];
18.       diffCrnt = (diff > 0) ? diff : -diff;
20. if(diffCrnt > maxDiff)
21. {
22. maxDiff = diffCrnt;
23. }
24.   }
26.   return(maxDiff);
27. }

复制代码

1. 这个函数用于对比matlab和ARM实际计算的输出，并返回最大的差值（Q31）。

席萌0209

22.2  总结


    本期教程就跟大家讲这么多，本期教程就不配套例子了，这些函数会在后面的应用中都用到。