Merge branch 'hotfix-2.0.0-rc6' of bitbucket.org:k1jt/wsjtx into hotfix-2.0.0-rc6

doc/user_guide/en/decoder_notes.adoc

@@ -8,9 +8,9 @@ false decodes.
 
 For example: when you decide to answer a CQ, you already know your own
 callsign and that of your potential QSO partner.  The software
-therefore "`knows`" what to expect for 57 of the 72 message bits (28
+therefore "`knows`" what might be expected for at least 57 message
-bits for each of two callsigns, 1 bit for message type) in the next
+bits (28 for each of two callsigns, 1 or more for message type) in the
-received message.  The decoder's task can thus be reduced to
+next received message.  The decoder's task can thus be reduced to
 determining the remaining 15 bits of the message and ensuring that the
 resulting solution is reliable.
 

doc/user_guide/en/introduction.adoc

@@ -7,7 +7,7 @@ K1**JT**,`" while the suffix "`-X`" indicates that _WSJT-X_ started as
 an extended and experimental branch of the program
 _WSJT_.
 
-_WSJT-X_ Version 1.9 offers nine different protocols or modes: *FT8*,
+_WSJT-X_ Version 2.0 offers nine different protocols or modes: *FT8*,
 *JT4*, *JT9*, *JT65*, *QRA64*, *ISCAT*, *MSK144*, *WSPR*, and *Echo*.
 The first five are designed for making reliable QSOs under extreme
 weak-signal conditions. They use nearly identical message structure
@@ -47,7 +47,7 @@ format with hashed callsigns.
 potential propagation paths using low-power transmissions. WSPR
 messages normally carry the transmitting station’s callsign, grid
 locator, and transmitter power in dBm, and they can be decoded at
-signal-to-noise ratios as low as -28 dB in a 2500 Hz bandwidth.  WSPR
+signal-to-noise ratios as low as -31 dB in a 2500 Hz bandwidth.  WSPR
 users with internet access can automatically upload reception
 reports to a central database called {wsprnet} that provides a mapping
 facility, archival storage, and many other features.

doc/user_guide/en/logging.adoc

@@ -18,17 +18,8 @@ this option is checked _WSJT-X_ appends some additional information to
 all CQ messages displayed in the _Band Activity_ window.  The name of
 the DXCC entity is shown, abbreviated if necessary.  Your "`worked
 before`" status for this callsign (according to log file
-`wsjtx_log.adi`) is flagged with a single character and a change of
+`wsjtx_log.adi`) is indicated by highlighting colors, if that option
-background color, as follows:
+has been selected.
-
-[horizontal]
-!::  Default color bright purple: New DXCC entity
-~::  Light pink: You have already worked this DXCC entity but not 
-this station
- ::  Green: You have previously worked the calling station
-
-In this respect the program does not distinguish between modes, but it
-does differentiate between bands.
 
 _WSJT-X_ includes a built-in `cty.dat` file containing DXCC prefix
 information.  Updated files can be downloaded from the {cty_dat} web
@@ -45,3 +36,5 @@ before status* off and then on again will cause _WSJT-X_ to re-read
 the log file.  Very large log files may cause _WSJT-X_ to slow down
 when searching for calls.
 
+Additional features are provided for *Contest* and *Fox* logging.
+(more to come, here ...)

doc/user_guide/en/make-qso.adoc

@@ -19,7 +19,10 @@ one callsign) followed by the transmitting station’s grid locator, a
 signal report, R plus a signal report, or the final acknowledgements
 RRR or 73.  These messages are compressed and encoded in a highly
 efficient and reliable way.  In uncompressed form (as displayed
-on-screen) they may contain as many as 22 characters.
+on-screen) they may contain as many as 22 characters.  Some operators
+prefer ro send RR73 rather than RRR.  This is workable because RR73 is
+encoded as a valid grid locator, one unlikely ever to be occupied by
+an amateur station.
 
 *Signal reports* are specified as signal-to-noise ratio (S/N) in dB,
 using a standard reference noise bandwidth of 2500 Hz.  Thus, in the
@@ -76,36 +79,92 @@ NOTE: When *Auto-Seq* is enabled the program de-activates *Enable Tx*
 at the end of each QSO.  It is not intended that _WSJT-X_ should make
 fully automated QSOs.
 
-=== VHF Contest Mode
+=== Contest Messages
 
-A special *NA VHF Contest* mode can be activated for FT8 and MSK144.
+The new FT8 and MSK144 protocols support special messages optimized
-To use it you must activate *File | Settings | General | Enable
+for *NA VHF* and *EU VHF* contests. FT8 also supports messages for
-VHF/UHF/Microwave features* and then check the box *NA VHF Contest* on
+*ARRL Field Day* and the *ARRL RTTY Roundup*.  The decoders recognize
-the main window.  This mode is configured especially for contests in
+and decode these messages at any time.  Configure the program to
-which four-character grid locators are the required exchange.  When
+automatically generate the required message types by selecting a
-*NA VHF Contest* mode is active, the standard QSO sequence looks like
+supported operating activity on the *Settings | Advanced* tab.  Model
-this:
+QSOs then proceed as follows, for each event type:
+
+*NA VHF Contest*
 
  CQ K1ABC FN42
-                      K1ABC W9XYZ EN37
+                       K1ABC W9XYZ EN37
  W9XYZ K1ABC R FN42
-                      K1ABC W9XYZ RRR
+                       K1ABC W9XYZ RRR
  W9XYZ K1ABC 73
 
-In contest circumstances K1ABC might choose to call CQ again rather
+Either callsign (or both) may have /R appended.  You can use RR73 in
-than sending 73 for his third transmission.
+place of RRR, and the final 73 is optional.
 
-IMPORTANT: Do not use VHF Contest Mode on an HF band or in conditions
+
-where worldwide propagation is available.  See
+*EU VHF Contest*
-<<PROTOCOL_OVERVIEW,Protocol Specifications>> for further details.
+
+ CQ TEST G4ABC IO91
+                       G4ABC PA9XYZ JO22
+ PA9XYZ 570123 IO91NP
+                       G4ABC R 580071 JO22DB
+ PA9XYZ G4ABC RR73
+
+Either callsign (or both) may have /P appended.
+
+*ARRL Field Day*
+
+ CQ FD K1ABC FN42
+                       K1ABC W9XYZ 6A WI
+ W9XYZ K1ABC R 2B EMA
+                       K1ABC W9XYZ RR73
+
+*ARRL RTTY Roundup*
+
+ CQ RU K1ABC FN42
+                       K1ABC W9XYZ 579 WI
+ W9XYZ K1ABC R 589 MA
+                       K1ABC W9XYZ RR73
 
 [[COMP-CALL]] 
 === Compound Callsigns
 
-Compound callsigns such as xx/K1ABC or K1ABC/x are handled in
+*FT8 and MSK144*
-one of two possible ways:
 
-.Messages containing Type 1 compound callsigns
+Compound callsigns like xx/K1ABC or K1ABC/x and nonstandard callsigns
+like YW18FIFA are supported for normal QSOs but not for the special
+contest-style messages.  Model QSOs look something like this:
+
+ CQ PJ4/K1ABC
+                       <PJ4/K1ABC> W9XYZ
+ W9XYZ <PJ4/K1ABC> +03
+                       <PJ4/K1ABC> W9XYZ R-08
+ <W9XYZ> PJ4/K1ABC RRR
+                       PJ4/K1ABC <W9XYZ> 73
+
+The compound or nonstandard callsigns are automatically recognized and
+handled using special message formats.  One such callsign and one
+standard callsign may appear in most messages, provided that one of
+them is enclosed in <  > angle brackets.  If the message includes a
+grid locator or numerical signal report, the brackets must enclose the
+compound or nonstandard callsign; otherwise the brackets may be around
+either call.
+
+Angle brackets imply that the enclosed callsign is not transmitted in
+full, but rather as a hash code using a smaller number of bits.
+Receiving stations will display the full nonstandard callsign if it
+has been received in full in the recent past.  Otherwise it will be
+displayed as < . . . >.  These restrictions are honored automatically
+by the algorithm that generates default messages for minimal QSOs.
+Except for the special cases involving /P or /R used in VHF
+contesting, _WSJT-X 2.0_ offers no support for two nonstandard
+callsigns to work each other.
+
+*JT4, JT9, JT65, and QRA64*
+
+In the 72-bit modes, compound callsigns are handled in one of two
+possible ways:
+
+.Type 1 compound callsigns
 
 A list of about 350 of the most common prefixes and suffixes can be
 displayed from the *Help* menu.  A single compound callsign involving
@@ -139,7 +198,7 @@ Notice that the full compound callsign is sent and received in the
 first two transmissions.  After that, the operators omit the add-on
 prefix or suffix and use the standard structured messages.
 
-.Type 2 Compound-Callsign Messages
+.Type 2 Compound callsigns
 
 Prefixes and suffixes _not_ found in the displayable short list are
 handled by using *Type 2* compound callsigns.  In this case the

doc/user_guide/en/new_features.adoc

@@ -1,33 +1,38 @@
-=== New in Version 1.9
+=== New in Version 2.0
 
 For quick reference, here's a short list of features and capabilities
-added to _WSJT-X_ since Version 1.8.0:
+added to _WSJT-X_ since Version 1.9.1:
 
-- New *FT8 DXpedition Mode* to facilitate high QSO rates in pileup
+- New FT8 and MSK144 protocols with 77-bit payloads permit these enhancements:
-situations
 
-- Decoding improvements for JT65 mode, including _a priori_ (AP)
+* Optimized contest messages for NA VHF, EU VHF, Field Day, RTTY Roundup
-decoding when VHF/UHF/Microwave features are enabled
 
-- Optional Auto-Sequencing in JT4, JT9, and JT65 when VHF/UHF/Microwave features are enabled
+* Full support for "/R" and "/P" calls in relevant contests
 
-- Better suppression of low-confidence false decodes generated by AP
+* New logging features for contesting
-decoding in FT8 mode
 
-- Improved decoding performance for WSPR mode, especially effective at LF and MF
+* Integration with N1MM+ and WriteLog for contesting
 
-- Minor adjustments to auto-sequencing behavior
+* IMproved support for compound and nonstandard callsigns
 
-- More flexible Doppler control features for EME
+* Nearly equal (or better) sensitivity compared to old protocols
 
-- Improved waterfall sensitivity for very weak signals
+* Lower false decode rates
 
-- Automatic real-time forwarding of logged information to _N1MM Logger+_
+- Improved color highlighting of received messages
+
+- Improved WSPR sensitivity
 
 - Expanded and improved UDP messages sent to companion programs
 
 - Bug fixes and other minor tweaks to user interface
 
+IMPORTANT: Note that for FT8 and MSK144 there is no backward
+compatibility with WSJT-X 1.9.1 and earlier.  Everyone using these
+modes should upgrade to WSJT-X 2.0 by January 1, 2019.
+
+
+
 === Documentation Conventions
 
 In this manual the following icons call attention to particular types
@@ -48,9 +53,9 @@ _WSJT-X_ is part of an open-source project released under the
 {gnu_gpl} (GPL). If you have programming or documentation skills or
 would like to contribute to the project in other ways, please make
 your interests known to the development team.  The project's
-source-code repository can be found at {devsvn}, and most
+source-code repository can be found at {devsvn}, and communication
-communication among the developers takes place on the email reflector
+among the developers takes place on the email reflector {devmail}.
-{devmail}.  Bug reports and suggestions for new features, improvements
+Bug reports and suggestions for new features, improvements to the
-to the _WSJT-X_ User Guide, etc., may also be sent to the
+_WSJT-X_ User Guide, etc., may also be sent to the {wsjt_yahoo_group}
-{wsjt_yahoo_group} email reflector.  You must join the relevant group
+email reflector.  You must join the relevant group before posting to
-before posting to either email list.
+either email list.

doc/user_guide/en/protocols.adoc

@@ -2,18 +2,20 @@
 === Overview
 
 All QSO modes except ISCAT use structured messages that compress
-user-readable information into fixed-length packets of 72 bits.  Each
+user-readable information into fixed-length packets.  JT4, JT9, JT65,
-message consists of two 28-bit fields normally used for callsigns and
+and QRA64 use 72-bit payloads.  Standard messages consist of two
-a 15-bit field for a grid locator, report, acknowledgment, or 73.  An
+28-bit fields normally used for callsigns and a 15-bit field for a
-additional bit flags a message containing arbitrary alphanumeric text,
+grid locator, report, acknowledgment, or 73.  An additional bit flags
-up to 13 characters.  Special cases allow other information such as
+a message containing arbitrary free text, up to 13 characters.
-add-on callsign prefixes (e.g., ZA/K1ABC) or suffixes (e.g., K1ABC/P)
+Special cases allow other information such as add-on callsign prefixes
-to be encoded. The basic aim is to compress the most common messages
+(e.g., ZA/K1ABC) or suffixes (e.g., K1ABC/P) to be encoded. The basic
-used for minimally valid QSOs into a fixed 72-bit length.  The
+aim is to compress the most common messages used for minimally valid
-information payload in FT8 includes 3 additional bits (75 bits total).
+QSOs into a fixed 72-bit length.
-One of the added bits is used to flag special messages used by the
+
-DXpedition station in FT8 DXpedition Mode.  Uses for the remaining two
+The information payload for FT8 and MSK144 contains 77 bits.  The 5
-bits are yet to be defined.
+additional bits are used to flag special message types used for FT8
+DXpedition Mode, contesting, nonstandard callsigns, and a few other
+special types.
 
 A standard amateur callsign consists of a one- or two-character
 prefix, at least one of which must be a letter, followed by a digit
@@ -42,22 +44,16 @@ additional information is sent in place of the grid locator or by
 encoding additional information into some of the 6 million available
 slots mentioned above.
 
-As a convenience for sending directed CQ messages, the compression
+As a convenience for sending directed CQ messages, the 72-bit
-algorithm supports messages starting with `CQ AA` through `CQ ZZ`.
+compression algorithm supports messages starting with `CQ AA` through
-These message fragments are encoded internally as if they were the
+`CQ ZZ`.  These message fragments are encoded internally as if they
-callsigns `E9AA` through `E9ZZ`.  Upon reception they are converted
+were the callsigns `E9AA` through `E9ZZ`.  Upon reception they are
-back to the form `CQ AA` through `CQ ZZ`, for display to the user.
+converted back to the form `CQ AA` through `CQ ZZ`, for display to the
+user.
 
-The FT8 and MSK144 modes support a special feature allowing convenient
+The new FT8 and MSK144 protocols use a different lossless compression
-transmission and acknowledgment of four-character grid locators, the
+algorithm with features to generate and recognize the special messages
-required exchanges in most North American VHF contests.  With this
+used for contesting and the like.  (More to come, here ...)
-Contest Mode enabled, _WSJT-X_ supports messages of the form `W9XYZ
-K1ABC R FN42` by converting the grid locator to that of its
-diametrically opposite point on Earth.  The receiving program
-recognizes a locator implying a distance greater than 10,000 km, does
-the reverse transformation, and inserts the implied "`R`".  Obviously,
-this mode should not be used on the HF bands or under other
-circumstances where world-wide propagation is possible.
 
 To be useful on channels with low signal-to-noise ratio, this kind of
 lossless message compression requires use of a strong forward error
@@ -75,9 +71,9 @@ _WSJT-X_ modes have continuous phase and constant envelope.
 ==== FT8
 
 Forward error correction (FEC) in FT8 uses a low-density parity check
-(LDPC) code with 75 information bits, a 12-bit cyclic redundancy check
+(LDPC) code with 77 information bits, a 14-bit cyclic redundancy check
-(CRC), and 87 parity bits making a 174-bit codeword.  It is thus
+(CRC), and 83 parity bits making a 174-bit codeword.  It is thus
-called an LDPC (174,87) code.  Synchronization uses 7×7 Costas arrays
+called an LDPC (174,91) code.  Synchronization uses 7×7 Costas arrays
 at the beginning, middle, and end of each transmission.  Modulation is
 8-tone frequency-shift keying (8-FSK) at 12000/1920 = 6.25 baud.  Each
 transmitted symbol carries three bits, so the total number of channel
@@ -231,7 +227,7 @@ which the probability of decoding is 50% or higher.
 |===============================================================================
 |Mode |FEC Type |(n,k) | Q|Modulation type|Keying rate (Baud)|Bandwidth (Hz)
 |Sync Energy|Tx Duration (s)|S/N Threshold (dB)
-|FT8  |LDPC, r=1/2|(174,87)| 8| 8-FSK| 6.25 | 50.0 | 0.27| 12.6 | -21
+|FT8  |LDPC, r=1/2|(174,91)| 8| 8-FSK| 6.25 | 50.0 | 0.27| 12.6 | -21
 |JT4A |K=32, r=1/2|(206,72)| 2| 4-FSK| 4.375| 17.5 | 0.50| 47.1 | -23
 |JT9A |K=32, r=1/2|(206,72)| 8| 9-FSK| 1.736| 15.6 | 0.19| 49.0 | -27
 |JT65A |Reed Solomon|(63,12) |64|65-FSK| 2.692| 177.6 | 0.50| 46.8 | -25
@@ -329,13 +325,13 @@ For details see Table 4, below.
 
 ==== MSK144
 
-Standard MSK144 messages are structured in the same way as those in
+Standard MSK144 messages are structured in the same way as in FT8,
-the slow modes, with 72 bits of user information.  Forward error
+with 77 bits of user information.  Forward error correction is
-correction is implemented by first augmenting the 72 message bits with
+implemented by first augmenting the 77 message bits with a 13-bit
-an 8-bit cyclic redundancy check (CRC) calculated from the message
+cyclic redundancy check (CRC) calculated from the message bits. The
-bits. The CRC is used to detect and eliminate most false decodes at
+CRC is used to detect and eliminate most false decodes at the
-the receiver. The resulting 80-bit augmented message is mapped to a
+receiver. The resulting 90-bit augmented message is mapped to a
-128-bit codeword using a (128,80) binary low-density-parity-check
+128-bit codeword using a (128,90) binary low-density-parity-check
 (LDPC) code designed by K9AN specifically for this purpose.  Two 8-bit
 synchronizing sequences are added to make a message frame 144 bits
 long.  Modulation is Offset Quadrature Phase-Shift Keying (OQPSK) at
@@ -379,6 +375,6 @@ and your QSO partner ± 200 Hz.
 |JT9F     |K=32, r=1/2|(206,72)| 8| 9-FSK| 50.0 |  450  | 0.19| 1.700 
 |JT9G     |K=32, r=1/2|(206,72)| 8| 9-FSK|100.0 |  900  | 0.19| 0.850 
 |JT9H     |K=32, r=1/2|(206,72)| 8| 9-FSK|200.0 | 1800  | 0.19| 0.425 
-|MSK144   |LDPC       |(128,80)| 2| OQPSK| 2000 | 2400  | 0.11| 0.072 
+|MSK144   |LDPC       |(128,90)| 2| OQPSK| 2000 | 2400  | 0.11| 0.072 
 |MSK144 Sh|LDPC       |(32,16) | 2| OQPSK| 2000 | 2400  | 0.20| 0.020 
 |=====================================================================

doc/user_guide/en/settings-advanced.adoc

@@ -36,9 +36,16 @@ with twice or four times the normal tone spacing.  This feature is
 intended for use with specialized LF/MF transmitters that divide
 generated frequencies by 2 or 4 as part of the transmission process.
 
-_FT8 DXpedition Mode_
+_Special Operating Activity: Generation of FT8 and MSk144 messages_
+
+- Check this box and select the type of activity to enable
+auto-generation of special message formats for contesting and
+DXpeditions.  For *ARRL Field Day*, enter your operating Class and
+ARRL/RAC section; for *ARRL RTTY Roundup*, enter your state or province.
+Use “DX” for section or state if you are not in the US or Canada.  In
+the RTTY Roundup, Stations in Alaska and Hawaii should enter “DX”.
 
 - Check *Fox* if you are a DXpedition station operating in FT8
 DXpedition Mode.  Check *Hound* if you wish to make QSOs with such a
-Fox.  Be sure to read the operating instructions for  {ft8_DXped}.
+Fox.  Be sure to read the operating instructions for {ft8_DXped}.
 

doc/user_guide/en/settings-colors.adoc

@@ -1,5 +1,7 @@
 image::colors.png[align="center",alt="Colors Screen"]
 
 _WSJT-X_ uses colors to highlight decoded messages containing
-information of particular interest.  Click on one of the buttons to
+information of particular interest.  Check the box to select any
-select your preferred colors for any message category.
+that interest you.  Drag any line up or down to raise or lower
+its logical priority.  Right-click any line to select a new
+foreground or background color.

doc/user_guide/en/settings-general.adoc

@@ -17,6 +17,6 @@ NOTE: If you are using a callsign with an add-on prefix or
 suffix, or wish to work a station using such a call, be sure to read
 the section <<COMP-CALL,Compound Callsigns>>.
 
-NOTE: Enabling VHF/UHF/Microwave features necessarily disables the
+NOTE: Checking *Enable VHF/UHF/Microwave features* necessarily
-wideband multi-decode capability of JT65.  In most circumstances you
+disables the wideband multi-decode capability of JT65.  In most
-should turn this feature off when operating at HF.
+circumstances you should turn this feature off when operating at HF.

doc/user_guide/en/wsjtx-main.adoc

@@ -113,9 +113,12 @@ include::transceiver-setup.adoc[]
 This section introduces the basic user controls and program behavior
 of _WSJT-X_, with particular emphasis on the JT9, JT65, and FT8 modes.
 We suggest that new users should go through the full HF-oriented
-tutorial, preferably while at your radio.  Subsequent sections cover
+tutorial, preferably while at your radio.  Note that as of late 2018,
-additional details on <<MAKE_QSOS,Making QSOs>>, <<WSPR,WSPR mode>>
+digital usage on the HF bands has mostly moved from JT65 and JT9 to FT8.  So
-and <<VHF_AND_UP,VHF+ Features>>.
+you may wish to pay particular attention to *FT8*, in Section 6.6.
+
+Subsequent sections cover additional details on <<MAKE_QSOS,Making
+QSOs>>, <<WSPR,WSPR mode>> and <<VHF_AND_UP,VHF+ Features>>.
 
 [[TUT_MAIN]]
 === Main Window Settings

lib/sync4.f90

@@ -29,7 +29,7 @@ subroutine sync4(dat,jz,ntol,nfqso,mode,mode4,minwidth,dtx,dfx,snrx,    &
   df=0.5*11025.0/nfft
   ftop=nfqso + 7*mode4*df
   if(ftop.gt.11025.0/4.0) then
-     print*,'*** Rx Freq is set too high for this submode ***'
+     print*,'*** Rx Freq is set too high for this sybmode ***'
      go to 900
   endif
 
@@ -139,11 +139,8 @@ subroutine sync4(dat,jz,ntol,nfqso,mode,mode4,minwidth,dtx,dfx,snrx,    &
         ns=ns+1
      endif
   enddo
-  rms=0.1
+  rms=sqrt(sq/ns)
-  snrx=-26.0
+  snrx=10.0*log10(ccfred(ipk1a)/rms) - 41.2
-  if(ns.gt.0) rms=sqrt(sq/ns)
-  if(ccfred(ipk1a).gt.0.0) snrx=10.0*log10(ccfred(ipk1a)/rms) - 41.2
-  if(snrx.gt.50.0) snrx=50.0
 
 900  return
 end subroutine sync4