/**

* Original code: automated SDL audio test written by Edgar Simo "bobbens"

* New/updated tests: aschiffler at ferzkopp dot net

*/

#include <stdio.h>

#include "SDL.h"

#include "SDL_test.h"

/* ================= Test Case Implementation ================== */

/* Fixture */

void

_audioSetUp(void *arg)

{

/* Start SDL audio subsystem */

int ret = SDL_InitSubSystem( SDL_INIT_AUDIO );

SDLTest_AssertPass("Call to SDL_InitSubSystem(SDL_INIT_AUDIO)");

SDLTest_AssertCheck(ret==0, "Check result from SDL_InitSubSystem(SDL_INIT_AUDIO)");

if (ret != 0) {

SDLTest_LogError("%s", SDL_GetError());

}

}

/* Test case functions */

/**

* \brief Enumerate and name available audio devices (output and capture).

*

* \sa http://wiki.libsdl.org/moin.cgi/SDL_GetNumAudioDevices

* \sa http://wiki.libsdl.org/moin.cgi/SDL_GetAudioDeviceName

*/

int audio_enumerateAndNameAudioDevices()

{

int t, tt;

int i, n, nn;

const char *name, *nameAgain;

/* Iterate over types: t=0 output device, t=1 input/capture device */

for (t=0; t<2; t++) {

/* Get number of devices. */

n = SDL_GetNumAudioDevices(t);

SDLTest_AssertPass("Call to SDL_GetNumAudioDevices(%i)", t);

SDLTest_Log("Number of %s devices < 0, reported as %i", (t) ? "output" : "capture", n);

SDLTest_AssertCheck(n >= 0, "Validate result is >= 0, got: %i", n);

/* Variation of non-zero type */

if (t==1) {

tt = t + SDLTest_RandomIntegerInRange(1,10);

nn = SDL_GetNumAudioDevices(tt);

SDLTest_AssertCheck(n==nn, "Verify result from SDL_GetNumAudioDevices(%i), expected same number of audio devices %i, got %i", tt, n, nn);

nn = SDL_GetNumAudioDevices(-tt);

SDLTest_AssertCheck(n==nn, "Verify result from SDL_GetNumAudioDevices(%i), expected same number of audio devices %i, got %i", -tt, n, nn);

}

/* List devices. */

if (n>0) {

for (i=0; i<n; i++) {

name = SDL_GetAudioDeviceName(i, t);

SDLTest_AssertPass("Call to SDL_GetAudioDeviceName(%i, %i)", i, t);

SDLTest_AssertCheck(name != NULL, "Verify result from SDL_GetAudioDeviceName(%i, %i) is not NULL", i, t);

if (name != NULL) {

SDLTest_AssertCheck(SDL_strlen(name)>0, "verify result from SDL_GetAudioDeviceName(%i, %i) is not empty, got: '%s'", i, t, name);

if (t==1) {

/* Also try non-zero type */

tt = t + SDLTest_RandomIntegerInRange(1,10);

nameAgain = SDL_GetAudioDeviceName(i, tt);

SDLTest_AssertCheck(nameAgain != NULL, "Verify result from SDL_GetAudioDeviceName(%i, %i) is not NULL", i, tt);

if (nameAgain != NULL) {

SDLTest_AssertCheck(SDL_strlen(nameAgain)>0, "Verify result from SDL_GetAudioDeviceName(%i, %i) is not empty, got: '%s'", i, tt, nameAgain);

SDLTest_AssertCheck(SDL_strcmp(name, nameAgain)==0,

"Verify SDL_GetAudioDeviceName(%i, %i) and SDL_GetAudioDeviceName(%i %i) return the same string",

i, t, i, tt);

}

}

}

}

}

}

return TEST_COMPLETED;

}

/**

* \brief Negative tests around enumeration and naming of audio devices.

*

* \sa http://wiki.libsdl.org/moin.cgi/SDL_GetNumAudioDevices

* \sa http://wiki.libsdl.org/moin.cgi/SDL_GetAudioDeviceName

*/

int audio_enumerateAndNameAudioDevicesNegativeTests()

