@discordjs/voice
Version:
Implementation of the Discord Voice API for Node.js
1,463 lines (1,445 loc) • 91.8 kB
JavaScript
"use strict";
var __create = Object.create;
var __defProp = Object.defineProperty;
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
var __getOwnPropNames = Object.getOwnPropertyNames;
var __getProtoOf = Object.getPrototypeOf;
var __hasOwnProp = Object.prototype.hasOwnProperty;
var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
var __export = (target, all) => {
for (var name in all)
__defProp(target, name, { get: all[name], enumerable: true });
};
var __copyProps = (to, from, except, desc) => {
if (from && typeof from === "object" || typeof from === "function") {
for (let key of __getOwnPropNames(from))
if (!__hasOwnProp.call(to, key) && key !== except)
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
}
return to;
};
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
// If the importer is in node compatibility mode or this is not an ESM
// file that has been converted to a CommonJS file using a Babel-
// compatible transform (i.e. "__esModule" has not been set), then set
// "default" to the CommonJS "module.exports" for node compatibility.
isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
mod
));
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
// src/index.ts
var src_exports = {};
__export(src_exports, {
AudioPlayer: () => AudioPlayer,
AudioPlayerError: () => AudioPlayerError,
AudioPlayerStatus: () => AudioPlayerStatus,
AudioReceiveStream: () => AudioReceiveStream,
AudioResource: () => AudioResource,
EndBehaviorType: () => EndBehaviorType,
NoSubscriberBehavior: () => NoSubscriberBehavior,
PlayerSubscription: () => PlayerSubscription,
SSRCMap: () => SSRCMap,
SpeakingMap: () => SpeakingMap,
StreamType: () => StreamType,
VoiceConnection: () => VoiceConnection,
VoiceConnectionDisconnectReason: () => VoiceConnectionDisconnectReason,
VoiceConnectionStatus: () => VoiceConnectionStatus,
VoiceReceiver: () => VoiceReceiver,
createAudioPlayer: () => createAudioPlayer,
createAudioResource: () => createAudioResource,
createDefaultAudioReceiveStreamOptions: () => createDefaultAudioReceiveStreamOptions,
demuxProbe: () => demuxProbe,
entersState: () => entersState,
generateDependencyReport: () => generateDependencyReport,
getGroups: () => getGroups,
getVoiceConnection: () => getVoiceConnection,
getVoiceConnections: () => getVoiceConnections,
joinVoiceChannel: () => joinVoiceChannel,
validateDiscordOpusHead: () => validateDiscordOpusHead,
version: () => version2
});
module.exports = __toCommonJS(src_exports);
// src/VoiceConnection.ts
var import_node_events7 = require("events");
// src/DataStore.ts
var import_v10 = require("discord-api-types/v10");
function createJoinVoiceChannelPayload(config) {
return {
op: import_v10.GatewayOpcodes.VoiceStateUpdate,
// eslint-disable-next-line id-length
d: {
guild_id: config.guildId,
channel_id: config.channelId,
self_deaf: config.selfDeaf,
self_mute: config.selfMute
}
};
}
__name(createJoinVoiceChannelPayload, "createJoinVoiceChannelPayload");
var groups = /* @__PURE__ */ new Map();
groups.set("default", /* @__PURE__ */ new Map());
function getOrCreateGroup(group) {
const existing = groups.get(group);
if (existing) return existing;
const map = /* @__PURE__ */ new Map();
groups.set(group, map);
return map;
}
__name(getOrCreateGroup, "getOrCreateGroup");
function getGroups() {
return groups;
}
__name(getGroups, "getGroups");
function getVoiceConnections(group = "default") {
return groups.get(group);
}
__name(getVoiceConnections, "getVoiceConnections");
function getVoiceConnection(guildId, group = "default") {
return getVoiceConnections(group)?.get(guildId);
}
__name(getVoiceConnection, "getVoiceConnection");
function untrackVoiceConnection(voiceConnection) {
return getVoiceConnections(voiceConnection.joinConfig.group)?.delete(voiceConnection.joinConfig.guildId);
}
__name(untrackVoiceConnection, "untrackVoiceConnection");
function trackVoiceConnection(voiceConnection) {
return getOrCreateGroup(voiceConnection.joinConfig.group).set(voiceConnection.joinConfig.guildId, voiceConnection);
}
__name(trackVoiceConnection, "trackVoiceConnection");
var FRAME_LENGTH = 20;
var audioCycleInterval;
var nextTime = -1;
var audioPlayers = [];
function audioCycleStep() {
if (nextTime === -1) return;
nextTime += FRAME_LENGTH;
const available = audioPlayers.filter((player) => player.checkPlayable());
for (const player of available) {
player["_stepDispatch"]();
}
prepareNextAudioFrame(available);
}
__name(audioCycleStep, "audioCycleStep");
function prepareNextAudioFrame(players) {
const nextPlayer = players.shift();
if (!nextPlayer) {
if (nextTime !== -1) {
audioCycleInterval = setTimeout(() => audioCycleStep(), nextTime - Date.now());
}
return;
}
nextPlayer["_stepPrepare"]();
setImmediate(() => prepareNextAudioFrame(players));
}
__name(prepareNextAudioFrame, "prepareNextAudioFrame");
function hasAudioPlayer(target) {
return audioPlayers.includes(target);
}
__name(hasAudioPlayer, "hasAudioPlayer");
function addAudioPlayer(player) {
if (hasAudioPlayer(player)) return player;
audioPlayers.push(player);
if (audioPlayers.length === 1) {
nextTime = Date.now();
setImmediate(() => audioCycleStep());
}
return player;
}
__name(addAudioPlayer, "addAudioPlayer");
function deleteAudioPlayer(player) {
const index = audioPlayers.indexOf(player);
if (index === -1) return;
audioPlayers.splice(index, 1);
if (audioPlayers.length === 0) {
nextTime = -1;
if (audioCycleInterval !== void 0) clearTimeout(audioCycleInterval);
}
}
__name(deleteAudioPlayer, "deleteAudioPlayer");
// src/networking/Networking.ts
var import_node_buffer3 = require("buffer");
var import_node_crypto = __toESM(require("crypto"));
var import_node_events3 = require("events");
var import_v42 = require("discord-api-types/voice/v4");
// src/util/Secretbox.ts
var import_node_buffer = require("buffer");
var libs = {
"sodium-native": /* @__PURE__ */ __name((sodium) => ({
crypto_aead_xchacha20poly1305_ietf_decrypt: /* @__PURE__ */ __name((cipherText, additionalData, nonce2, key) => {
const message = import_node_buffer.Buffer.alloc(cipherText.length - sodium.crypto_aead_xchacha20poly1305_ietf_ABYTES);
sodium.crypto_aead_xchacha20poly1305_ietf_decrypt(message, null, cipherText, additionalData, nonce2, key);
return message;
}, "crypto_aead_xchacha20poly1305_ietf_decrypt"),
crypto_aead_xchacha20poly1305_ietf_encrypt: /* @__PURE__ */ __name((plaintext, additionalData, nonce2, key) => {
const cipherText = import_node_buffer.Buffer.alloc(plaintext.length + sodium.crypto_aead_xchacha20poly1305_ietf_ABYTES);
sodium.crypto_aead_xchacha20poly1305_ietf_encrypt(cipherText, plaintext, additionalData, null, nonce2, key);
return cipherText;
}, "crypto_aead_xchacha20poly1305_ietf_encrypt")
}), "sodium-native"),
sodium: /* @__PURE__ */ __name((sodium) => ({
crypto_aead_xchacha20poly1305_ietf_decrypt: /* @__PURE__ */ __name((cipherText, additionalData, nonce2, key) => {
return sodium.api.crypto_aead_xchacha20poly1305_ietf_decrypt(cipherText, additionalData, null, nonce2, key);
}, "crypto_aead_xchacha20poly1305_ietf_decrypt"),
crypto_aead_xchacha20poly1305_ietf_encrypt: /* @__PURE__ */ __name((plaintext, additionalData, nonce2, key) => {
return sodium.api.crypto_aead_xchacha20poly1305_ietf_encrypt(plaintext, additionalData, null, nonce2, key);
}, "crypto_aead_xchacha20poly1305_ietf_encrypt")
}), "sodium"),
"libsodium-wrappers": /* @__PURE__ */ __name((sodium) => ({
crypto_aead_xchacha20poly1305_ietf_decrypt: /* @__PURE__ */ __name((cipherText, additionalData, nonce2, key) => {
return sodium.crypto_aead_xchacha20poly1305_ietf_decrypt(null, cipherText, additionalData, nonce2, key);
}, "crypto_aead_xchacha20poly1305_ietf_decrypt"),
crypto_aead_xchacha20poly1305_ietf_encrypt: /* @__PURE__ */ __name((plaintext, additionalData, nonce2, key) => {
return sodium.crypto_aead_xchacha20poly1305_ietf_encrypt(plaintext, additionalData, null, nonce2, key);
}, "crypto_aead_xchacha20poly1305_ietf_encrypt")
}), "libsodium-wrappers"),
"@stablelib/xchacha20poly1305": /* @__PURE__ */ __name((stablelib) => ({
crypto_aead_xchacha20poly1305_ietf_decrypt(plaintext, additionalData, nonce2, key) {
const crypto3 = new stablelib.XChaCha20Poly1305(key);
return crypto3.open(nonce2, plaintext, additionalData);
},
crypto_aead_xchacha20poly1305_ietf_encrypt(cipherText, additionalData, nonce2, key) {
const crypto3 = new stablelib.XChaCha20Poly1305(key);
return crypto3.seal(nonce2, cipherText, additionalData);
}
}), "@stablelib/xchacha20poly1305"),
"@noble/ciphers/chacha": /* @__PURE__ */ __name((noble) => ({
crypto_aead_xchacha20poly1305_ietf_decrypt(cipherText, additionalData, nonce2, key) {
const chacha = noble.xchacha20poly1305(key, nonce2, additionalData);
return chacha.decrypt(cipherText);
},
crypto_aead_xchacha20poly1305_ietf_encrypt(plaintext, additionalData, nonce2, key) {
const chacha = noble.xchacha20poly1305(key, nonce2, additionalData);
return chacha.encrypt(plaintext);
}
}), "@noble/ciphers/chacha")
};
var fallbackError = /* @__PURE__ */ __name(() => {
throw new Error(
`Cannot play audio as no valid encryption package is installed.
- Install one of:
- sodium
- libsodium-wrappers
- @stablelib/xchacha20poly1305
- @noble/ciphers.
- Use the generateDependencyReport() function for more information.
`
);
}, "fallbackError");
var methods = {
crypto_aead_xchacha20poly1305_ietf_encrypt: fallbackError,
crypto_aead_xchacha20poly1305_ietf_decrypt: fallbackError
};
var secretboxLoadPromise = new Promise(async (resolve2) => {
for (const libName of Object.keys(libs)) {
try {
const lib = await import(libName);
if (libName === "libsodium-wrappers" && lib.ready) {
await lib.ready;
}
Object.assign(methods, libs[libName](lib));
break;
} catch {
}
}
resolve2();
});
// src/util/util.ts
var noop = /* @__PURE__ */ __name(() => {
}, "noop");
// src/networking/VoiceUDPSocket.ts
var import_node_buffer2 = require("buffer");
var import_node_dgram = require("dgram");
var import_node_events = require("events");
var import_node_net = require("net");
function parseLocalPacket(message) {
const packet = import_node_buffer2.Buffer.from(message);
const ip = packet.slice(8, packet.indexOf(0, 8)).toString("utf8");
if (!(0, import_node_net.isIPv4)(ip)) {
throw new Error("Malformed IP address");
}
const port = packet.readUInt16BE(packet.length - 2);
return { ip, port };
}
__name(parseLocalPacket, "parseLocalPacket");
var KEEP_ALIVE_INTERVAL = 5e3;
var MAX_COUNTER_VALUE = 2 ** 32 - 1;
var VoiceUDPSocket = class extends import_node_events.EventEmitter {
static {
__name(this, "VoiceUDPSocket");
}
/**
* The underlying network Socket for the VoiceUDPSocket.
*/
socket;
/**
* The socket details for Discord (remote)
*/
remote;
/**
* The counter used in the keep alive mechanism.
*/
keepAliveCounter = 0;
/**
* The buffer used to write the keep alive counter into.
*/
keepAliveBuffer;
/**
* The Node.js interval for the keep-alive mechanism.
*/
keepAliveInterval;
/**
* The time taken to receive a response to keep alive messages.
*
* @deprecated This field is no longer updated as keep alive messages are no longer tracked.
*/
ping;
/**
* Creates a new VoiceUDPSocket.
*
* @param remote - Details of the remote socket
*/
constructor(remote) {
super();
this.socket = (0, import_node_dgram.createSocket)("udp4");
this.socket.on("error", (error) => this.emit("error", error));
this.socket.on("message", (buffer) => this.onMessage(buffer));
this.socket.on("close", () => this.emit("close"));
this.remote = remote;
this.keepAliveBuffer = import_node_buffer2.Buffer.alloc(8);
this.keepAliveInterval = setInterval(() => this.keepAlive(), KEEP_ALIVE_INTERVAL);
setImmediate(() => this.keepAlive());
}
/**
* Called when a message is received on the UDP socket.
*
* @param buffer - The received buffer
*/
onMessage(buffer) {
this.emit("message", buffer);
}
/**
* Called at a regular interval to check whether we are still able to send datagrams to Discord.
*/
keepAlive() {
this.keepAliveBuffer.writeUInt32LE(this.keepAliveCounter, 0);
this.send(this.keepAliveBuffer);
this.keepAliveCounter++;
if (this.keepAliveCounter > MAX_COUNTER_VALUE) {
this.keepAliveCounter = 0;
}
}
/**
* Sends a buffer to Discord.
*
* @param buffer - The buffer to send
*/
send(buffer) {
this.socket.send(buffer, this.remote.port, this.remote.ip);
}
/**
* Closes the socket, the instance will not be able to be reused.
*/
destroy() {
try {
this.socket.close();
} catch {
}
clearInterval(this.keepAliveInterval);
}
/**
* Performs IP discovery to discover the local address and port to be used for the voice connection.
*
* @param ssrc - The SSRC received from Discord
*/
async performIPDiscovery(ssrc) {
return new Promise((resolve2, reject) => {
const listener = /* @__PURE__ */ __name((message) => {
try {
if (message.readUInt16BE(0) !== 2) return;
const packet = parseLocalPacket(message);
this.socket.off("message", listener);
resolve2(packet);
} catch {
}
}, "listener");
this.socket.on("message", listener);
this.socket.once("close", () => reject(new Error("Cannot perform IP discovery - socket closed")));
const discoveryBuffer = import_node_buffer2.Buffer.alloc(74);
discoveryBuffer.writeUInt16BE(1, 0);
discoveryBuffer.writeUInt16BE(70, 2);
discoveryBuffer.writeUInt32BE(ssrc, 4);
this.send(discoveryBuffer);
});
}
};
// src/networking/VoiceWebSocket.ts
var import_node_events2 = require("events");
var import_v4 = require("discord-api-types/voice/v4");
var import_ws = __toESM(require("ws"));
var VoiceWebSocket = class extends import_node_events2.EventEmitter {
static {
__name(this, "VoiceWebSocket");
}
/**
* The current heartbeat interval, if any.
*/
heartbeatInterval;
/**
* The time (milliseconds since UNIX epoch) that the last heartbeat acknowledgement packet was received.
* This is set to 0 if an acknowledgement packet hasn't been received yet.
*/
lastHeartbeatAck;
/**
* The time (milliseconds since UNIX epoch) that the last heartbeat was sent. This is set to 0 if a heartbeat
* hasn't been sent yet.
*/
lastHeartbeatSend;
/**
* The number of consecutively missed heartbeats.
*/
missedHeartbeats = 0;
/**
* The last recorded ping.
*/
ping;
/**
* The debug logger function, if debugging is enabled.
*/
debug;
/**
* The underlying WebSocket of this wrapper.
*/
ws;
/**
* Creates a new VoiceWebSocket.
*
* @param address - The address to connect to
*/
constructor(address, debug) {
super();
this.ws = new import_ws.default(address);
this.ws.onmessage = (err) => this.onMessage(err);
this.ws.onopen = (err) => this.emit("open", err);
this.ws.onerror = (err) => this.emit("error", err instanceof Error ? err : err.error);
this.ws.onclose = (err) => this.emit("close", err);
this.lastHeartbeatAck = 0;
this.lastHeartbeatSend = 0;
this.debug = debug ? (message) => this.emit("debug", message) : null;
}
/**
* Destroys the VoiceWebSocket. The heartbeat interval is cleared, and the connection is closed.
*/
destroy() {
try {
this.debug?.("destroyed");
this.setHeartbeatInterval(-1);
this.ws.close(1e3);
} catch (error) {
const err = error;
this.emit("error", err);
}
}
/**
* Handles message events on the WebSocket. Attempts to JSON parse the messages and emit them
* as packets.
*
* @param event - The message event
*/
onMessage(event) {
if (typeof event.data !== "string") return;
this.debug?.(`<< ${event.data}`);
let packet;
try {
packet = JSON.parse(event.data);
} catch (error) {
const err = error;
this.emit("error", err);
return;
}
if (packet.op === import_v4.VoiceOpcodes.HeartbeatAck) {
this.lastHeartbeatAck = Date.now();
this.missedHeartbeats = 0;
this.ping = this.lastHeartbeatAck - this.lastHeartbeatSend;
}
this.emit("packet", packet);
}
/**
* Sends a JSON-stringifiable packet over the WebSocket.
*
* @param packet - The packet to send
*/
sendPacket(packet) {
try {
const stringified = JSON.stringify(packet);
this.debug?.(`>> ${stringified}`);
this.ws.send(stringified);
} catch (error) {
const err = error;
this.emit("error", err);
}
}
/**
* Sends a heartbeat over the WebSocket.
*/
sendHeartbeat() {
this.lastHeartbeatSend = Date.now();
this.missedHeartbeats++;
const nonce2 = this.lastHeartbeatSend;
this.sendPacket({
op: import_v4.VoiceOpcodes.Heartbeat,
// eslint-disable-next-line id-length
d: nonce2
});
}
/**
* Sets/clears an interval to send heartbeats over the WebSocket.
*
* @param ms - The interval in milliseconds. If negative, the interval will be unset
*/
setHeartbeatInterval(ms) {
if (this.heartbeatInterval !== void 0) clearInterval(this.heartbeatInterval);
if (ms > 0) {
this.heartbeatInterval = setInterval(() => {
if (this.lastHeartbeatSend !== 0 && this.missedHeartbeats >= 3) {
this.ws.close();
this.setHeartbeatInterval(-1);
}
this.sendHeartbeat();
}, ms);
}
}
};
// src/networking/Networking.ts
var CHANNELS = 2;
var TIMESTAMP_INC = 48e3 / 100 * CHANNELS;
var MAX_NONCE_SIZE = 2 ** 32 - 1;
var SUPPORTED_ENCRYPTION_MODES = ["aead_xchacha20_poly1305_rtpsize"];
if (import_node_crypto.default.getCiphers().includes("aes-256-gcm")) {
SUPPORTED_ENCRYPTION_MODES.unshift("aead_aes256_gcm_rtpsize");
}
var nonce = import_node_buffer3.Buffer.alloc(24);
function stringifyState(state) {
return JSON.stringify({
...state,
ws: Reflect.has(state, "ws"),
udp: Reflect.has(state, "udp")
});
}
__name(stringifyState, "stringifyState");
function chooseEncryptionMode(options) {
const option = options.find((option2) => SUPPORTED_ENCRYPTION_MODES.includes(option2));
if (!option) {
throw new Error(`No compatible encryption modes. Available include: ${options.join(", ")}`);
}
return option;
}
__name(chooseEncryptionMode, "chooseEncryptionMode");
function randomNBit(numberOfBits) {
return Math.floor(Math.random() * 2 ** numberOfBits);
}
__name(randomNBit, "randomNBit");
var Networking = class extends import_node_events3.EventEmitter {
static {
__name(this, "Networking");
}
_state;
/**
* The debug logger function, if debugging is enabled.
*/
debug;
/**
* Creates a new Networking instance.
*/
constructor(options, debug) {
super();
this.onWsOpen = this.onWsOpen.bind(this);
this.onChildError = this.onChildError.bind(this);
this.onWsPacket = this.onWsPacket.bind(this);
this.onWsClose = this.onWsClose.bind(this);
this.onWsDebug = this.onWsDebug.bind(this);
this.onUdpDebug = this.onUdpDebug.bind(this);
this.onUdpClose = this.onUdpClose.bind(this);
this.debug = debug ? (message) => this.emit("debug", message) : null;
this._state = {
code: 0 /* OpeningWs */,
ws: this.createWebSocket(options.endpoint),
connectionOptions: options
};
}
/**
* Destroys the Networking instance, transitioning it into the Closed state.
*/
destroy() {
this.state = {
code: 6 /* Closed */
};
}
/**
* The current state of the networking instance.
*/
get state() {
return this._state;
}
/**
* Sets a new state for the networking instance, performing clean-up operations where necessary.
*/
set state(newState) {
const oldWs = Reflect.get(this._state, "ws");
const newWs = Reflect.get(newState, "ws");
if (oldWs && oldWs !== newWs) {
oldWs.off("debug", this.onWsDebug);
oldWs.on("error", noop);
oldWs.off("error", this.onChildError);
oldWs.off("open", this.onWsOpen);
oldWs.off("packet", this.onWsPacket);
oldWs.off("close", this.onWsClose);
oldWs.destroy();
}
const oldUdp = Reflect.get(this._state, "udp");
const newUdp = Reflect.get(newState, "udp");
if (oldUdp && oldUdp !== newUdp) {
oldUdp.on("error", noop);
oldUdp.off("error", this.onChildError);
oldUdp.off("close", this.onUdpClose);
oldUdp.off("debug", this.onUdpDebug);
oldUdp.destroy();
}
const oldState = this._state;
this._state = newState;
this.emit("stateChange", oldState, newState);
this.debug?.(`state change:
from ${stringifyState(oldState)}
to ${stringifyState(newState)}`);
}
/**
* Creates a new WebSocket to a Discord Voice gateway.
*
* @param endpoint - The endpoint to connect to
*/
createWebSocket(endpoint) {
const ws = new VoiceWebSocket(`wss://${endpoint}?v=4`, Boolean(this.debug));
ws.on("error", this.onChildError);
ws.once("open", this.onWsOpen);
ws.on("packet", this.onWsPacket);
ws.once("close", this.onWsClose);
ws.on("debug", this.onWsDebug);
return ws;
}
/**
* Propagates errors from the children VoiceWebSocket and VoiceUDPSocket.
*
* @param error - The error that was emitted by a child
*/
onChildError(error) {
this.emit("error", error);
}
/**
* Called when the WebSocket opens. Depending on the state that the instance is in,
* it will either identify with a new session, or it will attempt to resume an existing session.
*/
onWsOpen() {
if (this.state.code === 0 /* OpeningWs */) {
const packet = {
op: import_v42.VoiceOpcodes.Identify,
d: {
server_id: this.state.connectionOptions.serverId,
user_id: this.state.connectionOptions.userId,
session_id: this.state.connectionOptions.sessionId,
token: this.state.connectionOptions.token
}
};
this.state.ws.sendPacket(packet);
this.state = {
...this.state,
code: 1 /* Identifying */
};
} else if (this.state.code === 5 /* Resuming */) {
const packet = {
op: import_v42.VoiceOpcodes.Resume,
d: {
server_id: this.state.connectionOptions.serverId,
session_id: this.state.connectionOptions.sessionId,
token: this.state.connectionOptions.token
}
};
this.state.ws.sendPacket(packet);
}
}
/**
* Called when the WebSocket closes. Based on the reason for closing (given by the code parameter),
* the instance will either attempt to resume, or enter the closed state and emit a 'close' event
* with the close code, allowing the user to decide whether or not they would like to reconnect.
*
* @param code - The close code
*/
onWsClose({ code }) {
const canResume = code === 4015 || code < 4e3;
if (canResume && this.state.code === 4 /* Ready */) {
this.state = {
...this.state,
code: 5 /* Resuming */,
ws: this.createWebSocket(this.state.connectionOptions.endpoint)
};
} else if (this.state.code !== 6 /* Closed */) {
this.destroy();
this.emit("close", code);
}
}
/**
* Called when the UDP socket has closed itself if it has stopped receiving replies from Discord.
*/
onUdpClose() {
if (this.state.code === 4 /* Ready */) {
this.state = {
...this.state,
code: 5 /* Resuming */,
ws: this.createWebSocket(this.state.connectionOptions.endpoint)
};
}
}
/**
* Called when a packet is received on the connection's WebSocket.
*
* @param packet - The received packet
*/
onWsPacket(packet) {
if (packet.op === import_v42.VoiceOpcodes.Hello && this.state.code !== 6 /* Closed */) {
this.state.ws.setHeartbeatInterval(packet.d.heartbeat_interval);
} else if (packet.op === import_v42.VoiceOpcodes.Ready && this.state.code === 1 /* Identifying */) {
const { ip, port, ssrc, modes } = packet.d;
const udp = new VoiceUDPSocket({ ip, port });
udp.on("error", this.onChildError);
udp.on("debug", this.onUdpDebug);
udp.once("close", this.onUdpClose);
udp.performIPDiscovery(ssrc).then((localConfig) => {
if (this.state.code !== 2 /* UdpHandshaking */) return;
this.state.ws.sendPacket({
op: import_v42.VoiceOpcodes.SelectProtocol,
d: {
protocol: "udp",
data: {
address: localConfig.ip,
port: localConfig.port,
mode: chooseEncryptionMode(modes)
}
}
});
this.state = {
...this.state,
code: 3 /* SelectingProtocol */
};
}).catch((error) => this.emit("error", error));
this.state = {
...this.state,
code: 2 /* UdpHandshaking */,
udp,
connectionData: {
ssrc
}
};
} else if (packet.op === import_v42.VoiceOpcodes.SessionDescription && this.state.code === 3 /* SelectingProtocol */) {
const { mode: encryptionMode, secret_key: secretKey } = packet.d;
this.state = {
...this.state,
code: 4 /* Ready */,
connectionData: {
...this.state.connectionData,
encryptionMode,
secretKey: new Uint8Array(secretKey),
sequence: randomNBit(16),
timestamp: randomNBit(32),
nonce: 0,
nonceBuffer: encryptionMode === "aead_aes256_gcm_rtpsize" ? import_node_buffer3.Buffer.alloc(12) : import_node_buffer3.Buffer.alloc(24),
speaking: false,
packetsPlayed: 0
}
};
} else if (packet.op === import_v42.VoiceOpcodes.Resumed && this.state.code === 5 /* Resuming */) {
this.state = {
...this.state,
code: 4 /* Ready */
};
this.state.connectionData.speaking = false;
}
}
/**
* Propagates debug messages from the child WebSocket.
*
* @param message - The emitted debug message
*/
onWsDebug(message) {
this.debug?.(`[WS] ${message}`);
}
/**
* Propagates debug messages from the child UDPSocket.
*
* @param message - The emitted debug message
*/
onUdpDebug(message) {
this.debug?.(`[UDP] ${message}`);
}
/**
* Prepares an Opus packet for playback. This includes attaching metadata to it and encrypting it.
* It will be stored within the instance, and can be played by dispatchAudio()
*
* @remarks
* Calling this method while there is already a prepared audio packet that has not yet been dispatched
* will overwrite the existing audio packet. This should be avoided.
* @param opusPacket - The Opus packet to encrypt
* @returns The audio packet that was prepared
*/
prepareAudioPacket(opusPacket) {
const state = this.state;
if (state.code !== 4 /* Ready */) return;
state.preparedPacket = this.createAudioPacket(opusPacket, state.connectionData);
return state.preparedPacket;
}
/**
* Dispatches the audio packet previously prepared by prepareAudioPacket(opusPacket). The audio packet
* is consumed and cannot be dispatched again.
*/
dispatchAudio() {
const state = this.state;
if (state.code !== 4 /* Ready */) return false;
if (state.preparedPacket !== void 0) {
this.playAudioPacket(state.preparedPacket);
state.preparedPacket = void 0;
return true;
}
return false;
}
/**
* Plays an audio packet, updating timing metadata used for playback.
*
* @param audioPacket - The audio packet to play
*/
playAudioPacket(audioPacket) {
const state = this.state;
if (state.code !== 4 /* Ready */) return;
const { connectionData } = state;
connectionData.packetsPlayed++;
connectionData.sequence++;
connectionData.timestamp += TIMESTAMP_INC;
if (connectionData.sequence >= 2 ** 16) connectionData.sequence = 0;
if (connectionData.timestamp >= 2 ** 32) connectionData.timestamp = 0;
this.setSpeaking(true);
state.udp.send(audioPacket);
}
/**
* Sends a packet to the voice gateway indicating that the client has start/stopped sending
* audio.
*
* @param speaking - Whether or not the client should be shown as speaking
*/
setSpeaking(speaking) {
const state = this.state;
if (state.code !== 4 /* Ready */) return;
if (state.connectionData.speaking === speaking) return;
state.connectionData.speaking = speaking;
state.ws.sendPacket({
op: import_v42.VoiceOpcodes.Speaking,
d: {
speaking: speaking ? 1 : 0,
delay: 0,
ssrc: state.connectionData.ssrc
}
});
}
/**
* Creates a new audio packet from an Opus packet. This involves encrypting the packet,
* then prepending a header that includes metadata.
*
* @param opusPacket - The Opus packet to prepare
* @param connectionData - The current connection data of the instance
*/
createAudioPacket(opusPacket, connectionData) {
const rtpHeader = import_node_buffer3.Buffer.alloc(12);
rtpHeader[0] = 128;
rtpHeader[1] = 120;
const { sequence, timestamp, ssrc } = connectionData;
rtpHeader.writeUIntBE(sequence, 2, 2);
rtpHeader.writeUIntBE(timestamp, 4, 4);
rtpHeader.writeUIntBE(ssrc, 8, 4);
rtpHeader.copy(nonce, 0, 0, 12);
return import_node_buffer3.Buffer.concat([rtpHeader, ...this.encryptOpusPacket(opusPacket, connectionData, rtpHeader)]);
}
/**
* Encrypts an Opus packet using the format agreed upon by the instance and Discord.
*
* @param opusPacket - The Opus packet to encrypt
* @param connectionData - The current connection data of the instance
*/
encryptOpusPacket(opusPacket, connectionData, additionalData) {
const { secretKey, encryptionMode } = connectionData;
connectionData.nonce++;
if (connectionData.nonce > MAX_NONCE_SIZE) connectionData.nonce = 0;
connectionData.nonceBuffer.writeUInt32BE(connectionData.nonce, 0);
const noncePadding = connectionData.nonceBuffer.subarray(0, 4);
let encrypted;
switch (encryptionMode) {
case "aead_aes256_gcm_rtpsize": {
const cipher = import_node_crypto.default.createCipheriv("aes-256-gcm", secretKey, connectionData.nonceBuffer);
cipher.setAAD(additionalData);
encrypted = import_node_buffer3.Buffer.concat([cipher.update(opusPacket), cipher.final(), cipher.getAuthTag()]);
return [encrypted, noncePadding];
}
case "aead_xchacha20_poly1305_rtpsize": {
encrypted = methods.crypto_aead_xchacha20poly1305_ietf_encrypt(
opusPacket,
additionalData,
connectionData.nonceBuffer,
secretKey
);
return [encrypted, noncePadding];
}
default: {
throw new RangeError(`Unsupported encryption method: ${encryptionMode}`);
}
}
}
};
// src/receive/VoiceReceiver.ts
var import_node_buffer5 = require("buffer");
var import_node_crypto2 = __toESM(require("crypto"));
var import_v43 = require("discord-api-types/voice/v4");
// src/receive/AudioReceiveStream.ts
var import_node_stream = require("stream");
// src/audio/AudioPlayer.ts
var import_node_buffer4 = require("buffer");
var import_node_events4 = require("events");
// src/audio/AudioPlayerError.ts
var AudioPlayerError = class extends Error {
static {
__name(this, "AudioPlayerError");
}
/**
* The resource associated with the audio player at the time the error was thrown.
*/
resource;
constructor(error, resource) {
super(error.message);
this.resource = resource;
this.name = error.name;
this.stack = error.stack;
}
};
// src/audio/PlayerSubscription.ts
var PlayerSubscription = class {
static {
__name(this, "PlayerSubscription");
}
/**
* The voice connection of this subscription.
*/
connection;
/**
* The audio player of this subscription.
*/
player;
constructor(connection, player) {
this.connection = connection;
this.player = player;
}
/**
* Unsubscribes the connection from the audio player, meaning that the
* audio player cannot stream audio to it until a new subscription is made.
*/
unsubscribe() {
this.connection["onSubscriptionRemoved"](this);
this.player["unsubscribe"](this);
}
};
// src/audio/AudioPlayer.ts
var SILENCE_FRAME = import_node_buffer4.Buffer.from([248, 255, 254]);
var NoSubscriberBehavior = /* @__PURE__ */ ((NoSubscriberBehavior2) => {
NoSubscriberBehavior2["Pause"] = "pause";
NoSubscriberBehavior2["Play"] = "play";
NoSubscriberBehavior2["Stop"] = "stop";
return NoSubscriberBehavior2;
})(NoSubscriberBehavior || {});
var AudioPlayerStatus = /* @__PURE__ */ ((AudioPlayerStatus2) => {
AudioPlayerStatus2["AutoPaused"] = "autopaused";
AudioPlayerStatus2["Buffering"] = "buffering";
AudioPlayerStatus2["Idle"] = "idle";
AudioPlayerStatus2["Paused"] = "paused";
AudioPlayerStatus2["Playing"] = "playing";
return AudioPlayerStatus2;
})(AudioPlayerStatus || {});
function stringifyState2(state) {
return JSON.stringify({
...state,
resource: Reflect.has(state, "resource"),
stepTimeout: Reflect.has(state, "stepTimeout")
});
}
__name(stringifyState2, "stringifyState");
var AudioPlayer = class extends import_node_events4.EventEmitter {
static {
__name(this, "AudioPlayer");
}
/**
* The state that the AudioPlayer is in.
*/
_state;
/**
* A list of VoiceConnections that are registered to this AudioPlayer. The player will attempt to play audio
* to the streams in this list.
*/
subscribers = [];
/**
* The behavior that the player should follow when it enters certain situations.
*/
behaviors;
/**
* The debug logger function, if debugging is enabled.
*/
debug;
/**
* Creates a new AudioPlayer.
*/
constructor(options = {}) {
super();
this._state = { status: "idle" /* Idle */ };
this.behaviors = {
noSubscriber: "pause" /* Pause */,
maxMissedFrames: 5,
...options.behaviors
};
this.debug = options.debug === false ? null : (message) => this.emit("debug", message);
}
/**
* A list of subscribed voice connections that can currently receive audio to play.
*/
get playable() {
return this.subscribers.filter(({ connection }) => connection.state.status === "ready" /* Ready */).map(({ connection }) => connection);
}
/**
* Subscribes a VoiceConnection to the audio player's play list. If the VoiceConnection is already subscribed,
* then the existing subscription is used.
*
* @remarks
* This method should not be directly called. Instead, use VoiceConnection#subscribe.
* @param connection - The connection to subscribe
* @returns The new subscription if the voice connection is not yet subscribed, otherwise the existing subscription
*/
// @ts-ignore
subscribe(connection) {
const existingSubscription = this.subscribers.find((subscription) => subscription.connection === connection);
if (!existingSubscription) {
const subscription = new PlayerSubscription(connection, this);
this.subscribers.push(subscription);
setImmediate(() => this.emit("subscribe", subscription));
return subscription;
}
return existingSubscription;
}
/**
* Unsubscribes a subscription - i.e. removes a voice connection from the play list of the audio player.
*
* @remarks
* This method should not be directly called. Instead, use PlayerSubscription#unsubscribe.
* @param subscription - The subscription to remove
* @returns Whether or not the subscription existed on the player and was removed
*/
// @ts-ignore
unsubscribe(subscription) {
const index = this.subscribers.indexOf(subscription);
const exists = index !== -1;
if (exists) {
this.subscribers.splice(index, 1);
subscription.connection.setSpeaking(false);
this.emit("unsubscribe", subscription);
}
return exists;
}
/**
* The state that the player is in.
*/
get state() {
return this._state;
}
/**
* Sets a new state for the player, performing clean-up operations where necessary.
*/
set state(newState) {
const oldState = this._state;
const newResource = Reflect.get(newState, "resource");
if (oldState.status !== "idle" /* Idle */ && oldState.resource !== newResource) {
oldState.resource.playStream.on("error", noop);
oldState.resource.playStream.off("error", oldState.onStreamError);
oldState.resource.audioPlayer = void 0;
oldState.resource.playStream.destroy();
oldState.resource.playStream.read();
}
if (oldState.status === "buffering" /* Buffering */ && (newState.status !== "buffering" /* Buffering */ || newState.resource !== oldState.resource)) {
oldState.resource.playStream.off("end", oldState.onFailureCallback);
oldState.resource.playStream.off("close", oldState.onFailureCallback);
oldState.resource.playStream.off("finish", oldState.onFailureCallback);
oldState.resource.playStream.off("readable", oldState.onReadableCallback);
}
if (newState.status === "idle" /* Idle */) {
this._signalStopSpeaking();
deleteAudioPlayer(this);
}
if (newResource) {
addAudioPlayer(this);
}
const didChangeResources = oldState.status !== "idle" /* Idle */ && newState.status === "playing" /* Playing */ && oldState.resource !== newState.resource;
this._state = newState;
this.emit("stateChange", oldState, this._state);
if (oldState.status !== newState.status || didChangeResources) {
this.emit(newState.status, oldState, this._state);
}
this.debug?.(`state change:
from ${stringifyState2(oldState)}
to ${stringifyState2(newState)}`);
}
/**
* Plays a new resource on the player. If the player is already playing a resource, the existing resource is destroyed
* (it cannot be reused, even in another player) and is replaced with the new resource.
*
* @remarks
* The player will transition to the Playing state once playback begins, and will return to the Idle state once
* playback is ended.
*
* If the player was previously playing a resource and this method is called, the player will not transition to the
* Idle state during the swap over.
* @param resource - The resource to play
* @throws Will throw if attempting to play an audio resource that has already ended, or is being played by another player
*/
play(resource) {
if (resource.ended) {
throw new Error("Cannot play a resource that has already ended.");
}
if (resource.audioPlayer) {
if (resource.audioPlayer === this) {
return;
}
throw new Error("Resource is already being played by another audio player.");
}
resource.audioPlayer = this;
const onStreamError = /* @__PURE__ */ __name((error) => {
if (this.state.status !== "idle" /* Idle */) {
this.emit("error", new AudioPlayerError(error, this.state.resource));
}
if (this.state.status !== "idle" /* Idle */ && this.state.resource === resource) {
this.state = {
status: "idle" /* Idle */
};
}
}, "onStreamError");
resource.playStream.once("error", onStreamError);
if (resource.started) {
this.state = {
status: "playing" /* Playing */,
missedFrames: 0,
playbackDuration: 0,
resource,
onStreamError
};
} else {
const onReadableCallback = /* @__PURE__ */ __name(() => {
if (this.state.status === "buffering" /* Buffering */ && this.state.resource === resource) {
this.state = {
status: "playing" /* Playing */,
missedFrames: 0,
playbackDuration: 0,
resource,
onStreamError
};
}
}, "onReadableCallback");
const onFailureCallback = /* @__PURE__ */ __name(() => {
if (this.state.status === "buffering" /* Buffering */ && this.state.resource === resource) {
this.state = {
status: "idle" /* Idle */
};
}
}, "onFailureCallback");
resource.playStream.once("readable", onReadableCallback);
resource.playStream.once("end", onFailureCallback);
resource.playStream.once("close", onFailureCallback);
resource.playStream.once("finish", onFailureCallback);
this.state = {
status: "buffering" /* Buffering */,
resource,
onReadableCallback,
onFailureCallback,
onStreamError
};
}
}
/**
* Pauses playback of the current resource, if any.
*
* @param interpolateSilence - If true, the player will play 5 packets of silence after pausing to prevent audio glitches
* @returns `true` if the player was successfully paused, otherwise `false`
*/
pause(interpolateSilence = true) {
if (this.state.status !== "playing" /* Playing */) return false;
this.state = {
...this.state,
status: "paused" /* Paused */,
silencePacketsRemaining: interpolateSilence ? 5 : 0
};
return true;
}
/**
* Unpauses playback of the current resource, if any.
*
* @returns `true` if the player was successfully unpaused, otherwise `false`
*/
unpause() {
if (this.state.status !== "paused" /* Paused */) return false;
this.state = {
...this.state,
status: "playing" /* Playing */,
missedFrames: 0
};
return true;
}
/**
* Stops playback of the current resource and destroys the resource. The player will either transition to the Idle state,
* or remain in its current state until the silence padding frames of the resource have been played.
*
* @param force - If true, will force the player to enter the Idle state even if the resource has silence padding frames
* @returns `true` if the player will come to a stop, otherwise `false`
*/
stop(force = false) {
if (this.state.status === "idle" /* Idle */) return false;
if (force || this.state.resource.silencePaddingFrames === 0) {
this.state = {
status: "idle" /* Idle */
};
} else if (this.state.resource.silenceRemaining === -1) {
this.state.resource.silenceRemaining = this.state.resource.silencePaddingFrames;
}
return true;
}
/**
* Checks whether the underlying resource (if any) is playable (readable)
*
* @returns `true` if the resource is playable, otherwise `false`
*/
checkPlayable() {
const state = this._state;
if (state.status === "idle" /* Idle */ || state.status === "buffering" /* Buffering */) return false;
if (!state.resource.readable) {
this.state = {
status: "idle" /* Idle */
};
return false;
}
return true;
}
/**
* Called roughly every 20ms by the global audio player timer. Dispatches any audio packets that are buffered
* by the active connections of this audio player.
*/
// @ts-ignore
_stepDispatch() {
const state = this._state;
if (state.status === "idle" /* Idle */ || state.status === "buffering" /* Buffering */) return;
for (const connection of this.playable) {
connection.dispatchAudio();
}
}
/**
* Called roughly every 20ms by the global audio player timer. Attempts to read an audio packet from the
* underlying resource of the stream, and then has all the active connections of the audio player prepare it
* (encrypt it, append header data) so that it is ready to play at the start of the next cycle.
*/
// @ts-ignore
_stepPrepare() {
const state = this._state;
if (state.status === "idle" /* Idle */ || state.status === "buffering" /* Buffering */) return;
const playable = this.playable;
if (state.status === "autopaused" /* AutoPaused */ && playable.length > 0) {
this.state = {
...state,
status: "playing" /* Playing */,
missedFrames: 0
};
}
if (state.status === "paused" /* Paused */ || state.status === "autopaused" /* AutoPaused */) {
if (state.silencePacketsRemaining > 0) {
state.silencePacketsRemaining--;
this._preparePacket(SILENCE_FRAME, playable, state);
if (state.silencePacketsRemaining === 0) {
this._signalStopSpeaking();
}
}
return;
}
if (playable.length === 0) {
if (this.behaviors.noSubscriber === "pause" /* Pause */) {
this.state = {
...state,
status: "autopaused" /* AutoPaused */,
silencePacketsRemaining: 5
};
return;
} else if (this.behaviors.noSubscriber === "stop" /* Stop */) {
this.stop(true);
}
}
const packet = state.resource.read();
if (state.status === "playing" /* Playing */) {
if (packet) {
this._preparePacket(packet, playable, state);
state.missedFrames = 0;
} else {
this._preparePacket(SILENCE_FRAME, playable, state);
state.missedFrames++;
if (state.missedFrames >= this.behaviors.maxMissedFrames) {
this.stop();
}
}
}
}
/**
* Signals to all the subscribed connections that they should send a packet to Discord indicating
* they are no longer speaking. Called once playback of a resource ends.
*/
_signalStopSpeaking() {
for (const { connection } of this.subscribers) {
connection.setSpeaking(false);
}
}
/**
* Instructs the given connections to each prepare this packet to be played at the start of the
* next cycle.
*
* @param packet - The Opus packet to be prepared by each receiver
* @param receivers - The connections that should play this packet
*/
_preparePacket(packet, receivers, state) {
state.playbackDuration += 20;
for (const connection of receivers) {
connection.prepareAudioPacket(packet);
}
}
};
function createAudioPlayer(options) {
return new AudioPlayer(options);
}
__name(createAudioPlayer, "createAudioPlayer");
// src/receive/AudioReceiveStream.ts
var EndBehaviorType = /* @__PURE__ */ ((EndBehaviorType2) => {
EndBehaviorType2[EndBehaviorType2["Manual"] = 0] = "Manual";
EndBehaviorType2[EndBehaviorType2["AfterSilence"] = 1] = "AfterSilence";
EndBehaviorType2[EndBehaviorType2["AfterInactivity"] = 2] = "AfterInactivity";
return EndBehaviorType2;
})(EndBehaviorType || {});
function createDefaultAudioReceiveStreamOptions() {
return {
end: {
behavior: 0 /* Manual */
}
};
}
__name(createDefaultAudioReceiveStreamOptions, "createDefaultAudioReceiveStreamOptions");
var AudioReceiveStream = class extends import_node_stream.Readable {
static {
__name(this, "AudioReceiveStream");
}
/**
* The end behavior of the receive stream.
*/
end;
endTimeout;
constructor({ end, ...options }) {
super({
...options,
objectMode: true
});
this.end = end;
}
push(buffer) {
if (buffer && (this.end.behavior === 2 /* AfterInactivity */ || this.end.behavior === 1 /* AfterSilence */ && (buffer.compare(SILENCE_FRAME) !== 0 || this.endTimeout === void 0))) {
this.renewEndTimeout(this.end);
}
return super.push(buffer);
}
renewEndTimeout(end) {
if (this.endTimeout) {
clearTimeout(this.endTimeout);
}
this.endTimeout = setTimeout(() => this.push(null), end.duration);
}
_read() {
}
};
// src/receive/SSRCMap.ts
var import_node_events5 = require("events");
var SSRCMap = class extends import_node_events5.EventEmitter {
static {
__name(this, "SSRCMap");
}
/**
* The underlying map.
*/
map;
constructor() {
super();
this.map = /* @__PURE__ */ new Map();
}
/**
* Updates the map with new user data
*
* @param data - The data to update with
*/
update(data) {
const existing = this.map.get(data.audioSSRC);
const newValue = {
...this.map.get(data.audioSSRC),
...data
};
this.map.set(data.audioSSRC, newValue);
if (!existing) this.emit("create", newValue);
this.emit("update", existing, newValue);
}
/**
* Gets the stored voice data of a user.
*
* @param target - The target, either their user id or audio SSRC
*/
get(target) {
if (typeof target === "number") {
return this.map.get(target);
}
for (const data of this.map.values()) {
if (data.userId === target) {
return data;
}
}
return void 0;
}
/**
* Deletes the stored voice data about a user.
*
* @param target - The target of the delete operation, either their audio SSRC or user id
* @returns The data that was deleted, if any
*/
delete(target) {
if (typeof target === "number") {
const existing = this.map.get(target);
if (existing) {
this.map.delete(target);
this.emit("delete", existing);
}
return existing;
}
for (const [audioSSRC, data] of this.map.entries()) {
if (data.userId === target) {
this.map.delete(audioSSRC);
this.emit("delete", data);
return data;
}
}
return void 0;
}
};
// src/receive/SpeakingMap.ts
var import_node_events6 = require("events");
var SpeakingMap = class _Speak