@e04/ft8ts 0.0.8 → 0.0.9

package/src/ft4/encode.ts

@@ -0,0 +1,40 @@
+import { encode174_91 } from "../ft8/encode.js";
+import { pack77 } from "../util/pack_jt77.js";
+import { generateFT4Waveform, type WaveformOptions } from "../util/waveform.js";
+import { COSTAS_A, COSTAS_B, COSTAS_C, COSTAS_D, GRAYMAP } from "./constants.js";
+import { xorWithScrambler } from "./scramble.js";
+
+/**
+ * Convert FT4 LDPC codeword bits into 103 channel tones.
+ * Port of lib/ft4/genft4.f90.
+ */
+export function getTones(codeword: readonly number[]): number[] {
+	const dataTones = new Array<number>(87);
+	for (let i = 0; i < 87; i++) {
+		const b0 = codeword[2 * i] ?? 0;
+		const b1 = codeword[2 * i + 1] ?? 0;
+		const symbol = b1 + 2 * b0;
+		dataTones[i] = GRAYMAP[symbol]!;
+	}
+
+	const tones = new Array<number>(103);
+	tones.splice(0, 4, ...COSTAS_A);
+	tones.splice(4, 29, ...dataTones.slice(0, 29));
+	tones.splice(33, 4, ...COSTAS_B);
+	tones.splice(37, 29, ...dataTones.slice(29, 58));
+	tones.splice(66, 4, ...COSTAS_C);
+	tones.splice(70, 29, ...dataTones.slice(58, 87));
+	tones.splice(99, 4, ...COSTAS_D);
+	return tones;
+}
+
+export function encodeMessage(msg: string): number[] {
+	const bits77 = pack77(msg);
+	const scrambled = xorWithScrambler(bits77);
+	const codeword = encode174_91(scrambled);
+	return getTones(codeword);
+}
+
+export function encode(msg: string, options: WaveformOptions = {}): Float32Array {
+	return generateFT4Waveform(encodeMessage(msg), options);
+}

package/src/ft4/scramble.ts

@@ -0,0 +1,9 @@
+import { RVEC } from "./constants.js";
+
+export function xorWithScrambler(bits77: readonly number[]): number[] {
+	const out = new Array<number>(77);
+	for (let i = 0; i < 77; i++) {
+		out[i] = ((bits77[i] ?? 0) + RVEC[i]!) & 1;
+	}
+	return out;
+}

package/src/ft8/constants.ts

@@ -0,0 +1,18 @@
+/** FT8-specific constants (lib/ft8/ft8_params.f90). */
+
+export const NSPS = 1920;
+export const NFFT1 = 2 * NSPS; // 3840
+export const NH1 = NFFT1 / 2; // 1920
+export const NSTEP = NSPS / 4; // 480
+export const NMAX = 15 * 12_000; // 180000
+export const NHSYM = Math.floor(NMAX / NSTEP) - 3; // 372
+export const NDOWN = 60;
+export const NN = 79;
+export const NS = 21;
+export const ND = 58;
+
+/** 7-symbol Costas array for sync. */
+export const COSTAS = [3, 1, 4, 0, 6, 5, 2] as const;
+
+/** 8-tone Gray mapping. */
+export const GRAY_MAP = [0, 1, 3, 2, 5, 6, 4, 7] as const;

package/src/ft8/decode.ts

@@ -1,20 +1,9 @@
-import {
-	graymap,
-	icos7,
-	N_LDPC,
-	NDOWN,
-	NFFT1,
-	NHSYM,
-	NMAX,
-	NN,
-	NSPS,
-	NSTEP,
-	SAMPLE_RATE,
-} from "../util/constants.js";
+import { N_LDPC, SAMPLE_RATE } from "../util/constants.js";
 import { decode174_91 } from "../util/decode174_91.js";
 import { fftComplex, nextPow2 } from "../util/fft.js";
 import type { HashCallBook } from "../util/hashcall.js";
 import { unpack77 } from "../util/unpack_jt77.js";