{

int t;

int i, j, no, nc;

const char *name;

/* Get number of devices. */

no = SDL_GetNumAudioDevices(0);

SDLTest_AssertPass("Call to SDL_GetNumAudioDevices(0)");

nc = SDL_GetNumAudioDevices(1);

SDLTest_AssertPass("Call to SDL_GetNumAudioDevices(1)");

/* Invalid device index when getting name */

for (t=0; t<2; t++) {

/* Negative device index */

i = SDLTest_RandomIntegerInRange(-10,-1);

name = SDL_GetAudioDeviceName(i, t);

SDLTest_AssertPass("Call to SDL_GetAudioDeviceName(%i, %i)", i, t);

SDLTest_AssertCheck(name == NULL, "Check SDL_GetAudioDeviceName(%i, %i) result NULL, expected NULL, got: %s", i, t, (name == NULL) ? "NULL" : name);

/* Device index past range */

for (j=0; j<3; j++) {

i = (t) ? nc+j : no+j;

name = SDL_GetAudioDeviceName(i, t);

SDLTest_AssertPass("Call to SDL_GetAudioDeviceName(%i, %i)", i, t);

SDLTest_AssertCheck(name == NULL, "Check SDL_GetAudioDeviceName(%i, %i) result, expected: NULL, got: %s", i, t, (name == NULL) ? "NULL" : name);

}

/* Capture index past capture range but within output range */

if ((no>0) && (no>nc) && (t==1)) {

i = no-1;

name = SDL_GetAudioDeviceName(i, t);

SDLTest_AssertPass("Call to SDL_GetAudioDeviceName(%i, %i)", i, t);

SDLTest_AssertCheck(name == NULL, "Check SDL_GetAudioDeviceName(%i, %i) result, expected: NULL, got: %s", i, t, (name == NULL) ? "NULL" : name);

}

}

return TEST_COMPLETED;

}

/**

* \brief Checks available audio driver names.

*

* \sa http://wiki.libsdl.org/moin.cgi/SDL_GetNumAudioDrivers

* \sa http://wiki.libsdl.org/moin.cgi/SDL_GetAudioDriver

*/

int audio_printAudioDrivers()

{

int i, n;

const char *name;

/* Get number of drivers */

n = SDL_GetNumAudioDrivers();

SDLTest_AssertPass("Call to SDL_GetNumAudioDrivers()");

SDLTest_AssertCheck(n>=0, "Verify number of audio drivers >= 0, got: %i", n);

/* List drivers. */

if (n>0)

{

for (i=0; i<n; i++) {

name = SDL_GetAudioDriver(i);

SDLTest_AssertPass("Call to SDL_GetAudioDriver(%i)", i);

SDLTest_AssertCheck(name != NULL, "Verify returned name is not NULL");

if (name != NULL) {

SDLTest_AssertCheck(SDL_strlen(name)>0, "Verify returned name is not empty, got: '%s'", name);

}

}

}

return TEST_COMPLETED;

}

/**

* \brief Checks current audio driver name with initialized audio.

*

* \sa http://wiki.libsdl.org/moin.cgi/SDL_GetCurrentAudioDriver

*/

int audio_printCurrentAudioDriver()

{

const char *name;

/* Check current audio driver */

name = SDL_GetCurrentAudioDriver();

SDLTest_AssertPass("Call to SDL_GetCurrentAudioDriver()");

SDLTest_AssertCheck(name != NULL, "Verify returned name is not NULL");

if (name != NULL) {

SDLTest_AssertCheck(SDL_strlen(name)>0, "Verify returned name is not empty, got: '%s'", name);

}

return TEST_COMPLETED;

}

/**

* \brief Builds various audio conversion structures

*

* \sa http://wiki.libsdl.org/moin.cgi/SDL_BuildAudioCVT

*/

int audio_buildAudioCVT()

