wsjtx-lib 1.2.5 → 2.0.1

package/README.md

@@ -192,7 +192,7 @@ Encode a message into audio waveform for transmission.
 
 **Parameters:**
 - `mode`: WSJTXMode enum value
-- `message`: Message text to encode (1-22 characters)
+- `message`: Message text to encode (FT8/FT4 structured messages: 1-37 characters; free text payloads are limited by WSJT-X to 13 characters)
 - `frequency`: Audio frequency in Hz (typically 500-3000 Hz)
 - `threads`: Number of threads to use (optional, default: 4)
 

package/dist/src/index.d.ts

@@ -1,182 +1,34 @@
 /**
- * WSJTX Digital Radio Protocol Library for Node.js
+ * wsjtx-lib — Node.js binding for the WSJT-X 3.0.0 backend.
  *
- * High-level TypeScript wrapper around the native C++ WSJTX library bindings.
- * Provides async/await support, input validation, and convenient utilities
- * for working with digital amateur radio protocols.
- *
- * @example
- * ```typescript
- * import { WSJTXLib, WSJTXMode } from 'wsjtx-lib';
- *
- * const lib = new WSJTXLib();
- *
- * // Decode FT8 audio data
- * const audioData = new Float32Array(48000 * 13); // 13 seconds at 48kHz
- * const result = await lib.decode(WSJTXMode.FT8, audioData, 1500);
- *
- * // Get decoded messages
- * const messages = lib.pullMessages();
- * console.log('Decoded messages:', messages);
- * ```
- */
-import { WSJTXMode, DecodeResult, EncodeResult, WSPRResult, WSPRDecodeOptions, WSJTXMessage, AudioData, IQData, WSJTXError, WSJTXConfig, VersionInfo, ModeCapabilities } from './types.js';
-/**
- * Main WSJTX library class providing digital radio protocol processing
- *
- * This class wraps the native C++ implementation and provides a convenient
- * TypeScript/JavaScript interface with proper error handling, validation,
- * and async/await support.
+ * Public surface:
+ *   - WSJTXLib.encode(mode, message, frequency)
+ *   - WSJTXLib.decode(mode, audio, options)
+ *   - WSJTXLib.decodeWSPR(audio, options)
+ *   - WSJTXLib.convertAudioFormat(audio, target)
+ *   - capability/sample-rate query helpers
  */