+import { COSTAS, GRAY_MAP, NDOWN, NFFT1, NHSYM, NMAX, NN, NSPS, NSTEP } from "./constants.js";
 
 export interface DecodedMessage {
 	freq: number;
@@ -174,7 +163,7 @@ function sync8(
 
 			for (let n = 0; n < 7; n++) {
 				const m = jj + jstrt + nssy * n;
-				const iCostas = i + nfos * icos7[n]!;
+				const iCostas = i + nfos * COSTAS[n]!;
 
 				if (m >= 0 && m < NHSYM && iCostas < halfSize) {
 					ta += s[iCostas * NHSYM + m]!;
@@ -440,7 +429,7 @@ function ft8b(
 					maxTone = t;
 				}
 			}
-			if (maxTone === icos7[k]) nsync++;
+			if (maxTone === COSTAS[k]) nsync++;
 		}
 	}
 	if (nsync <= 6) return null;
@@ -466,22 +455,22 @@ function ft8b(
 					const i2 = Math.floor((i & 63) / 8);
 					const i3 = i & 7;
 					if (nsym === 1) {
-						const re = csRe[graymap[i3]! * NN + ks - 1]!;
-						const im = csIm[graymap[i3]! * NN + ks - 1]!;
+						const re = csRe[GRAY_MAP[i3]! * NN + ks - 1]!;
+						const im = csIm[GRAY_MAP[i3]! * NN + ks - 1]!;
 						s2[i] = Math.sqrt(re * re + im * im);
 					} else if (nsym === 2) {
-						const sRe = csRe[graymap[i2]! * NN + ks - 1]! + csRe[graymap[i3]! * NN + ks]!;
-						const sIm = csIm[graymap[i2]! * NN + ks - 1]! + csIm[graymap[i3]! * NN + ks]!;
+						const sRe = csRe[GRAY_MAP[i2]! * NN + ks - 1]! + csRe[GRAY_MAP[i3]! * NN + ks]!;
+						const sIm = csIm[GRAY_MAP[i2]! * NN + ks - 1]! + csIm[GRAY_MAP[i3]! * NN + ks]!;
 						s2[i] = Math.sqrt(sRe * sRe + sIm * sIm);
 					} else {
 						const sRe =
-							csRe[graymap[i1]! * NN + ks - 1]! +
-							csRe[graymap[i2]! * NN + ks]! +
-							csRe[graymap[i3]! * NN + ks + 1]!;
+							csRe[GRAY_MAP[i1]! * NN + ks - 1]! +
+							csRe[GRAY_MAP[i2]! * NN + ks]! +
+							csRe[GRAY_MAP[i3]! * NN + ks + 1]!;
 						const sIm =
-							csIm[graymap[i1]! * NN + ks - 1]! +
-							csIm[graymap[i2]! * NN + ks]! +
-							csIm[graymap[i3]! * NN + ks + 1]!;
+							csIm[GRAY_MAP[i1]! * NN + ks - 1]! +
+							csIm[GRAY_MAP[i2]! * NN + ks]! +
+							csIm[GRAY_MAP[i3]! * NN + ks + 1]!;
 						s2[i] = Math.sqrt(sRe * sRe + sIm * sIm);
 					}
 				}
@@ -577,15 +566,15 @@ function ft8b(
 
 function getTones(cw: number[]): number[] {
 	const tones = new Array(79).fill(0) as number[];
-	for (let i = 0; i < 7; i++) tones[i] = icos7[i]!;
-	for (let i = 0; i < 7; i++) tones[36 + i] = icos7[i]!;
-	for (let i = 0; i < 7; i++) tones[72 + i] = icos7[i]!;
+	for (let i = 0; i < 7; i++) tones[i] = COSTAS[i]!;
+	for (let i = 0; i < 7; i++) tones[36 + i] = COSTAS[i]!;
+	for (let i = 0; i < 7; i++) tones[72 + i] = COSTAS[i]!;
 	let k = 7;
 	for (let j = 1; j <= 58; j++) {
 		const i = (j - 1) * 3;
 		if (j === 30) k += 7;
 		const indx = cw[i]! * 4 + cw[i + 1]! * 2 + cw[i + 2]!;
-		tones[k] = graymap[indx]!;
+		tones[k] = GRAY_MAP[indx]!;
 		k++;
 	}
 	return tones;
@@ -691,7 +680,7 @@ function sync8d(
 	const csyncIm = new Float64Array(7 * 32);
 	for (let i = 0; i < 7; i++) {
 		let phi = 0;
-		const dphi = (twopi * icos7[i]!) / 32;
+		const dphi = (twopi * COSTAS[i]!) / 32;
 		for (let j = 0; j < 32; j++) {
 			csyncRe[i * 32 + j] = Math.cos(phi);
 			csyncIm[i * 32 + j] = Math.sin(phi);

package/src/ft8/encode.ts

@@ -1,6 +1,7 @@
-import { gHex, graymap, icos7 } from "../util/constants.js";
+import { gHex } from "../util/constants.js";
 import { pack77 } from "../util/pack_jt77.js";
 import { generateFT8Waveform, type WaveformOptions } from "../util/waveform.js";
+import { COSTAS, GRAY_MAP } from "./constants.js";
 
 function generateLdpcGMatrix(): number[][] {
 	const K = 91;
@@ -59,16 +60,16 @@ export function encode174_91(msg77: number[]): number[] {
 export function getTones(codeword: number[]): number[] {
 	const tones = new Array(79).fill(0);
 
-	for (let i = 0; i < 7; i++) tones[i] = icos7[i]!;
-	for (let i = 0; i < 7; i++) tones[36 + i] = icos7[i]!;
-	for (let i = 0; i < 7; i++) tones[72 + i] = icos7[i]!;
+	for (let i = 0; i < 7; i++) tones[i] = COSTAS[i]!;
+	for (let i = 0; i < 7; i++) tones[36 + i] = COSTAS[i]!;
+	for (let i = 0; i < 7; i++) tones[72 + i] = COSTAS[i]!;
 
 	let k = 7;
 	for (let j = 1; j <= 58; j++) {
 		const i = j * 3 - 3; // codeword is 0-indexed in JS, but the loop was j=1 to 58
 		if (j === 30) k += 7;
 		const indx = codeword[i]! * 4 + codeword[i + 1]! * 2 + codeword[i + 2]!;
-		tones[k] = graymap[indx]!;
+		tones[k] = GRAY_MAP[indx]!;
 		k++;
 	}
 	return tones;

package/src/index.ts

@@ -1,3 +1,9 @@
+export {
+	type DecodedMessage as DecodedFT4Message,
+	type DecodeOptions as DecodeFT4Options,
+	decode as decodeFT4,
+} from "./ft4/decode.js";
+export { encode as encodeFT4 } from "./ft4/encode.js";
 export { type DecodedMessage, type DecodeOptions, decode as decodeFT8 } from "./ft8/decode.js";
 export { encode as encodeFT8 } from "./ft8/encode.js";
 export { HashCallBook } from "./util/hashcall.js";

package/src/util/constants.ts

@@ -1,21 +1,12 @@
+/** Shared constants used by FT8, FT4, pack77, etc. */
+
 export const SAMPLE_RATE = 12_000;
-export const NSPS = 1920;
-export const NFFT1 = 2 * NSPS; // 3840
-export const NH1 = NFFT1 / 2; // 1920
-export const NSTEP = NSPS / 4; // 480
-export const NMAX = 15 * SAMPLE_RATE; // 180000
-export const NHSYM = Math.floor(NMAX / NSTEP) - 3; // 372
-export const NDOWN = 60;
-export const NN = 79;
-export const NS = 21;
-export const ND = 58;
+
+/** LDPC(174,91) code (shared by FT8 and FT4). */
 export const KK = 91;
 export const N_LDPC = 174;
 export const M_LDPC = N_LDPC - KK; // 83
 
-export const icos7 = [3, 1, 4, 0, 6, 5, 2] as const;
-export const graymap = [0, 1, 3, 2, 5, 6, 4, 7] as const;
-
 export const gHex = [
 	"8329ce11bf31eaf509f27fc",
 	"761c264e25c259335493132",

package/src/util/waveform.ts

@@ -1,7 +1,13 @@
 const TWO_PI = 2 * Math.PI;
-const DEFAULT_SAMPLE_RATE = 12_000;
-const DEFAULT_SAMPLES_PER_SYMBOL = 1_920;
-const DEFAULT_BT = 2.0;
+const FT8_DEFAULT_SAMPLE_RATE = 12_000;
+const FT8_DEFAULT_SAMPLES_PER_SYMBOL = 1_920;
+const FT8_DEFAULT_BT = 2.0;
+
+import { NSPS as FT4_NSPS } from "../ft4/constants.js";
+
+const FT4_DEFAULT_SAMPLE_RATE = 12_000;
+const FT4_DEFAULT_SAMPLES_PER_SYMBOL = FT4_NSPS;
+const FT4_DEFAULT_BT = 1.0;
 const MODULATION_INDEX = 1.0;
 
 export interface WaveformOptions {
@@ -11,6 +17,17 @@ export interface WaveformOptions {
 	baseFrequency?: number;
 }
 
+interface WaveformDefaults {
+	sampleRate: number;
+	samplesPerSymbol: number;
+	bt: number;
+}
+
+interface WaveformShape {
+	includeRampSymbols: boolean;
+	fullSymbolRamp: boolean;
+}
+
 function assertPositiveFinite(value: number, name: string): void {
 	if (!Number.isFinite(value) || value <= 0) {
 		throw new Error(`${name} must be a positive finite number`);
@@ -36,19 +53,20 @@ function gfskPulse(bt: number, tt: number): number {
 	return 0.5 * (erfApprox(scale * (tt + 0.5)) - erfApprox(scale * (tt - 0.5)));
 }
 
-export function generateFT8Waveform(
+function generateGfskWaveform(
 	tones: readonly number[],
-	options: WaveformOptions = {},
+	options: WaveformOptions,
+	defaults: WaveformDefaults,
+	shape: WaveformShape,
 ): Float32Array {
-	// Mirrors the FT8 path in lib/ft8/gen_ft8wave.f90.
 	const nsym = tones.length;
 	if (nsym === 0) {
 		return new Float32Array(0);
 	}
 
-	const sampleRate = options.sampleRate ?? DEFAULT_SAMPLE_RATE;
-	const nsps = options.samplesPerSymbol ?? DEFAULT_SAMPLES_PER_SYMBOL;
-	const bt = options.bt ?? DEFAULT_BT;
+	const sampleRate = options.sampleRate ?? defaults.sampleRate;
+	const nsps = options.samplesPerSymbol ?? defaults.samplesPerSymbol;
+	const bt = options.bt ?? defaults.bt;
 	const f0 = options.baseFrequency ?? 0;
 
 	assertPositiveFinite(sampleRate, "sampleRate");
@@ -61,7 +79,7 @@ export function generateFT8Waveform(
 		throw new Error("samplesPerSymbol must be an integer");
 	}
 
-	const nwave = nsym * nsps;
+	const nwave = (shape.includeRampSymbols ? nsym + 2 : nsym) * nsps;
 	const pulse = new Float64Array(3 * nsps);
 	for (let i = 0; i < pulse.length; i++) {
 		const tt = (i + 1 - 1.5 * nsps) / nsps;
@@ -94,8 +112,9 @@ export function generateFT8Waveform(
 
 	const wave = new Float32Array(nwave);
 	let phi = 0;
+	const phaseStart = shape.includeRampSymbols ? 0 : nsps;
 	for (let k = 0; k < nwave; k++) {
-		const j = nsps + k; // skip the leading dummy symbol
+		const j = phaseStart + k;
 		wave[k] = Math.sin(phi);
 		phi += dphi[j]!;
 		phi %= TWO_PI;
@@ -104,17 +123,70 @@ export function generateFT8Waveform(
 		}
 	}
 
-	const nramp = Math.round(nsps / 8);
-	for (let i = 0; i < nramp; i++) {
-		const up = (1 - Math.cos((TWO_PI * i) / (2 * nramp))) / 2;
-		wave[i]! *= up;
-	}
+	if (shape.fullSymbolRamp) {
+		for (let i = 0; i < nsps; i++) {
+			const up = (1 - Math.cos((TWO_PI * i) / (2 * nsps))) / 2;
+			wave[i]! *= up;
+		}
+
+		const tailStart = (nsym + 1) * nsps;
+		for (let i = 0; i < nsps; i++) {
+			const down = (1 + Math.cos((TWO_PI * i) / (2 * nsps))) / 2;
+			wave[tailStart + i]! *= down;
+		}
+	} else {
+		const nramp = Math.round(nsps / 8);
+		for (let i = 0; i < nramp; i++) {
+			const up = (1 - Math.cos((TWO_PI * i) / (2 * nramp))) / 2;
+			wave[i]! *= up;
+		}
 
-	const tailStart = nwave - nramp;
-	for (let i = 0; i < nramp; i++) {
-		const down = (1 + Math.cos((TWO_PI * i) / (2 * nramp))) / 2;
-		wave[tailStart + i]! *= down;
+		const tailStart = nwave - nramp;
+		for (let i = 0; i < nramp; i++) {
+			const down = (1 + Math.cos((TWO_PI * i) / (2 * nramp))) / 2;
+			wave[tailStart + i]! *= down;
+		}
 	}
 
 	return wave;
 }
+
+export function generateFT8Waveform(
+	tones: readonly number[],
+	options: WaveformOptions = {},
+): Float32Array {
+	// Mirrors the FT8 path in lib/ft8/gen_ft8wave.f90.
+	return generateGfskWaveform(
+		tones,
+		options,
+		{
+			sampleRate: FT8_DEFAULT_SAMPLE_RATE,
+			samplesPerSymbol: FT8_DEFAULT_SAMPLES_PER_SYMBOL,
+			bt: FT8_DEFAULT_BT,
+		},
+		{
+			includeRampSymbols: false,
+			fullSymbolRamp: false,
+		},
+	);
+}
+
+export function generateFT4Waveform(
+	tones: readonly number[],
+	options: WaveformOptions = {},
+): Float32Array {
+	// Mirrors lib/ft4/gen_ft4wave.f90.
+	return generateGfskWaveform(
+		tones,
+		options,
+		{
+			sampleRate: FT4_DEFAULT_SAMPLE_RATE,
+			samplesPerSymbol: FT4_DEFAULT_SAMPLES_PER_SYMBOL,
+			bt: FT4_DEFAULT_BT,
+		},
+		{
+			includeRampSymbols: true,
+			fullSymbolRamp: true,
+		},
+	);
+}