Fix macro define A0 in KA9Q lib that conflicts with common Arduino port def

Author: NT7S

COPYING

@@ -47,7 +47,6 @@ JTEncode::JTEncode(void)
  *  Ensure that you pass a uint8_t array of size JT65_SYMBOL_COUNT to the method.
  *
  */
-
 void JTEncode::jt65_encode(char * message, uint8_t * symbols)
 {
   // Ensure that the message text conforms to standards
@@ -88,7 +87,6 @@ void JTEncode::jt65_encode(char * message, uint8_t * symbols)
  *  Ensure that you pass a uint8_t array of size JT9_SYMBOL_COUNT to the method.
  *
  */
-
 void JTEncode::jt9_encode(char * message, uint8_t * symbols)
 {
   // Ensure that the message text conforms to standards
@@ -123,6 +121,44 @@ void JTEncode::jt9_encode(char * message, uint8_t * symbols)
   jt9_merge_sync_vector(a, symbols);
 }
 
+/*
+ * jt9_encode(char * message, uint8_t * symbols)
+ *
+ * Takes an arbitrary message of up to 13 allowable characters and returns
+ * a channel symbol table.
+ *
+ * message - Plaintext Type 6 message.
+ * symbols - Array of channel symbols to transmit retunred by the method.
+ *  Ensure that you pass a uint8_t array of size JT9_SYMBOL_COUNT to the method.
+ *
+ */
+void JTEncode::jt4_encode(char * message, uint8_t * symbols)
+{
+  // Ensure that the message text conforms to standards
+  // --------------------------------------------------
+  jt_message_prep(message);
+
+  // Bit packing
+  // -----------
+  uint8_t c[13];
+  jt9_bit_packing(message, c);
+
+  // Convolutional Encoding
+  // ---------------------
+  uint8_t s[JT4_SYMBOL_COUNT];
+  convolve(c, s, 13, JT4_BIT_COUNT);
+
+  // Interleaving
+  // ------------
+  jt9_interleave(s);
+  memmove(s + 1, s, JT4_BIT_COUNT);
+  s[0] = 0; // Append a 0 bit to start of sequence
+
+  // Merge with sync vector
+  // ----------------------
+  jt4_merge_sync_vector(s, symbols);
+}
+
 /*
  * wspr_encode(char * call, char * loc, uint8_t dbm, uint8_t * symbols)
  *
@@ -135,7 +171,6 @@ void JTEncode::jt9_encode(char * message, uint8_t * symbols)
  *  Ensure that you pass a uint8_t array of size WSPR_SYMBOL_COUNT to the method.
  *
  */
-
 void JTEncode::wspr_encode(char * call, char * loc, uint8_t dbm, uint8_t * symbols)
 {
     // Ensure that the message text conforms to standards
@@ -655,6 +690,27 @@ void JTEncode::jt9_merge_sync_vector(uint8_t * g, uint8_t * symbols)
   }
 }
 
