chancged coohpsk_ch --raw_dir argument to be --fading_dir for consistency

Author: drowe67

README_data.md

@@ -336,7 +336,7 @@ Clipping works by introducing controlled distortion, which affects the SNR estim
 
 This command line demonstrates the effect:
 ```
-/src/freedv_data_raw_tx datac3 /dev/zero - --testframes 10 --bursts 10 --clip 1 | ./src/cohpsk_ch - - -100 --raw_dir ../raw  --Fs 8000 | ./src/freedv_data_raw_rx datac3 - /dev/null --testframes --framesperburst 1 -v
+./src/freedv_data_raw_tx datac3 /dev/zero - --testframes 10 --bursts 10 --clip 1 | ./src/cohpsk_ch - - -100 --fading_dir unittest  --Fs 8000 | ./src/freedv_data_raw_rx datac3 - /dev/null --testframes --framesperburst 1 -v
 ```
 Try adjusting `--clip` and third argument of `cohpsk_ch` (noise level) for different modes.  Note the SNR estimates returned from `freedv_data_raw_rx` compared to the SNR from the channel simulator `cohpsh_ch`. You will notice clipping also increases the RMS power and reduces the PER for a given noise level.
 

README_freedv.md

@@ -185,11 +185,11 @@ $ ./freedv_tx 2020 ~/LPCNet/wav/all.wav - | ./cohpsk_ch - - -22 --Fs 8000 | ./fr
 
 AWGN:
 ```
-$ ./src/freedv_tx 700D ../raw/ve9qrp.raw - --clip 0 --testframes | ./src/cohpsk_ch - - -16 --raw_dir ../raw/ --Fs 8000 | ./src/freedv_rx 700D - /dev/null --testframes
+$ ./src/freedv_tx 700D ../raw/ve9qrp.raw - --clip 0 --testframes | ./src/cohpsk_ch - - -16 --Fs 8000 | ./src/freedv_rx 700D - /dev/null --testframes
 ```
 MultiPath Poor (MPP):
 ```
-$ ./src/freedv_tx 700D ../raw/ve9qrp.raw - --clip 0 --testframes | ./src/cohpsk_ch - - -24 --fast --raw_dir ../raw/ --Fs 8000 | ./src/freedv_rx 700D - /dev/null --testframes
+$ ./src/freedv_tx 700D ../raw/ve9qrp.raw - --clip 0 --testframes | ./src/cohpsk_ch - - -24 --mpp --fading_dir unittest --Fs 8000 | ./src/freedv_rx 700D - /dev/null --testframes
 ```
 
 Adjust `--clip [0|1]` and 3rd argument of `cohpsk_ch` to obtain a PER of just less than 0.1, and note the SNR and PAPR reported by `cohpsk_ch`.  The use of the `ve9qrp` samples makes the test run for a few minutes, in order to get reasonable multipath channel results.

src/cohpsk_ch.c

@@ -48,7 +48,7 @@
 
 /* see instructions below for how to generate thsese files */
 
-#define DEFAULT_RAW_DIR       "../../raw"
+#define DEFAULT_FADING_DIR    ""
 #define MPG_FADING_FILE_NAME  "slow_fading_samples.float"
 #define MPP_FADING_FILE_NAME  "fast_fading_samples.float"
 #define MPD_FADING_FILE_NAME  "faster_fading_samples.float"
