1 /*
2  * Copyright (C) 2023 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #include <audio_utils/CircularBuffer.h>
18 #include <gtest/gtest.h>
19 #include <vector>
20 
21 using android::audio_utils::CircularBuffer;
22 
23 inline constexpr auto MAX_BUFFER_SIZE = 256u;
24 // This array has length that is a divisor of MAX_BUFFER_SIZE
25 inline const uint8_t REFERENCE_DATA_1[] = { 0, 1, 2, 3, 4, 5, 6, 7};
26 // This array has length that is prime with respect to MAX_BUFFER_SIZE
27 inline const uint8_t REFERENCE_DATA_2[] = { 0, 1, 2, 3, 4, 5, 6 };
28 
TEST(audio_utils_circular_buffer,TestBufferConstructor)29 TEST(audio_utils_circular_buffer, TestBufferConstructor) {
30     CircularBuffer buffer(MAX_BUFFER_SIZE);
31     ASSERT_EQ(0u, buffer.availableToRead());
32     ASSERT_EQ(MAX_BUFFER_SIZE, buffer.availableToWrite());
33     ASSERT_TRUE(buffer.empty());
34 }
35 
TEST(audio_utils_circular_buffer,TestBufferReadByte)36 TEST(audio_utils_circular_buffer, TestBufferReadByte) {
37     CircularBuffer buffer(MAX_BUFFER_SIZE);
38     buffer.write(REFERENCE_DATA_1, sizeof(REFERENCE_DATA_1));
39     ASSERT_EQ(MAX_BUFFER_SIZE - sizeof(REFERENCE_DATA_1), buffer.availableToWrite());
40     for (auto i = 0u; i < sizeof(REFERENCE_DATA_1); ++i) {
41         ASSERT_EQ(REFERENCE_DATA_1[i], buffer.readByte());
42     }
43     ASSERT_EQ(MAX_BUFFER_SIZE, buffer.availableToWrite());
44     ASSERT_TRUE(buffer.empty());
45 }
46 
TEST(audio_utils_circular_buffer,TestBufferWriteByte)47 TEST(audio_utils_circular_buffer, TestBufferWriteByte) {
48     CircularBuffer buffer(MAX_BUFFER_SIZE);
49     auto bytesToWrite = buffer.availableToWrite();
50     for (auto i = 0u; i < bytesToWrite; ++i) {
51       buffer.writeByte(REFERENCE_DATA_2[i % sizeof(REFERENCE_DATA_2)]);
52     }
53     ASSERT_EQ(MAX_BUFFER_SIZE, buffer.availableToRead());
54     ASSERT_EQ(0u, buffer.availableToWrite());
55 
56     // Read data and check it matches with reference
57     uint8_t readData[sizeof(REFERENCE_DATA_2)] = { 0 };
58     ASSERT_EQ(sizeof(REFERENCE_DATA_2), buffer.read(readData, sizeof(readData)));
59     ASSERT_EQ(0, memcmp(REFERENCE_DATA_2, readData, sizeof(REFERENCE_DATA_2)));
60 
61     // Write reference data which will wrap around the circular buffer
62     ASSERT_EQ(sizeof(REFERENCE_DATA_2), buffer.availableToWrite());
63     bytesToWrite = buffer.availableToWrite();
64     for (auto i = 0u; i < bytesToWrite; ++i) {
65         buffer.writeByte(REFERENCE_DATA_2[i]);
66     }
67 
68     // Ensure that all the bytes in the buffer are correct
69     uint8_t tmp[MAX_BUFFER_SIZE] = { 0 };
70     uint8_t *p = tmp;
71     ASSERT_EQ(MAX_BUFFER_SIZE, buffer.read(tmp, sizeof(tmp)));
72     constexpr auto BYTES_LEFT = MAX_BUFFER_SIZE - sizeof(REFERENCE_DATA_2);
73     for (auto i = 0u; i < BYTES_LEFT; ++i, ++p) {
74         ASSERT_EQ(REFERENCE_DATA_2[i % sizeof(REFERENCE_DATA_2)], *p);
75     }
76     for (auto i = 0u; i < sizeof(REFERENCE_DATA_2); ++i, ++p) {
77         ASSERT_EQ(REFERENCE_DATA_2[i % sizeof(REFERENCE_DATA_2)], *p);
78     }
79 }
80 
81 // Test reading and writing with data length that is a divisor with respect to buffer sizing.
TEST(audio_utils_circular_buffer,TestBufferReadWrite1)82 TEST(audio_utils_circular_buffer, TestBufferReadWrite1) {
83     CircularBuffer buffer(MAX_BUFFER_SIZE);
84 
85     // Write a few copies of the reference data into the buffer
86     constexpr auto NUM_WRITES = MAX_BUFFER_SIZE / sizeof(REFERENCE_DATA_1) - 1;
87     for (auto i = 0u; i < NUM_WRITES; ++i) {
88         ASSERT_EQ(sizeof(REFERENCE_DATA_1), buffer.write(REFERENCE_DATA_1,
89                 sizeof(REFERENCE_DATA_1)));
90     }
91 
92     // Exercise read() and write() with reference data and ensure buffer wrap around
93     uint8_t tmpData[sizeof(REFERENCE_DATA_1)] = { 0 };
94     for (auto i = 0u; i < 3 * NUM_WRITES; ++i) {
95         ASSERT_EQ(sizeof(REFERENCE_DATA_1), buffer.write(REFERENCE_DATA_1,
96                 sizeof(REFERENCE_DATA_1)));
97         ASSERT_EQ(sizeof(tmpData), buffer.read(tmpData, sizeof(tmpData)));
98         ASSERT_EQ(0, memcmp(REFERENCE_DATA_1, tmpData, sizeof(tmpData)));
99     }
100 }
101 
102 // Test reading and writing with prime sized data length with respect to buffer sizing.
TEST(audio_utils_circular_buffer,TestBufferReadWrite2)103 TEST(audio_utils_circular_buffer, TestBufferReadWrite2) {
104     CircularBuffer buffer(MAX_BUFFER_SIZE);
105 
106     // Write a few copies of the reference data into the buffer
107     constexpr auto NUM_WRITES = MAX_BUFFER_SIZE / sizeof(REFERENCE_DATA_2) - 1;
108     for (auto i = 0u; i < NUM_WRITES; ++i) {
109         ASSERT_EQ(sizeof(REFERENCE_DATA_2), buffer.write(REFERENCE_DATA_2,
110                 sizeof(REFERENCE_DATA_2)));
111     }
112 
113     // Exercise read() and write() with reference data and ensure buffer wrap around
114     uint8_t tmpData[sizeof(REFERENCE_DATA_2)] = { 0 };
115     for (auto i = 0u; i < 3 * NUM_WRITES; ++i) {
116         ASSERT_EQ(sizeof(REFERENCE_DATA_2), buffer.write(REFERENCE_DATA_2,
117                 sizeof(REFERENCE_DATA_2)));
118         ASSERT_EQ(sizeof(tmpData), buffer.read(tmpData, sizeof(tmpData)));
119         ASSERT_EQ(0, memcmp(REFERENCE_DATA_2, tmpData, sizeof(tmpData)));
120     }
121 }
122 
TEST(audio_utils_circular_buffer,TestBufferClear)123 TEST(audio_utils_circular_buffer, TestBufferClear) {
124     CircularBuffer buffer(MAX_BUFFER_SIZE);
125     uint8_t zeroData[MAX_BUFFER_SIZE] = { 0 };
126     buffer.write(zeroData, MAX_BUFFER_SIZE);
127     ASSERT_EQ(0u, buffer.availableToWrite());
128     ASSERT_EQ(MAX_BUFFER_SIZE, buffer.availableToRead());
129     buffer.clear();
130     ASSERT_EQ(MAX_BUFFER_SIZE, buffer.availableToWrite());
131     ASSERT_EQ(0u, buffer.availableToRead());
132     ASSERT_TRUE(buffer.empty());
133 }
134