cannam@162: /** @file paqa_errs.c cannam@162: @ingroup qa_src cannam@162: @brief Self Testing Quality Assurance app for PortAudio cannam@162: Do lots of bad things to test error reporting. cannam@162: @author Phil Burk http://www.softsynth.com cannam@162: Pieter Suurmond adapted to V19 API. cannam@162: */ cannam@162: /* cannam@162: * $Id$ cannam@162: * cannam@162: * This program uses the PortAudio Portable Audio Library. cannam@162: * For more information see: http://www.portaudio.com cannam@162: * Copyright (c) 1999-2000 Ross Bencina and Phil Burk cannam@162: * cannam@162: * Permission is hereby granted, free of charge, to any person obtaining cannam@162: * a copy of this software and associated documentation files cannam@162: * (the "Software"), to deal in the Software without restriction, cannam@162: * including without limitation the rights to use, copy, modify, merge, cannam@162: * publish, distribute, sublicense, and/or sell copies of the Software, cannam@162: * and to permit persons to whom the Software is furnished to do so, cannam@162: * subject to the following conditions: cannam@162: * cannam@162: * The above copyright notice and this permission notice shall be cannam@162: * included in all copies or substantial portions of the Software. cannam@162: * cannam@162: * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, cannam@162: * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF cannam@162: * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. cannam@162: * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR cannam@162: * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF cannam@162: * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION cannam@162: * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. cannam@162: */ cannam@162: cannam@162: /* cannam@162: * The text above constitutes the entire PortAudio license; however, cannam@162: * the PortAudio community also makes the following non-binding requests: cannam@162: * cannam@162: * Any person wishing to distribute modifications to the Software is cannam@162: * requested to send the modifications to the original developer so that cannam@162: * they can be incorporated into the canonical version. It is also cannam@162: * requested that these non-binding requests be included along with the cannam@162: * license above. cannam@162: */ cannam@162: cannam@162: #include cannam@162: #include cannam@162: cannam@162: #include "portaudio.h" cannam@162: cannam@162: /*--------- Definitions ---------*/ cannam@162: #define MODE_INPUT (0) cannam@162: #define MODE_OUTPUT (1) cannam@162: #define FRAMES_PER_BUFFER (64) cannam@162: #define SAMPLE_RATE (44100.0) cannam@162: cannam@162: typedef struct PaQaData cannam@162: { cannam@162: unsigned long framesLeft; cannam@162: int numChannels; cannam@162: int bytesPerSample; cannam@162: int mode; cannam@162: } cannam@162: PaQaData; cannam@162: cannam@162: static int gNumPassed = 0; /* Two globals */ cannam@162: static int gNumFailed = 0; cannam@162: cannam@162: /*------------------- Macros ------------------------------*/ cannam@162: /* Print ERROR if it fails. Tally success or failure. Odd */ cannam@162: /* do-while wrapper seems to be needed for some compilers. */ cannam@162: cannam@162: #define EXPECT(_exp) \ cannam@162: do \ cannam@162: { \ cannam@162: if ((_exp)) {\ cannam@162: gNumPassed++; \ cannam@162: } \ cannam@162: else { \ cannam@162: printf("\nERROR - 0x%x - %s for %s\n", result, Pa_GetErrorText(result), #_exp ); \ cannam@162: gNumFailed++; \ cannam@162: goto error; \ cannam@162: } \ cannam@162: } while(0) cannam@162: cannam@162: #define HOPEFOR(_exp) \ cannam@162: do \ cannam@162: { \ cannam@162: if ((_exp)) {\ cannam@162: gNumPassed++; \ cannam@162: } \ cannam@162: else { \ cannam@162: printf("\nERROR - 0x%x - %s for %s\n", result, Pa_GetErrorText(result), #_exp ); \ cannam@162: gNumFailed++; \ cannam@162: } \ cannam@162: } while(0) cannam@162: cannam@162: /*-------------------------------------------------------------------------*/ cannam@162: /* This routine will be called by the PortAudio engine when audio is needed. cannam@162: It may be called at interrupt level on some machines so don't do anything cannam@162: that could mess up the system like calling malloc() or free(). cannam@162: */ cannam@162: static int QaCallback( const void* inputBuffer, cannam@162: void* outputBuffer, cannam@162: unsigned long framesPerBuffer, cannam@162: const PaStreamCallbackTimeInfo* timeInfo, cannam@162: PaStreamCallbackFlags statusFlags, cannam@162: void* userData ) cannam@162: { cannam@162: unsigned long i; cannam@162: unsigned char* out = (unsigned char *) outputBuffer; cannam@162: PaQaData* data = (PaQaData *) userData; cannam@162: cannam@162: (void)inputBuffer; /* Prevent "unused variable" warnings. */ cannam@162: cannam@162: /* Zero out buffer so we don't hear terrible noise. */ cannam@162: if( data->mode == MODE_OUTPUT ) cannam@162: { cannam@162: unsigned long numBytes = framesPerBuffer * data->numChannels * data->bytesPerSample; cannam@162: for( i=0; iframesLeft > framesPerBuffer ) cannam@162: { cannam@162: data->framesLeft -= framesPerBuffer; cannam@162: return 0; cannam@162: } cannam@162: else cannam@162: { cannam@162: data->framesLeft = 0; cannam@162: return 1; cannam@162: } cannam@162: } cannam@162: cannam@162: static PaDeviceIndex FindInputOnlyDevice(void) cannam@162: { cannam@162: PaDeviceIndex result = Pa_GetDefaultInputDevice(); cannam@162: if( result != paNoDevice && Pa_GetDeviceInfo(result)->maxOutputChannels == 0 ) cannam@162: return result; cannam@162: cannam@162: for( result = 0; result < Pa_GetDeviceCount(); ++result ) cannam@162: { cannam@162: if( Pa_GetDeviceInfo(result)->maxOutputChannels == 0 ) cannam@162: return result; cannam@162: } cannam@162: cannam@162: return paNoDevice; cannam@162: } cannam@162: cannam@162: static PaDeviceIndex FindOutputOnlyDevice(void) cannam@162: { cannam@162: PaDeviceIndex result = Pa_GetDefaultOutputDevice(); cannam@162: if( result != paNoDevice && Pa_GetDeviceInfo(result)->maxInputChannels == 0 ) cannam@162: return result; cannam@162: cannam@162: for( result = 0; result < Pa_GetDeviceCount(); ++result ) cannam@162: { cannam@162: if( Pa_GetDeviceInfo(result)->maxInputChannels == 0 ) cannam@162: return result; cannam@162: } cannam@162: cannam@162: return paNoDevice; cannam@162: } cannam@162: cannam@162: /*-------------------------------------------------------------------------------------------------*/ cannam@162: static int TestBadOpens( void ) cannam@162: { cannam@162: PaStream* stream = NULL; cannam@162: PaError result; cannam@162: PaQaData myData; cannam@162: PaStreamParameters ipp, opp; cannam@162: const PaDeviceInfo* info = NULL; cannam@162: cannam@162: cannam@162: /* Setup data for synthesis thread. */ cannam@162: myData.framesLeft = (unsigned long) (SAMPLE_RATE * 100); /* 100 seconds */ cannam@162: myData.numChannels = 1; cannam@162: myData.mode = MODE_OUTPUT; cannam@162: cannam@162: /*----------------------------- No devices specified: */ cannam@162: ipp.device = opp.device = paNoDevice; cannam@162: ipp.channelCount = opp.channelCount = 0; /* Also no channels. */ cannam@162: ipp.hostApiSpecificStreamInfo = opp.hostApiSpecificStreamInfo = NULL; cannam@162: ipp.sampleFormat = opp.sampleFormat = paFloat32; cannam@162: /* Take the low latency of the default device for all subsequent tests. */ cannam@162: info = Pa_GetDeviceInfo(Pa_GetDefaultInputDevice()); cannam@162: ipp.suggestedLatency = info ? info->defaultLowInputLatency : 0.100; cannam@162: info = Pa_GetDeviceInfo(Pa_GetDefaultOutputDevice()); cannam@162: opp.suggestedLatency = info ? info->defaultLowOutputLatency : 0.100; cannam@162: HOPEFOR(((result = Pa_OpenStream(&stream, &ipp, &opp, cannam@162: SAMPLE_RATE, FRAMES_PER_BUFFER, cannam@162: paClipOff, QaCallback, &myData )) == paInvalidDevice)); cannam@162: cannam@162: /*----------------------------- No devices specified #2: */ cannam@162: HOPEFOR(((result = Pa_OpenStream(&stream, NULL, NULL, cannam@162: SAMPLE_RATE, FRAMES_PER_BUFFER, cannam@162: paClipOff, QaCallback, &myData )) == paInvalidDevice)); cannam@162: cannam@162: /*----------------------------- Out of range input device specified: */ cannam@162: ipp.hostApiSpecificStreamInfo = opp.hostApiSpecificStreamInfo = NULL; cannam@162: ipp.sampleFormat = opp.sampleFormat = paFloat32; cannam@162: ipp.channelCount = 0; ipp.device = Pa_GetDeviceCount(); /* And no output device, and no channels. */ cannam@162: opp.channelCount = 0; opp.device = paNoDevice; cannam@162: HOPEFOR(((result = Pa_OpenStream(&stream, &ipp, NULL, cannam@162: SAMPLE_RATE, FRAMES_PER_BUFFER, cannam@162: paClipOff, QaCallback, &myData )) == paInvalidDevice)); cannam@162: cannam@162: /*----------------------------- Out of range output device specified: */ cannam@162: ipp.hostApiSpecificStreamInfo = opp.hostApiSpecificStreamInfo = NULL; cannam@162: ipp.sampleFormat = opp.sampleFormat = paFloat32; cannam@162: ipp.channelCount = 0; ipp.device = paNoDevice; /* And no input device, and no channels. */ cannam@162: opp.channelCount = 0; opp.device = Pa_GetDeviceCount(); cannam@162: HOPEFOR(((result = Pa_OpenStream(&stream, NULL, &opp, cannam@162: SAMPLE_RATE, FRAMES_PER_BUFFER, cannam@162: paClipOff, QaCallback, &myData )) == paInvalidDevice)); cannam@162: cannam@162: if (Pa_GetDefaultInputDevice() != paNoDevice) { cannam@162: /*----------------------------- Zero input channels: */ cannam@162: ipp.hostApiSpecificStreamInfo = opp.hostApiSpecificStreamInfo = NULL; cannam@162: ipp.sampleFormat = opp.sampleFormat = paFloat32; cannam@162: ipp.channelCount = 0; ipp.device = Pa_GetDefaultInputDevice(); cannam@162: opp.channelCount = 0; opp.device = paNoDevice; /* And no output device, and no output channels. */ cannam@162: HOPEFOR(((result = Pa_OpenStream(&stream, &ipp, NULL, cannam@162: SAMPLE_RATE, FRAMES_PER_BUFFER, cannam@162: paClipOff, QaCallback, &myData )) == paInvalidChannelCount)); cannam@162: } cannam@162: cannam@162: if (Pa_GetDefaultOutputDevice() != paNoDevice) { cannam@162: /*----------------------------- Zero output channels: */ cannam@162: ipp.hostApiSpecificStreamInfo = opp.hostApiSpecificStreamInfo = NULL; cannam@162: ipp.sampleFormat = opp.sampleFormat = paFloat32; cannam@162: ipp.channelCount = 0; ipp.device = paNoDevice; /* And no input device, and no input channels. */ cannam@162: opp.channelCount = 0; opp.device = Pa_GetDefaultOutputDevice(); cannam@162: HOPEFOR(((result = Pa_OpenStream(&stream, NULL, &opp, cannam@162: SAMPLE_RATE, FRAMES_PER_BUFFER, cannam@162: paClipOff, QaCallback, &myData )) == paInvalidChannelCount)); cannam@162: } cannam@162: /*----------------------------- Nonzero input and output channels but no output device: */ cannam@162: ipp.hostApiSpecificStreamInfo = opp.hostApiSpecificStreamInfo = NULL; cannam@162: ipp.sampleFormat = opp.sampleFormat = paFloat32; cannam@162: ipp.channelCount = 2; ipp.device = Pa_GetDefaultInputDevice(); /* Both stereo. */ cannam@162: opp.channelCount = 2; opp.device = paNoDevice; cannam@162: HOPEFOR(((result = Pa_OpenStream(&stream, &ipp, &opp, cannam@162: SAMPLE_RATE, FRAMES_PER_BUFFER, cannam@162: paClipOff, QaCallback, &myData )) == paInvalidDevice)); cannam@162: cannam@162: /*----------------------------- Nonzero input and output channels but no input device: */ cannam@162: ipp.hostApiSpecificStreamInfo = opp.hostApiSpecificStreamInfo = NULL; cannam@162: ipp.sampleFormat = opp.sampleFormat = paFloat32; cannam@162: ipp.channelCount = 2; ipp.device = paNoDevice; cannam@162: opp.channelCount = 2; opp.device = Pa_GetDefaultOutputDevice(); cannam@162: HOPEFOR(((result = Pa_OpenStream(&stream, &ipp, &opp, cannam@162: SAMPLE_RATE, FRAMES_PER_BUFFER, cannam@162: paClipOff, QaCallback, &myData )) == paInvalidDevice)); cannam@162: cannam@162: if (Pa_GetDefaultOutputDevice() != paNoDevice) { cannam@162: /*----------------------------- NULL stream pointer: */ cannam@162: ipp.hostApiSpecificStreamInfo = opp.hostApiSpecificStreamInfo = NULL; cannam@162: ipp.sampleFormat = opp.sampleFormat = paFloat32; cannam@162: ipp.channelCount = 0; ipp.device = paNoDevice; /* Output is more likely than input. */ cannam@162: opp.channelCount = 2; opp.device = Pa_GetDefaultOutputDevice(); /* Only 2 output channels. */ cannam@162: HOPEFOR(((result = Pa_OpenStream(NULL, &ipp, &opp, cannam@162: SAMPLE_RATE, FRAMES_PER_BUFFER, cannam@162: paClipOff, QaCallback, &myData )) == paBadStreamPtr)); cannam@162: cannam@162: /*----------------------------- Low sample rate: */ cannam@162: ipp.hostApiSpecificStreamInfo = opp.hostApiSpecificStreamInfo = NULL; cannam@162: ipp.sampleFormat = opp.sampleFormat = paFloat32; cannam@162: ipp.channelCount = 0; ipp.device = paNoDevice; cannam@162: opp.channelCount = 2; opp.device = Pa_GetDefaultOutputDevice(); cannam@162: HOPEFOR(((result = Pa_OpenStream(&stream, NULL, &opp, cannam@162: 1.0, FRAMES_PER_BUFFER, /* 1 cycle per second (1 Hz) is too low. */ cannam@162: paClipOff, QaCallback, &myData )) == paInvalidSampleRate)); cannam@162: cannam@162: /*----------------------------- High sample rate: */ cannam@162: ipp.hostApiSpecificStreamInfo = opp.hostApiSpecificStreamInfo = NULL; cannam@162: ipp.sampleFormat = opp.sampleFormat = paFloat32; cannam@162: ipp.channelCount = 0; ipp.device = paNoDevice; cannam@162: opp.channelCount = 2; opp.device = Pa_GetDefaultOutputDevice(); cannam@162: HOPEFOR(((result = Pa_OpenStream(&stream, NULL, &opp, cannam@162: 10000000.0, FRAMES_PER_BUFFER, /* 10^6 cycles per second (10 MHz) is too high. */ cannam@162: paClipOff, QaCallback, &myData )) == paInvalidSampleRate)); cannam@162: cannam@162: /*----------------------------- NULL callback: */ cannam@162: /* NULL callback is valid in V19 -- it means use blocking read/write stream cannam@162: cannam@162: ipp.hostApiSpecificStreamInfo = opp.hostApiSpecificStreamInfo = NULL; cannam@162: ipp.sampleFormat = opp.sampleFormat = paFloat32; cannam@162: ipp.channelCount = 0; ipp.device = paNoDevice; cannam@162: opp.channelCount = 2; opp.device = Pa_GetDefaultOutputDevice(); cannam@162: HOPEFOR(((result = Pa_OpenStream(&stream, NULL, &opp, cannam@162: SAMPLE_RATE, FRAMES_PER_BUFFER, cannam@162: paClipOff, cannam@162: NULL, cannam@162: &myData )) == paNullCallback)); cannam@162: */ cannam@162: cannam@162: /*----------------------------- Bad flag: */ cannam@162: ipp.hostApiSpecificStreamInfo = opp.hostApiSpecificStreamInfo = NULL; cannam@162: ipp.sampleFormat = opp.sampleFormat = paFloat32; cannam@162: ipp.channelCount = 0; ipp.device = paNoDevice; cannam@162: opp.channelCount = 2; opp.device = Pa_GetDefaultOutputDevice(); cannam@162: HOPEFOR(((result = Pa_OpenStream(&stream, NULL, &opp, cannam@162: SAMPLE_RATE, FRAMES_PER_BUFFER, cannam@162: 255, /* Is 8 maybe legal V19 API? */ cannam@162: QaCallback, &myData )) == paInvalidFlag)); cannam@162: } cannam@162: cannam@162: /*----------------------------- using input device as output device: */ cannam@162: if( FindInputOnlyDevice() != paNoDevice ) cannam@162: { cannam@162: ipp.hostApiSpecificStreamInfo = opp.hostApiSpecificStreamInfo = NULL; cannam@162: ipp.sampleFormat = opp.sampleFormat = paFloat32; cannam@162: ipp.channelCount = 0; ipp.device = paNoDevice; /* And no input device, and no channels. */ cannam@162: opp.channelCount = 2; opp.device = FindInputOnlyDevice(); cannam@162: HOPEFOR(((result = Pa_OpenStream(&stream, NULL, &opp, cannam@162: SAMPLE_RATE, FRAMES_PER_BUFFER, cannam@162: paClipOff, QaCallback, &myData )) == paInvalidChannelCount)); cannam@162: } cannam@162: cannam@162: /*----------------------------- using output device as input device: */ cannam@162: if( FindOutputOnlyDevice() != paNoDevice ) cannam@162: { cannam@162: ipp.hostApiSpecificStreamInfo = opp.hostApiSpecificStreamInfo = NULL; cannam@162: ipp.sampleFormat = opp.sampleFormat = paFloat32; cannam@162: ipp.channelCount = 2; ipp.device = FindOutputOnlyDevice(); cannam@162: opp.channelCount = 0; opp.device = paNoDevice; /* And no output device, and no channels. */ cannam@162: HOPEFOR(((result = Pa_OpenStream(&stream, &ipp, NULL, cannam@162: SAMPLE_RATE, FRAMES_PER_BUFFER, cannam@162: paClipOff, QaCallback, &myData )) == paInvalidChannelCount)); cannam@162: cannam@162: } cannam@162: cannam@162: if( stream != NULL ) Pa_CloseStream( stream ); cannam@162: return result; cannam@162: } cannam@162: cannam@162: /*-----------------------------------------------------------------------------------------*/ cannam@162: static int TestBadActions( void ) cannam@162: { cannam@162: PaStream* stream = NULL; cannam@162: const PaDeviceInfo* deviceInfo = NULL; cannam@162: PaError result = 0; cannam@162: PaQaData myData; cannam@162: PaStreamParameters opp; cannam@162: const PaDeviceInfo* info = NULL; cannam@162: cannam@162: /* Setup data for synthesis thread. */ cannam@162: myData.framesLeft = (unsigned long)(SAMPLE_RATE * 100); /* 100 seconds */ cannam@162: myData.numChannels = 1; cannam@162: myData.mode = MODE_OUTPUT; cannam@162: cannam@162: opp.device = Pa_GetDefaultOutputDevice(); /* Default output. */ cannam@162: opp.channelCount = 2; /* Stereo output. */ cannam@162: opp.hostApiSpecificStreamInfo = NULL; cannam@162: opp.sampleFormat = paFloat32; cannam@162: info = Pa_GetDeviceInfo(opp.device); cannam@162: opp.suggestedLatency = info ? info->defaultLowOutputLatency : 0.100; cannam@162: cannam@162: if (opp.device != paNoDevice) { cannam@162: HOPEFOR(((result = Pa_OpenStream(&stream, NULL, /* Take NULL as input parame- */ cannam@162: &opp, /* ters, meaning try only output. */ cannam@162: SAMPLE_RATE, FRAMES_PER_BUFFER, cannam@162: paClipOff, QaCallback, &myData )) == paNoError)); cannam@162: } cannam@162: cannam@162: HOPEFOR(((deviceInfo = Pa_GetDeviceInfo(paNoDevice)) == NULL)); cannam@162: HOPEFOR(((deviceInfo = Pa_GetDeviceInfo(87654)) == NULL)); cannam@162: HOPEFOR(((result = Pa_StartStream(NULL)) == paBadStreamPtr)); cannam@162: HOPEFOR(((result = Pa_StopStream(NULL)) == paBadStreamPtr)); cannam@162: HOPEFOR(((result = Pa_IsStreamStopped(NULL)) == paBadStreamPtr)); cannam@162: HOPEFOR(((result = Pa_IsStreamActive(NULL)) == paBadStreamPtr)); cannam@162: HOPEFOR(((result = Pa_CloseStream(NULL)) == paBadStreamPtr)); cannam@162: HOPEFOR(((result = Pa_SetStreamFinishedCallback(NULL, NULL)) == paBadStreamPtr)); cannam@162: HOPEFOR(((result = !Pa_GetStreamInfo(NULL)))); cannam@162: HOPEFOR(((result = Pa_GetStreamTime(NULL)) == 0.0)); cannam@162: HOPEFOR(((result = Pa_GetStreamCpuLoad(NULL)) == 0.0)); cannam@162: HOPEFOR(((result = Pa_ReadStream(NULL, NULL, 0)) == paBadStreamPtr)); cannam@162: HOPEFOR(((result = Pa_WriteStream(NULL, NULL, 0)) == paBadStreamPtr)); cannam@162: cannam@162: /** @todo test Pa_GetStreamReadAvailable and Pa_GetStreamWriteAvailable */ cannam@162: cannam@162: if (stream != NULL) Pa_CloseStream(stream); cannam@162: return result; cannam@162: } cannam@162: cannam@162: /*---------------------------------------------------------------------*/ cannam@162: int main(void); cannam@162: int main(void) cannam@162: { cannam@162: PaError result; cannam@162: cannam@162: EXPECT(((result = Pa_Initialize()) == paNoError)); cannam@162: TestBadOpens(); cannam@162: TestBadActions(); cannam@162: error: cannam@162: Pa_Terminate(); cannam@162: printf("QA Report: %d passed, %d failed.\n", gNumPassed, gNumFailed); cannam@162: return 0; cannam@162: }