blob: dc19985d57110ffdd8ee24813173a7f3c1bc650e [file] [log] [blame]
/*
* Copyright (C) 2017 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Test various AAudio features including AAudioStream_setBufferSizeInFrames().
#include <condition_variable>
#include <mutex>
#include <stdio.h>
#include <android-base/macros.h>
#include <aaudio/AAudio.h>
#include <gtest/gtest.h>
#include <unistd.h>
// Callback function that does nothing.
aaudio_data_callback_result_t NoopDataCallbackProc(
AAudioStream *stream,
void *userData,
void *audioData,
int32_t numFrames
) {
(void) stream;
(void) userData;
(void) audioData;
(void) numFrames;
return AAUDIO_CALLBACK_RESULT_CONTINUE;
}
// Test AAudioStream_setBufferSizeInFrames()
constexpr int64_t NANOS_PER_MILLISECOND = 1000 * 1000;
//int foo() { // To fix Android Studio formatting when editing.
TEST(test_various, aaudio_stop_when_open) {
AAudioStreamBuilder *aaudioBuilder = nullptr;
AAudioStream *aaudioStream = nullptr;
// Use an AAudioStreamBuilder to contain requested parameters.
ASSERT_EQ(AAUDIO_OK, AAudio_createStreamBuilder(&aaudioBuilder));
// Request stream properties.
AAudioStreamBuilder_setDataCallback(aaudioBuilder, NoopDataCallbackProc, nullptr);
AAudioStreamBuilder_setPerformanceMode(aaudioBuilder, AAUDIO_PERFORMANCE_MODE_LOW_LATENCY);
// Create an AAudioStream using the Builder.
EXPECT_EQ(AAUDIO_OK, AAudioStreamBuilder_openStream(aaudioBuilder, &aaudioStream));
aaudio_stream_state_t state = AAUDIO_STREAM_STATE_UNKNOWN;
EXPECT_EQ(AAUDIO_OK, AAudioStream_waitForStateChange(aaudioStream,
AAUDIO_STREAM_STATE_UNKNOWN, &state,
1000 * NANOS_PER_MILLISECOND));
EXPECT_EQ(AAUDIO_STREAM_STATE_OPEN, state);
EXPECT_EQ(AAUDIO_OK, AAudioStream_requestStop(aaudioStream));
state = AAUDIO_STREAM_STATE_UNKNOWN;
EXPECT_EQ(AAUDIO_OK, AAudioStream_waitForStateChange(aaudioStream,
AAUDIO_STREAM_STATE_UNKNOWN, &state, 0));
EXPECT_EQ(AAUDIO_STREAM_STATE_OPEN, state);
AAudioStream_close(aaudioStream);
AAudioStreamBuilder_delete(aaudioBuilder);
}
//int boo() { // To fix Android Studio formatting when editing.
TEST(test_various, aaudio_flush_when_started) {
AAudioStreamBuilder *aaudioBuilder = nullptr;
AAudioStream *aaudioStream = nullptr;
// Use an AAudioStreamBuilder to contain requested parameters.
ASSERT_EQ(AAUDIO_OK, AAudio_createStreamBuilder(&aaudioBuilder));
// Request stream properties.
AAudioStreamBuilder_setDataCallback(aaudioBuilder, NoopDataCallbackProc, nullptr);
AAudioStreamBuilder_setPerformanceMode(aaudioBuilder, AAUDIO_PERFORMANCE_MODE_LOW_LATENCY);
// Create an AAudioStream using the Builder.
EXPECT_EQ(AAUDIO_OK, AAudioStreamBuilder_openStream(aaudioBuilder, &aaudioStream));
EXPECT_EQ(AAUDIO_OK, AAudioStream_requestStart(aaudioStream));
aaudio_stream_state_t state = AAUDIO_STREAM_STATE_UNKNOWN;
EXPECT_EQ(AAUDIO_OK, AAudioStream_waitForStateChange(aaudioStream,
AAUDIO_STREAM_STATE_STARTING, &state,
1000 * NANOS_PER_MILLISECOND));
EXPECT_EQ(AAUDIO_STREAM_STATE_STARTED, state);
EXPECT_EQ(AAUDIO_ERROR_INVALID_STATE, AAudioStream_requestFlush(aaudioStream));
state = AAUDIO_STREAM_STATE_UNKNOWN;
EXPECT_EQ(AAUDIO_OK, AAudioStream_waitForStateChange(aaudioStream,
AAUDIO_STREAM_STATE_UNKNOWN, &state, 0));
EXPECT_EQ(AAUDIO_STREAM_STATE_STARTED, state);
AAudioStream_close(aaudioStream);
AAudioStreamBuilder_delete(aaudioBuilder);
}
//int main() { // To fix Android Studio formatting when editing.
TEST(test_various, aaudio_set_buffer_size) {
int32_t bufferCapacity;
int32_t framesPerBurst = 0;
int32_t actualSize = 0;
AAudioStreamBuilder *aaudioBuilder = nullptr;
AAudioStream *aaudioStream = nullptr;
// Use an AAudioStreamBuilder to contain requested parameters.
ASSERT_EQ(AAUDIO_OK, AAudio_createStreamBuilder(&aaudioBuilder));
// Request stream properties.
AAudioStreamBuilder_setDataCallback(aaudioBuilder, NoopDataCallbackProc, nullptr);
AAudioStreamBuilder_setPerformanceMode(aaudioBuilder, AAUDIO_PERFORMANCE_MODE_LOW_LATENCY);
// Create an AAudioStream using the Builder.
EXPECT_EQ(AAUDIO_OK, AAudioStreamBuilder_openStream(aaudioBuilder, &aaudioStream));
// This is the number of frames that are read in one chunk by a DMA controller
// or a DSP or a mixer.
framesPerBurst = AAudioStream_getFramesPerBurst(aaudioStream);
bufferCapacity = AAudioStream_getBufferCapacityInFrames(aaudioStream);
printf(" bufferCapacity = %d, remainder = %d\n",
bufferCapacity, bufferCapacity % framesPerBurst);
actualSize = AAudioStream_setBufferSizeInFrames(aaudioStream, 0);
EXPECT_GT(actualSize, 0);
EXPECT_LE(actualSize, bufferCapacity);
actualSize = AAudioStream_setBufferSizeInFrames(aaudioStream, 2 * framesPerBurst);
EXPECT_GT(actualSize, framesPerBurst);
EXPECT_LE(actualSize, bufferCapacity);
actualSize = AAudioStream_setBufferSizeInFrames(aaudioStream, bufferCapacity - 1);
EXPECT_GT(actualSize, framesPerBurst);
EXPECT_LE(actualSize, bufferCapacity);
actualSize = AAudioStream_setBufferSizeInFrames(aaudioStream, bufferCapacity);
EXPECT_GT(actualSize, framesPerBurst);
EXPECT_LE(actualSize, bufferCapacity);
actualSize = AAudioStream_setBufferSizeInFrames(aaudioStream, bufferCapacity + 1);
EXPECT_GT(actualSize, framesPerBurst);
EXPECT_LE(actualSize, bufferCapacity);
actualSize = AAudioStream_setBufferSizeInFrames(aaudioStream, 1234567);
EXPECT_GT(actualSize, framesPerBurst);
EXPECT_LE(actualSize, bufferCapacity);
actualSize = AAudioStream_setBufferSizeInFrames(aaudioStream, INT32_MAX);
EXPECT_GT(actualSize, framesPerBurst);
EXPECT_LE(actualSize, bufferCapacity);
actualSize = AAudioStream_setBufferSizeInFrames(aaudioStream, INT32_MIN);
EXPECT_GT(actualSize, 0);
EXPECT_LE(actualSize, bufferCapacity);
AAudioStream_close(aaudioStream);
AAudioStreamBuilder_delete(aaudioBuilder);
}
// ************************************************************
// Test to make sure that AAUDIO_CALLBACK_RESULT_STOP works.
// Callback function that counts calls.
aaudio_data_callback_result_t CallbackOnceProc(
AAudioStream *stream,
void *userData,
void *audioData,
int32_t numFrames
) {
(void) stream;
(void) audioData;
(void) numFrames;
std::atomic<int32_t> *callbackCountPtr = (std::atomic<int32_t> *)userData;
(*callbackCountPtr)++;
return AAUDIO_CALLBACK_RESULT_STOP;
}
void checkCallbackOnce(aaudio_performance_mode_t perfMode) {
std::atomic<int32_t> callbackCount{0};
AAudioStreamBuilder *aaudioBuilder = nullptr;
AAudioStream *aaudioStream = nullptr;
// Use an AAudioStreamBuilder to contain requested parameters.
ASSERT_EQ(AAUDIO_OK, AAudio_createStreamBuilder(&aaudioBuilder));
// Request stream properties.
AAudioStreamBuilder_setDataCallback(aaudioBuilder, CallbackOnceProc, &callbackCount);
AAudioStreamBuilder_setPerformanceMode(aaudioBuilder, perfMode);
// Create an AAudioStream using the Builder.
ASSERT_EQ(AAUDIO_OK, AAudioStreamBuilder_openStream(aaudioBuilder, &aaudioStream));
AAudioStreamBuilder_delete(aaudioBuilder);
ASSERT_EQ(AAUDIO_OK, AAudioStream_requestStart(aaudioStream));
sleep(1); // Give callback a chance to run many times.
EXPECT_EQ(AAUDIO_OK, AAudioStream_requestStop(aaudioStream));
EXPECT_EQ(1, callbackCount.load()); // should stop after first call
EXPECT_EQ(AAUDIO_OK, AAudioStream_close(aaudioStream));
}
TEST(test_various, aaudio_callback_once_none) {
checkCallbackOnce(AAUDIO_PERFORMANCE_MODE_NONE);
}
TEST(test_various, aaudio_callback_once_lowlat) {
checkCallbackOnce(AAUDIO_PERFORMANCE_MODE_LOW_LATENCY);
}
// ************************************************************
struct WakeUpCallbackData {
void wakeOther() {
// signal waiting test to wake up
{
std::lock_guard <std::mutex> lock(mutex);
finished = true;
}
conditionVariable.notify_one();
}
void waitForFinished() {
std::unique_lock <std::mutex> aLock(mutex);
conditionVariable.wait(aLock, [=] { return finished; });
}
// For signalling foreground test when callback finished
std::mutex mutex;
std::condition_variable conditionVariable;
bool finished = false;
};
// Test to make sure we cannot call recursively into the system from a callback.
struct DangerousData : public WakeUpCallbackData {
aaudio_result_t resultStart = AAUDIO_OK;
aaudio_result_t resultStop = AAUDIO_OK;
aaudio_result_t resultPause = AAUDIO_OK;
aaudio_result_t resultFlush = AAUDIO_OK;
aaudio_result_t resultClose = AAUDIO_OK;
};
// Callback function that tries to call back into the stream.
aaudio_data_callback_result_t DangerousDataCallbackProc(
AAudioStream *stream,
void *userData,
void *audioData,
int32_t numFrames) {
(void) audioData;
(void) numFrames;
DangerousData *data = (DangerousData *)userData;
data->resultStart = AAudioStream_requestStart(stream);
data->resultStop = AAudioStream_requestStop(stream);
data->resultPause = AAudioStream_requestPause(stream);
data->resultFlush = AAudioStream_requestFlush(stream);
data->resultClose = AAudioStream_close(stream);
data->wakeOther();
return AAUDIO_CALLBACK_RESULT_STOP;
}
//int main() { // To fix Android Studio formatting when editing.
void checkDangerousCallback(aaudio_performance_mode_t perfMode) {
DangerousData dangerousData;
AAudioStreamBuilder *aaudioBuilder = nullptr;
AAudioStream *aaudioStream = nullptr;
// Use an AAudioStreamBuilder to contain requested parameters.
ASSERT_EQ(AAUDIO_OK, AAudio_createStreamBuilder(&aaudioBuilder));
// Request stream properties.
AAudioStreamBuilder_setDataCallback(aaudioBuilder, DangerousDataCallbackProc, &dangerousData);
AAudioStreamBuilder_setPerformanceMode(aaudioBuilder, perfMode);
// Create an AAudioStream using the Builder.
ASSERT_EQ(AAUDIO_OK, AAudioStreamBuilder_openStream(aaudioBuilder, &aaudioStream));
AAudioStreamBuilder_delete(aaudioBuilder);
ASSERT_EQ(AAUDIO_OK, AAudioStream_requestStart(aaudioStream));
dangerousData.waitForFinished();
EXPECT_EQ(AAUDIO_OK, AAudioStream_requestStop(aaudioStream));
EXPECT_EQ(AAUDIO_ERROR_INVALID_STATE, dangerousData.resultStart);
EXPECT_EQ(AAUDIO_ERROR_INVALID_STATE, dangerousData.resultStop);
EXPECT_EQ(AAUDIO_ERROR_INVALID_STATE, dangerousData.resultPause);
EXPECT_EQ(AAUDIO_ERROR_INVALID_STATE, dangerousData.resultFlush);
EXPECT_EQ(AAUDIO_ERROR_INVALID_STATE, dangerousData.resultClose);
EXPECT_EQ(AAUDIO_OK, AAudioStream_close(aaudioStream));
}
//int main() { // To fix Android Studio formatting when editing.
TEST(test_various, aaudio_callback_blockers_none) {
checkDangerousCallback(AAUDIO_PERFORMANCE_MODE_NONE);
}
TEST(test_various, aaudio_callback_blockers_lowlat) {
checkDangerousCallback(AAUDIO_PERFORMANCE_MODE_LOW_LATENCY);
}