g711-web-stream-player 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,170 @@
+/** Supported ITU-T G.711 companding variants. */
+type G711CodecType = 'pcma' | 'pcmu';
+/** Decode one G.711 A-law byte to a signed 16-bit PCM sample. */
+declare function decodeALaw(encoded: number): number;
+/** Decode one G.711 μ-law byte to a signed 16-bit PCM sample. */
+declare function decodeMuLaw(encoded: number): number;
+/** Decode a complete G.711 packet into signed 16-bit PCM samples. */
+declare function decodeG711Chunk(data: Uint8Array, codec: G711CodecType): Int16Array;
+/** Convert signed 16-bit PCM into Web Audio's normalized Float32 format. */
+declare function pcm16ToFloat32(pcm: Int16Array): Float32Array;
+/** Decode a G.711 packet directly into samples accepted by the Web Audio API. */
+declare function decodeG711ToFloat32(data: Uint8Array, codec: G711CodecType): Float32Array;
+
+interface G711AudioPlayerOptions {
+    /** G.711 input rate. Telephony streams normally use 8000 Hz. */
+    inputSampleRate?: number;
+    /** Maximum queued audio, in milliseconds. */
+    bufferDurationMs?: number;
+    /** Audio collected before playback starts or resumes after an underflow. */
+    prebufferMs?: number;
+    /** Old audio discarded when the ring buffer overflows. */
+    overflowDropMs?: number;
+    /** ScriptProcessor buffer size; must be one of the Web Audio supported sizes. */
+    processorBufferSize?: 256 | 512 | 1024 | 2048 | 4096 | 8192 | 16384;
+    /** Enable Catmull-Rom interpolation instead of linear interpolation. */
+    cubicInterpolation?: boolean;
+    /** RMS value below which the noise gate closes. Set to 0 to disable it. */
+    noiseGateThreshold?: number;
+    /** Gain used while the gate is closed, from 0 to 1. */
+    noiseGateFloor?: number;
+    /** Gate closing speed, from 0 (slow) to 1 (immediate). */
+    noiseGateRelease?: number;
+    /** High-pass cutoff in hertz. Set to 0 to disable the filter. */
+    highpassHz?: number;
+    /** High-shelf start frequency. Set to 0 to disable the filter. */
+    highshelfHz?: number;
+    /** High-shelf gain in dB. */
+    highshelfGainDb?: number;
+    /** Initial output volume. */
+    volume?: number;
+    /** Start muted. */
+    muted?: boolean;
+    /** Emit diagnostic events without logging stream URLs or packet contents. */
+    onDiagnostic?: (event: G711DiagnosticEvent) => void;
+}
+interface G711DiagnosticState {
+    contextState: AudioContextState | 'not-created';
+    muted: boolean;
+    volume: number;
+    outputSampleRate: number;
+    queuedSamples: number;
+    queuedMilliseconds: number;
+    inputChunkCount: number;
+    inputBytes: number;
+    processCallbackCount: number;
+    underflowCount: number;
+    overflowCount: number;
+    waitingForBuffer: boolean;
+    destroyed: boolean;
+}
+interface G711DiagnosticEvent {
+    type: 'initialized' | 'context-state' | 'underflow' | 'overflow' | 'destroyed';
+    state: G711DiagnosticState;
+}
+/**
+ * Browser G.711 player with jitter buffering, resampling and speech-oriented
+ * noise filtering. Create one instance per independently controlled stream.
+ */
+declare class G711AudioPlayer {
+    private readonly options;
+    private context;
+    private gainNode;
+    private scriptNode;
+    private nodes;
+    private outputSampleRate;
+    private resampleRatio;
+    private sourcePhase;
+    private ring;
+    private writeIndex;
+    private readIndex;
+    private gateGain;
+    private waitingForBuffer;
+    private destroyed;
+    private inputChunkCount;
+    private inputBytes;
+    private processCallbackCount;
+    private underflowCount;
+    private overflowCount;
+    constructor(options?: G711AudioPlayerOptions);
+    get isReady(): boolean;
+    getDiagnosticState(): G711DiagnosticState;
+    /** Initialize Web Audio. Call this from a click/tap handler when possible. */
+    init(): void;
+    /** Resume an AudioContext suspended by the browser autoplay policy. */
+    resume(): Promise<void>;
+    /** Decode and enqueue one raw PCMA or PCMU packet. */
+    pushChunk(data: Uint8Array, codec: G711CodecType): void;
+    /** Smoothly mute or unmute the output. */
+    setMuted(muted: boolean): void;
+    /** Set output volume in the inclusive range 0..1. */
+    setVolume(volume: number): void;
+    /** Drop queued audio and rebuild the initial jitter buffer. */
+    flush(): void;
+    /** Disconnect audio nodes and close the underlying AudioContext. */
+    destroy(): void;
+    private get readable();
+    private get writable();
+    private sampleAt;
+    private process;
+    private applyNoiseGate;
+    private cubic;
+    private rampGain;
+    private emit;
+}
+
+interface FlvAudioCallbacks {
+    onAudioData?: (data: Uint8Array, codec: G711CodecType, timestamp: number) => void;
+    onCodecDetected?: (codec: G711CodecType) => void;
+    onUnsupportedAudioFormat?: (soundFormat: number) => void;
+    onError?: (error: Error) => void;
+}
+/**
+ * Incremental FLV demuxer focused on G.711 audio tags.
+ * Feed it arbitrary network chunks; incomplete headers/tags remain buffered.
+ */
+declare class FlvG711Demuxer {
+    private readonly callbacks;
+    private buffer;
+    private headerParsed;
+    private detectedCodec;
+    private readonly unsupportedFormats;
+    constructor(callbacks?: FlvAudioCallbacks);
+    append(chunk: Uint8Array): void;
+    reset(): void;
+    private parse;
+    private emitAudio;
+}
+interface FlvAudioExtractorOptions {
+    fetch?: typeof fetch;
+    requestInit?: Omit<RequestInit, 'signal'>;
+}
+/** Fetch and incrementally demux a live HTTP-FLV stream. */
+declare class FlvAudioExtractor {
+    private readonly options;
+    private controller;
+    private stopped;
+    constructor(options?: FlvAudioExtractorOptions);
+    start(url: string, callbacks?: FlvAudioCallbacks): Promise<void>;
+    stop(): void;
+}
+interface FlvAudioStreamerOptions {
+    player?: G711AudioPlayerOptions;
+    extractor?: FlvAudioExtractorOptions;
+}
+/** One-step HTTP-FLV → G.711 → Web Audio streaming pipeline. */
+declare class FlvAudioStreamer {
+    readonly player: G711AudioPlayer;
+    private readonly extractor;
+    constructor(options?: FlvAudioStreamerOptions);
+    get isReady(): boolean;
+    start(url: string, callbacks?: FlvAudioCallbacks): Promise<void>;
+    resume(): Promise<void>;
+    setMuted(muted: boolean): void;
+    setVolume(volume: number): void;
+    flush(): void;
+    stop(): void;
+    destroy(): void;
+}
+
+export { type FlvAudioCallbacks, FlvAudioExtractor, type FlvAudioExtractorOptions, FlvAudioStreamer, type FlvAudioStreamerOptions, FlvG711Demuxer, G711AudioPlayer, type G711AudioPlayerOptions, type G711CodecType, type G711DiagnosticEvent, type G711DiagnosticState, decodeALaw, decodeG711Chunk, decodeG711ToFloat32, decodeMuLaw, pcm16ToFloat32 };

