|
| 1 | +import{Readable}from"stream"; |
| 2 | + |
| 3 | +/** |
| 4 | + * SilenceFiller is a Readable stream that intersperses incoming audio data |
| 5 | + * with bytes of silence. This is important in some cases to keep an audio |
| 6 | + * stream "alive". Audio players, such as ffmpeg, can interpret inactivity as |
| 7 | + * meaning the stream is ended, or disconnected. |
| 8 | + * |
| 9 | + *@example |
| 10 | + * ```typescript |
| 11 | + * import { SilenceFiller } from 'hume'; |
| 12 | + * |
| 13 | + * const BYTES_PER_SAMPLE = 2; // 16-bit samples |
| 14 | + * const SAMPLE_RATE = 48000; |
| 15 | + * const BUFFER_SIZE = Math.floor(SAMPLE_RATE * 0.1 * BYTES_PER_SAMPLE); // 100ms buffer |
| 16 | + * const silenceFiller = new SilenceFiller(BUFFER_SIZE, SAMPLE_RATE, BYTES_PER_SAMPLE, 10); |
| 17 | + * |
| 18 | + * // Pipe silence filler output to audio player stdin |
| 19 | + * silenceFiller.pipe(audioPlayer.stdin); |
| 20 | + * |
| 21 | + * // Handle pipe errors |
| 22 | + * silenceFiller.on('error', (err) => { |
| 23 | + * console.error("SilenceFiller error:", err); |
| 24 | + * }); |
| 25 | + * |
| 26 | + * // Write audio data as it arrives |
| 27 | + * silenceFiller.writeAudio(audioBuffer); |
| 28 | + * |
| 29 | + * // End the stream when done |
| 30 | + * await silenceFiller.endStream(); |
| 31 | + * ``` |
| 32 | + */ |
| 33 | +exportclassSilenceFillerextendsReadable{ |
| 34 | +privateunclockedSilenceFiller:UnclockedSilenceFiller; |
| 35 | +privateisStarted:boolean=false; |
| 36 | +privatepushInterval:NodeJS.Timeout|null=null; |
| 37 | +privatebytesPerSample:number; |
| 38 | +privatepushIntervalMs:number; |
| 39 | + |
| 40 | +/** |
| 41 | + * Creates a new SilenceFiller instance. |
| 42 | + * |
| 43 | + *@param pushIntervalMs - The interval in milliseconds for pushing audio data (default: 5ms). |
| 44 | + *@param sampleRate - The sample rate of the audio (e.g., 48000). |
| 45 | + *@param bytesPerSample - The number of bytes per audio sample (e.g., 2 for 16-bit). |
| 46 | + *@param bufferSize - How much to 'prebuffer'. If you set this too low there |
| 47 | + * is a chance that playback will stutter, but if you set it too high |
| 48 | + * playback will take longer to start. |
| 49 | + */ |
| 50 | +constructor( |
| 51 | +pushIntervalMs:number=5, |
| 52 | +sampleRate:number=48000, |
| 53 | +bytesPerSample:number=2, |
| 54 | +bufferSize:number=9600, |
| 55 | +){ |
| 56 | +super({objectMode:false}); |
| 57 | +this.unclockedSilenceFiller=newUnclockedSilenceFiller(bufferSize,sampleRate,bytesPerSample); |
| 58 | +this.bytesPerSample=bytesPerSample; |
| 59 | +this.pushIntervalMs=pushIntervalMs; |
| 60 | +} |
| 61 | + |
| 62 | +/** |
| 63 | + * Writes audio data to the silence filler. |
| 64 | + * |
| 65 | + *@param audioBuffer - The audio buffer to write. |
| 66 | + */ |
| 67 | +writeAudio(audioBuffer:Buffer):void{ |
| 68 | +constnow=Date.now(); |
| 69 | +try{ |
| 70 | +this.unclockedSilenceFiller.writeAudio(audioBuffer,now); |
| 71 | +if(!this.isStarted&&this.unclockedSilenceFiller.donePrebuffering){ |
| 72 | +this.isStarted=true; |
| 73 | +this.startPushInterval(); |
| 74 | +} |
| 75 | +}catch(error){ |
| 76 | +console.error(`[SilenceFiller] Error writing audio:`,error); |
| 77 | +this.emit("error",error); |
| 78 | +} |
| 79 | +} |
| 80 | + |
| 81 | +privatestartPushInterval():void{ |
| 82 | +this.pushInterval=setInterval(()=>{ |
| 83 | +this.pushData(); |
| 84 | +},this.pushIntervalMs); |
| 85 | +} |
| 86 | + |
| 87 | +privatepushData():void{ |
| 88 | +if(!this.isStarted)return; |
| 89 | + |
| 90 | +try{ |
| 91 | +constnow=Date.now(); |
| 92 | +constaudioChunk=this.unclockedSilenceFiller.readAudio(now); |
| 93 | + |
| 94 | +if(audioChunk&&audioChunk.length>0){ |
| 95 | +// Ensure chunk size is aligned to bytesPerSample |
| 96 | +constalignedChunkSize=Math.floor(audioChunk.length/this.bytesPerSample)*this.bytesPerSample; |
| 97 | + |
| 98 | +if(alignedChunkSize>0){ |
| 99 | +constchunk=audioChunk.subarray(0,alignedChunkSize); |
| 100 | +this.push(chunk); |
| 101 | +} |
| 102 | +} |
| 103 | +}catch(error){ |
| 104 | +console.error(`[SilenceFiller] Error pushing data:`,error); |
| 105 | +this.emit("error",error); |
| 106 | +} |
| 107 | +} |
| 108 | + |
| 109 | +_read():void{} |
| 110 | + |
| 111 | +_destroy(error:Error|null,callback:(error?:Error|null)=>void):void{ |
| 112 | +super._destroy(error,callback); |
| 113 | +} |
| 114 | + |
| 115 | +/** |
| 116 | + * Ends the stream and drains all remaining audio data. |
| 117 | + * |
| 118 | + *@returns A promise that resolves when the stream has ended. |
| 119 | + */ |
| 120 | +endStream():Promise<void>{ |
| 121 | +returnnewPromise((resolve)=>{ |
| 122 | +// Stop pushing data |
| 123 | +if(this.pushInterval){ |
| 124 | +clearInterval(this.pushInterval); |
| 125 | +this.pushInterval=null; |
| 126 | +} |
| 127 | + |
| 128 | +// Drain all remaining audio from SilenceFiller |
| 129 | +constnow=Date.now(); |
| 130 | + |
| 131 | +// Keep reading until no more audio is available |
| 132 | +while(true){ |
| 133 | +constremainingChunk=this.unclockedSilenceFiller.readAudio(now); |
| 134 | + |
| 135 | +if(!remainingChunk||remainingChunk.length===0){ |
| 136 | +break; |
| 137 | +} |
| 138 | + |
| 139 | +constalignedChunkSize=Math.floor(remainingChunk.length/this.bytesPerSample)*this.bytesPerSample; |
| 140 | +if(alignedChunkSize>0){ |
| 141 | +constchunk=remainingChunk.subarray(0,alignedChunkSize); |
| 142 | +this.push(chunk); |
| 143 | +} |
| 144 | +} |
| 145 | + |
| 146 | +this.push(null);// Signal end of stream |
| 147 | + |
| 148 | +this.once("end",()=>{ |
| 149 | +resolve(); |
| 150 | +}); |
| 151 | +}); |
| 152 | +} |
| 153 | +} |
| 154 | + |
| 155 | +/** |
| 156 | + * Does the actual calculation of how interspersing audio with silence |
| 157 | + * is "pure" in the sense that it does not rely on the system clock. |
| 158 | + * It's up to the caller to provide timestamps. |
| 159 | + * |
| 160 | + *@internal |
| 161 | + */ |
| 162 | +exportclassUnclockedSilenceFiller{ |
| 163 | +privateaudioQueue:Buffer[]=[]; |
| 164 | +privatetotalBufferedBytes:number=0; |
| 165 | +privatestartTimestamp:number|null=null; |
| 166 | +privatetotalBytesSent:number=0; |
| 167 | +publicdonePrebuffering:boolean=false; |
| 168 | +privatebufferSize:number; |
| 169 | +privatesampleRate:number; |
| 170 | +privatebytesPerSample:number; |
| 171 | + |
| 172 | +constructor(bufferSize:number,sampleRate:number,bytesPerSample:number){ |
| 173 | +this.bufferSize=bufferSize; |
| 174 | +this.sampleRate=sampleRate; |
| 175 | +this.bytesPerSample=bytesPerSample; |
| 176 | +} |
| 177 | + |
| 178 | +writeAudio(audioBuffer:Buffer,timestamp:number):void{ |
| 179 | +this.audioQueue.push(audioBuffer); |
| 180 | +this.totalBufferedBytes+=audioBuffer.length; |
| 181 | + |
| 182 | +if(this.startTimestamp===null){ |
| 183 | +this.startTimestamp=timestamp; |
| 184 | +} |
| 185 | + |
| 186 | +if(!this.donePrebuffering&&this.totalBufferedBytes>=this.bufferSize){ |
| 187 | +this.donePrebuffering=true; |
| 188 | +} |
| 189 | +} |
| 190 | + |
| 191 | +readAudio(timestamp:number):Buffer|null{ |
| 192 | +if(this.startTimestamp===null||!this.donePrebuffering){ |
| 193 | +returnnull; |
| 194 | +} |
| 195 | + |
| 196 | +constelapsedMs=timestamp-this.startTimestamp; |
| 197 | + |
| 198 | +consttargetBytesSent=Math.floor(((this.sampleRate*elapsedMs)/1000)*this.bytesPerSample); |
| 199 | + |
| 200 | +constbytesNeeded=targetBytesSent-this.totalBytesSent; |
| 201 | + |
| 202 | +if(bytesNeeded<=0){ |
| 203 | +returnnull; |
| 204 | +} |
| 205 | + |
| 206 | +// Ensure bytesNeeded is a multiple of bytesPerSample |
| 207 | +constalignedBytesNeeded=Math.floor(bytesNeeded/this.bytesPerSample)*this.bytesPerSample; |
| 208 | + |
| 209 | +if(alignedBytesNeeded<=0){ |
| 210 | +returnnull; |
| 211 | +} |
| 212 | + |
| 213 | +letchunk=Buffer.alloc(0); |
| 214 | + |
| 215 | +// Drain from queue until we have enough bytes |
| 216 | +while(chunk.length<alignedBytesNeeded&&this.audioQueue.length>0){ |
| 217 | +constnextBuffer=this.audioQueue.shift()!; |
| 218 | +chunk=Buffer.concat([chunk,nextBuffer]); |
| 219 | +this.totalBufferedBytes-=nextBuffer.length; |
| 220 | +} |
| 221 | + |
| 222 | +// If we have more than needed, put the excess back |
| 223 | +if(chunk.length>alignedBytesNeeded){ |
| 224 | +constexcess=chunk.subarray(alignedBytesNeeded); |
| 225 | +this.audioQueue.unshift(excess); |
| 226 | +this.totalBufferedBytes+=excess.length; |
| 227 | +chunk=chunk.subarray(0,alignedBytesNeeded); |
| 228 | +} |
| 229 | + |
| 230 | +// Fill remaining with silence if needed |
| 231 | +if(chunk.length<alignedBytesNeeded){ |
| 232 | +constsilenceNeeded=Buffer.alloc(alignedBytesNeeded-chunk.length,0); |
| 233 | +chunk=Buffer.concat([chunk,silenceNeeded]); |
| 234 | +} |
| 235 | + |
| 236 | +// Update total bytes sent |
| 237 | +this.totalBytesSent+=chunk.length; |
| 238 | + |
| 239 | +returnchunk; |
| 240 | +} |
| 241 | +} |