modules/rtp_rtcp/source/rtp_payload_registry_unittest.cc - src/webrtc - Git at Google

 /*
  *  Copyright (c) 2013 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 "webrtc/modules/rtp_rtcp/interface/rtp_payload_registry.h"

 #include "testing/gmock/include/gmock/gmock.h"
 #include "testing/gtest/include/gtest/gtest.h"
 #include "webrtc/modules/rtp_rtcp/source/mock/mock_rtp_payload_strategy.h"
 #include "webrtc/modules/rtp_rtcp/source/rtp_utility.h"
 #include "webrtc/system_wrappers/interface/scoped_ptr.h"

 namespace webrtc {

 using ::testing::Eq;
 using ::testing::Return;
 using ::testing::_;

 static const char* kTypicalPayloadName = "name";
 static const uint8_t kTypicalChannels = 1;
 static const int kTypicalFrequency = 44000;
 static const int kTypicalRate = 32 * 1024;

 class RtpPayloadRegistryTest : public ::testing::Test {
  public:
   void SetUp() {
     // Note: the payload registry takes ownership of the strategy.
     mock_payload_strategy_ = new testing::NiceMock<MockRTPPayloadStrategy>();
     rtp_payload_registry_.reset(new RTPPayloadRegistry(mock_payload_strategy_));
   }

  protected:
   RtpUtility::Payload* ExpectReturnOfTypicalAudioPayload(uint8_t payload_type,
                                                          uint32_t rate) {
     bool audio = true;
     RtpUtility::Payload returned_payload = {
         "name",
         audio,
         {// Initialize the audio struct in this case.
          {kTypicalFrequency, kTypicalChannels, rate}}};

     // Note: we return a new payload since the payload registry takes ownership
     // of the created object.
     RtpUtility::Payload* returned_payload_on_heap =
         new RtpUtility::Payload(returned_payload);
     EXPECT_CALL(*mock_payload_strategy_,
         CreatePayloadType(kTypicalPayloadName, payload_type,
             kTypicalFrequency,
             kTypicalChannels,
             rate)).WillOnce(Return(returned_payload_on_heap));
     return returned_payload_on_heap;
   }

   scoped_ptr<RTPPayloadRegistry> rtp_payload_registry_;
   testing::NiceMock<MockRTPPayloadStrategy>* mock_payload_strategy_;
 };

 TEST_F(RtpPayloadRegistryTest, RegistersAndRemembersPayloadsUntilDeregistered) {
   uint8_t payload_type = 97;
   RtpUtility::Payload* returned_payload_on_heap =
       ExpectReturnOfTypicalAudioPayload(payload_type, kTypicalRate);

   bool new_payload_created = false;
   EXPECT_EQ(0, rtp_payload_registry_->RegisterReceivePayload(
       kTypicalPayloadName, payload_type, kTypicalFrequency, kTypicalChannels,
       kTypicalRate, &new_payload_created));

   EXPECT_TRUE(new_payload_created) << "A new payload WAS created.";

   RtpUtility::Payload* retrieved_payload = NULL;
   EXPECT_TRUE(rtp_payload_registry_->PayloadTypeToPayload(payload_type,
                                                           retrieved_payload));

   // We should get back the exact pointer to the payload returned by the
   // payload strategy.
   EXPECT_EQ(returned_payload_on_heap, retrieved_payload);

   // Now forget about it and verify it's gone.
   EXPECT_EQ(0, rtp_payload_registry_->DeRegisterReceivePayload(payload_type));
   EXPECT_FALSE(rtp_payload_registry_->PayloadTypeToPayload(
       payload_type, retrieved_payload));
 }

 TEST_F(RtpPayloadRegistryTest, DoesNotCreateNewPayloadTypeIfRed) {
   EXPECT_CALL(*mock_payload_strategy_,
       CreatePayloadType(_, _, _, _, _)).Times(0);

   bool new_payload_created = false;
   uint8_t red_type_of_the_day = 104;
   EXPECT_EQ(0, rtp_payload_registry_->RegisterReceivePayload(
       "red", red_type_of_the_day, kTypicalFrequency, kTypicalChannels,
       kTypicalRate, &new_payload_created));
   ASSERT_FALSE(new_payload_created);

   ASSERT_EQ(red_type_of_the_day, rtp_payload_registry_->red_payload_type());

   RtpUtility::Payload* retrieved_payload = NULL;
   EXPECT_TRUE(rtp_payload_registry_->PayloadTypeToPayload(red_type_of_the_day,
                                                           retrieved_payload));
   EXPECT_FALSE(retrieved_payload->audio);
   EXPECT_STRCASEEQ("red", retrieved_payload->name);
 }

 TEST_F(RtpPayloadRegistryTest,
        DoesNotAcceptSamePayloadTypeTwiceExceptIfPayloadIsCompatible) {
   uint8_t payload_type = 97;

   bool ignored = false;
   RtpUtility::Payload* first_payload_on_heap =
       ExpectReturnOfTypicalAudioPayload(payload_type, kTypicalRate);
   EXPECT_EQ(0, rtp_payload_registry_->RegisterReceivePayload(
       kTypicalPayloadName, payload_type, kTypicalFrequency, kTypicalChannels,
       kTypicalRate, &ignored));

   EXPECT_EQ(-1, rtp_payload_registry_->RegisterReceivePayload(
       kTypicalPayloadName, payload_type, kTypicalFrequency, kTypicalChannels,
       kTypicalRate, &ignored)) << "Adding same codec twice = bad.";

   RtpUtility::Payload* second_payload_on_heap =
       ExpectReturnOfTypicalAudioPayload(payload_type - 1, kTypicalRate);
   EXPECT_EQ(0, rtp_payload_registry_->RegisterReceivePayload(
       kTypicalPayloadName, payload_type - 1, kTypicalFrequency,
       kTypicalChannels, kTypicalRate, &ignored)) <<
           "With a different payload type is fine though.";

   // Ensure both payloads are preserved.
   RtpUtility::Payload* retrieved_payload = NULL;
   EXPECT_TRUE(rtp_payload_registry_->PayloadTypeToPayload(payload_type,
                                                           retrieved_payload));
   EXPECT_EQ(first_payload_on_heap, retrieved_payload);
   EXPECT_TRUE(rtp_payload_registry_->PayloadTypeToPayload(payload_type - 1,
                                                           retrieved_payload));
   EXPECT_EQ(second_payload_on_heap, retrieved_payload);

   // Ok, update the rate for one of the codecs. If either the incoming rate or
   // the stored rate is zero it's not really an error to register the same
   // codec twice, and in that case roughly the following happens.
   ON_CALL(*mock_payload_strategy_, PayloadIsCompatible(_, _, _, _))
       .WillByDefault(Return(true));
   EXPECT_CALL(*mock_payload_strategy_,
               UpdatePayloadRate(first_payload_on_heap, kTypicalRate));
   EXPECT_EQ(0, rtp_payload_registry_->RegisterReceivePayload(
       kTypicalPayloadName, payload_type, kTypicalFrequency, kTypicalChannels,
       kTypicalRate, &ignored));
 }

 TEST_F(RtpPayloadRegistryTest,
        RemovesCompatibleCodecsOnRegistryIfCodecsMustBeUnique) {
   ON_CALL(*mock_payload_strategy_, PayloadIsCompatible(_, _, _, _))
       .WillByDefault(Return(true));
   ON_CALL(*mock_payload_strategy_, CodecsMustBeUnique())
       .WillByDefault(Return(true));

   uint8_t payload_type = 97;

   bool ignored = false;
   ExpectReturnOfTypicalAudioPayload(payload_type, kTypicalRate);
   EXPECT_EQ(0, rtp_payload_registry_->RegisterReceivePayload(
       kTypicalPayloadName, payload_type, kTypicalFrequency, kTypicalChannels,
       kTypicalRate, &ignored));
   ExpectReturnOfTypicalAudioPayload(payload_type - 1, kTypicalRate);
   EXPECT_EQ(0, rtp_payload_registry_->RegisterReceivePayload(
       kTypicalPayloadName, payload_type - 1, kTypicalFrequency,
       kTypicalChannels, kTypicalRate, &ignored));

   RtpUtility::Payload* retrieved_payload = NULL;
   EXPECT_FALSE(rtp_payload_registry_->PayloadTypeToPayload(
       payload_type, retrieved_payload)) << "The first payload should be "
           "deregistered because the only thing that differs is payload type.";
   EXPECT_TRUE(rtp_payload_registry_->PayloadTypeToPayload(
       payload_type - 1, retrieved_payload)) <<
           "The second payload should still be registered though.";

   // Now ensure non-compatible codecs aren't removed.
   ON_CALL(*mock_payload_strategy_, PayloadIsCompatible(_, _, _, _))
       .WillByDefault(Return(false));
   ExpectReturnOfTypicalAudioPayload(payload_type + 1, kTypicalRate);
   EXPECT_EQ(0, rtp_payload_registry_->RegisterReceivePayload(
       kTypicalPayloadName, payload_type + 1, kTypicalFrequency,
       kTypicalChannels, kTypicalRate, &ignored));

   EXPECT_TRUE(rtp_payload_registry_->PayloadTypeToPayload(
       payload_type - 1, retrieved_payload)) <<
           "Not compatible; both payloads should be kept.";
   EXPECT_TRUE(rtp_payload_registry_->PayloadTypeToPayload(
       payload_type + 1, retrieved_payload)) <<
           "Not compatible; both payloads should be kept.";
 }

 TEST_F(RtpPayloadRegistryTest,
        LastReceivedCodecTypesAreResetWhenRegisteringNewPayloadTypes) {
   rtp_payload_registry_->set_last_received_payload_type(17);
   EXPECT_EQ(17, rtp_payload_registry_->last_received_payload_type());

   bool media_type_unchanged = rtp_payload_registry_->ReportMediaPayloadType(18);
   EXPECT_FALSE(media_type_unchanged);
   media_type_unchanged = rtp_payload_registry_->ReportMediaPayloadType(18);
   EXPECT_TRUE(media_type_unchanged);

   bool ignored;
   ExpectReturnOfTypicalAudioPayload(34, kTypicalRate);
   EXPECT_EQ(0, rtp_payload_registry_->RegisterReceivePayload(
       kTypicalPayloadName, 34, kTypicalFrequency, kTypicalChannels,
       kTypicalRate, &ignored));

   EXPECT_EQ(-1, rtp_payload_registry_->last_received_payload_type());
   media_type_unchanged = rtp_payload_registry_->ReportMediaPayloadType(18);
   EXPECT_FALSE(media_type_unchanged);
 }

 class ParameterizedRtpPayloadRegistryTest :
     public RtpPayloadRegistryTest,
     public ::testing::WithParamInterface<int> {
 };

 TEST_P(ParameterizedRtpPayloadRegistryTest,
        FailsToRegisterKnownPayloadsWeAreNotInterestedIn) {
   int payload_type = GetParam();

   bool ignored;
   EXPECT_EQ(-1, rtp_payload_registry_->RegisterReceivePayload(
       "whatever", static_cast<uint8_t>(payload_type), 19, 1, 17,
       &ignored));
 }

 INSTANTIATE_TEST_CASE_P(TestKnownBadPayloadTypes,
                         ParameterizedRtpPayloadRegistryTest,
                         testing::Values(64, 72, 73, 74, 75, 76, 77, 78, 79));

 class RtpPayloadRegistryGenericTest :
     public RtpPayloadRegistryTest,
     public ::testing::WithParamInterface<int> {
 };

 TEST_P(RtpPayloadRegistryGenericTest, RegisterGenericReceivePayloadType) {
   int payload_type = GetParam();

   bool ignored;

   EXPECT_EQ(0, rtp_payload_registry_->RegisterReceivePayload("generic-codec",
     static_cast<int8_t>(payload_type),
     19, 1, 17, &ignored)); // dummy values, except for payload_type
 }

 INSTANTIATE_TEST_CASE_P(TestDynamicRange, RtpPayloadRegistryGenericTest,
                         testing::Range(96, 127+1));

 }  // namespace webrtc
	/*
	* Copyright (c) 2013 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 "webrtc/modules/rtp_rtcp/interface/rtp_payload_registry.h"

	#include "testing/gmock/include/gmock/gmock.h"
	#include "testing/gtest/include/gtest/gtest.h"
	#include "webrtc/modules/rtp_rtcp/source/mock/mock_rtp_payload_strategy.h"
	#include "webrtc/modules/rtp_rtcp/source/rtp_utility.h"
	#include "webrtc/system_wrappers/interface/scoped_ptr.h"

	namespace webrtc {

	using ::testing::Eq;
	using ::testing::Return;
	using ::testing::_;

	static const char* kTypicalPayloadName = "name";
	static const uint8_t kTypicalChannels = 1;
	static const int kTypicalFrequency = 44000;
	static const int kTypicalRate = 32 * 1024;

	class RtpPayloadRegistryTest : public ::testing::Test {
	public:
	void SetUp() {
	// Note: the payload registry takes ownership of the strategy.
	mock_payload_strategy_ = new testing::NiceMock<MockRTPPayloadStrategy>();
	rtp_payload_registry_.reset(new RTPPayloadRegistry(mock_payload_strategy_));
	}

	protected:
	RtpUtility::Payload* ExpectReturnOfTypicalAudioPayload(uint8_t payload_type,
	uint32_t rate) {
	bool audio = true;
	RtpUtility::Payload returned_payload = {
	"name",
	audio,
	{// Initialize the audio struct in this case.
	{kTypicalFrequency, kTypicalChannels, rate}}};

	// Note: we return a new payload since the payload registry takes ownership
	// of the created object.
	RtpUtility::Payload* returned_payload_on_heap =
	new RtpUtility::Payload(returned_payload);
	EXPECT_CALL(*mock_payload_strategy_,
	CreatePayloadType(kTypicalPayloadName, payload_type,
	kTypicalFrequency,
	kTypicalChannels,
	rate)).WillOnce(Return(returned_payload_on_heap));
	return returned_payload_on_heap;
	}

	scoped_ptr<RTPPayloadRegistry> rtp_payload_registry_;
	testing::NiceMock<MockRTPPayloadStrategy>* mock_payload_strategy_;
	};

	TEST_F(RtpPayloadRegistryTest, RegistersAndRemembersPayloadsUntilDeregistered) {
	uint8_t payload_type = 97;
	RtpUtility::Payload* returned_payload_on_heap =
	ExpectReturnOfTypicalAudioPayload(payload_type, kTypicalRate);

	bool new_payload_created = false;
	EXPECT_EQ(0, rtp_payload_registry_->RegisterReceivePayload(
	kTypicalPayloadName, payload_type, kTypicalFrequency, kTypicalChannels,
	kTypicalRate, &new_payload_created));

	EXPECT_TRUE(new_payload_created) << "A new payload WAS created.";

	RtpUtility::Payload* retrieved_payload = NULL;
	EXPECT_TRUE(rtp_payload_registry_->PayloadTypeToPayload(payload_type,
	retrieved_payload));

	// We should get back the exact pointer to the payload returned by the
	// payload strategy.
	EXPECT_EQ(returned_payload_on_heap, retrieved_payload);

	// Now forget about it and verify it's gone.
	EXPECT_EQ(0, rtp_payload_registry_->DeRegisterReceivePayload(payload_type));
	EXPECT_FALSE(rtp_payload_registry_->PayloadTypeToPayload(
	payload_type, retrieved_payload));
	}

	TEST_F(RtpPayloadRegistryTest, DoesNotCreateNewPayloadTypeIfRed) {
	EXPECT_CALL(*mock_payload_strategy_,
	CreatePayloadType(_, _, _, _, _)).Times(0);

	bool new_payload_created = false;
	uint8_t red_type_of_the_day = 104;
	EXPECT_EQ(0, rtp_payload_registry_->RegisterReceivePayload(
	"red", red_type_of_the_day, kTypicalFrequency, kTypicalChannels,
	kTypicalRate, &new_payload_created));
	ASSERT_FALSE(new_payload_created);

	ASSERT_EQ(red_type_of_the_day, rtp_payload_registry_->red_payload_type());

	RtpUtility::Payload* retrieved_payload = NULL;
	EXPECT_TRUE(rtp_payload_registry_->PayloadTypeToPayload(red_type_of_the_day,
	retrieved_payload));
	EXPECT_FALSE(retrieved_payload->audio);
	EXPECT_STRCASEEQ("red", retrieved_payload->name);
	}

	TEST_F(RtpPayloadRegistryTest,
	DoesNotAcceptSamePayloadTypeTwiceExceptIfPayloadIsCompatible) {
	uint8_t payload_type = 97;

	bool ignored = false;
	RtpUtility::Payload* first_payload_on_heap =
	ExpectReturnOfTypicalAudioPayload(payload_type, kTypicalRate);
	EXPECT_EQ(0, rtp_payload_registry_->RegisterReceivePayload(
	kTypicalPayloadName, payload_type, kTypicalFrequency, kTypicalChannels,
	kTypicalRate, &ignored));

	EXPECT_EQ(-1, rtp_payload_registry_->RegisterReceivePayload(
	kTypicalPayloadName, payload_type, kTypicalFrequency, kTypicalChannels,
	kTypicalRate, &ignored)) << "Adding same codec twice = bad.";

	RtpUtility::Payload* second_payload_on_heap =
	ExpectReturnOfTypicalAudioPayload(payload_type - 1, kTypicalRate);
	EXPECT_EQ(0, rtp_payload_registry_->RegisterReceivePayload(
	kTypicalPayloadName, payload_type - 1, kTypicalFrequency,
	kTypicalChannels, kTypicalRate, &ignored)) <<
	"With a different payload type is fine though.";

	// Ensure both payloads are preserved.
	RtpUtility::Payload* retrieved_payload = NULL;
	EXPECT_TRUE(rtp_payload_registry_->PayloadTypeToPayload(payload_type,
	retrieved_payload));
	EXPECT_EQ(first_payload_on_heap, retrieved_payload);
	EXPECT_TRUE(rtp_payload_registry_->PayloadTypeToPayload(payload_type - 1,
	retrieved_payload));
	EXPECT_EQ(second_payload_on_heap, retrieved_payload);

	// Ok, update the rate for one of the codecs. If either the incoming rate or
	// the stored rate is zero it's not really an error to register the same
	// codec twice, and in that case roughly the following happens.
	ON_CALL(*mock_payload_strategy_, PayloadIsCompatible(_, _, _, _))
	.WillByDefault(Return(true));
	EXPECT_CALL(*mock_payload_strategy_,
	UpdatePayloadRate(first_payload_on_heap, kTypicalRate));
	EXPECT_EQ(0, rtp_payload_registry_->RegisterReceivePayload(
	kTypicalPayloadName, payload_type, kTypicalFrequency, kTypicalChannels,
	kTypicalRate, &ignored));
	}

	TEST_F(RtpPayloadRegistryTest,
	RemovesCompatibleCodecsOnRegistryIfCodecsMustBeUnique) {
	ON_CALL(*mock_payload_strategy_, PayloadIsCompatible(_, _, _, _))
	.WillByDefault(Return(true));
	ON_CALL(*mock_payload_strategy_, CodecsMustBeUnique())
	.WillByDefault(Return(true));

	uint8_t payload_type = 97;

	bool ignored = false;
	ExpectReturnOfTypicalAudioPayload(payload_type, kTypicalRate);
	EXPECT_EQ(0, rtp_payload_registry_->RegisterReceivePayload(
	kTypicalPayloadName, payload_type, kTypicalFrequency, kTypicalChannels,
	kTypicalRate, &ignored));
	ExpectReturnOfTypicalAudioPayload(payload_type - 1, kTypicalRate);
	EXPECT_EQ(0, rtp_payload_registry_->RegisterReceivePayload(
	kTypicalPayloadName, payload_type - 1, kTypicalFrequency,
	kTypicalChannels, kTypicalRate, &ignored));

	RtpUtility::Payload* retrieved_payload = NULL;
	EXPECT_FALSE(rtp_payload_registry_->PayloadTypeToPayload(
	payload_type, retrieved_payload)) << "The first payload should be "
	"deregistered because the only thing that differs is payload type.";
	EXPECT_TRUE(rtp_payload_registry_->PayloadTypeToPayload(
	payload_type - 1, retrieved_payload)) <<
	"The second payload should still be registered though.";

	// Now ensure non-compatible codecs aren't removed.
	ON_CALL(*mock_payload_strategy_, PayloadIsCompatible(_, _, _, _))
	.WillByDefault(Return(false));
	ExpectReturnOfTypicalAudioPayload(payload_type + 1, kTypicalRate);
	EXPECT_EQ(0, rtp_payload_registry_->RegisterReceivePayload(
	kTypicalPayloadName, payload_type + 1, kTypicalFrequency,
	kTypicalChannels, kTypicalRate, &ignored));

	EXPECT_TRUE(rtp_payload_registry_->PayloadTypeToPayload(
	payload_type - 1, retrieved_payload)) <<
	"Not compatible; both payloads should be kept.";
	EXPECT_TRUE(rtp_payload_registry_->PayloadTypeToPayload(
	payload_type + 1, retrieved_payload)) <<
	"Not compatible; both payloads should be kept.";
	}

	TEST_F(RtpPayloadRegistryTest,
	LastReceivedCodecTypesAreResetWhenRegisteringNewPayloadTypes) {
	rtp_payload_registry_->set_last_received_payload_type(17);
	EXPECT_EQ(17, rtp_payload_registry_->last_received_payload_type());

	bool media_type_unchanged = rtp_payload_registry_->ReportMediaPayloadType(18);
	EXPECT_FALSE(media_type_unchanged);
	media_type_unchanged = rtp_payload_registry_->ReportMediaPayloadType(18);
	EXPECT_TRUE(media_type_unchanged);

	bool ignored;
	ExpectReturnOfTypicalAudioPayload(34, kTypicalRate);
	EXPECT_EQ(0, rtp_payload_registry_->RegisterReceivePayload(
	kTypicalPayloadName, 34, kTypicalFrequency, kTypicalChannels,
	kTypicalRate, &ignored));

	EXPECT_EQ(-1, rtp_payload_registry_->last_received_payload_type());
	media_type_unchanged = rtp_payload_registry_->ReportMediaPayloadType(18);
	EXPECT_FALSE(media_type_unchanged);
	}

	class ParameterizedRtpPayloadRegistryTest :
	public RtpPayloadRegistryTest,
	public ::testing::WithParamInterface<int> {
	};

	TEST_P(ParameterizedRtpPayloadRegistryTest,
	FailsToRegisterKnownPayloadsWeAreNotInterestedIn) {
	int payload_type = GetParam();

	bool ignored;
	EXPECT_EQ(-1, rtp_payload_registry_->RegisterReceivePayload(
	"whatever", static_cast<uint8_t>(payload_type), 19, 1, 17,
	&ignored));
	}

	INSTANTIATE_TEST_CASE_P(TestKnownBadPayloadTypes,
	ParameterizedRtpPayloadRegistryTest,
	testing::Values(64, 72, 73, 74, 75, 76, 77, 78, 79));

	class RtpPayloadRegistryGenericTest :
	public RtpPayloadRegistryTest,
	public ::testing::WithParamInterface<int> {
	};

	TEST_P(RtpPayloadRegistryGenericTest, RegisterGenericReceivePayloadType) {
	int payload_type = GetParam();

	bool ignored;

	EXPECT_EQ(0, rtp_payload_registry_->RegisterReceivePayload("generic-codec",
	static_cast<int8_t>(payload_type),
	19, 1, 17, &ignored)); // dummy values, except for payload_type
	}

	INSTANTIATE_TEST_CASE_P(TestDynamicRange, RtpPayloadRegistryGenericTest,
	testing::Range(96, 127+1));

	} // namespace webrtc