Merge pull request #78 from shuchitak/bugfix/fs_deviation_increase_precision

Increase fFsRatioDeviation precision in the C model

Author: shuchitak

CHANGELOG.rst

@@ -12,6 +12,8 @@ lib_src change log
   * CHANGED: Golden reference test signals now generated automatically by CI
   * RESOLVED: Linker warning on channel ends
   * REMOVED: AN00231 ASRC App Note. See github.com/xmos/sln_voice/examples
+  * CHANGED: Increased precision of the fFsRatioDeviation used in the C emulator
+    from float to double
 
   * Changes to dependencies:
 

tests/asrc_test/dut/asrc_test.xc

@@ -33,7 +33,7 @@ int uiInFs = -1;
 int uiOutFs = -1;
 
 //Global deviation ratio from nominal sample rate in/out ratio. Initialise to invalid.
-float fFsRatioDeviation = -1.0000;
+double fFsRatioDeviation = (double)-1.0000;
 
 const int sample_rates[] = {44100, 48000, 88200, 96000, 176400, 192000};
 
@@ -67,13 +67,13 @@ void dsp_slave(chanend c_dsp)
         asrc_ctrl[ui].piStack                   = asrc_stack[ui];
         asrc_ctrl[ui].piADCoefs                 = asrc_adfir_coefs.iASRCADFIRCoefs;
     }