@@ -80,7 +80,7 @@ COMP noise(void) {
 int main(int argc, char *argv[])
 {
     FILE          *fin, *ffading, *fout;
-    char	        *raw_dir;
+    char	        *fading_dir;
     float          NodB, foff_hz;
     int            fading_en, nhfdelay;
 
@@ -119,7 +119,7 @@ int main(int argc, char *argv[])
         Fs = COHPSK_FS; foff_hz = 0.0; fading_en = 0; ctest = 0;
         clip =32767; gain = 1.0;
         ssbfilt_en = 1; complex_out = 0;
-        raw_dir = strdup(DEFAULT_RAW_DIR); user_multipath_delay = -1.0;
+        fading_dir = strdup(DEFAULT_FADING_DIR); user_multipath_delay = -1.0;
 
         for(int i=4; i<argc; i++) {
             if (!strcmp(argv[i],"--Fs")) { Fs = atoi(argv[i+1]); i++; }
@@ -133,8 +133,8 @@ int main(int argc, char *argv[])
             else if (!strcmp(argv[i], "--complexout")) complex_out = 1;
             else if (!strcmp(argv[i], "--ctest")) ctest = 1;
             else if (!strcmp(argv[i], "--multipath_delay")) { user_multipath_delay = atof(argv[i+1]); i++; }
-            else if (!strcmp(argv[i], "--raw_dir")) {
-                FREE(raw_dir); raw_dir = strdup(argv[i+1]); i++;
+            else if (!strcmp(argv[i], "--fading_dir")) {
+                FREE(fading_dir); fading_dir = strdup(argv[i+1]); i++;
             } else {
                 fprintf(stderr, "Unknown argument: %s\n", argv[i]);
                 exit(1);
@@ -143,7 +143,7 @@ int main(int argc, char *argv[])
     }
     else {
         fprintf(stderr, "usage: %s InputRealModemRawFile OutputRealModemRawFile No(dB/Hz) [--Fs SampleRateHz]"
-                        " [-f FoffHz] [--mpg] [--mpp] [--mpd] [--clip 0to1] [--ssbfilt 0|1] [--raw_dir Path]"
+                        " [-f FoffHz] [--mpg] [--mpp] [--mpd] [--clip 0to1] [--ssbfilt 0|1] [--fading_dir Path]"
                         " [--complexout] [--mulipath_delay ms]\n", argv[0]);
         exit(1);
     }
@@ -152,7 +152,7 @@ int main(int argc, char *argv[])
 
     /*  N = var = NoFs */
 
-    // arbitrary nise scaling, to maintain backwards compatability with many tests.  TODO make the No
+    // arbitrary noise scaling, to maintain backwards compatability with many tests.  TODO make the No
     // units more sensible, and fix all the tests that depend on this scaling
     No = pow(10.0, NodB/10.0)*1000*1000;
     variance = Fs*No;
@@ -169,35 +169,35 @@ int main(int argc, char *argv[])
         char fname[256];
 
         if (fading_en == 1) {
-	          sprintf(fname, "%s/%s", raw_dir, MPG_FADING_FILE_NAME);
+            sprintf(fname, "%s/%s", fading_dir, MPG_FADING_FILE_NAME);
             ffading = fopen(fname, "rb");
             if (ffading == NULL) {
             cant_load_fading_file:
                 fprintf(stderr, "-----------------------------------------------------\n");
                 fprintf(stderr, "cohpsk_ch ERROR: Can't find fading file: %s\n", fname);
-                fprintf(stderr, "\nAdjust path --raw_dir or use GNU Octave to generate:\n\n");
+                fprintf(stderr, "\nAdjust path --fading_dir or use GNU Octave to generate:\n\n");
             gen_fading_file:
                 fprintf(stderr, "$ octave --no-gui\n");
                 fprintf(stderr, "octave:24> pkg load signal\n");
                 fprintf(stderr, "octave:24> time_secs=60\n");
-                fprintf(stderr, "octave:25> cohpsk_ch_fading(\"../raw/faster_fading_samples.float\", 8000, 2.0, 8000*time_secs)\n");
-                fprintf(stderr, "octave:26> cohpsk_ch_fading(\"../raw/fast_fading_samples.float\", 8000, 1.0, 8000*time_secs)\n");
-                fprintf(stderr, "octave:27> cohpsk_ch_fading(\"../raw/slow_fading_samples.float\", 8000, 0.1, 8000*time_secs)\n");
+                fprintf(stderr, "octave:25> cohpsk_ch_fading(\"faster_fading_samples.float\", 8000, 2.0, 8000*time_secs)\n");
+                fprintf(stderr, "octave:26> cohpsk_ch_fading(\"fast_fading_samples.float\", 8000, 1.0, 8000*time_secs)\n");
+                fprintf(stderr, "octave:27> cohpsk_ch_fading(\"slow_fading_samples.float\", 8000, 0.1, 8000*time_secs)\n");
                 fprintf(stderr, "-----------------------------------------------------\n");
                 exit(1);
             }
             nhfdelay = floor(MPG_DELAY_MS*Fs/1000);
         }
 
         if (fading_en == 2) {
-	          sprintf(fname, "%s/%s", raw_dir, MPP_FADING_FILE_NAME);
+            sprintf(fname, "%s/%s", fading_dir, MPP_FADING_FILE_NAME);
             ffading = fopen(fname, "rb");
             if (ffading == NULL) goto cant_load_fading_file;
             nhfdelay = floor(MPP_DELAY_MS*Fs/1000);
         }
 
         if (fading_en == 3) {
-	          sprintf(fname, "%s/%s", raw_dir, MPD_FADING_FILE_NAME);
+	          sprintf(fname, "%s/%s", fading_dir, MPD_FADING_FILE_NAME);
             ffading = fopen(fname, "rb");
             if (ffading == NULL) goto cant_load_fading_file;
             nhfdelay = floor(MPD_DELAY_MS*Fs/1000);

unittest/CMakeLists.txt

@@ -107,12 +107,12 @@ ExternalProject_Add(cml
 )
 
 # Create fading files (used for channel simulation) as part of unit test setup
-add_custom_target(fade_files ALL
+add_custom_target(fading_files ALL
   DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/fast_fading_samples.float
   DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/faster_fading_samples.float
   )
 add_custom_command(
   OUTPUT  ${CMAKE_CURRENT_BINARY_DIR}/fast_fading_samples.float
   OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/faster_fading_samples.float
-  COMMAND cd ${CMAKE_CURRENT_SOURCE_DIR} && ./fade_files.sh ${CMAKE_CURRENT_BINARY_DIR}
+  COMMAND cd ${CMAKE_CURRENT_SOURCE_DIR} && ./fading_files.sh ${CMAKE_CURRENT_BINARY_DIR}
 )

unittest/fade_files.sh unittest/fading_files.shunittest/fade_files.sh renamed to unittest/fading_files.sh

@@ -31,7 +31,7 @@ if [[ $p1 -eq 1 && $p2 -eq 1 ]]; then echo "OK"; else echo "BAD"; PASS=0; fi
 echo
 echo "Simple test, plain, AWGN"
 OFDM_MOD --in /dev/zero --testframes 100 |
-    cohpsk_ch - - -20 -Fs 8000 -f -5 --raw_dir ../../raw |
+    cohpsk_ch - - -20 -Fs 8000 -f -5  |
     OFDM_DEMOD --out /dev/null --testframes --verbose 1 2>tmp
 cat tmp
 n=$(grep '^BER\.*:' tmp | cut -d ' ' -f 2)
@@ -54,7 +54,7 @@ if [[ $p1 -eq 1 && $p2 -eq 1 ]]; then echo "OK"; else echo "BAD"; PASS=0; fi
 echo
 echo "Simple test, LDPC, AWGN"
 OFDM_MOD --in /dev/zero --ldpc --testframes 100 |
-    cohpsk_ch - - -20 -Fs 8000 -f -5 --raw_dir ../../raw |
+    cohpsk_ch - - -20 -Fs 8000 -f -5 --fading_dir ../../build_linux/unittest |
     OFDM_DEMOD --out /dev/null --ldpc --testframes --verbose 1 2>tmp
 cat tmp
 n=$(grep '^BER\.*:' tmp | cut -d ' ' -f 2)

unittest/ofdm_check

@@ -4,9 +4,9 @@
 # Tests 700D OFDM modem fading channel performance, using a simulated channel
 
 results=$(mktemp)
-fade_dir=$1
+fading_dir=$1
 # BER should be around 4% for this test (it's better for larger interleavers but no one uses interleaving in practice)
-ofdm_mod --in /dev/zero --ldpc 1 --testframes 60 --txbpf | cohpsk_ch - - -24 --Fs 8000 -f -10 --mpp --raw_dir $fade_dir | ofdm_demod --out /dev/null --testframes --verbose 2 --ldpc 1 2> $results
+ofdm_mod --in /dev/zero --ldpc 1 --testframes 60 --txbpf | cohpsk_ch - - -24 --Fs 8000 -f -10 --mpp --fading_dir $fading_dir | ofdm_demod --out /dev/null --testframes --verbose 2 --ldpc 1 2> $results
 cat $results
 cber=$(cat $results | sed -n "s/^Coded BER.* \([0-9..]*\) Tbits.*/\1/p")
 python3 -c "import sys; sys.exit(0) if $cber<=0.05 else sys.exit(1)"

unittest/ofdm_fade.sh

@@ -3,12 +3,12 @@
 # David Sep 2019
 # Tests 2020 OFDM modem fading channel performance in DPSK mode, using a simulated faster (2Hz) high SNR fading channel
 
-RAW=$1
+fading_dir=$1
 results=$(mktemp)
 
 # Coded BER should be < 1% for this test
 ofdm_mod --in /dev/zero --testframes 300 --mode 2020 --ldpc --verbose 1 -p 312 --dpsk | \
-cohpsk_ch - - -40 --Fs 8000 -f 10 --ssbfilt 1 --mpd --raw_dir $RAW --multipath_delay 2 | \
+cohpsk_ch - - -40 --Fs 8000 -f 10 --ssbfilt 1 --mpd --fading_dir $fading_dir --multipath_delay 2 | \
 ofdm_demod --out /dev/null --testframes --mode 2020 --verbose 1 --ldpc -p 312 --dpsk 2> $results
 cat $results
 cber=$(cat $results | sed -n "s/^Coded BER.* \([0-9..]*\) Tbits.*/\1/p")

unittest/ofdm_fade_dpsk.sh

@@ -14,10 +14,10 @@
 #   $ PATH=$PATH:../build_linux/src ./ofdm_phase_est_bw.sh
 
 results=$(mktemp)
-fade_dir=$1
+fading_dir=$1
 # BER should be < 5% for this test
 ofdm_mod --in /dev/zero --testframes 300 --mode 2020 --ldpc -p 312 --verbose 0 | \
-cohpsk_ch - - -40 --Fs 8000 -f 10 --ssbfilt 1 --mpp --raw_dir $fade_dir | \
+cohpsk_ch - - -40 --Fs 8000 -f 10 --ssbfilt 1 --mpp --fading_dir $fading_dir | \
 ofdm_demod --out /dev/null --testframes --mode 2020 --verbose 2 --ldpc -p 312 --bandwidth 1 2> $results
 cat $results
 cber=$(cat $results | sed -n "s/^Coded BER.* \([0-9..]*\) Tbits.*/\1/p")

unittest/ofdm_phase_est_bw.sh

@@ -8,7 +8,7 @@ snr=$2
 min_text_packets=$3
 clip=$4
 build_folder=$5
-fade_dir=${build_folder}/../unittest
+fading_dir=${build_folder}/../unittest
 rx=$build_folder/freedv_rx
 tx=$build_folder/freedv_tx
 
@@ -18,7 +18,7 @@ else
     clip_args=
 fi
 
-$tx $mode ../raw/ve9qrp.raw - --reliabletext AB1CDEF $clip_args | $build_folder/cohpsk_ch - - $snr --mpp --Fs 8000 -f -5 --raw_dir $fade_dir > $results/reliable_fade.raw 
+$tx $mode ../raw/ve9qrp.raw - --reliabletext AB1CDEF $clip_args | $build_folder/cohpsk_ch - - $snr --mpp --Fs 8000 -f -5 --fading_dir $fading_dir > $results/reliable_fade.raw 
 $rx $mode $results/reliable_fade.raw /dev/null --txtrx $results/reliable_fade.txt --reliabletext
 if [ `cat $results/reliable_fade.txt | wc -l` -ge $min_text_packets ]; then
     exit 0