Voice Client & Packets v2

.gitignore

@@ -29,3 +29,4 @@ composer.lock
 phpunit.log
 /.phpunit*
 /coverage
+/.vs

composer.json

@@ -20,7 +20,6 @@
         "ratchet/pawl": "^0.4.3",
         "react/datagram": "^1.8",
         "symfony/options-resolver": "^5.1.11 || ^6.0 || ^7.0",
-        "trafficcophp/bytebuffer": "^0.3",
         "monolog/monolog": "^2.1.1 || ^3.0",
         "react/event-loop": "^1.2",
         "ext-zlib": "*",

src/Discord/Discord.php

@@ -14,6 +14,7 @@
 namespace Discord;
 
 use Discord\Exceptions\IntentException;
+use Discord\Exceptions\Runtime\RequiredExtensionNotLoadedException;
 use Discord\Factory\Factory;
 use Discord\Helpers\BigInt;
 use Discord\Helpers\CacheConfig;
@@ -34,14 +35,18 @@
 use Discord\Repository\GuildRepository;
 use Discord\Repository\PrivateChannelRepository;
 use Discord\Repository\UserRepository;
+use Discord\Voice\Voice;
 use Discord\Voice\VoiceClient;
+use Discord\Voice\VoiceManager;
 use Discord\WebSockets\Event;
 use Discord\WebSockets\Events\GuildCreate;
-use Discord\WebSockets\Payload;
 use Discord\WebSockets\Handlers;
 use Discord\WebSockets\Intents;
 use Discord\WebSockets\Op;
+use Discord\WebSockets\Payload;
 use Evenement\EventEmitterTrait;
+use function React\Async\coroutine;
+use function React\Promise\all;
 use Monolog\Formatter\LineFormatter;
 use Monolog\Handler\StreamHandler;
 use Monolog\Logger as Monolog;
@@ -53,13 +58,11 @@
 use React\EventLoop\LoopInterface;
 use React\EventLoop\TimerInterface;
 use React\Promise\Deferred;
+
 use React\Promise\PromiseInterface;
 use React\Socket\Connector as SocketConnector;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
