1 /*
2 * Copyright (c) 2023, Alliance for Open Media. All rights reserved
3 *
4 * This source code is subject to the terms of the BSD 3-Clause Clear License
5 * and the Alliance for Open Media Patent License 1.0. If the BSD 3-Clause Clear
6 * License was not distributed with this source code in the LICENSE file, you
7 * can obtain it at www.aomedia.org/license/software-license/bsd-3-c-c. If the
8 * Alliance for Open Media Patent License 1.0 was not distributed with this
9 * source code in the PATENTS file, you can obtain it at
10 * www.aomedia.org/license/patent.
11 */
12 #include "iamf/cli/codec/opus_encoder.h"
13
14 #include <cstdint>
15 #include <memory>
16 #include <vector>
17
18 #include "absl/status/status_matchers.h"
19 #include "gmock/gmock.h"
20 #include "gtest/gtest.h"
21 #include "iamf/cli/codec/tests/encoder_test_base.h"
22 #include "iamf/cli/proto/codec_config.pb.h"
23 #include "iamf/obu/codec_config.h"
24 #include "iamf/obu/decoder_config/opus_decoder_config.h"
25 #include "iamf/obu/obu_header.h"
26
27 namespace iamf_tools {
28 namespace {
29
30 using ::absl_testing::IsOk;
31
32 constexpr bool kOverrideAudioRollDistance = true;
33 constexpr bool kValidateCodecDelay = true;
34 constexpr bool kDontValidateCodecDelay = false;
35 constexpr uint16_t kIncorrectPreSkip = 999;
36
37 class OpusEncoderTest : public EncoderTestBase, public testing::Test {
38 public:
OpusEncoderTest()39 OpusEncoderTest() {
40 opus_encoder_metadata_.set_target_bitrate_per_channel(48000);
41 opus_encoder_metadata_.set_application(
42 iamf_tools_cli_proto::APPLICATION_AUDIO);
43 num_samples_per_frame_ = 120;
44 input_sample_size_ = 16;
45 }
46
47 ~OpusEncoderTest() = default;
48
49 protected:
ConstructEncoder()50 void ConstructEncoder() override {
51 // Construct a Codec Config OBU. The only fields that should affect the
52 // output are `num_samples_per_frame` and `decoder_config`.
53 const CodecConfig temp = {.codec_id = CodecConfig::kCodecIdOpus,
54 .num_samples_per_frame = num_samples_per_frame_,
55 .decoder_config = opus_decoder_config_};
56
57 CodecConfigObu codec_config(ObuHeader(), 0, temp);
58 EXPECT_THAT(codec_config.Initialize(kOverrideAudioRollDistance), IsOk());
59
60 encoder_ = std::make_unique<OpusEncoder>(
61 opus_encoder_metadata_, codec_config, num_channels_, substream_id_);
62 }
63
64 OpusDecoderConfig opus_decoder_config_ = {
65 .version_ = 1, .pre_skip_ = 312, .input_sample_rate_ = 48000};
66 iamf_tools_cli_proto::OpusEncoderMetadata opus_encoder_metadata_ = {};
67 }; // namespace iamf_tools
68
TEST_F(OpusEncoderTest,FramesAreInOrder)69 TEST_F(OpusEncoderTest, FramesAreInOrder) {
70 InitExpectOk();
71
72 // Encode several frames and ensure the correct number of frames are output in
73 // the same order as the input.
74 const int kNumFrames = 100;
75 for (int i = 0; i < kNumFrames; i++) {
76 EncodeAudioFrame(std::vector<std::vector<int32_t>>(
77 num_samples_per_frame_, std::vector<int32_t>(num_channels_, i)));
78 }
79 FinalizeAndValidateOrderOnly(kNumFrames);
80 }
81
TEST_F(OpusEncoderTest,EncodeAndFinalizes16BitFrameSucceeds)82 TEST_F(OpusEncoderTest, EncodeAndFinalizes16BitFrameSucceeds) {
83 input_sample_size_ = 16;
84 InitExpectOk();
85
86 EncodeAudioFrame(std::vector<std::vector<int32_t>>(
87 num_samples_per_frame_, std::vector<int32_t>(num_channels_, 42 << 16)));
88
89 FinalizeAndValidateOrderOnly(1);
90 }
91
TEST_F(OpusEncoderTest,EncodeAndFinalizes16BitFrameSucceedsWithoutFloatApi)92 TEST_F(OpusEncoderTest, EncodeAndFinalizes16BitFrameSucceedsWithoutFloatApi) {
93 input_sample_size_ = 16;
94 opus_encoder_metadata_.set_use_float_api(false);
95 InitExpectOk();
96
97 EncodeAudioFrame(std::vector<std::vector<int32_t>>(
98 num_samples_per_frame_, std::vector<int32_t>(num_channels_, 42 << 16)));
99
100 FinalizeAndValidateOrderOnly(1);
101 }
102
TEST_F(OpusEncoderTest,EncodeAndFinalizes24BitFrameSucceeds)103 TEST_F(OpusEncoderTest, EncodeAndFinalizes24BitFrameSucceeds) {
104 input_sample_size_ = 24;
105 InitExpectOk();
106
107 EncodeAudioFrame(std::vector<std::vector<int32_t>>(
108 num_samples_per_frame_, std::vector<int32_t>(num_channels_, 42 << 8)));
109
110 FinalizeAndValidateOrderOnly(1);
111 }
112
TEST_F(OpusEncoderTest,EncodeAndFinalizes32BitFrameSucceeds)113 TEST_F(OpusEncoderTest, EncodeAndFinalizes32BitFrameSucceeds) {
114 input_sample_size_ = 32;
115 InitExpectOk();
116
117 EncodeAudioFrame(std::vector<std::vector<int32_t>>(
118 num_samples_per_frame_, std::vector<int32_t>(num_channels_, 42)));
119
120 FinalizeAndValidateOrderOnly(1);
121 }
122
TEST_F(OpusEncoderTest,IgnoresPreSkipWhenValidateCodecDelayIsFalse)123 TEST_F(OpusEncoderTest, IgnoresPreSkipWhenValidateCodecDelayIsFalse) {
124 opus_decoder_config_.pre_skip_ = kIncorrectPreSkip;
125 ConstructEncoder();
126
127 EXPECT_THAT(encoder_->Initialize(kDontValidateCodecDelay), IsOk());
128 }
129
TEST_F(OpusEncoderTest,ChecksPreSkipWhenValidateCodecDelayIsTrue)130 TEST_F(OpusEncoderTest, ChecksPreSkipWhenValidateCodecDelayIsTrue) {
131 opus_decoder_config_.pre_skip_ = kIncorrectPreSkip;
132 ConstructEncoder();
133
134 EXPECT_FALSE(encoder_->Initialize(kValidateCodecDelay).ok());
135 }
136
137 } // namespace
138 } // namespace iamf_tools
139