Chris@4: /** @file patest_suggested_vs_streaminfo_latency.c
Chris@4: 	@ingroup test_src
Chris@4: 	@brief Print suggested vs. PaStreamInfo reported actual latency
Chris@4: 	@author Ross Bencina <rossb@audiomulch.com>
Chris@4: 
Chris@4: 	Opens streams with a sequence of suggested latency values 
Chris@4: 	from 0 to 2 seconds in .5ms intervals and gathers the resulting actual 
Chris@4: 	latency values. Output a csv file and graph suggested vs. actual. Run 
Chris@4: 	with framesPerBuffer unspecified, powers of 2 and multiples of 50 and 
Chris@4: 	prime number buffer sizes.
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 <stdio.h>
Chris@4: #include <stdlib.h>
Chris@4: #include <string.h>
Chris@4: #include <math.h>
Chris@4: #include "portaudio.h"
Chris@4: 
Chris@4: #define SAMPLE_RATE             (44100)
Chris@4: #define FRAMES_PER_BUFFER       2//(128)
Chris@4: #define NUM_CHANNELS            (2)
Chris@4: 
Chris@4: #define SUGGESTED_LATENCY_START_SECONDS     (0.0)
Chris@4: #define SUGGESTED_LATENCY_END_SECONDS       (2.0)
Chris@4: #define SUGGESTED_LATENCY_INCREMENT_SECONDS (0.0005) /* half a millisecond increments */
Chris@4: 
Chris@4: 
Chris@4: /* dummy callback. does nothing. never gets called */
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:     return paContinue;
Chris@4: }
Chris@4: 
Chris@4: /*******************************************************************/
Chris@4: static void usage()
Chris@4: {
Chris@4:     int i;
Chris@4:     const PaDeviceInfo *deviceInfo;
Chris@4:     const char *channelString;
Chris@4: 
Chris@4:     fprintf( stderr, "PortAudio suggested (requested) vs. resulting (reported) stream latency test\n" );
Chris@4:     fprintf( stderr, "Usage: x.exe input-device-index output-device-index sample-rate frames-per-buffer\n" );
Chris@4:     fprintf( stderr, "Use -1 for default device index, or use one of these:\n" );
Chris@4:     for( i=0; i < Pa_GetDeviceCount(); ++i ){
Chris@4:         deviceInfo = Pa_GetDeviceInfo(i);
Chris@4:         if( deviceInfo->maxInputChannels > 0 && deviceInfo->maxOutputChannels > 0 )
Chris@4:             channelString = "full-duplex";
Chris@4:         else if( deviceInfo->maxInputChannels > 0 )
Chris@4:             channelString = "input only";
Chris@4:         else
Chris@4:             channelString = "output only";
Chris@4: 
Chris@4:         fprintf( stderr, "%d (%s, %s, %s)\n", i, deviceInfo->name, Pa_GetHostApiInfo(deviceInfo->hostApi)->name, channelString );
Chris@4:     }
Chris@4:     Pa_Terminate();
Chris@4:     exit(-1);
Chris@4: }
Chris@4: 
Chris@4: int main( int argc, const char* argv[] );
Chris@4: int main( int argc, const char* argv[] )
Chris@4: {
Chris@4:     PaStreamParameters inputParameters, outputParameters;
Chris@4:     PaStream *stream;
Chris@4:     PaError err;
Chris@4:     PaTime suggestedLatency;
Chris@4:     const PaStreamInfo *streamInfo;
Chris@4:     const PaDeviceInfo *deviceInfo;
Chris@4:     float sampleRate = SAMPLE_RATE;
Chris@4:     int framesPerBuffer = FRAMES_PER_BUFFER;
Chris@4:     err = Pa_Initialize();
Chris@4:     if( err != paNoError ) goto error;
Chris@4: 
Chris@4:     if( argc > 1 && strcmp(argv[1],"-h") == 0 )
Chris@4:         usage();
Chris@4: 
Chris@4:     if( argc > 3 ){
Chris@4:         sampleRate = atoi(argv[3]);
Chris@4:     }
Chris@4: 
Chris@4:     if( argc > 4 ){
Chris@4:         framesPerBuffer = atoi(argv[4]);
Chris@4:     }
Chris@4: 
Chris@4:     printf("# sample rate=%f, frames per buffer=%d\n", (float)sampleRate, framesPerBuffer );
Chris@4: 
Chris@4:     inputParameters.device = -1;
Chris@4:     if( argc > 1 )
Chris@4:         inputParameters.device = atoi(argv[1]);
Chris@4:     if( inputParameters.device == -1 ){
Chris@4:         inputParameters.device = Pa_GetDefaultInputDevice();
Chris@4:         if (inputParameters.device == paNoDevice) {
Chris@4:           fprintf(stderr,"Error: No default input device available.\n");
Chris@4:           goto error;
Chris@4:         }
Chris@4:     }else{
Chris@4:         deviceInfo = Pa_GetDeviceInfo(inputParameters.device);
Chris@4:         if( !deviceInfo ){
Chris@4:             fprintf(stderr,"Error: Invalid input device index.\n");
Chris@4:             usage();
Chris@4:         }
Chris@4:         if( deviceInfo->maxInputChannels == 0 ){
Chris@4:             fprintf(stderr,"Error: Specified input device has no input channels (an output only device?).\n");
Chris@4:             usage();
Chris@4:         }
Chris@4:     }
Chris@4:     
Chris@4:     inputParameters.channelCount = NUM_CHANNELS;
Chris@4:     inputParameters.sampleFormat = paFloat32; /* 32 bit floating point output */
Chris@4:     inputParameters.hostApiSpecificStreamInfo = NULL;
Chris@4: 
Chris@4:     deviceInfo = Pa_GetDeviceInfo(inputParameters.device);
Chris@4:     printf( "# using input device id %d (%s, %s)\n", inputParameters.device, deviceInfo->name, Pa_GetHostApiInfo(deviceInfo->hostApi)->name );
Chris@4: 
Chris@4: 
Chris@4:     outputParameters.device = -1;
Chris@4:     if( argc > 2 )
Chris@4:         outputParameters.device = atoi(argv[2]);
Chris@4:     if( outputParameters.device == -1 ){
Chris@4:         outputParameters.device = Pa_GetDefaultOutputDevice();
Chris@4:         if (outputParameters.device == paNoDevice) {
Chris@4:           fprintf(stderr,"Error: No default output device available.\n");
Chris@4:           goto error;
Chris@4:         }
Chris@4:     }else{
Chris@4:         deviceInfo = Pa_GetDeviceInfo(outputParameters.device);
Chris@4:         if( !deviceInfo ){
Chris@4:             fprintf(stderr,"Error: Invalid output device index.\n");
Chris@4:             usage();
Chris@4:         }
Chris@4:         if( deviceInfo->maxOutputChannels == 0 ){
Chris@4:             fprintf(stderr,"Error: Specified output device has no output channels (an input only device?).\n");
Chris@4:             usage();
Chris@4:         }
Chris@4:     }
Chris@4: 
Chris@4:     outputParameters.channelCount = NUM_CHANNELS;
Chris@4:     outputParameters.sampleFormat = paFloat32; /* 32 bit floating point output */
Chris@4:     outputParameters.hostApiSpecificStreamInfo = NULL;
Chris@4: 
Chris@4:     deviceInfo = Pa_GetDeviceInfo(outputParameters.device);
Chris@4:     printf( "# using output device id %d (%s, %s)\n", outputParameters.device, deviceInfo->name, Pa_GetHostApiInfo(deviceInfo->hostApi)->name );
Chris@4: 
Chris@4: 
Chris@4:     printf( "# suggested latency, half duplex PaStreamInfo::outputLatency, half duplex PaStreamInfo::inputLatency, full duplex PaStreamInfo::outputLatency, full duplex PaStreamInfo::inputLatency\n" );
Chris@4:     suggestedLatency = SUGGESTED_LATENCY_START_SECONDS;
Chris@4:     while( suggestedLatency <= SUGGESTED_LATENCY_END_SECONDS ){
Chris@4: 
Chris@4:         outputParameters.suggestedLatency = suggestedLatency;
Chris@4:         inputParameters.suggestedLatency = suggestedLatency;
Chris@4: 
Chris@4:         printf( "%f, ", suggestedLatency );
Chris@4: 
Chris@4:         /* ------------------------------ output ------------------------------ */
Chris@4: 
Chris@4:         err = Pa_OpenStream(
Chris@4:                   &stream,
Chris@4:                   NULL, /* no input */
Chris@4:                   &outputParameters,
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:                   0 );
Chris@4:         if( err != paNoError ) goto error;
Chris@4: 
Chris@4:         streamInfo = Pa_GetStreamInfo( stream );
Chris@4: 
Chris@4:         printf( "%f,", streamInfo->outputLatency  );
Chris@4: 
Chris@4:         err = Pa_CloseStream( stream );
Chris@4:         if( err != paNoError ) goto error;
Chris@4: 
Chris@4:         /* ------------------------------ input ------------------------------ */
Chris@4: 
Chris@4:         err = Pa_OpenStream(
Chris@4:                   &stream,
Chris@4:                   &inputParameters, 
Chris@4:                   NULL, /* no output */
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:                   0 );
Chris@4:         if( err != paNoError ) goto error;
Chris@4: 
Chris@4:         streamInfo = Pa_GetStreamInfo( stream );
Chris@4: 
Chris@4:         printf( "%f,", streamInfo->inputLatency  );
Chris@4: 
Chris@4:         err = Pa_CloseStream( stream );
Chris@4:         if( err != paNoError ) goto error;
Chris@4: 
Chris@4:         /* ------------------------------ full duplex ------------------------------ */
Chris@4: 
Chris@4:         err = Pa_OpenStream(
Chris@4:                   &stream,
Chris@4:                   &inputParameters, 
Chris@4:                   &outputParameters,
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:                   0 );
Chris@4:         if( err != paNoError ) goto error;
Chris@4: 
Chris@4:         streamInfo = Pa_GetStreamInfo( stream );
Chris@4: 
Chris@4:         printf( "%f,%f", streamInfo->outputLatency, streamInfo->inputLatency );
Chris@4: 
Chris@4:         err = Pa_CloseStream( stream );
Chris@4:         if( err != paNoError ) goto error;
Chris@4: 
Chris@4:         /* ------------------------------------------------------------ */
Chris@4: 
Chris@4:         printf( "\n" );
Chris@4:         suggestedLatency += SUGGESTED_LATENCY_INCREMENT_SECONDS;
Chris@4:     }
Chris@4: 
Chris@4:     Pa_Terminate();
Chris@4:     printf("# Test finished.\n");
Chris@4:     
Chris@4:     return err;
Chris@4: error:
Chris@4:     Pa_Terminate();
Chris@4:     fprintf( stderr, "An error occured while using the portaudio stream\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: }