+import { WSJTXMode, type DecodeResult, type EncodeResult, type WSPRResult, type WSPRDecodeOptions, type WSJTXMessage, type AudioData, WSJTXError, type WSJTXConfig, type ModeCapabilities, type DecodeOptions } from './types.js';
 export declare class WSJTXLib {
-    private native;
-    private config;
-    /**
-     * Create a new WSJTX library instance
-     *
-     * @param config Optional configuration options
-     * @throws {WSJTXError} If the native library fails to initialize
-     */
+    private readonly native;
+    private readonly config;
     constructor(config?: WSJTXConfig);
-    /**
-     * Decode digital radio signals from audio data
-     *
-     * This method processes audio samples and attempts to decode digital
-     * messages using the specified protocol mode. The operation is performed
-     * asynchronously to avoid blocking the Node.js event loop.
-     *
-     * @param mode The digital mode to use for decoding
-     * @param audioData Audio samples (Float32Array or Int16Array)
-     * @param frequency Center frequency in Hz
-     * @param threads Number of threads to use (1-16, default: 4)
-     * @returns Promise that resolves when decoding is complete
-     *
-     * @throws {WSJTXError} If parameters are invalid or decoding fails
-     *
-     * @example
-     * ```typescript
-     * const audioData = new Float32Array(48000 * 13); // 13 seconds
-     * await lib.decode(WSJTXMode.FT8, audioData, 1500);
-     * const messages = lib.pullMessages();
-     * ```
-     */
-    decode(mode: WSJTXMode, audioData: AudioData, frequency: number, threads?: number): Promise<DecodeResult>;
-    /**
-     * Encode a message into audio waveform for transmission
-     *
-     * Generates the audio waveform that represents the specified message
-     * using the given digital mode. The resulting audio can be fed to
-     * a radio transmitter or audio interface.
-     *
-     * @param mode The digital mode to use for encoding
-     * @param message The message text to encode (mode-specific format)
-     * @param frequency Center frequency in Hz
-     * @param threads Number of threads to use (1-16, default: 4)
-     * @returns Promise that resolves with encoded audio data and actual message sent
-     *
-     * @throws {WSJTXError} If parameters are invalid or encoding fails
-     *
-     * @example
-     * ```typescript
-     * const result = await lib.encode(WSJTXMode.FT8, 'CQ DX K1ABC FN20', 1500);
-     * console.log('Generated audio samples:', result.audioData.length);
-     * console.log('Actual message sent:', result.messageSent);
-     * ```
-     */
+    decode(mode: WSJTXMode, audioData: AudioData, options: DecodeOptions): Promise<DecodeResult>;
     encode(mode: WSJTXMode, message: string, frequency: number, threads?: number): Promise<EncodeResult>;
-    /**
-     * Decode WSPR signals from IQ data
-     *
-     * WSPR (Weak Signal Propagation Reporter) is a specialized protocol
-     * for studying radio propagation. This method takes IQ (complex)
-     * samples and attempts to decode WSPR transmissions.
-     *
-     * @param iqData Interleaved I,Q samples as Float32Array
-     * @param options Decoder options (frequency, callsign, etc.)
-     * @returns Promise that resolves with array of decoded WSPR results
-     *
-     * @throws {WSJTXError} If parameters are invalid or decoding fails
-     *
-     * @example
-     * ```typescript
-     * const iqData = new Float32Array(2 * 12000 * 111); // 2 minutes of IQ data
-     * const options = {
-     *   dialFrequency: 14095600, // 20m WSPR frequency
-     *   callsign: 'K1ABC',
-     *   locator: 'FN20'
-     * };
-     * const results = await lib.decodeWSPR(iqData, options);
-     * ```
-     */
-    decodeWSPR(iqData: IQData, options?: WSPRDecodeOptions): Promise<WSPRResult[]>;
-    /**
-     * Retrieve decoded messages from the internal queue
-     *
-     * Messages are added to an internal queue as they are decoded.
-     * This method retrieves and removes all pending messages from the queue.
-     *
-     * @returns Array of decoded messages
-     *
-     * @example
-     * ```typescript
-     * const messages = lib.pullMessages();
-     * messages.forEach(msg => {
-     *   console.log(`${msg.text} (SNR: ${msg.snr} dB, ΔT: ${msg.deltaTime}s)`);
-     * });
-     * ```
-     */
+    decodeWSPR(audioData: Int16Array, options?: WSPRDecodeOptions): Promise<WSPRResult[]>;
     pullMessages(): WSJTXMessage[];
-    /**
-     * Check if encoding is supported for a specific mode
-     *
-     * @param mode The mode to check
-     * @returns True if encoding is supported
-     */
     isEncodingSupported(mode: WSJTXMode): boolean;
-    /**
-     * Check if decoding is supported for a specific mode
-     *
-     * @param mode The mode to check
-     * @returns True if decoding is supported
-     */
     isDecodingSupported(mode: WSJTXMode): boolean;
-    /**
-     * Get the required sample rate for a specific mode
-     *
-     * @param mode The mode to query
-     * @returns Sample rate in Hz
-     */
     getSampleRate(mode: WSJTXMode): number;
-    /**
-     * Get the transmission duration for a specific mode
-     *
-     * @param mode The mode to query
-     * @returns Duration in seconds
-     */
     getTransmissionDuration(mode: WSJTXMode): number;
-    /**
-     * Get capabilities for all supported modes
-     *
-     * @returns Array of mode capability information
-     */
     getAllModeCapabilities(): ModeCapabilities[];
-    /**
-     * Convert audio format between Float32Array and Int16Array (async)
-     *
-     * Uses the native addon with Node's libuv 线程池执行，不阻塞主线程。
-     *
-     * @param audioData 输入音频数据
-     * @param targetFormat 目标格式 ('float32' | 'int16')
-     * @returns Promise 解析为转换后的数据
-     */
     convertAudioFormat(audioData: AudioData, targetFormat: 'float32' | 'int16'): Promise<AudioData>;
     private validateMode;
     private validateFrequency;
     private validateThreads;
     private validateMessage;
-    private validateAudioData;
-    private validateIQData;
+    private validateAudio;
 }