{

int result;

SDL_AudioCVT cvt;

SDL_AudioSpec spec1;

SDL_AudioSpec spec2;

int i, j, k;

const int numFormats = 18;

SDL_AudioFormat formats[] = { AUDIO_S8, AUDIO_U8, AUDIO_S16LSB, AUDIO_S16MSB, AUDIO_S16SYS, AUDIO_S16, AUDIO_U16LSB,

AUDIO_U16MSB, AUDIO_U16SYS, AUDIO_U16, AUDIO_S32LSB, AUDIO_S32MSB, AUDIO_S32SYS, AUDIO_S32,

AUDIO_F32LSB, AUDIO_F32MSB, AUDIO_F32SYS, AUDIO_F32 };

const int numChannels = 4;

Uint8 channels[] = { 1, 2, 4, 6 };

const int numFrequencies = 4;

int frequencies[] = { 11025, 22050, 44100, 48000 };

/* No conversion needed */

spec1.format = AUDIO_S16LSB;

spec1.channels = 2;

spec1.freq = 22050;

result = SDL_BuildAudioCVT(&cvt, spec1.format, spec1.channels, spec1.freq,

spec1.format, spec1.channels, spec1.freq);

SDLTest_AssertPass("Call to SDL_BuildAudioCVT(spec1 ==> spec1)");

SDLTest_AssertCheck(result == 0, "Verify result value; expected: 0, got: %i", result);

/* Typical conversion */

spec1.format = AUDIO_S8;

spec1.channels = 1;

spec1.freq = 22050;

spec2.format = AUDIO_S16LSB;

spec2.channels = 2;

spec2.freq = 44100;

result = SDL_BuildAudioCVT(&cvt, spec1.format, spec1.channels, spec1.freq,

spec2.format, spec2.channels, spec2.freq);

SDLTest_AssertPass("Call to SDL_BuildAudioCVT(spec1 ==> spec2)");

SDLTest_AssertCheck(result == 1, "Verify result value; expected: 1, got: %i", result);

/* All source conversions with random conversion targets */

for (i=0; i<numFormats; i++) {

for (j=0; j<numChannels; j++) {

for (k=0; k<numFrequencies; k++) {

spec1.format = formats[i];

spec1.channels = channels[j];

spec1.freq = frequencies[k];

spec2.format = formats[SDLTest_RandomIntegerInRange(0, numFormats - 1)];

spec2.channels = channels[SDLTest_RandomIntegerInRange(0, numChannels - 1)];

spec2.freq = frequencies[SDLTest_RandomIntegerInRange(0, numFrequencies - 1)];

result = SDL_BuildAudioCVT(&cvt, spec1.format, spec1.channels, spec1.freq,

spec2.format, spec2.channels, spec2.freq);

SDLTest_AssertPass("Call to SDL_BuildAudioCVT(format=%i,channels=%i,freq=%i ==> format=%i,channels=%i,freq=%i)",

spec1.format, spec1.channels, spec1.freq, spec2.format, spec2.channels, spec2.freq);

SDLTest_AssertCheck(result == 0 || result == 1, "Verify result value; expected: 0 or 1, got: %i", result);

if (result<0) {

SDLTest_LogError(SDL_GetError());

}

}

}

}

return TEST_COMPLETED;

}

/**

* \brief Checkes calls with invalid input to SDL_BuildAudioCVT

*

* \sa http://wiki.libsdl.org/moin.cgi/SDL_BuildAudioCVT

*/

int audio_buildAudioCVTNegative()

{

const char *expectedError = "Parameter 'cvt' is invalid";

const char *error;

int result;

SDL_AudioCVT cvt;

SDL_AudioSpec spec1;

SDL_AudioSpec spec2;

int i;

char message[256];

/* Valid format */

spec1.format = AUDIO_S8;

spec1.channels = 1;

spec1.freq = 22050;

spec2.format = AUDIO_S16LSB;

spec2.channels = 2;

spec2.freq = 44100;

SDL_ClearError();

SDLTest_AssertPass("Call to SDL_ClearError()");

/* NULL input for CVT buffer */

result = SDL_BuildAudioCVT((SDL_AudioCVT *)NULL, spec1.format, spec1.channels, spec1.freq,

spec2.format, spec2.channels, spec2.freq);

SDLTest_AssertPass("Call to SDL_BuildAudioCVT(NULL,...)");

SDLTest_AssertCheck(result == -1, "Verify result value; expected: -1, got: %i", result);

error = SDL_GetError();

SDLTest_AssertPass("Call to SDL_GetError()");

SDLTest_AssertCheck(error != NULL, "Validate that error message was not NULL");

if (error != NULL) {

SDLTest_AssertCheck(SDL_strcmp(error, expectedError) == 0,

"Validate error message, expected: '%s', got: '%s'", expectedError, error);

}

/* Invalid conversions */

for (i = 1; i < 64; i++) {

/* Valid format to start with */

spec1.format = AUDIO_S8;

spec1.channels = 1;

spec1.freq = 22050;

spec2.format = AUDIO_S16LSB;

spec2.channels = 2;

spec2.freq = 44100;

SDL_ClearError();

SDLTest_AssertPass("Call to SDL_ClearError()");

/* Set various invalid format inputs */

strcpy(message, "Invalid: ");

if (i & 1) {

strcat(message, " spec1.format");

spec1.format = 0;

}

if (i & 2) {

strcat(message, " spec1.channels");

spec1.channels = 0;

}

if (i & 4) {

strcat(message, " spec1.freq");

spec1.freq = 0;

}

if (i & 8) {

strcat(message, " spec2.format");

spec2.format = 0;

}

if (i & 16) {

strcat(message, " spec2.channels");

spec2.channels = 0;

}

if (i & 32) {

strcat(message, " spec2.freq");

spec2.freq = 0;

}

SDLTest_Log(message);

result = SDL_BuildAudioCVT(&cvt, spec1.format, spec1.channels, spec1.freq,

spec2.format, spec2.channels, spec2.freq);

SDLTest_AssertPass("Call to SDL_BuildAudioCVT(spec1 ==> spec2)");

SDLTest_AssertCheck(result == -1, "Verify result value; expected: -1, got: %i", result);

error = SDL_GetError();

SDLTest_AssertPass("Call to SDL_GetError()");

SDLTest_AssertCheck(error != NULL && SDL_strlen(error)>0, "Validate that error message was not NULL or empty");

}

SDL_ClearError();

SDLTest_AssertPass("Call to SDL_ClearError()");

return TEST_COMPLETED;

}

