wsjtx-lib 1.0.4 → 1.1.0

package/dist/index.d.cts

@@ -1,192 +0,0 @@
-import { WSJTXConfig, WSJTXMode, AudioData, DecodeResult, EncodeResult, IQData, WSPRDecodeOptions, WSPRResult, WSJTXMessage, ModeCapabilities } from './types.cjs';
-export { VersionInfo, WSJTXError } from './types.cjs';
-
-/**
- * WSJTX Digital Radio Protocol Library for Node.js
- *
- * 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);
- * ```
- */
-
-/**
- * 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.
- */
-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
-     */
-    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);
-     * ```
-     */
-    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)`);
-     * });
-     * ```
-     */
-    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
-     *
-     * @param audioData Input audio data
-     * @param targetFormat Target format ('float32' or 'int16')
-     * @returns Converted audio data
-     */
-    static convertAudioFormat(audioData: AudioData, targetFormat: 'float32' | 'int16'): AudioData;
-    /**
-     * Static convenience helper for async audio format conversion.
-     */
-    static convertAudioFormatAsync(audioData: AudioData, targetFormat: 'float32' | 'int16'): Promise<AudioData>;
-    /**
-     * Asynchronously convert audio data format without blocking the event loop
-     *
-     * Uses native thread pool to offload conversion.
-     */
-    convertAudioFormatAsync(audioData: AudioData, targetFormat: 'float32' | 'int16'): Promise<AudioData>;
-    private validateMode;
-    private validateFrequency;
-    private validateThreads;
-    private validateMessage;
-    private validateAudioData;
-    private validateIQData;
-}
-
-export { AudioData, DecodeResult, EncodeResult, IQData, ModeCapabilities, WSJTXConfig, WSJTXLib, WSJTXMessage, WSJTXMode, WSPRDecodeOptions, WSPRResult };

package/dist/index.d.ts

@@ -1,192 +0,0 @@
-import { WSJTXConfig, WSJTXMode, AudioData, DecodeResult, EncodeResult, IQData, WSPRDecodeOptions, WSPRResult, WSJTXMessage, ModeCapabilities } from './types.js';
-export { VersionInfo, WSJTXError } from './types.js';
-
-/**
- * WSJTX Digital Radio Protocol Library for Node.js
- *
- * 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);
- * ```
- */
-
-/**
- * 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.
- */
-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
-     */
-    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);
-     * ```
-     */
-    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)`);
-     * });
-     * ```
-     */
-    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
-     *
-     * @param audioData Input audio data
-     * @param targetFormat Target format ('float32' or 'int16')
-     * @returns Converted audio data
-     */
-    static convertAudioFormat(audioData: AudioData, targetFormat: 'float32' | 'int16'): AudioData;
-    /**
-     * Static convenience helper for async audio format conversion.
-     */
-    static convertAudioFormatAsync(audioData: AudioData, targetFormat: 'float32' | 'int16'): Promise<AudioData>;
-    /**
-     * Asynchronously convert audio data format without blocking the event loop
-     *
-     * Uses native thread pool to offload conversion.
-     */
-    convertAudioFormatAsync(audioData: AudioData, targetFormat: 'float32' | 'int16'): Promise<AudioData>;
-    private validateMode;
-    private validateFrequency;
-    private validateThreads;
-    private validateMessage;
-    private validateAudioData;
-    private validateIQData;
-}
-
-export { AudioData, DecodeResult, EncodeResult, IQData, ModeCapabilities, WSJTXConfig, WSJTXLib, WSJTXMessage, WSJTXMode, WSPRDecodeOptions, WSPRResult };