Merge pull request #1918 from danog/fix-stream-receiver-on-demand

Stream mode: download the stream only to record it

Author: danog

src/GroupCall/GroupCallController.php

@@ -283,12 +283,8 @@ public function resumeAfterRestart(): void
         $this->presentationDj?->resumeReader();
         $this->connection?->resume();
         $this->presentationConnection?->resume();
-        if ($this->streamMode) {
-            // The stream receiver does not survive a restart (its recording does not either):
-            // follow the stream again from the live edge.
-            $this->streamReceiver = new StreamReceiver($this);
-            $this->streamReceiver->start($this->rtmpMode);
-        }
+        // The stream receiver does not survive a restart, and neither does its recording: it's started again when a
+        // recording is set, see setOutput().
         EventLoop::queue($this->refetch(...));
     }
 
@@ -414,8 +410,9 @@ private function applyConnectionParams(array $params): void
             );
             $this->connection?->close();
             $this->connection = null;
-            $this->streamReceiver ??= new StreamReceiver($this);
-            $this->streamReceiver->start($parsed['rtmp']);
+            // Only to record: without a recording, it downloaded every chunk for nothing, and the flood waits of
+            // downloading a few streams at once made it fall behind (TIME_TOO_SMALL), see setOutput().
+            $this->streamReceiver?->start($parsed['rtmp']);
             return;
         }
         if ($parsed['transport'] === null) {
@@ -1143,6 +1140,7 @@ public function setOutput(LocalFile|WritableStream $file, string|int|null $parti
         CallStream::checkAvailable($streams, $available, 'The stream');
         $this->streamReceiver ??= new StreamReceiver($this);
         $this->streamReceiver->setOutput($file, $format);
+        $this->streamReceiver->start($this->rtmpMode);
         return $available;
     }
 
@@ -1162,6 +1160,7 @@ public function setOutputFolder(LocalDirectory $dir, string|int|null $participan
         }
         $this->streamReceiver ??= new StreamReceiver($this);
         $this->streamReceiver->setOutputDirectory($dir, $format);
+        $this->streamReceiver->start($this->rtmpMode);
         return $this;
     }
 

tests/danog/MadelineProto/GroupCallMembershipTest.php

@@ -24,6 +24,8 @@
 use danog\MadelineProto\DataCenter;
 use danog\MadelineProto\EventHandler\Calls\GroupCallState;
 use danog\MadelineProto\GroupCall\GroupCallController;
+use danog\MadelineProto\GroupCall\StreamReceiver;
+use danog\MadelineProto\LocalFile;
 use danog\MadelineProto\Logger;
 use danog\MadelineProto\MTProto;
 use danog\MadelineProto\RPCErrorException;
@@ -148,6 +150,23 @@ public function testAnEndedCallIsLeft(string $rpc): void
         $this->assertSame([], $API->getAllGroupCalls());
     }
 
+    /**
+     * In stream mode, the chunks of the stream are only downloaded to record them: without a recording, magnaluna
+     * downloaded the RTMP livestreams it plays to for nothing, drew flood waits, and fell behind their live edge.
+     */
+    public function testTheStreamIsOnlyDownloadedToRecordIt(): void
+    {
+        $controller = $this->joinedCall($this->client());
+        $receiver = new ReflectionProperty(GroupCallController::class, 'streamReceiver');
+        (fn () => $this->applyConnectionParams(['stream' => true, 'rtmp' => true]))->call($controller);
+        $this->assertNull($receiver->getValue($controller), 'Not downloaded without a recording');
+
+        $controller->setOutput(new LocalFile(sys_get_temp_dir().'/madeline-stream-on-demand.mkv'));
+        $this->assertNotNull($receiver->getValue($controller));
+        $this->assertTrue((new ReflectionProperty(StreamReceiver::class, 'running'))->getValue($receiver->getValue($controller)), 'Downloaded to record it');
+        $receiver->getValue($controller)->stop();
+    }
+
     /**
      * A call that ended is reported to the event handler as discarded: a live story ends with an updateStory, without
      * the groupCallDiscarded the event handler waits for (magnaluna didn't start its live story again).