src/media/cast/audio_receiver/audio_receiver_unittest.cc

   1 // Copyright 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "base/bind.h"
   6 #include "base/memory/ref_counted.h"
   7 #include "base/memory/scoped_ptr.h"
   8 #include "base/test/simple_test_tick_clock.h"
   9 #include "media/cast/audio_receiver/audio_receiver.h"
  10 #include "media/cast/cast_defines.h"
  11 #include "media/cast/cast_environment.h"
  12 #include "media/cast/logging/simple_event_subscriber.h"
  13 #include "media/cast/rtcp/test_rtcp_packet_builder.h"
  14 #include "media/cast/test/fake_single_thread_task_runner.h"
  15 #include "media/cast/transport/pacing/mock_paced_packet_sender.h"
  16 #include "testing/gmock/include/gmock/gmock.h"
  17
  18 namespace media {
  19 namespace cast {
  20
  21 using ::testing::_;
  22
  23 namespace {
  24
  25 const int64 kStartMillisecond = INT64_C(12345678900000);
  26 const uint32 kFirstFrameId = 1234;
  27
  28 class FakeAudioClient {
  29  public:
  30   FakeAudioClient() : num_called_(0) {}
  31   virtual ~FakeAudioClient() {}
  32
  33   void SetNextExpectedResult(uint32 expected_frame_id,
  34                              const base::TimeTicks& expected_playout_time) {
  35     expected_frame_id_ = expected_frame_id;
  36     expected_playout_time_ = expected_playout_time;
  37   }
  38
  39   void DeliverEncodedAudioFrame(
  40       scoped_ptr<transport::EncodedAudioFrame> audio_frame,
  41       const base::TimeTicks& playout_time) {
  42     ASSERT_FALSE(!audio_frame)
  43         << "If at shutdown: There were unsatisfied requests enqueued.";
  44     EXPECT_EQ(expected_frame_id_, audio_frame->frame_id);
  45     EXPECT_EQ(transport::kPcm16, audio_frame->codec);
  46     EXPECT_EQ(expected_playout_time_, playout_time);
  47     num_called_++;
  48   }
  49
  50   int number_times_called() const { return num_called_; }
  51
  52  private:
  53   int num_called_;
  54   uint32 expected_frame_id_;
  55   base::TimeTicks expected_playout_time_;
  56
  57   DISALLOW_COPY_AND_ASSIGN(FakeAudioClient);
  58 };
  59
  60 }  // namespace
  61
  62 class AudioReceiverTest : public ::testing::Test {
  63  protected:
  64   AudioReceiverTest() {
  65     // Configure the audio receiver to use PCM16.
  66     audio_config_.rtp_payload_type = 127;
  67     audio_config_.frequency = 16000;
  68     audio_config_.channels = 1;
  69     audio_config_.codec = transport::kPcm16;
  70     audio_config_.use_external_decoder = true;
  71     audio_config_.feedback_ssrc = 1234;
  72     testing_clock_ = new base::SimpleTestTickClock();
  73     testing_clock_->Advance(
  74         base::TimeDelta::FromMilliseconds(kStartMillisecond));
  75     task_runner_ = new test::FakeSingleThreadTaskRunner(testing_clock_);
  76
  77     cast_environment_ = new CastEnvironment(
  78         scoped_ptr<base::TickClock>(testing_clock_).Pass(),
  79         task_runner_,
  80         task_runner_,
  81         task_runner_);
  82
  83     receiver_.reset(new AudioReceiver(cast_environment_, audio_config_,
  84                                       &mock_transport_));
  85   }
  86
  87   virtual ~AudioReceiverTest() {}
  88
  89   virtual void SetUp() {
  90     payload_.assign(kMaxIpPacketSize, 0);
  91     rtp_header_.is_key_frame = true;
  92     rtp_header_.frame_id = kFirstFrameId;
  93     rtp_header_.packet_id = 0;
  94     rtp_header_.max_packet_id = 0;
  95     rtp_header_.reference_frame_id = 0;
  96     rtp_header_.rtp_timestamp = 0;
  97   }
  98
  99   void FeedOneFrameIntoReceiver() {
 100     receiver_->OnReceivedPayloadData(
 101         payload_.data(), payload_.size(), rtp_header_);
 102   }
 103
 104   AudioReceiverConfig audio_config_;
 105   std::vector<uint8> payload_;
 106   RtpCastHeader rtp_header_;
 107   base::SimpleTestTickClock* testing_clock_;  // Owned by CastEnvironment.
 108   transport::MockPacedPacketSender mock_transport_;
 109   scoped_refptr<test::FakeSingleThreadTaskRunner> task_runner_;
 110   scoped_refptr<CastEnvironment> cast_environment_;
 111   FakeAudioClient fake_audio_client_;
 112
 113   // Important for the AudioReceiver to be declared last, since its dependencies
 114   // must remain alive until after its destruction.
 115   scoped_ptr<AudioReceiver> receiver_;
 116 };
 117
 118 TEST_F(AudioReceiverTest, GetOnePacketEncodedFrame) {
 119   SimpleEventSubscriber event_subscriber;
 120   cast_environment_->Logging()->AddRawEventSubscriber(&event_subscriber);
 121
 122   EXPECT_CALL(mock_transport_, SendRtcpPacket(_, _)).Times(1);
 123
 124   // Enqueue a request for an audio frame.
 125   receiver_->GetEncodedAudioFrame(
 126       base::Bind(&FakeAudioClient::DeliverEncodedAudioFrame,
 127                  base::Unretained(&fake_audio_client_)));
 128
 129   // The request should not be satisfied since no packets have been received.
 130   task_runner_->RunTasks();
 131   EXPECT_EQ(0, fake_audio_client_.number_times_called());
 132
 133   // Deliver one audio frame to the receiver and expect to get one frame back.
 134   fake_audio_client_.SetNextExpectedResult(kFirstFrameId,
 135                                            testing_clock_->NowTicks());
 136   FeedOneFrameIntoReceiver();
 137   task_runner_->RunTasks();
 138   EXPECT_EQ(1, fake_audio_client_.number_times_called());
 139
 140   std::vector<FrameEvent> frame_events;
 141   event_subscriber.GetFrameEventsAndReset(&frame_events);
 142
 143   ASSERT_TRUE(!frame_events.empty());
 144   EXPECT_EQ(kAudioAckSent, frame_events.begin()->type);
 145   EXPECT_EQ(rtp_header_.frame_id, frame_events.begin()->frame_id);
 146   EXPECT_EQ(rtp_header_.rtp_timestamp, frame_events.begin()->rtp_timestamp);
 147
 148   cast_environment_->Logging()->RemoveRawEventSubscriber(&event_subscriber);
 149 }
 150
 151 TEST_F(AudioReceiverTest, MultiplePendingGetCalls) {
 152   EXPECT_CALL(mock_transport_, SendRtcpPacket(_, _))
 153       .WillRepeatedly(testing::Return(true));
 154
 155   // Enqueue a request for an audio frame.
 156   const AudioFrameEncodedCallback frame_encoded_callback =
 157       base::Bind(&FakeAudioClient::DeliverEncodedAudioFrame,
 158                  base::Unretained(&fake_audio_client_));
 159   receiver_->GetEncodedAudioFrame(frame_encoded_callback);
 160   task_runner_->RunTasks();
 161   EXPECT_EQ(0, fake_audio_client_.number_times_called());
 162
 163   // Receive one audio frame and expect to see the first request satisfied.
 164   fake_audio_client_.SetNextExpectedResult(kFirstFrameId,
 165                                            testing_clock_->NowTicks());
 166   FeedOneFrameIntoReceiver();
 167   task_runner_->RunTasks();
 168   EXPECT_EQ(1, fake_audio_client_.number_times_called());
 169
 170   TestRtcpPacketBuilder rtcp_packet;
 171
 172   uint32 ntp_high;
 173   uint32 ntp_low;
 174   ConvertTimeTicksToNtp(testing_clock_->NowTicks(), &ntp_high, &ntp_low);
 175   rtcp_packet.AddSrWithNtp(audio_config_.feedback_ssrc, ntp_high, ntp_low,
 176                            rtp_header_.rtp_timestamp);
 177
 178   testing_clock_->Advance(base::TimeDelta::FromMilliseconds(20));
 179
 180   receiver_->IncomingPacket(rtcp_packet.GetPacket().Pass());
 181
 182   // Enqueue a second request for an audio frame, but it should not be
 183   // fulfilled yet.
 184   receiver_->GetEncodedAudioFrame(frame_encoded_callback);
 185   task_runner_->RunTasks();
 186   EXPECT_EQ(1, fake_audio_client_.number_times_called());
 187
 188   // Receive one audio frame out-of-order: Make sure that we are not continuous
 189   // and that the RTP timestamp represents a time in the future.
 190   rtp_header_.is_key_frame = false;
 191   rtp_header_.frame_id = kFirstFrameId + 2;
 192   rtp_header_.reference_frame_id = 0;
 193   rtp_header_.rtp_timestamp = 960;
 194   fake_audio_client_.SetNextExpectedResult(
 195       kFirstFrameId + 2,
 196       testing_clock_->NowTicks() + base::TimeDelta::FromMilliseconds(100));
 197   FeedOneFrameIntoReceiver();
 198
 199   // Frame 2 should not come out at this point in time.
 200   task_runner_->RunTasks();
 201   EXPECT_EQ(1, fake_audio_client_.number_times_called());
 202
 203   // Enqueue a third request for an audio frame.
 204   receiver_->GetEncodedAudioFrame(frame_encoded_callback);
 205   task_runner_->RunTasks();
 206   EXPECT_EQ(1, fake_audio_client_.number_times_called());
 207
 208   // After 100 ms has elapsed, Frame 2 is emitted (to satisfy the second
 209   // request) because a decision was made to skip over the no-show Frame 1.
 210   testing_clock_->Advance(base::TimeDelta::FromMilliseconds(100));
 211   task_runner_->RunTasks();
 212   EXPECT_EQ(2, fake_audio_client_.number_times_called());
 213
 214   // Receive Frame 3 and expect it to fulfill the third request immediately.
 215   rtp_header_.frame_id = kFirstFrameId + 3;
 216   rtp_header_.reference_frame_id = rtp_header_.frame_id - 1;
 217   rtp_header_.rtp_timestamp = 1280;
 218   fake_audio_client_.SetNextExpectedResult(kFirstFrameId + 3,
 219                                            testing_clock_->NowTicks());
 220   FeedOneFrameIntoReceiver();
 221   task_runner_->RunTasks();
 222   EXPECT_EQ(3, fake_audio_client_.number_times_called());
 223
 224   // Move forward another 100 ms and run any pending tasks (there should be
 225   // none).  Expect no additional frames where emitted.
 226   testing_clock_->Advance(base::TimeDelta::FromMilliseconds(100));
 227   task_runner_->RunTasks();
 228   EXPECT_EQ(3, fake_audio_client_.number_times_called());
 229 }
 230
 231 }  // namespace cast
 232 }  // namespace media