/**

* \brief Checks current audio status.

*

* \sa http://wiki.libsdl.org/moin.cgi/SDL_GetAudioStatus

*/

int audio_getAudioStatus()

{

SDL_AudioStatus result;

/* Check current audio status */

result = SDL_GetAudioStatus();

SDLTest_AssertPass("Call to SDL_GetAudioStatus()");

SDLTest_AssertCheck(result == SDL_AUDIO_STOPPED || result == SDL_AUDIO_PLAYING || result == SDL_AUDIO_PAUSED,

"Verify returned value; expected: STOPPED (%i) | PLAYING (%i) | PAUSED (%i), got: %i",

SDL_AUDIO_STOPPED, SDL_AUDIO_PLAYING, SDL_AUDIO_PAUSED, result);

return TEST_COMPLETED;

}

/* Test callback function */

void _audio_testCallback(void *userdata, Uint8 *stream, int len)

{

}

/**

* \brief Opens, checks current audio status, and closes a device.

*

* \sa http://wiki.libsdl.org/moin.cgi/SDL_GetAudioStatus

*/

int audio_openCloseAndGetAudioStatus()

{

SDL_AudioStatus result;

int i;

int count;

char *device;

SDL_AudioDeviceID id;

SDL_AudioSpec desired, obtained;

/* Get number of devices. */

count = SDL_GetNumAudioDevices(0);

SDLTest_AssertPass("Call to SDL_GetNumAudioDevices(0)");

if (count>0) {

for (i=0; i< count; i++) {

/* Get device name */

device = (char *)SDL_GetAudioDeviceName(i, 0);

SDLTest_AssertPass("SDL_GetAudioDeviceName(%i,0)", i);

SDLTest_AssertCheck(device != NULL, "Validate device name is not NULL; got: %s", (device != NULL) ? device : "NULL");

if (device == NULL) return TEST_ABORTED;

/* Set standard desired spec */

desired.freq=22050;

desired.format=AUDIO_S16SYS;

desired.channels=2;

desired.samples=4096;

desired.callback=_audio_testCallback;

desired.userdata=NULL;

/* Open device */

id = SDL_OpenAudioDevice((const char *)device, 0, &desired, &obtained, SDL_AUDIO_ALLOW_ANY_CHANGE);

SDLTest_AssertPass("SDL_OpenAudioDevice('%s',...)", device);

SDLTest_AssertCheck(id > 1, "Validate device ID; expected: >=2, got: %i", id);

if (id > 1) {

/* Check device audio status */

result = SDL_GetAudioDeviceStatus(id);

SDLTest_AssertPass("Call to SDL_GetAudioDeviceStatus()");

SDLTest_AssertCheck(result == SDL_AUDIO_STOPPED || result == SDL_AUDIO_PLAYING || result == SDL_AUDIO_PAUSED,

"Verify returned value; expected: STOPPED (%i) | PLAYING (%i) | PAUSED (%i), got: %i",

SDL_AUDIO_STOPPED, SDL_AUDIO_PLAYING, SDL_AUDIO_PAUSED, result);

/* Close device again */

SDL_CloseAudioDevice(id);

SDLTest_AssertPass("Call to SDL_CloseAudioDevice()");

}

}

} else {

SDLTest_Log("No devices to test with");

}

return TEST_COMPLETED;

}

/**

* \brief Locks and unlocks open audio device.

*

* \sa http://wiki.libsdl.org/moin.cgi/SDL_LockAudioDevice

* \sa http://wiki.libsdl.org/moin.cgi/SDL_UnlockAudioDevice

*/

int audio_lockUnlockOpenAudioDevice()

