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