-    
+
 /*
      // Update Fs Ratio
     for(int i = 0; i < ASRC_N_CHANNELS; i++)
     {
     // Make Fs Ratio deviate
-    asrc_ctrl[i].uiFsRatio        = (unsigned int)(asrc_ctrl[i].uiFsRatio * fFsRatioDeviation);
+    asrc_ctrl[i].uiFsRatio        = (unsigned int)((double)asrc_ctrl[i].uiFsRatio * fFsRatioDeviation);
         if(ASRC_update_fs_ratio(&asrc_ctrl[i]) != ASRC_NO_ERROR)
         {
               printf("Error updating ASRC fs ratio\n");
@@ -103,7 +103,7 @@ void dsp_slave(chanend c_dsp)
         }
 
         n_samps_in_tot += ASRC_N_IN_SAMPLES;
-        
+
         c_dsp <: n_samps_out;       //Send number of samples to receive
 
         for(unsigned uj = 0; uj < n_samps_out; uj++)
@@ -121,7 +121,7 @@ void dsp_slave(chanend c_dsp)
             unsigned OutFs                    = sr_in_out_new & 0xffff;
 
             unsigned nominal_FsRatio = asrc_init(InFs, OutFs, asrc_ctrl, ASRC_CHANNELS_PER_INSTANCE, ASRC_N_IN_SAMPLES, ASRC_DITHER_SETTING);
-            
+
             sr_in_out = sr_in_out_new;
             printf("DSP init Initial nominal_FsRatio=%d, SR in=%d, SR out=%d\n", nominal_FsRatio, InFs, OutFs);
         }
@@ -130,7 +130,7 @@ void dsp_slave(chanend c_dsp)
     }
 }
 
-void dsp_mgr(chanend c_dsp[], float fFsRatioDeviation){
+void dsp_mgr(chanend c_dsp[], double fFsRatioDeviation){
 
     FILE            * movable InFileDat[ASRC_N_CHANNELS];
     FILE            * movable OutFileDat[ASRC_N_CHANNELS];
@@ -140,11 +140,11 @@ void dsp_mgr(chanend c_dsp[], float fFsRatioDeviation){
     unsigned iEndOfFile  = 0;
     unsigned int    sr_in_out = uiInFs << 16 | uiOutFs ; //Input fs in upper 16bits and Output fs in lower 16bits
     unsigned FsRatio = (unsigned) (((unsigned long long)sample_rates[uiInFs] * (unsigned long long)(1<<28)) / (unsigned long long)sample_rates[uiOutFs]);
-    
-    FsRatio =  (unsigned int)((float)FsRatio * fFsRatioDeviation); //Ensure is precisely the same as golden value complete with trucation due to 32b float
+
+    FsRatio =  (unsigned int)((double)FsRatio * fFsRatioDeviation); //Ensure is precisely the same as golden value complete with trucation due to 32b float
     printf("Adjusted FsRatio dsp_mgr = %d, 0x%x\n", FsRatio, FsRatio);
 
-    
+
 
     for (int i=0; i<ASRC_N_CHANNELS; i++)
     unsafe
@@ -164,7 +164,7 @@ void dsp_mgr(chanend c_dsp[], float fFsRatioDeviation){
 
 
     while(!iEndOfFile)
-    {        
+    {
         for (unsigned j=0; j<ASRC_N_INSTANCES; j++) {
             c_dsp[j] <: sr_in_out;
             c_dsp[j] <: FsRatio;
@@ -180,21 +180,21 @@ void dsp_mgr(chanend c_dsp[], float fFsRatioDeviation){
                     printf("EOF\n");
                 }
                 c_dsp[j] <: samp;       //Send the sample
-            }            
+            }
         }
-        count_in += ASRC_N_IN_SAMPLES; 
+        count_in += ASRC_N_IN_SAMPLES;
 
 
         unsigned n_samps;
-        for (unsigned j=0; j<ASRC_N_INSTANCES; j++) 
+        for (unsigned j=0; j<ASRC_N_INSTANCES; j++)
         {
             c_dsp[j] :> n_samps;  //Get number of samps to receive
         }
 
-        for(unsigned i = 0; i < n_samps * ASRC_CHANNELS_PER_INSTANCE; i++) 
+        for(unsigned i = 0; i < n_samps * ASRC_CHANNELS_PER_INSTANCE; i++)
         {
             int samp;
-            for (unsigned j=0; j<ASRC_N_INSTANCES; j++) 
+            for (unsigned j=0; j<ASRC_N_INSTANCES; j++)
             {
                 unsigned file_index = (i * ASRC_N_INSTANCES + j) % ASRC_N_CHANNELS;
                 c_dsp[j] :> samp; //Get samples
@@ -232,7 +232,7 @@ void ShowUsage()
         "         -g     Output sample rate (44100 - 192000)\n\n"
         "         -n     Number of input samples (all channels) to process\n\n"
         );
-    
+
     exit(0);
 }
 
@@ -268,13 +268,13 @@ void ParseCmdLine(char *input, char * unsafe * argv, int ui)
 {
   switch (*input)
   {
-  
+
     case 'h':
     case 'H':
       ShowUsage();
       exit(0);
       break;
-    
+
     case 'i':
     case 'I':
       for (int i=0; i<ASRC_N_CHANNELS; i++)
@@ -305,7 +305,7 @@ void ParseCmdLine(char *input, char * unsafe * argv, int ui)
     case 'g':
     case 'G':
       uiOutFs = (unsigned int)(atoi((char *)argv[ui + 1]));
-      uiOutFs = samp_rate_to_code(uiOutFs);      
+      uiOutFs = samp_rate_to_code(uiOutFs);
       if((uiOutFs < ASRC_FS_MIN) || (uiOutFs > ASRC_FS_MAX))
       {
         printf("ERROR: invalid frequency index %d\n", uiOutFs);
@@ -315,7 +315,7 @@ void ParseCmdLine(char *input, char * unsafe * argv, int ui)
 
     case 'e':
     case 'E':
-      fFsRatioDeviation = (float)(atof((char *)argv[ui + 1]));
+      fFsRatioDeviation = (double)(atof((char *)argv[ui + 1]));
       //Note no check. This is done at run-time.
       break;
 
@@ -346,14 +346,14 @@ void ParseCmdLine(char *input, char * unsafe * argv, int ui)
   }
 }
 
-int main(int argc, char * unsafe argv[]) 
+int main(int argc, char * unsafe argv[])
 {
     int ui;
 
     printf("Running ASRC test simulation \n");
     if (argc <= 1 ) ShowUsage();
 
-    //Parse command line arguments 
+    //Parse command line arguments
     for (ui = 1; ui < (unsigned int)argc; ui++)
     unsafe{
         if (*(argv[ui]) == '-')
@@ -370,7 +370,7 @@ int main(int argc, char * unsafe argv[])
         printf("ERROR: number of input samples not set\n");
         exit(1);
     }
-    
+
     if (uiInFs == -1)
     {
         printf("ERROR: input sample rate not set\n");

tests/asrc_test/model/Main.c

@@ -1,6 +1,6 @@
 // ===========================================================================
 // ===========================================================================
-//	
+//
 // File: Main.c
 //
 // Main implementation file for the ASRC demonstration program
@@ -77,7 +77,7 @@ char*			pzOutFileName[ASRC_N_IO_CHANNELS];				// Output data file name
 
 unsigned int	uiInFs;											// Input sampling rate
 unsigned int	uiOutFs;										// Output sampling rate
-float			fFsRatioDeviation;								// Fs ratio deviation
+double			fFsRatioDeviation;								// Fs ratio deviation
 
 unsigned int	uiNTotalInSamples;								// Total number of input sample pairs to process
 unsigned int	uiNTotalOutSamples;								// Total number of output sample pairs produced
@@ -94,7 +94,7 @@ ASRCState_t		sASRCState[ASRC_N_IO_CHANNELS];
 int				iASRCStack[ASRC_N_IO_CHANNELS][ASRC_STACK_LENGTH_MULT * N_IN_SAMPLES_MAX];
 ASRCCtrl_t		sASRCCtrl[ASRC_N_IO_CHANNELS];
 int				iASRCADFIRCoefs[ASRC_ADFIR_COEFS_LENGTH];
-	
+
 
 // Data I/O
 // --------
@@ -133,13 +133,13 @@ void main(int argc, char *argv[])
 	int				iEndOfFile;
 	unsigned int	ui, uj;
 
-	//	Display application information 
+	//	Display application information
 	fprintf(stdout, "\n%s  \nVersion: %s\n%s\n\n",
 		APPLICATION, VERSION, COPYRIGHT);
-	
+
 	// Initialize default values
-	pzInFileName[0]		= INPUT_FILE_CHANNEL_0_DEFAULT;			// Input data for channel 0			
-	pzInFileName[1]		= INPUT_FILE_CHANNEL_1_DEFAULT;			// Input data for channel 1	
+	pzInFileName[0]		= INPUT_FILE_CHANNEL_0_DEFAULT;			// Input data for channel 0
+	pzInFileName[1]		= INPUT_FILE_CHANNEL_1_DEFAULT;			// Input data for channel 1
 	pzOutFileName[0]	= OUTPUT_FILE_CHANNEL_0_DEFAULT;		// Output data for channel 0
 	pzOutFileName[1]	= OUTPUT_FILE_CHANNEL_0_DEFAULT;		// Output data for channel 1
 
@@ -155,7 +155,7 @@ void main(int argc, char *argv[])
 	uiASRCRandSeed[0]	= ASRC_RAND_SEED_CHANNEL_0_DEFAULT;		// Random seed for channel 0
 	uiASRCRandSeed[1]	= ASRC_RAND_SEED_CHANNEL_1_DEFAULT;		// Random seed for channel 1
 
-	//	Parse command line arguments 
+	//	Parse command line arguments
 	for (ui = 1; ui < (unsigned int)argc; ui++)
 	{
 		if (*(argv[ui]) == '-')
@@ -187,15 +187,15 @@ void main(int argc, char *argv[])
 
 	printf("Total number of input samples: %i\n", uiNTotalInSamples);
 	printf("Number of input samples to process in one call: %i\n\n", uiNInSamples);
-	
+
 
 	// Clear data buffers
 	for(ui = 0; ui < ASRC_N_IO_CHANNELS * N_TOTAL_IN_SAMPLES_MAX; ui++)
 		iIn[ui]		= 0;
 	for(ui = 0; ui < ASRC_N_IO_CHANNELS * N_TOTAL_IN_SAMPLES_MAX * ASRC_N_IN_OUT_RATIO_MAX; ui++)
 		iOut[ui]	= 0;
 
-	// Open i/o files 
+	// Open i/o files
 	for(ui = 0; ui < ASRC_N_IO_CHANNELS; ui++)
 	{
 		if ((InFileDat[ui] = fopen(pzInFileName[ui], "rt")) == NULL)
@@ -209,7 +209,7 @@ void main(int argc, char *argv[])
 			HandleError(pzError, FATAL);
 		}
 	}
-	
+
 
 	// Process init
 	// ------------
@@ -280,7 +280,7 @@ void main(int argc, char *argv[])
 
 	// Process data
 	// ------------
-	// Initialize remaing number of samples to total number of input samples, 
+	// Initialize remaing number of samples to total number of input samples,
 	// total number of output samples to 0 and setup input / output data pointers to base of buffers
 	iNRemainingSamples		= (int)uiNTotalInSamples;
 	uiNTotalOutSamples		= 0;
@@ -322,7 +322,7 @@ void main(int argc, char *argv[])
 		// ==================================
 		for(ui = 0; ui < ASRC_N_IO_CHANNELS; ui++)
 			// Note: this is block based similar to SSRC, output will be on stack
-			// and there will be sASRCCtrl[0].uiNSyncSamples samples per channel produced		
+			// and there will be sASRCCtrl[0].uiNSyncSamples samples per channel produced
 			if(ASRC_proc_F1_F2(&sASRCCtrl[ui]) != ASRC_NO_ERROR)
 			{
 				sprintf(pzError, "Error at ASRC F1 F2 process");
@@ -377,13 +377,13 @@ void main(int argc, char *argv[])
 		// We are back to block based processing. This is where the number of ASRC output samples is required again
 		// (would not be used if sample by sample based (on output samples))
 		for(ui = 0; ui < ASRC_N_IO_CHANNELS; ui++)
-			// Note: this is block based similar to SSRC	
+			// Note: this is block based similar to SSRC
 			if(ASRC_proc_dither(&sASRCCtrl[ui]) != ASRC_NO_ERROR)
 			{
 				sprintf(pzError, "Error at ASRC F1 F2 process");
 				HandleError(pzError, FATAL);
 			}
-	
+
 
 		// Write output data to files
 		// --------------------------
@@ -393,8 +393,8 @@ void main(int argc, char *argv[])
 				{
 					sprintf(pzError, "Error while writing to output file, %s", pzOutFileName[ui]);
 					HandleError(pzError, FATAL);
-				}		
-	
+				}
+
 
 		// Update input and outut data pointers for next round
 		piIn					+= (sASRCCtrl[0].uiNInSamples * ASRC_N_IO_CHANNELS);
@@ -404,21 +404,21 @@ void main(int argc, char *argv[])
 		// Update total output sample counter
 		uiNTotalOutSamples		+= sASRCCtrl[0].uiNASRCOutSamples;
 	}
-	
 
-	// Report MIPS 
+
+	// Report MIPS
 	for(ui = 0; ui < ASRC_N_IO_CHANNELS; ui++)
 	{
 		printf("MIPS total load channel %i: %f\n", ui, (sASRCCtrl[ui].fCycleCountF1F2 + sASRCCtrl[ui].fCycleCountF3AdaptiveCoefs + sASRCCtrl[ui].fCycleCountF3 + sASRCCtrl[ui].fCycleCountDither) / (float)(sASRCCtrl[ui].uiNInSamples) * (float)uiFsTable[sASRCCtrl[ui].eInFs]/ 1000000.0);
 		printf("MIPS F1+F2 load channel %i: %f\n", ui, sASRCCtrl[ui].fCycleCountF1F2 / (float)(sASRCCtrl[ui].uiNInSamples) * (float)uiFsTable[sASRCCtrl[ui].eInFs]/ 1000000.0);
 		printf("MIPS F3 Adaptive Coefs computation load channel %i: %f\n", ui, sASRCCtrl[ui].fCycleCountF3AdaptiveCoefs / (float)(sASRCCtrl[ui].uiNInSamples) * (float)uiFsTable[sASRCCtrl[ui].eInFs]/ 1000000.0);
 		printf("MIPS F3 load channel %i: %f\n", ui, sASRCCtrl[ui].fCycleCountF3 / (float)(sASRCCtrl[ui].uiNInSamples) * (float)uiFsTable[sASRCCtrl[ui].eInFs]/ 1000000.0);
 		printf("MIPS Dither load channel %i: %f\n\n", ui, sASRCCtrl[ui].fCycleCountDither / (float)(sASRCCtrl[ui].uiNInSamples) * (float)uiFsTable[sASRCCtrl[ui].eInFs]/ 1000000.0);
-		
+
 	}
 	// Report number of output samples produced
 	printf("Total number of output samples produced: %i\n\n\n", uiNTotalOutSamples);
-	
+
 
 	//	Close i/o files
 	for(ui = 0; ui < ASRC_N_IO_CHANNELS; ui++)
@@ -435,11 +435,11 @@ void main(int argc, char *argv[])
 		}
 	}
 
-	
+
 
 	fprintf(stdout, "Application run finished, press any key to exit\n\n");
 	getchar();
-	
+
 	exit(0);
 }
 
@@ -461,15 +461,15 @@ void ParseCmdLine(char *input)
 
 		case 'e':
 		case 'E':
-			fFsRatioDeviation = (float)(atof(input + 1));
+			fFsRatioDeviation = (double)(atof(input + 1));
 			break;
-	
+
 		case 'h':
 		case 'H':
 			ShowUsage();
 			exit(0);
 			break;
-		
+
 		case 'i':
 		case 'I':
 			pzInFileName[0] = input + 1;
@@ -553,7 +553,7 @@ void ShowHelp()
 	fprintf(stdout,"Invalid argument. Application will terminate now. Use -h to get usage.\n");
 	fprintf(stdout, "Press any key to exit\n\n");
 	getchar();
-	
+
 	exit(0);
 }
 
@@ -577,7 +577,7 @@ void ShowUsage()
 		"		  -r	 Random seed for channel 0 for dither generation (default: 1)\n\n"
 		"		  -s	 Random seed for channel 1 for dither generation (default: 1458976)\n\n"
 		);
-	
+
 	exit(0);
 }
 
@@ -603,5 +603,3 @@ void HandleError(char *pzErrorMessage, short sErrorType)
 	getchar();
 	return;
 }
-
-