+void JTEncode::jt4_merge_sync_vector(uint8_t * g, uint8_t * symbols)
+{
+  uint8_t i;
+  const uint8_t sync_vector[JT4_SYMBOL_COUNT] =
+	{0, 0, 0, 0, 1, 1, 0, 0, 0, 1, 1, 0, 1, 1, 0, 0, 1, 0, 1, 0, 0, 0,
+   0, 0, 0, 0, 1, 1, 0, 0, 0 ,0 ,0 ,0 ,0 ,0 ,0 ,0 ,0 ,0 ,1 ,0 ,1 ,1,
+   0, 1, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0, 1, 0, 0, 0, 1, 0, 0, 1, 0, 0,
+   1, 1, 1, 1, 1, 0, 0, 0, 1, 0, 1, 0, 0, 0, 1, 1, 1, 1, 0, 1, 1, 0,
+   0, 1, 0, 0, 0, 1, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 1, 1, 1, 1, 0,
+   1, 0, 1, 0, 1, 1, 0, 1, 0, 1, 0, 1, 1, 1, 0, 0, 1, 0, 1, 1, 0, 1,
+   1, 1, 1, 0, 0, 0, 0, 1, 1, 0, 1, 1, 0, 0, 0, 1, 1, 1, 0, 1, 1, 1,
+   0, 1, 1, 1, 0, 0, 1, 0, 0, 0, 1, 1, 0, 1, 1, 0, 0, 1, 0, 0, 0, 1,
+   1, 1, 1, 1, 1, 0, 0, 1, 1, 0, 0, 0, 0, 1, 1, 0, 0, 0, 1, 0, 1, 1,
+   0, 1, 1, 1, 1, 0, 1, 0, 1};
+
+	for(i = 0; i < JT4_SYMBOL_COUNT; i++)
+	{
+		symbols[i] = sync_vector[i] + (2 * g[i]);
+	}
+}
+
 void JTEncode::wspr_merge_sync_vector(uint8_t * g, uint8_t * symbols)
 {
   uint8_t i;

JTEncode.cpp

@@ -28,12 +28,14 @@
 
 #define JT65_SYMBOL_COUNT                   126
 #define JT9_SYMBOL_COUNT                    85
+#define JT4_SYMBOL_COUNT                    207
 #define WSPR_SYMBOL_COUNT                   162
 
 #define JT65_ENCODE_COUNT                   63
 #define JT9_ENCODE_COUNT                    69
 
 #define JT9_BIT_COUNT                       206
+#define JT4_BIT_COUNT                       206
 #define WSPR_BIT_COUNT                      162
 
 class JTEncode
@@ -42,6 +44,7 @@ class JTEncode
   JTEncode(void);
   void jt65_encode(char *, uint8_t *);
   void jt9_encode(char *, uint8_t *);
+  void jt4_encode(char *, uint8_t *);
   void wspr_encode(char *, char *, uint8_t, uint8_t *);
 private:
   uint8_t jt_code(char);
@@ -59,6 +62,7 @@ class JTEncode
   void jt_gray_code(uint8_t *, uint8_t);
   void jt65_merge_sync_vector(uint8_t *, uint8_t *);
   void jt9_merge_sync_vector(uint8_t *, uint8_t *);
+  void jt4_merge_sync_vector(uint8_t *, uint8_t *);
   void wspr_merge_sync_vector(uint8_t *, uint8_t *);
   void convolve(uint8_t *, uint8_t *, uint8_t, uint8_t);
   void rs_encode(uint8_t *, uint8_t *);

JTEncode.h

@@ -1,6 +1,6 @@
-JT65/JT9/WSPR Encoder Library for Arduino
-=========================================
-This library very simply generates a set of channel symbols for JT65, JT9, or WSPR based on the user providing a properly formatted Type 6 message for JT65 or JT9 (which is 13 valid characters) or a callsign, Maidenhead grid locator, and power output for WSPR. When paired with a synthesizer that can output frequencies in fine, phase-continuous tuning steps (such as the Si5351), then a beacon or telemetry transmitter can be created which can change the transmitted characters as needed from the Arduino.
+JT65/JT9/JT4/WSPR Encoder Library for Arduino
+=============================================
+This library very simply generates a set of channel symbols for JT65, JT9, JT4, or WSPR based on the user providing a properly formatted Type 6 message for JT65, JT9, or JT4 (which is 13 valid characters) or a callsign, Maidenhead grid locator, and power output for WSPR. When paired with a synthesizer that can output frequencies in fine, phase-continuous tuning steps (such as the Si5351), then a beacon or telemetry transmitter can be created which can change the transmitted characters as needed from the Arduino.
 
 Please feel free to use the issues feature of GitHub if you run into problems or have suggestions for important features to implement.
 
@@ -16,11 +16,11 @@ Include the JTEncode library into your instance of the Arduino IDE. Download a Z
 
 Example
 -------
-There is a simple example that is placed in your examples menu under JTEncode. Open this to see how to incorporate this library with your code. The example provided with with the library is meant to be used in conjuction with the [Etherkit Si5351A Breakout Board](https://www.etherkit.com/rf-modules/si5351a-breakout-board.html), although it could be modified to use with other synthesizers which meet the technical requirements of the JT65/JT9/WSPR modes.
+There is a simple example that is placed in your examples menu under JTEncode. Open this to see how to incorporate this library with your code. The example provided with with the library is meant to be used in conjuction with the [Etherkit Si5351A Breakout Board](https://www.etherkit.com/rf-modules/si5351a-breakout-board.html), although it could be modified to use with other synthesizers which meet the technical requirements of the JT65/JT9/JT4/WSPR modes.
 
 To run this example, be sure to download the [Si5351Arduino](https://github.com/etherkit/Si5351Arduino) library and follow the instructions there to connect the Si5351A Breakout Board to your Arduino. In order to trigger transmissions, you will also need to connect a momentary pushbutton from pin 12 of the Arduino to ground.
 
-The example sketch itself is fairly straightforward. JT65, JT9, and WSPR modes are modulated in same way: phase-continuous multiple-frequency shift keying (MFSK). The message to be transmitted is passed to the JTEncode method corresponding to the desired mode, along with a pointer to an array which holds the returned channel symbols. When the pushbutton is pushed, the sketch then transmits each channel symbol sequentially as an offset from the base frequency given in the sketch define section.
+The example sketch itself is fairly straightforward. JT65, JT9, JT4, and WSPR modes are modulated in same way: phase-continuous multiple-frequency shift keying (MFSK). The message to be transmitted is passed to the JTEncode method corresponding to the desired mode, along with a pointer to an array which holds the returned channel symbols. When the pushbutton is pushed, the sketch then transmits each channel symbol sequentially as an offset from the base frequency given in the sketch define section.
 
 An instance of the JTEncode object is created:
 
@@ -44,6 +44,12 @@ On sketch startup, the mode parameters are set based on which mode is currently
       symbol_count = JT65_SYMBOL_COUNT; // From the library defines
       tone_spacing = JT65_TONE_SPACING;
       break;
+    case MODE_JT4:
+      freq = JT4_DEFAULT_FREQ;
+      ctc = JT4_CTC;
+      symbol_count = JT4_SYMBOL_COUNT; // From the library defines
+      tone_spacing = JT4_TONE_SPACING;
+      break;
     case MODE_WSPR:
       freq = WSPR_DEFAULT_FREQ;
       ctc = WSPR_CTC;
@@ -65,12 +71,15 @@ During transmit, the proper class method is chosen based on the desired mode, th
     case MODE_JT65:
       jtencode.jt65_encode(message, tx_buffer);
       break;
+    case MODE_JT4:
+      jtencode.jt4_encode(message, tx_buffer);
+      break;
     case MODE_WSPR:
       jtencode.wspr_encode(call, loc, dbm, tx_buffer);
       break;
     }
 
-Once the channel symbols have been generate, it is a simple matter of transmitting them in sequence, each of the correct amount of time:
+Once the channel symbols have been generated, it is a simple matter of transmitting them in sequence, each the correct amount of time:
 
     // Now transmit the channel symbols
     for(i = 0; i < symbol_count; i++)
@@ -111,6 +120,21 @@ Public Methods
  */
 ```
 
+###jt4_encode()
+```
+/*
+ * jt4_encode(char * message, uint8_t * symbols)
+ *
+ * Takes an arbitrary message of up to 13 allowable characters and returns
+ * a channel symbol table.
+ *
+ * message - Plaintext Type 6 message.
+ * symbols - Array of channel symbols to transmit retunred by the method.
+ *  Ensure that you pass a uint8_t array of size JT4_SYMBOL_COUNT to the method.
+ *
+ */
+ ```
+
 ###wspr_encode()
 ```
 /*
@@ -132,8 +156,16 @@ Here are the defines, structs, and enumerations you will find handy to use with
 
 Defines:
 
-    JT65_SYMBOL_COUNT, JT9_SYMBOL_COUNT, WSPR_SYMBOL_COUNT
+    JT65_SYMBOL_COUNT, JT9_SYMBOL_COUNT, JT4_SYMBOL_COUNT, WSPR_SYMBOL_COUNT
 
 Acknowledgements
 ----------------
 Many thanks to Joe Taylor K1JT for his innovative work in amateur radio. We are lucky to have him. The algorithms in this program were derived from the source code in the [WSJT](http://sourceforge.net/projects/wsjt/) suite of applications. Also, many thanks for Andy Talbot G4JNT for [his paper](http://www.g4jnt.com/JTModesBcns.htm) on the WSPR coding protocol, which helped me to understand the WSPR encoding process, which in turn helped me to understand the related JT protocols.
+
+License
+-------
+JTEncode is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
+JTEncode is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with JTEncode.  If not, see <http://www.gnu.org/licenses/>.

README.md

@@ -38,8 +38,8 @@ void JTEncode::encode_rs_int(void *p, data_t *data, data_t *parity)
 {
   struct rs *rs = (struct rs *)p;
 
-  #undef A0
-  #define A0 (NN) /* Special reserved value encoding zero in index form */
+  #undef A_0
+  #define A_0 (NN) /* Special reserved value encoding zero in index form */
 
   {
     int i, j;
@@ -49,7 +49,7 @@ void JTEncode::encode_rs_int(void *p, data_t *data, data_t *parity)
 
     for(i=0;i<NN-NROOTS-PAD;i++){
       feedback = INDEX_OF[data[i] ^ parity[0]];
-      if(feedback != A0){      /* feedback term is non-zero */
+      if(feedback != A_0){      /* feedback term is non-zero */
   #ifdef UNNORMALIZED
         /* This line is unnecessary when GENPOLY[NROOTS] is unity, as it must
          * always be for the polynomials constructed by init_rs()
@@ -61,7 +61,7 @@ void JTEncode::encode_rs_int(void *p, data_t *data, data_t *parity)
       }
       /* Shift */
       memmove(&parity[0],&parity[1],sizeof(data_t)*(NROOTS-1));
-      if(feedback != A0)
+      if(feedback != A_0)
         parity[NROOTS-1] = ALPHA_TO[MODNN(feedback + GENPOLY[0])];
       else
         parity[NROOTS-1] = 0;