6e956053b7
Add a StartShortCircuiting() callback to allow clients which have configured Encoded Transforms when creating a PeerConnection to have all frames skip the transform. This offers a zero cost path for streams which don't need transforms. This is preferable to uninstalling/not installing the transform to allow implementing the behaviour in https://w3c.github.io/webrtc-encoded-transform/#stream-creation - giving web apps a chance to configure transforms within a short window (before the next JS event loop run, so usually sub-millisecond) after stream creation, without any untransformed frames passing. Usage in Chromium: crrev.com/c/5040731 Bug: chromium:1502781 Change-Id: I803477db1df51e80bdedf6c84d2d3695b088de83 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/327601 Reviewed-by: Harald Alvestrand <hta@webrtc.org> Commit-Queue: Tony Herre <herre@google.com> Cr-Commit-Position: refs/heads/main@{#41184}
193 lines
8.0 KiB
C++
193 lines
8.0 KiB
C++
/*
|
|
* Copyright (c) 2020 The WebRTC project authors. All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by a BSD-style license
|
|
* that can be found in the LICENSE file in the root of the source
|
|
* tree. An additional intellectual property rights grant can be found
|
|
* in the file PATENTS. All contributing project authors may
|
|
* be found in the AUTHORS file in the root of the source tree.
|
|
*/
|
|
|
|
#include "audio/channel_send_frame_transformer_delegate.h"
|
|
|
|
#include <memory>
|
|
#include <utility>
|
|
|
|
#include "rtc_base/task_queue_for_test.h"
|
|
#include "test/gmock.h"
|
|
#include "test/gtest.h"
|
|
#include "test/mock_frame_transformer.h"
|
|
#include "test/mock_transformable_frame.h"
|
|
|
|
namespace webrtc {
|
|
namespace {
|
|
|
|
using ::testing::_;
|
|
using ::testing::ElementsAre;
|
|
using ::testing::NiceMock;
|
|
using ::testing::Return;
|
|
using ::testing::SaveArg;
|
|
|
|
class MockChannelSend {
|
|
public:
|
|
MockChannelSend() = default;
|
|
~MockChannelSend() = default;
|
|
|
|
MOCK_METHOD(int32_t,
|
|
SendFrame,
|
|
(AudioFrameType frameType,
|
|
uint8_t payloadType,
|
|
uint32_t rtp_timestamp,
|
|
rtc::ArrayView<const uint8_t> payload,
|
|
int64_t absolute_capture_timestamp_ms));
|
|
|
|
ChannelSendFrameTransformerDelegate::SendFrameCallback callback() {
|
|
return [this](AudioFrameType frameType, uint8_t payloadType,
|
|
uint32_t rtp_timestamp, rtc::ArrayView<const uint8_t> payload,
|
|
int64_t absolute_capture_timestamp_ms) {
|
|
return SendFrame(frameType, payloadType, rtp_timestamp, payload,
|
|
absolute_capture_timestamp_ms);
|
|
};
|
|
}
|
|
};
|
|
|
|
std::unique_ptr<MockTransformableAudioFrame> CreateMockReceiverFrame() {
|
|
const uint8_t mock_data[] = {1, 2, 3, 4};
|
|
std::unique_ptr<MockTransformableAudioFrame> mock_frame =
|
|
std::make_unique<MockTransformableAudioFrame>();
|
|
rtc::ArrayView<const uint8_t> payload(mock_data);
|
|
ON_CALL(*mock_frame, GetData).WillByDefault(Return(payload));
|
|
ON_CALL(*mock_frame, GetPayloadType).WillByDefault(Return(0));
|
|
ON_CALL(*mock_frame, GetDirection)
|
|
.WillByDefault(Return(TransformableFrameInterface::Direction::kReceiver));
|
|
return mock_frame;
|
|
}
|
|
|
|
// Test that the delegate registers itself with the frame transformer on Init().
|
|
TEST(ChannelSendFrameTransformerDelegateTest,
|
|
RegisterTransformedFrameCallbackOnInit) {
|
|
rtc::scoped_refptr<MockFrameTransformer> mock_frame_transformer =
|
|
rtc::make_ref_counted<MockFrameTransformer>();
|
|
rtc::scoped_refptr<ChannelSendFrameTransformerDelegate> delegate =
|
|
rtc::make_ref_counted<ChannelSendFrameTransformerDelegate>(
|
|
ChannelSendFrameTransformerDelegate::SendFrameCallback(),
|
|
mock_frame_transformer, nullptr);
|
|
EXPECT_CALL(*mock_frame_transformer, RegisterTransformedFrameCallback);
|
|
delegate->Init();
|
|
}
|
|
|
|
// Test that the delegate unregisters itself from the frame transformer on
|
|
// Reset().
|
|
TEST(ChannelSendFrameTransformerDelegateTest,
|
|
UnregisterTransformedFrameCallbackOnReset) {
|
|
rtc::scoped_refptr<MockFrameTransformer> mock_frame_transformer =
|
|
rtc::make_ref_counted<MockFrameTransformer>();
|
|
rtc::scoped_refptr<ChannelSendFrameTransformerDelegate> delegate =
|
|
rtc::make_ref_counted<ChannelSendFrameTransformerDelegate>(
|
|
ChannelSendFrameTransformerDelegate::SendFrameCallback(),
|
|
mock_frame_transformer, nullptr);
|
|
EXPECT_CALL(*mock_frame_transformer, UnregisterTransformedFrameCallback);
|
|
delegate->Reset();
|
|
}
|
|
|
|
// Test that when the delegate receives a transformed frame from the frame
|
|
// transformer, it passes it to the channel using the SendFrameCallback.
|
|
TEST(ChannelSendFrameTransformerDelegateTest,
|
|
TransformRunsChannelSendCallback) {
|
|
TaskQueueForTest channel_queue("channel_queue");
|
|
rtc::scoped_refptr<MockFrameTransformer> mock_frame_transformer =
|
|
rtc::make_ref_counted<NiceMock<MockFrameTransformer>>();
|
|
MockChannelSend mock_channel;
|
|
rtc::scoped_refptr<ChannelSendFrameTransformerDelegate> delegate =
|
|
rtc::make_ref_counted<ChannelSendFrameTransformerDelegate>(
|
|
mock_channel.callback(), mock_frame_transformer, &channel_queue);
|
|
rtc::scoped_refptr<TransformedFrameCallback> callback;
|
|
EXPECT_CALL(*mock_frame_transformer, RegisterTransformedFrameCallback)
|
|
.WillOnce(SaveArg<0>(&callback));
|
|
delegate->Init();
|
|
ASSERT_TRUE(callback);
|
|
|
|
const uint8_t data[] = {1, 2, 3, 4};
|
|
EXPECT_CALL(mock_channel, SendFrame);
|
|
ON_CALL(*mock_frame_transformer, Transform)
|
|
.WillByDefault(
|
|
[&callback](std::unique_ptr<TransformableFrameInterface> frame) {
|
|
callback->OnTransformedFrame(std::move(frame));
|
|
});
|
|
delegate->Transform(AudioFrameType::kEmptyFrame, 0, 0, data, sizeof(data), 0,
|
|
/*ssrc=*/0, /*mimeType=*/"audio/opus");
|
|
channel_queue.WaitForPreviouslyPostedTasks();
|
|
}
|
|
|
|
// Test that when the delegate receives a Incoming frame from the frame
|
|
// transformer, it passes it to the channel using the SendFrameCallback.
|
|
TEST(ChannelSendFrameTransformerDelegateTest,
|
|
TransformRunsChannelSendCallbackForIncomingFrame) {
|
|
TaskQueueForTest channel_queue("channel_queue");
|
|
rtc::scoped_refptr<MockFrameTransformer> mock_frame_transformer =
|
|
rtc::make_ref_counted<NiceMock<MockFrameTransformer>>();
|
|
MockChannelSend mock_channel;
|
|
rtc::scoped_refptr<ChannelSendFrameTransformerDelegate> delegate =
|
|
rtc::make_ref_counted<ChannelSendFrameTransformerDelegate>(
|
|
mock_channel.callback(), mock_frame_transformer, &channel_queue);
|
|
rtc::scoped_refptr<TransformedFrameCallback> callback;
|
|
EXPECT_CALL(*mock_frame_transformer, RegisterTransformedFrameCallback)
|
|
.WillOnce(SaveArg<0>(&callback));
|
|
delegate->Init();
|
|
ASSERT_TRUE(callback);
|
|
|
|
const uint8_t data[] = {1, 2, 3, 4};
|
|
EXPECT_CALL(mock_channel, SendFrame).Times(0);
|
|
EXPECT_CALL(mock_channel, SendFrame(_, 0, 0, ElementsAre(1, 2, 3, 4), _));
|
|
ON_CALL(*mock_frame_transformer, Transform)
|
|
.WillByDefault(
|
|
[&callback](std::unique_ptr<TransformableFrameInterface> frame) {
|
|
callback->OnTransformedFrame(CreateMockReceiverFrame());
|
|
});
|
|
delegate->Transform(AudioFrameType::kEmptyFrame, 0, 0, data, sizeof(data), 0,
|
|
/*ssrc=*/0, /*mimeType=*/"audio/opus");
|
|
channel_queue.WaitForPreviouslyPostedTasks();
|
|
}
|
|
|
|
// Test that if the delegate receives a transformed frame after it has been
|
|
// reset, it does not run the SendFrameCallback, as the channel is destroyed
|
|
// after resetting the delegate.
|
|
TEST(ChannelSendFrameTransformerDelegateTest,
|
|
OnTransformedDoesNotRunChannelSendCallbackAfterReset) {
|
|
TaskQueueForTest channel_queue("channel_queue");
|
|
rtc::scoped_refptr<MockFrameTransformer> mock_frame_transformer =
|
|
rtc::make_ref_counted<testing::NiceMock<MockFrameTransformer>>();
|
|
MockChannelSend mock_channel;
|
|
rtc::scoped_refptr<ChannelSendFrameTransformerDelegate> delegate =
|
|
rtc::make_ref_counted<ChannelSendFrameTransformerDelegate>(
|
|
mock_channel.callback(), mock_frame_transformer, &channel_queue);
|
|
|
|
delegate->Reset();
|
|
EXPECT_CALL(mock_channel, SendFrame).Times(0);
|
|
delegate->OnTransformedFrame(std::make_unique<MockTransformableAudioFrame>());
|
|
channel_queue.WaitForPreviouslyPostedTasks();
|
|
}
|
|
|
|
TEST(ChannelSendFrameTransformerDelegateTest, ShortCircuitingSkipsTransform) {
|
|
TaskQueueForTest channel_queue("channel_queue");
|
|
rtc::scoped_refptr<MockFrameTransformer> mock_frame_transformer =
|
|
rtc::make_ref_counted<testing::NiceMock<MockFrameTransformer>>();
|
|
MockChannelSend mock_channel;
|
|
rtc::scoped_refptr<ChannelSendFrameTransformerDelegate> delegate =
|
|
rtc::make_ref_counted<ChannelSendFrameTransformerDelegate>(
|
|
mock_channel.callback(), mock_frame_transformer, &channel_queue);
|
|
|
|
delegate->StartShortCircuiting();
|
|
|
|
// Will not call the actual transformer.
|
|
EXPECT_CALL(*mock_frame_transformer, Transform).Times(0);
|
|
// Will pass the frame straight to the channel.
|
|
EXPECT_CALL(mock_channel, SendFrame);
|
|
const uint8_t data[] = {1, 2, 3, 4};
|
|
delegate->Transform(AudioFrameType::kEmptyFrame, 0, 0, data, sizeof(data), 0,
|
|
/*ssrc=*/0, /*mimeType=*/"audio/opus");
|
|
}
|
|
|
|
} // namespace
|
|
} // namespace webrtc
|