-export { WSJTXMode, WSJTXError, };
-export type { DecodeResult, EncodeResult, WSPRResult, WSPRDecodeOptions, WSJTXMessage, AudioData, IQData, WSJTXConfig, VersionInfo, ModeCapabilities };
+export { WSJTXMode, WSJTXError };
+export type { DecodeResult, EncodeResult, WSPRResult, WSPRDecodeOptions, WSJTXMessage, AudioData, WSJTXConfig, DecodeOptions, ModeCapabilities, };
 //# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,EACL,SAAS,EACT,YAAY,EACZ,YAAY,EACZ,UAAU,EACV,iBAAiB,EACjB,YAAY,EACZ,SAAS,EACT,MAAM,EACN,UAAU,EACV,WAAW,EACX,WAAW,EACX,gBAAgB,EAIjB,MAAM,YAAY,CAAC;AA0BpB;;;;;;GAMG;AACH,qBAAa,QAAQ;IACnB,OAAO,CAAC,MAAM,CAAM;IACpB,OAAO,CAAC,MAAM,CAAc;IAE5B;;;;;OAKG;gBACS,MAAM,GAAE,WAAgB;IAiBpC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,EACf,SAAS,EAAE,SAAS,EACpB,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,MAAoC,GAC5C,OAAO,CAAC,YAAY,CAAC;IA+BxB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,EACf,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,MAAoC,GAC5C,OAAO,CAAC,YAAY,CAAC;IA8BxB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,UAAU,CACd,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC,UAAU,EAAE,CAAC;IAkCxB;;;;;;;;;;;;;;;OAeG;IACH,YAAY,IAAI,YAAY,EAAE;IAW9B;;;;;OAKG;IACH,mBAAmB,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO;IAI7C;;;;;OAKG;IACH,mBAAmB,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO;IAI7C;;;;;OAKG;IACH,aAAa,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM;IAItC;;;;;OAKG;IACH,uBAAuB,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM;IAIhD;;;;OAIG;IACH,sBAAsB,IAAI,gBAAgB,EAAE;IAY5C;;;;;;;;OAQG;IACG,kBAAkB,CACtB,SAAS,EAAE,SAAS,EACpB,YAAY,EAAE,SAAS,GAAG,OAAO,GAChC,OAAO,CAAC,SAAS,CAAC;IA8BrB,OAAO,CAAC,YAAY;IAMpB,OAAO,CAAC,iBAAiB;IASzB,OAAO,CAAC,eAAe;IASvB,OAAO,CAAC,eAAe;IASvB,OAAO,CAAC,iBAAiB;IAYzB,OAAO,CAAC,cAAc;CAcvB;AAGD,OAAO,EACL,SAAS,EACT,UAAU,GACX,CAAC;AAEF,YAAY,EACV,YAAY,EACZ,YAAY,EACZ,UAAU,EACV,iBAAiB,EACjB,YAAY,EACZ,SAAS,EACT,MAAM,EACN,WAAW,EACX,WAAW,EACX,gBAAgB,EACjB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EACL,SAAS,EACT,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,YAAY,EACjB,KAAK,SAAS,EACd,UAAU,EACV,KAAK,WAAW,EAChB,KAAK,gBAAgB,EACrB,KAAK,aAAa,EACnB,MAAM,YAAY,CAAC;AAuDpB,qBAAa,QAAQ;IACnB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAiB;IACxC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAwB;gBAEnC,MAAM,GAAE,WAAgB;IAK9B,MAAM,CAAC,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;IA0B5F,MAAM,CACV,IAAI,EAAE,SAAS,EACf,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,MAA+B,GACvC,OAAO,CAAC,YAAY,CAAC;IAiBlB,UAAU,CAAC,SAAS,EAAE,UAAU,EAAE,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAwB/F,YAAY,IAAI,YAAY,EAAE;IAI9B,mBAAmB,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO;IAI7C,mBAAmB,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO;IAI7C,aAAa,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM;IAItC,uBAAuB,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM;IAIhD,sBAAsB,IAAI,gBAAgB,EAAE;IAWtC,kBAAkB,CAAC,SAAS,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,GAAG,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC;IASrG,OAAO,CAAC,YAAY;IAMpB,OAAO,CAAC,iBAAiB;IAMzB,OAAO,CAAC,eAAe;IAMvB,OAAO,CAAC,eAAe;IAMvB,OAAO,CAAC,aAAa;CAMtB;AAED,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC;AACjC,YAAY,EACV,YAAY,EACZ,YAAY,EACZ,UAAU,EACV,iBAAiB,EACjB,YAAY,EACZ,SAAS,EACT,WAAW,EACX,aAAa,EACb,gBAAgB,GACjB,CAAC"}