package/dist/index.d.ts

@@ -0,0 +1,170 @@
+/** Supported ITU-T G.711 companding variants. */
+type G711CodecType = 'pcma' | 'pcmu';
+/** Decode one G.711 A-law byte to a signed 16-bit PCM sample. */
+declare function decodeALaw(encoded: number): number;
+/** Decode one G.711 μ-law byte to a signed 16-bit PCM sample. */
+declare function decodeMuLaw(encoded: number): number;
+/** Decode a complete G.711 packet into signed 16-bit PCM samples. */
+declare function decodeG711Chunk(data: Uint8Array, codec: G711CodecType): Int16Array;
+/** Convert signed 16-bit PCM into Web Audio's normalized Float32 format. */
+declare function pcm16ToFloat32(pcm: Int16Array): Float32Array;
+/** Decode a G.711 packet directly into samples accepted by the Web Audio API. */
+declare function decodeG711ToFloat32(data: Uint8Array, codec: G711CodecType): Float32Array;
+
+interface G711AudioPlayerOptions {
+    /** G.711 input rate. Telephony streams normally use 8000 Hz. */
+    inputSampleRate?: number;
+    /** Maximum queued audio, in milliseconds. */
+    bufferDurationMs?: number;
+    /** Audio collected before playback starts or resumes after an underflow. */
+    prebufferMs?: number;
+    /** Old audio discarded when the ring buffer overflows. */
+    overflowDropMs?: number;
+    /** ScriptProcessor buffer size; must be one of the Web Audio supported sizes. */
+    processorBufferSize?: 256 | 512 | 1024 | 2048 | 4096 | 8192 | 16384;
+    /** Enable Catmull-Rom interpolation instead of linear interpolation. */
+    cubicInterpolation?: boolean;
+    /** RMS value below which the noise gate closes. Set to 0 to disable it. */
+    noiseGateThreshold?: number;
+    /** Gain used while the gate is closed, from 0 to 1. */
+    noiseGateFloor?: number;
+    /** Gate closing speed, from 0 (slow) to 1 (immediate). */
+    noiseGateRelease?: number;
+    /** High-pass cutoff in hertz. Set to 0 to disable the filter. */
+    highpassHz?: number;
+    /** High-shelf start frequency. Set to 0 to disable the filter. */
+    highshelfHz?: number;
+    /** High-shelf gain in dB. */
+    highshelfGainDb?: number;
+    /** Initial output volume. */
+    volume?: number;
+    /** Start muted. */
+    muted?: boolean;
+    /** Emit diagnostic events without logging stream URLs or packet contents. */
+    onDiagnostic?: (event: G711DiagnosticEvent) => void;
+}
+interface G711DiagnosticState {
+    contextState: AudioContextState | 'not-created';
+    muted: boolean;
+    volume: number;
+    outputSampleRate: number;
+    queuedSamples: number;
+    queuedMilliseconds: number;
+    inputChunkCount: number;
+    inputBytes: number;
+    processCallbackCount: number;
+    underflowCount: number;
+    overflowCount: number;
+    waitingForBuffer: boolean;
+    destroyed: boolean;
+}
+interface G711DiagnosticEvent {
+    type: 'initialized' | 'context-state' | 'underflow' | 'overflow' | 'destroyed';
+    state: G711DiagnosticState;
+}
+/**
+ * Browser G.711 player with jitter buffering, resampling and speech-oriented
+ * noise filtering. Create one instance per independently controlled stream.
+ */
+declare class G711AudioPlayer {
+    private readonly options;
+    private context;
+    private gainNode;
+    private scriptNode;
+    private nodes;
+    private outputSampleRate;
+    private resampleRatio;
+    private sourcePhase;
+    private ring;
+    private writeIndex;
+    private readIndex;
+    private gateGain;
+    private waitingForBuffer;
+    private destroyed;
+    private inputChunkCount;
+    private inputBytes;
+    private processCallbackCount;
+    private underflowCount;
+    private overflowCount;
+    constructor(options?: G711AudioPlayerOptions);
+    get isReady(): boolean;
+    getDiagnosticState(): G711DiagnosticState;
+    /** Initialize Web Audio. Call this from a click/tap handler when possible. */
+    init(): void;
+    /** Resume an AudioContext suspended by the browser autoplay policy. */
+    resume(): Promise<void>;
+    /** Decode and enqueue one raw PCMA or PCMU packet. */
+    pushChunk(data: Uint8Array, codec: G711CodecType): void;
+    /** Smoothly mute or unmute the output. */
+    setMuted(muted: boolean): void;
+    /** Set output volume in the inclusive range 0..1. */
+    setVolume(volume: number): void;
+    /** Drop queued audio and rebuild the initial jitter buffer. */
+    flush(): void;
+    /** Disconnect audio nodes and close the underlying AudioContext. */
+    destroy(): void;
+    private get readable();
+    private get writable();
+    private sampleAt;
+    private process;
+    private applyNoiseGate;
+    private cubic;
+    private rampGain;
+    private emit;
+}
+
+interface FlvAudioCallbacks {
+    onAudioData?: (data: Uint8Array, codec: G711CodecType, timestamp: number) => void;
+    onCodecDetected?: (codec: G711CodecType) => void;
+    onUnsupportedAudioFormat?: (soundFormat: number) => void;
+    onError?: (error: Error) => void;
+}
+/**
+ * Incremental FLV demuxer focused on G.711 audio tags.
+ * Feed it arbitrary network chunks; incomplete headers/tags remain buffered.
+ */
+declare class FlvG711Demuxer {
+    private readonly callbacks;
+    private buffer;
+    private headerParsed;
+    private detectedCodec;
+    private readonly unsupportedFormats;
+    constructor(callbacks?: FlvAudioCallbacks);
+    append(chunk: Uint8Array): void;
+    reset(): void;
+    private parse;
+    private emitAudio;
+}
+interface FlvAudioExtractorOptions {
+    fetch?: typeof fetch;
+    requestInit?: Omit<RequestInit, 'signal'>;
+}
+/** Fetch and incrementally demux a live HTTP-FLV stream. */
+declare class FlvAudioExtractor {
+    private readonly options;
+    private controller;
+    private stopped;
+    constructor(options?: FlvAudioExtractorOptions);
+    start(url: string, callbacks?: FlvAudioCallbacks): Promise<void>;
+    stop(): void;
+}
+interface FlvAudioStreamerOptions {
+    player?: G711AudioPlayerOptions;
+    extractor?: FlvAudioExtractorOptions;
+}
+/** One-step HTTP-FLV → G.711 → Web Audio streaming pipeline. */
+declare class FlvAudioStreamer {
+    readonly player: G711AudioPlayer;
+    private readonly extractor;
+    constructor(options?: FlvAudioStreamerOptions);
+    get isReady(): boolean;
+    start(url: string, callbacks?: FlvAudioCallbacks): Promise<void>;
+    resume(): Promise<void>;
+    setMuted(muted: boolean): void;
+    setVolume(volume: number): void;
+    flush(): void;
+    stop(): void;
+    destroy(): void;
+}
+
+export { type FlvAudioCallbacks, FlvAudioExtractor, type FlvAudioExtractorOptions, FlvAudioStreamer, type FlvAudioStreamerOptions, FlvG711Demuxer, G711AudioPlayer, type G711AudioPlayerOptions, type G711CodecType, type G711DiagnosticEvent, type G711DiagnosticState, decodeALaw, decodeG711Chunk, decodeG711ToFloat32, decodeMuLaw, pcm16ToFloat32 };