Merge branch 'feat/voice-rewrite-and-fixes' of https://github.com/DA-344/pycord into feat/voice-rewrite-and-fixes

Author: DA-344

discord/opus.py

@@ -43,7 +43,7 @@
 
 if TYPE_CHECKING:
     T = TypeVar("T")
-    APPLICATION_CTL = Literal['audio', 'voip', 'lowdelay']
+    APPLICATION_CTL = Literal["audio", "voip", "lowdelay"]
     BAND_CTL = Literal["narrow", "medium", "wide", "superwide", "full"]
     SIGNAL_CTL = Literal["auto", "voice", "music"]
 
@@ -81,7 +81,7 @@ class ApplicationCtl(TypedDict):
 c_int_ptr = ctypes.POINTER(ctypes.c_int)
 c_int16_ptr = ctypes.POINTER(ctypes.c_int16)
 c_float_ptr = ctypes.POINTER(ctypes.c_float)
-OPUS_SILENCE = b'\xf8\xff\xfe'
+OPUS_SILENCE = b"\xf8\xff\xfe"
 
 _lib = None
 
@@ -105,9 +105,9 @@ class DecoderStruct(ctypes.Structure):
 
 # Encoder CTLs
 application_ctl: ApplicationCtl = {
-    'audio': 2049,
-    'lowdelay': 2051,
-    'voip': 2048,
+    "audio": 2049,
+    "lowdelay": 2051,
+    "voip": 2048,
 }
 
 CTL_SET_BITRATE = 4002
@@ -378,22 +378,20 @@ class Encoder(_OpusStruct):
     def __init__(
         self,
         *,
-        application: APPLICATION_CTL = 'audio',
+        application: APPLICATION_CTL = "audio",
         bitrate: int = 128,
         fec: bool = True,
         expected_packet_loss: float = 0.15,
-        bandwidth: BAND_CTL = 'full',
-        signal_type: SIGNAL_TL = 'auto',
+        bandwidth: BAND_CTL = "full",
+        signal_type: SIGNAL_TL = "auto",
     ) -> None:
         if application not in application_ctl:
-            raise ValueError(
-                'invalid application ctl type provided'
-            )
+            raise ValueError("invalid application ctl type provided")
         if not 16 <= bitrate <= 512:
-            raise ValueError('bitrate must be between 16 and 512, both included')
+            raise ValueError("bitrate must be between 16 and 512, both included")
         if not 0 < expected_packet_loss <= 1:
             raise ValueError(
-                'expected_packet_loss must be between 0 and 1, including 1',
+                "expected_packet_loss must be between 0 and 1, including 1",
             )
 
         _OpusStruct.get_opus_version()

discord/sinks/core.py

@@ -128,9 +128,9 @@ def __init__(self, data: bytes, client: VoiceClient):
         self.header: bytes = data[:cutoff]
         self.data = self.data[cutoff:]
 
-        self.decrypted_data: bytes = getattr(self.client, f"_decrypt_{self.client.mode}")(
-            self.header, self.data
-        )
+        self.decrypted_data: bytes = getattr(
+            self.client, f"_decrypt_{self.client.mode}"
+        )(self.header, self.data)
         self.decoded_data: bytes | None = None
 
         self.user_id: int | None = None

discord/voice/client.py

@@ -26,47 +26,48 @@
 from __future__ import annotations
 
 import asyncio
-from collections.abc import Callable, Coroutine
 import struct
+from collections.abc import Callable, Coroutine
 from typing import TYPE_CHECKING, Any, Literal, overload
 
 from discord import opus
 from discord.errors import ClientException
+from discord.sinks import RawData, Sink
 from discord.sinks.errors import RecordingException
 from discord.utils import MISSING
-from discord.sinks import RawData, Sink
 
 from ._types import VoiceProtocol
-from .state import VoiceConnectionState
+from .player import AudioPlayer
 from .recorder import Recorder
 from .source import AudioSource
-from .player import AudioPlayer
+from .state import VoiceConnectionState
 
 if TYPE_CHECKING:
     from typing_extensions import ParamSpec
 
     from discord import abc
     from discord.client import Client
     from discord.guild import Guild, VocalGuildChannel
-    from discord.state import ConnectionState
-    from discord.user import ClientUser
+    from discord.opus import APPLICATION_CTL, BAND_CTL, SIGNAL_CTL, Decoder, Encoder
     from discord.raw_models import (
-        RawVoiceStateUpdateEvent,
         RawVoiceServerUpdateEvent,
+        RawVoiceStateUpdateEvent,
     )
+    from discord.state import ConnectionState
     from discord.types.voice import SupportedModes
-    from discord.opus import Encoder, APPLICATION_CTL, BAND_CTL, SIGNAL_CTL, Decoder
+    from discord.user import ClientUser
 
     from .gateway import VoiceWebSocket
 
     AfterCallback = Callable[[Exception | None], Any]
