cannam@140: /** @file patest_suggested_vs_streaminfo_latency.c cannam@140: @ingroup test_src cannam@140: @brief Print suggested vs. PaStreamInfo reported actual latency cannam@140: @author Ross Bencina cannam@140: cannam@140: Opens streams with a sequence of suggested latency values cannam@140: from 0 to 2 seconds in .5ms intervals and gathers the resulting actual cannam@140: latency values. Output a csv file and graph suggested vs. actual. Run cannam@140: with framesPerBuffer unspecified, powers of 2 and multiples of 50 and cannam@140: prime number buffer sizes. cannam@140: */ cannam@140: /* cannam@140: * $Id: patest_sine.c 1368 2008-03-01 00:38:27Z rossb $ cannam@140: * cannam@140: * This program uses the PortAudio Portable Audio Library. cannam@140: * For more information see: http://www.portaudio.com/ cannam@140: * Copyright (c) 1999-2000 Ross Bencina and Phil Burk cannam@140: * cannam@140: * Permission is hereby granted, free of charge, to any person obtaining cannam@140: * a copy of this software and associated documentation files cannam@140: * (the "Software"), to deal in the Software without restriction, cannam@140: * including without limitation the rights to use, copy, modify, merge, cannam@140: * publish, distribute, sublicense, and/or sell copies of the Software, cannam@140: * and to permit persons to whom the Software is furnished to do so, cannam@140: * subject to the following conditions: cannam@140: * cannam@140: * The above copyright notice and this permission notice shall be cannam@140: * included in all copies or substantial portions of the Software. cannam@140: * cannam@140: * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, cannam@140: * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF cannam@140: * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. cannam@140: * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR cannam@140: * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF cannam@140: * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION cannam@140: * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. cannam@140: */ cannam@140: cannam@140: /* cannam@140: * The text above constitutes the entire PortAudio license; however, cannam@140: * the PortAudio community also makes the following non-binding requests: cannam@140: * cannam@140: * Any person wishing to distribute modifications to the Software is cannam@140: * requested to send the modifications to the original developer so that cannam@140: * they can be incorporated into the canonical version. It is also cannam@140: * requested that these non-binding requests be included along with the cannam@140: * license above. cannam@140: */ cannam@140: #include cannam@140: #include cannam@140: #include cannam@140: #include cannam@140: #include "portaudio.h" cannam@140: cannam@140: #define SAMPLE_RATE (44100) cannam@140: #define FRAMES_PER_BUFFER 2//(128) cannam@140: #define NUM_CHANNELS (2) cannam@140: cannam@140: #define SUGGESTED_LATENCY_START_SECONDS (0.0) cannam@140: #define SUGGESTED_LATENCY_END_SECONDS (2.0) cannam@140: #define SUGGESTED_LATENCY_INCREMENT_SECONDS (0.0005) /* half a millisecond increments */ cannam@140: cannam@140: cannam@140: /* dummy callback. does nothing. never gets called */ cannam@140: static int patestCallback( const void *inputBuffer, void *outputBuffer, cannam@140: unsigned long framesPerBuffer, cannam@140: const PaStreamCallbackTimeInfo* timeInfo, cannam@140: PaStreamCallbackFlags statusFlags, cannam@140: void *userData ) cannam@140: { cannam@140: return paContinue; cannam@140: } cannam@140: cannam@140: /*******************************************************************/ cannam@140: static void usage() cannam@140: { cannam@140: int i; cannam@140: const PaDeviceInfo *deviceInfo; cannam@140: const char *channelString; cannam@140: cannam@140: fprintf( stderr, "PortAudio suggested (requested) vs. resulting (reported) stream latency test\n" ); cannam@140: fprintf( stderr, "Usage: x.exe input-device-index output-device-index sample-rate frames-per-buffer\n" ); cannam@140: fprintf( stderr, "Use -1 for default device index, or use one of these:\n" ); cannam@140: for( i=0; i < Pa_GetDeviceCount(); ++i ){ cannam@140: deviceInfo = Pa_GetDeviceInfo(i); cannam@140: if( deviceInfo->maxInputChannels > 0 && deviceInfo->maxOutputChannels > 0 ) cannam@140: channelString = "full-duplex"; cannam@140: else if( deviceInfo->maxInputChannels > 0 ) cannam@140: channelString = "input only"; cannam@140: else cannam@140: channelString = "output only"; cannam@140: cannam@140: fprintf( stderr, "%d (%s, %s, %s)\n", i, deviceInfo->name, Pa_GetHostApiInfo(deviceInfo->hostApi)->name, channelString ); cannam@140: } cannam@140: Pa_Terminate(); cannam@140: exit(-1); cannam@140: } cannam@140: cannam@140: int main( int argc, const char* argv[] ); cannam@140: int main( int argc, const char* argv[] ) cannam@140: { cannam@140: PaStreamParameters inputParameters, outputParameters; cannam@140: PaStream *stream; cannam@140: PaError err; cannam@140: PaTime suggestedLatency; cannam@140: const PaStreamInfo *streamInfo; cannam@140: const PaDeviceInfo *deviceInfo; cannam@140: float sampleRate = SAMPLE_RATE; cannam@140: int framesPerBuffer = FRAMES_PER_BUFFER; cannam@140: err = Pa_Initialize(); cannam@140: if( err != paNoError ) goto error; cannam@140: cannam@140: if( argc > 1 && strcmp(argv[1],"-h") == 0 ) cannam@140: usage(); cannam@140: cannam@140: if( argc > 3 ){ cannam@140: sampleRate = atoi(argv[3]); cannam@140: } cannam@140: cannam@140: if( argc > 4 ){ cannam@140: framesPerBuffer = atoi(argv[4]); cannam@140: } cannam@140: cannam@140: printf("# sample rate=%f, frames per buffer=%d\n", (float)sampleRate, framesPerBuffer ); cannam@140: cannam@140: inputParameters.device = -1; cannam@140: if( argc > 1 ) cannam@140: inputParameters.device = atoi(argv[1]); cannam@140: if( inputParameters.device == -1 ){ cannam@140: inputParameters.device = Pa_GetDefaultInputDevice(); cannam@140: if (inputParameters.device == paNoDevice) { cannam@140: fprintf(stderr,"Error: No default input device available.\n"); cannam@140: goto error; cannam@140: } cannam@140: }else{ cannam@140: deviceInfo = Pa_GetDeviceInfo(inputParameters.device); cannam@140: if( !deviceInfo ){ cannam@140: fprintf(stderr,"Error: Invalid input device index.\n"); cannam@140: usage(); cannam@140: } cannam@140: if( deviceInfo->maxInputChannels == 0 ){ cannam@140: fprintf(stderr,"Error: Specified input device has no input channels (an output only device?).\n"); cannam@140: usage(); cannam@140: } cannam@140: } cannam@140: cannam@140: inputParameters.channelCount = NUM_CHANNELS; cannam@140: inputParameters.sampleFormat = paFloat32; /* 32 bit floating point output */ cannam@140: inputParameters.hostApiSpecificStreamInfo = NULL; cannam@140: cannam@140: deviceInfo = Pa_GetDeviceInfo(inputParameters.device); cannam@140: printf( "# using input device id %d (%s, %s)\n", inputParameters.device, deviceInfo->name, Pa_GetHostApiInfo(deviceInfo->hostApi)->name ); cannam@140: cannam@140: cannam@140: outputParameters.device = -1; cannam@140: if( argc > 2 ) cannam@140: outputParameters.device = atoi(argv[2]); cannam@140: if( outputParameters.device == -1 ){ cannam@140: outputParameters.device = Pa_GetDefaultOutputDevice(); cannam@140: if (outputParameters.device == paNoDevice) { cannam@140: fprintf(stderr,"Error: No default output device available.\n"); cannam@140: goto error; cannam@140: } cannam@140: }else{ cannam@140: deviceInfo = Pa_GetDeviceInfo(outputParameters.device); cannam@140: if( !deviceInfo ){ cannam@140: fprintf(stderr,"Error: Invalid output device index.\n"); cannam@140: usage(); cannam@140: } cannam@140: if( deviceInfo->maxOutputChannels == 0 ){ cannam@140: fprintf(stderr,"Error: Specified output device has no output channels (an input only device?).\n"); cannam@140: usage(); cannam@140: } cannam@140: } cannam@140: cannam@140: outputParameters.channelCount = NUM_CHANNELS; cannam@140: outputParameters.sampleFormat = paFloat32; /* 32 bit floating point output */ cannam@140: outputParameters.hostApiSpecificStreamInfo = NULL; cannam@140: cannam@140: deviceInfo = Pa_GetDeviceInfo(outputParameters.device); cannam@140: printf( "# using output device id %d (%s, %s)\n", outputParameters.device, deviceInfo->name, Pa_GetHostApiInfo(deviceInfo->hostApi)->name ); cannam@140: cannam@140: cannam@140: printf( "# suggested latency, half duplex PaStreamInfo::outputLatency, half duplex PaStreamInfo::inputLatency, full duplex PaStreamInfo::outputLatency, full duplex PaStreamInfo::inputLatency\n" ); cannam@140: suggestedLatency = SUGGESTED_LATENCY_START_SECONDS; cannam@140: while( suggestedLatency <= SUGGESTED_LATENCY_END_SECONDS ){ cannam@140: cannam@140: outputParameters.suggestedLatency = suggestedLatency; cannam@140: inputParameters.suggestedLatency = suggestedLatency; cannam@140: cannam@140: printf( "%f, ", suggestedLatency ); cannam@140: cannam@140: /* ------------------------------ output ------------------------------ */ cannam@140: cannam@140: err = Pa_OpenStream( cannam@140: &stream, cannam@140: NULL, /* no input */ cannam@140: &outputParameters, cannam@140: sampleRate, cannam@140: framesPerBuffer, cannam@140: paClipOff, /* we won't output out of range samples so don't bother clipping them */ cannam@140: patestCallback, cannam@140: 0 ); cannam@140: if( err != paNoError ) goto error; cannam@140: cannam@140: streamInfo = Pa_GetStreamInfo( stream ); cannam@140: cannam@140: printf( "%f,", streamInfo->outputLatency ); cannam@140: cannam@140: err = Pa_CloseStream( stream ); cannam@140: if( err != paNoError ) goto error; cannam@140: cannam@140: /* ------------------------------ input ------------------------------ */ cannam@140: cannam@140: err = Pa_OpenStream( cannam@140: &stream, cannam@140: &inputParameters, cannam@140: NULL, /* no output */ cannam@140: sampleRate, cannam@140: framesPerBuffer, cannam@140: paClipOff, /* we won't output out of range samples so don't bother clipping them */ cannam@140: patestCallback, cannam@140: 0 ); cannam@140: if( err != paNoError ) goto error; cannam@140: cannam@140: streamInfo = Pa_GetStreamInfo( stream ); cannam@140: cannam@140: printf( "%f,", streamInfo->inputLatency ); cannam@140: cannam@140: err = Pa_CloseStream( stream ); cannam@140: if( err != paNoError ) goto error; cannam@140: cannam@140: /* ------------------------------ full duplex ------------------------------ */ cannam@140: cannam@140: err = Pa_OpenStream( cannam@140: &stream, cannam@140: &inputParameters, cannam@140: &outputParameters, cannam@140: sampleRate, cannam@140: framesPerBuffer, cannam@140: paClipOff, /* we won't output out of range samples so don't bother clipping them */ cannam@140: patestCallback, cannam@140: 0 ); cannam@140: if( err != paNoError ) goto error; cannam@140: cannam@140: streamInfo = Pa_GetStreamInfo( stream ); cannam@140: cannam@140: printf( "%f,%f", streamInfo->outputLatency, streamInfo->inputLatency ); cannam@140: cannam@140: err = Pa_CloseStream( stream ); cannam@140: if( err != paNoError ) goto error; cannam@140: cannam@140: /* ------------------------------------------------------------ */ cannam@140: cannam@140: printf( "\n" ); cannam@140: suggestedLatency += SUGGESTED_LATENCY_INCREMENT_SECONDS; cannam@140: } cannam@140: cannam@140: Pa_Terminate(); cannam@140: printf("# Test finished.\n"); cannam@140: cannam@140: return err; cannam@140: error: cannam@140: Pa_Terminate(); cannam@140: fprintf( stderr, "An error occured while using the portaudio stream\n" ); cannam@140: fprintf( stderr, "Error number: %d\n", err ); cannam@140: fprintf( stderr, "Error message: %s\n", Pa_GetErrorText( err ) ); cannam@140: return err; cannam@140: }