/**

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

 * New/updated tests: aschiffler at ferzkopp dot net

 */

#include <stdio.h>

#include <string.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 callback function */

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

{

   /* TODO: add tracking if callback was called */

}

/* Test case functions */

/**

 * \brief Stop and restart audio subsystem

 *

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

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

 */

int audio_quitInitAudioSubSystem()

{

    /* Stop SDL audio subsystem */

    SDL_QuitSubSystem( SDL_INIT_AUDIO );

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

        /* Restart audio again */

        _audioSetUp(NULL);

    return TEST_COMPLETED;

}

/**

 * \brief Start and stop audio directly

 *

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

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

 */

int audio_initQuitAudio()

{

        int result;

    int i, iMax;

    const char* audioDriver;

    /* Stop SDL audio subsystem */

    SDL_QuitSubSystem( SDL_INIT_AUDIO );

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

        /* Loop over all available audio drivers */

        iMax = SDL_GetNumAudioDrivers();

        SDLTest_AssertPass("Call to SDL_GetNumAudioDrivers");

        SDLTest_AssertCheck(iMax > 0, "Validate number of audio drivers; expected: >0 got: %d", iMax);

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

            audioDriver = SDL_GetAudioDriver(i);

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

            SDLTest_AssertCheck(audioDriver != NULL, "Audio driver name is not NULL");

            SDLTest_AssertCheck(SDL_strlen(audioDriver) > 0, "Audio driver name is not empty; got: %s", audioDriver);

            /* Call Init */

            result = SDL_AudioInit(audioDriver);

            SDLTest_AssertPass("Call to SDL_AudioInit('%s')", audioDriver);

            SDLTest_AssertCheck(result == 0, "Validate result value; expected: 0 got: %d", result);

            /* Call Quit */

            SDL_AudioQuit();

            SDLTest_AssertPass("Call to SDL_AudioQuit()");

    }

    /* NULL driver specification */

    audioDriver = NULL;

    /* Call Init */

    result = SDL_AudioInit(audioDriver);

    SDLTest_AssertPass("Call to SDL_AudioInit(NULL)");

    SDLTest_AssertCheck(result == 0, "Validate result value; expected: 0 got: %d", result);

    /* Call Quit */

    SDL_AudioQuit();

    SDLTest_AssertPass("Call to SDL_AudioQuit()");

        /* Restart audio again */

        _audioSetUp(NULL);

    return TEST_COMPLETED;

}

/**

 * \brief Start, open, close and stop audio

 *

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

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

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

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

 */

int audio_initOpenCloseQuitAudio()

{

    int result;

    int i, iMax, j;

    const char* audioDriver;

    SDL_AudioSpec desired;

    /* Stop SDL audio subsystem */

    SDL_QuitSubSystem( SDL_INIT_AUDIO );

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

        /* Loop over all available audio drivers */

        iMax = SDL_GetNumAudioDrivers();

        SDLTest_AssertPass("Call to SDL_GetNumAudioDrivers");

        SDLTest_AssertCheck(iMax > 0, "Validate number of audio drivers; expected: >0 got: %d", iMax);

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

            audioDriver = SDL_GetAudioDriver(i);

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

            SDLTest_AssertCheck(audioDriver != NULL, "Audio driver name is not NULL");

            SDLTest_AssertCheck(SDL_strlen(audioDriver) > 0, "Audio driver name is not empty; got: %s", audioDriver);

            /* Change specs */

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

                /* Call Init */

                result = SDL_AudioInit(audioDriver);

                SDLTest_AssertPass("Call to SDL_AudioInit('%s')", audioDriver);

                SDLTest_AssertCheck(result == 0, "Validate result value; expected: 0 got: %d", result);

                /* Set spec */

                SDL_memset(&desired, 0, sizeof(desired));

                switch (j) {

                    case 0:

                    /* Set standard desired spec */

                    desired.freq = 22050;

                    desired.format = AUDIO_S16SYS;

                    desired.channels = 2;

                    desired.samples = 4096;

                    desired.callback = _audio_testCallback;

                    desired.userdata = NULL;

                    case 1:

                    /* Set custom desired spec */

                    desired.freq = 48000;

                    desired.format = AUDIO_F32SYS;

                    desired.channels = 2;

                    desired.samples = 2048;

                    desired.callback = _audio_testCallback;

                    desired.userdata = NULL;

                    break;

            }

            /* Call Open */

            result = SDL_OpenAudio(&desired, NULL);

            SDLTest_AssertPass("Call to SDL_OpenAudio(desired_spec_%d, NULL)", j);

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

            /* Call Close */

                    SDL_CloseAudio();

                    SDLTest_AssertPass("Call to SDL_CloseAudio()");

            /* Call Quit */

            SDL_AudioQuit();

            SDLTest_AssertPass("Call to SDL_AudioQuit()");

        } /* spec loop */

    } /* driver loop */

        /* Restart audio again */

        _audioSetUp(NULL);

    return TEST_COMPLETED;

}

/**

 * \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) ? "capture" : "output", 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()

{

   /* Check current audio driver */

   const char *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;

}

/* Definition of all formats, channels, and frequencies used to test audio conversions */

const int _numAudioFormats = 18;

SDL_AudioFormat _audioFormats[] = { 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 };

char *_audioFormatsVerbose[] = { "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 _numAudioChannels = 4;

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

const int _numAudioFrequencies = 4;

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

/**

 * \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, ii, j, jj, k, kk;

  /* 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, allow 'null' conversions */

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

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

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

        spec1.format = _audioFormats[i];

        spec1.channels = _audioChannels[j];

        spec1.freq = _audioFrequencies[k];

        ii = SDLTest_RandomIntegerInRange(0, _numAudioFormats - 1);

        jj = SDLTest_RandomIntegerInRange(0, _numAudioChannels - 1);

        kk = SDLTest_RandomIntegerInRange(0, _numAudioFrequencies - 1);

        spec2.format = _audioFormats[ii];

        spec2.channels = _audioChannels[jj];

        spec2.freq = _audioFrequencies[kk];

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

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

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

            i, _audioFormatsVerbose[i], spec1.format, j, spec1.channels, k, spec1.freq, ii, _audioFormatsVerbose[ii], spec2.format, jj, spec2.channels, kk, 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());

        } else {

          SDLTest_AssertCheck(cvt.len_mult > 0, "Verify that cvt.len_mult value; expected: >0, got: %i", cvt.len_mult);

        }

      }

    }

  }

   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 */

    SDL_strlcpy(message, "Invalid: ", 256);

    if (i & 1) {

        SDL_strlcat(message, " spec1.format", 256);

        spec1.format = 0;

    }

    if (i & 2) {

        SDL_strlcat(message, " spec1.channels", 256);

        spec1.channels = 0;

    }

    if (i & 4) {

        SDL_strlcat(message, " spec1.freq", 256);

        spec1.freq = 0;

    }

    if (i & 8) {

        SDL_strlcat(message, " spec2.format", 256);

        spec2.format = 0;

    }

    if (i & 16) {

        SDL_strlcat(message, " spec2.channels", 256);