-use function React\Async\coroutine;
-use function React\Promise\all;
-
 /**
  * The Discord client class.
  *
@@ -81,7 +84,6 @@
  * @property PrivateChannelRepository   $private_channels
  * @property SoundRepository            $sounds
  * @property UserRepository             $users
-
  */
 class Discord
 {
@@ -108,13 +110,6 @@ class Discord
      */
     protected $logger;
 
-    /**
-     * An array of loggers for voice clients.
-     *
-     * @var ?LoggerInterface[] Loggers.
-     */
-    protected $voiceLoggers = [];
-
     /**
      * An array of options passed to the client.
      *
@@ -134,7 +129,7 @@ class Discord
      *
      * @var LoopInterface Event loop.
      */
-    protected $loop;
+    public $loop;
 
     /**
      * The WebSocket client factory.
@@ -192,13 +187,6 @@ class Discord
      */
     protected $sessionId;
 
-    /**
-     * An array of voice clients that are currently connected.
-     *
-     * @var array Voice Clients.
-     */
-    protected $voiceClients = [];
-
     /**
      * An array of large guilds that need to be requested for members.
      *
@@ -347,6 +335,13 @@ class Discord
      */
     private $application_commands;
 
+    /**
+     * The voice handler, of clients and packets.
+     *
+     * @var VoiceManager
+     */
+    public VoiceManager $voice;
+
     /**
      * The transport compression setting.
      *
@@ -361,6 +356,13 @@ class Discord
      */
     protected $usePayloadCompression;
 
+    /**
+     * The instance of the Discord client.
+     *
+     * @var Discord|null Instance.
+     */
+    protected static Discord $instance;
+
     /**
      * Creates a Discord client instance.
      *
@@ -372,7 +374,7 @@ public function __construct(array $options = [])
     {
         // x86 need gmp extension for big integer operation
         if (PHP_INT_SIZE === 4 && ! BigInt::init()) {
-            throw new \RuntimeException('ext-gmp is not loaded, it is required for 32-bits (x86) PHP.');
+            throw new RequiredExtensionNotLoadedException();
         }
 
         $options = $this->resolveOptions($options);
@@ -382,7 +384,8 @@ public function __construct(array $options = [])
         $this->loop = $options['loop'];
         $this->logger = $options['logger'];
 
-        if (!in_array(php_sapi_name(), ['cli', 'micro'])) {
+        if (! in_array(php_sapi_name(), ['cli', 'micro'])) {
+            // @todo: throw an exception instead?
             $this->logger->critical('DiscordPHP will not run on a webserver. Please use PHP CLI to run a DiscordPHP bot.');
         }
 
@@ -414,6 +417,22 @@ public function __construct(array $options = [])
         $this->useTransportCompression = $options['useTransportCompression'];
         $this->usePayloadCompression = $options['usePayloadCompression'];
         $this->connectWs();
+
+        if (!isset(self::$instance)) {
+            // If the instance is not set, set it to this instance.
+            // This allows for static access to the Discord client.
+            self::$instance = $this;
+        }
+    }
+
+    # BETA - still testing if it works
+    public static function __callStatic($method, $args)
+    {
+        if (method_exists(self::class, $method)) {
+            return self::$instance->$method(...$args);
+        }
+
+        throw new \BadMethodCallException("Method {$method} does not exist in " . __CLASS__);
     }
 
     /**
@@ -423,9 +442,9 @@ public function __construct(array $options = [])
      */
     protected function handleVoiceServerUpdate(Payload $data): void
     {
-        if (isset($this->voiceClients[$data->d->guild_id])) {
+        if (isset($this->voice->clients[$data->d->guild_id])) {
             $this->logger->debug('voice server update received', ['guild' => $data->d->guild_id, 'data' => $data->d]);
-            $this->voiceClients[$data->d->guild_id]->handleVoiceServerChange((array) $data->d);
+            $this->voice->clients[$data->d->guild_id]->handleVoiceServerChange((array) $data->d);
         }
     }
 
@@ -604,15 +623,19 @@ protected function handleGuildMembersChunk(Payload $data): void
      */
     protected function handleVoiceStateUpdate(Payload $data): void
     {
-        if (isset($this->voiceClients[$data->d->guild_id])) {
+        if (isset($this->voice->clients[$data->d->guild_id])) {
             $this->logger->debug('voice state update received', ['guild' => $data->d->guild_id, 'data' => $data->d]);
-            $this->voiceClients[$data->d->guild_id]->handleVoiceStateUpdate($data->d);
+            $this->voice->clients[$data->d->guild_id]->handleVoiceStateUpdate($data->d);
         }
     }
 
     /**
      * Handles WebSocket connections received by the client.
      *
+     * @uses \Discord\Discord::handleWsMessage
+     * @uses \Discord\Discord::handleWsClose
+     * @uses \Discord\Discord::handleWsError
+     *
      * @param WebSocket $ws WebSocket client.
      */
     public function handleWsConnection(WebSocket $ws): void
@@ -782,6 +805,12 @@ public function handleWsConnectionFailed(\Throwable $e): void
     /**
      * Handles dispatch events received by the WebSocket.
      *
+     * @uses \Discord\Discord::handleVoiceStateUpdate
+     * @uses \Discord\Discord::handleVoiceServerUpdate
+     * @uses \Discord\Discord::handleResume
+     * @uses \Discord\Discord::handleReady
+     * @uses \Discord\Discord::handleGuildMembersChunk
+     *
      * @param object $data Packet data.
      */
     protected function handleDispatch(object $data): void
@@ -806,7 +835,6 @@ protected function handleDispatch(object $data): void
                 $this->{$handlers[$data->t]}(Payload::new($data->op, $data->d, $data->s, $data->t));
             }
 
-
             return;
         }
 
@@ -852,11 +880,13 @@ protected function handleDispatch(object $data): void
                 $promise = coroutine([$handler, 'handle'], $data->d);
                 $promise->then([$deferred, 'resolve'], [$deferred, 'reject']);
             };
-        } else {
-            /** @var PromiseInterface */
-            $promise = coroutine([$handler, 'handle'], $data->d);
-            $promise->then([$deferred, 'resolve'], [$deferred, 'reject']);
+
+            return;
         }
+
+        /** @var PromiseInterface */
+        $promise = coroutine([$handler, 'handle'], $data->d);
+        $promise->then([$deferred, 'resolve'], [$deferred, 'reject']);
     }
 
     /**
@@ -1157,7 +1187,7 @@ public function requestSoundboardSounds(array $guildIds): void
      *
      * @param Payload|array $data Packet data.
      */
-    protected function send(Payload|array $data, bool $force = false): void
+    public function send(Payload|array $data, bool $force = false): void
     {
         // Wait until payload count has been reset
         // Keep 5 payloads for heartbeats as required
@@ -1184,6 +1214,9 @@ protected function ready()
         }
         $this->emittedInit = true;
 
+        $this->voice = new VoiceManager($this);
+        $this->logger->info('voice class initialized');
+
         $this->logger->info('client is ready');
         $this->emit('init', [$this]);
 