{

int i;

int count;

char *device;

SDL_AudioDeviceID id;

SDL_AudioSpec desired, obtained;

/* Get number of devices. */

count = SDL_GetNumAudioDevices(0);

SDLTest_AssertPass("Call to SDL_GetNumAudioDevices(0)");

if (count>0) {

for (i=0; i< count; i++) {

/* Get device name */

device = (char *)SDL_GetAudioDeviceName(i, 0);

SDLTest_AssertPass("SDL_GetAudioDeviceName(%i,0)", i);

SDLTest_AssertCheck(device != NULL, "Validate device name is not NULL; got: %s", (device != NULL) ? device : "NULL");

if (device == NULL) return TEST_ABORTED;

/* Set standard desired spec */

desired.freq=22050;

desired.format=AUDIO_S16SYS;

desired.channels=2;

desired.samples=4096;

desired.callback=_audio_testCallback;

desired.userdata=NULL;

/* Open device */

id = SDL_OpenAudioDevice((const char *)device, 0, &desired, &obtained, SDL_AUDIO_ALLOW_ANY_CHANGE);

SDLTest_AssertPass("SDL_OpenAudioDevice('%s',...)", device);

SDLTest_AssertCheck(id > 1, "Validate device ID; expected: >=2, got: %i", id);

if (id > 1) {

/* Lock to protect callback */

SDL_LockAudioDevice(id);

SDLTest_AssertPass("SDL_LockAudioDevice(%i)", id);

/* Simulate callback processing */

SDL_Delay(10);

SDLTest_Log("Simulate callback processing - delay");

/* Unlock again*/

SDL_UnlockAudioDevice(id);

SDLTest_AssertPass("SDL_UnlockAudioDevice(%i)", id);

/* Close device again */

SDL_CloseAudioDevice(id);

SDLTest_AssertPass("Call to SDL_CloseAudioDevice()");

}

}

} else {

SDLTest_Log("No devices to test with");

}

return TEST_COMPLETED;

}

/* ================= Test Case References ================== */

/* Audio test cases */

static const SDLTest_TestCaseReference audioTest1 =

{ (SDLTest_TestCaseFp)audio_enumerateAndNameAudioDevices, "audio_enumerateAndNameAudioDevices", "Enumerate and name available audio devices (output and capture)", TEST_ENABLED };

static const SDLTest_TestCaseReference audioTest2 =

{ (SDLTest_TestCaseFp)audio_enumerateAndNameAudioDevicesNegativeTests, "audio_enumerateAndNameAudioDevicesNegativeTests", "Negative tests around enumeration and naming of audio devices.", TEST_ENABLED };

static const SDLTest_TestCaseReference audioTest3 =

{ (SDLTest_TestCaseFp)audio_printAudioDrivers, "audio_printAudioDrivers", "Checks available audio driver names.", TEST_ENABLED };

static const SDLTest_TestCaseReference audioTest4 =

{ (SDLTest_TestCaseFp)audio_printCurrentAudioDriver, "audio_printCurrentAudioDriver", "Checks current audio driver name with initialized audio.", TEST_ENABLED };

static const SDLTest_TestCaseReference audioTest5 =

{ (SDLTest_TestCaseFp)audio_buildAudioCVT, "audio_buildAudioCVT", "Builds various audio conversion structures.", TEST_ENABLED };

static const SDLTest_TestCaseReference audioTest6 =

{ (SDLTest_TestCaseFp)audio_buildAudioCVTNegative, "audio_buildAudioCVTNegative", "Checks calls with invalid input to SDL_BuildAudioCVT", TEST_ENABLED };

static const SDLTest_TestCaseReference audioTest7 =

{ (SDLTest_TestCaseFp)audio_getAudioStatus, "audio_getAudioStatus", "Checks current audio status.", TEST_ENABLED };

static const SDLTest_TestCaseReference audioTest8 =

{ (SDLTest_TestCaseFp)audio_openCloseAndGetAudioStatus, "audio_openCloseAndGetAudioStatus", "Opens and closes audio device and get audio status.", TEST_ENABLED };

static const SDLTest_TestCaseReference audioTest9 =

{ (SDLTest_TestCaseFp)audio_lockUnlockOpenAudioDevice, "audio_lockUnlockOpenAudioDevice", "Locks and unlocks an open audio device.", TEST_ENABLED };

/* Sequence of Audio test cases */

static const SDLTest_TestCaseReference *audioTests[] = {

};

/* Audio test suite (global) */

SDLTest_TestSuiteReference audioTestSuite = {

"Audio",

_audioSetUp,

audioTests,

NULL

};