-    P = ParamSpec('P')
+    P = ParamSpec("P")
 
 has_nacl: bool
 
 try:
     import nacl.secret
     import nacl.utils
+
     has_nacl = True
 except ImportError:
     has_nacl = False
@@ -102,9 +103,9 @@ class VoiceClient(VoiceProtocol):
     def __init__(self, client: Client, channel: abc.Connectable) -> None:
         if not has_nacl:
             raise RuntimeError(
-                'PyNaCl library is needed in order to use voice related features, '
+                "PyNaCl library is needed in order to use voice related features, "
                 'you can run "pip install py-cord[voice]" to install all voice-related '
-                'dependencies.'
+                "dependencies."
             )
 
         super().__init__(client, channel)
@@ -130,10 +131,10 @@ def __init__(self, client: Client, channel: abc.Connectable) -> None:
 
     warn_nacl: bool = not has_nacl
     supported_modes: tuple[SupportedModes, ...] = (
-        'aead_xchacha20_poly1305_rtpsize',
-        'xsalsa20_poly1305_lite',
-        'xsalsa20_poly1305_suffix',
-        'xsalsa20_poly1305',
+        "aead_xchacha20_poly1305_rtpsize",
+        "xsalsa20_poly1305_lite",
+        "xsalsa20_poly1305_suffix",
+        "xsalsa20_poly1305",
     )
 
     @property
@@ -224,7 +225,7 @@ def latency(self) -> float:
         .. versionadded:: 1.4
         """
         ws = self.ws
-        return float('inf') if not ws else ws.latency
+        return float("inf") if not ws else ws.latency
 
     @property
     def average_latency(self) -> float:
@@ -233,7 +234,7 @@ def average_latency(self) -> float:
         .. versionadded:: 1.4
         """
         ws = self.ws
-        return float('inf') if not ws else ws.average_latency
+        return float("inf") if not ws else ws.average_latency
 
     async def disconnect(self, *, force: bool = False) -> None:
         """|coro|
@@ -245,7 +246,9 @@ async def disconnect(self, *, force: bool = False) -> None:
         await self._connection.disconnect(force=force, wait=True)
         self.cleanup()
 
-    async def move_to(self, channel: abc.Snowflake | None, *, timeout: float | None = 30.0) -> None:
+    async def move_to(
+        self, channel: abc.Snowflake | None, *, timeout: float | None = 30.0
+    ) -> None:
         """|coro|
 
         moves you to a different voice channel.
@@ -285,11 +288,11 @@ def _get_voice_packet(self, data: Any) -> bytes:
         # formulate rtp header
         header[0] = 0x80
         header[1] = 0x78
-        struct.pack_into('>H', header, 2, self.sequence)
-        struct.pack_into('>I', header, 4, self.timestamp)
-        struct.pack_into('>I', header, 8, self.ssrc)
+        struct.pack_into(">H", header, 2, self.sequence)
+        struct.pack_into(">I", header, 4, self.timestamp)
+        struct.pack_into(">I", header, 8, self.ssrc)
 
-        encrypt_packet = getattr(self, f'_encrypt_{self.mode}')
+        encrypt_packet = getattr(self, f"_encrypt_{self.mode}")
         return encrypt_packet(header, data)
 
     def _encrypt_xsalsa20_poly1305(self, header: bytes, data: Any) -> bytes:
@@ -309,17 +312,23 @@ def _encrypt_xsalsa20_poly1305_lite(self, header: bytes, data: Any) -> bytes:
         # deprecated
         box = nacl.secret.SecretBox(bytes(self.secret_key))
         nonce = bytearray(24)
-        nonce[:4] = struct.pack('>I', self._incr_nonce)
-        self.checked_add('_incr_nonce', 1, 4294967295)
+        nonce[:4] = struct.pack(">I", self._incr_nonce)
+        self.checked_add("_incr_nonce", 1, 4294967295)
 
         return header + box.encrypt(bytes(data), bytes(nonce)).ciphertext + nonce[:4]
 
-    def _encrypt_aead_xcacha20_poly1305_rtpsize(self, header: bytes, data: Any) -> bytes:
+    def _encrypt_aead_xcacha20_poly1305_rtpsize(
+        self, header: bytes, data: Any
+    ) -> bytes:
         box = nacl.secret.Aead(bytes(self.secret_key))
         nonce = bytearray(24)
-        nonce[:4] = struct.pack('>I', self._incr_nonce)
-        self.checked_add('_incr_nonce', 1, 4294967295)
-        return header + box.encrypt(bytes(data), bytes(header), bytes(nonce)).ciphertext + nonce[:4]
+        nonce[:4] = struct.pack(">I", self._incr_nonce)
+        self.checked_add("_incr_nonce", 1, 4294967295)
+        return (
+            header
+            + box.encrypt(bytes(data), bytes(header), bytes(nonce)).ciphertext
+            + nonce[:4]
+        )
 
     def _decrypt_xsalsa20_poly1305(self, header: bytes, data: Any) -> bytes:
         # deprecated
