@ovencord/voice 0.19.0

package/LICENSE

@@ -0,0 +1,191 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2022 Noel Buechler
+   Copyright 2020 Amish Shah
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,120 @@
+<div align="center">
+	<br />
+	<p>
+		<a href="https://discord.js.org"><img src="https://discord.js.org/static/logo.svg" width="546" alt="discord.js" /></a>
+	</p>
+	<br />
+	<p>
+		<a href="https://discord.gg/djs"><img src="https://img.shields.io/badge/join_us-on_discord-5865F2?logo=discord&logoColor=white" alt="Discord server" /></a>
+		<a href="https://www.npmjs.com/package/@ovencord/voice"><img src="https://img.shields.io/npm/v/@ovencord/voice.svg?maxAge=3600" alt="npm version" /></a>
+		<a href="https://www.npmjs.com/package/@ovencord/voice"><img src="https://img.shields.io/npm/dt/@ovencord/voice.svg?maxAge=3600" alt="npm downloads" /></a>
+		<a href="https://github.com/ovencord/ovencord/actions"><img src="https://github.com/ovencord/ovencord/actions/workflows/tests.yml/badge.svg" alt="Build status" /></a>
+		<a href="https://github.com/ovencord/ovencord/commits/main/packages/voice"><img alt="Last commit." src="https://img.shields.io/github/last-commit/ovencord/ovencord?logo=github&logoColor=ffffff&path=packages%2Fvoice" /></a>
+		<a href="https://opencollective.com/discordjs"><img src="https://img.shields.io/opencollective/backers/discordjs?maxAge=3600&logo=opencollective" alt="backers" /></a>
+		<a href="https://codecov.io/gh/ovencord/ovencord"><img src="https://codecov.io/gh/ovencord/ovencord/branch/main/graph/badge.svg?precision=2&flag=voice" alt="Code coverage" /></a>
+	</p>
+	<p>
+		<a href="https://vercel.com/?utm_source=discordjs&utm_campaign=oss"><img src="https://raw.githubusercontent.com/ovencord/ovencord/main/.github/powered-by-vercel.svg" alt="Vercel" /></a>
+		<a href="https://www.cloudflare.com"><img src="https://raw.githubusercontent.com/ovencord/ovencord/main/.github/powered-by-workers.png" alt="Cloudflare Workers" height="44" /></a>
+	</p>
+</div>
+
+## About
+
+`@ovencord/voice` is a TypeScript implementation of the Discord Voice API for Node.js.
+
+**Features:**
+
+- Send and receive\* audio in Discord voice-based channels
+- A strong focus on reliability and predictable behavior
+- Horizontal scalability and libraries other than [discord.js](https://discord.js.org/) are supported with custom adapters
+- A robust audio processing system that can handle a wide range of audio sources
+
+\*_Audio receive is not documented by Discord so stable support is not guaranteed_
+
+## Installation
+
+**Node.js 22.12.0 or newer is required.**
+
+```sh
+npm install @ovencord/voice
+yarn add @ovencord/voice
+pnpm add @ovencord/voice
+bun add @ovencord/voice
+```
+
+## Dependencies
+
+This library has several optional dependencies to support a variety
+of different platforms. Install one dependency from each of the
+categories shown below. The dependencies are listed in order of
+preference for performance. If you can't install one of the options,
+try installing another.
+
+**Encryption Libraries (npm install):**
+
+> [!NOTE]
+> You only need to install one of these libraries if your system does not support `aes-256-gcm` (verify by running `require('node:crypto').getCiphers().includes('aes-256-gcm')`).
+
+- `sodium-native`: ^3.3.0
+- `sodium`: ^3.0.2
+- `@stablelib/xchacha20poly1305`: ^2.0.0
+- `@noble/ciphers`: ^1.0.0
+- `libsodium-wrappers`: ^0.7.9
+
+**DAVE Protocol Libraries (e2ee)**
+
+> [!NOTE]
+> At this time, `@snazzah/davey` is the only supported DAVE protocol library in this package, and comes pre-installed. In the future, we may support other libraries once they are created.
+
+- `@snazzah/davey`: ^0.1.6
+
+**Opus Libraries (npm install):**
+
+- `@ovencord/opus`: ^0.4.0
+- `opusscript`: ^0.0.7
+
+**FFmpeg:**
+
+- [`FFmpeg`](https://ffmpeg.org/) (installed and added to environment)
+- `ffmpeg-static`: ^4.2.7 (npm install)
+
+## Examples
+
+The [voice-examples][voice-examples] repository contains examples on how to use this package. Feel free to check them out if you need a nudge in the right direction.
+
+## Links
+
+- [Website][website] ([source][website-source])
+- [Documentation][documentation]
+- [Guide][guide] ([source][guide-source])
+  Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library.
+- [discord.js Discord server][discord]
+- [Discord Developers Discord server][discord-developers]
+- [GitHub][source]
+- [npm][npm]
+- [Related libraries][related-libs]
+
+## Contributing
+
+Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the
+[documentation][documentation].  
+See [the contribution guide][contributing] if you'd like to submit a PR.
+
+## Help
+
+If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
+
+[website]: https://discord.js.org
+[website-source]: https://github.com/ovencord/ovencord/tree/main/apps/website
+[documentation]: https://discord.js.org/docs/packages/voice/stable
+[guide]: https://discordjs.guide
+[guide-source]: https://github.com/ovencord/ovencord/tree/main/apps/guide
+[guide-update]: https://discordjs.guide/legacy/additional-info/changes-in-v14
+[discord]: https://discord.gg/djs
+[discord-developers]: https://discord.gg/discord-developers
+[source]: https://github.com/ovencord/ovencord/tree/main/packages/voice
+[npm]: https://www.npmjs.com/package/@ovencord/voice
+[related-libs]: https://discord.com/developers/docs/topics/community-resources#libraries
+[contributing]: https://github.com/ovencord/ovencord/blob/main/.github/CONTRIBUTING.md
+[voice-examples]: https://github.com/discordjs/voice-examples

package/package.json

@@ -0,0 +1,72 @@
+{
+	"$schema": "https://json.schemastore.org/package.json",
+	"name": "@ovencord/voice",
+	"version": "0.19.0",
+	"description": "Implementation of the Discord Voice API for Node.js",
+	"scripts": {
+		"test": "bun test",
+		"typecheck": "tsc --noEmit",
+		"lint": "eslint src"
+	},
+	"exports": "./src/index.ts",
+	"main": "./src/index.ts",
+	"module": "./src/index.ts",
+	"types": "./src/index.ts",
+	"files": [
+		"src"
+	],
+	"contributors": [
+		"Ovencord Contributors"
+	],
+	"license": "Apache-2.0",
+	"keywords": [
+		"discord",
+		"discord.js",
+		"audio",
+		"voice",
+		"streaming"
+	],
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/ovencord/ovencord.git",
+		"directory": "packages/voice"
+	},
+	"bugs": {
+		"url": "https://github.com/ovencord/ovencord/issues"
+	},
+	"homepage": "https://ovencord.dev",
+	"funding": "https://github.com/ovencord/ovencord?sponsor",
+	"dependencies": {
+		"@snazzah/davey": "^0.1.8",
+		"@types/ws": "^8.18.1",
+		"discord-api-types": "^0.38.36",
+		"prism-media": "^1.3.5",
+		"tslib": "^2.8.1",
+		"ws": "^8.18.3"
+	},
+	"devDependencies": {
+		"@ovencord/api-extractor": "workspace:^",
+		"@ovencord/opus": "^0.9.0",
+		"@ovencord/scripts": "workspace:^",
+		"@favware/cliff-jumper": "^6.0.0",
+		"@noble/ciphers": "^2.1.1",
+		"@vitest/coverage-v8": "^4.0.15",
+		"cross-env": "^10.1.0",
+		"esbuild-plugin-version-injector": "^1.2.1",
+		"eslint": "^9.39.2",
+		"eslint-formatter-compact": "^9.0.1",
+		"eslint-formatter-pretty": "^7.0.0",
+		"prettier": "^3.7.4",
+		"typescript": "^5.9.3",
+		"vitest": "^4.0.15",
+		"vitest-websocket-mock": "^0.5.0",
+		"@types/bun": "latest",
+		"typescript-eslint": "^8.54.0"
+	},
+	"engines": {
+		"bun": ">=1.0.0"
+	},
+	"publishConfig": {
+		"access": "public"
+	}
+}

package/src/DataStore.ts

@@ -0,0 +1,189 @@
+import { GatewayOpcodes } from 'discord-api-types/v10';
+import type { VoiceConnection } from './VoiceConnection';
+import type { AudioPlayer } from './audio/index';
+
+export interface JoinConfig {
+	channelId: string | null;
+	group: string;
+	guildId: string;
+	selfDeaf: boolean;
+	selfMute: boolean;
+}
+
+/**
+ * Sends a voice state update to the main websocket shard of a guild, to indicate joining/leaving/moving across
+ * voice channels.
+ *
+ * @param config - The configuration to use when joining the voice channel
+ */
+export function createJoinVoiceChannelPayload(config: JoinConfig) {
+	return {
+		op: 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,
+		},
+	};
+}
+
+// Voice Connections
+const groups = new Map<string, Map<string, VoiceConnection>>();
+groups.set('default', new Map());
+
+function getOrCreateGroup(group: string) {
+	const existing = groups.get(group);
+	if (existing) return existing;
+	const map = new Map<string, VoiceConnection>();
+	groups.set(group, map);
+	return map;
+}
+
+/**
+ * Retrieves the map of group names to maps of voice connections. By default, all voice connections
+ * are created under the 'default' group.
+ *
+ * @returns The group map
+ */
+export function getGroups() {
+	return groups;
+}
+
+/**
+ * Retrieves all the voice connections under the 'default' group.
+ *
+ * @param group - The group to look up
+ * @returns The map of voice connections
+ */
+export function getVoiceConnections(group?: 'default'): Map<string, VoiceConnection>;
+
+/**
+ * Retrieves all the voice connections under the given group name.
+ *
+ * @param group - The group to look up
+ * @returns The map of voice connections
+ */
+export function getVoiceConnections(group: string): Map<string, VoiceConnection> | undefined;
+
+/**
+ * Retrieves all the voice connections under the given group name. Defaults to the 'default' group.
+ *
+ * @param group - The group to look up
+ * @returns The map of voice connections
+ */
+export function getVoiceConnections(group = 'default') {
+	return groups.get(group);
+}
+
+/**
+ * Finds a voice connection with the given guild id and group. Defaults to the 'default' group.
+ *
+ * @param guildId - The guild id of the voice connection
+ * @param group - the group that the voice connection was registered with
+ * @returns The voice connection, if it exists
+ */
+export function getVoiceConnection(guildId: string, group = 'default') {
+	return getVoiceConnections(group)?.get(guildId);
+}
+
+export function untrackVoiceConnection(voiceConnection: VoiceConnection) {
+	return getVoiceConnections(voiceConnection.joinConfig.group)?.delete(voiceConnection.joinConfig.guildId);
+}
+
+export function trackVoiceConnection(voiceConnection: VoiceConnection) {
+	return getOrCreateGroup(voiceConnection.joinConfig.group).set(voiceConnection.joinConfig.guildId, voiceConnection);
+}
+
+// Audio Players
+
+// Each audio packet is 20ms long
+const FRAME_LENGTH = 20;
+
+let audioCycleInterval: NodeJS.Timeout | undefined;
+let nextTime = -1;
+
+/**
+ * A list of created audio players that are still active and haven't been destroyed.
+ */
+const audioPlayers: AudioPlayer[] = [];
+
+/**
+ * Called roughly every 20 milliseconds. Dispatches audio from all players, and then gets the players to prepare
+ * the next audio frame.
+ */
+function audioCycleStep() {
+	if (nextTime === -1) return;
+
+	nextTime += FRAME_LENGTH;
+	const available = audioPlayers.filter((player) => player.checkPlayable());
+
+	for (const player of available) {
+		// eslint-disable-next-line @typescript-eslint/dot-notation
+		player['_stepDispatch']();
+	}
+
+	prepareNextAudioFrame(available);
+}
+
+/**
+ * Recursively gets the players that have been passed as parameters to prepare audio frames that can be played
+ * at the start of the next cycle.
+ */
+function prepareNextAudioFrame(players: AudioPlayer[]) {
+	const nextPlayer = players.shift();
+
+	if (!nextPlayer) {
+		if (nextTime !== -1) {
+			audioCycleInterval = setTimeout(() => audioCycleStep(), Math.max(1, nextTime - Date.now()));
+		}
+
+		return;
+	}
+
+	// eslint-disable-next-line @typescript-eslint/dot-notation
+	nextPlayer['_stepPrepare']();
+
+	// setImmediate to avoid long audio player chains blocking other scheduled tasks
+	setImmediate(() => prepareNextAudioFrame(players));
+}
+
+/**
+ * Checks whether or not the given audio player is being driven by the data store clock.
+ *
+ * @param target - The target to test for
+ * @returns `true` if it is being tracked, `false` otherwise
+ */
+export function hasAudioPlayer(target: AudioPlayer) {
+	return audioPlayers.includes(target);
+}
+
+/**
+ * Adds an audio player to the data store tracking list, if it isn't already there.
+ *
+ * @param player - The player to track
+ */
+export function addAudioPlayer(player: AudioPlayer) {
+	if (hasAudioPlayer(player)) return player;
+	audioPlayers.push(player);
+	if (audioPlayers.length === 1) {
+		nextTime = Date.now();
+		setImmediate(() => audioCycleStep());
+	}
+
+	return player;
+}
+
+/**
+ * Removes an audio player from the data store tracking list, if it is present there.
+ */
+export function deleteAudioPlayer(player: AudioPlayer) {
+	const index = audioPlayers.indexOf(player);
+	if (index === -1) return;
+	audioPlayers.splice(index, 1);
+	if (audioPlayers.length === 0) {
+		nextTime = -1;
+		if (audioCycleInterval !== undefined) clearTimeout(audioCycleInterval);
+	}
+}