@@ -1245,12 +1278,13 @@ public function updatePresence(?Activity $activity = null, bool $idle = false, s
      * Gets a voice client from a guild ID. Returns null if there is no voice client.
      *
      * @param string $guild_id The guild ID to look up.
+     * @deprecated Use $discord->voice->getVoiceClient()
      *
      * @return VoiceClient|null
      */
     public function getVoiceClient(string $guild_id): ?VoiceClient
     {
-        return $this->voiceClients[$guild_id] ?? null;
+        return $this->voice->clients[$guild_id] ?? null;
     }
 
     /**
@@ -1266,95 +1300,11 @@ public function getVoiceClient(string $guild_id): ?VoiceClient
      * @since 10.0.0 Removed argument $check that has no effect (it is always checked)
      * @since 4.0.0
      *
-     * @return PromiseInterface<VoiceClient>
+     * @return PromiseInterface<Voice>
      */
     public function joinVoiceChannel(Channel $channel, $mute = false, $deaf = true, ?LoggerInterface $logger = null): PromiseInterface
     {
-        $deferred = new Deferred();
-
-        if (! $channel->isVoiceBased()) {
-            $deferred->reject(new \RuntimeException('Channel must allow voice.'));
-
-            return $deferred->promise();
-        }
-
-        if (isset($this->voiceClients[$channel->guild_id])) {
-            $deferred->reject(new \RuntimeException('You cannot join more than one voice channel per guild.'));
-
-            return $deferred->promise();
-        }
-
-        $data = [
-            'user_id' => $this->id,
-            'deaf' => $deaf,
-            'mute' => $mute,
-        ];
-
-        $voiceStateUpdate = function ($vs, $discord) use ($channel, &$data, &$voiceStateUpdate) {
-            if ($vs->guild_id != $channel->guild_id) {
-                return; // This voice state update isn't for our guild.
-            }
-
-            $data['session'] = $vs->session_id;
-            $this->logger->info('received session id for voice session', ['guild' => $channel->guild_id, 'session_id' => $vs->session_id]);
-            $this->removeListener(Event::VOICE_STATE_UPDATE, $voiceStateUpdate);
-        };
-
-        $voiceServerUpdate = function ($vs, $discord) use ($channel, &$data, &$voiceServerUpdate, $deferred, $logger) {
-            if ($vs->guild_id != $channel->guild_id) {
-                return; // This voice server update isn't for our guild.
-            }
-
-            $data['token'] = $vs->token;
-            $data['endpoint'] = $vs->endpoint;
-            $data['dnsConfig'] = $discord->options['dnsConfig'];
-            $this->logger->info('received token and endpoint for voice session', ['guild' => $channel->guild_id, 'token' => $vs->token, 'endpoint' => $vs->endpoint]);
-
-            if (null === $logger) {
-                $logger = $this->logger;
-            }
-
-            $vc = new VoiceClient($this->ws, $this->loop, $channel, $logger, $data);
-
-            $vc->once('ready', function () use ($vc, $deferred, $channel, $logger) {
-                $logger->info('voice client is ready');
-                $this->voiceClients[$channel->guild_id] = $vc;
-
-                $vc->setBitrate($channel->bitrate);
-                $logger->info('set voice client bitrate', ['bitrate' => $channel->bitrate]);
-                $deferred->resolve($vc);
-            });
-            $vc->once('error', function ($e) use ($deferred, $logger) {
-                $logger->error('error initializing voice client', ['e' => $e->getMessage()]);
-                $deferred->reject($e);
-            });
-            $vc->once('close', function () use ($channel, $logger) {
-                $logger->warning('voice client closed');
-                unset($this->voiceClients[$channel->guild_id]);
-            });
-
-            $vc->start();
-
-            $this->voiceLoggers[$channel->guild_id] = $logger;
-            $this->removeListener(Event::VOICE_SERVER_UPDATE, $voiceServerUpdate);
-        };
-
-        $this->on(Event::VOICE_STATE_UPDATE, $voiceStateUpdate);
-        $this->on(Event::VOICE_SERVER_UPDATE, $voiceServerUpdate);
-
-        $payload = Payload::new(
-            Op::OP_VOICE_STATE_UPDATE,
-            [
-                'guild_id' => $channel->guild_id,
-                'channel_id' => $channel->id,
-                'self_mute' => $mute,
-                'self_deaf' => $deaf,
-            ],
-        );
-
-        $this->send($payload);
-
-        return $deferred->promise();
+        return $this->voice->createClientAndJoinChannel($channel, $this, $mute, $deaf);
     }
 
     /**
@@ -1641,7 +1591,7 @@ public function getLogger(): LoggerInterface
      */
     public function getHttp(): Http
     {
-        return $this->http;
+        return $this->getHttpClient();
     }
 
     /**
@@ -1791,4 +1741,14 @@ public function __debugInfo(): array
 
         return $config;
     }
+
+    public function getWs(): ?WebSocket
+    {
+        return $this->ws;
+    }
+
+    public static function getInstance(): ?self
+    {
+        return self::$instance;
+    }
 }