@@ -349,7 +358,9 @@ def _decrypt_xsalsa20_poly1305_lite(self, header: bytes, data: Any) -> bytes:
 
         return self.strip_header_ext(box.decrypt(bytes(data), bytes(nonce)))
 
-    def _decrypt_aead_xchacha20_poly1305_rtpsize(self, header: bytes, data: Any) -> bytes:
+    def _decrypt_aead_xchacha20_poly1305_rtpsize(
+        self, header: bytes, data: Any
+    ) -> bytes:
         box = nacl.secret.Aead(bytes(self.secret_key))
 
         nonce = bytearray(24)
@@ -363,7 +374,7 @@ def _decrypt_aead_xchacha20_poly1305_rtpsize(self, header: bytes, data: Any) ->
     @staticmethod
     def strip_header_ext(data: bytes) -> bytes:
         if len(data) > 4 and data[0] == 0xBE and data[1] == 0xDE:
-            _, length = struct.unpack_from('>HH', data)
+            _, length = struct.unpack_from(">HH", data)
             offset = 4 + length * 4
             data = data[offset:]
         return data
@@ -403,12 +414,12 @@ def play(
         source: AudioSource,
         *,
         after: AfterCallback | None = None,
-        application: APPLICATION_CTL = 'audio',
+        application: APPLICATION_CTL = "audio",
         bitrate: int = 128,
         fec: bool = True,
         expected_packet_loss: float = 0.15,
-        bandwidth: BAND_CTL = 'full',
-        signal_type: SIGNAL_CTL = 'auto',
+        bandwidth: BAND_CTL = "full",
+        signal_type: SIGNAL_CTL = "auto",
         wait_finish: bool = False,
     ) -> None | asyncio.Future[None]:
         """Plays an :class:`AudioSource`.
@@ -465,12 +476,12 @@ def play(
         """
 
         if not self.is_connected():
-            raise ClientException('Not connected to voice')
+            raise ClientException("Not connected to voice")
         if self.is_playing():
-            raise ClientException('Already playing audio')
+            raise ClientException("Already playing audio")
         if not isinstance(source, AudioSource):
             raise TypeError(
-                f'Source must be an AudioSource, not {source.__class__.__name__}',
+                f"Source must be an AudioSource, not {source.__class__.__name__}",
             )
         if not self.encoder and not source.is_opus():
             self.encoder = opus.Encoder(
@@ -579,10 +590,12 @@ def start_recording(
         """
 
         if not self.is_connected():
-            raise RecordingException('Not connected to a voice channel')
+            raise RecordingException("Not connected to a voice channel")
         if self.recording:
-            raise RecordingException('You are already recording')
+            raise RecordingException("You are already recording")
         if not isinstance(sink, Sink):
-            raise RecordingException(f'Expected a Sink object, got {sink.__class__.__name__}')
+            raise RecordingException(
+                f"Expected a Sink object, got {sink.__class__.__name__}"
+            )
 
         self._recording_handler.empty()

discord/voice/gateway.py

@@ -162,7 +162,7 @@ async def received_message(self, msg: Any, /):
                 "successfully RESUMED.",
             )
         elif op == OpCodes.session_description:
-            self.state.mode = data['mode']
+            self.state.mode = data["mode"]
         elif op == OpCodes.hello:
             interval = data["heartbeat_interval"] / 1000.0
             self._keep_alive = KeepAliveHandler(
@@ -268,10 +268,10 @@ async def close(self, code: int = 1000) -> None:
     async def speak(self, state: SpeakingState = SpeakingState.voice) -> None:
         await self.send_as_json(
             {
-                'op': int(OpCodes.speaking),
-                'd': {
-                    'speaking': int(state),
-                    'delay': 0,
+                "op": int(OpCodes.speaking),
+                "d": {
+                    "speaking": int(state),
+                    "delay": 0,
                 },
             },
         )
@@ -285,7 +285,7 @@ async def from_state(
         hook: Callable[..., Coroutine[Any, Any, Any]] | None = None,
         seq_ack: int = -1,
     ) -> Self:
-        gateway = f'wss://{state.endpoint}/?v=8'
+        gateway = f"wss://{state.endpoint}/?v=8"
         client = state.client
         http = client._state.http
         socket = await http.ws_connect(gateway, compress=15)

discord/voice/recorder.py

@@ -22,6 +22,7 @@
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 DEALINGS IN THE SOFTWARE.
 """
+
 from __future__ import annotations
 
 # TODO: finish this