//
// This file is part of Dire Wolf, an amateur radio packet TNC.
//
// Copyright (C) 2011, 2012, 2013 John Langner, WB2OSZ
//
// This program 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 2 of the License, or
// (at your option) any later version.
//
// This program 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 this program. If not, see .
//
/*------------------------------------------------------------------
*
* Module: direwolf.c
*
* Purpose: Main program for "Dire Wolf" which includes:
*
* AFSK modem using the "sound card."
* AX.25 encoder/decoder.
* APRS data encoder / decoder.
* APRS digipeater.
* KISS TNC emulator.
* APRStt (touch tone input) gateway
* Internet Gateway (IGate)
*
*
*---------------------------------------------------------------*/
#include
#include
#include
#include
#include
#include
#include
#if __WIN32__
#else
#include
#include
#include
#include
#include
#include
#include
#include
#endif
#define DIREWOLF_C 1
#include "direwolf.h"
#include "version.h"
#include "audio.h"
#include "config.h"
#include "multi_modem.h"
#include "demod.h"
#include "hdlc_rec.h"
#include "hdlc_rec2.h"
#include "ax25_pad.h"
#include "decode_aprs.h"
#include "textcolor.h"
#include "server.h"
#include "kiss.h"
#include "kissnet.h"
#include "gen_tone.h"
#include "digipeater.h"
#include "tq.h"
#include "xmit.h"
#include "ptt.h"
#include "beacon.h"
#include "ax25_pad.h"
#include "redecode.h"
#include "dtmf.h"
#include "aprs_tt.h"
#include "tt_user.h"
#include "igate.h"
#include "symbols.h"
#include "dwgps.h"
#if __WIN32__
static BOOL cleanup_win (int);
#else
static void cleanup_linux (int);
#endif
static void usage (char **argv);
#if __SSE__
static void __cpuid(int cpuinfo[4], int infotype){
__asm__ __volatile__ (
"cpuid":
"=a" (cpuinfo[0]),
"=b" (cpuinfo[1]),
"=c" (cpuinfo[2]),
"=d" (cpuinfo[3]) :
"a" (infotype)
);
}
#endif
/*-------------------------------------------------------------------
*
* Name: main
*
* Purpose: Main program for packet radio virtual TNC.
*
* Inputs: Command line arguments.
* See usage message for details.
*
* Outputs: Decoded information is written to stdout.
*
* A socket and pseudo terminal are created for
* for communication with other applications.
*
*--------------------------------------------------------------------*/
static struct audio_s modem;
static int d_u_opt = 0; /* "-d u" command line option. */
int main (int argc, char *argv[])
{
int err;
int eof;
int j;
char config_file[100];
int xmit_calibrate_option = 0;
int enable_pseudo_terminal = 0;
struct digi_config_s digi_config;
struct tt_config_s tt_config;
struct igate_config_s igate_config;
struct misc_config_s misc_config;
int r_opt = 0, n_opt = 0, b_opt = 0, B_opt = 0, D_opt = 0; /* Command line options. */
char input_file[80];
int t_opt = 1; /* Text color option. */
#if __WIN32__
// Select UTF-8 code page for console output.
// http://msdn.microsoft.com/en-us/library/windows/desktop/ms686036(v=vs.85).aspx
// This is the default I see for windows terminal:
// >chcp
// Active code page: 437
//Restore on exit? oldcp = GetConsoleOutputCP();
SetConsoleOutputCP(CP_UTF8);
#elif __CYGWIN__
/*
* Without this, the ISO Latin 1 characters are displayed as gray boxes.
*/
//setenv ("LANG", "C.ISO-8859-1", 1);
#else
/*
* Default on Raspian & Ubuntu Linux is fine. Don't know about others.
*
* Should we look at LANG environment variable and issue a warning
* if it doesn't look something like en_US.UTF-8 ?
*/
#endif
/*
* Pre-scan the command line options for the text color option.
* We need to set this before any text output.
*/
t_opt = 1; /* 1 = normal, 0 = no text colors. */
for (j=1; j= 1) {
__cpuid (cpuinfo, 1);
//dw_printf ("debug: cpuinfo = %x, %x, %x, %x\n", cpuinfo[0], cpuinfo[1], cpuinfo[2], cpuinfo[3]);
if ( ! ( cpuinfo[3] & (1 << 25))) {
text_color_set(DW_COLOR_ERROR);
dw_printf ("------------------------------------------------------------------\n");
dw_printf ("This version requires a minimum of a Pentium 3 or equivalent.\n");
dw_printf ("If you are seeing this message, you are probably using a computer\n");
dw_printf ("from the previous century. See comments in Makefile.win for\n");
dw_printf ("information on how you can recompile it for use with your antique.\n");
dw_printf ("------------------------------------------------------------------\n");
}
}
text_color_set(DW_COLOR_INFO);
#endif
/*
* This has not been very well tested in 64 bit mode.
*/
#if 0
if (sizeof(int) != 4 || sizeof(long) != 4 || sizeof(char *) != 4) {
text_color_set(DW_COLOR_ERROR);
dw_printf ("------------------------------------------------------------------\n");
dw_printf ("This might not work properly when compiled for a 64 bit target.\n");
dw_printf ("It is recommended that you rebuild it with gcc -m32 option.\n");
dw_printf ("------------------------------------------------------------------\n");
}
#endif
/*
* Default location of configuration file is current directory.
* Can be overridden by -c command line option.
* TODO: Automatically search other places.
*/
strcpy (config_file, "direwolf.conf");
/*
* Look at command line options.
* So far, the only one is the configuration file location.
*/
strcpy (input_file, "");
while (1) {
int this_option_optind = optind ? optind : 1;
int option_index = 0;
int c;
static struct option long_options[] = {
{"future1", 1, 0, 0},
{"future2", 0, 0, 0},
{"future3", 1, 0, 'c'},
{0, 0, 0, 0}
};
/* ':' following option character means arg is required. */
c = getopt_long(argc, argv, "B:D:c:pxr:b:n:d:t:U",
long_options, &option_index);
if (c == -1)
break;
switch (c) {
case 0: /* possible future use */
text_color_set(DW_COLOR_DEBUG);
dw_printf("option %s", long_options[option_index].name);
if (optarg) {
dw_printf(" with arg %s", optarg);
}
dw_printf("\n");
break;
case 'c': /* -c for configuration file name */
strcpy (config_file, optarg);
break;
#if __WIN32__
#else
case 'p': /* -p enable pseudo terminal */
/* We want this to be off by default because it hangs */
/* eventually when nothing is reading from other side. */
enable_pseudo_terminal = 1;
break;
#endif
case 'B': /* -B baud rate and modem properties. */
B_opt = atoi(optarg);
if (B_opt < 100 || B_opt > 10000) {
text_color_set(DW_COLOR_ERROR);
dw_printf ("Use a more reasonable data baud rate in range of 100 - 10000.\n");
exit (EXIT_FAILURE);
}
break;
case 'D': /* -D decrease AFSK demodulator sample rate */
D_opt = atoi(optarg);
if (D_opt < 1 || D_opt > 8) {
text_color_set(DW_COLOR_ERROR);
dw_printf ("Crazy value of -D. \n");
exit (EXIT_FAILURE);
}
break;
case 'x': /* -x for transmit calibration tones. */
xmit_calibrate_option = 1;
break;
case 'r': /* -r audio samples/sec. e.g. 44100 */
r_opt = atoi(optarg);
if (r_opt < MIN_SAMPLES_PER_SEC || r_opt > MAX_SAMPLES_PER_SEC)
{
text_color_set(DW_COLOR_ERROR);
dw_printf("-r option, audio samples/sec, is out of range.\n");
r_opt = 0;
}
break;
case 'n': /* -n number of audio channels. 1 or 2. */
n_opt = atoi(optarg);
if (n_opt < 1 || n_opt > MAX_CHANS)
{
text_color_set(DW_COLOR_ERROR);
dw_printf("-n option, number of audio channels, is out of range.\n");
n_opt = 0;
}
break;
case 'b': /* -b bits per sample. 8 or 16. */
b_opt = atoi(optarg);
if (b_opt != 8 && b_opt != 16)
{
text_color_set(DW_COLOR_ERROR);
dw_printf("-b option, bits per sample, must be 8 or 16.\n");
b_opt = 0;
}
break;
case '?':
/* Unknown option message was already printed. */
usage (argv);
break;
case 'd': /* Set debug option. */
switch (optarg[0]) {
case 'a': server_set_debug(1); break;
case 'k': kiss_serial_set_debug (1); break;
case 'n': kiss_net_set_debug (1); break;
case 'u': d_u_opt = 1; break;
default: break;
}
break;
case 't': /* Was handled earlier. */
break;
case 'U': /* Print UTF-8 test and exit. */
dw_printf ("\n UTF-8 test string: ma%c%cana %c%c F%c%c%c%ce\n\n",
0xc3, 0xb1,
0xc2, 0xb0,
0xc3, 0xbc, 0xc3, 0x9f);
exit (0);
break;
default:
/* Should not be here. */
text_color_set(DW_COLOR_DEBUG);
dw_printf("?? getopt returned character code 0%o ??\n", c);
usage (argv);
}
} /* end while(1) for options */
if (optind < argc)
{
if (optind < argc - 1)
{
text_color_set(DW_COLOR_ERROR);
dw_printf ("Warning: File(s) beyond the first are ignored.\n");
}
strcpy (input_file, argv[optind]);
}
/*
* Get all types of configuration settings from configuration file.
*
* Possibly override some by command line options.
*/
symbols_init ();
config_init (config_file, &modem, &digi_config, &tt_config, &igate_config, &misc_config);
if (r_opt != 0) {
modem.samples_per_sec = r_opt;
}
if (n_opt != 0) {
modem.num_channels = n_opt;
}
if (b_opt != 0) {
modem.bits_per_sample = b_opt;
}
if (B_opt != 0) {
modem.baud[0] = B_opt;
if (modem.baud[0] < 600) {
modem.modem_type[0] = AFSK;
modem.mark_freq[0] = 1600;
modem.space_freq[0] = 1800;
modem.decimate[0] = 3;
}
else if (modem.baud[0] > 2400) {
modem.modem_type[0] = SCRAMBLE;
modem.mark_freq[0] = 0;
modem.space_freq[0] = 0;
}
else {
modem.modem_type[0] = AFSK;
modem.mark_freq[0] = 1200;
modem.space_freq[0] = 2200;
}
}
if (D_opt != 0) {
// Don't document. This will change.
modem.decimate[0] = D_opt;
}
misc_config.enable_kiss_pt = enable_pseudo_terminal;
if (strlen(input_file) > 0) {
strcpy (modem.adevice_in, input_file);
}
/*
* Open the audio source
* - soundcard
* - stdin
* - UDP
* Files not supported at this time.
* Can always "cat" the file and pipe it into stdin.
*/
err = audio_open (&modem);
if (err < 0) {
text_color_set(DW_COLOR_ERROR);
dw_printf ("Pointless to continue without audio device.\n");
SLEEP_SEC(5);
exit (1);
}
/*
* Initialize the AFSK demodulator and HDLC decoder.
*/
multi_modem_init (&modem);
/*
* Initialize the touch tone decoder & APRStt gateway.
*/
dtmf_init (modem.samples_per_sec);
aprs_tt_init (&tt_config);
tt_user_init (&tt_config);
/*
* Should there be an option for audio output level?
* Note: This is not the same as a volume control you would see on the screen.
* It is the range of the digital sound representation.
*/
gen_tone_init (&modem, 100);
assert (modem.bits_per_sample == 8 || modem.bits_per_sample == 16);
assert (modem.num_channels == 1 || modem.num_channels == 2);
assert (modem.samples_per_sec >= MIN_SAMPLES_PER_SEC && modem.samples_per_sec <= MAX_SAMPLES_PER_SEC);
/*
* Initialize the transmit queue.
*/
xmit_init (&modem);
/*
* If -x option specified, transmit alternating tones for transmitter
* audio level adjustment, up to 1 minute then quit.
* TODO: enhance for more than one channel.
*/
if (xmit_calibrate_option) {
int max_duration = 60; /* seconds */
int n = modem.baud[0] * max_duration;
int chan = 0;
text_color_set(DW_COLOR_INFO);
dw_printf ("\nSending transmit calibration tones. Press control-C to terminate.\n");
ptt_set (chan, 1);
while (n-- > 0) {
tone_gen_put_bit (chan, n & 1);
}
ptt_set (chan, 0);
exit (0);
}
/*
* Initialize the digipeater and IGate functions.
*/
digipeater_init (&digi_config);
igate_init (&igate_config, &digi_config);
/*
* Provide the AGW & KISS socket interfaces for use by a client application.
*/
server_init (&misc_config);
kissnet_init (&misc_config);
/*
* Create a pseudo terminal and KISS TNC emulator.
*/
kiss_init (&misc_config);
/*
* Create thread for trying to salvage frames with bad FCS.
*/
redecode_init ();
/*
* Enable beaconing.
*/
beacon_init (&misc_config, &digi_config);
/*
* Get sound samples and decode them.
* Use hot attribute for all functions called for every audio sample.
* TODO: separate function with __attribute__((hot))
*/
eof = 0;
while ( ! eof)
{
int audio_sample;
int c;
char tt;
for (c=0; c= 256 * 256)
eof = 1;
multi_modem_process_sample(c,audio_sample);
/* Previously, the DTMF decoder was always active. */
/* It took very little CPU time and the thinking was that an */
/* attached application might be interested in this even when */
/* the APRStt gateway was not being used. */
/* Unfortunately it resulted in too many false detections of */
/* touch tones when hearing other types of digital communications */
/* on HF. Starting in version 1.0, the DTMF decoder is active */
/* only when the APRStt gateway is configured. */
if (tt_config.obj_xmit_header[0] != '\0') {
tt = dtmf_sample (c, audio_sample/16384.);
if (tt != ' ') {
aprs_tt_button (c, tt);
}
}
}
/* When a complete frame is accumulated, */
/* process_rec_frame, below, is called. */
}
exit (EXIT_SUCCESS);
}
/*-------------------------------------------------------------------
*
* Name: app_process_rec_frame
*
* Purpose: This is called when we receive a frame with a valid
* FCS and acceptable size.
*
* Inputs: chan - Audio channel number, 0 or 1.
* subchan - Which modem caught it.
* Special case -1 for APRStt gateway.
* pp - Packet handle.
* alevel - Audio level, range of 0 - 100.
* (Special case, use negative to skip
* display of audio level line.
* Use -2 to indicate DTMF message.)
* retries - Level of bit correction used.
* spectrum - Display of how well multiple decoders did.
*
*
* Description: Print decoded packet.
* Optionally send to another application.
*
*--------------------------------------------------------------------*/
void app_process_rec_packet (int chan, int subchan, packet_t pp, int alevel, retry_t retries, char *spectrum)
{
char stemp[500];
unsigned char *pinfo;
int info_len;
char heard[AX25_MAX_ADDR_LEN];
//int j;
int h;
assert (chan >= 0 && chan < MAX_CHANS);
assert (subchan >= -1 && subchan < MAX_SUBCHANS);
ax25_format_addrs (pp, stemp);
info_len = ax25_get_info (pp, &pinfo);
/* Print so we can see what is going on. */
/* Display audio input level. */
/* Who are we hearing? Original station or digipeater. */
if (ax25_get_num_addr(pp) == 0) {
/* Not AX.25. No station to display below. */
h = -1;
strcpy (heard, "");
}
else {
h = ax25_get_heard(pp);
ax25_get_addr_with_ssid(pp, h, heard);
}
if (alevel >= 0) {
text_color_set(DW_COLOR_DEBUG);
dw_printf ("\n");
if (h != -1 && h != AX25_SOURCE) {
dw_printf ("Digipeater ");
}
/* As suggested by KJ4ERJ, if we are receiving from */
/* WIDEn-0, it is quite likely (but not guaranteed), that */
/* we are actually hearing the preceding station in the path. */
if (h >= AX25_REPEATER_2 &&
strncmp(heard, "WIDE", 4) == 0 &&
isdigit(heard[4]) &&
heard[5] == '\0') {
char probably_really[AX25_MAX_ADDR_LEN];
ax25_get_addr_with_ssid(pp, h-1, probably_really);
dw_printf ("%s (probably %s) audio level = %d [%s] %s\n", heard, probably_really, alevel, retry_text[(int)retries], spectrum);
}
else {
dw_printf ("%s audio level = %d [%s] %s\n", heard, alevel, retry_text[(int)retries], spectrum);
}
/* Cranking up the input currently produces */
/* no more than 97. Issue a warning before we */
/* reach this saturation point. */
if (alevel > 90) {
text_color_set(DW_COLOR_ERROR);
dw_printf ("Audio input level is too high. Reduce so most stations are around 50.\n");
}
}
// Display non-APRS packets in a different color.
// Display subchannel only when multiple modems configured for channel.
// -1 for APRStt DTMF decoder.
if (subchan == -1) {
text_color_set(DW_COLOR_REC);
dw_printf ("[%d.dtmf] ", chan);
}
else {
if (ax25_is_aprs(pp)) {
text_color_set(DW_COLOR_REC);
}
else {
text_color_set(DW_COLOR_DEBUG);
}
if (modem.num_subchan[chan] > 1) {
dw_printf ("[%d.%d] ", chan, subchan);
}
else {
dw_printf ("[%d] ", chan);
}
}
dw_printf ("%s", stemp); /* stations followed by : */
ax25_safe_print ((char *)pinfo, info_len, 0);
dw_printf ("\n");
// Display in pure ASCII if non-ASCII characters and "-d u" option specified.
if (d_u_opt) {
unsigned char *p;
int n = 0;
for (p = pinfo; *p != '\0'; p++) {
if (*p >= 0x80) n++;
}
if (n > 0) {
text_color_set(DW_COLOR_DEBUG);
ax25_safe_print ((char *)pinfo, info_len, 1);
dw_printf ("\n");
}
}
/* Decode the contents of APRS frames and display in human-readable form. */
if (ax25_is_aprs(pp)) {
decode_aprs (pp);
}
/* Send to another application if connected. */
int flen;
unsigned char fbuf[AX25_MAX_PACKET_LEN];
flen = ax25_pack(pp, fbuf);
server_send_rec_packet (chan, pp, fbuf, flen);
kissnet_send_rec_packet (chan, fbuf, flen);
kiss_send_rec_packet (chan, fbuf, flen);
/* Send to Internet server if option is enabled. */
/* Consider only those with correct CRC. */
if (ax25_is_aprs(pp) && retries == RETRY_NONE) {
igate_send_rec_packet (chan, pp);
}
/* Note that packet can be modified in place so this is the last thing we should do with it. */
/* Again, use only those with correct CRC. */
/* We don't want to spread corrupted data! */
/* Single bit change appears to be safe from observations so far but be cautious. */
if (ax25_is_aprs(pp) && retries == RETRY_NONE) {
digipeater (chan, pp);
}
ax25_delete (pp);
} /* end app_process_rec_packet */
/* Process control C and window close events. */
#if __WIN32__
static BOOL cleanup_win (int ctrltype)
{
if (ctrltype == CTRL_C_EVENT || ctrltype == CTRL_CLOSE_EVENT) {
text_color_set(DW_COLOR_INFO);
dw_printf ("\nQRT\n");
ptt_term ();
dwgps_term ();
SLEEP_SEC(1);
ExitProcess (0);
}
return (TRUE);
}
#else
static void cleanup_linux (int x)
{
text_color_set(DW_COLOR_INFO);
dw_printf ("\nQRT\n");
ptt_term ();
dwgps_term ();
exit(0);
}
#endif
static void usage (char **argv)
{
text_color_set(DW_COLOR_ERROR);
dw_printf ("\n");
dw_printf ("Dire Wolf version %d.%d\n", MAJOR_VERSION, MINOR_VERSION);
dw_printf ("\n");
dw_printf ("Usage: direwolf [options]\n");
dw_printf ("Options:\n");
dw_printf (" -c fname Configuration file name.\n");
dw_printf (" -r n Audio sample rate, per sec.\n");
dw_printf (" -n n Number of audio channels, 1 or 2.\n");
dw_printf (" -b n Bits per audio sample, 8 or 16.\n");
dw_printf (" -B n Data rate in bits/sec. Standard values are 300, 1200, 9600.\n");
dw_printf (" If < 600, AFSK tones are set to 1600 & 1800.\n");
dw_printf (" If > 2400, K9NG/G3RUH style encoding is used.\n");
dw_printf (" Otherwise, AFSK tones are set to 1200 & 2200.\n");
dw_printf (" -d Debug communication with client application, one of\n");
dw_printf (" a a = AGWPE network protocol.\n");
dw_printf (" k k = KISS serial port.\n");
dw_printf (" n n = KISS network.\n");
dw_printf (" u u = Display non-ASCII text in hexadecimal.\n");
dw_printf (" -t n Text colors. 1=normal, 0=disabled.\n");
#if __WIN32__
#else
dw_printf (" -p Enable pseudo terminal for KISS protocol.\n");
#endif
dw_printf (" -x Send Xmit level calibration tones.\n");
dw_printf (" -U Print UTF-8 test string and exit.\n");
dw_printf ("\n");
#if __WIN32__
#else
dw_printf ("Complete documentation can be found in /usr/local/share/doc/direwolf.\n");
#endif
exit (EXIT_FAILURE);
}
/* end direwolf.c */