Play/Stream/Record PCM audio data & Encode/Decode Opus to PCM audio data
npm install @voicehype/audify-plusMade with ❤️ by VoiceHype, Alhamdulillah! Visit voicehype.ai
Stop Typing. Start Talking.
Transcribe accurately, optimize with AI, and super-charge your workflow.
---
⚠️ Important ⚠️
If you are using Audify Plus in a VS Code extension, please review the VS Code Packaging Notes at the end of this document.
Bismillahir Rahmanir Raheem (In the name of Allah, the Most Gracious, the Most Merciful)
Enhanced cross-platform audio I/O library with VS Code extension support. Based on the original Audify project with pre-bundled binaries.
We couldn't find any robust solution for audio I/O library that works seamlessly in VS Code extensions without going through the hassle of compiling binaries. Audify-JS-Plus addresses this by providing pre-built binaries for Windows, macOS, and Linux.
- Cross-platform audio processing - Works on Windows, macOS, and Linux
- VS Code extension optimized - Direct binary loading without file system operations
- Opus encoding/decoding - High-quality audio compression
- RtAudio integration - Real-time audio input/output
- Zero dependencies - All native binaries included
``bash`
npm i @voicehype/audify-plus
- Windows: x64, ia32
- macOS: x64, arm64 (Apple Silicon)
- Linux: x64, arm64, arm
`javascript
const { OpusEncoder, OpusDecoder, OpusApplication } = require("@voicehype/audify-plus");
// Init encoder and decoder
// Sample rate is 48kHz and the amount of channels is 2
// The opus coding mode is optimized for audio
const encoder = new OpusEncoder(48000, 2, OpusApplication.OPUS_APPLICATION_AUDIO);
const decoder = new OpusDecoder(48000, 2);
const frameSize = 1920; // 40ms
const buffer = ... // Your PCM audio buffer
// Encode and then decode
var encoded = encoder.encode(buffer, frameSize);
var decoded = decoder.decode(encoded, frameSize);
`
`javascript
const { RtAudio, RtAudioFormat } = require("@voicehype/audify-plus");
// Init RtAudio instance using default sound API
const rtAudio = new RtAudio(/ Insert here specific API if needed /);
// Open the input/output stream
rtAudio.openStream(
{
deviceId: rtAudio.getDefaultOutputDevice(), // Output device id (Get all devices using getDevices)getDevices
nChannels: 1, // Number of channels
firstChannel: 0, // First channel index on device (default = 0).
},
{
deviceId: rtAudio.getDefaultInputDevice(), // Input device id (Get all devices using )
nChannels: 1, // Number of channels
firstChannel: 0, // First channel index on device (default = 0).
},
RtAudioFormat.RTAUDIO_SINT16, // PCM Format - Signed 16-bit integer
48000, // Sampling rate is 48kHz
1920, // Frame size is 1920 (40ms)
"MyStream", // The name of the stream (used for JACK Api)
(pcm) => rtAudio.write(pcm) // Input callback function, write every input pcm data to the output buffer
);
// Start the stream
rtAudio.start();
`
`javascript
const { RtAudio, RtAudioApi } = require("@voicehype/audify-plus");
const rtAudio = new RtAudio(RtAudioApi.RTAUDIO_API_UNSPECIFIED);
const devices = rtAudio.getDevices();
console.log('Available audio devices:', devices);
`
javascript
const { OpusApplication } = audify;
- OpusApplication.OPUS_APPLICATION_VOIP
- OpusApplication.OPUS_APPLICATION_AUDIO
- OpusApplication.OPUS_APPLICATION_RESTRICTED_LOWDELAY
`$3
`javascript
const { RtAudioApi } = audify;
- RtAudioApi.RTAUDIO_API_UNSPECIFIED
- RtAudioApi.RTAUDIO_API_LINUX_ALSA
- RtAudioApi.RTAUDIO_API_LINUX_PULSE
- RtAudioApi.RTAUDIO_API_MACOSX_CORE
- RtAudioApi.RTAUDIO_API_WINDOWS_WASAPI
// ... and more
`📈 Performance
- Zero runtime dependencies - All binaries are prebuilt
- Direct binary loading - No file copying at runtime
- Optimized for extensions - Minimal file system operations
- Cross-platform - Native performance on all supported platforms
🤝 Contributing
This is an enhanced version of the original Audify project. For issues related to the core audio functionality, please refer to the original Audify repository.
For issues specific to audify-plus enhancements:
1. Fork this repository
2. Create a feature branch
3. Make your changes
4. Test across platforms
5. Submit a pull request
📄 License
MIT License - same as the original Audify project.
🙏 Acknowledgments
- Original Audify project by almoghamdani
- The Opus codec team
- The RtAudio library developers
📚 API Reference
$3
####
OpusEncoder
- constructor(sampleRate, channels, application)
- encode(buffer) - Encode PCM audio to Opus
- destroy() - Clean up encoder resources####
OpusDecoder
- constructor(sampleRate, channels)
- decode(buffer) - Decode Opus audio to PCM
- destroy() - Clean up decoder resources####
RtAudio
- constructor(api)
- getDevices() - Get available audio devices
- openStream(outputParams, inputParams, format, sampleRate, bufferFrames, callback)
- closeStream() - Close audio stream
- startStream() - Start audio processing
- stopStream() - Stop audio processing---
VS Code Packaging Notes
When using Audify Plus in a VS Code extension, these configurations are critical for proper functionality:
1. Webpack Configuration
The externals configuration prevents Webpack from bundling the package, ensuring the pre-built binaries remain accessible:
`javascript
'@voicehype/audify-plus': 'commonjs @voicehype/audify-plus'
`
This tells Webpack to treat audify-plus as an external dependency that will be available at runtime2. VS Code Ignore File
The ignore file modification ensures all necessary package files are included in the VSIX package:
`
!node_modules/@voicehype/audify-plus/**
`
The !` prefix overrides the default node_modules exclusion, including the package's pre-built binaries3. Binary Loading
Audify Plus binaries are automatically loaded from the prebuilt packages. These configurations ensure:
- Binaries are properly packaged in the extension
- Correct module resolution at runtime
- No file system permission issues
Made with ❤️ by VoiceHype, Alhamdulillah! Visit voicehype.ai