Chris@4: /** @file paqa_latency.c Chris@4: @ingroup qa_src Chris@4: @brief Test latency estimates. Chris@4: @author Ross Bencina Chris@4: @author Phil Burk Chris@4: */ Chris@4: /* Chris@4: * $Id: patest_sine.c 1368 2008-03-01 00:38:27Z rossb $ Chris@4: * Chris@4: * This program uses the PortAudio Portable Audio Library. Chris@4: * For more information see: http://www.portaudio.com/ Chris@4: * Copyright (c) 1999-2000 Ross Bencina and Phil Burk Chris@4: * Chris@4: * Permission is hereby granted, free of charge, to any person obtaining Chris@4: * a copy of this software and associated documentation files Chris@4: * (the "Software"), to deal in the Software without restriction, Chris@4: * including without limitation the rights to use, copy, modify, merge, Chris@4: * publish, distribute, sublicense, and/or sell copies of the Software, Chris@4: * and to permit persons to whom the Software is furnished to do so, Chris@4: * subject to the following conditions: Chris@4: * Chris@4: * The above copyright notice and this permission notice shall be Chris@4: * included in all copies or substantial portions of the Software. Chris@4: * Chris@4: * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, Chris@4: * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF Chris@4: * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. Chris@4: * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR Chris@4: * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF Chris@4: * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION Chris@4: * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Chris@4: */ Chris@4: Chris@4: /* Chris@4: * The text above constitutes the entire PortAudio license; however, Chris@4: * the PortAudio community also makes the following non-binding requests: Chris@4: * Chris@4: * Any person wishing to distribute modifications to the Software is Chris@4: * requested to send the modifications to the original developer so that Chris@4: * they can be incorporated into the canonical version. It is also Chris@4: * requested that these non-binding requests be included along with the Chris@4: * license above. Chris@4: */ Chris@4: #include Chris@4: #include Chris@4: #include "portaudio.h" Chris@4: #include "loopback/src/qa_tools.h" Chris@4: Chris@4: #define NUM_SECONDS (5) Chris@4: #define SAMPLE_RATE (44100) Chris@4: #define FRAMES_PER_BUFFER (64) Chris@4: Chris@4: #ifndef M_PI Chris@4: #define M_PI (3.14159265) Chris@4: #endif Chris@4: Chris@4: #define TABLE_SIZE (200) Chris@4: typedef struct Chris@4: { Chris@4: float sine[TABLE_SIZE]; Chris@4: int left_phase; Chris@4: int right_phase; Chris@4: char message[20]; Chris@4: int minFramesPerBuffer; Chris@4: int maxFramesPerBuffer; Chris@4: int callbackCount; Chris@4: PaTime minDeltaDacTime; Chris@4: PaTime maxDeltaDacTime; Chris@4: PaStreamCallbackTimeInfo previousTimeInfo; Chris@4: } Chris@4: paTestData; Chris@4: Chris@4: /* Used to tally the results of the QA tests. */ Chris@4: int g_testsPassed = 0; Chris@4: int g_testsFailed = 0; Chris@4: Chris@4: /* This routine will be called by the PortAudio engine when audio is needed. Chris@4: ** It may called at interrupt level on some machines so don't do anything Chris@4: ** that could mess up the system like calling malloc() or free(). Chris@4: */ Chris@4: static int patestCallback( const void *inputBuffer, void *outputBuffer, Chris@4: unsigned long framesPerBuffer, Chris@4: const PaStreamCallbackTimeInfo* timeInfo, Chris@4: PaStreamCallbackFlags statusFlags, Chris@4: void *userData ) Chris@4: { Chris@4: paTestData *data = (paTestData*)userData; Chris@4: float *out = (float*)outputBuffer; Chris@4: unsigned long i; Chris@4: Chris@4: (void) timeInfo; /* Prevent unused variable warnings. */ Chris@4: (void) statusFlags; Chris@4: (void) inputBuffer; Chris@4: Chris@4: if( data->minFramesPerBuffer > framesPerBuffer ) Chris@4: { Chris@4: data->minFramesPerBuffer = framesPerBuffer; Chris@4: } Chris@4: if( data->maxFramesPerBuffer < framesPerBuffer ) Chris@4: { Chris@4: data->maxFramesPerBuffer = framesPerBuffer; Chris@4: } Chris@4: Chris@4: /* Measure min and max output time stamp delta. */ Chris@4: if( data->callbackCount > 0 ) Chris@4: { Chris@4: PaTime delta = timeInfo->outputBufferDacTime - data->previousTimeInfo.outputBufferDacTime; Chris@4: if( data->minDeltaDacTime > delta ) Chris@4: { Chris@4: data->minDeltaDacTime = delta; Chris@4: } Chris@4: if( data->maxDeltaDacTime < delta ) Chris@4: { Chris@4: data->maxDeltaDacTime = delta; Chris@4: } Chris@4: } Chris@4: data->previousTimeInfo = *timeInfo; Chris@4: Chris@4: for( i=0; isine[data->left_phase]; /* left */ Chris@4: *out++ = data->sine[data->right_phase]; /* right */ Chris@4: data->left_phase += 1; Chris@4: if( data->left_phase >= TABLE_SIZE ) data->left_phase -= TABLE_SIZE; Chris@4: data->right_phase += 3; /* higher pitch so we can distinguish left and right. */ Chris@4: if( data->right_phase >= TABLE_SIZE ) data->right_phase -= TABLE_SIZE; Chris@4: } Chris@4: Chris@4: data->callbackCount += 1; Chris@4: return paContinue; Chris@4: } Chris@4: Chris@4: PaError paqaCheckLatency( PaStreamParameters *outputParamsPtr, Chris@4: paTestData *dataPtr, double sampleRate, unsigned long framesPerBuffer ) Chris@4: { Chris@4: PaError err; Chris@4: PaStream *stream; Chris@4: const PaStreamInfo* streamInfo; Chris@4: Chris@4: dataPtr->minFramesPerBuffer = 9999999; Chris@4: dataPtr->maxFramesPerBuffer = 0; Chris@4: dataPtr->minDeltaDacTime = 9999999.0; Chris@4: dataPtr->maxDeltaDacTime = 0.0; Chris@4: dataPtr->callbackCount = 0; Chris@4: Chris@4: printf("Stream parameter: suggestedOutputLatency = %g\n", outputParamsPtr->suggestedLatency ); Chris@4: if( framesPerBuffer == paFramesPerBufferUnspecified ){ Chris@4: printf("Stream parameter: user framesPerBuffer = paFramesPerBufferUnspecified\n" ); Chris@4: }else{ Chris@4: printf("Stream parameter: user framesPerBuffer = %lu\n", framesPerBuffer ); Chris@4: } Chris@4: err = Pa_OpenStream( Chris@4: &stream, Chris@4: NULL, /* no input */ Chris@4: outputParamsPtr, Chris@4: sampleRate, Chris@4: framesPerBuffer, Chris@4: paClipOff, /* we won't output out of range samples so don't bother clipping them */ Chris@4: patestCallback, Chris@4: dataPtr ); Chris@4: if( err != paNoError ) goto error1; Chris@4: Chris@4: streamInfo = Pa_GetStreamInfo( stream ); Chris@4: printf("Stream info: inputLatency = %g\n", streamInfo->inputLatency ); Chris@4: printf("Stream info: outputLatency = %g\n", streamInfo->outputLatency ); Chris@4: Chris@4: err = Pa_StartStream( stream ); Chris@4: if( err != paNoError ) goto error2; Chris@4: Chris@4: printf("Play for %d seconds.\n", NUM_SECONDS ); Chris@4: Pa_Sleep( NUM_SECONDS * 1000 ); Chris@4: Chris@4: printf(" minFramesPerBuffer = %4d\n", dataPtr->minFramesPerBuffer ); Chris@4: printf(" maxFramesPerBuffer = %4d\n", dataPtr->maxFramesPerBuffer ); Chris@4: printf(" minDeltaDacTime = %f\n", dataPtr->minDeltaDacTime ); Chris@4: printf(" maxDeltaDacTime = %f\n", dataPtr->maxDeltaDacTime ); Chris@4: Chris@4: err = Pa_StopStream( stream ); Chris@4: if( err != paNoError ) goto error2; Chris@4: Chris@4: err = Pa_CloseStream( stream ); Chris@4: Pa_Sleep( 1 * 1000 ); Chris@4: Chris@4: Chris@4: printf("-------------------------------------\n"); Chris@4: return err; Chris@4: error2: Chris@4: Pa_CloseStream( stream ); Chris@4: error1: Chris@4: printf("-------------------------------------\n"); Chris@4: return err; Chris@4: } Chris@4: Chris@4: Chris@4: /*******************************************************************/ Chris@4: static int paqaNoopCallback( const void *inputBuffer, void *outputBuffer, Chris@4: unsigned long framesPerBuffer, Chris@4: const PaStreamCallbackTimeInfo* timeInfo, Chris@4: PaStreamCallbackFlags statusFlags, Chris@4: void *userData ) Chris@4: { Chris@4: (void)inputBuffer; Chris@4: (void)outputBuffer; Chris@4: (void)framesPerBuffer; Chris@4: (void)timeInfo; Chris@4: (void)statusFlags; Chris@4: (void)userData; Chris@4: return paContinue; Chris@4: } Chris@4: Chris@4: /*******************************************************************/ Chris@4: static int paqaCheckMultipleSuggested( PaDeviceIndex deviceIndex, int isInput ) Chris@4: { Chris@4: int i; Chris@4: int numLoops = 10; Chris@4: PaError err; Chris@4: PaStream *stream; Chris@4: PaStreamParameters streamParameters; Chris@4: const PaStreamInfo* streamInfo; Chris@4: double lowLatency; Chris@4: double highLatency; Chris@4: double finalLatency; Chris@55: double sampleRate = SAMPLE_RATE; Chris@4: const PaDeviceInfo *pdi = Pa_GetDeviceInfo( deviceIndex ); Chris@4: double previousLatency = 0.0; Chris@4: int numChannels = 1; Chris@55: float toleranceRatio = 1.0; Chris@55: Chris@4: printf("------------------------ paqaCheckMultipleSuggested - %s\n", Chris@4: (isInput ? "INPUT" : "OUTPUT") ); Chris@4: if( isInput ) Chris@4: { Chris@4: lowLatency = pdi->defaultLowInputLatency; Chris@4: highLatency = pdi->defaultHighInputLatency; Chris@4: numChannels = (pdi->maxInputChannels < 2) ? 1 : 2; Chris@4: } Chris@4: else Chris@4: { Chris@4: lowLatency = pdi->defaultLowOutputLatency; Chris@4: highLatency = pdi->defaultHighOutputLatency; Chris@4: numChannels = (pdi->maxOutputChannels < 2) ? 1 : 2; Chris@4: } Chris@4: streamParameters.channelCount = numChannels; Chris@4: streamParameters.device = deviceIndex; Chris@4: streamParameters.hostApiSpecificStreamInfo = NULL; Chris@4: streamParameters.sampleFormat = paFloat32; Chris@55: sampleRate = pdi->defaultSampleRate; Chris@4: Chris@4: printf(" lowLatency = %g\n", lowLatency ); Chris@4: printf(" highLatency = %g\n", highLatency ); Chris@4: printf(" numChannels = %d\n", numChannels ); Chris@55: printf(" sampleRate = %g\n", sampleRate ); Chris@4: Chris@4: if( (highLatency - lowLatency) < 0.001 ) Chris@4: { Chris@55: numLoops = 1; Chris@55: } Chris@55: Chris@4: for( i=0; iinputLatency; Chris@4: } Chris@4: else Chris@4: { Chris@4: finalLatency = streamInfo->outputLatency; Chris@4: } Chris@4: printf(" finalLatency = %6.4f\n", finalLatency ); Chris@55: /* For the default low & high latency values, expect quite close; for other requested Chris@55: * values, at worst the next power-of-2 may result (eg 513 -> 1024) */ Chris@55: toleranceRatio = ( (i == 0) || (i == ( numLoops - 1 )) ) ? 0.1 : 1.0; Chris@55: QA_ASSERT_CLOSE( "final latency should be close to suggested latency", Chris@55: streamParameters.suggestedLatency, finalLatency, (streamParameters.suggestedLatency * toleranceRatio) ); Chris@55: if( i == 0 ) Chris@55: { Chris@55: previousLatency = finalLatency; Chris@55: } Chris@55: } Chris@55: Chris@55: if( numLoops > 1 ) Chris@55: { Chris@4: QA_ASSERT_TRUE( " final latency should increase with suggested latency", (finalLatency > previousLatency) ); Chris@4: } Chris@55: Chris@4: return 0; Chris@4: error: Chris@4: return -1; Chris@4: } Chris@4: Chris@4: /*******************************************************************/ Chris@4: static int paqaVerifySuggestedLatency( void ) Chris@4: { Chris@4: PaDeviceIndex id; Chris@4: int result = 0; Chris@4: const PaDeviceInfo *pdi; Chris@4: int numDevices = Pa_GetDeviceCount(); Chris@4: Chris@4: printf("\n ------------------------ paqaVerifySuggestedLatency\n"); Chris@4: for( id=0; idname, Pa_GetHostApiInfo(pdi->hostApi)->name); Chris@4: if( pdi->maxOutputChannels > 0 ) Chris@4: { Chris@55: if( paqaCheckMultipleSuggested( id, 0 ) < 0 ) Chris@55: { Chris@55: printf("OUTPUT CHECK FAILED !!! #%d: '%s'\n", id, pdi->name); Chris@55: result -= 1; Chris@55: } Chris@4: } Chris@4: if( pdi->maxInputChannels > 0 ) Chris@4: { Chris@55: if( paqaCheckMultipleSuggested( id, 1 ) < 0 ) Chris@55: { Chris@55: printf("INPUT CHECK FAILED !!! #%d: '%s'\n", id, pdi->name); Chris@55: result -= 1; Chris@55: } Chris@4: } Chris@4: } Chris@55: return result; Chris@4: } Chris@4: Chris@4: /*******************************************************************/ Chris@4: static int paqaVerifyDeviceInfoLatency( void ) Chris@4: { Chris@4: PaDeviceIndex id; Chris@4: const PaDeviceInfo *pdi; Chris@4: int numDevices = Pa_GetDeviceCount(); Chris@4: Chris@4: printf("\n ------------------------ paqaVerifyDeviceInfoLatency\n"); Chris@4: for( id=0; idname, Pa_GetHostApiInfo(pdi->hostApi)->name); Chris@4: if( pdi->maxOutputChannels > 0 ) Chris@4: { Chris@4: printf(" Output defaultLowOutputLatency = %f seconds\n", pdi->defaultLowOutputLatency); Chris@55: printf(" Output defaultHighOutputLatency = %f seconds\n", pdi->defaultHighOutputLatency); Chris@4: QA_ASSERT_TRUE( "defaultLowOutputLatency should be > 0", (pdi->defaultLowOutputLatency > 0.0) ); Chris@4: QA_ASSERT_TRUE( "defaultHighOutputLatency should be > 0", (pdi->defaultHighOutputLatency > 0.0) ); Chris@55: QA_ASSERT_TRUE( "defaultHighOutputLatency should be >= Low", (pdi->defaultHighOutputLatency >= pdi->defaultLowOutputLatency) ); Chris@4: } Chris@4: if( pdi->maxInputChannels > 0 ) Chris@4: { Chris@55: printf(" Input defaultLowInputLatency = %f seconds\n", pdi->defaultLowInputLatency); Chris@55: printf(" Input defaultHighInputLatency = %f seconds\n", pdi->defaultHighInputLatency); Chris@55: QA_ASSERT_TRUE( "defaultLowInputLatency should be > 0", (pdi->defaultLowInputLatency > 0.0) ); Chris@55: QA_ASSERT_TRUE( "defaultHighInputLatency should be > 0", (pdi->defaultHighInputLatency > 0.0) ); Chris@55: QA_ASSERT_TRUE( "defaultHighInputLatency should be >= Low", (pdi->defaultHighInputLatency >= pdi->defaultLowInputLatency) ); Chris@4: } Chris@4: } Chris@4: return 0; Chris@4: error: Chris@4: return -1; Chris@4: } Chris@4: Chris@4: Chris@4: Chris@4: /*******************************************************************/ Chris@4: int main(void); Chris@4: int main(void) Chris@4: { Chris@4: PaStreamParameters outputParameters; Chris@4: PaError err; Chris@4: paTestData data; Chris@4: const PaDeviceInfo *deviceInfo; Chris@4: int i; Chris@4: int framesPerBuffer; Chris@55: double sampleRate = SAMPLE_RATE; Chris@4: Chris@55: printf("\nPortAudio QA: investigate output latency.\n"); Chris@55: Chris@4: /* initialise sinusoidal wavetable */ Chris@4: for( i=0; iname, Pa_GetHostApiInfo(deviceInfo->hostApi)->name); Chris@4: printf("Device info: defaultLowOutputLatency = %f seconds\n", deviceInfo->defaultLowOutputLatency); Chris@4: printf("Device info: defaultHighOutputLatency = %f seconds\n", deviceInfo->defaultHighOutputLatency); Chris@55: sampleRate = deviceInfo->defaultSampleRate; Chris@55: printf("Sample Rate for following tests: %g\n", sampleRate); Chris@4: outputParameters.hostApiSpecificStreamInfo = NULL; Chris@55: printf("-------------------------------------\n"); Chris@55: Chris@4: // Try to use a small buffer that is smaller than we think the device can handle. Chris@4: // Try to force combining multiple user buffers into a host buffer. Chris@4: printf("------------- Try a very small buffer.\n"); Chris@4: framesPerBuffer = 9; Chris@4: outputParameters.suggestedLatency = deviceInfo->defaultLowOutputLatency; Chris@4: err = paqaCheckLatency( &outputParameters, &data, sampleRate, framesPerBuffer ); Chris@4: if( err != paNoError ) goto error; Chris@4: Chris@4: printf("------------- 64 frame buffer with 1.1 * defaultLow latency.\n"); Chris@4: framesPerBuffer = 64; Chris@4: outputParameters.suggestedLatency = deviceInfo->defaultLowOutputLatency * 1.1; Chris@4: err = paqaCheckLatency( &outputParameters, &data, sampleRate, framesPerBuffer ); Chris@4: if( err != paNoError ) goto error; Chris@4: Chris@4: // Try to create a huge buffer that is bigger than the allowed device maximum. Chris@4: printf("------------- Try a huge buffer.\n"); Chris@4: framesPerBuffer = 16*1024; Chris@4: outputParameters.suggestedLatency = ((double)framesPerBuffer) / sampleRate; // approximate Chris@4: err = paqaCheckLatency( &outputParameters, &data, sampleRate, framesPerBuffer ); Chris@4: if( err != paNoError ) goto error; Chris@4: Chris@4: printf("------------- Try suggestedLatency = 0.0\n"); Chris@4: outputParameters.suggestedLatency = 0.0; Chris@4: err = paqaCheckLatency( &outputParameters, &data, sampleRate, paFramesPerBufferUnspecified ); Chris@4: if( err != paNoError ) goto error; Chris@4: Chris@4: printf("------------- Try suggestedLatency = defaultLowOutputLatency\n"); Chris@4: outputParameters.suggestedLatency = deviceInfo->defaultLowOutputLatency; Chris@4: err = paqaCheckLatency( &outputParameters, &data, sampleRate, paFramesPerBufferUnspecified ); Chris@4: if( err != paNoError ) goto error; Chris@4: Chris@4: printf("------------- Try suggestedLatency = defaultHighOutputLatency\n"); Chris@4: outputParameters.suggestedLatency = deviceInfo->defaultHighOutputLatency; Chris@4: err = paqaCheckLatency( &outputParameters, &data, sampleRate, paFramesPerBufferUnspecified ); Chris@4: if( err != paNoError ) goto error; Chris@4: Chris@4: printf("------------- Try suggestedLatency = defaultHighOutputLatency * 4\n"); Chris@4: outputParameters.suggestedLatency = deviceInfo->defaultHighOutputLatency * 4; Chris@4: err = paqaCheckLatency( &outputParameters, &data, sampleRate, paFramesPerBufferUnspecified ); Chris@4: if( err != paNoError ) goto error; Chris@4: Chris@55: Pa_Terminate(); Chris@55: printf("SUCCESS - test finished.\n"); Chris@55: return err; Chris@4: Chris@4: error: Chris@4: Pa_Terminate(); Chris@55: fprintf( stderr, "ERROR - test failed.\n" ); Chris@4: fprintf( stderr, "Error number: %d\n", err ); Chris@4: fprintf( stderr, "Error message: %s\n", Pa_GetErrorText( err ) ); Chris@4: return err; Chris@4: }