cannam@162: /** @file paqa_latency.c cannam@162: @ingroup qa_src cannam@162: @brief Test latency estimates. cannam@162: @author Ross Bencina cannam@162: @author Phil Burk cannam@162: */ cannam@162: /* cannam@162: * $Id: patest_sine.c 1368 2008-03-01 00:38:27Z rossb $ 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: #include cannam@162: #include cannam@162: #include "portaudio.h" cannam@162: #include "loopback/src/qa_tools.h" cannam@162: cannam@162: #define NUM_SECONDS (5) cannam@162: #define SAMPLE_RATE (44100) cannam@162: #define FRAMES_PER_BUFFER (64) cannam@162: cannam@162: #ifndef M_PI cannam@162: #define M_PI (3.14159265) cannam@162: #endif cannam@162: cannam@162: #define TABLE_SIZE (200) cannam@162: typedef struct cannam@162: { cannam@162: float sine[TABLE_SIZE]; cannam@162: int left_phase; cannam@162: int right_phase; cannam@162: char message[20]; cannam@162: int minFramesPerBuffer; cannam@162: int maxFramesPerBuffer; cannam@162: int callbackCount; cannam@162: PaTime minDeltaDacTime; cannam@162: PaTime maxDeltaDacTime; cannam@162: PaStreamCallbackTimeInfo previousTimeInfo; cannam@162: } cannam@162: paTestData; cannam@162: cannam@162: /* Used to tally the results of the QA tests. */ cannam@162: int g_testsPassed = 0; cannam@162: int g_testsFailed = 0; cannam@162: cannam@162: /* This routine will be called by the PortAudio engine when audio is needed. cannam@162: ** It may 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 patestCallback( const void *inputBuffer, void *outputBuffer, cannam@162: unsigned long framesPerBuffer, cannam@162: const PaStreamCallbackTimeInfo* timeInfo, cannam@162: PaStreamCallbackFlags statusFlags, cannam@162: void *userData ) cannam@162: { cannam@162: paTestData *data = (paTestData*)userData; cannam@162: float *out = (float*)outputBuffer; cannam@162: unsigned long i; cannam@162: cannam@162: (void) timeInfo; /* Prevent unused variable warnings. */ cannam@162: (void) statusFlags; cannam@162: (void) inputBuffer; cannam@162: cannam@162: if( data->minFramesPerBuffer > framesPerBuffer ) cannam@162: { cannam@162: data->minFramesPerBuffer = framesPerBuffer; cannam@162: } cannam@162: if( data->maxFramesPerBuffer < framesPerBuffer ) cannam@162: { cannam@162: data->maxFramesPerBuffer = framesPerBuffer; cannam@162: } cannam@162: cannam@162: /* Measure min and max output time stamp delta. */ cannam@162: if( data->callbackCount > 0 ) cannam@162: { cannam@162: PaTime delta = timeInfo->outputBufferDacTime - data->previousTimeInfo.outputBufferDacTime; cannam@162: if( data->minDeltaDacTime > delta ) cannam@162: { cannam@162: data->minDeltaDacTime = delta; cannam@162: } cannam@162: if( data->maxDeltaDacTime < delta ) cannam@162: { cannam@162: data->maxDeltaDacTime = delta; cannam@162: } cannam@162: } cannam@162: data->previousTimeInfo = *timeInfo; cannam@162: cannam@162: for( i=0; isine[data->left_phase]; /* left */ cannam@162: *out++ = data->sine[data->right_phase]; /* right */ cannam@162: data->left_phase += 1; cannam@162: if( data->left_phase >= TABLE_SIZE ) data->left_phase -= TABLE_SIZE; cannam@162: data->right_phase += 3; /* higher pitch so we can distinguish left and right. */ cannam@162: if( data->right_phase >= TABLE_SIZE ) data->right_phase -= TABLE_SIZE; cannam@162: } cannam@162: cannam@162: data->callbackCount += 1; cannam@162: return paContinue; cannam@162: } cannam@162: cannam@162: PaError paqaCheckLatency( PaStreamParameters *outputParamsPtr, cannam@162: paTestData *dataPtr, double sampleRate, unsigned long framesPerBuffer ) cannam@162: { cannam@162: PaError err; cannam@162: PaStream *stream; cannam@162: const PaStreamInfo* streamInfo; cannam@162: cannam@162: dataPtr->minFramesPerBuffer = 9999999; cannam@162: dataPtr->maxFramesPerBuffer = 0; cannam@162: dataPtr->minDeltaDacTime = 9999999.0; cannam@162: dataPtr->maxDeltaDacTime = 0.0; cannam@162: dataPtr->callbackCount = 0; cannam@162: cannam@162: printf("Stream parameter: suggestedOutputLatency = %g\n", outputParamsPtr->suggestedLatency ); cannam@162: if( framesPerBuffer == paFramesPerBufferUnspecified ){ cannam@162: printf("Stream parameter: user framesPerBuffer = paFramesPerBufferUnspecified\n" ); cannam@162: }else{ cannam@162: printf("Stream parameter: user framesPerBuffer = %lu\n", framesPerBuffer ); cannam@162: } cannam@162: err = Pa_OpenStream( cannam@162: &stream, cannam@162: NULL, /* no input */ cannam@162: outputParamsPtr, cannam@162: sampleRate, cannam@162: framesPerBuffer, cannam@162: paClipOff, /* we won't output out of range samples so don't bother clipping them */ cannam@162: patestCallback, cannam@162: dataPtr ); cannam@162: if( err != paNoError ) goto error1; cannam@162: cannam@162: streamInfo = Pa_GetStreamInfo( stream ); cannam@162: printf("Stream info: inputLatency = %g\n", streamInfo->inputLatency ); cannam@162: printf("Stream info: outputLatency = %g\n", streamInfo->outputLatency ); cannam@162: cannam@162: err = Pa_StartStream( stream ); cannam@162: if( err != paNoError ) goto error2; cannam@162: cannam@162: printf("Play for %d seconds.\n", NUM_SECONDS ); cannam@162: Pa_Sleep( NUM_SECONDS * 1000 ); cannam@162: cannam@162: printf(" minFramesPerBuffer = %4d\n", dataPtr->minFramesPerBuffer ); cannam@162: printf(" maxFramesPerBuffer = %4d\n", dataPtr->maxFramesPerBuffer ); cannam@162: printf(" minDeltaDacTime = %f\n", dataPtr->minDeltaDacTime ); cannam@162: printf(" maxDeltaDacTime = %f\n", dataPtr->maxDeltaDacTime ); cannam@162: cannam@162: err = Pa_StopStream( stream ); cannam@162: if( err != paNoError ) goto error2; cannam@162: cannam@162: err = Pa_CloseStream( stream ); cannam@162: Pa_Sleep( 1 * 1000 ); cannam@162: cannam@162: cannam@162: printf("-------------------------------------\n"); cannam@162: return err; cannam@162: error2: cannam@162: Pa_CloseStream( stream ); cannam@162: error1: cannam@162: printf("-------------------------------------\n"); cannam@162: return err; cannam@162: } cannam@162: cannam@162: cannam@162: /*******************************************************************/ cannam@162: static int paqaNoopCallback( const void *inputBuffer, void *outputBuffer, cannam@162: unsigned long framesPerBuffer, cannam@162: const PaStreamCallbackTimeInfo* timeInfo, cannam@162: PaStreamCallbackFlags statusFlags, cannam@162: void *userData ) cannam@162: { cannam@162: (void)inputBuffer; cannam@162: (void)outputBuffer; cannam@162: (void)framesPerBuffer; cannam@162: (void)timeInfo; cannam@162: (void)statusFlags; cannam@162: (void)userData; cannam@162: return paContinue; cannam@162: } cannam@162: cannam@162: /*******************************************************************/ cannam@162: static int paqaCheckMultipleSuggested( PaDeviceIndex deviceIndex, int isInput ) cannam@162: { cannam@162: int i; cannam@162: int numLoops = 10; cannam@162: PaError err; cannam@162: PaStream *stream; cannam@162: PaStreamParameters streamParameters; cannam@162: const PaStreamInfo* streamInfo; cannam@162: double lowLatency; cannam@162: double highLatency; cannam@162: double finalLatency; cannam@162: double sampleRate = SAMPLE_RATE; cannam@162: const PaDeviceInfo *pdi = Pa_GetDeviceInfo( deviceIndex ); cannam@162: double previousLatency = 0.0; cannam@162: int numChannels = 1; cannam@162: float toleranceRatio = 1.0; cannam@162: cannam@162: printf("------------------------ paqaCheckMultipleSuggested - %s\n", cannam@162: (isInput ? "INPUT" : "OUTPUT") ); cannam@162: if( isInput ) cannam@162: { cannam@162: lowLatency = pdi->defaultLowInputLatency; cannam@162: highLatency = pdi->defaultHighInputLatency; cannam@162: numChannels = (pdi->maxInputChannels < 2) ? 1 : 2; cannam@162: } cannam@162: else cannam@162: { cannam@162: lowLatency = pdi->defaultLowOutputLatency; cannam@162: highLatency = pdi->defaultHighOutputLatency; cannam@162: numChannels = (pdi->maxOutputChannels < 2) ? 1 : 2; cannam@162: } cannam@162: streamParameters.channelCount = numChannels; cannam@162: streamParameters.device = deviceIndex; cannam@162: streamParameters.hostApiSpecificStreamInfo = NULL; cannam@162: streamParameters.sampleFormat = paFloat32; cannam@162: sampleRate = pdi->defaultSampleRate; cannam@162: cannam@162: printf(" lowLatency = %g\n", lowLatency ); cannam@162: printf(" highLatency = %g\n", highLatency ); cannam@162: printf(" numChannels = %d\n", numChannels ); cannam@162: printf(" sampleRate = %g\n", sampleRate ); cannam@162: cannam@162: if( (highLatency - lowLatency) < 0.001 ) cannam@162: { cannam@162: numLoops = 1; cannam@162: } cannam@162: cannam@162: for( i=0; iinputLatency; cannam@162: } cannam@162: else cannam@162: { cannam@162: finalLatency = streamInfo->outputLatency; cannam@162: } cannam@162: printf(" finalLatency = %6.4f\n", finalLatency ); cannam@162: /* For the default low & high latency values, expect quite close; for other requested cannam@162: * values, at worst the next power-of-2 may result (eg 513 -> 1024) */ cannam@162: toleranceRatio = ( (i == 0) || (i == ( numLoops - 1 )) ) ? 0.1 : 1.0; cannam@162: QA_ASSERT_CLOSE( "final latency should be close to suggested latency", cannam@162: streamParameters.suggestedLatency, finalLatency, (streamParameters.suggestedLatency * toleranceRatio) ); cannam@162: if( i == 0 ) cannam@162: { cannam@162: previousLatency = finalLatency; cannam@162: } cannam@162: } cannam@162: cannam@162: if( numLoops > 1 ) cannam@162: { cannam@162: QA_ASSERT_TRUE( " final latency should increase with suggested latency", (finalLatency > previousLatency) ); cannam@162: } cannam@162: cannam@162: return 0; cannam@162: error: cannam@162: return -1; cannam@162: } cannam@162: cannam@162: /*******************************************************************/ cannam@162: static int paqaVerifySuggestedLatency( void ) cannam@162: { cannam@162: PaDeviceIndex id; cannam@162: int result = 0; cannam@162: const PaDeviceInfo *pdi; cannam@162: int numDevices = Pa_GetDeviceCount(); cannam@162: cannam@162: printf("\n ------------------------ paqaVerifySuggestedLatency\n"); cannam@162: for( id=0; idname, Pa_GetHostApiInfo(pdi->hostApi)->name); cannam@162: if( pdi->maxOutputChannels > 0 ) cannam@162: { cannam@162: if( paqaCheckMultipleSuggested( id, 0 ) < 0 ) cannam@162: { cannam@162: printf("OUTPUT CHECK FAILED !!! #%d: '%s'\n", id, pdi->name); cannam@162: result -= 1; cannam@162: } cannam@162: } cannam@162: if( pdi->maxInputChannels > 0 ) cannam@162: { cannam@162: if( paqaCheckMultipleSuggested( id, 1 ) < 0 ) cannam@162: { cannam@162: printf("INPUT CHECK FAILED !!! #%d: '%s'\n", id, pdi->name); cannam@162: result -= 1; cannam@162: } cannam@162: } cannam@162: } cannam@162: return result; cannam@162: } cannam@162: cannam@162: /*******************************************************************/ cannam@162: static int paqaVerifyDeviceInfoLatency( void ) cannam@162: { cannam@162: PaDeviceIndex id; cannam@162: const PaDeviceInfo *pdi; cannam@162: int numDevices = Pa_GetDeviceCount(); cannam@162: cannam@162: printf("\n ------------------------ paqaVerifyDeviceInfoLatency\n"); cannam@162: for( id=0; idname, Pa_GetHostApiInfo(pdi->hostApi)->name); cannam@162: if( pdi->maxOutputChannels > 0 ) cannam@162: { cannam@162: printf(" Output defaultLowOutputLatency = %f seconds\n", pdi->defaultLowOutputLatency); cannam@162: printf(" Output defaultHighOutputLatency = %f seconds\n", pdi->defaultHighOutputLatency); cannam@162: QA_ASSERT_TRUE( "defaultLowOutputLatency should be > 0", (pdi->defaultLowOutputLatency > 0.0) ); cannam@162: QA_ASSERT_TRUE( "defaultHighOutputLatency should be > 0", (pdi->defaultHighOutputLatency > 0.0) ); cannam@162: QA_ASSERT_TRUE( "defaultHighOutputLatency should be >= Low", (pdi->defaultHighOutputLatency >= pdi->defaultLowOutputLatency) ); cannam@162: } cannam@162: if( pdi->maxInputChannels > 0 ) cannam@162: { cannam@162: printf(" Input defaultLowInputLatency = %f seconds\n", pdi->defaultLowInputLatency); cannam@162: printf(" Input defaultHighInputLatency = %f seconds\n", pdi->defaultHighInputLatency); cannam@162: QA_ASSERT_TRUE( "defaultLowInputLatency should be > 0", (pdi->defaultLowInputLatency > 0.0) ); cannam@162: QA_ASSERT_TRUE( "defaultHighInputLatency should be > 0", (pdi->defaultHighInputLatency > 0.0) ); cannam@162: QA_ASSERT_TRUE( "defaultHighInputLatency should be >= Low", (pdi->defaultHighInputLatency >= pdi->defaultLowInputLatency) ); cannam@162: } cannam@162: } cannam@162: return 0; cannam@162: error: cannam@162: return -1; cannam@162: } cannam@162: cannam@162: cannam@162: cannam@162: /*******************************************************************/ cannam@162: int main(void); cannam@162: int main(void) cannam@162: { cannam@162: PaStreamParameters outputParameters; cannam@162: PaError err; cannam@162: paTestData data; cannam@162: const PaDeviceInfo *deviceInfo; cannam@162: int i; cannam@162: int framesPerBuffer; cannam@162: double sampleRate = SAMPLE_RATE; cannam@162: cannam@162: printf("\nPortAudio QA: investigate output latency.\n"); cannam@162: cannam@162: /* initialise sinusoidal wavetable */ cannam@162: for( i=0; iname, Pa_GetHostApiInfo(deviceInfo->hostApi)->name); cannam@162: printf("Device info: defaultLowOutputLatency = %f seconds\n", deviceInfo->defaultLowOutputLatency); cannam@162: printf("Device info: defaultHighOutputLatency = %f seconds\n", deviceInfo->defaultHighOutputLatency); cannam@162: sampleRate = deviceInfo->defaultSampleRate; cannam@162: printf("Sample Rate for following tests: %g\n", sampleRate); cannam@162: outputParameters.hostApiSpecificStreamInfo = NULL; cannam@162: printf("-------------------------------------\n"); cannam@162: cannam@162: // Try to use a small buffer that is smaller than we think the device can handle. cannam@162: // Try to force combining multiple user buffers into a host buffer. cannam@162: printf("------------- Try a very small buffer.\n"); cannam@162: framesPerBuffer = 9; cannam@162: outputParameters.suggestedLatency = deviceInfo->defaultLowOutputLatency; cannam@162: err = paqaCheckLatency( &outputParameters, &data, sampleRate, framesPerBuffer ); cannam@162: if( err != paNoError ) goto error; cannam@162: cannam@162: printf("------------- 64 frame buffer with 1.1 * defaultLow latency.\n"); cannam@162: framesPerBuffer = 64; cannam@162: outputParameters.suggestedLatency = deviceInfo->defaultLowOutputLatency * 1.1; cannam@162: err = paqaCheckLatency( &outputParameters, &data, sampleRate, framesPerBuffer ); cannam@162: if( err != paNoError ) goto error; cannam@162: cannam@162: // Try to create a huge buffer that is bigger than the allowed device maximum. cannam@162: printf("------------- Try a huge buffer.\n"); cannam@162: framesPerBuffer = 16*1024; cannam@162: outputParameters.suggestedLatency = ((double)framesPerBuffer) / sampleRate; // approximate cannam@162: err = paqaCheckLatency( &outputParameters, &data, sampleRate, framesPerBuffer ); cannam@162: if( err != paNoError ) goto error; cannam@162: cannam@162: printf("------------- Try suggestedLatency = 0.0\n"); cannam@162: outputParameters.suggestedLatency = 0.0; cannam@162: err = paqaCheckLatency( &outputParameters, &data, sampleRate, paFramesPerBufferUnspecified ); cannam@162: if( err != paNoError ) goto error; cannam@162: cannam@162: printf("------------- Try suggestedLatency = defaultLowOutputLatency\n"); cannam@162: outputParameters.suggestedLatency = deviceInfo->defaultLowOutputLatency; cannam@162: err = paqaCheckLatency( &outputParameters, &data, sampleRate, paFramesPerBufferUnspecified ); cannam@162: if( err != paNoError ) goto error; cannam@162: cannam@162: printf("------------- Try suggestedLatency = defaultHighOutputLatency\n"); cannam@162: outputParameters.suggestedLatency = deviceInfo->defaultHighOutputLatency; cannam@162: err = paqaCheckLatency( &outputParameters, &data, sampleRate, paFramesPerBufferUnspecified ); cannam@162: if( err != paNoError ) goto error; cannam@162: cannam@162: printf("------------- Try suggestedLatency = defaultHighOutputLatency * 4\n"); cannam@162: outputParameters.suggestedLatency = deviceInfo->defaultHighOutputLatency * 4; cannam@162: err = paqaCheckLatency( &outputParameters, &data, sampleRate, paFramesPerBufferUnspecified ); cannam@162: if( err != paNoError ) goto error; cannam@162: cannam@162: Pa_Terminate(); cannam@162: printf("SUCCESS - test finished.\n"); cannam@162: return err; cannam@162: cannam@162: error: cannam@162: Pa_Terminate(); cannam@162: fprintf( stderr, "ERROR - test failed.\n" ); cannam@162: fprintf( stderr, "Error number: %d\n", err ); cannam@162: fprintf( stderr, "Error message: %s\n", Pa_GetErrorText( err ) ); cannam@162: return err; cannam@162: }